SaltedSHA1PasswordStorageScheme.java revision ea1068c292e9b341af6d6b563cd8988a96be20a9
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2006-2010 Sun Microsystems, Inc.
* Portions Copyright 2010-2015 ForgeRock AS.
*/
/**
* This class defines a Directory Server password storage scheme based on the
* SHA-1 algorithm defined in FIPS 180-1. This is a one-way digest algorithm
* so there is no way to retrieve the original clear-text version of the
* password from the hashed value (although this means that it is not suitable
* for things that need the clear-text password like DIGEST-MD5). The values
* that it generates are also salted, which protects against dictionary attacks.
* It does this by generating a 64-bit random salt which is appended to the
* clear-text value. A SHA-1 hash is then generated based on this, the salt is
* appended to the hash, and then the entire value is base64-encoded.
*/
public class SaltedSHA1PasswordStorageScheme
{
/**
* The fully-qualified name of this class.
*/
private static final String CLASS_NAME =
"org.opends.server.extensions.SaltedSHA1PasswordStorageScheme";
/**
* The number of bytes of random data to use as the salt when generating the
* hashes.
*/
private static final int NUM_SALT_BYTES = 8;
// The number of bytes SHA algorithm produces
private static final int SHA1_LENGTH = 20;
// The message digest that will actually be used to generate the SHA-1 hashes.
private MessageDigest messageDigest;
// The lock used to provide threadsafe access to the message digest.
private Object digestLock;
// The secure random number generator to use to generate the salt values.
/**
* Creates a new instance of this password storage scheme. Note that no
* initialization should be performed here, as all initialization should be
* done in the <CODE>initializePasswordStorageScheme</CODE> method.
*/
public SaltedSHA1PasswordStorageScheme()
{
super();
}
/**
* {@inheritDoc}
*/
public void initializePasswordStorageScheme(
{
try
{
}
catch (Exception e)
{
logger.traceException(e);
LocalizableMessage message = ERR_PWSCHEME_CANNOT_INITIALIZE_MESSAGE_DIGEST.get(MESSAGE_DIGEST_ALGORITHM_SHA_1, e);
throw new InitializationException(message, e);
}
digestLock = new Object();
}
/**
* {@inheritDoc}
*/
public String getStorageSchemeName()
{
return STORAGE_SCHEME_NAME_SALTED_SHA_1;
}
/**
* {@inheritDoc}
*/
throws DirectoryException
{
byte[] saltBytes = new byte[NUM_SALT_BYTES];
byte[] digestBytes;
synchronized (digestLock)
{
try
{
// Generate the salt and put in the plain+salt array.
// Create the hash from the concatenated value.
}
catch (Exception e)
{
logger.traceException(e);
message, e);
}
finally
{
}
}
// Append the salt to the hashed value and base64-the whole thing.
}
/**
* {@inheritDoc}
*/
throws DirectoryException
{
byte[] saltBytes = new byte[NUM_SALT_BYTES];
byte[] digestBytes;
synchronized (digestLock)
{
try
{
// Generate the salt and put in the plain+salt array.
// Create the hash from the concatenated value.
}
catch (Exception e)
{
logger.traceException(e);
message, e);
}
finally
{
}
}
// Append the salt to the hashed value and base64-the whole thing.
}
/**
* {@inheritDoc}
*/
{
// Base64-decode the stored value and take the last 8 bytes as the salt.
byte[] saltBytes;
byte[] digestBytes = new byte[SHA1_LENGTH];
int saltLength = 0;
try
{
if (saltLength <= 0)
{
return false;
}
saltBytes = new byte[saltLength];
}
catch (Exception e)
{
logger.traceException(e);
return false;
}
// Use the salt to generate a digest based on the provided plain-text value.
byte[] userDigestBytes;
synchronized (digestLock)
{
try
{
}
catch (Exception e)
{
logger.traceException(e);
return false;
}
finally
{
}
}
}
/**
* {@inheritDoc}
*/
public boolean supportsAuthPasswordSyntax()
{
// This storage scheme does support the authentication password syntax.
return true;
}
/**
* {@inheritDoc}
*/
public String getAuthPasswordSchemeName()
{
}
/**
* {@inheritDoc}
*/
throws DirectoryException
{
byte[] saltBytes = new byte[NUM_SALT_BYTES];
byte[] digestBytes;
synchronized (digestLock)
{
try
{
// Generate the salt and put in the plain+salt array.
// Create the hash from the concatenated value.
}
catch (Exception e)
{
logger.traceException(e);
message, e);
}
finally
{
}
}
// Encode and return the value.
}
/**
* {@inheritDoc}
*/
{
byte[] saltBytes;
byte[] digestBytes;
try
{
}
catch (Exception e)
{
logger.traceException(e);
return false;
}
synchronized (digestLock)
{
try
{
}
finally
{
}
}
}
/**
* {@inheritDoc}
*/
public boolean isReversible()
{
return false;
}
/**
* {@inheritDoc}
*/
throws DirectoryException
{
}
/**
* {@inheritDoc}
*/
throws DirectoryException
{
}
/**
* {@inheritDoc}
*/
public boolean isStorageSchemeSecure()
{
// SHA-1 should be considered secure.
return true;
}
/**
* Generates an encoded password string from the given clear-text password.
* This method is primarily intended for use when it is necessary to generate
* a password with the server offline (e.g., when setting the initial root
* user password).
*
* @param passwordBytes The bytes that make up the clear-text password.
*
* @return The encoded password string, including the scheme name in curly
* braces.
*
* @throws DirectoryException If a problem occurs during processing.
*/
throws DirectoryException
{
byte[] saltBytes = new byte[NUM_SALT_BYTES];
try
{
}
catch (Exception e)
{
}
}
}