Package org.opends.server.extensions

Class SaltedSHA256PasswordStorageScheme

  • public class SaltedSHA256PasswordStorageScheme
extends PasswordStorageScheme<SaltedSHA256PasswordStorageSchemeCfg>
    This class defines a Directory Server password storage scheme based on the 256-bit SHA-2 algorithm defined in FIPS 180-2. This is a one-way digest algorithm so there is no way to retrieve the original clear-text version of the password from the hashed value (although this means that it is not suitable for things that need the clear-text password like DIGEST-MD5). The values that it generates are also salted, which protects against dictionary attacks. It does this by generating a 64-bit random salt which is appended to the clear-text value. A SHA-2 hash is then generated based on this, the salt is appended to the hash, and then the entire value is base64-encoded.

    • Constructor Detail

      • SaltedSHA256PasswordStorageScheme

        public SaltedSHA256PasswordStorageScheme()
        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 method.

    • Method Detail

      • 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<SaltedSHA256PasswordStorageSchemeCfg>
        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.
        Specified by:
        supportsAuthPasswordSyntax in class PasswordStorageScheme<SaltedSHA256PasswordStorageSchemeCfg>
        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.

      • 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.
        Overrides:
        getAuthPasswordSchemeName in class PasswordStorageScheme<SaltedSHA256PasswordStorageSchemeCfg>
        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.

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