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

Skip to content

added better validation and more validation tests #46277

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
vmuzikar merged 4 commits into from
Feb 18, 2026
Merged

added better validation and more validation tests #46277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e51272a
added better validation and more validation tests
edewit Feb 12, 2026
a41443d
Use getClientsApiUrl() in tests
mabartos Feb 12, 2026
bbc22df
refactored removed duplication
edewit Feb 13, 2026
0694795
added test for update
edewit Feb 16, 2026
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
7 changes: 7 additions & 0 deletions rest/admin-v2/api/src/main/java/org/keycloak/services/client/DefaultClientService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import org.keycloak.services.resources.admin.ClientsResource;
import org.keycloak.services.resources.admin.RealmAdminResource;
import org.keycloak.services.resources.admin.fgap.AdminPermissionEvaluator;
import org.keycloak.validation.ValidationUtil;
import org.keycloak.validation.jakarta.HibernateValidatorProvider;
import org.keycloak.validation.jakarta.JakartaValidatorProvider;

Expand Down Expand Up @@ -125,6 +126,12 @@ public CreateOrUpdateResult createOrUpdate(RealmModel realm, BaseClientRepresent
clientResource = clientsResource.getClient(model.getId());

mapper.toModel(client, model);

// Validate the fully populated model (createClientModel only validates the basic model)
ValidationUtil.validateClient(session, model, true, r -> {
session.getTransactionManager().setRollbackOnly();
throw new ServiceException(r.getAllErrorsAsString(), Response.Status.BAD_REQUEST);
});
}

handleRoles(client.getRoles());
Expand Down
178 changes: 178 additions & 0 deletions rest/admin-v2/tests/src/test/java/org/keycloak/tests/admin/client/v2/ClientApiV2Test.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.util.EntityUtils;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;

import static org.keycloak.services.cors.Cors.ACCESS_CONTROL_ALLOW_METHODS;
Expand Down Expand Up @@ -617,6 +618,183 @@ public void preflight() throws Exception {
}
}

@Test
public void createClientWithInvalidRedirectUriFragment() throws Exception {
OIDCClientRepresentation rep = new OIDCClientRepresentation();
rep.setEnabled(true);
rep.setClientId("client-invalid-fragment");
rep.setRedirectUris(Set.of("http://localhost:3000#fragment"));
assertClientCreationFailsWithError(rep, "Redirect URIs must not contain an URI fragment");
}

@Test
public void createClientWithInvalidRedirectUriScheme() throws Exception {
OIDCClientRepresentation rep = new OIDCClientRepresentation();
rep.setEnabled(true);
rep.setClientId("client-invalid-scheme");
rep.setRedirectUris(Set.of("javascript:alert(1)"));
assertClientCreationFailsWithError(rep, "Each redirect URL must be valid");
}

@Test
@Disabled("Root URL fragment validation not yet implemented in V2 API")
public void createClientWithInvalidRootUrl() throws Exception {
OIDCClientRepresentation rep = new OIDCClientRepresentation();
rep.setEnabled(true);
rep.setClientId("client-invalid-root-url");
rep.setAppUrl("http://localhost:3000#fragment");
assertClientCreationFailsWithError(rep, "Root URL must not contain an URL fragment");
}

@Test
public void createSamlClientWithInvalidRedirectUriFragment() throws Exception {
SAMLClientRepresentation rep = new SAMLClientRepresentation();
rep.setEnabled(true);
rep.setClientId("saml-client-invalid-fragment");
rep.setRedirectUris(Set.of("http://localhost:3000#fragment"));
assertClientCreationFailsWithError(rep, "Redirect URIs must not contain an URI fragment");
}

@Test
public void createSamlClientWithInvalidRedirectUriScheme() throws Exception {
SAMLClientRepresentation rep = new SAMLClientRepresentation();
rep.setEnabled(true);
rep.setClientId("saml-client-invalid-scheme");
rep.setRedirectUris(Set.of("javascript:alert(1)"));
assertClientCreationFailsWithError(rep, "Each redirect URL must be valid");
}

@Test
@Disabled("Root URL fragment validation not yet implemented in V2 API")
public void createSamlClientWithInvalidRootUrl() throws Exception {
SAMLClientRepresentation rep = new SAMLClientRepresentation();
rep.setEnabled(true);
rep.setClientId("saml-client-invalid-root-url");
rep.setAppUrl("http://localhost:3000#fragment");
assertClientCreationFailsWithError(rep, "Root URL must not contain an URL fragment");
}

@Test
public void updateClientWithInvalidRedirectUriFragment() throws Exception {
OIDCClientRepresentation rep = new OIDCClientRepresentation();
rep.setEnabled(true);
rep.setClientId("client-update-invalid-fragment");
rep.setRedirectUris(Set.of("http://localhost:3000#fragment"));
assertClientUpdateFailsWithError(rep, "Redirect URIs must not contain an URI fragment");
}

