org.jasypt.util.password.BasicPasswordEncryptor Maven / Gradle / Ivy

/*
 * =============================================================================
 * 
 *   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;

import org.jasypt.digest.StandardStringDigester;

/**
 * 
 * Utility class for easily performing password digesting and checking.
 * 
 * 
 * This class internally holds a {@link StandardStringDigester} 
 * configured this way:
 * 

 *   Algorithm: MD5.
 *   Salt size: 8 bytes.
 *   Iterations: 1000.
 * 
 * 
 * 
 * The required steps to use it are:
 * 

 *   Create an instance (using new).
 *   Perform the desired {@link #encryptPassword(String)} or 
 *       {@link #checkPassword(String, String)} 
 *       operations. 
 *  
 * 
 * 
 * This class is thread-safe
 * 
 * 
 * @since 1.2 (class existed as org.jasypt.util.PasswordEncryptor since 1.0)
 * 
 * @author Daniel Fernández
 * 
 */
public final class BasicPasswordEncryptor implements PasswordEncryptor {

    // The internal digester used
    private final StandardStringDigester digester;
    
    
    /**
     * Creates a new instance of BasicPasswordEncryptor
     *
     */
    public BasicPasswordEncryptor() {
        super();
        this.digester = new StandardStringDigester();
        this.digester.initialize();
    }
    
    
    /**
     * 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.
     * 
     * @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);
    }
    
}