8000 Fix admin event paths when request realm casing differs by Aschenbath · Pull Request #55226 · keycloak/keycloak · GitHub
[go: up one dir, main page]

Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


8000
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/actions/run-store-tests/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ runs:
run: |
KC_TEST_DATABASE=${{ inputs.db }} KC_TEST_DATABASE_REUSE=true TESTCONTAINERS_REUSE_ENABLE=true ./mvnw package -f tests/pom.xml -Dtest=DatabaseTestSuite -Dkc.test.server.start.timeout=360

- name: Run Admin API v2 database tests
shell: bash
run: |
KC_TEST_DATABASE=${{ inputs.db }} KC_TEST_DATABASE_REUSE=true TESTCONTAINERS_REUSE_ENABLE=true ./mvnw verify -pl rest/admin-v2/tests/pom.xml -Dtest=DatabaseTestSuite -Dkc.test.server.start.timeout=360

- name: Run stateless tests
shell: bash
run: |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,7 @@ public AdminEventV2Builder(RealmModel realm, AdminAuth auth, KeycloakSession ses

@Override
protected String getResourcePath(UriInfo uriInfo) {
String path = uriInfo.getPath();
String realmRelative = "/admin/api/%s/".formatted(realm.getName());
return path.substring(path.indexOf(realmRelative) + realmRelative.length());
return getResourcePath(uriInfo, "admin/api/", "realmName");
}

@Override
Expand Down
33 changes: 33 additions & 0 deletions rest/admin-v2/tests/pom.xml
F438
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,34 @@
<groupId>org.keycloak.testframework</groupId>
<artifactId>keycloak-test-framework-junit5-config</artifactId>
</dependency>
<dependency>
<groupId>org.keycloak.testframework</groupId>
<artifactId>keycloak-test-framework-db-edb</artifactId>
</dependency>
<dependency>
<groupId>org.keycloak.testframework</groupId>
<artifactId>keycloak-test-framework-db-mariadb</artifactId>
</dependency>
<dependency>
<groupId>org.keycloak.testframework</groupId>
<artifactId>keycloak-test-framework-db-mssql</artifactId>
</dependency>
<dependency>
<groupId>org.keycloak.testframework</groupId>
<artifactId>keycloak-test-framework-db-mysql</artifactId>
</dependency>
<dependency>
<groupId>org.keycloak.testframework</groupId>
<artifactId>keycloak-test-framework-db-oracle</artifactId>
</dependency>
<dependency>
<groupId>org.keycloak.testframework</groupId>
<artifactId>keycloak-test-framework-db-postgres</artifactId>
</dependency>
<dependency>
<groupId>org.keycloak.testframework</groupId>
<artifactId>keycloak-test-framework-db-tidb</artifactId>
</dependency>
<dependency>
<groupId>org.keycloak.tests</groupId>
<artifactId>keycloak-tests-custom-providers</artifactId>
Expand All @@ -57,6 +85,11 @@
<artifactId>keycloak-core</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.platform</groupId>
<artifactId>junit-platform-suite</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

<profiles>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@

import java.io.ByteArrayInputStream;
import java.util.List;
import java.util.Locale;
import java.util.Set;

import org.keycloak.authentication.authenticators.client.ClientIdAndSecretAuthenticator;
import org.keycloak.common.Profile;
Expand All @@ -28,11 +30,14 @@
import org.keycloak.representations.idm.RealmEventsConfigRepresentation;
import org.keycloak.testframework.annotations.InjectRealm;
import org.keycloak.testframework.annotations.KeycloakIntegrationTest;
import org.keycloak.testframework.database.TestDatabase;
import org.keycloak.testframework.injection.Extensions;
import org.keycloak.testframework.realm.ManagedRealm;
import org.keycloak.testframework.remote.runonserver.InjectRunOnServer;
import org.keycloak.testframework.remote.runonserver.RunOnServerClient;
import org.keycloak.testframework.server.KeycloakServerConfig;
import org.keycloak.testframework.server.KeycloakServerConfigBuilder;
import org.keycloak.tests.suites.DatabaseTest;

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
Expand All @@ -56,8 +61,12 @@
* Tests for Admin API v2 events.
* Verifies that v2 admin events are fired with the apiVersion=v2 detail.
*/
@DatabaseTest
@KeycloakIntegrationTest(config = AdminEventV2Test.AdminV2EventConfig.class)
public class AdminEventV2Test extends AbstractClientApiV2Test {
// Databases whose default collation compares the realm name case-insensitively.
private static final Set<String> CASE_INSENSITIVE_DATABASES = Set.of("mariadb", "mysql", "mssql");

private static final String TEST_CLIENT_ID = "v2-rep-test-client";

@InjectRunOnServer
Expand Down Expand Up @@ -96,6 +105,43 @@ public void disableAdminEventsV2() {
});
}

