Package org.keycloak.policy

Class DenylistPasswordPolicyProvider

java.lang.Object

org.keycloak.policy.DenylistPasswordPolicyProvider

All Implemented Interfaces:

org.keycloak.policy.PasswordPolicyProvider, org.keycloak.provider.Provider

public class DenylistPasswordPolicyProvider
extends Object
implements org.keycloak.policy.PasswordPolicyProvider

Checks a password against a configured password denylist.

Author:

Thomas Darimont

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_MESSAGE

Fields inherited from interface org.keycloak.policy.PasswordPolicyProvider

INT_CONFIG_TYPE, STRING_CONFIG_TYPE

Constructor Summary

Constructors

Constructor	Description
DenylistPasswordPolicyProvider(org.keycloak.models.KeycloakContext context, DenylistPasswordPolicyProviderFactory factory)

Method Summary

Modifier and Type	Method	Description
void	close()
Object	parseConfig(String denylistName)	Parses the allowed configuration for a DenylistPasswordPolicyProvider.
org.keycloak.policy.PolicyError	validate(String username, String password)	Checks whether the provided password is contained in the configured blacklist.
org.keycloak.policy.PolicyError	validate(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, String password)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.policy.PasswordPolicyProvider

parseInteger

Field Details

ERROR_MESSAGE

public static final String ERROR_MESSAGE

See Also:

• Constant Field Values

Constructor Details

DenylistPasswordPolicyProvider

public DenylistPasswordPolicyProvider(org.keycloak.models.KeycloakContext context,
 DenylistPasswordPolicyProviderFactory factory)

Method Details

validate

public org.keycloak.policy.PolicyError validate(String username,
 String password)

Checks whether the provided password is contained in the configured blacklist.

Specified by:

validate in interface org.keycloak.policy.PasswordPolicyProvider

Parameters:

username -

password -

Returns:

null if the password is not blacklisted otherwise a PolicyError

validate

public org.keycloak.policy.PolicyError validate(org.keycloak.models.RealmModel realm,
 org.keycloak.models.UserModel user,
 String password)

Specified by:

validate in interface org.keycloak.policy.PasswordPolicyProvider

parseConfig

public Object parseConfig(String denylistName)

Parses the allowed configuration for a DenylistPasswordPolicyProvider. Supported syntax is {@¢ode passwordBlacklist(fileName)} Example configurations:

• passwordBlacklist(test-password-blacklist.txt)

Specified by:

parseConfig in interface org.keycloak.policy.PasswordPolicyProvider

Parameters:

denylistName -

Returns:

close

public void close()

Specified by:

close in interface org.keycloak.provider.Provider