8000 Prevent access to user info if not the owner or requested of a resource by pedroigor · Pull Request #49122 · keycloak/keycloak · GitHub
[go: up one dir, main page]
Skip to content

Prevent access to user info if not the owner or requested of a resource #49122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stianst merged 1 commit into from
May 20, 2026
Merged

Prevent access to user info if not the owner or requested of a resource #49122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 24 additions & 8 deletions ...ices/src/main/java/org/keycloak/services/resources/account/resources/ResourceService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,19 +102,35 @@ public Collection<Permission> toPermissions() {
@Produces(MediaType.APPLICATION_JSON)
public Response user(@QueryParam("value") String value) {
try {
final UserModel user = getUser(value);
UserRepresentation rep = new UserRepresentation();
rep.setId(user.getId());
rep.setUsername(user.getUsername());
rep.setFirstName(user.getFirstName());
rep.setLastName(user.getLastName());
rep.setEmail(user.getEmail());
return Response.ok(rep).build();
final UserModel queriedUser = getUser(value);
final UserModel authenticatedUser = auth.getUser();

if (!queriedUser.getId().equals(authenticatedUser.getId()) && !hasPermissionRequest(queriedUser.getId())) {
return Response.status(Response.Status.FORBIDDEN).build();
}

UserRepresentation minimalUserRep = new UserRepresentation();
minimalUserRep.setId(queriedUser.getId());
minimalUserRep.setUsername(queriedUser.getUsername());
minimalUserRep.setFirstName(queriedUser.getFirstName());
minimalUserRep.setLastName(queriedUser.getLastName());
minimalUserRep.setEmail(queriedUser.getEmail());

return Response.ok(minimalUserRep).build();
} catch (NotFoundException e) {
return Response.noContent().build();
}
}

private boolean hasPermissionRequest(String userId) {
Map<PermissionTicket.FilterOption, String> filters = new EnumMap<>(PermissionTicket.FilterOption.class);

filters.put(PermissionTicket.FilterOption.RESOURCE_ID, resource.getId());
filters.put(PermissionTicket.FilterOption.REQUESTER, userId);

return !ticketStore.find(resourceServer, filters, null, null).isEmpty();
}