@Test
public void updateClientWithInvalidRedirectUriScheme() throws Exception {
OIDCClientRepresentation rep = new OIDCClientRepresentation();
rep.setEnabled(true);
rep.setClientId("client-update-invalid-scheme");
rep.setRedirectUris(Set.of("javascript:alert(1)"));
assertClientUpdateFailsWithError(rep, "A redirect URI uses an illegal scheme");
}

@Test
@Disabled("Root URL fragment validation not yet implemented in V2 API")
public void updateClientWithInvalidRootUrl() throws Exception {
OIDCClientRepresentation rep = new OIDCClientRepresentation();
rep.setEnabled(true);
rep.setClientId("client-update-invalid-root-url");
rep.setAppUrl("http://localhost:3000#fragment");
assertClientUpdateFailsWithError(rep, "Root URL must not contain an URL fragment");
}

@Test
public void updateSamlClientWithInvalidRedirectUriFragment() throws Exception {
SAMLClientRepresentation rep = new SAMLClientRepresentation();
rep.setEnabled(true);
rep.setClientId("saml-client-update-invalid-fragment");
rep.setRedirectUris(Set.of("http://localhost:3000#fragment"));
assertClientUpdateFailsWithError(rep, "Redirect URIs must not contain an URI fragment");
}

@Test
public void updateSamlClientWithInvalidRedirectUriScheme() throws Exception {
SAMLClientRepresentation rep = new SAMLClientRepresentation();
rep.setEnabled(true);
rep.setClientId("saml-client-update-invalid-scheme");
rep.setRedirectUris(Set.of("javascript:alert(1)"));
assertClientUpdateFailsWithError(rep, "A redirect URI uses an illegal scheme");
}

@Test
@Disabled("Root URL fragment validation not yet implemented in V2 API")
public void updateSamlClientWithInvalidRootUrl() throws Exception {
SAMLClientRepresentation rep = new SAMLClientRepresentation();
rep.setEnabled(true);
rep.setClientId("saml-client-update-invalid-root-url");
rep.setAppUrl("http://localhost:3000#fragment");
assertClientUpdateFailsWithError(rep, "Root URL must not contain an URL fragment");
}

/**
* Helper method to verify that client creation fails with the expected validation error.
* This verifies that ValidationUtil.validateClient is called after the full model is populated.
*/
private void assertClientCreationFailsWithError(BaseClientRepresentation rep, String expectedErrorMessage) throws Exception {
HttpPost request = new HttpPost(getClientsApiUrl());
setAuthHeader(request);
request.setHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON);
request.setEntity(new StringEntity(mapper.writeValueAsString(rep)));

try (var response = client.execute(request)) {
assertThat(response.getStatusLine().getStatusCode(), is(400));
String body = EntityUtils.toString(response.getEntity());
assertThat(body, containsString(expectedErrorMessage));
}
}

/**
* Helper method to verify that client update fails with the expected validation error.
* First creates a valid client, then attempts to update it with invalid data.
*/
private void assertClientUpdateFailsWithError(BaseClientRepresentation rep, String expectedErrorMessage) throws Exception {
String clientId = rep.getClientId();

// First, create a valid client
HttpPut createRequest = new HttpPut(getClientsApiUrl() + "/" + clientId);
setAuthHeader(createRequest);
createRequest.setHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON);

BaseClientRepresentation validRep;
if (rep instanceof SAMLClientRepresentation) {
validRep = new SAMLClientRepresentation();
} else {
validRep = new OIDCClientRepresentation();
}
validRep.setClientId(clientId);
validRep.setEnabled(true);

createRequest.setEntity(new StringEntity(mapper.writeValueAsString(validRep)));

try (var response = client.execute(createRequest)) {
assertThat(response.getStatusLine().getStatusCode(), is(201));
EntityUtils.consumeQuietly(response.getEntity());
}

// Now try to update with invalid data
HttpPut updateRequest = new HttpPut(getClientsApiUrl() + "/" + clientId);
setAuthHeader(updateRequest);
updateRequest.setHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON);
updateRequest.setEntity(new StringEntity(mapper.writeValueAsString(rep)));

try (var response = client.execute(updateRequest)) {
assertThat(response.getStatusLine().getStatusCode(), is(400));
String body = EntityUtils.toString(response.getEntity());
assertThat(body, containsString(expectedErrorMessage));
}

// Cleanup: delete the created client
HttpDelete deleteRequest = new HttpDelete(getClientsApiUrl() + "/" + clientId);
Copy link
Contributor

@mabartos mabartos Feb 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: It'd be good to have the cleanup either in the try-finally block, or some other error-resistant cleanup. But it can be done in a follow-up tasks as we'd need to probably polish other tests as well.

setAuthHeader(deleteRequest);
try (var response = client.execute(deleteRequest)) {
EntityUtils.consumeQuietly(response.getEntity());
}
}

private OIDCClientRepresentation getTestingFullClientRep() {
var rep = new OIDCClientRepresentation();
rep.setClientId("my-client");
Expand Down
Loading