Package org.forgerock.opendj.server.config.client

Interface CryptPasswordStorageSchemeCfgClient

  • All Superinterfaces:
    ConfigurationClient, PasswordStorageSchemeCfgClient
    public interface CryptPasswordStorageSchemeCfgClient
extends PasswordStorageSchemeCfgClient
    A client-side interface for reading and modifying Crypt Password Storage Scheme settings.

    The Crypt Password Storage Scheme provides a mechanism for encoding user passwords like Unix crypt does. Like on most Unix systems, the password may be encrypted using different algorithms, either Unix crypt, md5, sha256 or sha512.

    • Method Detail

      • getCryptPasswordStorageEncryptionAlgorithm

        CryptPasswordStorageSchemeCfgDefn.CryptPasswordStorageEncryptionAlgorithm getCryptPasswordStorageEncryptionAlgorithm()
        Gets the "crypt-password-storage-encryption-algorithm" property.

        Specifies the algorithm to use to encrypt new passwords.

        Select the crypt algorithm to use to encrypt new passwords. The value can either be "unix", which means the password is encrypted with the weak Unix crypt algorithm, or "md5" which means the password is encrypted with the BSD MD5 algorithm and has a $1$ prefix, or "sha256" which means the password is encrypted with the SHA256 algorithm and has a $5$ prefix, or "sha512" which means the password is encrypted with the SHA512 algorithm and has a $6$ prefix.

        Returns:
        Returns the value of the "crypt-password-storage-encryption-algorithm" property.

      • setCryptPasswordStorageEncryptionAlgorithm

        void setCryptPasswordStorageEncryptionAlgorithm​(CryptPasswordStorageSchemeCfgDefn.CryptPasswordStorageEncryptionAlgorithm value)
                                         throws PropertyException
        Sets the "crypt-password-storage-encryption-algorithm" property.

        Specifies the algorithm to use to encrypt new passwords.

        Select the crypt algorithm to use to encrypt new passwords. The value can either be "unix", which means the password is encrypted with the weak Unix crypt algorithm, or "md5" which means the password is encrypted with the BSD MD5 algorithm and has a $1$ prefix, or "sha256" which means the password is encrypted with the SHA256 algorithm and has a $5$ prefix, or "sha512" which means the password is encrypted with the SHA512 algorithm and has a $6$ prefix.

        Parameters:
        value - The value of the "crypt-password-storage-encryption-algorithm" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getJavaClass

        String getJavaClass()
        Gets the "java-class" property.

        Specifies the fully-qualified name of the Java class that provides the Crypt Password Storage Scheme implementation.

        Specified by:
        getJavaClass in interface PasswordStorageSchemeCfgClient
        Returns:
        Returns the value of the "java-class" property.

      • setJavaClass

        void setJavaClass​(String value)
           throws PropertyException
        Sets the "java-class" property.

        Specifies the fully-qualified name of the Java class that provides the Crypt Password Storage Scheme implementation.

        Specified by:
        setJavaClass in interface PasswordStorageSchemeCfgClient
        Parameters:
        value - The value of the "java-class" property.
        Throws:
        PropertyException - If the new value is invalid.