From c273886394a3e2cbfebe20b164810d039a9f6218 Mon Sep 17 00:00:00 2001 From: Jyotirmoy Roy Date: Sat, 3 Oct 2026 08:11:58 +0530 Subject: [PATCH 1/8] Reject blank usernames created by identity provider mappers Signed-off-by: Jyotirmoy Roy --- .../topics/changes/changes-26_8_1.adoc | 9 + .../cache/infinispan/UserCacheManager.java | 2 +- .../events/UserFullInvalidationEvent.java | 2 +- .../keycloak/models/jpa/JpaUserProvider.java | 6 +- .../keycloak/storage/UserStorageManager.java | 4 + .../org/keycloak/models/UserProvider.java | 3 +- .../oidc/mappers/UsernameTemplateMapper.java | 24 +-- .../saml/mappers/UsernameTemplateMapper.java | 24 +-- .../AbstractTokenExchangeProvider.java | 4 +- .../resources/IdentityBrokerService.java | 4 +- .../mappers/UsernameTemplateMapperTest.java | 186 ++++++++++++++++++ .../saml/UsernameTemplateMapperTest.java | 175 ++++++++++++++++ ...dpCreateUserIfUniqueAuthenticatorTest.java | 15 ++ 13 files changed, 427 insertions(+), 31 deletions(-) create mode 100644 services/src/test/java/org/keycloak/test/broker/oidc/mappers/UsernameTemplateMapperTest.java create mode 100644 services/src/test/java/org/keycloak/test/broker/saml/UsernameTemplateMapperTest.java diff --git a/docs/documentation/upgrading/topics/changes/changes-26_8_1.adoc b/docs/documentation/upgrading/topics/changes/changes-26_8_1.adoc index 2a5010faa17e..a493ff546443 100644 --- a/docs/documentation/upgrading/topics/changes/changes-26_8_1.adoc +++ b/docs/documentation/upgrading/topics/changes/changes-26_8_1.adoc @@ -17,3 +17,12 @@ Although no issues are expected, the previous behavior can be restored with the bin/kc.[sh|bat] start --spi-storage--ldap--disable-kerberos-authentication-round-trip true \ --spi-storage--kerberos--disable-kerberos-authentication-round-trip true ---- + +=== Identity provider mappers no longer create users with a blank username +// https://github.com/keycloak/keycloak/issues/53164 + +When the username template of an identity provider mapper could not be fully resolved, the mapper set a blank username and the federated account was created with it. Such an account cannot be found by username, and could not be edited or deleted, because invalidating the user in the cache required a username. + +A username template that does not resolve to a non-blank username now fails the login with an error, and `addUser` rejects a blank username. Accounts that were already created with a blank username can be edited and deleted again. + +Review the username template of any identity provider mapper that does not resolve for every user, before upgrading. diff --git a/model/infinispan/src/main/java/org/keycloak/models/cache/infinispan/UserCacheManager.java b/model/infinispan/src/main/java/org/keycloak/models/cache/infinispan/UserCacheManager.java index f7e933761b16..ab935db4b3e9 100755 --- a/model/infinispan/src/main/java/org/keycloak/models/cache/infinispan/UserCacheManager.java +++ b/model/infinispan/src/main/java/org/keycloak/models/cache/infinispan/UserCacheManager.java @@ -47,7 +47,7 @@ protected Logger getLogger() { public void userUpdatedInvalidations(String userId, String username, String email, String realmId, Set invalidations) { invalidations.add(userId); if (email != null) invalidations.add(UserCacheSession.getUserByEmailCacheKey(realmId, email)); - invalidations.add(UserCacheSession.getUserByUsernameCacheKey(realmId, username)); + if (username != null) invalidations.add(UserCacheSession.getUserByUsernameCacheKey(realmId, username)); } // Fully invalidate user including consents and federatedIdentity links. diff --git a/model/infinispan/src/main/java/org/keycloak/models/cache/infinispan/events/UserFullInvalidationEvent.java b/model/infinispan/src/main/java/org/keycloak/models/cache/infinispan/events/UserFullInvalidationEvent.java index 9516f067b13f..c6242f63c461 100644 --- a/model/infinispan/src/main/java/org/keycloak/models/cache/infinispan/events/UserFullInvalidationEvent.java +++ b/model/infinispan/src/main/java/org/keycloak/models/cache/infinispan/events/UserFullInvalidationEvent.java @@ -53,7 +53,7 @@ public class UserFullInvalidationEvent extends InvalidationEvent implements User private UserFullInvalidationEvent(String id, String username, String email, String realmId, boolean identityFederationEnabled, Map federatedIdentities) { super(id); - this.username = Objects.requireNonNull(username); + this.username = username; this.email = email; this.realmId = Objects.requireNonNull(realmId); this.federatedIdentities = federatedIdentities; diff --git a/model/jpa/src/main/java/org/keycloak/models/jpa/JpaUserProvider.java b/model/jpa/src/main/java/org/keycloak/models/jpa/JpaUserProvider.java index 7ae6ae42e289..5ca5734054e6 100755 --- a/model/jpa/src/main/java/org/keycloak/models/jpa/JpaUserProvider.java +++ b/model/jpa/src/main/java/org/keycloak/models/jpa/JpaUserProvider.java @@ -121,6 +121,10 @@ public JpaUserProvider(KeycloakSession session, EntityManager em) { @Override public UserModel addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) { + if (StringUtil.isBlank(username)) { + throw new ModelException("Cannot create a user without a username"); + } + if (id == null) { id = KeycloakModelUtils.generateId(); } @@ -158,7 +162,7 @@ public UserModel addUser(RealmModel realm, String id, String username, boolean a @Override public UserModel addUser(RealmModel realm, String username) { - return addUser(realm, KeycloakModelUtils.generateId(), username.toLowerCase(), true, true); + return addUser(realm, KeycloakModelUtils.generateId(), username, true, true); } @Override diff --git a/model/storage-private/src/main/java/org/keycloak/storage/UserStorageManager.java b/model/storage-private/src/main/java/org/keycloak/storage/UserStorageManager.java index a9c18e42cc7e..42d609c4ee3e 100755 --- a/model/storage-private/src/main/java/org/keycloak/storage/UserStorageManager.java +++ b/model/storage-private/src/main/java/org/keycloak/storage/UserStorageManager.java @@ -497,6 +497,10 @@ private static Stream removeDuplicates(Stream withDuplicat @Override public UserModel addUser(RealmModel realm, String username) { + if (StringUtil.isBlank(username)) { + throw new ModelException("Cannot create a user without a username"); + } + if (username.startsWith(ServiceAccountConstants.SERVICE_ACCOUNT_USER_PREFIX)) { // Don't use federation for service account user return localStorage().addUser(realm, username); diff --git a/server-spi/src/main/java/org/keycloak/models/UserProvider.java b/server-spi/src/main/java/org/keycloak/models/UserProvider.java index 8bd7810bbb31..6672288d34b1 100755 --- a/server-spi/src/main/java/org/keycloak/models/UserProvider.java +++ b/server-spi/src/main/java/org/keycloak/models/UserProvider.java @@ -79,7 +79,8 @@ public interface UserProvider extends Provider, * @param addDefaultRequiredActions if {@code true}, all default required actions are added to the created user * @return model of created user * - * @throws NullPointerException when username or realm is {@code null} + * @throws NullPointerException when realm is {@code null} + * @throws ModelException when username is {@code null} or empty * @throws ModelDuplicateException when a user with given id or username already exists */ UserModel addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions); diff --git a/services/src/main/java/org/keycloak/broker/oidc/mappers/UsernameTemplateMapper.java b/services/src/main/java/org/keycloak/broker/oidc/mappers/UsernameTemplateMapper.java index 30116b5b230e..e83d0276cd2a 100755 --- a/services/src/main/java/org/keycloak/broker/oidc/mappers/UsernameTemplateMapper.java +++ b/services/src/main/java/org/keycloak/broker/oidc/mappers/UsernameTemplateMapper.java @@ -31,6 +31,7 @@ import org.keycloak.broker.oidc.KeycloakOIDCIdentityProviderFactory; import org.keycloak.broker.oidc.OIDCIdentityProviderFactory; import org.keycloak.broker.provider.BrokeredIdentityContext; +import org.keycloak.broker.provider.IdentityBrokerException; import org.keycloak.broker.saml.mappers.UsernameTemplateMapper.Target; import org.keycloak.models.IdentityProviderMapperModel; import org.keycloak.models.IdentityProviderSyncMode; @@ -39,6 +40,7 @@ import org.keycloak.models.UserModel; import org.keycloak.models.utils.KeycloakModelUtils; import org.keycloak.provider.ProviderConfigProperty; +import org.keycloak.utils.StringUtil; import org.keycloak.social.bitbucket.BitbucketIdentityProviderFactory; import org.keycloak.social.facebook.FacebookIdentityProviderFactory; import org.keycloak.social.github.GitHubIdentityProviderFactory; @@ -52,8 +54,6 @@ import org.keycloak.social.stackoverflow.StackoverflowIdentityProviderFactory; import org.keycloak.social.twitter.TwitterIdentityProviderFactory; -import org.jboss.logging.Logger; - import static org.keycloak.broker.saml.mappers.UsernameTemplateMapper.TARGET; import static org.keycloak.broker.saml.mappers.UsernameTemplateMapper.TARGETS; import static org.keycloak.broker.saml.mappers.UsernameTemplateMapper.TRANSFORMERS; @@ -65,8 +65,6 @@ */ public class UsernameTemplateMapper extends AbstractClaimMapper { - private static final Logger logger = Logger.getLogger(UsernameTemplateMapper.class); - public static final String[] COMPATIBLE_PROVIDERS = { KeycloakOIDCIdentityProviderFactory.PROVIDER_ID, OIDCIdentityProviderFactory.PROVIDER_ID, @@ -149,8 +147,10 @@ public void updateBrokeredUserLegacy(KeycloakSession session, RealmModel realm, @Override public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) { // preprocessFederatedIdentity gets called anyways, so we only need to set the username if necessary. - // However, we don't want to set the username when the email is used as username - if (getTarget(mapperModel.getConfig().get(TARGET)) == Target.LOCAL && !realm.isRegistrationEmailAsUsername()) { + // However, we don't want to set the username when the email is used as username, and we must never + // overwrite an existing username with a blank one as such a user can no longer be managed + if (getTarget(mapperModel.getConfig().get(TARGET)) == Target.LOCAL && !realm.isRegistrationEmailAsUsername() + && StringUtil.isNotBlank(context.getModelUsername())) { user.setUsername(context.getModelUsername()); } } @@ -195,13 +195,15 @@ private void setUserNameFromTemplate(IdentityProviderMapperModel mapperModel, Br } m.appendTail(sb); - if (hasUnresolvedVariable) { - logger.warnf("Username template '%s' for identity provider '%s' contains unresolved claims. Check that the identity provider is sending the expected claims.", - template, context.getIdpConfig().getAlias()); + Target t = getTarget(mapperModel.getConfig().get(TARGET)); + String username = sb.toString(); + + if (hasUnresolvedVariable || StringUtil.isBlank(username)) { + throw new IdentityBrokerException("Username template '%s' for identity provider '%s' could not be resolved to a username, check that the identity provider sends the expected claims." + .formatted(template, context.getIdpConfig().getAlias())); } - Target t = getTarget(mapperModel.getConfig().get(TARGET)); - t.set(context, hasUnresolvedVariable ? "" : sb.toString()); + t.set(context, username); } @Override diff --git a/services/src/main/java/org/keycloak/broker/saml/mappers/UsernameTemplateMapper.java b/services/src/main/java/org/keycloak/broker/saml/mappers/UsernameTemplateMapper.java index e6d7eeac9ae2..7896769fe15c 100755 --- a/services/src/main/java/org/keycloak/broker/saml/mappers/UsernameTemplateMapper.java +++ b/services/src/main/java/org/keycloak/broker/saml/mappers/UsernameTemplateMapper.java @@ -31,6 +31,7 @@ import org.keycloak.broker.provider.AbstractIdentityProviderMapper; import org.keycloak.broker.provider.BrokeredIdentityContext; +import org.keycloak.broker.provider.IdentityBrokerException; import org.keycloak.broker.saml.SAMLEndpoint; import org.keycloak.broker.saml.SAMLIdentityProviderFactory; import org.keycloak.dom.saml.v2.assertion.AssertionType; @@ -45,8 +46,7 @@ import org.keycloak.models.UserModel; import org.keycloak.models.utils.KeycloakModelUtils; import org.keycloak.provider.ProviderConfigProperty; - -import org.jboss.logging.Logger; +import org.keycloak.utils.StringUtil; /** * @author Bill Burke @@ -54,8 +54,6 @@ */ public class UsernameTemplateMapper extends AbstractIdentityProviderMapper { - private static final Logger logger = Logger.getLogger(UsernameTemplateMapper.class); - public static final String[] COMPATIBLE_PROVIDERS = {SAMLIdentityProviderFactory.PROVIDER_ID}; public static final String TEMPLATE = "template"; @@ -147,9 +145,9 @@ public void updateBrokeredUserLegacy(KeycloakSession session, RealmModel realm, @Override public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) { - // preprocessFederatedIdentity gets called anyways, so we only need to set the username if necessary. - // However, we don't want to set the username when the email is used as username - if (getTarget(mapperModel.getConfig().get(TARGET)) == Target.LOCAL && !realm.isRegistrationEmailAsUsername()) { + + if (getTarget(mapperModel.getConfig().get(TARGET)) == Target.LOCAL && !realm.isRegistrationEmailAsUsername() + && StringUtil.isNotBlank(context.getModelUsername())) { user.setUsername(context.getModelUsername()); } } @@ -208,13 +206,15 @@ private void setUserNameFromTemplate(IdentityProviderMapperModel mapperModel, Br } m.appendTail(sb); - if (hasUnresolvedVariable) { - logger.warnf("Username template '%s' for identity provider '%s' contains unresolved attributes. Check that the identity provider is sending the expected SAML attributes.", - template, context.getIdpConfig().getAlias()); + Target t = getTarget(mapperModel.getConfig().get(TARGET)); + String username = sb.toString(); + + if (hasUnresolvedVariable || StringUtil.isBlank(username)) { + throw new IdentityBrokerException("Username template '%s' for identity provider '%s' could not be resolved to a username, check that the identity provider sends the expected attributes." + .formatted(template, context.getIdpConfig().getAlias())); } - Target t = getTarget(mapperModel.getConfig().get(TARGET)); - t.set(context, hasUnresolvedVariable ? "" : sb.toString()); + t.set(context, username); } @Override diff --git a/services/src/main/java/org/keycloak/protocol/oidc/tokenexchange/AbstractTokenExchangeProvider.java b/services/src/main/java/org/keycloak/protocol/oidc/tokenexchange/AbstractTokenExchangeProvider.java index e95e9e37b0ed..f1d3216f33a7 100644 --- a/services/src/main/java/org/keycloak/protocol/oidc/tokenexchange/AbstractTokenExchangeProvider.java +++ b/services/src/main/java/org/keycloak/protocol/oidc/tokenexchange/AbstractTokenExchangeProvider.java @@ -341,10 +341,10 @@ protected UserModel importUserFromExternalIdentity(BrokeredIdentityContext conte logger.debugf("Federated user not found for provider '%s' and broker username '%s'.", providerId, context.getUsername()); String username = context.getModelUsername(); - if (username == null) { + if (Validation.isBlank(username)) { if (this.realm.isRegistrationEmailAsUsername() && !Validation.isBlank(context.getEmail())) { username = context.getEmail(); - } else if (context.getUsername() == null) { + } else if (Validation.isBlank(context.getUsername())) { username = context.getIdpConfig().getAlias() + "." + context.getId(); } else { username = context.getUsername(); diff --git a/services/src/main/java/org/keycloak/services/resources/IdentityBrokerService.java b/services/src/main/java/org/keycloak/services/resources/IdentityBrokerService.java index fcf2f5e28dfa..efcb9d85fa5c 100755 --- a/services/src/main/java/org/keycloak/services/resources/IdentityBrokerService.java +++ b/services/src/main/java/org/keycloak/services/resources/IdentityBrokerService.java @@ -775,10 +775,10 @@ public Response authenticated(BrokeredIdentityContext context) { authenticationSession.setAuthNote(AbstractUsernameFormAuthenticator.ATTEMPTED_USERNAME, context.getUsername()); String username = context.getModelUsername(); - if (username == null) { + if (Validation.isBlank(username)) { if (this.realmModel.isRegistrationEmailAsUsername() && !Validation.isBlank(context.getEmail())) { username = context.getEmail(); - } else if (context.getUsername() == null) { + } else if (Validation.isBlank(context.getUsername())) { username = context.getIdpConfig().getAlias() + "." + context.getId(); } else { username = context.getUsername(); diff --git a/services/src/test/java/org/keycloak/test/broker/oidc/mappers/UsernameTemplateMapperTest.java b/services/src/test/java/org/keycloak/test/broker/oidc/mappers/UsernameTemplateMapperTest.java new file mode 100644 index 000000000000..1a92ca9311cd --- /dev/null +++ b/services/src/test/java/org/keycloak/test/broker/oidc/mappers/UsernameTemplateMapperTest.java @@ -0,0 +1,186 @@ +/* + * Copyright 2016 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.test.broker.oidc.mappers; + +import java.lang.reflect.Method; +import java.lang.reflect.Proxy; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.function.BiFunction; + +import org.keycloak.broker.oidc.OIDCIdentityProvider; +import org.keycloak.broker.oidc.mappers.UsernameTemplateMapper; +import org.keycloak.broker.provider.BrokeredIdentityContext; +import org.keycloak.broker.provider.IdentityBrokerException; +import org.keycloak.broker.saml.mappers.UsernameTemplateMapper.Target; +import org.keycloak.models.IdentityProviderMapperModel; +import org.keycloak.models.IdentityProviderModel; +import org.keycloak.models.RealmModel; +import org.keycloak.models.UserModel; +import org.keycloak.representations.JsonWebToken; + +import org.junit.Test; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; +import static org.keycloak.broker.saml.mappers.UsernameTemplateMapper.TARGET; + +/** + * Unit test for {@link UsernameTemplateMapper} making sure a username template that cannot be resolved never + * results in a blank username. + */ +public class UsernameTemplateMapperTest { + + private static final String ALIAS = "myidp"; + + private final UsernameTemplateMapper mapper = new UsernameTemplateMapper(); + + @Test + public void resolvedTemplateSetsUsername() { + BrokeredIdentityContext context = context("preferred_username", "jdoe"); + + mapper.preprocessFederatedIdentity(null, null, mapperModel(Target.LOCAL, "${ALIAS}-${CLAIM.preferred_username}"), context); + + assertEquals(ALIAS + "-jdoe", context.getModelUsername()); + } + + @Test + public void missingClaimIsRejected() { + BrokeredIdentityContext context = context("preferred_username", "jdoe"); + context.setModelUsername("previous-username"); + + IdentityBrokerException e = assertThrows(IdentityBrokerException.class, + () -> mapper.preprocessFederatedIdentity(null, null, mapperModel(Target.LOCAL, "${CLAIM.non-existent-claim}"), context)); + + assertTrue(e.getMessage(), e.getMessage().contains("${CLAIM.non-existent-claim}")); + assertEquals("the existing username must not be overwritten", "previous-username", context.getModelUsername()); + } + + @Test + public void partiallyMissingClaimIsRejected() { + BrokeredIdentityContext context = context("preferred_username", "jdoe"); + + assertThrows(IdentityBrokerException.class, + () -> mapper.preprocessFederatedIdentity(null, null, mapperModel(Target.LOCAL, "${ALIAS}-${CLAIM.non-existent-claim}"), context)); + + assertNull("an incomplete username must not be applied", context.getModelUsername()); + } + + @Test + public void emptyClaimValueIsRejected() { + BrokeredIdentityContext context = context("preferred_username", ""); + + assertThrows(IdentityBrokerException.class, + () -> mapper.preprocessFederatedIdentity(null, null, mapperModel(Target.LOCAL, "${CLAIM.preferred_username}"), context)); + + assertNull(context.getModelUsername()); + } + + @Test + public void brokerTargetsAreApplied() { + BrokeredIdentityContext id = context("preferred_username", "jdoe"); + mapper.preprocessFederatedIdentity(null, null, mapperModel(Target.BROKER_ID, "${CLAIM.preferred_username}"), id); + assertEquals("jdoe", id.getId()); + + BrokeredIdentityContext name = context("preferred_username", "jdoe"); + mapper.preprocessFederatedIdentity(null, null, mapperModel(Target.BROKER_USERNAME, "${CLAIM.preferred_username}"), name); + assertEquals("jdoe", name.getUsername()); + } + + @Test + public void updateBrokeredUserUpdatesUsername() { + BrokeredIdentityContext context = context("preferred_username", "jdoe"); + context.setModelUsername(ALIAS + "-jdoe"); + List written = new ArrayList<>(); + + mapper.updateBrokeredUser(null, realm(false), user(written), mapperModel(Target.LOCAL, "${ALIAS}"), context); + + assertEquals(List.of(ALIAS + "-jdoe"), written); + } + + @Test + public void updateBrokeredUserNeverBlanksExistingUsername() { + for (String username : new String[]{null, "", " "}) { + BrokeredIdentityContext context = context("preferred_username", "jdoe"); + context.setModelUsername(username); + List written = new ArrayList<>(); + + mapper.updateBrokeredUser(null, realm(false), user(written), mapperModel(Target.LOCAL, "${ALIAS}"), context); + + assertEquals("username [" + username + "] must not be written back", List.of(), written); + } + } + + @Test + public void updateBrokeredUserKeepsUsernameWhenEmailIsUsedAsUsername() { + BrokeredIdentityContext context = context("preferred_username", "jdoe"); + context.setModelUsername(ALIAS + "-jdoe"); + List written = new ArrayList<>(); + + mapper.updateBrokeredUser(null, realm(true), user(written), mapperModel(Target.LOCAL, "${ALIAS}"), context); + + assertEquals(List.of(), written); + } + + private BrokeredIdentityContext context(String claimName, Object claimValue) { + IdentityProviderModel idpConfig = new IdentityProviderModel(); + idpConfig.setAlias(ALIAS); + idpConfig.setEnabled(true); + + JsonWebToken idToken = new JsonWebToken(); + idToken.setSubject("sub-1"); + idToken.getOtherClaims().put(claimName, claimValue); + + BrokeredIdentityContext context = new BrokeredIdentityContext("sub-1", idpConfig); + context.getContextData().put(OIDCIdentityProvider.VALIDATED_ID_TOKEN, idToken); + return context; + } + + private IdentityProviderMapperModel mapperModel(Target target, String template) { + Map config = new HashMap<>(); + config.put(UsernameTemplateMapper.TEMPLATE, template); + config.put(TARGET, target.name()); + IdentityProviderMapperModel model = new IdentityProviderMapperModel(); + model.setConfig(config); + return model; + } + + private RealmModel realm(boolean registrationEmailAsUsername) { + return stub(RealmModel.class, (method, args) -> + "isRegistrationEmailAsUsername".equals(method.getName()) ? (Object) registrationEmailAsUsername : null); + } + + private UserModel user(List writtenUsernames) { + return stub(UserModel.class, (method, args) -> { + if ("setUsername".equals(method.getName())) { + writtenUsernames.add((String) args[0]); + } + return null; + }); + } + + @SuppressWarnings("unchecked") + private static T stub(Class iface, BiFunction handler) { + return (T) Proxy.newProxyInstance(iface.getClassLoader(), new Class[]{iface}, + (proxy, method, args) -> handler.apply(method, args)); + } + +} \ No newline at end of file diff --git a/services/src/test/java/org/keycloak/test/broker/saml/UsernameTemplateMapperTest.java b/services/src/test/java/org/keycloak/test/broker/saml/UsernameTemplateMapperTest.java new file mode 100644 index 000000000000..833b373a31fa --- /dev/null +++ b/services/src/test/java/org/keycloak/test/broker/saml/UsernameTemplateMapperTest.java @@ -0,0 +1,175 @@ +/* + * Copyright 2016 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.test.broker.saml; + +import java.lang.reflect.Method; +import java.lang.reflect.Proxy; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.function.BiFunction; + +import org.keycloak.broker.provider.BrokeredIdentityContext; +import org.keycloak.broker.provider.IdentityBrokerException; +import org.keycloak.broker.saml.SAMLEndpoint; +import org.keycloak.broker.saml.mappers.UsernameTemplateMapper; +import org.keycloak.broker.saml.mappers.UsernameTemplateMapper.Target; +import org.keycloak.dom.saml.v2.assertion.AssertionType; +import org.keycloak.dom.saml.v2.assertion.AttributeStatementType; +import org.keycloak.dom.saml.v2.assertion.AttributeType; +import org.keycloak.dom.saml.v2.assertion.NameIDType; +import org.keycloak.models.IdentityProviderMapperModel; +import org.keycloak.models.IdentityProviderModel; +import org.keycloak.models.RealmModel; +import org.keycloak.models.UserModel; +import org.keycloak.saml.processing.core.saml.v2.util.AssertionUtil; + +import org.junit.Test; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; +import static org.keycloak.broker.saml.mappers.UsernameTemplateMapper.TARGET; + +/** + * Unit test for {@link UsernameTemplateMapper} making sure a username template that cannot be resolved never + * results in a blank username. + */ +public class UsernameTemplateMapperTest { + + private static final String ALIAS = "myidp"; + private static final String ATTRIBUTE_NAME = "urn:oid:0.9.2342.19200300.100.1.1"; + + private final UsernameTemplateMapper mapper = new UsernameTemplateMapper(); + + @Test + public void resolvedTemplateSetsUsername() { + BrokeredIdentityContext context = context("jdoe"); + + mapper.preprocessFederatedIdentity(null, null, mapperModel(Target.LOCAL, "${ALIAS}-${ATTRIBUTE.uid}"), context); + + assertEquals(ALIAS + "-jdoe", context.getModelUsername()); + } + + @Test + public void missingAttributeIsRejected() { + BrokeredIdentityContext context = context("jdoe"); + context.setModelUsername("previous-username"); + + IdentityBrokerException e = assertThrows(IdentityBrokerException.class, + () -> mapper.preprocessFederatedIdentity(null, null, mapperModel(Target.LOCAL, "${ATTRIBUTE.non-existent}"), context)); + + assertTrue(e.getMessage(), e.getMessage().contains("${ATTRIBUTE.non-existent}")); + assertEquals("the existing username must not be overwritten", "previous-username", context.getModelUsername()); + } + + @Test + public void partiallyMissingAttributeIsRejected() { + BrokeredIdentityContext context = context("jdoe"); + + assertThrows(IdentityBrokerException.class, + () -> mapper.preprocessFederatedIdentity(null, null, mapperModel(Target.LOCAL, "${ALIAS}-${ATTRIBUTE.non-existent}"), context)); + + assertNull("an incomplete username must not be applied", context.getModelUsername()); + } + + @Test + public void blankTemplateResultIsRejected() { + for (String value : new String[]{"", " "}) { + BrokeredIdentityContext context = context(value); + + assertThrows(IdentityBrokerException.class, + () -> mapper.preprocessFederatedIdentity(null, null, mapperModel(Target.LOCAL, "${ATTRIBUTE.uid}"), context)); + + assertNull("username [" + value + "] must not be applied", context.getModelUsername()); + } + } + + @Test + public void updateBrokeredUserNeverBlanksExistingUsername() { + for (String username : new String[]{null, "", " "}) { + BrokeredIdentityContext context = context("jdoe"); + context.setModelUsername(username); + List written = new ArrayList<>(); + + mapper.updateBrokeredUser(null, realm(false), user(written), mapperModel(Target.LOCAL, "${ALIAS}"), context); + + assertEquals("username [" + username + "] must not be written back", List.of(), written); + } + } + + @Test + public void updateBrokeredUserKeepsUsernameWhenEmailIsUsedAsUsername() { + BrokeredIdentityContext context = context("jdoe"); + context.setModelUsername(ALIAS + "-jdoe"); + List written = new ArrayList<>(); + + mapper.updateBrokeredUser(null, realm(true), user(written), mapperModel(Target.LOCAL, "${ALIAS}"), context); + + assertEquals(List.of(), written); + } + + private BrokeredIdentityContext context(String attributeValue) { + IdentityProviderModel idpConfig = new IdentityProviderModel(); + idpConfig.setAlias(ALIAS); + idpConfig.setEnabled(true); + + AssertionType assertion = AssertionUtil.createAssertion("assertionId", NameIDType.deserializeFromString("nameIDType")); + AttributeStatementType statement = new AttributeStatementType(); + assertion.addStatement(statement); + AttributeType attribute = new AttributeType(ATTRIBUTE_NAME); + attribute.setFriendlyName("uid"); + attribute.addAttributeValue(attributeValue); + statement.addAttribute(new AttributeStatementType.ASTChoiceType(attribute)); + + BrokeredIdentityContext context = new BrokeredIdentityContext("sub-1", idpConfig); + context.getContextData().put(SAMLEndpoint.SAML_ASSERTION, assertion); + return context; + } + + private IdentityProviderMapperModel mapperModel(Target target, String template) { + Map config = new HashMap<>(); + config.put(UsernameTemplateMapper.TEMPLATE, template); + config.put(TARGET, target.name()); + IdentityProviderMapperModel model = new IdentityProviderMapperModel(); + model.setConfig(config); + return model; + } + + private RealmModel realm(boolean registrationEmailAsUsername) { + return stub(RealmModel.class, (method, args) -> + "isRegistrationEmailAsUsername".equals(method.getName()) ? (Object) registrationEmailAsUsername : null); + } + + private UserModel user(List writtenUsernames) { + return stub(UserModel.class, (method, args) -> { + if ("setUsername".equals(method.getName())) { + writtenUsernames.add((String) args[0]); + } + return null; + }); + } + + @SuppressWarnings("unchecked") + private static T stub(Class iface, BiFunction handler) { + return (T) Proxy.newProxyInstance(iface.getClassLoader(), new Class[]{iface}, + (proxy, method, args) -> handler.apply(method, args)); + } + +} \ No newline at end of file diff --git a/tests/base/src/test/java/org/keycloak/tests/broker/IdpCreateUserIfUniqueAuthenticatorTest.java b/tests/base/src/test/java/org/keycloak/tests/broker/IdpCreateUserIfUniqueAuthenticatorTest.java index 6984fe7d5f4f..ed5e48352ae2 100644 --- a/tests/base/src/test/java/org/keycloak/tests/broker/IdpCreateUserIfUniqueAuthenticatorTest.java +++ b/tests/base/src/test/java/org/keycloak/tests/broker/IdpCreateUserIfUniqueAuthenticatorTest.java @@ -108,6 +108,21 @@ public void testIdpBrokerLoginAcceptsUsernameAtMaxLength() { created.forEach(u -> consumerRealm.cleanup().add(r -> r.users().get(u.getId()).remove())); } + @Test // #53164 + public void testIdpBrokerLoginRejectsUnresolvableUsernameTemplate() { + addUsernameTemplateMapper("unresolvable-username-mapper", "${ALIAS}.${CLAIM.non-existent-claim}"); + + createProviderUser(); + oauth.openLoginForm(); + loginPage.clickSocial(IDP_ALIAS); + + loginPage.fillLogin(PROVIDER_USERNAME, "password"); + loginPage.submit(); + + assertTrue(consumerRealm.admin().users().search("", true).isEmpty(), + "A username template that cannot be resolved must not create a user with an empty username"); + } + private void addUsernameTemplateMapper(String mapperName, String usernameTemplate) { // adds to consumer IDP, replaces brokered username with mapperName IdentityProviderMapperRepresentation mapper = new IdentityProviderMapperRepresentation(); From a601a341f5345ea413f9f8fcd41e4c383fc113b0 Mon Sep 17 00:00:00 2001 From: Jyotirmoy Roy Date: Sat, 3 Oct 2026 08:37:22 +0530 Subject: [PATCH 2/8] Add regression coverage for blank username handling Signed-off-by: Jyotirmoy Roy --- .../topics/changes/changes-26_8_1.adoc | 9 ++ .../infinispan/UserCacheManagerTest.java | 60 ++++++++++++ .../events/UserFullInvalidationEventTest.java | 68 ++++++++++++++ .../models/jpa/JpaUserProviderTest.java | 42 +++++++++ .../storage/UserStorageManagerTest.java | 42 +++++++++ ...ederatedUsernameHasValueValidatorTest.java | 93 +++++++++++++++++++ 6 files changed, 314 insertions(+) create mode 100644 model/infinispan/src/test/java/org/keycloak/models/cache/infinispan/UserCacheManagerTest.java create mode 100644 model/infinispan/src/test/java/org/keycloak/models/cache/infinispan/events/UserFullInvalidationEventTest.java create mode 100644 model/jpa/src/test/java/org/keycloak/models/jpa/JpaUserProviderTest.java create mode 100644 model/storage-private/src/test/java/org/keycloak/storage/UserStorageManagerTest.java create mode 100644 services/src/test/java/org/keycloak/userprofile/validator/BrokeringFederatedUsernameHasValueValidatorTest.java diff --git a/docs/documentation/upgrading/topics/changes/changes-26_8_1.adoc b/docs/documentation/upgrading/topics/changes/changes-26_8_1.adoc index a493ff546443..13d7918400d1 100644 --- a/docs/documentation/upgrading/topics/changes/changes-26_8_1.adoc +++ b/docs/documentation/upgrading/topics/changes/changes-26_8_1.adoc @@ -26,3 +26,12 @@ When the username template of an identity provider mapper could not be fully res A username template that does not resolve to a non-blank username now fails the login with an error, and `addUser` rejects a blank username. Accounts that were already created with a blank username can be edited and deleted again. Review the username template of any identity provider mapper that does not resolve for every user, before upgrading. + +No database constraint was added, so existing accounts are not rejected. Use the following query to find accounts that are affected, and assign them a username, for example by resetting their federated identity: + +[source,sql] +---- +SELECT id, email, realm_id +FROM user_entity +WHERE username IS NULL OR TRIM(username) = ''; +---- diff --git a/model/infinispan/src/test/java/org/keycloak/models/cache/infinispan/UserCacheManagerTest.java b/model/infinispan/src/test/java/org/keycloak/models/cache/infinispan/UserCacheManagerTest.java new file mode 100644 index 000000000000..e90c1c59a37a --- /dev/null +++ b/model/infinispan/src/test/java/org/keycloak/models/cache/infinispan/UserCacheManagerTest.java @@ -0,0 +1,60 @@ +/* + * 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.models.cache.infinispan; + +import java.util.HashSet; +import java.util.Set; + +import org.junit.Test; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +public class UserCacheManagerTest { + + private static final String USER_ID = "user-id"; + private static final String REALM_ID = "realm-id"; + + private final UserCacheManager manager = new UserCacheManager(null, null); + + @Test + public void skipsUsernameLookupKeyWhenUsernameIsMissing() { + Set invalidations = invalidationsFor(null, null); + + assertEquals(Set.of(USER_ID), invalidations); + assertFalse(invalidations.contains(REALM_ID + ".username.null")); + } + + @Test + public void invalidatesUsernameAndEmailLookupsWhenPresent() { + Set invalidations = invalidationsFor("jdoe", "jdoe@example.com"); + + assertEquals(Set.of(USER_ID, REALM_ID + ".username.jdoe", REALM_ID + ".email.jdoe@example.com"), invalidations); + } + + @Test + public void skipsEmailLookupKeyWhenEmailIsMissing() { + assertTrue(invalidationsFor("jdoe", null).contains(REALM_ID + ".username.jdoe")); + } + + private Set invalidationsFor(String username, String email) { + Set invalidations = new HashSet<>(); + manager.userUpdatedInvalidations(USER_ID, username, email, REALM_ID, invalidations); + return invalidations; + } +} \ No newline at end of file diff --git a/model/infinispan/src/test/java/org/keycloak/models/cache/infinispan/events/UserFullInvalidationEventTest.java b/model/infinispan/src/test/java/org/keycloak/models/cache/infinispan/events/UserFullInvalidationEventTest.java new file mode 100644 index 000000000000..5f0b2d69d9e2 --- /dev/null +++ b/model/infinispan/src/test/java/org/keycloak/models/cache/infinispan/events/UserFullInvalidationEventTest.java @@ -0,0 +1,68 @@ +/* + * 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.models.cache.infinispan.events; + +import java.util.HashSet; +import java.util.Set; +import java.util.stream.Stream; + +import org.junit.Test; +import org.keycloak.models.cache.infinispan.UserCacheManager; + +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; + +public class UserFullInvalidationEventTest { + + private static final String USER_ID = "user-id"; + private static final String REALM_ID = "realm-id"; + private static final String BOGUS_USERNAME_KEY = REALM_ID + ".username.null"; + + @Test + public void accountWithoutUsernameCanBeInvalidated() { + UserFullInvalidationEvent event = UserFullInvalidationEvent.create(USER_ID, null, null, REALM_ID, false, Stream.empty()); + + Set invalidations = invalidate(event); + + assertTrue("the user must still be invalidated by id", invalidations.contains(USER_ID)); + assertFalse("no lookup key may be built for a missing username", invalidations.contains(BOGUS_USERNAME_KEY)); + } + + @Test + public void accountWithUsernameStillInvalidatesUsernameLookup() { + UserFullInvalidationEvent event = UserFullInvalidationEvent.create(USER_ID, "jdoe", null, REALM_ID, false, Stream.empty()); + + Set invalidations = invalidate(event); + + assertTrue(invalidations.contains(USER_ID)); + assertTrue(invalidations.contains(REALM_ID + ".username.jdoe")); + } + + @Test + public void realmIdIsStillMandatory() { + assertThrows(NullPointerException.class, + () -> UserFullInvalidationEvent.create(USER_ID, null, null, null, false, Stream.empty())); + } + + private Set invalidate(UserFullInvalidationEvent event) { + Set invalidations = new HashSet<>(); + // the caches are not touched while collecting the invalidation keys + event.addInvalidations(new UserCacheManager(null, null), invalidations); + return invalidations; + } +} \ No newline at end of file diff --git a/model/jpa/src/test/java/org/keycloak/models/jpa/JpaUserProviderTest.java b/model/jpa/src/test/java/org/keycloak/models/jpa/JpaUserProviderTest.java new file mode 100644 index 000000000000..93cf174aa9e6 --- /dev/null +++ b/model/jpa/src/test/java/org/keycloak/models/jpa/JpaUserProviderTest.java @@ -0,0 +1,42 @@ +/* + * 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.models.jpa; + +import org.junit.Test; +import org.keycloak.models.ModelException; + +import static org.junit.Assert.assertThrows; + +public class JpaUserProviderTest { + + private final JpaUserProvider provider = new JpaUserProvider(null, null); + + @Test + public void rejectsMissingUsername() { + assertThrows(ModelException.class, () -> provider.addUser(null, null, null, true, true)); + } + + @Test + public void rejectsEmptyUsername() { + assertThrows(ModelException.class, () -> provider.addUser(null, null, "", true, true)); + } + + @Test + public void rejectsWhitespaceUsername() { + assertThrows(ModelException.class, () -> provider.addUser(null, null, " ", true, true)); + } +} \ No newline at end of file diff --git a/model/storage-private/src/test/java/org/keycloak/storage/UserStorageManagerTest.java b/model/storage-private/src/test/java/org/keycloak/storage/UserStorageManagerTest.java new file mode 100644 index 000000000000..8e4c3fedc1ff --- /dev/null +++ b/model/storage-private/src/test/java/org/keycloak/storage/UserStorageManagerTest.java @@ -0,0 +1,42 @@ +/* + * 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.storage; + +import org.junit.Test; +import org.keycloak.models.ModelException; + +import static org.junit.Assert.assertThrows; + +public class UserStorageManagerTest { + + private final UserStorageManager manager = new UserStorageManager(null); + + @Test + public void rejectsMissingUsername() { + assertThrows(ModelException.class, () -> manager.addUser(null, null)); + } + + @Test + public void rejectsEmptyUsername() { + assertThrows(ModelException.class, () -> manager.addUser(null, "")); + } + + @Test + public void rejectsWhitespaceUsername() { + assertThrows(ModelException.class, () -> manager.addUser(null, " ")); + } +} \ No newline at end of file diff --git a/services/src/test/java/org/keycloak/userprofile/validator/BrokeringFederatedUsernameHasValueValidatorTest.java b/services/src/test/java/org/keycloak/userprofile/validator/BrokeringFederatedUsernameHasValueValidatorTest.java new file mode 100644 index 000000000000..7a81e536fdb8 --- /dev/null +++ b/services/src/test/java/org/keycloak/userprofile/validator/BrokeringFederatedUsernameHasValueValidatorTest.java @@ -0,0 +1,93 @@ +/* + * 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.userprofile.validator; + +import java.lang.reflect.Method; +import java.lang.reflect.Proxy; +import java.util.List; +import java.util.function.BiFunction; + +import org.junit.Test; +import org.keycloak.models.KeycloakContext; +import org.keycloak.models.KeycloakSession; +import org.keycloak.models.RealmModel; +import org.keycloak.models.UserModel; +import org.keycloak.validate.ValidationContext; +import org.keycloak.validate.ValidatorConfig; + +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +public class BrokeringFederatedUsernameHasValueValidatorTest { + + private final BrokeringFederatedUsernameHasValueValidator validator = new BrokeringFederatedUsernameHasValueValidator(); + + @Test + public void acceptsProvidedUsername() { + assertTrue(validate(false, List.of("jdoe")).isValid()); + } + + @Test + public void rejectsMissingUsername() { + assertFalse(validate(false, List.of()).isValid()); + } + + @Test + public void rejectsEmptyUsername() { + assertFalse(validate(false, List.of("")).isValid()); + } + + @Test + public void rejectsWhitespaceUsername() { + assertFalse(validate(false, List.of(" ")).isValid()); + } + + @Test + public void rejectsNullUsername() { + assertFalse(validate(false, java.util.Collections.singletonList(null)).isValid()); + } + + @Test + public void acceptsMissingUsernameWhenEmailIsUsedAsUsername() { + assertTrue(validate(true, List.of()).isValid()); + } + + private ValidationContext validate(boolean emailAsUsername, List usernames) { + RealmModel realm = stub(RealmModel.class, (method, args) -> + method.getName().equals("isRegistrationEmailAsUsername") ? emailAsUsername : defaultValue(method)); + KeycloakContext keycloakContext = stub(KeycloakContext.class, + (method, args) -> method.getName().equals("getRealm") ? realm : defaultValue(method)); + KeycloakSession session = stub(KeycloakSession.class, + (method, args) -> method.getName().equals("getContext") ? keycloakContext : defaultValue(method)); + + return validator.validate(usernames, UserModel.USERNAME, new ValidationContext(session), ValidatorConfig.EMPTY); + } + + private static Object defaultValue(Method method) { + Class type = method.getReturnType(); + if (!type.isPrimitive()) return null; + if (type == boolean.class) return false; + if (type == void.class) return null; + return 0; + } + + @SuppressWarnings("unchecked") + private static T stub(Class iface, BiFunction handler) { + return (T) Proxy.newProxyInstance(iface.getClassLoader(), new Class[]{iface}, + (proxy, method, args) -> handler.apply(method, args)); + } +} \ No newline at end of file From 8089c1c417a1ad06bb65cd2d1a68f87f376c734b Mon Sep 17 00:00:00 2001 From: Jyotirmoy Roy Date: Sat, 3 Oct 2026 09:14:04 +0530 Subject: [PATCH 3/8] Reject blank usernames on the storage-level addUser path Signed-off-by: Jyotirmoy Roy --- .../keycloak/models/jpa/JpaUserProvider.java | 4 + .../models/jpa/JpaUserProviderTest.java | 6 ++ .../keycloak/storage/UserStorageManager.java | 4 + .../storage/UserStorageManagerTest.java | 73 ++++++++++++++++++- 4 files changed, 85 insertions(+), 2 deletions(-) diff --git a/model/jpa/src/main/java/org/keycloak/models/jpa/JpaUserProvider.java b/model/jpa/src/main/java/org/keycloak/models/jpa/JpaUserProvider.java index 5ca5734054e6..bc2b98ee651f 100755 --- a/model/jpa/src/main/java/org/keycloak/models/jpa/JpaUserProvider.java +++ b/model/jpa/src/main/java/org/keycloak/models/jpa/JpaUserProvider.java @@ -721,6 +721,10 @@ public UserModel getUserById(RealmModel realm, String id) { @Override public UserModel getUserByUsername(RealmModel realm, String username) { + if (username == null) { + return null; + } + TypedQuery query = em.createNamedQuery("getRealmUserByUsername", UserEntity.class); query.setParameter("username", username.toLowerCase()); query.setParameter("realmId", realm.getId()); diff --git a/model/jpa/src/test/java/org/keycloak/models/jpa/JpaUserProviderTest.java b/model/jpa/src/test/java/org/keycloak/models/jpa/JpaUserProviderTest.java index 93cf174aa9e6..e7414605eb8f 100644 --- a/model/jpa/src/test/java/org/keycloak/models/jpa/JpaUserProviderTest.java +++ b/model/jpa/src/test/java/org/keycloak/models/jpa/JpaUserProviderTest.java @@ -19,6 +19,7 @@ import org.junit.Test; import org.keycloak.models.ModelException; +import static org.junit.Assert.assertNull; import static org.junit.Assert.assertThrows; public class JpaUserProviderTest { @@ -39,4 +40,9 @@ public void rejectsEmptyUsername() { public void rejectsWhitespaceUsername() { assertThrows(ModelException.class, () -> provider.addUser(null, null, " ", true, true)); } + + @Test + public void lookupByMissingUsernameFindsNobody() { + assertNull(provider.getUserByUsername(null, null)); + } } \ No newline at end of file diff --git a/model/storage-private/src/main/java/org/keycloak/storage/UserStorageManager.java b/model/storage-private/src/main/java/org/keycloak/storage/UserStorageManager.java index 42d609c4ee3e..8a0f08b40d00 100755 --- a/model/storage-private/src/main/java/org/keycloak/storage/UserStorageManager.java +++ b/model/storage-private/src/main/java/org/keycloak/storage/UserStorageManager.java @@ -802,6 +802,10 @@ public void preRemove(RealmModel realm, RoleModel role) { @Override public UserModel addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) { + if (StringUtil.isBlank(username)) { + throw new ModelException("Cannot create a user without a username"); + } + return localStorage().addUser(realm, id, username.toLowerCase(), addDefaultRoles, addDefaultRequiredActions); } diff --git a/model/storage-private/src/test/java/org/keycloak/storage/UserStorageManagerTest.java b/model/storage-private/src/test/java/org/keycloak/storage/UserStorageManagerTest.java index 8e4c3fedc1ff..481980e8dd5c 100644 --- a/model/storage-private/src/test/java/org/keycloak/storage/UserStorageManagerTest.java +++ b/model/storage-private/src/test/java/org/keycloak/storage/UserStorageManagerTest.java @@ -16,27 +16,96 @@ */ package org.keycloak.storage; +import java.lang.reflect.Method; +import java.lang.reflect.Proxy; +import java.util.ArrayList; +import java.util.List; +import java.util.function.BiFunction; + +import org.junit.Before; import org.junit.Test; +import org.keycloak.models.KeycloakSession; import org.keycloak.models.ModelException; +import org.keycloak.models.UserProvider; +import org.keycloak.storage.datastore.DefaultDatastoreProvider; +import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; public class UserStorageManagerTest { - private final UserStorageManager manager = new UserStorageManager(null); + private final List delegatedUsernames = new ArrayList<>(); + + private UserStorageManager manager; + + @Before + public void setUp() { + UserProvider localStorage = stub(UserProvider.class, (method, args) -> { + if (method.getName().equals("addUser") && args.length == 5) { + delegatedUsernames.add((String) args[2]); + return null; + } + return defaultValue(method); + }); + + KeycloakSession[] sessionRef = new KeycloakSession[1]; + KeycloakSession session = stub(KeycloakSession.class, (method, args) -> { + if (method.getName().equals("getProvider")) { + Class requested = (Class) args[0]; + if (requested == DatastoreProvider.class) { + return new DefaultDatastoreProvider(null, sessionRef[0]); + } + if (requested == UserProvider.class) { + return localStorage; + } + } + return defaultValue(method); + }); + sessionRef[0] = session; + + manager = new UserStorageManager(session); + } @Test public void rejectsMissingUsername() { assertThrows(ModelException.class, () -> manager.addUser(null, null)); + assertThrows(ModelException.class, () -> manager.addUser(null, "id", null, true, true)); + assertTrue(delegatedUsernames.isEmpty()); } @Test public void rejectsEmptyUsername() { assertThrows(ModelException.class, () -> manager.addUser(null, "")); + assertThrows(ModelException.class, () -> manager.addUser(null, "id", "", true, true)); + assertTrue(delegatedUsernames.isEmpty()); } @Test public void rejectsWhitespaceUsername() { assertThrows(ModelException.class, () -> manager.addUser(null, " ")); + assertThrows(ModelException.class, () -> manager.addUser(null, "id", " ", true, true)); + assertTrue(delegatedUsernames.isEmpty()); + } + + @Test + public void lowercasesUsernameBeforeDelegating() { + manager.addUser(null, "id", "JDoe", true, true); + + assertEquals(List.of("jdoe"), delegatedUsernames); + } + + private static Object defaultValue(Method method) { + Class type = method.getReturnType(); + if (!type.isPrimitive()) return null; + if (type == boolean.class) return false; + if (type == void.class) return null; + return 0; + } + + @SuppressWarnings("unchecked") + private static T stub(Class iface, BiFunction handler) { + return (T) Proxy.newProxyInstance(iface.getClassLoader(), new Class[]{iface}, + (proxy, method, args) -> handler.apply(method, args)); } -} \ No newline at end of file +} From f891c39361fe840cbef8b04f71fbb3c0b16ac9ef Mon Sep 17 00:00:00 2001 From: itsroy69 Date: Fri, 13 Nov 2026 23:27:20 +0530 Subject: [PATCH 4/8] Validate username input in user creation and update tests for unresolvable username templates Signed-off-by: itsroy69 --- .../events/UserFullInvalidationEventTest.java | 3 +- .../keycloak/models/jpa/JpaUserProvider.java | 6 ++- .../models/jpa/JpaUserProviderTest.java | 8 +++- .../storage/UserStorageManagerTest.java | 22 +++++++--- .../org/keycloak/models/UserProvider.java | 2 +- .../oidc/mappers/UsernameTemplateMapper.java | 2 +- .../AbstractTokenExchangeProvider.java | 14 +++++-- .../resources/IdentityBrokerService.java | 5 ++- .../mappers/UsernameTemplateMapperTest.java | 3 +- .../saml/UsernameTemplateMapperTest.java | 3 +- ...ederatedUsernameHasValueValidatorTest.java | 3 +- ...dpCreateUserIfUniqueAuthenticatorTest.java | 8 +++- .../broker/KcOidcBrokerTokenExchangeTest.java | 42 +++++++++++++++++++ 13 files changed, 100 insertions(+), 21 deletions(-) diff --git a/model/infinispan/src/test/java/org/keycloak/models/cache/infinispan/events/UserFullInvalidationEventTest.java b/model/infinispan/src/test/java/org/keycloak/models/cache/infinispan/events/UserFullInvalidationEventTest.java index 5f0b2d69d9e2..5e4d67b9fbda 100644 --- a/model/infinispan/src/test/java/org/keycloak/models/cache/infinispan/events/UserFullInvalidationEventTest.java +++ b/model/infinispan/src/test/java/org/keycloak/models/cache/infinispan/events/UserFullInvalidationEventTest.java @@ -20,9 +20,10 @@ import java.util.Set; import java.util.stream.Stream; -import org.junit.Test; import org.keycloak.models.cache.infinispan.UserCacheManager; +import org.junit.Test; + import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; diff --git a/model/jpa/src/main/java/org/keycloak/models/jpa/JpaUserProvider.java b/model/jpa/src/main/java/org/keycloak/models/jpa/JpaUserProvider.java index 020ede5e1c33..9790db10c400 100755 --- a/model/jpa/src/main/java/org/keycloak/models/jpa/JpaUserProvider.java +++ b/model/jpa/src/main/java/org/keycloak/models/jpa/JpaUserProvider.java @@ -162,7 +162,11 @@ public UserModel addUser(RealmModel realm, String id, String username, boolean a @Override public UserModel addUser(RealmModel realm, String username) { - return addUser(realm, KeycloakModelUtils.generateId(), username, true, true); + if (StringUtil.isBlank(username)) { + throw new ModelException("Cannot create a user without a username"); + } + + return addUser(realm, KeycloakModelUtils.generateId(), username.toLowerCase(), true, true); } @Override diff --git a/model/jpa/src/test/java/org/keycloak/models/jpa/JpaUserProviderTest.java b/model/jpa/src/test/java/org/keycloak/models/jpa/JpaUserProviderTest.java index e7414605eb8f..68546020fca8 100644 --- a/model/jpa/src/test/java/org/keycloak/models/jpa/JpaUserProviderTest.java +++ b/model/jpa/src/test/java/org/keycloak/models/jpa/JpaUserProviderTest.java @@ -16,9 +16,10 @@ */ package org.keycloak.models.jpa; -import org.junit.Test; import org.keycloak.models.ModelException; +import org.junit.Test; + import static org.junit.Assert.assertNull; import static org.junit.Assert.assertThrows; @@ -31,6 +32,11 @@ public void rejectsMissingUsername() { assertThrows(ModelException.class, () -> provider.addUser(null, null, null, true, true)); } + @Test + public void rejectsMissingUsernameThroughAddUser() { + assertThrows(ModelException.class, () -> provider.addUser(null, null)); + } + @Test public void rejectsEmptyUsername() { assertThrows(ModelException.class, () -> provider.addUser(null, null, "", true, true)); diff --git a/model/storage-private/src/test/java/org/keycloak/storage/UserStorageManagerTest.java b/model/storage-private/src/test/java/org/keycloak/storage/UserStorageManagerTest.java index 71f28b6a63b2..e6ee2dd32642 100644 --- a/model/storage-private/src/test/java/org/keycloak/storage/UserStorageManagerTest.java +++ b/model/storage-private/src/test/java/org/keycloak/storage/UserStorageManagerTest.java @@ -26,8 +26,6 @@ import java.util.function.Consumer; import java.util.stream.Stream; -import org.junit.Before; -import org.junit.Test; import org.keycloak.component.ComponentModel; import org.keycloak.models.KeycloakSession; import org.keycloak.models.KeycloakSessionFactory; @@ -40,6 +38,9 @@ import org.keycloak.storage.datastore.DefaultDatastoreProvider; import org.keycloak.storage.federated.UserFederatedStorageProvider; +import org.junit.Before; +import org.junit.Test; + import static org.hamcrest.MatcherAssert.assertThat; import static org.hamcrest.Matchers.empty; import static org.hamcrest.Matchers.is; @@ -54,6 +55,7 @@ public class UserStorageManagerTest { private final List delegatedUsernames = new ArrayList<>(); + private DefaultDatastoreProvider datastore; private UserStorageManager manager; @Before @@ -66,12 +68,12 @@ public void setUp() { return defaultValue(method); }); - KeycloakSession[] sessionRef = new KeycloakSession[1]; + DefaultDatastoreProvider[] datastoreRef = new DefaultDatastoreProvider[1]; KeycloakSession session = stub(KeycloakSession.class, (method, args) -> { if (method.getName().equals("getProvider")) { Class requested = (Class) args[0]; if (requested == DatastoreProvider.class) { - return new DefaultDatastoreProvider(null, sessionRef[0]); + return datastoreRef[0]; } if (requested == UserProvider.class) { return localStorage; @@ -79,9 +81,10 @@ public void setUp() { } return defaultValue(method); }); - sessionRef[0] = session; + datastore = new DefaultDatastoreProvider(null, session); + datastoreRef[0] = datastore; - manager = new UserStorageManager(session); + manager = (UserStorageManager) datastore.users(); } @Test @@ -105,6 +108,13 @@ public void rejectsWhitespaceUsername() { assertTrue(delegatedUsernames.isEmpty()); } + @Test + public void rejectsMissingUsernameThroughSessionUserProvider() { + assertThrows(ModelException.class, () -> datastore.users().addUser(null, "id", null, true, true)); + assertThrows(ModelException.class, () -> datastore.users().addUser(null, null)); + assertTrue(delegatedUsernames.isEmpty()); + } + @Test public void lowercasesUsernameBeforeDelegating() { manager.addUser(null, "id", "JDoe", true, true); diff --git a/server-spi/src/main/java/org/keycloak/models/UserProvider.java b/server-spi/src/main/java/org/keycloak/models/UserProvider.java index 6672288d34b1..553027d6e3a1 100755 --- a/server-spi/src/main/java/org/keycloak/models/UserProvider.java +++ b/server-spi/src/main/java/org/keycloak/models/UserProvider.java @@ -80,7 +80,7 @@ public interface UserProvider extends Provider, * @return model of created user * * @throws NullPointerException when realm is {@code null} - * @throws ModelException when username is {@code null} or empty + * @throws ModelException when username is blank * @throws ModelDuplicateException when a user with given id or username already exists */ UserModel addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions); diff --git a/services/src/main/java/org/keycloak/broker/oidc/mappers/UsernameTemplateMapper.java b/services/src/main/java/org/keycloak/broker/oidc/mappers/UsernameTemplateMapper.java index e83d0276cd2a..d5d8cddfdeb2 100755 --- a/services/src/main/java/org/keycloak/broker/oidc/mappers/UsernameTemplateMapper.java +++ b/services/src/main/java/org/keycloak/broker/oidc/mappers/UsernameTemplateMapper.java @@ -40,7 +40,6 @@ import org.keycloak.models.UserModel; import org.keycloak.models.utils.KeycloakModelUtils; import org.keycloak.provider.ProviderConfigProperty; -import org.keycloak.utils.StringUtil; import org.keycloak.social.bitbucket.BitbucketIdentityProviderFactory; import org.keycloak.social.facebook.FacebookIdentityProviderFactory; import org.keycloak.social.github.GitHubIdentityProviderFactory; @@ -53,6 +52,7 @@ import org.keycloak.social.paypal.PayPalIdentityProviderFactory; import org.keycloak.social.stackoverflow.StackoverflowIdentityProviderFactory; import org.keycloak.social.twitter.TwitterIdentityProviderFactory; +import org.keycloak.utils.StringUtil; import static org.keycloak.broker.saml.mappers.UsernameTemplateMapper.TARGET; import static org.keycloak.broker.saml.mappers.UsernameTemplateMapper.TARGETS; diff --git a/services/src/main/java/org/keycloak/protocol/oidc/tokenexchange/AbstractTokenExchangeProvider.java b/services/src/main/java/org/keycloak/protocol/oidc/tokenexchange/AbstractTokenExchangeProvider.java index f1d3216f33a7..6e0399c1a27f 100644 --- a/services/src/main/java/org/keycloak/protocol/oidc/tokenexchange/AbstractTokenExchangeProvider.java +++ b/services/src/main/java/org/keycloak/protocol/oidc/tokenexchange/AbstractTokenExchangeProvider.java @@ -74,6 +74,7 @@ import org.keycloak.sessions.AuthenticationSessionModel; import org.keycloak.sessions.RootAuthenticationSessionModel; import org.keycloak.util.Booleans; +import org.keycloak.utils.StringUtil; import org.jboss.logging.Logger; @@ -299,7 +300,14 @@ protected Response exchangeExternalToken(String subjectIssuer, String subjectTok throw new CorsErrorResponseException(cors, Errors.INVALID_ISSUER, "Invalid " + OAuth2Constants.SUBJECT_ISSUER + " parameter", Response.Status.BAD_REQUEST); } - UserModel user = importUserFromExternalIdentity(context); + UserModel user; + try { + user = importUserFromExternalIdentity(context); + } catch (IdentityBrokerException e) { + event.detail(Details.REASON, e.getMessage()); + event.error(Errors.IDENTITY_PROVIDER_ERROR); + throw new CorsErrorResponseException(cors, OAuthErrorException.INVALID_REQUEST, e.getMessage(), Response.Status.BAD_REQUEST); + } UserSessionModel userSession = new UserSessionManager(session).createUserSession(realm, user, user.getUsername(), clientConnection.getRemoteHost(), "external-exchange", false, null, null); externalExchangeContext.provider().exchangeExternalComplete(userSession, context, formParams); @@ -341,10 +349,10 @@ protected UserModel importUserFromExternalIdentity(BrokeredIdentityContext conte logger.debugf("Federated user not found for provider '%s' and broker username '%s'.", providerId, context.getUsername()); String username = context.getModelUsername(); - if (Validation.isBlank(username)) { + if (StringUtil.isBlank(username)) { if (this.realm.isRegistrationEmailAsUsername() && !Validation.isBlank(context.getEmail())) { username = context.getEmail(); - } else if (Validation.isBlank(context.getUsername())) { + } else if (StringUtil.isBlank(context.getUsername())) { username = context.getIdpConfig().getAlias() + "." + context.getId(); } else { username = context.getUsername(); diff --git a/services/src/main/java/org/keycloak/services/resources/IdentityBrokerService.java b/services/src/main/java/org/keycloak/services/resources/IdentityBrokerService.java index 8d9e013fd4cc..accb469af6d2 100755 --- a/services/src/main/java/org/keycloak/services/resources/IdentityBrokerService.java +++ b/services/src/main/java/org/keycloak/services/resources/IdentityBrokerService.java @@ -137,6 +137,7 @@ import org.keycloak.sessions.RootAuthenticationSessionModel; import org.keycloak.util.Booleans; import org.keycloak.util.JsonSerialization; +import org.keycloak.utils.StringUtil; import org.jboss.logging.Logger; import org.jboss.resteasy.reactive.NoCache; @@ -789,10 +790,10 @@ public Response authenticated(BrokeredIdentityContext context) { authenticationSession.setAuthNote(AbstractUsernameFormAuthenticator.ATTEMPTED_USERNAME, context.getUsername()); String username = context.getModelUsername(); - if (Validation.isBlank(username)) { + if (StringUtil.isBlank(username)) { if (this.realmModel.isRegistrationEmailAsUsername() && !Validation.isBlank(context.getEmail())) { username = context.getEmail(); - } else if (Validation.isBlank(context.getUsername())) { + } else if (StringUtil.isBlank(context.getUsername())) { username = context.getIdpConfig().getAlias() + "." + context.getId(); } else { username = context.getUsername(); diff --git a/services/src/test/java/org/keycloak/test/broker/oidc/mappers/UsernameTemplateMapperTest.java b/services/src/test/java/org/keycloak/test/broker/oidc/mappers/UsernameTemplateMapperTest.java index 1a92ca9311cd..71d4976b5f20 100644 --- a/services/src/test/java/org/keycloak/test/broker/oidc/mappers/UsernameTemplateMapperTest.java +++ b/services/src/test/java/org/keycloak/test/broker/oidc/mappers/UsernameTemplateMapperTest.java @@ -37,11 +37,12 @@ import org.junit.Test; +import static org.keycloak.broker.saml.mappers.UsernameTemplateMapper.TARGET; + import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; -import static org.keycloak.broker.saml.mappers.UsernameTemplateMapper.TARGET; /** * Unit test for {@link UsernameTemplateMapper} making sure a username template that cannot be resolved never diff --git a/services/src/test/java/org/keycloak/test/broker/saml/UsernameTemplateMapperTest.java b/services/src/test/java/org/keycloak/test/broker/saml/UsernameTemplateMapperTest.java index 833b373a31fa..7f83b7e89214 100644 --- a/services/src/test/java/org/keycloak/test/broker/saml/UsernameTemplateMapperTest.java +++ b/services/src/test/java/org/keycloak/test/broker/saml/UsernameTemplateMapperTest.java @@ -41,11 +41,12 @@ import org.junit.Test; +import static org.keycloak.broker.saml.mappers.UsernameTemplateMapper.TARGET; + import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; -import static org.keycloak.broker.saml.mappers.UsernameTemplateMapper.TARGET; /** * Unit test for {@link UsernameTemplateMapper} making sure a username template that cannot be resolved never diff --git a/services/src/test/java/org/keycloak/userprofile/validator/BrokeringFederatedUsernameHasValueValidatorTest.java b/services/src/test/java/org/keycloak/userprofile/validator/BrokeringFederatedUsernameHasValueValidatorTest.java index 7a81e536fdb8..2fed693b7add 100644 --- a/services/src/test/java/org/keycloak/userprofile/validator/BrokeringFederatedUsernameHasValueValidatorTest.java +++ b/services/src/test/java/org/keycloak/userprofile/validator/BrokeringFederatedUsernameHasValueValidatorTest.java @@ -21,7 +21,6 @@ import java.util.List; import java.util.function.BiFunction; -import org.junit.Test; import org.keycloak.models.KeycloakContext; import org.keycloak.models.KeycloakSession; import org.keycloak.models.RealmModel; @@ -29,6 +28,8 @@ import org.keycloak.validate.ValidationContext; import org.keycloak.validate.ValidatorConfig; +import org.junit.Test; + import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertTrue; diff --git a/tests/base/src/test/java/org/keycloak/tests/broker/IdpCreateUserIfUniqueAuthenticatorTest.java b/tests/base/src/test/java/org/keycloak/tests/broker/IdpCreateUserIfUniqueAuthenticatorTest.java index d1ebc1871b48..627d0eefc4bc 100644 --- a/tests/base/src/test/java/org/keycloak/tests/broker/IdpCreateUserIfUniqueAuthenticatorTest.java +++ b/tests/base/src/test/java/org/keycloak/tests/broker/IdpCreateUserIfUniqueAuthenticatorTest.java @@ -139,14 +139,18 @@ public void testIdpBrokerLoginRejectsUnresolvableUsernameTemplate() { addUsernameTemplateMapper("unresolvable-username-mapper", "${ALIAS}.${CLAIM.non-existent-claim}"); createProviderUser(); + int userCountBefore = consumerRealm.admin().users().count(); + oauth.openLoginForm(); loginPage.clickSocial(IDP_ALIAS); loginPage.fillLogin(PROVIDER_USERNAME, "password"); loginPage.submit(); - assertTrue(consumerRealm.admin().users().search("", true).isEmpty(), - "A username template that cannot be resolved must not create a user with an empty username"); + assertEquals("login-error", driver.page().getCurrentPageId(), + "A username template that cannot be resolved must reject the login"); + assertEquals(userCountBefore, consumerRealm.admin().users().count().intValue(), + "A username template that cannot be resolved must not create a user"); } @Test // #50505 diff --git a/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcOidcBrokerTokenExchangeTest.java b/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcOidcBrokerTokenExchangeTest.java index f3ddd80bc48d..1e7544b7ad9f 100644 --- a/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcOidcBrokerTokenExchangeTest.java +++ b/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcOidcBrokerTokenExchangeTest.java @@ -39,6 +39,7 @@ import org.keycloak.authorization.model.Policy; import org.keycloak.authorization.model.ResourceServer; import org.keycloak.broker.oidc.mappers.UserAttributeMapper; +import org.keycloak.broker.oidc.mappers.UsernameTemplateMapper; import org.keycloak.common.Profile; import org.keycloak.models.ClientModel; import org.keycloak.models.IdentityProviderMapperModel; @@ -101,6 +102,47 @@ public void testExternalInternalTokenExchange() throws Exception { assertExternalToInternalExchange(bc.getIDPAlias(), true, false); } + @Test + public void testExternalInternalTokenExchangeRejectsUnresolvableUsernameTemplate() throws Exception { + testingClient.server(BrokerTestConstants.REALM_CONS_NAME).run(KcOidcBrokerTokenExchangeTest::setupRealm); + + RealmResource providerRealm = realmsResouce().realm(bc.providerRealmName()); + ClientRepresentation brokerApp = providerRealm.clients().findByClientId("brokerapp").get(0); + brokerApp.setDirectAccessGrantsEnabled(true); + providerRealm.clients().get(brokerApp.getId()).update(brokerApp); + + RealmResource consumerRealm = realmsResouce().realm(bc.consumerRealmName()); + IdentityProviderResource identityProviderResource = consumerRealm.identityProviders().get(bc.getIDPAlias()); + + IdentityProviderMapperRepresentation usernameTemplateMapper = new IdentityProviderMapperRepresentation(); + usernameTemplateMapper.setName("unresolvable-username-template"); + usernameTemplateMapper.setIdentityProviderAlias(bc.getIDPAlias()); + usernameTemplateMapper.setIdentityProviderMapper(UsernameTemplateMapper.PROVIDER_ID); + usernameTemplateMapper.setConfig(Map.of( + IdentityProviderMapperModel.SYNC_MODE, IdentityProviderMapperSyncMode.INHERIT.toString(), + UsernameTemplateMapper.TEMPLATE, "${ALIAS}.${CLAIM.non-existent-claim}")); + identityProviderResource.addMapper(usernameTemplateMapper).close(); + getCleanup().addCleanup(() -> identityProviderResource.getMappers().stream() + .filter(mapper -> "unresolvable-username-template".equals(mapper.getName())) + .forEach(mapper -> identityProviderResource.delete(mapper.getId()))); + + org.keycloak.testsuite.util.oauth.AccessTokenResponse tokenResponse = oauth.realm(bc.providerRealmName()) + .client(brokerApp.getClientId(), brokerApp.getSecret()) + .doPasswordGrantRequest(bc.getUserLogin(), bc.getUserPassword()); + assertThat(tokenResponse.getIdToken(), notNullValue()); + + int userCountBefore = consumerRealm.users().count(); + + try (Client httpClient = AdminClientUtil.createResteasyClient()) { + WebTarget exchangeUrl = getConsumerTokenEndpoint(httpClient); + try (Response response = sendExternalInternalTokenExchangeRequest(exchangeUrl, tokenResponse.getIdToken(), OAuth2Constants.ID_TOKEN_TYPE)) { + assertThat(response.getStatus(), equalTo(Status.BAD_REQUEST.getStatusCode())); + } + } + + assertThat(consumerRealm.users().count(), equalTo(userCountBefore)); + } + // Tests token-exchange works when user is already linked to the IDP @Test public void testExternalInternalTokenExchangeWithExistingUser() throws Exception { From ac48f94d3e3af20a5c89b2f813ec8e7f3a87f961 Mon Sep 17 00:00:00 2001 From: Alexander Schwartz Date: Fri, 13 Nov 2026 18:40:50 +0100 Subject: [PATCH 5/8] Close limited SOAP request streams in SAML endpoints Closes #55169 Signed-off-by: Alexander Schwartz Signed-off-by: Alexander Schwartz Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- .../java/org/keycloak/protocol/saml/SamlService.java | 10 ++++++++-- .../saml/profile/ecp/SamlEcpProfileService.java | 6 ++++-- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/services/src/main/java/org/keycloak/protocol/saml/SamlService.java b/services/src/main/java/org/keycloak/protocol/saml/SamlService.java index b001e4fa3801..9ea3fc420411 100755 --- a/services/src/main/java/org/keycloak/protocol/saml/SamlService.java +++ b/services/src/main/java/org/keycloak/protocol/saml/SamlService.java @@ -1210,7 +1210,13 @@ public AuthenticationSessionModel getOrCreateLoginSessionForIdpInitiatedSso(Keyc @NoCache @Consumes({"application/soap+xml", MediaType.TEXT_XML}) public Response artifactResolutionService(InputStream inputStream) { - Document soapBodyContents = Soap.extractSoapMessage(SamlProtocolUtils.limit(inputStream, maxSoapMessageRequestSize)); + Document soapBodyContents; + try (InputStream limitedInputStream = SamlProtocolUtils.limit(inputStream, maxSoapMessageRequestSize)) { + soapBodyContents = Soap.extractSoapMessage(limitedInputStream); + } catch (IOException e) { + logger.debug("Error while closing the SOAP request stream", e); + return Soap.createFault().reason("").detail("").build(); + } ArtifactResolveType artifactResolveType = null; SAMLDocumentHolder samlDocumentHolder = null; try { @@ -1262,7 +1268,7 @@ public Response artifactResolutionService(InputStream inputStream) { public Response soapBinding(InputStream inputStream) { SamlEcpProfileService bindingService = new SamlEcpProfileService(session, event, maxInflatingSize, destinationValidator, maxSoapMessageRequestSize, enableSaml11); - return bindingService.authenticate(SamlProtocolUtils.limit(inputStream, maxSoapMessageRequestSize)); + return bindingService.authenticate(inputStream); } private ClientModel getAndCheckClientModel(String clientSessionId, String clientId) throws ProcessingException { diff --git a/services/src/main/java/org/keycloak/protocol/saml/profile/ecp/SamlEcpProfileService.java b/services/src/main/java/org/keycloak/protocol/saml/profile/ecp/SamlEcpProfileService.java index d8d958339962..929716a88c21 100755 --- a/services/src/main/java/org/keycloak/protocol/saml/profile/ecp/SamlEcpProfileService.java +++ b/services/src/main/java/org/keycloak/protocol/saml/profile/ecp/SamlEcpProfileService.java @@ -67,12 +67,14 @@ public SamlEcpProfileService(KeycloakSession session, EventBuilder event, long m } public Response authenticate(InputStream inputStream) { - try { - return authenticate(Soap.extractSoapMessage(SamlProtocolUtils.limit(inputStream, maxSoapMessageRequestSize))); + Document soapMessage; + try (InputStream limitedInputStream = SamlProtocolUtils.limit(inputStream, maxSoapMessageRequestSize)) { + soapMessage = Soap.extractSoapMessage(limitedInputStream); } catch (Exception e) { logger.debugf(e, "Error while processing SOAP request."); return Soap.createFault().reason("Some error occurred while processing the SOAP request.").build(); } + return authenticate(soapMessage); } public Response authenticate(Document soapMessage) { From 4e5aebdab63b949352a3baab52ac83be11564f49 Mon Sep 17 00:00:00 2001 From: Peter Zaoral Date: Fri, 13 Nov 2026 18:41:09 +0100 Subject: [PATCH 6/8] Clean up Azure CI resources after workflow completion (#54835) Closes #54833 Signed-off-by: Peter Zaoral --- .github/scripts/ansible/azure_vm_manager.sh | 5 +- .github/scripts/azure/sql/azure_create_sql.sh | 7 +- .github/workflows/azure-delete.yml | 67 +++++++++++++++++++ .github/workflows/ci.yml | 5 +- 4 files changed, 80 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/azure-delete.yml diff --git a/.github/scripts/ansible/azure_vm_manager.sh b/.github/scripts/ansible/azure_vm_manager.sh index 66d62a13d65c..b00cc960f622 100755 --- a/.github/scripts/ansible/azure_vm_manager.sh +++ b/.github/scripts/ansible/azure_vm_manager.sh @@ -18,7 +18,10 @@ IMAGE="Ubuntu2404" if [[ "$ACTION" == "create" ]]; then # 1. Resource group - az group create --name "$CLUSTER" --location "$REGION" + GROUP_EXISTS=$(az group exists --name "$CLUSTER") + if [[ "$GROUP_EXISTS" == "false" ]]; then + az group create --name "$CLUSTER" --location "$REGION" + fi # 2. SSH key if [[ ! -f "${SSH_KEY}" ]]; then diff --git a/.github/scripts/azure/sql/azure_create_sql.sh b/.github/scripts/azure/sql/azure_create_sql.sh index 143003ffb63a..dc062a5da08c 100755 --- a/.github/scripts/azure/sql/azure_create_sql.sh +++ b/.github/scripts/azure/sql/azure_create_sql.sh @@ -14,7 +14,12 @@ requiredEnv AZURE_SUBSCRIPTION AZURE_ADMIN_USER AZURE_DB_USER # Resource group (created via idempotent command) echo "Creating resource group ${AZURE_RG} in ${AZURE_REGION}" -az group create --name ${AZURE_RG} --location ${AZURE_REGION} --subscription ${AZURE_SUBSCRIPTION} +group_args=(--name "$AZURE_RG" --location "$AZURE_REGION" --subscription "$AZURE_SUBSCRIPTION") +if [[ "${GITHUB_ACTIONS:-}" == "true" ]]; then + group_args+=(--tags "keycloak-ci-repository=$GITHUB_REPOSITORY" "keycloak-ci-run=$GITHUB_RUN_ID" + "keycloak-ci-attempt=$GITHUB_RUN_ATTEMPT") +fi +az group create "${group_args[@]}" echo "Creating SQL server ${AZURE_NAME}-sqlsrv" az sql server create \ diff --git a/.github/workflows/azure-delete.yml b/.github/workflows/azure-delete.yml new file mode 100644 index 000000000000..da0b49952c49 --- /dev/null +++ b/.github/workflows/azure-delete.yml @@ -0,0 +1,67 @@ +name: Azure Delete + +on: + workflow_run: + workflows: [Keycloak CI] + types: [completed] + +permissions: + actions: read + +jobs: + delete: + name: Delete Azure resource group + if: >- + github.event.workflow_run.head_repository.full_name == github.repository && + (github.event.workflow_run.event == 'push' || github.event.workflow_run.event == 'workflow_dispatch') + runs-on: ubuntu-latest + timeout-minutes: 30 + env: + CI_RUN_ID: ${{ github.event.workflow_run.id }} + CI_RUN_ATTEMPT: ${{ github.event.workflow_run.run_attempt }} + steps: + - name: Check whether Azure provisioning could have started + id: azure-job + env: + GH_TOKEN: ${{ github.token }} + HAS_AZURE_CREDENTIALS: ${{ secrets.AZURE_CREDENTIALS != '' }} + run: | + if [[ "$HAS_AZURE_CREDENTIALS" != "true" ]]; then + exit 0 + fi + + azure_job=$(gh api --paginate \ + "repos/$GITHUB_REPOSITORY/actions/runs/$CI_RUN_ID/attempts/$CI_RUN_ATTEMPT/jobs?per_page=100" \ + --jq '.jobs[] | select(.name == "AzureDB IT" and .conclusion != "skipped") | .id') + if [[ -n "$azure_job" ]]; then + echo "ran=true" >> "$GITHUB_OUTPUT" + fi + + - name: Login to Azure + if: steps.azure-job.outputs.ran == 'true' + uses: azure/login@a641126d1b8aa4d1fa005f4f92df94a3a4c4c906 # v3.1.0 + with: + creds: ${{ secrets.AZURE_CREDENTIALS }} + + - name: Delete and verify resource group + if: steps.azure-job.outputs.ran == 'true' + run: | + groups=$(az group list --query \ + "[?tags.\"keycloak-ci-repository\"=='$GITHUB_REPOSITORY' && tags.\"keycloak-ci-run\"=='$CI_RUN_ID' && tags.\"keycloak-ci-attempt\"=='$CI_RUN_ATTEMPT'].[name, properties.provisioningState]" \ + --output tsv) + if [[ -z "$groups" ]]; then + echo "No Azure resource group found for this CI attempt." + exit 0 + fi + + read -r group state <<< "$groups" + expected_name="^gh-action-[0-9a-f]+-${CI_RUN_ID}-${CI_RUN_ATTEMPT}$" + if [[ "$groups" == *$'\n'* || ! "$group" =~ $expected_name ]]; then + echo "::error::Expected one CI resource group with a name matching the triggering attempt." + exit 1 + fi + + if [[ "$state" != "Deleting" ]]; then + az group delete --name "$group" --yes --no-wait + fi + az group wait --name "$group" --deleted --timeout 1500 diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e6007d7c71d2..8f7422830bb7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -726,7 +726,8 @@ jobs: env: AZURE_CREDENTIALS: ${{ secrets.AZURE_CREDENTIALS }} - - name: Login to Azure + - id: azure-login + name: Login to Azure uses: azure/login@a641126d1b8aa4d1fa005f4f92df94a3a4c4c906 # v3.1.0 with: creds: ${{ secrets.AZURE_CREDENTIALS }} @@ -853,7 +854,7 @@ jobs: path: .github/scripts/ansible/files - name: Delete all Azure resources (resource group) - if: always() + if: always() && steps.azure-login.outcome == 'success' working-directory: .github/scripts/ansible run: | ./azure_vm_manager.sh delete ${{ steps.azure-init.outputs.region }} ${{ steps.azure-init.outputs.azure-cluster-name }} From 8323980f19954e8f5ff27906f478575b81e3b8da Mon Sep 17 00:00:00 2001 From: Maximilian Brodda <11014840+QuellcodeWanderer@users.noreply.github.com> Date: Fri, 13 Nov 2026 19:13:05 +0100 Subject: [PATCH 7/8] Generate the admin API v2 OpenAPI validation hints in English regardless of the build locale (#54853) Closes #54852 Signed-off-by: Maximilian Brodda Co-authored-by: Maximilian Brodda --- .../openapi/ValidationAnnotationScanner.java | 4 +++- .../openapi/ValidationAnnotationScannerTest.java | 16 ++++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/rest/admin-v2/services/src/main/java/org/keycloak/admin/internal/openapi/ValidationAnnotationScanner.java b/rest/admin-v2/services/src/main/java/org/keycloak/admin/internal/openapi/ValidationAnnotationScanner.java index d16b7d19856c..e3ffa8d56f5c 100644 --- a/rest/admin-v2/services/src/main/java/org/keycloak/admin/internal/openapi/ValidationAnnotationScanner.java +++ b/rest/admin-v2/services/src/main/java/org/keycloak/admin/internal/openapi/ValidationAnnotationScanner.java @@ -5,6 +5,7 @@ import java.util.HashMap; import java.util.HashSet; import java.util.List; +import java.util.Locale; import java.util.Map; import java.util.MissingResourceException; import java.util.ResourceBundle; @@ -81,7 +82,8 @@ public ValidationAnnotationScanner(IndexView indexView) { private ResourceBundle loadValidationMessages() { try { - return ResourceBundle.getBundle("org.hibernate.validator.ValidationMessages"); + // Always use the English base bundle, so the generated OpenAPI document does not depend on the locale of the build machine + return ResourceBundle.getBundle("org.hibernate.validator.ValidationMessages", Locale.ROOT); } catch (MissingResourceException e) { log.warn("Could not load ValidationMessages resource bundle", e); return null; diff --git a/rest/admin-v2/services/src/test/java/org/keycloak/admin/internal/openapi/ValidationAnnotationScannerTest.java b/rest/admin-v2/services/src/test/java/org/keycloak/admin/internal/openapi/ValidationAnnotationScannerTest.java index 5582dfd7f594..3ba108ff73c4 100644 --- a/rest/admin-v2/services/src/test/java/org/keycloak/admin/internal/openapi/ValidationAnnotationScannerTest.java +++ b/rest/admin-v2/services/src/test/java/org/keycloak/admin/internal/openapi/ValidationAnnotationScannerTest.java @@ -21,6 +21,7 @@ import java.io.InputStream; import java.math.BigDecimal; import java.util.LinkedHashSet; +import java.util.Locale; import java.util.Map; import java.util.Set; @@ -184,6 +185,21 @@ public void buildDescription_notBlankConstraint() { assertTrue(description.contains("must not be blank")); } + @Test + public void buildDescription_isEnglishRegardlessOfDefaultLocale() { + Locale defaultLocale = Locale.getDefault(); + try { + Locale.setDefault(Locale.GERMANY); + ValidationAnnotationScanner germanScanner = new ValidationAnnotationScanner(index); + ClassInfo classInfo = index.getClassByName(TestRepresentation.class); + + assertTrue(germanScanner.buildDescription(classInfo, "notBlankField").contains("must not be blank")); + assertTrue(germanScanner.buildDescription(classInfo, "sizedString").contains("size must be between 5 and 100")); + } finally { + Locale.setDefault(defaultLocale); + } + } + @Test public void buildDescription_jakartaConstraintWhenConstraintTypeNotIndexed() throws IOException { // Mirrors OpenAPI generation: scanPackages often excludes jakarta.validation from the Jandex index From ed355c56ee119a63ea75eb06cd523eafa011762a Mon Sep 17 00:00:00 2001 From: Jyotirmoy Roy Date: Sat, 14 Nov 2026 09:01:15 +0530 Subject: [PATCH 8/8] Update documentation and tests for username template handling and invalidation events Signed-off-by: Jyotirmoy Roy --- .../upgrading/topics/changes/changes-26_8_1.adoc | 6 +++++- .../testsuite/broker/KcOidcBrokerTokenExchangeTest.java | 6 ++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/documentation/upgrading/topics/changes/changes-26_8_1.adoc b/docs/documentation/upgrading/topics/changes/changes-26_8_1.adoc index a3bca9ada1aa..39f6c9ac8845 100644 --- a/docs/documentation/upgrading/topics/changes/changes-26_8_1.adoc +++ b/docs/documentation/upgrading/topics/changes/changes-26_8_1.adoc @@ -76,7 +76,7 @@ A username template that does not resolve to a non-blank username now fails the Review the username template of any identity provider mapper that does not resolve for every user, before upgrading. -No database constraint was added, so existing accounts are not rejected. Use the following query to find accounts that are affected, and assign them a username, for example by resetting their federated identity: +No database constraint was added, so existing accounts are not rejected. Use the following query to find accounts that are affected: [source,sql] ---- @@ -85,6 +85,10 @@ FROM user_entity WHERE username IS NULL OR TRIM(username) = ''; ---- +Assign them a username through the Admin Console or the Admin REST API by user ID, enabling *Edit username* in the realm if necessary. +Resetting or unlinking a federated identity does not assign a local username. +Re-linking the identity does not repair the username when the mapper uses the `IMPORT` or `LEGACY` sync mode. + === Registration access tokens are rejected by client registration endpoints of a different protocol Updating or deleting a client through a client registration endpoint whose protocol does not match the client, such as using a SAML client's registration access token against the `openid-connect` endpoint, is now rejected with `400 invalid_client`, matching the behavior that already applied to read requests. Use the protocol-agnostic `clients-registrations/default` endpoint or the Admin REST API to manage clients of other protocols. diff --git a/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcOidcBrokerTokenExchangeTest.java b/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcOidcBrokerTokenExchangeTest.java index 1e7544b7ad9f..c9e8f494c576 100644 --- a/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcOidcBrokerTokenExchangeTest.java +++ b/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcOidcBrokerTokenExchangeTest.java @@ -114,6 +114,12 @@ public void testExternalInternalTokenExchangeRejectsUnresolvableUsernameTemplate RealmResource consumerRealm = realmsResouce().realm(bc.consumerRealmName()); IdentityProviderResource identityProviderResource = consumerRealm.identityProviders().get(bc.getIDPAlias()); + IdentityProviderRepresentation idpRepresentation = identityProviderResource.toRepresentation(); + if (!idpRepresentation.getConfig().get("issuer").startsWith(ServerURLs.getAuthServerContextRoot())) { + idpRepresentation.getConfig().put("issuer", ServerURLs.getAuthServerContextRoot() + "/auth/realms/provider"); + identityProviderResource.update(idpRepresentation); + } + IdentityProviderMapperRepresentation usernameTemplateMapper = new IdentityProviderMapperRepresentation(); usernameTemplateMapper.setName("unresolvable-username-template"); usernameTemplateMapper.setIdentityProviderAlias(bc.getIDPAlias());