/*
* =============================================================================
*
* Copyright (c) 2007-2010, The JASYPT team (http://www.jasypt.org)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* =============================================================================
*/
package org.jasypt.util.password.rfc2307;
import org.jasypt.digest.StandardStringDigester;
import org.jasypt.util.password.PasswordEncryptor;
Utility class for easily performing password digesting and checking
according to {MD5}, a password encryption scheme defined in RFC2307
and commonly found in LDAP systems.
This class internally holds a StandardStringDigester
configured this way:
- Algorithm: MD5.
- Salt size: 0 bytes (no salt).
- Iterations: 1 (no hash iteration).
- Prefix: {MD5}.
This class is thread-safe
Author: Daniel Fernández Since: 1.7
/**
* <p>
* Utility class for easily performing password digesting and checking
* according to {MD5}, a password encryption scheme defined in RFC2307
* and commonly found in LDAP systems.
* </p>
* <p>
* This class internally holds a {@link StandardStringDigester}
* configured this way:
* <ul>
* <li>Algorithm: <tt>MD5</tt>.</li>
* <li>Salt size: <tt>0 bytes</tt> (no salt).</li>
* <li>Iterations: <tt>1</tt> (no hash iteration).</li>
* <li>Prefix: <tt>{MD5}</tt>.</li>
* </ul>
* </p>
* <p>
* This class is <i>thread-safe</i>
* </p>
*
* @since 1.7
*
* @author Daniel Fernández
*
*/
public final class RFC2307MD5PasswordEncryptor implements PasswordEncryptor {
// The internal digester used
private final StandardStringDigester digester;
Creates a new instance of RFC2307MD5PasswordEncryptor
/**
* Creates a new instance of <tt>RFC2307MD5PasswordEncryptor</tt>
*
*/
public RFC2307MD5PasswordEncryptor() {
super();
this.digester = new StandardStringDigester();
this.digester.setAlgorithm("MD5");
this.digester.setIterations(1);
this.digester.setSaltSizeBytes(0);
this.digester.setPrefix("{MD5}");
}
Sets the the form in which String output
will be encoded. Available encoding types are:
- base64 (default)
- hexadecimal
Params: - stringOutputType – the string output type.
/**
* <p>
* Sets the the form in which String output
* will be encoded. Available encoding types are:
* </p>
* <ul>
* <li><tt><b>base64</b></tt> (default)</li>
* <li><tt><b>hexadecimal</b></tt></li>
* </ul>
*
* @param stringOutputType the string output type.
*/
public void setStringOutputType(final String stringOutputType) {
this.digester.setStringOutputType(stringOutputType);
}
Encrypts (digests) a password.
Params: - password – the password to be encrypted.
See Also: Returns: the resulting digest.
/**
* Encrypts (digests) a password.
*
* @param password the password to be encrypted.
* @return the resulting digest.
* @see StandardStringDigester#digest(String)
*/
public String encryptPassword(final String password) {
return this.digester.digest(password);
}
Checks an unencrypted (plain) password against an encrypted one
(a digest) to see if they match.
Params: - plainPassword – the plain password to check.
- encryptedPassword – the digest against which to check the password.
See Also: Returns: true if passwords match, false if not.
/**
* Checks an unencrypted (plain) password against an encrypted one
* (a digest) to see if they match.
*
* @param plainPassword the plain password to check.
* @param encryptedPassword the digest against which to check the password.
* @return true if passwords match, false if not.
* @see StandardStringDigester#matches(String, String)
*/
public boolean checkPassword(final String plainPassword,
final String encryptedPassword) {
return this.digester.matches(plainPassword, encryptedPassword);
}
}