@Test
public void resourcePathWithExactRealmName() throws Exception {
createTestClient();
try {
assertThat(testRealm.admin().getAdminEvents().get(0).getResourcePath(), is("clients/v2"));
} finally {
deleteTestClient();
}
}

@Test
public void resourcePathWithUpperCaseRealmName() throws Exception {
String upperCaseRealmName = testRealm.getName().toUpperCase(Locale.ROOT);
String database = dbType();

try (var response = getClientsApi(upperCaseRealmName).createClient(getTestClientRepresentation())) {
if (CASE_INSENSITIVE_DATABASES.contains(database)) {
assertEquals(201, response.getStatus(), database);
} else {
assertEquals(404, response.getStatus(), database);
assertThat(testRealm.admin().getAdminEvents().size(), is(0));
return;
}
}
try {
List<AdminEventRepresentation> events = testRealm.admin().getAdminEvents();
assertThat(events.size(), is(1));
assertThat(events.get(0).getResourcePath(), is("clients/v2"));
} finally {
deleteTestClient();
}
}

private static String dbType() {
return Extensions.getInstance().findSupplierByType(TestDatabase.class).getAlias();
}

@Test
public void createClientFiresV2Event() throws Exception {
createTestClient();
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package org.keycloak.tests.suites;

import org.junit.platform.suite.api.IncludeTags;
import org.junit.platform.suite.api.SelectPackages;
import org.junit.platform.suite.api.Suite;

@Suite
@IncludeTags(DatabaseTest.TAG)
@SelectPackages({
"org.keycloak.tests"
})
public class DatabaseTestSuite {
}
Original file line number Diff line number Diff line change
Expand Up @@ -242,15 +242,18 @@ public AdminEventBuilder resourcePath(UriInfo uriInfo, String id) {
}

protected String getResourcePath(UriInfo uriInfo) {
String path = uriInfo.getPath();

StringBuilder sb = new StringBuilder();
sb.append("/realms/");
sb.append(realm.getName());
sb.append("/");
String realmRelative = sb.toString();
return getResourcePath(uriInfo, "realms/", "realm");
}

return path.substring(path.indexOf(realmRelative) + realmRelative.length());
/**
* Extracts the realm-relative path using the realm name matched in the request.
* The stored realm name can have different casing with a case-insensitive database collation.
*/
protected String getResourcePath(UriInfo uriInfo, String realmPathPrefix, String realmParameter) {
String path = uriInfo.getPath();
String realmRelative = realmPathPrefix + uriInfo.getPathParameters().getFirst(realmParameter) + "/";
int realmIndex = path.indexOf(realmRelative);
return realmIndex >= 0 ? path.substring(realmIndex + realmRelative.length()) : path;
}

public AdminEventBuilder representation(Object value) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,23 @@
package org.keycloak.tests.admin.event;

import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Instant;
import java.time.LocalDate;
import java.time.ZoneOffset;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.UUID;

import org.keycloak.admin.client.Keycloak;
import org.keycloak.admin.client.resource.RealmResource;
import org.keycloak.admin.client.resource.UserResource;
import org.keycloak.common.util.Encode;
import org.keycloak.events.EventStoreProvider;
import org.keycloak.events.admin.AdminEvent;
import org.keycloak.events.admin.AuthDetails;
Expand All @@ -42,15 +49,19 @@
import org.keycloak.representations.idm.RealmRepresentation;
import org.keycloak.representations.idm.UserRepresentation;
import org.keycloak.testframework.annotations.InjectAdminClient;
import org.keycloak.testframework.annotations.InjectKeycloakUrls;
import org.keycloak.testframework.annotations.InjectRealm;
import org.keycloak.testframework.annotations.KeycloakIntegrationTest;
import org.keycloak.testframework.database.TestDatabase;
import org.keycloak.testframework.events.AdminEventAssertion;
import org.keycloak.testframework.injection.Extensions;
import org.keycloak.testframework.realm.ManagedRealm;
import org.keycloak.testframework.realm.RealmBuilder;
import org.keycloak.testframework.realm.RealmConfig;
import org.keycloak.testframework.realm.UserBuilder;
import org.keycloak.testframework.remote.runonserver.InjectRunOnServer;
import org.keycloak.testframework.remote.runonserver.RunOnServerClient;
import org.keycloak.testframework.server.KeycloakUrls;
import org.keycloak.testframework.util.ApiUtil;
import org.keycloak.tests.suites.DatabaseTest;
import org.keycloak.util.JsonSerialization;
Expand All @@ -75,6 +86,9 @@
@DatabaseTest
public class AdminEventTest {

// Databases whose default collation compares the realm name case-insensitively.
private static final Set<String> CASE_INSENSITIVE_DATABASES = Set.of("mariadb", "mysql", "mssql");

@InjectRealm(attachTo = "master", ref = "master")
ManagedRealm masterRealm;

Expand All @@ -84,6 +98,9 @@ public class AdminEventTest {
@InjectAdminClient(mode = InjectAdminClient.Mode.BOOTSTRAP)
Keycloak adminClient;

@InjectKeycloakUrls
KeycloakUrls keycloakUrls;

@InjectRunOnServer(realmRef = "default")
RunOnServerClient runOnServerClient;

Expand Down Expand Up @@ -163,6 +180,47 @@ public void testEventDetails() {
assertThat(event.getDetails(), is(equalTo(Map.of(UserModel.USERNAME, userRep.getUsername(), UserModel.EMAIL, userRep.getEmail()))));
}

@Test
public void resourcePathWithExactRealmName() throws Exception {
String userId = createUser("resource-path-user");
managedRealm.admin().clearAdminEvents();

assertThat(updateUser(managedRealm.getName(), userId), is(204));
assertUserUpdateEvent(userId);
}

@Test
public void resourcePathWithUpperCaseRealmName() throws Exception {
String userId = createUser("resource-path-user");
managedRealm.admin().clearAdminEvents();
String database = Extensions.getInstance().findSupplierByType(TestDatabase.class).getAlias();

int status = updateUser(managedRealm.getName().toUpperCase(Locale.ROOT), userId);
if (CASE_INSENSITIVE_DATABASES.contains(database)) {
assertThat(database, status, is(204));
assertUserUpdateEvent(userId);
} else {
assertThat(database, status, is(404));
assertThat(events().size(), is(0));
}
}

private int updateUser(String realmName, String userId) throws Exception {
HttpRequest request = HttpRequest.newBuilder(URI.create(keycloakUrls.getAdmin() + "/realms/" + Encode.encodePathSegment(realmName) + "/users/" + userId))
.header("Authorization", "Bearer " + adminClient.tokenManager().getAccessTokenString())
.header("Content-Type", "application/json")
.PUT(HttpRequest.BodyPublishers.ofString("{\"firstName\":\"updated\"}"))
.build();
return HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.discarding()).statusCode();
}

private void assertUserUpdateEvent(String userId) {
List<AdminEventRepresentation> events = events();
assertThat(events.size(), is(1));
AdminEventAssertion.assertSuccess(events.get(0)).operationType(OperationType.UPDATE);
assertThat(events.get(0).getResourcePath(), is("users/" + userId));
}

@Test
public void retrieveAdminEventTest() {
createUser("user1");
Expand Down
Loading
0