Package org.opends.server.extensions

Class PBKDF2PasswordStorageScheme

java.lang.Object
org.opends.server.api.PasswordStorageScheme<Pbkdf2PasswordStorageSchemeCfg>
org.opends.server.extensions.PBKDF2PasswordStorageScheme
All Implemented Interfaces:
ConfigurationChangeListener<Pbkdf2PasswordStorageSchemeCfg>
public final class PBKDF2PasswordStorageScheme extends PasswordStorageScheme<Pbkdf2PasswordStorageSchemeCfg>
This class defines a Directory Server password storage scheme based on the PBKDF2 algorithm defined in RFC 2898. PBKDF2 is the shortname for PBKDF2-HMAC-SHA1.

  • Constructor Details

    • PBKDF2PasswordStorageScheme

      public PBKDF2PasswordStorageScheme()

  • Method Details

    • getStorageSchemeName

      public String getStorageSchemeName()
      Description copied from class: PasswordStorageScheme
      Retrieves the name of the password storage scheme provided by this handler.
      Returns:
      The name of the password storage scheme provided by this handler.

    • getAuthPasswordSchemeName

      public String getAuthPasswordSchemeName()
      Description copied from class: PasswordStorageScheme
      Retrieves the scheme name that should be used with this password storage scheme when it is used in the context of the authentication password syntax. This default implementation will return the same value as the getStorageSchemeName method.
      Returns:
      The scheme name that should be used with this password storage scheme when it is used in the context of the authentication password syntax.

    • encodeOffline

      public static String encodeOffline(byte[] passwordBytes) throws LdapException
      Generates an encoded password string from the given clear-text password. This method is primarily intended for use when it is necessary to generate a password with the server offline (e.g., when setting the initial root user password).
      Parameters:
      passwordBytes - The bytes that make up the clear-text password.
      Returns:
      The encoded password string, including the scheme name in curly braces.
      Throws:
      LdapException - If a problem occurs during processing.

    • initializePasswordStorageScheme

      public void initializePasswordStorageScheme(Pbkdf2PasswordStorageSchemeCfg config, ServerContext serverContext) throws 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<Pbkdf2PasswordStorageSchemeCfg>
      Parameters:
      config - The configuration entry that contains the information to use to initialize this password storage scheme handler.
      serverContext - The server context
      Throws:
      InitializationException - If a problem occurs during initialization that is not related to the server configuration.

    • encodePassword

      public ByteString encodePassword(ByteString plaintext) throws LdapException
      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<Pbkdf2PasswordStorageSchemeCfg>
      Parameters:
      plaintext - The plaintext version of the password.
      Returns:
      The password that has been encoded using this storage scheme.
      Throws:
      LdapException - If a problem occurs while processing.

    • 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<Pbkdf2PasswordStorageSchemeCfg>
      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.

    • 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.
      Overrides:
      supportsAuthPasswordSyntax in class PasswordStorageScheme<Pbkdf2PasswordStorageSchemeCfg>
      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.

    • isConfigurationChangeAcceptable

      public boolean isConfigurationChangeAcceptable(Pbkdf2PasswordStorageSchemeCfg 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<Pbkdf2PasswordStorageSchemeCfg>
      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(Pbkdf2PasswordStorageSchemeCfg configuration)
      Description copied from interface: ConfigurationChangeListener
      Applies the configuration changes to this change listener.
      Specified by:
      applyConfigurationChange in interface ConfigurationChangeListener<Pbkdf2PasswordStorageSchemeCfg>
      Parameters:
      configuration - The new configuration containing the changes.
      Returns:
      Returns information about the result of changing the configuration.

    • finalizePasswordStorageScheme

      public void finalizePasswordStorageScheme()
      Description copied from class: PasswordStorageScheme
      Performs any necessary finalization that might be required when this password storage scheme is no longer needed (e.g., the scheme is disabled or the server is shutting down).
      Overrides:
      finalizePasswordStorageScheme in class PasswordStorageScheme<Pbkdf2PasswordStorageSchemeCfg>

    • encodeAuthPassword

      public ByteString encodeAuthPassword(ByteString plaintext) throws LdapException
      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.
      Overrides:
      encodeAuthPassword in class PasswordStorageScheme<Pbkdf2PasswordStorageSchemeCfg>
      Parameters:
      plaintext - The plaintext version of the password.
      Returns:
      The password that has been encoded in the authentication password syntax.
      Throws:
      LdapException - If a problem occurs while processing of if this storage scheme does not support the authentication password syntax.

    • authPasswordMatches

      public boolean authPasswordMatches(ByteString 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.

      This is the historical method signature used by clients' custom password storage scheme. Be careful to not modify it.

      Overrides:
      authPasswordMatches in class PasswordStorageScheme<Pbkdf2PasswordStorageSchemeCfg>
      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.

    • 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<Pbkdf2PasswordStorageSchemeCfg>
      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.

    • isRehashNeeded

      public boolean isRehashNeeded(ByteString storedPassword)
      Description copied from class: PasswordStorageScheme
      Indicates whether the encoded password needs to be rehashed because the password storage scheme configuration changed. Only password storage schemes with specific configuration parameters, such as PBKDF2, need to override this method.
      Overrides:
      isRehashNeeded in class PasswordStorageScheme<Pbkdf2PasswordStorageSchemeCfg>
      Parameters:
      storedPassword - An existing hashed password including the name of the storage scheme.
      Returns:
      whether the stored password should be rehashed.