TwoWayPasswordEncoderInterface.java

/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2015 by Pentaho : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * 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.pentaho.di.core.encryption;

import org.pentaho.di.core.exception.KettleException;

public interface TwoWayPasswordEncoderInterface {

  /**
   * Initialize the password encoder by loading key details from the environment (kettle.properties or system settings).
   * @throws KettleException
   */
  public void init() throws KettleException;

  /**
   * Encode the raw password, include a prefix indicating the type of encryption used.
   * @param password The password to encode
   * @return The encoded password string
   */
  public String encode( String password );

  /**
   * Encode a password.
   * @param password The password to encode
   * @param includePrefix True if a prefix needs to be encoded
   * @return The encoded password string
   */
  public String encode( String password, boolean includePrefix );

  /**
   * Decode a password.
   * @param encodedPassword The encoded password with or without a prefix
   * @param optionallyEncrypted Set to true if the password is optionally encrypted (indicated by a prefix).
   * @return The decoded password string
   */
  public String decode( String encodedPassword, boolean optionallyEncrypted );

  /**
   * Decode a password which does NOT have a prefix attached.
   * @param encodedPassword The encoded password without a prefix
   * @return The decoded password string
   */
  public String decode( String encodedPassword );

  /**
   * @return The prefixes to the encoded passwords which this password encoder supports.
   */
  public String[] getPrefixes();
}