PKCS5S2PasswordStorageScheme.java revision 423f6a91805232d2116622864305b5eb129058bc
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * CDDL HEADER START
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * The contents of this file are subject to the terms of the
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * Common Development and Distribution License, Version 1.0 only
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * (the "License"). You may not use this file except in compliance
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * with the License.
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * or http://forgerock.org/license/CDDLv1.0.html.
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * See the License for the specific language governing permissions
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * and limitations under the License.
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * When distributing Covered Code, include this CDDL HEADER in each
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * file and include the License file at legal-notices/CDDLv1_0.txt.
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * If applicable, add the following below this CDDL HEADER, with the
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * fields enclosed by brackets "[]" replaced with your own identifying
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * information:
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * Portions Copyright [yyyy] [name of copyright owner]
3b653205cf7bd3851befd0a9f6a3ded6e267c173Lennart Poettering * CDDL HEADER END
07630cea1f3a845c09309f197ac7c4f11edd3b62Lennart Poettering * Copyright 2014-2015 ForgeRock AS.
07630cea1f3a845c09309f197ac7c4f11edd3b62Lennart Poettering * Portions Copyright Emidio Stani & Andrea Stani
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalierimport java.security.NoSuchAlgorithmException;
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalierimport org.forgerock.i18n.LocalizableMessage;
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalierimport org.forgerock.i18n.slf4j.LocalizedLogger;
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalierimport org.forgerock.opendj.ldap.ByteSequence;
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalierimport org.opends.server.admin.std.server.PKCS5S2PasswordStorageSchemeCfg;
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalierimport org.opends.server.api.PasswordStorageScheme;
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalierimport org.opends.server.core.DirectoryServer;
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalierimport org.opends.server.types.DirectoryException;
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalierimport org.opends.server.types.InitializationException;
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalierimport static org.opends.messages.ExtensionMessages.*;
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalierimport static org.opends.server.extensions.ExtensionsConstants.*;
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalierimport static org.opends.server.util.StaticUtils.*;
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * This class defines a Directory Server password storage scheme based on the
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * Atlassian PBKF2-base hash algorithm. This is a one-way digest algorithm
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * so there is no way to retrieve the original clear-text version of the
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * password from the hashed value (although this means that it is not suitable
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * for things that need the clear-text password like DIGEST-MD5). Unlike
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * the other PBKF2-base scheme, this implementation uses a fixed number of
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * iterations.
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier extends PasswordStorageScheme<PKCS5S2PasswordStorageSchemeCfg>
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier /** The fully-qualified name of this class. */
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier private static final String CLASS_NAME = "org.opends.server.extensions.PKCS5S2PasswordStorageScheme";
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier /** The number of bytes of random data to use as the salt when generating the hashes. */
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier private static final int NUM_SALT_BYTES = 16;
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier /** The number of bytes the SHA-1 algorithm produces. */
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier /** Atlassian hardcoded the number of iterations to 10000. */
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier private static final int iterations = 10000;
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier /** The secure random number generator to use to generate the salt values. */
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * Creates a new instance of this password storage scheme. Note that no
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * initialization should be performed here, as all initialization should be
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier * done in the <CODE>initializePasswordStorageScheme</CODE> method.
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier /** {@inheritDoc} */
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier public void initializePasswordStorageScheme(PKCS5S2PasswordStorageSchemeCfg configuration)
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier random = SecureRandom.getInstance(SECURE_PRNG_SHA1);
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier // Just try to verify if the algorithm is supported
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier SecretKeyFactory.getInstance(MESSAGE_DIGEST_ALGORITHM_PBKDF2);
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier /** {@inheritDoc} */
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier /** {@inheritDoc} */
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier public ByteString encodePassword(ByteSequence plaintext)
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier byte[] saltBytes = new byte[NUM_SALT_BYTES];
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier byte[] digestBytes = encodeWithRandomSalt(plaintext, saltBytes,random);
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier byte[] hashPlusSalt = concatenateSaltPlusHash(saltBytes, digestBytes);
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier return ByteString.valueOf(Base64.encode(hashPlusSalt));
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier /** {@inheritDoc} */
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier public ByteString encodePasswordWithScheme(ByteSequence plaintext)
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier return ByteString.valueOf('{' + STORAGE_SCHEME_NAME_PKCS5S2 + '}' + encodePassword(plaintext));
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier /** {@inheritDoc} */
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier public boolean passwordMatches(ByteSequence plaintextPassword, ByteSequence storedPassword)
c182135d3af7a662739d16353e3cc630199aac24Ronny Chevalier // Base64-decode the value and take the first 16 bytes as the salt.
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier byte[] decodedBytes = Base64.decode(stored);
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier if (decodedBytes.length != NUM_SALT_BYTES + SHA1_LENGTH)
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier logger.error(ERR_PWSCHEME_INVALID_BASE64_DECODED_STORED_PASSWORD.get(storedPassword.toString()));
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier return false;
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier final byte[] digestBytes = new byte[SHA1_LENGTH];
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier final byte[] saltBytes = new byte[saltLength];
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier System.arraycopy(decodedBytes, 0, saltBytes, 0, saltLength);
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier System.arraycopy(decodedBytes, saltLength, digestBytes, 0, SHA1_LENGTH);
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier return encodeAndMatch(plaintextPassword, saltBytes, digestBytes, iterations);
e76398868a154258c3620be2bdecdd9fa7cdf093Daniel Mack logger.error(ERR_PWSCHEME_CANNOT_BASE64_DECODE_STORED_PASSWORD.get(storedPassword.toString(), String.valueOf(e)));
e76398868a154258c3620be2bdecdd9fa7cdf093Daniel Mack return false;
e76398868a154258c3620be2bdecdd9fa7cdf093Daniel Mack /** {@inheritDoc} */
e76398868a154258c3620be2bdecdd9fa7cdf093Daniel Mack return true;
e76398868a154258c3620be2bdecdd9fa7cdf093Daniel Mack /** {@inheritDoc} */
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering public String getAuthPasswordSchemeName()
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering return AUTH_PASSWORD_SCHEME_NAME_PKCS5S2;
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering /** {@inheritDoc} */
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering public ByteString encodeAuthPassword(ByteSequence plaintext)
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering byte[] saltBytes = new byte[NUM_SALT_BYTES];
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering byte[] digestBytes = encodeWithRandomSalt(plaintext, saltBytes,random);
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering // Encode and return the value.
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering return ByteString.valueOf(AUTH_PASSWORD_SCHEME_NAME_PKCS5S2 + '$' + iterations
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering + ':' + Base64.encode(saltBytes) + '$' + Base64.encode(digestBytes));
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering /** {@inheritDoc} */
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering public boolean authPasswordMatches(ByteSequence plaintextPassword, String authInfo, String authValue)
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering int iterations = Integer.parseInt(authInfo.substring(0, pos));
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering byte[] saltBytes = Base64.decode(authInfo.substring(pos + 1));
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering byte[] digestBytes = Base64.decode(authValue);
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering return encodeAndMatch(plaintextPassword, saltBytes, digestBytes, iterations);
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering /** {@inheritDoc} */
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering public boolean isReversible()
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering /** {@inheritDoc} */
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering public ByteString getPlaintextValue(ByteSequence storedPassword)
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering LocalizableMessage message = ERR_PWSCHEME_NOT_REVERSIBLE.get(STORAGE_SCHEME_NAME_PKCS5S2);
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering throw new DirectoryException(ResultCode.CONSTRAINT_VIOLATION, message);
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering /** {@inheritDoc} */
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering public ByteString getAuthPasswordPlaintextValue(String authInfo, String authValue)
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering LocalizableMessage message = ERR_PWSCHEME_NOT_REVERSIBLE.get(AUTH_PASSWORD_SCHEME_NAME_PKCS5S2);
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering throw new DirectoryException(ResultCode.CONSTRAINT_VIOLATION, message);
059f6c42b744a18d0deec0c79a9e0730ec6c1c76Lennart Poettering /** {@inheritDoc} */
07916bea0708715bf9cc4c3d9010f2397dd1d62aRonny Chevalier * Generates an encoded password string from the given clear-text password.
07916bea0708715bf9cc4c3d9010f2397dd1d62aRonny Chevalier * This method is primarily intended for use when it is necessary to generate a password with the server
07916bea0708715bf9cc4c3d9010f2397dd1d62aRonny Chevalier * offline (e.g., when setting the initial root user password).
07916bea0708715bf9cc4c3d9010f2397dd1d62aRonny Chevalier * @param passwordBytes The bytes that make up the clear-text password.
07916bea0708715bf9cc4c3d9010f2397dd1d62aRonny Chevalier * @return The encoded password string, including the scheme name in curly braces.
07916bea0708715bf9cc4c3d9010f2397dd1d62aRonny Chevalier * @throws DirectoryException If a problem occurs during processing.
07916bea0708715bf9cc4c3d9010f2397dd1d62aRonny Chevalier public static String encodeOffline(byte[] passwordBytes)
07916bea0708715bf9cc4c3d9010f2397dd1d62aRonny Chevalier byte[] saltBytes = new byte[NUM_SALT_BYTES];
07916bea0708715bf9cc4c3d9010f2397dd1d62aRonny Chevalier byte[] digestBytes = encodeWithRandomSalt(ByteString.wrap(passwordBytes), saltBytes);
07916bea0708715bf9cc4c3d9010f2397dd1d62aRonny Chevalier byte[] hashPlusSalt = concatenateSaltPlusHash(saltBytes, digestBytes);
07916bea0708715bf9cc4c3d9010f2397dd1d62aRonny Chevalier return '{' + STORAGE_SCHEME_NAME_PKCS5S2 + '}' + Base64.encode(hashPlusSalt);
b31f535c9a7af9b5f5c4f5d4e52be9159af72127Zbigniew Jędrzejewski-Szmek private static byte[] encodeWithRandomSalt(ByteString plaintext, byte[] saltBytes)
b31f535c9a7af9b5f5c4f5d4e52be9159af72127Zbigniew Jędrzejewski-Szmek final SecureRandom random = SecureRandom.getInstance(SECURE_PRNG_SHA1);
b31f535c9a7af9b5f5c4f5d4e52be9159af72127Zbigniew Jędrzejewski-Szmek return encodeWithRandomSalt(plaintext, saltBytes, random);
b31f535c9a7af9b5f5c4f5d4e52be9159af72127Zbigniew Jędrzejewski-Szmek private static byte[] encodeWithSalt(ByteSequence plaintext, byte[] saltBytes, int iterations)
b31f535c9a7af9b5f5c4f5d4e52be9159af72127Zbigniew Jędrzejewski-Szmek final char[] plaintextChars = plaintext.toString().toCharArray();
eda8090ba9abc7d00f30e2b4cb34273cde799704Thomas Hindoe Paaboel Andersen final SecretKeyFactory factory = SecretKeyFactory.getInstance(MESSAGE_DIGEST_ALGORITHM_PBKDF2);
da927ba997d68401563b927f92e6e40e021a8e5cMichal Schmidt KeySpec spec = new PBEKeySpec(plaintextChars, saltBytes, iterations, SHA1_LENGTH * 8);
b31f535c9a7af9b5f5c4f5d4e52be9159af72127Zbigniew Jędrzejewski-Szmek return factory.generateSecret(spec).getEncoded();
bdf7026e9557349cd3eeb291c01655d5f2a55db8Thomas Hindoe Paaboel Andersen throw cannotEncodePassword(e);
b31f535c9a7af9b5f5c4f5d4e52be9159af72127Zbigniew Jędrzejewski-Szmek Arrays.fill(plaintextChars, '0');
b31f535c9a7af9b5f5c4f5d4e52be9159af72127Zbigniew Jędrzejewski-Szmek private boolean encodeAndMatch(ByteSequence plaintext, byte[] saltBytes, byte[] digestBytes, int iterations)
b31f535c9a7af9b5f5c4f5d4e52be9159af72127Zbigniew Jędrzejewski-Szmek final byte[] userDigestBytes = encodeWithSalt(plaintext, saltBytes, iterations);
bdf7026e9557349cd3eeb291c01655d5f2a55db8Thomas Hindoe Paaboel Andersen return Arrays.equals(digestBytes, userDigestBytes);
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier private static byte[] encodeWithRandomSalt(ByteSequence plaintext, byte[] saltBytes, SecureRandom random)
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier return encodeWithSalt(plaintext, saltBytes, iterations);
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier private static DirectoryException cannotEncodePassword(Exception e)
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier LocalizableMessage message = ERR_PWSCHEME_CANNOT_ENCODE_PASSWORD.get(CLASS_NAME, getExceptionMessage(e));
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier return new DirectoryException(DirectoryServer.getServerErrorResultCode(), message, e);
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier private static byte[] concatenateSaltPlusHash(byte[] saltBytes, byte[] digestBytes) {
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier final byte[] hashPlusSalt = new byte[digestBytes.length + NUM_SALT_BYTES];
43dc004336ae0c99cac45df20e32dc7aa2e7cd0cRonny Chevalier System.arraycopy(saltBytes, 0, hashPlusSalt, 0, NUM_SALT_BYTES);