org.apache.ambari.server.security.encryption

Interface EncryptionService

All Known Implementing Classes:

AESEncryptionService

public interface EncryptionService

This interface provides useful methods to encrypt/decrypt sensitive information. As of now the underlying implementation uses AES encryption which may be changed in the future (or you will have the option to plugin your own security algorithm). Text encoding takes places during encryption thus decryption starts with text decoding of the same encoding type. Currently the following text encoding types are supported:

• BASE_64 (default)
• BinHex

See Also:

TextEncoding

Method Summary

Modifier and Type	Method and Description
String	decrypt(String toBeDecrypted) Decrypts the given text (must be encoded with BASE_64 encoding) using Ambari's master key found in the environment.
String	decrypt(String toBeDecrypted, String key) Decrypts the given text (must be encoded with BASE_64 encoding) using the given key.
String	decrypt(String toBeDecrypted, String key, TextEncoding textEncoding) Decrypts the given text (must be encoded with the given text encoding) using the given key.
String	decrypt(String toBeDecrypted, TextEncoding textEncoding) Decrypts the given text (must be encoded with the given text encoding) using Ambari's master key found in the environment.
String	encrypt(String toBeEncrypted) Encrypts the given text using Ambari's master key found in the environment.
String	encrypt(String toBeEncrypted, String key) Encrypts the given text using the given key.
String	encrypt(String toBeEncrypted, String key, TextEncoding textEncoding) Encrypts the given text using the given key.The returned value will be encoded with the given text encoding.
String	encrypt(String toBeEncrypted, TextEncoding textEncoding) Encrypts the given text using Ambari's master key found in the environment.
String	getAmbariMasterKey()

Method Detail

encrypt

String encrypt(String toBeEncrypted)

Encrypts the given text using Ambari's master key found in the environment. The returned value will be encoded with BASE_64 encoding.

Parameters:

toBeEncrypted - the text to be encrypted

Returns:

the String representation of the encrypted text

Throws:

Exception - in case any error happened during the encryption process

encrypt

String encrypt(String toBeEncrypted,
               TextEncoding textEncoding)

Encrypts the given text using Ambari's master key found in the environment. The returned value will be encoded with the given text encoding.

Parameters:

toBeEncrypted - the text to be encrypted

textEncoding - the text encoding which the encrypted text is encoded with

Returns:

the String representation of the encrypted text

encrypt

String encrypt(String toBeEncrypted,
               String key)

Encrypts the given text using the given key. The returned value will be encoded with BASE_64 encoding.

Parameters:

toBeEncrypted - the text to be encrypted

key - the key to be used for encryption

Returns:

the String representation of the encrypted text in case any error happened during the encryption process

encrypt

String encrypt(String toBeEncrypted,
               String key,
               TextEncoding textEncoding)

Encrypts the given text using the given key.The returned value will be encoded with the given text encoding.

Parameters:

toBeEncrypted - the text to be encrypted

key - the key to be used for encryption

textEncoding - the text encoding which the encrypted text is encoded with

Returns:

the String representation of the encrypted text

getAmbariMasterKey

String getAmbariMasterKey()

Returns:

the default encryption key used by this encryption service

decrypt

String decrypt(String toBeDecrypted)

Decrypts the given text (must be encoded with BASE_64 encoding) using Ambari's master key found in the environment.

Parameters:

toBeDecrypted - the text to be decrypted

Returns:

the String representation of the decrypted text

decrypt

String decrypt(String toBeDecrypted,
               TextEncoding textEncoding)

Decrypts the given text (must be encoded with the given text encoding) using Ambari's master key found in the environment.

Parameters:

toBeDecrypted - the text to be decrypted

textEncoding - the text encoding which toBeDecrypted is encoded with

Returns:

the String representation of the decrypted text

decrypt

String decrypt(String toBeDecrypted,
               String key)

Decrypts the given text (must be encoded with BASE_64 encoding) using the given key.

Parameters:

toBeDecrypted - the text to be decrypted

key - the key to be used for decryption

Returns:

the String representation of the decrypted text

decrypt

String decrypt(String toBeDecrypted,
               String key,
               TextEncoding textEncoding)

Decrypts the given text (must be encoded with the given text encoding) using the given key.

Parameters:

toBeDecrypted - the text to be decrypted

key - the key to be used for decryption

textEncoding - the text encoding which toBeDecrypted is encoded with

Returns:

the String representation of the decrypted text