org.apache.hadoop.hbase.io.crypto.aes

Class AES

java.lang.Object

org.apache.hadoop.hbase.io.crypto.Cipher

org.apache.hadoop.hbase.io.crypto.aes.AES

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public class AES
extends Cipher

AES-128, provided by the JCE

Algorithm instances are pooled for reuse, so the cipher provider and mode are configurable but fixed at instantiation.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLOCK_SIZE
static java.lang.String	CIPHER_MODE_KEY
static java.lang.String	CIPHER_PROVIDER_KEY
static int	IV_LENGTH
static int	KEY_LENGTH
static int	KEY_LENGTH_BITS
static java.lang.String	RNG_ALGORITHM_KEY
static java.lang.String	RNG_PROVIDER_KEY

Constructor Summary

Constructors

Constructor and Description
AES(CipherProvider provider)

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	createDecryptionStream(java.io.InputStream in, Context context, byte[] iv) Create a decrypting input stream given a context and IV
java.io.InputStream	createDecryptionStream(java.io.InputStream in, Decryptor d) Create a decrypting output stream given an initialized decryptor
java.io.OutputStream	createEncryptionStream(java.io.OutputStream out, Context context, byte[] iv) Create an encrypting output stream given a context and IV
java.io.OutputStream	createEncryptionStream(java.io.OutputStream out, Encryptor e) Create an encrypting output stream given an initialized encryptor
Decryptor	getDecryptor() Return a decryptor for decrypting data.
Encryptor	getEncryptor() Get an encryptor for encrypting data.
int	getIvLength() Return the expected initialization vector length, in bytes, or 0 if not applicable
int	getKeyLength() Return the key length required by this cipher, in bytes
java.lang.String	getName() Return this Cipher's name
java.security.Key	getRandomKey() Create a random symmetric key

Methods inherited from class org.apache.hadoop.hbase.io.crypto.Cipher

getProvider

Methods inherited from class java.lang.Object

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

Field Detail

KEY_LENGTH

public static final int KEY_LENGTH

See Also:

Constant Field Values

KEY_LENGTH_BITS

public static final int KEY_LENGTH_BITS

See Also:

Constant Field Values

BLOCK_SIZE

public static final int BLOCK_SIZE

See Also:

Constant Field Values

IV_LENGTH

public static final int IV_LENGTH

See Also:

Constant Field Values

CIPHER_MODE_KEY

public static final java.lang.String CIPHER_MODE_KEY

See Also:

Constant Field Values

CIPHER_PROVIDER_KEY

public static final java.lang.String CIPHER_PROVIDER_KEY

See Also:

Constant Field Values

RNG_ALGORITHM_KEY

public static final java.lang.String RNG_ALGORITHM_KEY

See Also:

Constant Field Values

RNG_PROVIDER_KEY

public static final java.lang.String RNG_PROVIDER_KEY

See Also:

Constant Field Values

Constructor Detail

AES

public AES(CipherProvider provider)

Method Detail

getName

public java.lang.String getName()

Description copied from class: Cipher

Return this Cipher's name

Specified by:

getName in class Cipher

getKeyLength

public int getKeyLength()

Description copied from class: Cipher

Return the key length required by this cipher, in bytes

Specified by:

getKeyLength in class Cipher

getIvLength

public int getIvLength()

Description copied from class: Cipher

Return the expected initialization vector length, in bytes, or 0 if not applicable

Specified by:

getIvLength in class Cipher

getRandomKey

public java.security.Key getRandomKey()

Description copied from class: Cipher

Create a random symmetric key

Specified by:

getRandomKey in class Cipher

Returns:

the random symmetric key

getEncryptor

public Encryptor getEncryptor()

Description copied from class: Cipher

Get an encryptor for encrypting data.

Specified by:

getEncryptor in class Cipher

getDecryptor

public Decryptor getDecryptor()

Description copied from class: Cipher

Return a decryptor for decrypting data.

Specified by:

getDecryptor in class Cipher

createEncryptionStream

public java.io.OutputStream createEncryptionStream(java.io.OutputStream out,
                                                   Context context,
                                                   byte[] iv)
                                            throws java.io.IOException

Description copied from class: Cipher

Create an encrypting output stream given a context and IV

Specified by:

createEncryptionStream in class Cipher

Parameters:

out - the output stream to wrap

context - the encryption context

iv - initialization vector

Returns:

the encrypting wrapper

Throws:

java.io.IOException

createEncryptionStream

public java.io.OutputStream createEncryptionStream(java.io.OutputStream out,
                                                   Encryptor e)
                                            throws java.io.IOException

Description copied from class: Cipher

Create an encrypting output stream given an initialized encryptor

Specified by:

createEncryptionStream in class Cipher

Parameters:

out - the output stream to wrap

e - the encryptor

Returns:

the encrypting wrapper

Throws:

java.io.IOException

createDecryptionStream

public java.io.InputStream createDecryptionStream(java.io.InputStream in,
                                                  Context context,
                                                  byte[] iv)
                                           throws java.io.IOException

Description copied from class: Cipher

Create a decrypting input stream given a context and IV

Specified by:

createDecryptionStream in class Cipher

Parameters:

in - the input stream to wrap

context - the encryption context

iv - initialization vector

Returns:

the decrypting wrapper

Throws:

java.io.IOException

createDecryptionStream

public java.io.InputStream createDecryptionStream(java.io.InputStream in,
                                                  Decryptor d)
                                           throws java.io.IOException

Description copied from class: Cipher

Create a decrypting output stream given an initialized decryptor

Specified by:

createDecryptionStream in class Cipher

Parameters:

in - the input stream to wrap

d - the decryptor

Returns:

the decrypting wrapper

Throws:

java.io.IOException