feature: password age in days policy

Closes keycloak#30210 Signed-off-by: Maciej Mierzwa <[email protected]>
MaciejMierzwa · Jun 12, 2024 · ad87a1b · ad87a1b
1 parent c7361cc
commit ad87a1b
Show file tree

Hide file tree

Showing 7 changed files with 406 additions and 4 deletions.
diff --git a/common/src/main/java/org/keycloak/common/util/Time.java b/common/src/main/java/org/keycloak/common/util/Time.java
@@ -69,6 +69,15 @@ public static long toMillis(long time) {
         return time * 1000L;
     }
 
+    /**
+     *  Calculates number of milliseconds from passed argument
+     * @param days Time in days
+     * @return Time in milliseconds
+     */
+    public static long daysToMillis(int days) {
+        return (long) days * 24 * 60 * 60 * 1000;
+    }
+
     /**
      * @return Time offset in seconds that will be added to {@link #currentTime()} and {@link #currentTimeMillis()}.
      */

diff --git a/server-spi-private/src/main/java/org/keycloak/policy/AgePasswordPolicyProvider.java b/server-spi-private/src/main/java/org/keycloak/policy/AgePasswordPolicyProvider.java
@@ -0,0 +1,71 @@
+package org.keycloak.policy;
+
+import org.keycloak.common.util.Time;
+import org.keycloak.credential.CredentialModel;
+import org.keycloak.credential.hash.PasswordHashProvider;
+import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.PasswordPolicy;
+import org.keycloak.models.RealmModel;
+import org.keycloak.models.UserModel;
+import org.keycloak.models.credential.PasswordCredentialModel;
+import org.jboss.logging.Logger;
+
+import java.util.stream.Stream;
+
+public class AgePasswordPolicyProvider implements PasswordPolicyProvider {
+    private static final String ERROR_MESSAGE = "invalidPasswordGenericMessage";
+    public static final Logger logger = Logger.getLogger(AgePasswordPolicyProvider.class);
+    private final KeycloakSession session;
+
+    public AgePasswordPolicyProvider(KeycloakSession session) {
+        this.session = session;
+    }
+
+    @Override
+    public PolicyError validate(String user, String password) {
+        return null;
+    }
+
+    @Override
+    public PolicyError validate(RealmModel realm, UserModel user, String password) {
+        PasswordPolicy policy = session.getContext().getRealm().getPasswordPolicy();
+        int passwordAgePolicyValue = policy.getPolicyConfig(PasswordPolicy.PASSWORD_AGE);
+
+        if (passwordAgePolicyValue != -1) {
+            //current password check
+            if (user.credentialManager().getStoredCredentialsByTypeStream(PasswordCredentialModel.TYPE)
+                    .map(PasswordCredentialModel::createFromCredentialModel)
+                    .anyMatch(passwordCredential -> {
+                        PasswordHashProvider hash = session.getProvider(PasswordHashProvider.class,
+                                passwordCredential.getPasswordCredentialData().getAlgorithm());
+                        return hash != null && hash.verify(password, passwordCredential);
+                    })) {
+                return new PolicyError(ERROR_MESSAGE, passwordAgePolicyValue);
+            }
+
+            final long passwordMaxAgeMillis = Time.currentTimeMillis() - Time.daysToMillis(passwordAgePolicyValue);
+            if (passwordAgePolicyValue > 0) {
+                if (user.credentialManager().getStoredCredentialsByTypeStream(PasswordCredentialModel.PASSWORD_HISTORY)
+                        .filter(credentialModel -> credentialModel.getCreatedDate() > passwordMaxAgeMillis)
+                        .map(PasswordCredentialModel::createFromCredentialModel)
+                        .anyMatch(passwordCredential -> {
+                            PasswordHashProvider hash = session.getProvider(PasswordHashProvider.class,
+                                    passwordCredential.getPasswordCredentialData().getAlgorithm());
+                            return hash.verify(password, passwordCredential);
+                        })) {
+                    return new PolicyError(ERROR_MESSAGE, passwordAgePolicyValue);
+                }
+            }
+        }
+        return null;
+    }
+
+    @Override
+    public Object parseConfig(String value) {
+        return parseInteger(value, AgePasswordPolicyProviderFactory.DEFAULT_AGE_DAYS);
+    }
+
+    @Override
+    public void close() {
+    }
+}
diff --git a/server-spi-private/src/main/java/org/keycloak/policy/AgePasswordPolicyProviderFactory.java b/server-spi-private/src/main/java/org/keycloak/policy/AgePasswordPolicyProviderFactory.java
@@ -0,0 +1,55 @@
+package org.keycloak.policy;
+
+import org.keycloak.Config;
+import org.keycloak.models.KeycloakSession;
+import org.keycloak.models.KeycloakSessionFactory;
+import org.keycloak.models.PasswordPolicy;
+
+public class AgePasswordPolicyProviderFactory implements PasswordPolicyProviderFactory {
+    public static final Integer DEFAULT_AGE_DAYS = 30;
+
+    @Override
+    public String getId() {
+        return PasswordPolicy.PASSWORD_AGE;
+    }
+
+    @Override
+    public String getDisplayName() {
+        return "Not Recently Used (In Days)";
+    }
+
+    @Override
+    public String getConfigType() {
+        return PasswordPolicyProvider.INT_CONFIG_TYPE;
+    }
+
+    @Override
+    public String getDefaultConfigValue() {
+        return String.valueOf(DEFAULT_AGE_DAYS);
+    }
+
+    @Override
+    public boolean isMultiplSupported() {
+        return false;
+    }
+
+    @Override
+    public PasswordPolicyProvider create(KeycloakSession session) {
+        return new AgePasswordPolicyProvider(session);
+    }
+
+    @Override
+    public void init(Config.Scope config) {
+
+    }
+
+    @Override
+    public void postInit(KeycloakSessionFactory factory) {
+
+    }
+
+    @Override
+    public void close() {
+
+    }
+}
diff --git a/...te/src/main/resources/META-INF/services/org.keycloak.policy.PasswordPolicyProviderFactory b/...te/src/main/resources/META-INF/services/org.keycloak.policy.PasswordPolicyProviderFactory
@@ -32,3 +32,4 @@ org.keycloak.policy.BlacklistPasswordPolicyProviderFactory
 org.keycloak.policy.NotEmailPasswordPolicyProviderFactory
 org.keycloak.policy.RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
 org.keycloak.policy.MaxAuthAgePasswordPolicyProviderFactory
