Thanks to visit codestin.com
Credit goes to Github.com

Skip to content

fix: ensuring proper error handling for duplicate protocol mappers #46306

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
ahus1 merged 1 commit into from
Feb 13, 2026
+61 −19
Merged

fix: ensuring proper error handling for duplicate protocol mappers #46306

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
8 changes: 7 additions & 1 deletion server-spi-private/src/main/java/org/keycloak/models/utils/RepresentationToModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,9 @@
import org.keycloak.models.IdentityProviderMapperModel;
import org.keycloak.models.IdentityProviderModel;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.ModelDuplicateException;
import org.keycloak.models.ModelException;
import org.keycloak.models.ModelValidationException;
import org.keycloak.models.OrganizationDomainModel;
import org.keycloak.models.OrganizationModel;
import org.keycloak.models.ProtocolMapperModel;
Expand Down Expand Up @@ -630,7 +632,11 @@ public static void updateClientProtocolMappers(ClientRepresentation rep, ClientM
existingProtocolMappers.remove(protocolNameKey);

} else {
resource.addProtocolMapper(toModel(protocolMapperRepresentation));
try {
resource.addProtocolMapper(toModel(protocolMapperRepresentation));
} catch (ModelDuplicateException e) {
throw new ModelValidationException("Cannot add protocol mapper '%s'. %s".formatted(protocolMapperRepresentation.getName(), e.getMessage()));
}
}
}

Expand Down
5 changes: 4 additions & 1 deletion services/src/main/java/org/keycloak/services/resources/admin/ClientResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
import org.keycloak.models.Constants;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.ModelDuplicateException;
import org.keycloak.models.ModelValidationException;
import org.keycloak.models.RealmModel;
import org.keycloak.models.UserCredentialModel;
import org.keycloak.models.UserModel;
Expand Down Expand Up @@ -183,6 +184,8 @@ public Response update(final ClientRepresentation rep) {
throw ErrorResponse.error(cte.getMessage(), cte.getParameters(), Response.Status.BAD_REQUEST);
} catch (ClientPolicyException cpe) {
throw new ErrorResponseException(cpe.getError(), cpe.getErrorDetail(), Response.Status.BAD_REQUEST);
} catch (ModelValidationException e) {
throw new ErrorResponseException(Errors.INVALID_INPUT, e.getMessage(), Response.Status.BAD_REQUEST);
}
}

Expand Down Expand Up @@ -426,7 +429,7 @@ private void addDefaultClientScope(String clientScopeId, boolean defaultScope) {
}

validateClientScopeAssignment(session, clientScope, defaultScope, realm);

client.addClientScope(clientScope, defaultScope);

