SaltedMD5PasswordStorageScheme.java revision 52674c7996797d28e6671590293a44c1e5f93017
/*
* 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-2008 Sun Microsystems, Inc.
* Portions Copyright 2013-2015 ForgeRock AS
*/
/**
* This class defines a Directory Server password storage scheme based on the
* MD5 algorithm defined in RFC 1321. 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 MD5 hash is then generated based on this, the salt is
* appended to the hash, and then the entire value is base64-encoded.
*/
public class SaltedMD5PasswordStorageScheme
{
/**
* The fully-qualified name of this class.
*/
private static final String CLASS_NAME =
"org.opends.server.extensions.SaltedMD5PasswordStorageScheme";
/**
* 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 MD5 algorithm produces. */
private static final int MD5_LENGTH = 16;
/** The message digest that will actually be used to generate the MD5 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 SaltedMD5PasswordStorageScheme()
{
super();
}
/** {@inheritDoc} */
public void initializePasswordStorageScheme(
{
try
{
}
catch (Exception e)
{
logger.traceException(e);
LocalizableMessage message = ERR_PWSCHEME_CANNOT_INITIALIZE_MESSAGE_DIGEST.get(MESSAGE_DIGEST_ALGORITHM_MD5, e);
throw new InitializationException(message, e);
}
digestLock = new Object();
}
/** {@inheritDoc} */
public String getStorageSchemeName()
{
return STORAGE_SCHEME_NAME_SALTED_MD5;
}
/** {@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 = new byte[NUM_SALT_BYTES];
byte[] digestBytes = new byte[MD5_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()
{
// MD5 may be considered reasonably secure for this purpose.
return true;
}
}