org.keycloak.models

Class PasswordPolicy

java.lang.Object

org.keycloak.models.PasswordPolicy

All Implemented Interfaces:

Serializable

public class PasswordPolicy
extends Object
implements Serializable

Author:

Stian Thorgersen

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PasswordPolicy.Error

Field Summary

Fields

Modifier and Type	Field and Description
static String	INVALID_PASSWORD_HISTORY
static String	INVALID_PASSWORD_MIN_DIGITS_MESSAGE
static String	INVALID_PASSWORD_MIN_LENGTH_MESSAGE
static String	INVALID_PASSWORD_MIN_LOWER_CASE_CHARS_MESSAGE
static String	INVALID_PASSWORD_MIN_SPECIAL_CHARS_MESSAGE
static String	INVALID_PASSWORD_MIN_UPPER_CASE_CHARS_MESSAGE
static String	INVALID_PASSWORD_NOT_USERNAME
static String	INVALID_PASSWORD_REGEX_PATTERN

Constructor Summary

Constructors

Constructor and Description
PasswordPolicy(String policyString)

Method Summary

Modifier and Type	Method and Description
int	getDaysToExpirePassword()
int	getExpiredPasswords()
String	getHashAlgorithm()
int	getHashIterations()
String	toString()
PasswordPolicy.Error	validate(KeycloakSession session, String user, String password)
PasswordPolicy.Error	validate(KeycloakSession session, UserModel user, String password)

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_PASSWORD_MIN_LENGTH_MESSAGE

public static final String INVALID_PASSWORD_MIN_LENGTH_MESSAGE

See Also:

Constant Field Values

INVALID_PASSWORD_MIN_DIGITS_MESSAGE

public static final String INVALID_PASSWORD_MIN_DIGITS_MESSAGE

See Also:

Constant Field Values

INVALID_PASSWORD_MIN_LOWER_CASE_CHARS_MESSAGE

public static final String INVALID_PASSWORD_MIN_LOWER_CASE_CHARS_MESSAGE

See Also:

Constant Field Values

INVALID_PASSWORD_MIN_UPPER_CASE_CHARS_MESSAGE

public static final String INVALID_PASSWORD_MIN_UPPER_CASE_CHARS_MESSAGE

See Also:

Constant Field Values

INVALID_PASSWORD_MIN_SPECIAL_CHARS_MESSAGE

public static final String INVALID_PASSWORD_MIN_SPECIAL_CHARS_MESSAGE

See Also:

Constant Field Values

INVALID_PASSWORD_NOT_USERNAME

public static final String INVALID_PASSWORD_NOT_USERNAME

See Also:

Constant Field Values

INVALID_PASSWORD_REGEX_PATTERN

public static final String INVALID_PASSWORD_REGEX_PATTERN

See Also:

Constant Field Values

INVALID_PASSWORD_HISTORY

public static final String INVALID_PASSWORD_HISTORY

See Also:

Constant Field Values

Constructor Detail

PasswordPolicy

public PasswordPolicy(String policyString)

Method Detail

getHashAlgorithm

public String getHashAlgorithm()

getHashIterations

public int getHashIterations()

Returns:

-1 if no hash iterations setting

getExpiredPasswords

public int getExpiredPasswords()

Returns:

-1 if no expired passwords setting

getDaysToExpirePassword

public int getDaysToExpirePassword()

Returns:

-1 if no force expired password change setting

validate

public PasswordPolicy.Error validate(KeycloakSession session,
                                     UserModel user,
                                     String password)

validate

public PasswordPolicy.Error validate(KeycloakSession session,
                                     String user,
                                     String password)

toString

public String toString()

Overrides:

toString in class Object