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; 021 022 023 024/** 025 * A server-side interface for querying Bcrypt Password Storage Scheme 026 * settings. 027 * <p> 028 * The Bcrypt Password Storage Scheme provides a mechanism for 029 * encoding user passwords using the bcrypt message digest algorithm. 030 */ 031public interface BcryptPasswordStorageSchemeCfg extends PasswordStorageSchemeCfg { 032 033 /** 034 * Gets the configuration class associated with this Bcrypt Password Storage Scheme. 035 * 036 * @return Returns the configuration class associated with this Bcrypt Password Storage Scheme. 037 */ 038 Class<? extends BcryptPasswordStorageSchemeCfg> configurationClass(); 039 040 041 042 /** 043 * Register to be notified when this Bcrypt Password Storage Scheme is changed. 044 * 045 * @param listener 046 * The Bcrypt Password Storage Scheme configuration change listener. 047 */ 048 void addBcryptChangeListener(ConfigurationChangeListener<BcryptPasswordStorageSchemeCfg> listener); 049 050 051 052 /** 053 * Deregister an existing Bcrypt Password Storage Scheme configuration change listener. 054 * 055 * @param listener 056 * The Bcrypt Password Storage Scheme configuration change listener. 057 */ 058 void removeBcryptChangeListener(ConfigurationChangeListener<BcryptPasswordStorageSchemeCfg> listener); 059 060 061 062 /** 063 * Gets the "bcrypt-cost" property. 064 * <p> 065 * The cost parameter specifies a key expansion iteration count as a 066 * power of two. A default value of 12 (2^12 iterations) is 067 * considered in 2016 as a reasonable balance between responsiveness 068 * and security for regular users. 069 * 070 * @return Returns the value of the "bcrypt-cost" property. 071 */ 072 int getBcryptCost(); 073 074 075 076 /** 077 * Gets the "java-class" property. 078 * <p> 079 * Specifies the fully-qualified name of the Java class that 080 * provides the Bcrypt Password Storage Scheme implementation. 081 * 082 * @return Returns the value of the "java-class" property. 083 */ 084 String getJavaClass(); 085 086}