org.apache.gobblin.password

Class PasswordManager

java.lang.Object

org.apache.gobblin.password.PasswordManager

public class PasswordManager
extends Object

A class for managing password encryption and decryption. To encrypt or decrypt a password, a master password should be provided which is used as encryption or decryption key. Encryption is done with the single key provided. Decryption is tried with multiple keys to facilitate key rotation. If the master key file provided is /var/tmp/masterKey.txt, decryption is tried with keys at /var/tmp/masterKey.txt, /var/tmp/masterKey.txt.1, /var/tmp/masterKey.txt.2, and so on and so forth till either any such file does not exist or this.NUMBER_OF_ENCRYPT_KEYS attempts have been made.

Method Summary

Modifier and Type	Method and Description
String	decryptPassword(String encrypted) Decrypt an encrypted password.
String	encryptPassword(String plain) Encrypt a password.
static PasswordManager	getInstance() Get an instance with no master password, which cannot encrypt or decrypt passwords.
static PasswordManager	getInstance(org.apache.hadoop.fs.Path masterPwdLoc) Get an instance.
static PasswordManager	getInstance(Properties props) Get an instance.
static PasswordManager	getInstance(State state) Get an instance.
static com.google.common.base.Optional<String>	getMasterPassword(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path masterPasswordFile)
static com.google.common.base.Optional<String>	getMasterPassword(org.apache.hadoop.fs.Path masterPasswordFile)
String	readPassword(String password) Decrypt a password if it is an encrypted password (in the form of ENC(.*)) and a master password file has been provided in the constructor.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static PasswordManager getInstance()

Get an instance with no master password, which cannot encrypt or decrypt passwords.

getInstance

public static PasswordManager getInstance(State state)

Get an instance. The location of the master password file is provided via "encrypt.key.loc".

getInstance

public static PasswordManager getInstance(Properties props)

Get an instance. The location of the master password file is provided via "encrypt.key.loc".

getInstance

public static PasswordManager getInstance(org.apache.hadoop.fs.Path masterPwdLoc)

Get an instance. The master password file is given by masterPwdLoc.

encryptPassword

public String encryptPassword(String plain)

Encrypt a password. A master password must have been provided in the constructor.

Parameters:

plain - A plain password to be encrypted.

Returns:

The encrypted password.

decryptPassword

public String decryptPassword(String encrypted)

Decrypt an encrypted password. A master password file must have been provided in the constructor.

Parameters:

encrypted - An encrypted password.

Returns:

The decrypted password.

readPassword

public String readPassword(String password)

Decrypt a password if it is an encrypted password (in the form of ENC(.*)) and a master password file has been provided in the constructor. Otherwise, return the password as is.

getMasterPassword

public static com.google.common.base.Optional<String> getMasterPassword(org.apache.hadoop.fs.Path masterPasswordFile)

getMasterPassword

public static com.google.common.base.Optional<String> getMasterPassword(org.apache.hadoop.fs.FileSystem fs,
                                                                        org.apache.hadoop.fs.Path masterPasswordFile)