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

Interface CryptoManagerCfg

  • All Superinterfaces:
    Configuration
    public interface CryptoManagerCfg
extends Configuration
    A server-side interface for querying Crypto Manager settings.

    The Crypto Manager provides a common interface for performing compression, decompression, hashing, encryption and other kinds of cryptographic operations.

    • Method Detail

      • configurationClass

        Class<? extends CryptoManagerCfg> configurationClass()
        Gets the configuration class associated with this Crypto Manager.
        Specified by:
        configurationClass in interface Configuration
        Returns:
        Returns the configuration class associated with this Crypto Manager.

      • addChangeListener

        void addChangeListener​(ConfigurationChangeListener<CryptoManagerCfg> listener)
        Register to be notified when this Crypto Manager is changed.
        Parameters:
        listener - The Crypto Manager configuration change listener.

      • removeChangeListener

        void removeChangeListener​(ConfigurationChangeListener<CryptoManagerCfg> listener)
        Deregister an existing Crypto Manager configuration change listener.
        Parameters:
        listener - The Crypto Manager configuration change listener.

      • getCipherKeyLength

        int getCipherKeyLength()
        Gets the "cipher-key-length" property.

        Specifies the key length in bits for the preferred cipher.

        Returns:
        Returns the value of the "cipher-key-length" property.

      • getCipherTransformation

        String getCipherTransformation()
        Gets the "cipher-transformation" property.

        Specifies the cipher for the directory server using the syntax algorithm/mode/padding.

        The full transformation is required: specifying only an algorithm and allowing the cipher provider to supply the default mode and padding is not supported, because there is no guarantee these default values are the same among different implementations. Some cipher algorithms, including RC4 and ARCFOUR, do not have a mode or padding, and hence must be specified using NONE for the mode field and NoPadding for the padding field. For example, RC4/NONE/NoPadding.

        Returns:
        Returns the value of the "cipher-transformation" property.

      • getDigestAlgorithm

        String getDigestAlgorithm()
        Gets the "digest-algorithm" property.

        Specifies the preferred message digest algorithm for the directory server.

        Returns:
        Returns the value of the "digest-algorithm" property.

      • getKeyWrappingTransformation

        String getKeyWrappingTransformation()
        Gets the "key-wrapping-transformation" property.

        The preferred key wrapping transformation for the directory server. This value must be the same for all server instances in a replication topology.

        Returns:
        Returns the value of the "key-wrapping-transformation" property.

      • getMacAlgorithm

        String getMacAlgorithm()
        Gets the "mac-algorithm" property.

        Specifies the preferred MAC algorithm for the directory server.

        Returns:
        Returns the value of the "mac-algorithm" property.

      • getMacKeyLength

        int getMacKeyLength()
        Gets the "mac-key-length" property.

        Specifies the key length in bits for the preferred MAC algorithm.

        Returns:
        Returns the value of the "mac-key-length" property.

      • getSSLCertNickname

        SortedSet<String> getSSLCertNickname()
        Gets the "ssl-cert-nickname" property.

        Specifies the nicknames (also called the aliases) of the keys or key pairs that the Crypto Manager should use when performing SSL communication. The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key.

        This is only applicable when the Crypto Manager is configured to use SSL.

        Returns:
        Returns an unmodifiable set containing the values of the "ssl-cert-nickname" property.

      • getSSLCipherSuite

        SortedSet<String> getSSLCipherSuite()
        Gets the "ssl-cipher-suite" property.

        Specifies the names of the SSL cipher suites that are allowed for use in SSL or TLS communication.

        Returns:
        Returns an unmodifiable set containing the values of the "ssl-cipher-suite" property.

      • isSSLEncryption

        boolean isSSLEncryption()
        Gets the "ssl-encryption" property.

        Specifies whether SSL/TLS is used to provide encrypted communication between two OpenDJ server components.

        Returns:
        Returns the value of the "ssl-encryption" property.

      • getSSLProtocol

        SortedSet<String> getSSLProtocol()
        Gets the "ssl-protocol" property.

        Specifies the names of the SSL protocols that are allowed for use in SSL or TLS communication.

        Returns:
        Returns an unmodifiable set containing the values of the "ssl-protocol" property.