+org.keycloak.policy.AgePasswordPolicyProviderFactory
diff --git a/server-spi/src/main/java/org/keycloak/models/PasswordPolicy.java b/server-spi/src/main/java/org/keycloak/models/PasswordPolicy.java
@@ -45,6 +45,8 @@ public class PasswordPolicy implements Serializable {
 
     public static final String MAX_AUTH_AGE_ID = "maxAuthAge";
 
+    public static final String PASSWORD_AGE = "passwordAge";
+
     private Map<String, Object> policyConfig;
     private Builder builder;
 
@@ -97,6 +99,14 @@ public int getExpiredPasswords() {
         }
     }
 
+    public int getPasswordAgeInDays() {
+        if (policyConfig.containsKey(PASSWORD_AGE)) {
+            return getPolicyConfig(PASSWORD_AGE);
+        } else {
+            return -1;
+        }
+    }
+
     public int getDaysToExpirePassword() {
         if (policyConfig.containsKey(FORCE_EXPIRED_ID)) {
             return getPolicyConfig(FORCE_EXPIRED_ID);

diff --git a/services/src/main/java/org/keycloak/credential/PasswordCredentialProvider.java b/services/src/main/java/org/keycloak/credential/PasswordCredentialProvider.java
@@ -79,6 +79,7 @@ public CredentialModel createCredential(RealmModel realm, UserModel user, Passwo
 
         PasswordPolicy policy = realm.getPasswordPolicy();
         int expiredPasswordsPolicyValue = policy.getExpiredPasswords();
+        int passwordAgeInDaysPolicy = Math.max(0, policy.getPasswordAgeInDays());
 
         // 1) create new or reset existing password
         CredentialModel createdCredential;
@@ -94,24 +95,34 @@ public CredentialModel createCredential(RealmModel realm, UserModel user, Passwo
             createdCredential = credentialModel;
 
             // 2) add a password history item based on the old password
-            if (expiredPasswordsPolicyValue > 1) {
+            if (expiredPasswordsPolicyValue > 1 || passwordAgeInDaysPolicy > 0) {
                 oldPassword.setId(null);
                 oldPassword.setType(PasswordCredentialModel.PASSWORD_HISTORY);
-                user.credentialManager().createStoredCredential(oldPassword);
+                oldPassword = user.credentialManager().createStoredCredential(oldPassword);
             }
         }
-        
-        // 3) remove old password history items
+
+        // 3) remove old password history items, if both history policies are set, more restrictive policy wins
         final int passwordHistoryListMaxSize = Math.max(0, expiredPasswordsPolicyValue - 1);
+
+        final long passwordMaxAgeMillis = Time.currentTimeMillis() - Time.daysToMillis(passwordAgeInDaysPolicy);
+
+        CredentialModel finalOldPassword = oldPassword;
         user.credentialManager().getStoredCredentialsByTypeStream(PasswordCredentialModel.PASSWORD_HISTORY)
                 .sorted(CredentialModel.comparingByStartDateDesc())
                 .skip(passwordHistoryListMaxSize)
+                .filter(credentialModel1 -> !(credentialModel1.getId().equals(finalOldPassword.getId())))
+                .filter(credential -> passwordAgePredicate(credential, passwordMaxAgeMillis))
                 .collect(Collectors.toList())
                 .forEach(p -> user.credentialManager().removeStoredCredentialById(p.getId()));
 
         return createdCredential;
     }
 
+    private boolean passwordAgePredicate(CredentialModel credential, long passwordMaxAgeMillis) {
+        return credential.getCreatedDate() < passwordMaxAgeMillis;
+    }
+
     @Override
     public boolean deleteCredential(RealmModel realm, UserModel user, String credentialId) {
         return user.credentialManager().removeStoredCredentialById(credentialId);