Skip to content

Fix duplicate label when using password history #42789

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
ahus1 merged 1 commit into from
Sep 24, 2025
Merged

Fix duplicate label when using password history #42789

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions model/jpa/src/main/java/org/keycloak/models/jpa/JpaUserCredentialStore.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public void updateCredential(RealmModel realm, UserModel user, CredentialModel c
if (!Objects.equals(cred.getUserLabel(), entity.getUserLabel())) {
// For legacy entries in the credentials, there might be a duplicate for historical reasons.
// Ignore them when the credential is updated, which might happen when credentials are verified.
validateDuplicateCredential(realm, user, cred.getUserLabel(), cred.getId());
validateDuplicateCredential(realm, user, cred.getType(), cred.getUserLabel(), cred.getId());
}
entity.setCreatedDate(cred.getCreatedDate());
entity.setUserLabel(cred.getUserLabel());
Expand Down Expand Up @@ -135,7 +135,7 @@ public Stream<CredentialModel> getStoredCredentialsByTypeStream(RealmModel realm
@Override
public CredentialModel getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type) {
return getStoredCredentialsStream(realm, user).filter(credential ->
Objects.equals(type, credential.getType()) && Objects.equals(name, credential.getUserLabel()))
Objects.equals(type, credential.getType()) && Objects.equals(name, credential.getUserLabel()))
.findFirst().orElse(null);
}

Expand All @@ -144,12 +144,13 @@ public void close() {

}

private void validateDuplicateCredential(RealmModel realm, UserModel user, String userLabel, String credentialId) {
private void validateDuplicateCredential(RealmModel realm, UserModel user, String credType, String userLabel, String credentialId) {
if (userLabel != null) {
boolean exists = getStoredCredentialEntities(realm, user)
.anyMatch(existing -> existing.getUserLabel() != null
&& existing.getUserLabel().equalsIgnoreCase(userLabel.trim())
&& (credentialId == null || !existing.getId().equals(credentialId))); // Exclude self in update
&& existing.getType().equals(credType)
&& !existing.getId().equals(credentialId)); // Exclude self in update

if (exists) {
throw new ModelDuplicateException("Device already exists with the same name", CredentialModel.USER_LABEL);
Expand All @@ -158,7 +159,7 @@ private void validateDuplicateCredential(RealmModel realm, UserModel user, Strin
}

CredentialEntity createCredentialEntity(RealmModel realm, UserModel user, CredentialModel cred) {
validateDuplicateCredential(realm, user, cred.getUserLabel(), null);
validateDuplicateCredential(realm, user, cred.getType(), cred.getUserLabel(), null);
CredentialEntity entity = new CredentialEntity();
String id = cred.getId() == null ? KeycloakModelUtils.generateId() : cred.getId();
entity.setId(id);
Expand Down
2 changes: 2 additions & 0 deletions services/src/main/java/org/keycloak/credential/PasswordCredentialProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,8 @@ public CredentialModel createCredential(RealmModel realm, UserModel user, Passwo
if (expiredPasswordsPolicyValue > 1 || passwordAgeInDaysPolicy > 0) {
oldPassword.setId(null);
oldPassword.setType(PasswordCredentialModel.PASSWORD_HISTORY);
// Setting the label to "nulL" avoids duplicate label errors
Copy link
Contributor

@rmartinc rmartinc Sep 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Small typo nulL but it's OK.

oldPassword.setUserLabel(null);
oldPassword = user.credentialManager().createStoredCredential(oldPassword);
}
}
Expand Down
2 changes: 2 additions & 0 deletions ...ian/tests/base/src/test/java/org/keycloak/testsuite/policy/PasswordHistoryPolicyTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ public void resetUserPassword(UserResource userResource, String newPassword) {
newCredential.setValue(newPassword);
newCredential.setTemporary(false);
userResource.resetPassword(newCredential);
CredentialRepresentation cr = userResource.credentials().stream().filter(credentialRepresentation -> credentialRepresentation.getType().equals(PASSWORD)).findFirst().get();
userResource.setCredentialUserLabel(cr.getId(), "My Password");
}

private void expectBadRequestException(Consumer<Void> f) {
Expand Down
2 changes: 1 addition & 1 deletion ...sts/base/src/test/java/org/keycloak/testsuite/webauthn/account/WebAuthnSigningInTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ public void createWebAuthnSameUserLabel() {

final String SAME_LABEL = "key123";

SigningInPage.UserCredential webAuthn = addWebAuthnCredential(SAME_LABEL, false);
SigningInPage.UserCredential webAuthn = addWebAuthnCredential(SAME_LABEL, true);
assertThat(webAuthn, notNullValue());

SigningInPage.CredentialType credentialType = webAuthnPwdlessCredentialType;
Expand Down
Loading