Package org.opends.server.extensions

Class SimilarityBasedPasswordValidator

java.lang.Object

org.opends.server.api.PasswordValidator<SimilarityBasedPasswordValidatorCfg>

org.opends.server.extensions.SimilarityBasedPasswordValidator

All Implemented Interfaces:

ConfigurationChangeListener<SimilarityBasedPasswordValidatorCfg>

public final class SimilarityBasedPasswordValidator
extends PasswordValidator<SimilarityBasedPasswordValidatorCfg>
implements ConfigurationChangeListener<SimilarityBasedPasswordValidatorCfg>

This class provides a password validator that can ensure that the provided password meets minimum similarity requirements.

Constructor Summary

Constructors

Constructor	Description
SimilarityBasedPasswordValidator()	Creates a new instance of this password validator.

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationChange(SimilarityBasedPasswordValidatorCfg configuration)	Applies the configuration changes to this change listener.
com.forgerock.opendj.ldap.controls.PasswordQualityAdviceResponseControl.Criteria	createPasswordQualityCriteria()	Returns a password quality criteria corresponding to the type and parameters of this validator for use in a PasswordQualityAdviceResponseControl.
void	finalizePasswordValidator()	Performs any finalization that might be required when this password validator is unloaded.
void	initializePasswordValidator(SimilarityBasedPasswordValidatorCfg configuration)	Initializes this password validator based on the information in the provided configuration entry.
boolean	isConfigurationChangeAcceptable(SimilarityBasedPasswordValidatorCfg configuration, List<LocalizableMessage> unacceptableReasons)	Indicates whether the proposed change to the configuration is acceptable to this change listener.
boolean	passwordIsAcceptable(ByteString newPassword, Set<ByteString> currentPasswords, Operation operation, Entry userEntry, LocalizableMessageBuilder invalidReason)	Indicates whether the provided password is acceptable for use by the specified user.

Methods inherited from class org.opends.server.api.PasswordValidator

isConfigurationAcceptable

Methods inherited from class java.lang.Object

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

Constructor Detail

SimilarityBasedPasswordValidator

public SimilarityBasedPasswordValidator()

Creates a new instance of this password validator.

Method Detail

initializePasswordValidator

public void initializePasswordValidator(SimilarityBasedPasswordValidatorCfg configuration)

Description copied from class: PasswordValidator

Initializes this password validator based on the information in the provided configuration entry.

Specified by:

initializePasswordValidator in class PasswordValidator<SimilarityBasedPasswordValidatorCfg>

Parameters:

configuration - The configuration to use to initialize this password validator.

finalizePasswordValidator

public void finalizePasswordValidator()

Description copied from class: PasswordValidator

Performs any finalization that might be required when this password validator is unloaded. No action is taken in the default implementation.

Overrides:

finalizePasswordValidator in class PasswordValidator<SimilarityBasedPasswordValidatorCfg>

passwordIsAcceptable

public boolean passwordIsAcceptable(ByteString newPassword,
                                    Set<ByteString> currentPasswords,
                                    Operation operation,
                                    Entry userEntry,
                                    LocalizableMessageBuilder invalidReason)

Description copied from class: PasswordValidator

Indicates whether the provided password is acceptable for use by the specified user. If the password is determined to be unacceptable, then a human-readable explanation should be appended to the provided buffer.

Specified by:

passwordIsAcceptable in class PasswordValidator<SimilarityBasedPasswordValidatorCfg>

Parameters:

newPassword - The proposed clear-text password that should be validated.

currentPasswords - The set of clear-text current passwords for the user (if available). Note that the current passwords may not always be available, and this may not comprise entire set of passwords currently for the user.

operation - The operation that is being used to set the password. It may be an add, a modify, or a password modify operation.

userEntry - The entry for the user whose password is being changed.

invalidReason - The buffer to which the human-readable explanation should be appended if it is determined that the password is not acceptable.

Returns:

true if the password is acceptable, or false if not.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(SimilarityBasedPasswordValidatorCfg configuration,
                                               List<LocalizableMessage> unacceptableReasons)

Description copied from interface: ConfigurationChangeListener

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<SimilarityBasedPasswordValidatorCfg>

Parameters:

configuration - The new configuration containing the changes.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.

applyConfigurationChange

public ConfigChangeResult applyConfigurationChange(SimilarityBasedPasswordValidatorCfg configuration)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<SimilarityBasedPasswordValidatorCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

createPasswordQualityCriteria

public com.forgerock.opendj.ldap.controls.PasswordQualityAdviceResponseControl.Criteria createPasswordQualityCriteria()

Description copied from class: PasswordValidator

Returns a password quality criteria corresponding to the type and parameters of this validator for use in a PasswordQualityAdviceResponseControl.

Specified by:

createPasswordQualityCriteria in class PasswordValidator<SimilarityBasedPasswordValidatorCfg>

Returns:

A password quality criteria corresponding to the type and parameters of this validator.