Package org.opends.server.extensions

Class Base64PasswordStorageScheme

java.lang.Object

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

org.opends.server.extensions.Base64PasswordStorageScheme

public final class Base64PasswordStorageScheme
extends PasswordStorageScheme<Base64PasswordStorageSchemeCfg>

This class defines a Directory Server password storage scheme that will store the values in base64-encoded form. This is a reversible algorithm that offers very little actual protection -- it will merely obscure the plaintext value from the casual observer.

Constructor Summary

Constructors

Constructor	Description
Base64PasswordStorageScheme()

Method Summary

Modifier and Type	Method	Description
ByteString	encodePassword(ByteString plaintext)	Encodes the provided plaintext password for this storage scheme, without the name of the associated scheme.
ByteString	getPlaintextValue(ByteString 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(Base64PasswordStorageSchemeCfg configuration, ServerContext serverContext)	Initializes this password storage scheme handler based on the information in the provided configuration entry.
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(ByteString plaintextPassword, ByteString storedPassword)	Indicates whether the provided plaintext password included in a bind request matches the given stored value.

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

authPasswordMatches, destroySilently, encodeAuthPassword, encodePasswordWithScheme, finalizePasswordStorageScheme, getAuthPasswordPlaintextValue, getAuthPasswordSchemeName, isConfigurationAcceptable, isRehashNeeded, supportsAuthPasswordSyntax

Methods inherited from class java.lang.Object

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

Constructor Detail

Base64PasswordStorageScheme

public Base64PasswordStorageScheme()

Method Detail

initializePasswordStorageScheme

public void initializePasswordStorageScheme(Base64PasswordStorageSchemeCfg configuration,
                                            ServerContext serverContext)

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<Base64PasswordStorageSchemeCfg>

Parameters:

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

serverContext - The server context

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<Base64PasswordStorageSchemeCfg>

Returns:

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

encodePassword

public ByteString encodePassword(ByteString plaintext)

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<Base64PasswordStorageSchemeCfg>

Parameters:

plaintext - The plaintext version of the password.

Returns:

The password that has been encoded using this storage scheme.

passwordMatches

public boolean passwordMatches(ByteString plaintextPassword,
                               ByteString 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<Base64PasswordStorageSchemeCfg>

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).

Overrides:

isReversible in class PasswordStorageScheme<Base64PasswordStorageSchemeCfg>

Returns:

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

getPlaintextValue

public ByteString getPlaintextValue(ByteString storedPassword)
                             throws LdapException

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.

Overrides:

getPlaintextValue in class PasswordStorageScheme<Base64PasswordStorageSchemeCfg>

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:

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

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<Base64PasswordStorageSchemeCfg>

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.