PasswordEncryptor.java

/*******************************************************************************
 * Copyright (c) 2012-2017 Codenvy, S.A.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Codenvy, S.A. - initial API and implementation
 *******************************************************************************/
package org.eclipse.che.security;

/**
 * Encrypts password in implementation specific way.
 *
 * @author Yevhenii Voevodin
 */
public interface PasswordEncryptor {

    /**
     * Encrypts the given {@code password}.
     *
     * @param password
     *         the plain password to be encrypted
     * @return the encrypted password
     * @throws NullPointerException
     *         when the password is null
     * @throws RuntimeException
     *         when any error occurs during password encryption
     */
    String encrypt(String password);

    /**
     * Tests whether given {@code password} is {@code encryptedPassword}.
     *
     * @param encryptedPassword
     *         encrypted password
     * @param password
     *         the password to check
     * @return true if given {@code password} is {@code encryptedPassword}
     * @throws NullPointerException
     *         when either of arguments is null
     * @throws RuntimeException
     *         when any error occurs during test
     */
    boolean test(String password, String encryptedPassword);
}