org.pentaho.di.core.encryption

Class KettleTwoWayPasswordEncoder

java.lang.Object

org.pentaho.di.core.encryption.KettleTwoWayPasswordEncoder

All Implemented Interfaces:

TwoWayPasswordEncoderInterface

public class KettleTwoWayPasswordEncoder
extends Object
implements TwoWayPasswordEncoderInterface

This class handles basic encryption of passwords in Kettle. Note that it's not really encryption, it's more obfuscation. Passwords are difficult to read, not impossible.

Since:

17-12-2003

Author:

Matt

Field Summary

Fields

Modifier and Type	Field and Description
static String	PASSWORD_ENCRYPTED_PREFIX The word that is put before a password to indicate an encrypted form.

Constructor Summary

Constructors

Constructor and Description
KettleTwoWayPasswordEncoder()

Method Summary

Modifier and Type	Method and Description
String	decode(String encodedPassword) Decode a password which does NOT have a prefix attached.
String	decode(String encodedPassword, boolean optionallyEncrypted) Decode a password.
static String	decryptPassword(String encrypted) Deprecated.
protected String	decryptPasswordInternal(String encrypted)
static String	decryptPasswordOptionallyEncrypted(String password) Deprecated. - Use the instance method through Encr instead of this directly
protected String	decryptPasswordOptionallyEncryptedInternal(String password) Decrypts a password if it contains the prefix "Encrypted "
String	encode(String rawPassword) Encode the raw password, include a prefix indicating the type of encryption used.
String	encode(String rawPassword, boolean includePrefix) Encode a password.
static String	encryptPassword(String password) Deprecated. - use the instance method through Encr instead of this directly
static String	encryptPasswordIfNotUsingVariables(String password) Deprecated. - Use the instance method through Encr instead of this directly
protected String	encryptPasswordIfNotUsingVariablesInternal(String password) Encrypt the password, but only if the password doesn't contain any variables.
protected String	encryptPasswordInternal(String password)
String[]	getPrefixes()
protected String	getSeed()
void	init() Initialize the password encoder by loading key details from the environment (kettle.properties or system settings).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PASSWORD_ENCRYPTED_PREFIX

public static final String PASSWORD_ENCRYPTED_PREFIX

The word that is put before a password to indicate an encrypted form. If this word is not present, the password is considered to be NOT encrypted

See Also:

Constant Field Values

Constructor Detail

KettleTwoWayPasswordEncoder

public KettleTwoWayPasswordEncoder()

Method Detail

init

public void init()
          throws KettleException

Description copied from interface: TwoWayPasswordEncoderInterface

Initialize the password encoder by loading key details from the environment (kettle.properties or system settings).

Specified by:

init in interface TwoWayPasswordEncoderInterface

Throws:

KettleException

encode

public String encode(String rawPassword)

Description copied from interface: TwoWayPasswordEncoderInterface

Encode the raw password, include a prefix indicating the type of encryption used.

Specified by:

encode in interface TwoWayPasswordEncoderInterface

Parameters:

rawPassword - The password to encode

Returns:

The encoded password string

encode

public String encode(String rawPassword,
                     boolean includePrefix)

Description copied from interface: TwoWayPasswordEncoderInterface

Encode a password.

Specified by:

encode in interface TwoWayPasswordEncoderInterface

Parameters:

rawPassword - The password to encode

includePrefix - True if a prefix needs to be encoded

Returns:

The encoded password string

decode

public String decode(String encodedPassword)

Description copied from interface: TwoWayPasswordEncoderInterface

Decode a password which does NOT have a prefix attached.

Specified by:

decode in interface TwoWayPasswordEncoderInterface

Parameters:

encodedPassword - The encoded password without a prefix

Returns:

The decoded password string

decode

public String decode(String encodedPassword,
                     boolean optionallyEncrypted)

Description copied from interface: TwoWayPasswordEncoderInterface

Decode a password.

Specified by:

decode in interface TwoWayPasswordEncoderInterface

Parameters:

encodedPassword - The encoded password with or without a prefix

optionallyEncrypted - Set to true if the password is optionally encrypted (indicated by a prefix).

Returns:

The decoded password string

encryptPasswordInternal

protected String encryptPasswordInternal(String password)

decryptPasswordInternal

protected String decryptPasswordInternal(String encrypted)

getSeed

protected String getSeed()

getPrefixes

public String[] getPrefixes()

Specified by:

getPrefixes in interface TwoWayPasswordEncoderInterface

Returns:

The prefixes to the encoded passwords which this password encoder supports.

encryptPasswordIfNotUsingVariablesInternal

protected final String encryptPasswordIfNotUsingVariablesInternal(String password)

Encrypt the password, but only if the password doesn't contain any variables.

Parameters:

password - The password to encrypt

Returns:

The encrypted password or the

decryptPasswordOptionallyEncryptedInternal

protected final String decryptPasswordOptionallyEncryptedInternal(String password)

Decrypts a password if it contains the prefix "Encrypted "

Parameters:

password - The encrypted password

Returns:

The decrypted password or the original value if the password doesn't start with "Encrypted "

encryptPasswordIfNotUsingVariables

public static final String encryptPasswordIfNotUsingVariables(String password)

Deprecated. - Use the instance method through Encr instead of this directly

Encrypt the password, but only if the password doesn't contain any variables.

Parameters:

password - The password to encrypt

Returns:

The encrypted password or the

decryptPasswordOptionallyEncrypted

public static final String decryptPasswordOptionallyEncrypted(String password)

Deprecated. - Use the instance method through Encr instead of this directly

Decrypts a password if it contains the prefix "Encrypted "

Parameters:

password - The encrypted password

Returns:

The decrypted password or the original value if the password doesn't start with "Encrypted "

encryptPassword

public static final String encryptPassword(String password)

Deprecated. - use the instance method through Encr instead of this directly

Deprecared - use the instance method instead

Parameters:

password -

Returns:

encrypted password

decryptPassword

public static final String decryptPassword(String encrypted)

Deprecated.

Deprecated - use Encr instead of this directly

Parameters:

encrypted -

Returns:

decrypted password