From 3f2f7118d41d7b2211d1843b3c7e7bd8324013c7 Mon Sep 17 00:00:00 2001 From: Inf1mum Date: Fri, 6 Nov 2026 20:17:21 +0300 Subject: [PATCH 1/3] Reject array-valued aud in FAPI 2.0 client assertion (#54743) Signed-off-by: Inf1mum --- ...ClientAuthenticationAssertionExecutor.java | 22 +-- ...ntAuthenticationAssertionExecutorTest.java | 180 ++++++++++++++++++ 2 files changed, 189 insertions(+), 13 deletions(-) create mode 100644 tests/base/src/test/java/org/keycloak/tests/client/policies/SecureClientAuthenticationAssertionExecutorTest.java diff --git a/services/src/main/java/org/keycloak/services/clientpolicy/executor/SecureClientAuthenticationAssertionExecutor.java b/services/src/main/java/org/keycloak/services/clientpolicy/executor/SecureClientAuthenticationAssertionExecutor.java index b33848c2db8f..52e5febfdd68 100644 --- a/services/src/main/java/org/keycloak/services/clientpolicy/executor/SecureClientAuthenticationAssertionExecutor.java +++ b/services/src/main/java/org/keycloak/services/clientpolicy/executor/SecureClientAuthenticationAssertionExecutor.java @@ -18,9 +18,6 @@ package org.keycloak.services.clientpolicy.executor; import java.io.IOException; -import java.util.ArrayList; -import java.util.Collections; -import java.util.List; import jakarta.ws.rs.core.MultivaluedMap; @@ -37,6 +34,7 @@ import org.keycloak.services.clientpolicy.ClientPolicyException; import org.keycloak.util.JsonSerialization; +import com.fasterxml.jackson.databind.JsonNode; import org.jboss.logging.Logger; /** @@ -96,23 +94,21 @@ private void validateClientAssertion() throws ClientPolicyException { // Decode the client assertion String encodedContent = parts[1]; byte[] content = Base64Url.decode(encodedContent); - JsonWebToken token; + JsonNode payload; try { - token = JsonSerialization.readValue(content, JsonWebToken.class); + payload = JsonSerialization.readValue(content, JsonNode.class); } catch (IOException e) { logger.warnf("client assertion parse error: %s", e.getMessage()); throw new ClientPolicyException(OAuthErrorException.INVALID_REQUEST, "invalid client assertion"); } - // Validate the client assertion audience + // Validate the client assertion audience. The aud claim is required to contain only the issuer identifier + // as a single string value. Array forms are rejected, including single-element arrays such as [""], + // as required by FAPI 2.0 Security Profile section 5.3.2.1. String issuerUrl = Urls.realmIssuer(session.getContext().getUri().getBaseUri(), session.getContext().getRealm().getName()); - List expectedAudiences = new ArrayList<>(Collections.singletonList(issuerUrl)); - if (token.getAudience() == null || token.getAudience().length != 1) { - logger.warnf("invalid audience in client assertion - no audience or multiple audiences found"); - throw new ClientPolicyException(OAuthErrorException.INVALID_REQUEST, "invalid audience in client assertion"); - } - if (!token.hasAnyAudience(expectedAudiences)) { - logger.warnf("invalid audience in client assertion - audience not issuer URL"); + JsonNode audNode = payload.get(JsonWebToken.AUD); + if (audNode == null || !audNode.isTextual() || !issuerUrl.equals(audNode.asText())) { + logger.warnf("invalid audience in client assertion - no audience, multiple audiences, array-valued audience or audience not issuer URL found"); throw new ClientPolicyException(OAuthErrorException.INVALID_REQUEST, "invalid audience in client assertion"); } } diff --git a/tests/base/src/test/java/org/keycloak/tests/client/policies/SecureClientAuthenticationAssertionExecutorTest.java b/tests/base/src/test/java/org/keycloak/tests/client/policies/SecureClientAuthenticationAssertionExecutorTest.java new file mode 100644 index 000000000000..d4e436cc8826 --- /dev/null +++ b/tests/base/src/test/java/org/keycloak/tests/client/policies/SecureClientAuthenticationAssertionExecutorTest.java @@ -0,0 +1,180 @@ +/* + * Copyright 2026 Red Hat, Inc. and/or its affiliates + * and other contributors as indicated by the @author tags. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.keycloak.tests.client.policies; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.UUID; + +import org.keycloak.OAuthErrorException; +import org.keycloak.authentication.authenticators.client.JWTClientSecretAuthenticator; +import org.keycloak.common.util.Time; +import org.keycloak.jose.jws.JWSBuilder; +import org.keycloak.protocol.oidc.OIDCLoginProtocol; +import org.keycloak.representations.JsonWebToken; +import org.keycloak.representations.idm.ClientPolicyConditionConfigurationRepresentation; +import org.keycloak.representations.idm.ClientPolicyExecutorConfigurationRepresentation; +import org.keycloak.services.clientpolicy.condition.AnyClientConditionFactory; +import org.keycloak.services.clientpolicy.executor.SecureClientAuthenticationAssertionExecutorFactory; +import org.keycloak.testframework.annotations.InjectRealm; +import org.keycloak.testframework.annotations.KeycloakIntegrationTest; +import org.keycloak.testframework.oauth.OAuthClient; +import org.keycloak.testframework.oauth.annotations.InjectOAuthClient; +import org.keycloak.testframework.realm.ClientBuilder; +import org.keycloak.testframework.realm.ClientConfig; +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.testsuite.util.oauth.AccessTokenResponse; +import org.keycloak.util.JsonSerialization; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.node.ArrayNode; +import com.fasterxml.jackson.databind.node.JsonNodeFactory; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.fasterxml.jackson.databind.node.TextNode; + +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; + +/** + * Tests for the secure-client-authentication-assertion executor. FAPI 2.0 Security Profile section 5.3.2.1 + * requires the authorization server to only accept its issuer identifier, as a string, in the aud claim of + * client authentication assertions. The array forms must be rejected, including single-element arrays. + */ +@KeycloakIntegrationTest +public class SecureClientAuthenticationAssertionExecutorTest extends AbstractClientPoliciesTest { + + private static final String CLIENT_SECRET = "atleast-14chars-password"; + + @InjectRealm(config = ClientAuthRealmConfig.class) + ManagedRealm realm; + + @InjectOAuthClient(config = ClientAuthClientConfig.class) + OAuthClient oauth; + + @AfterEach + void resetPolicies() { + realm.updateWithCleanup(r -> r.resetClientProfiles().resetClientPolicies()); + } + + @Test + void audIssuerStringAccepted() throws Exception { + setupPolicy(); + + AccessTokenResponse response = requestTokenWithAudience(TextNode.valueOf(oauth.getEndpoints().getIssuer())); + Assertions.assertTrue(response.isSuccess()); + } + + @Test + void audIssuerSingleElementArrayRejected() throws Exception { + setupPolicy(); + + ArrayNode aud = JsonNodeFactory.instance.arrayNode().add(oauth.getEndpoints().getIssuer()); + AccessTokenResponse response = requestTokenWithAudience(aud); + + Assertions.assertEquals(400, response.getStatusCode()); + Assertions.assertEquals(OAuthErrorException.INVALID_GRANT, response.getError()); + Assertions.assertEquals("invalid audience in client assertion", response.getErrorDescription()); + } + + @Test + void audIssuerMultipleElementArrayRejected() throws Exception { + setupPolicy(); + + ArrayNode aud = JsonNodeFactory.instance.arrayNode().add(oauth.getEndpoints().getIssuer()) + .add("https://attacker.example/realms/x"); + AccessTokenResponse response = requestTokenWithAudience(aud); + + Assertions.assertFalse(response.isSuccess()); + } + + @Test + void audTokenEndpointStringRejected() throws Exception { + setupPolicy(); + + AccessTokenResponse response = requestTokenWithAudience(TextNode.valueOf(oauth.getEndpoints().getToken())); + + Assertions.assertEquals(400, response.getStatusCode()); + Assertions.assertEquals(OAuthErrorException.INVALID_GRANT, response.getError()); + Assertions.assertEquals("invalid audience in client assertion", response.getErrorDescription()); + } + + @Test + void audIssuerSingleElementArrayAcceptedWithoutProfile() { + // without the profile the general client authentication flow is unchanged and still accepts the array form + ArrayNode aud = JsonNodeFactory.instance.arrayNode().add(oauth.getEndpoints().getIssuer()); + + AccessTokenResponse response = requestTokenWithAudience(aud); + + Assertions.assertTrue(response.isSuccess()); + } + + private void setupPolicy() throws Exception { + setupPolicy(realm, SecureClientAuthenticationAssertionExecutorFactory.PROVIDER_ID, + new ClientPolicyExecutorConfigurationRepresentation(), AnyClientConditionFactory.PROVIDER_ID, + new ClientPolicyConditionConfigurationRepresentation()); + } + + private AccessTokenResponse requestTokenWithAudience(JsonNode aud) { + oauth.doLogin("test-user@localhost", "password"); + String code = oauth.parseLoginResponse().getCode(); + String clientAssertion = createClientAssertion(aud); + return oauth.accessTokenRequest(code).signedJwt(clientAssertion).send(); + } + + private String createClientAssertion(JsonNode aud) { + ObjectNode payload = JsonSerialization.createObjectNode(); + payload.put("iss", oauth.getClientId()); + payload.put("sub", oauth.getClientId()); + payload.put("jti", UUID.randomUUID().toString()); + payload.put("iat", (long) Time.currentTime()); + payload.put("exp", (long) (Time.currentTime() + 300)); + payload.set(JsonWebToken.AUD, aud); + + try { + return new JWSBuilder().content(JsonSerialization.writeValueAsBytes(payload)) + .hmac256(CLIENT_SECRET.getBytes(StandardCharsets.UTF_8)); + } catch (IOException e) { + throw new RuntimeException(e); + } + } + + public static class ClientAuthRealmConfig implements RealmConfig { + + @Override + public RealmBuilder configure(RealmBuilder realm) { + return realm.users(UserBuilder.create("test-user@localhost").password("password") + .name("Test", "User").email("test-user@localhost").emailVerified(true)); + } + } + + public static class ClientAuthClientConfig implements ClientConfig { + + @Override + public ClientBuilder configure(ClientBuilder client) { + return client.clientId("test-app") + .secret(CLIENT_SECRET) + .protocol(OIDCLoginProtocol.LOGIN_PROTOCOL) + .publicClient(false) + .authenticatorType(JWTClientSecretAuthenticator.PROVIDER_ID) + .redirectUris("http://127.0.0.1:8500/callback/oauth"); + } + } +} From c286932e7bdb6d12a7f3cc4e233b763f89234dbc Mon Sep 17 00:00:00 2001 From: Inf1mum Date: Fri, 6 Nov 2026 23:53:00 +0300 Subject: [PATCH 2/3] Fix spotless import ordering in SecureClientAuthenticationAssertionExecutorTest Signed-off-by: Inf1mum --- .../SecureClientAuthenticationAssertionExecutorTest.java | 1 - 1 file changed, 1 deletion(-) diff --git a/tests/base/src/test/java/org/keycloak/tests/client/policies/SecureClientAuthenticationAssertionExecutorTest.java b/tests/base/src/test/java/org/keycloak/tests/client/policies/SecureClientAuthenticationAssertionExecutorTest.java index d4e436cc8826..15ffab3ac014 100644 --- a/tests/base/src/test/java/org/keycloak/tests/client/policies/SecureClientAuthenticationAssertionExecutorTest.java +++ b/tests/base/src/test/java/org/keycloak/tests/client/policies/SecureClientAuthenticationAssertionExecutorTest.java @@ -48,7 +48,6 @@ import com.fasterxml.jackson.databind.node.JsonNodeFactory; import com.fasterxml.jackson.databind.node.ObjectNode; import com.fasterxml.jackson.databind.node.TextNode; - import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; From c41339805aefd518170da44a5a6806314e6fd118 Mon Sep 17 00:00:00 2001 From: Inf1mum Date: Sat, 7 Nov 2026 02:58:00 +0300 Subject: [PATCH 3/3] Isolate SSO session per test in SecureClientAuthenticationAssertionExecutorTest Signed-off-by: Inf1mum --- .../SecureClientAuthenticationAssertionExecutorTest.java | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/tests/base/src/test/java/org/keycloak/tests/client/policies/SecureClientAuthenticationAssertionExecutorTest.java b/tests/base/src/test/java/org/keycloak/tests/client/policies/SecureClientAuthenticationAssertionExecutorTest.java index 15ffab3ac014..d39146aead52 100644 --- a/tests/base/src/test/java/org/keycloak/tests/client/policies/SecureClientAuthenticationAssertionExecutorTest.java +++ b/tests/base/src/test/java/org/keycloak/tests/client/policies/SecureClientAuthenticationAssertionExecutorTest.java @@ -32,6 +32,7 @@ import org.keycloak.services.clientpolicy.executor.SecureClientAuthenticationAssertionExecutorFactory; import org.keycloak.testframework.annotations.InjectRealm; import org.keycloak.testframework.annotations.KeycloakIntegrationTest; +import org.keycloak.testframework.injection.LifeCycle; import org.keycloak.testframework.oauth.OAuthClient; import org.keycloak.testframework.oauth.annotations.InjectOAuthClient; import org.keycloak.testframework.realm.ClientBuilder; @@ -40,6 +41,8 @@ import org.keycloak.testframework.realm.RealmBuilder; import org.keycloak.testframework.realm.RealmConfig; import org.keycloak.testframework.realm.UserBuilder; +import org.keycloak.testframework.ui.annotations.InjectWebDriver; +import org.keycloak.testframework.ui.webdriver.ManagedWebDriver; import org.keycloak.testsuite.util.oauth.AccessTokenResponse; import org.keycloak.util.JsonSerialization; @@ -65,9 +68,13 @@ public class SecureClientAuthenticationAssertionExecutorTest extends AbstractCli @InjectRealm(config = ClientAuthRealmConfig.class) ManagedRealm realm; - @InjectOAuthClient(config = ClientAuthClientConfig.class) + // method-scoped OAuth client and web driver so that a SSO session from one test does not skip the login form of the next test + @InjectOAuthClient(config = ClientAuthClientConfig.class, lifecycle = LifeCycle.METHOD) OAuthClient oauth; + @InjectWebDriver(lifecycle = LifeCycle.METHOD) + ManagedWebDriver webDriver; + @AfterEach void resetPolicies() { realm.updateWithCleanup(r -> r.resetClientProfiles().resetClientPolicies());