adminEvent.operation(OperationType.CREATE).resource(ResourceType.CLIENT_SCOPE_CLIENT_MAPPING).resourcePath(session.getContext().getUri()).success();
Expand Down
2 changes: 1 addition & 1 deletion services/src/main/java/org/keycloak/services/resources/admin/ClientsResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ public ClientModel createClientModel(final ClientRepresentation rep) {
} catch (ClientPolicyException cpe) {
throw new ErrorResponseException(cpe.getError(), cpe.getErrorDetail(), Response.Status.BAD_REQUEST);
} catch (ModelValidationException e) {
throw new ErrorResponseException("validation error", e.getMessage(), Response.Status.BAD_REQUEST);
throw new ErrorResponseException(Errors.INVALID_INPUT, e.getMessage(), Response.Status.BAD_REQUEST);
}
catch (ClientTypeException cte) {
throw ErrorResponse.error(cte.getMessage(), cte.getParameters(), Response.Status.BAD_REQUEST);
Expand Down
65 changes: 49 additions & 16 deletions tests/base/src/test/java/org/keycloak/tests/admin/ClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,9 +351,15 @@ private void testClientUriValidation(boolean create, String expectedRootUrlError
}
rep.setRedirectUris(null);

if (expectedRootUrlError != null) rep.setRootUrl(testUrl);
if (expectedBaseUrlError != null) rep.setBaseUrl(testUrl);
if (expectedRedirectUrisError != null) rep.setRedirectUris(List.of(testUrl));
if (expectedRootUrlError != null) {
rep.setRootUrl(testUrl);
}
if (expectedBaseUrlError != null) {
rep.setBaseUrl(testUrl);
}
if (expectedRedirectUrisError != null) {
rep.setRedirectUris(List.of(testUrl));
}
createOrUpdateClientExpectingValidationErrors(rep, create, expectedRootUrlError, expectedBaseUrlError, expectedRedirectUrisError);

rep.setRootUrl(null);
Expand Down Expand Up @@ -969,27 +975,54 @@ public void updateClientWithProtocolMapper() {

ClientRepresentation storedClient = managedRealm.admin().clients().get(client.getId()).toRepresentation();
assertClient(client, storedClient);

// try adding a duplicate protocol mapper
protocolMappers.add(barMapper);
newClient.setProtocolMappers(protocolMappers);

createOrUpdateClientExpectingValidationErrors(newClient, false, "Cannot add protocol mapper 'bar'. Protocol mapper name must be unique per protocol");
}

public static void assertClient(ClientRepresentation client, ClientRepresentation storedClient) {
if (client.getClientId() != null) Assert.assertEquals(client.getClientId(), storedClient.getClientId());
if (client.getName() != null) Assert.assertEquals(client.getName(), storedClient.getName());
if (client.isEnabled() != null) Assert.assertEquals(client.isEnabled(), storedClient.isEnabled());
if (client.isAlwaysDisplayInConsole() != null)
if (client.getClientId() != null) {
Assert.assertEquals(client.getClientId(), storedClient.getClientId());
}
if (client.getName() != null) {
Assert.assertEquals(client.getName(), storedClient.getName());
}
if (client.isEnabled() != null) {
Assert.assertEquals(client.isEnabled(), storedClient.isEnabled());
}
if (client.isAlwaysDisplayInConsole() != null) {
Assert.assertEquals(client.isAlwaysDisplayInConsole(), storedClient.isAlwaysDisplayInConsole());
if (client.isBearerOnly() != null) Assert.assertEquals(client.isBearerOnly(), storedClient.isBearerOnly());
if (client.isPublicClient() != null)
}
if (client.isBearerOnly() != null) {
Assert.assertEquals(client.isBearerOnly(), storedClient.isBearerOnly());
}
if (client.isPublicClient() != null) {
Assert.assertEquals(client.isPublicClient(), storedClient.isPublicClient());
if (client.isFullScopeAllowed() != null)
}
if (client.isFullScopeAllowed() != null) {
Assert.assertEquals(client.isFullScopeAllowed(), storedClient.isFullScopeAllowed());
if (client.getRootUrl() != null) Assert.assertEquals(client.getRootUrl(), storedClient.getRootUrl());
if (client.getAdminUrl() != null) Assert.assertEquals(client.getAdminUrl(), storedClient.getAdminUrl());
if (client.getBaseUrl() != null) Assert.assertEquals(client.getBaseUrl(), storedClient.getBaseUrl());
if (client.isSurrogateAuthRequired() != null)
}
if (client.getRootUrl() != null) {
Assert.assertEquals(client.getRootUrl(), storedClient.getRootUrl());
}
if (client.getAdminUrl() != null) {
Assert.assertEquals(client.getAdminUrl(), storedClient.getAdminUrl());
}
if (client.getBaseUrl() != null) {
Assert.assertEquals(client.getBaseUrl(), storedClient.getBaseUrl());
}
if (client.isSurrogateAuthRequired() != null) {
Assert.assertEquals(client.isSurrogateAuthRequired(), storedClient.isSurrogateAuthRequired());
if (client.getClientAuthenticatorType() != null)
}
if (client.getClientAuthenticatorType() != null) {
Assert.assertEquals(client.getClientAuthenticatorType(), storedClient.getClientAuthenticatorType());
if (client.getSecret() != null) Assert.assertEquals(client.getSecret(), storedClient.getSecret());
}
if (client.getSecret() != null) {
Assert.assertEquals(client.getSecret(), storedClient.getSecret());
}

if (client.getNotBefore() != null) {
Assertions.assertEquals(client.getNotBefore(), storedClient.getNotBefore());
Expand Down
Loading