/**
* Updates the permission set for a resource based on the given {@code permissions}.
*
Expand Down
109 changes: 109 additions & 0 deletions ...ian/tests/base/src/test/java/org/keycloak/testsuite/account/ResourcesRestServiceTest.java
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,17 @@
import java.util.Set;
import java.util.function.Consumer;

import jakarta.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.Response.Status;

import org.keycloak.admin.client.resource.AuthorizationResource;
import org.keycloak.admin.client.resource.ClientResource;
import org.keycloak.admin.client.resource.ClientsResource;
import org.keycloak.authorization.client.AuthzClient;
import org.keycloak.authorization.client.Configuration;
import org.keycloak.authorization.client.resource.PermissionResource;
import org.keycloak.common.Profile;
import org.keycloak.common.util.KeycloakUriBuilder;
import org.keycloak.http.simple.SimpleHttpRequest;
Expand Down Expand Up @@ -68,6 +72,7 @@

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.empty;
import static org.junit.Assert.assertFalse;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
Expand Down Expand Up @@ -679,6 +684,110 @@ public void testApprovePermissionRequest() throws IOException {
}
}

@Test
public void testGetUserInfoOwnUser() {
Resource resource = getMyResources().get(0);

UserRepresentation userRep = doGet("/" + encodePathAsIs(resource.getId()) + "/user?value=test-authz-user@localhost",
UserRepresentation.class);

assertNotNull(userRep);
assertNotNull(userRep.getId(), "User ID should be returned");
assertEquals("test-authz-user@localhost", userRep.getUsername());
assertNull(userRep.getCreatedTimestamp(), "Creation timestamp should not be exposed");
assertNull(userRep.isEnabled(), "Enabled status should not be exposed");
assertNull(userRep.isEmailVerified(), "Email verified should not be exposed");
}

@Test
public void testGetUserInfoWithPermissionRequest() {
Resource resource = getMyResources().get(0);
PermissionResource permissionsApi = authzClient.protection("test-authz-user@localhost", "password").permission();
List<PermissionTicketRepresentation> permissions = permissionsApi.find(resource.getId(), null, null, null, null, null, null, null);
for (PermissionTicketRepresentation permission : permissions) {
permissionsApi.delete(permission.getId());
}

PermissionTicketRepresentation ticket = new PermissionTicketRepresentation();
ticket.setGranted(false);
ticket.setOwner("test-authz-user@localhost");
ticket.setRequesterName("alice");
ticket.setResource(resource.getId());
ticket.setScopeName("Scope A");

permissionsApi.create(ticket);

UserRepresentation userRep = doGet("/" + encodePathAsIs(resource.getId()) + "/user?value=alice",
UserRepresentation.class);

assertNotNull(userRep);
assertNotNull(userRep.getId(), "User ID should be returned");
assertEquals("alice", userRep.getUsername());
assertNull(userRep.getCreatedTimestamp(), "Creation timestamp should not be exposed");
assertNull(userRep.isEnabled(), "Enabled status should not be exposed");
}

@Test
public void testGetUserInfoUnauthorized() throws IOException {
Resource resource = getMyResources().get(0);

try (SimpleHttpResponse response = SimpleHttpDefault
.doGet(getAccountUrl("resources/" + encodePathAsIs(resource.getId()) + "/user?value=bob"), httpClient)
.auth(tokenUtil.getToken())
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON)
.asResponse()) {

assertEquals(Response.Status.FORBIDDEN.getStatusCode(), response.getStatus(), "Should return 403 Forbidden when querying unrelated user");
}
}

@Test
public void testGetUserInfoWithGrantedPermission() {
Resource resource = getMyResources().get(0);
List<Permission> permissions = doGet("/" + encodePathAsIs(resource.getId()) + "/permissions",
new TypeReference<>() {});
assertFalse("Should have at least one granted permission", permissions.isEmpty());
String grantedUser = permissions.get(0).getUsername();
UserRepresentation userRep = doGet("/" + encodePathAsIs(resource.getId()) + "/user?value=" + grantedUser,
UserRepresentation.class);

assertNotNull(userRep);
assertNotNull(userRep.getId(), "User ID should be returned");
assertEquals(grantedUser, userRep.getUsername());
assertNull(userRep.getCreatedTimestamp(), "Creation timestamp should not be exposed");
assertNull(userRep.isEnabled(), "Enabled status should not be exposed");
}

@Test
public void testGetUserInfoNonExistent() throws IOException {
Resource resource = getMyResources().get(0);

try (SimpleHttpResponse response = SimpleHttpDefault
.doGet(getAccountUrl("resources/" + encodePathAsIs(resource.getId()) + "/user?value=nonexistent"), httpClient)
.auth(tokenUtil.getToken())
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON)
.asResponse()) {

assertEquals(Response.Status.NO_CONTENT.getStatusCode(), response.getStatus(), "Should return 204 No Content for non-existent user");
}
}

@Test
public void testGetUserInfoDifferentUserCannotAccessAnotherResource() throws IOException {
Resource ownerResource = getMyResources().get(0);

String aliceToken = authzClient.obtainAccessToken("alice", "password").getToken();

try (SimpleHttpResponse response = SimpleHttpDefault
.doGet(getAccountUrl("resources/" + encodePathAsIs(ownerResource.getId()) + "/user?value=bob"), httpClient)
.auth(aliceToken)
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON)
.asResponse()) {

assertEquals(Status.BAD_REQUEST.getStatusCode(), response.getStatus(), "Alice should not be able to access resource owner's endpoint");
}
}

private List<AbstractResourceService.ResourcePermission> getSharedWithMe(String userName) {
return getSharedWithMe(userName, null, -1, -1, null);
}
Expand Down
Loading
0