Package org.keycloak.policy

Interface DenylistPasswordPolicyProviderFactory.PasswordDenylist

All Known Implementing Classes:

DenylistPasswordPolicyProviderFactory.FileBasedPasswordDenylist

Enclosing class:

DenylistPasswordPolicyProviderFactory

public static interface DenylistPasswordPolicyProviderFactory.PasswordDenylist

A DenylistPasswordPolicyProviderFactory.PasswordDenylist describes a list of too easy to guess or potentially leaked passwords that users should not be able to use.

Method Summary

Modifier and Type	Method	Description
boolean	contains(String password)	Checks whether a given password is contained in this DenylistPasswordPolicyProviderFactory.PasswordDenylist.
String	getName()

Method Details

getName

String getName()

Returns:

the logical name of the DenylistPasswordPolicyProviderFactory.PasswordDenylist

contains

boolean contains(String password)

Checks whether a given password is contained in this DenylistPasswordPolicyProviderFactory.PasswordDenylist.

Callers must normalize the password via DenylistPasswordPolicyProviderFactory.normalizePassword(String) before calling this method, because the denylist stores passwords in normalized (lowercased) form.

Parameters:

password - the already-normalized password to check

Returns:

true if the password is denied