001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 */
016package org.forgerock.opendj.server.config.server;
017
018
019
020import org.forgerock.opendj.config.server.ConfigurationChangeListener;
021import org.forgerock.opendj.server.config.meta.CryptPasswordStorageSchemeCfgDefn.CryptPasswordStorageEncryptionAlgorithm;
022
023
024
025/**
026 * A server-side interface for querying Crypt Password Storage Scheme
027 * settings.
028 * <p>
029 * The Crypt Password Storage Scheme provides a mechanism for encoding
030 * user passwords like Unix crypt does. Like on most Unix systems, the
031 * password may be encrypted using different algorithms, either Unix
032 * crypt, md5, sha256 or sha512.
033 */
034public interface CryptPasswordStorageSchemeCfg extends PasswordStorageSchemeCfg {
035
036  /**
037   * Gets the configuration class associated with this Crypt Password Storage Scheme.
038   *
039   * @return Returns the configuration class associated with this Crypt Password Storage Scheme.
040   */
041  Class<? extends CryptPasswordStorageSchemeCfg> configurationClass();
042
043
044
045  /**
046   * Register to be notified when this Crypt Password Storage Scheme is changed.
047   *
048   * @param listener
049   *          The Crypt Password Storage Scheme configuration change listener.
050   */
051  void addCryptChangeListener(ConfigurationChangeListener<CryptPasswordStorageSchemeCfg> listener);
052
053
054
055  /**
056   * Deregister an existing Crypt Password Storage Scheme configuration change listener.
057   *
058   * @param listener
059   *          The Crypt Password Storage Scheme configuration change listener.
060   */
061  void removeCryptChangeListener(ConfigurationChangeListener<CryptPasswordStorageSchemeCfg> listener);
062
063
064
065  /**
066   * Gets the "crypt-password-storage-encryption-algorithm" property.
067   * <p>
068   * Specifies the algorithm to use to encrypt new passwords.
069   * <p>
070   * Select the crypt algorithm to use to encrypt new passwords. The
071   * value can either be "unix", which means the password is encrypted
072   * with the weak Unix crypt algorithm, or "md5" which means the
073   * password is encrypted with the BSD MD5 algorithm and has a $1$
074   * prefix, or "sha256" which means the password is encrypted with the
075   * SHA256 algorithm and has a $5$ prefix, or "sha512" which means the
076   * password is encrypted with the SHA512 algorithm and has a $6$
077   * prefix.
078   *
079   * @return Returns the value of the "crypt-password-storage-encryption-algorithm" property.
080   */
081  CryptPasswordStorageEncryptionAlgorithm getCryptPasswordStorageEncryptionAlgorithm();
082
083
084
085  /**
086   * Gets the "java-class" property.
087   * <p>
088   * Specifies the fully-qualified name of the Java class that
089   * provides the Crypt Password Storage Scheme implementation.
090   *
091   * @return Returns the value of the "java-class" property.
092   */
093  String getJavaClass();
094
095}