001/* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt 010 * or http://forgerock.org/license/CDDLv1.0.html. 011 * See the License for the specific language governing permissions 012 * and limitations under the License. 013 * 014 * When distributing Covered Code, include this CDDL HEADER in each 015 * file and include the License file at legal-notices/CDDLv1_0.txt. 016 * If applicable, add the following below this CDDL HEADER, with the 017 * fields enclosed by brackets "[]" replaced with your own identifying 018 * information: 019 * Portions Copyright [yyyy] [name of copyright owner] 020 * 021 * CDDL HEADER END 022 * 023 * 024 * Copyright 2008 Sun Microsystems, Inc. 025 */ 026package org.opends.server.admin.std.client; 027 028 029 030import org.opends.server.admin.ManagedObjectDefinition; 031import org.opends.server.admin.PropertyException; 032import org.opends.server.admin.std.meta.CryptPasswordStorageSchemeCfgDefn.CryptPasswordStorageEncryptionAlgorithm; 033import org.opends.server.admin.std.server.CryptPasswordStorageSchemeCfg; 034 035 036 037/** 038 * A client-side interface for reading and modifying Crypt Password 039 * Storage Scheme settings. 040 * <p> 041 * The Crypt Password Storage Scheme provides a mechanism for encoding 042 * user passwords like Unix crypt does. Like on most Unix systems, the 043 * password may be encrypted using different algorithms, either Unix 044 * crypt, md5, sha256 or sha512. 045 */ 046public interface CryptPasswordStorageSchemeCfgClient extends PasswordStorageSchemeCfgClient { 047 048 /** 049 * Get the configuration definition associated with this Crypt Password Storage Scheme. 050 * 051 * @return Returns the configuration definition associated with this Crypt Password Storage Scheme. 052 */ 053 ManagedObjectDefinition<? extends CryptPasswordStorageSchemeCfgClient, ? extends CryptPasswordStorageSchemeCfg> definition(); 054 055 056 057 /** 058 * Gets the "crypt-password-storage-encryption-algorithm" property. 059 * <p> 060 * Specifies the algorithm to use to encrypt new passwords. 061 * <p> 062 * Select the crypt algorithm to use to encrypt new passwords. The 063 * value can either be "unix", which means the password is encrypted 064 * with the weak Unix crypt algorithm, or "md5" which means the 065 * password is encrypted with the BSD MD5 algorithm and has a $1$ 066 * prefix, or "sha256" which means the password is encrypted with the 067 * SHA256 algorithm and has a $5$ prefix, or "sha512" which means the 068 * password is encrypted with the SHA512 algorithm and has a $6$ 069 * prefix. 070 * 071 * @return Returns the value of the "crypt-password-storage-encryption-algorithm" property. 072 */ 073 CryptPasswordStorageEncryptionAlgorithm getCryptPasswordStorageEncryptionAlgorithm(); 074 075 076 077 /** 078 * Sets the "crypt-password-storage-encryption-algorithm" property. 079 * <p> 080 * Specifies the algorithm to use to encrypt new passwords. 081 * <p> 082 * Select the crypt algorithm to use to encrypt new passwords. The 083 * value can either be "unix", which means the password is encrypted 084 * with the weak Unix crypt algorithm, or "md5" which means the 085 * password is encrypted with the BSD MD5 algorithm and has a $1$ 086 * prefix, or "sha256" which means the password is encrypted with the 087 * SHA256 algorithm and has a $5$ prefix, or "sha512" which means the 088 * password is encrypted with the SHA512 algorithm and has a $6$ 089 * prefix. 090 * 091 * @param value The value of the "crypt-password-storage-encryption-algorithm" property. 092 * @throws PropertyException 093 * If the new value is invalid. 094 */ 095 void setCryptPasswordStorageEncryptionAlgorithm(CryptPasswordStorageEncryptionAlgorithm value) throws PropertyException; 096 097 098 099 /** 100 * Gets the "java-class" property. 101 * <p> 102 * Specifies the fully-qualified name of the Java class that 103 * provides the Crypt Password Storage Scheme implementation. 104 * 105 * @return Returns the value of the "java-class" property. 106 */ 107 String getJavaClass(); 108 109 110 111 /** 112 * Sets the "java-class" property. 113 * <p> 114 * Specifies the fully-qualified name of the Java class that 115 * provides the Crypt Password Storage Scheme implementation. 116 * 117 * @param value The value of the "java-class" property. 118 * @throws PropertyException 119 * If the new value is invalid. 120 */ 121 void setJavaClass(String value) throws PropertyException; 122 123}