FFFF 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

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 docs/documentation/server_admin/topics/events/admin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@

You can record all actions that are performed by an administrator in the Admin Console. The Admin Console performs administrative actions by invoking the {project_name} REST interface and {project_name} audits these REST invocations. You can view the resulting events in the Admin Console.

For operations on resources within a realm, the resource path in an admin event is relative to that realm.
For example, a request to `/admin/realms/my-realm/users/User-ID` records `users/User-ID`.
Resource names and IDs retain their casing, including when the database accepts a different casing for the realm name in the request.
Admin API v2 events follow the same rule relative to `/admin/api/{realm-name}/`.

.Procedure

Use this procedure to start auditing admin actions.
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
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,34 @@

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

import org.keycloak.authentication.authenticators.client.ClientIdAndSecretAuthenticator;
import org.keycloak.common.Profile;
import org.keycloak.common.util.Encode;
import org.keycloak.events.admin.OperationType;
import org.keycloak.events.admin.v2.AdminEventV2Builder;
import org.keycloak.models.RealmModel;
import org.keycloak.representations.admin.v2.OIDCClientRepresentation;
import org.keycloak.representations.idm.AdminEventRepresentation;
import org.keycloak.representations.idm.RealmEventsConfigRepresentation;
import org.keycloak.services.resources.admin.AdminAuth;
import org.keycloak.testframework.annotations.InjectRealm;
import org.keycloak.testframework.annotations.InjectUser;
import org.keycloak.testframework.annotations.KeycloakIntegrationTest;
import org.keycloak.testframework.realm.ManagedRealm;
import org.keycloak.testframework.realm.ManagedUser;
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.jboss.resteasy.specimpl.ResteasyUriInfo;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;

import static org.keycloak.events.admin.v2.AdminEventV2Builder.API_VERSION_DETAIL_KEY;
import static org.keycloak.events.admin.v2.AdminEventV2Builder.API_VERSION_V2;
Expand Down Expand Up @@ -66,6 +76,9 @@ public class AdminEventV2Test extends AbstractClientApiV2Test {
@InjectRealm
ManagedRealm testRealm;

@InjectUser
ManagedUser testUser;

@Override
public String getRealmName() {
return testRealm.getName();
Expand Down Expand Up @@ -96,6 +109,34 @@ public void disableAdminEventsV2() {
});
}

@ParameterizedTest
@ValueSource(booleans = {false, true})
public void resourcePathUsesRequestedRealmName(boolean differentCase) {
String userId = testUser.getId();

// Use the resolved realm model so this also runs on case-sensitive databases.
runOnServer.run(session -> {
RealmModel realm = session.getContext().getRealm();
AdminAuth auth = new AdminAuth(realm, null, session.users().getUserById(realm, userId), realm.getClientByClientId("account"));
AdminEventV2Builder builder = new AdminEventV2Builder(realm, auth, session, session.getContext().getConnection());
String requestedRealmName = differentCase ? realm.getName().toUpperCase(Locale.ROOT) : realm.getName();
String encodedRealmName = Encode.encodePathSegment(requestedRealmName);
String uriPrefix = "http://localhost/admin/api/" + encodedRealmName + "/";

ResteasyUriInfo uriInfo = new ResteasyUriInfo(uriPrefix + "clients/v2/Client%20Name+ID%2FChild", "");
uriInfo.addEncodedPathParameter("realmName", encodedRealmName);
builder.resourcePath(uriInfo);
assertThat(builder.getEvent().getResourcePath(), is("clients/v2/Client Name+ID/Child"));

for (String trailingSlash : List.of("", "/")) {
ResteasyUriInfo collectionUriInfo = new ResteasyUriInfo(uriPrefix + "clients/v2" + trailingSlash, "");
collectionUriInfo.addEncodedPathParameter("realmName", encodedRealmName);
builder.resourcePath(collectionUriInfo, "Client-ID");
assertThat(builder.getEvent().getResourcePath(), is("clients/v2/Client-ID"));
}
});
}

@Test
public void createClientFiresV2Event() throws Exception {
createTestClient();
Expand Down
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 @@ -22,17 +22,20 @@
import java.time.LocalDate;
import java.time.ZoneOffset;
import java.util.List;
import java.util.Locale;
import java.util.Map;
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;
import org.keycloak.events.admin.OperationType;
import org.keycloak.events.admin.ResourceType;
import org.keycloak.models.RealmModel;
import org.keycloak.models.UserModel;
import org.keycloak.representations.idm.AdminEventRepresentation;
import org.keycloak.representations.idm.AuthDetailsRepresentation;
Expand All @@ -41,6 +44,8 @@
import org.keycloak.representations.idm.RealmEventsConfigRepresentation;
import org.keycloak.representations.idm.RealmRepresentation;
import org.keycloak.representations.idm.UserRepresentation;
import org.keycloak.services.resources.admin.AdminAuth;
import org.keycloak.services.resources.admin.AdminEventBuilder;
import org.keycloak.testframework.annotations.InjectAdminClient;
import org.keycloak.testframework.annotations.InjectRealm;
import org.keycloak.testframework.annotations.KeycloakIntegrationTest;
Expand All @@ -56,9 +61,12 @@
import org.keycloak.util.JsonSerialization;

import org.apache.commons.lang3.RandomStringUtils;
import org.jboss.resteasy.specimpl.ResteasyUriInfo;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.allOf;
Expand Down Expand Up @@ -163,6 +171,34 @@ public void testEventDetails() {
assertThat(event.getDetails(), is(equalTo(Map.of(UserModel.USERNAME, userRep.getUsername(), UserModel.EMAIL, userRep.getEmail()))));
}

@ParameterizedTest
@ValueSource(booleans = {false, true})
public void resourcePathUsesRequestedRealmName(boolean differentCase) {
String userId = createUser("resource-path-user");

// Use the resolved realm model so this also runs on case-sensitive databases.
runOnServerClient.run(session -> {
RealmModel realm = session.getContext().getRealm();
AdminAuth auth = new AdminAuth(realm, null, session.users().getUserById(realm, userId), realm.getClientByClientId("account"));
AdminEventBuilder builder = new AdminEventBuilder(realm, auth, session, session.getContext().getConnection());
String requestedRealmName = differentCase ? realm.getName().toUpperCase(Locale.ROOT) : realm.getName();
String encodedRealmName = Encode.encodePathSegment(requestedRealmName);
String uriPrefix = "http://localhost/admin/realms/" + encodedRealmName + "/";

ResteasyUriInfo uriInfo = new ResteasyUriInfo(uriPrefix + "roles/Role%20Name+ID%2FChild", "");
uriInfo.addEncodedPathParameter("realm", encodedRealmName);
builder.resourcePath(uriInfo);
assertThat(builder.getEvent().getResourcePath(), is("roles/Role Name+ID/Child"));

for (String trailingSlash : List.of("", "/")) {
ResteasyUriInfo collectionUriInfo = new ResteasyUriInfo(uriPrefix + "users" + trailingSlash, "");
collectionUriInfo.addEncodedPathParameter("realm", encodedRealmName);
builder.resourcePath(collectionUriInfo, "User-ID");
assertThat(builder.getEvent().getResourcePath(), is("users/User-ID"));
}
});
}

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