Package org.opends.server.extensions

Class BcryptPasswordStorageScheme

java.lang.Object

org.opends.server.api.PasswordStorageScheme<BcryptPasswordStorageSchemeCfg>

org.opends.server.extensions.BcryptPasswordStorageScheme

All Implemented Interfaces:

ConfigurationChangeListener<BcryptPasswordStorageSchemeCfg>

public class BcryptPasswordStorageScheme
extends PasswordStorageScheme<BcryptPasswordStorageSchemeCfg>
implements ConfigurationChangeListener<BcryptPasswordStorageSchemeCfg>

This class defines a Directory Server password storage scheme that will encode values using the Blowfish reversible encryption algorithm. This implementation supports only the user password syntax and not the auth password syntax.

Constructor Summary

Constructors

Constructor	Description
BcryptPasswordStorageScheme()	Creates a new instance of this password storage scheme.

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationChange(BcryptPasswordStorageSchemeCfg configuration)	Applies the configuration changes to this change listener.
boolean	authPasswordMatches(ByteSequence plaintextPassword, String authInfo, String authValue)	Indicates whether the provided plaintext password matches the encoded password using the authentication password syntax with the given authInfo and authValue components.
ByteString	encodeAuthPassword(ByteSequence plaintext)	Encodes the provided plaintext password for this storage scheme using the authentication password syntax defined in RFC 3112.
ByteString	encodePassword(ByteSequence plaintext)	Encodes the provided plaintext password for this storage scheme, without the name of the associated scheme.
ByteString	encodePasswordWithScheme(ByteSequence plaintext)	Encodes the provided plaintext password for this storage scheme, prepending the name of the scheme in curly braces.
ByteString	getAuthPasswordPlaintextValue(String authInfo, String authValue)	Retrieves the original plaintext value for the provided password stored in the authPassword syntax.
ByteString	getPlaintextValue(ByteSequence storedPassword)	Retrieves the original plaintext value for the provided stored password.
String	getStorageSchemeName()	Retrieves the name of the password storage scheme provided by this handler.
void	initializePasswordStorageScheme(BcryptPasswordStorageSchemeCfg configuration)	Initializes this password storage scheme handler based on the information in the provided configuration entry.
boolean	isConfigurationChangeAcceptable(BcryptPasswordStorageSchemeCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)	Indicates whether the proposed change to the configuration is acceptable to this change listener.
boolean	isReversible()	Indicates whether this storage scheme is reversible (i.e., it is possible to obtain the original plaintext value from the stored password).
boolean	isStorageSchemeSecure()	Indicates whether this password storage scheme should be considered "secure".
boolean	passwordMatches(ByteSequence plaintextPassword, ByteSequence storedPassword)	Indicates whether the provided plaintext password included in a bind request matches the given stored value.
boolean	supportsAuthPasswordSyntax()	Indicates whether this password storage scheme supports the ability to interact with values using the authentication password syntax defined in RFC 3112.

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

finalizePasswordStorageScheme, getAuthPasswordSchemeName, isConfigurationAcceptable

Methods inherited from class java.lang.Object

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

Constructor Detail

BcryptPasswordStorageScheme

public BcryptPasswordStorageScheme()

Creates a new instance of this password storage scheme. Note that no initialization should be performed here, as all initialization should be done in the initializePasswordStorageScheme(BcryptPasswordStorageSchemeCfg) method.

Method Detail

initializePasswordStorageScheme

public void initializePasswordStorageScheme(BcryptPasswordStorageSchemeCfg configuration)
                                     throws ConfigException,
                                            InitializationException

Description copied from class: PasswordStorageScheme

Initializes this password storage scheme handler based on the information in the provided configuration entry. It should also register itself with the Directory Server for the particular storage scheme that it will manage.

Specified by:

initializePasswordStorageScheme in class PasswordStorageScheme<BcryptPasswordStorageSchemeCfg>

Parameters:

configuration - The configuration entry that contains the information to use to initialize this password storage scheme handler.

Throws:

ConfigException - If an unrecoverable problem arises in the process of performing the initialization.

InitializationException - If a problem occurs during initialization that is not related to the server configuration.

getStorageSchemeName

public String getStorageSchemeName()

Description copied from class: PasswordStorageScheme

Retrieves the name of the password storage scheme provided by this handler.

Specified by:

getStorageSchemeName in class PasswordStorageScheme<BcryptPasswordStorageSchemeCfg>

Returns:

