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





Common interface for all util classes aimed at password encryption.

Author:
Daniel Fernández
Since:
1.2/**
 * <p>
 * Common interface for all util classes aimed at password encryption.
 * </p>
 * 
 * @since 1.2
 * 
 * @author Daniel Fern&aacute;ndez
 * 
 */
public interface PasswordEncryptor {

    
    
Encrypts (digests) a password.
Params:
password – the password to be encrypted.
Returns:
the resulting digest./**
     * Encrypts (digests) a password.
     * 
     * @param password the password to be encrypted.
     * @return the resulting digest.
     */
    public String encryptPassword(String 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.
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.
     */
    public boolean checkPassword(String plainPassword, 
            String encryptedPassword);
    
}