forked from keycloak/keycloak
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature: password age in days policy
Closes keycloak#30210 Signed-off-by: Maciej Mierzwa <[email protected]>
- Loading branch information
1 parent
8d0e03a
commit c147bba
Showing
7 changed files
with
459 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
90 changes: 90 additions & 0 deletions
90
server-spi-private/src/main/java/org/keycloak/policy/AgePasswordPolicyProvider.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
/* | ||
* Copyright 2024 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.policy; | ||
|
||
import org.keycloak.common.util.Time; | ||
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.time.Duration; | ||
|
||
/** | ||
* @author <a href="mailto:[email protected]">Maciej Mierzwa</a> | ||
*/ | ||
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() - Duration.ofDays(passwordAgePolicyValue).toMillis(); | ||
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() { | ||
} | ||
} |
75 changes: 75 additions & 0 deletions
75
server-spi-private/src/main/java/org/keycloak/policy/AgePasswordPolicyProviderFactory.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
/* | ||
* Copyright 2024 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.policy; | ||
|
||
import org.keycloak.Config; | ||
import org.keycloak.models.KeycloakSession; | ||
import org.keycloak.models.KeycloakSessionFactory; | ||
import org.keycloak.models.PasswordPolicy; | ||
|
||
/** | ||
* @author <a href="mailto:[email protected]">Maciej Mierzwa</a> | ||
*/ | ||
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() { | ||
|
||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.