The name of the password storage scheme provided by this handler.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(BcryptPasswordStorageSchemeCfg configuration,
                                               List<org.forgerock.i18n.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<BcryptPasswordStorageSchemeCfg>

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(BcryptPasswordStorageSchemeCfg configuration)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<BcryptPasswordStorageSchemeCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

encodePassword

public ByteString encodePassword(ByteSequence plaintext)
                          throws DirectoryException

Description copied from class: PasswordStorageScheme

Encodes the provided plaintext password for this storage scheme, without the name of the associated scheme. Note that the provided plaintext password should not be altered in any way.

Specified by:

encodePassword in class PasswordStorageScheme<BcryptPasswordStorageSchemeCfg>

Parameters:

plaintext - The plaintext version of the password.

Returns:

The password that has been encoded using this storage scheme.

Throws:

DirectoryException - If a problem occurs while processing.

encodePasswordWithScheme

public ByteString encodePasswordWithScheme(ByteSequence plaintext)
                                    throws DirectoryException

Description copied from class: PasswordStorageScheme

Encodes the provided plaintext password for this storage scheme, prepending the name of the scheme in curly braces. Note that the provided plaintext password should not be altered in any way.

Specified by:

encodePasswordWithScheme in class PasswordStorageScheme<BcryptPasswordStorageSchemeCfg>

Parameters:

plaintext - The plaintext version of the password.

Returns:

The encoded password, including the name of the storage scheme.

Throws:

DirectoryException - If a problem occurs while processing.

passwordMatches

public boolean passwordMatches(ByteSequence plaintextPassword,
                               ByteSequence storedPassword)

Description copied from class: PasswordStorageScheme

Indicates whether the provided plaintext password included in a bind request matches the given stored value. The provided stored value should not include the scheme name in curly braces.

Specified by:

passwordMatches in class PasswordStorageScheme<BcryptPasswordStorageSchemeCfg>

Parameters:

plaintextPassword - The plaintext password provided by the user as part of a simple bind attempt.

storedPassword - The stored password to compare against the provided plaintext password.

Returns:

true if the provided plaintext password matches the provided stored password, or false if not.

isReversible

public boolean isReversible()

Description copied from class: PasswordStorageScheme

Indicates whether this storage scheme is reversible (i.e., it is possible to obtain the original plaintext value from the stored password).

Specified by:

isReversible in class PasswordStorageScheme<BcryptPasswordStorageSchemeCfg>

Returns:

true if this is a reversible password storage scheme, or false if it is not.

getPlaintextValue

public ByteString getPlaintextValue(ByteSequence storedPassword)
                             throws DirectoryException

Description copied from class: PasswordStorageScheme

Retrieves the original plaintext value for the provided stored password. Note that this should only be called if isReversible returns true.

Specified by:

getPlaintextValue in class PasswordStorageScheme<BcryptPasswordStorageSchemeCfg>

Parameters:

storedPassword - The password for which to obtain the plaintext value. It should not include the scheme name in curly braces.

Returns:

The plaintext value for the provided stored password.

Throws:

DirectoryException - If it is not possible to obtain the plaintext value for the provided stored password.

supportsAuthPasswordSyntax

public boolean supportsAuthPasswordSyntax()

Description copied from class: PasswordStorageScheme

Indicates whether this password storage scheme supports the ability to interact with values using the authentication password syntax defined in RFC 3112.

Specified by:

supportsAuthPasswordSyntax in class PasswordStorageScheme<BcryptPasswordStorageSchemeCfg>

Returns:

true if this password storage scheme supports the ability to interact with values using the authentication password syntax, or false if it does not.

encodeAuthPassword

public ByteString encodeAuthPassword(ByteSequence plaintext)
                              throws DirectoryException

Description copied from class: PasswordStorageScheme

Encodes the provided plaintext password for this storage scheme using the authentication password syntax defined in RFC 3112. Note that the provided plaintext password should not be altered in any way.

Specified by:

encodeAuthPassword in class PasswordStorageScheme<BcryptPasswordStorageSchemeCfg>

Parameters:

plaintext - The plaintext version of the password.

Returns:

The password that has been encoded in the authentication password syntax.

Throws:

DirectoryException - If a problem occurs while processing of if this storage scheme does not support the authentication password syntax.

authPasswordMatches

public boolean authPasswordMatches(ByteSequence plaintextPassword,
                                   String authInfo,
                                   String authValue)

Description copied from class: PasswordStorageScheme

Indicates whether the provided plaintext password matches the encoded password using the authentication password syntax with the given authInfo and authValue components.

Specified by:

authPasswordMatches in class PasswordStorageScheme<BcryptPasswordStorageSchemeCfg>

Parameters:

plaintextPassword - The plaintext password provided by the user.

authInfo - The authInfo component of the password encoded in the authentication password syntax.

authValue - The authValue component of the password encoded in the authentication password syntax.

Returns:

true if the provided plaintext password matches the encoded password according to the authentication password info syntax, or false if it does not or this storage scheme does not support the authentication password syntax.

getAuthPasswordPlaintextValue

public ByteString getAuthPasswordPlaintextValue(String authInfo,
                                                String authValue)
                                         throws DirectoryException

Description copied from class: PasswordStorageScheme

Retrieves the original plaintext value for the provided password stored in the authPassword syntax. Note that this should only be called if isReversible returns true.

Specified by:

getAuthPasswordPlaintextValue in class PasswordStorageScheme<BcryptPasswordStorageSchemeCfg>

Parameters:

authInfo - The authInfo component of the password encoded in the authentication password syntax.

authValue - The authValue component of the password encoded in the authentication password syntax.

Returns:

The plaintext value for the provided stored password.

Throws:

DirectoryException - If it is not possible to obtain the plaintext value for the provided stored password, or if this storage scheme does not support the authPassword syntax..

isStorageSchemeSecure

public boolean isStorageSchemeSecure()

Description copied from class: PasswordStorageScheme

Indicates whether this password storage scheme should be considered "secure". If the encoding used for this scheme does not obscure the value at all, or if it uses a method that is trivial to reverse (e.g., base64), then it should not be considered secure.

This may be used to determine whether a password may be included in a set of search results, including the possibility of overriding access controls in the case that access controls would allow the password to be returned but the password is considered too insecure to reveal.

Specified by:

isStorageSchemeSecure in class PasswordStorageScheme<BcryptPasswordStorageSchemeCfg>

Returns:

false if it may be trivial to discover the original plain-text password from the encoded form, or true if the scheme offers sufficient protection that revealing the encoded password will not easily reveal the corresponding plain-text value.