org.apache.hadoop.hbase.io.crypto

Class Cipher

java.lang.Object

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

Direct Known Subclasses:

AES, CommonsCryptoAES

@InterfaceAudience.Public
public abstract class Cipher
extends Object

A common interface for a cryptographic algorithm.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLOCK_SIZE
static int	IV_LENGTH
static int	KEY_LENGTH
static int	KEY_LENGTH_BITS
private CipherProvider	provider
static String	RNG_ALGORITHM_KEY
static String	RNG_PROVIDER_KEY

Constructor Summary

Constructors

Constructor and Description
Cipher(CipherProvider provider)

Method Summary

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

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

RNG_ALGORITHM_KEY

public static final String RNG_ALGORITHM_KEY

See Also:

Constant Field Values

RNG_PROVIDER_KEY

public static final String RNG_PROVIDER_KEY

See Also:

Constant Field Values

provider

private final CipherProvider provider

Constructor Detail

Cipher

public Cipher(CipherProvider provider)

Method Detail

getProvider

public CipherProvider getProvider()

Return the provider for this Cipher

getName

public abstract String getName()

Return this Cipher's name

getKeyLength

public abstract int getKeyLength()

Return the key length required by this cipher, in bytes

getIvLength

public abstract int getIvLength()

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

getRandomKey

public abstract Key getRandomKey()

Create a random symmetric key

Returns:

the random symmetric key

getEncryptor

public abstract Encryptor getEncryptor()

Get an encryptor for encrypting data.

getDecryptor

public abstract Decryptor getDecryptor()

Return a decryptor for decrypting data.

createEncryptionStream

public abstract OutputStream createEncryptionStream(OutputStream out,
                                                    Context context,
                                                    byte[] iv)
                                             throws IOException

Create an encrypting output stream given a context and IV

Parameters:

out - the output stream to wrap

context - the encryption context

iv - initialization vector

Returns:

the encrypting wrapper

Throws:

IOException

createEncryptionStream

public abstract OutputStream createEncryptionStream(OutputStream out,
                                                    Encryptor encryptor)
                                             throws IOException

Create an encrypting output stream given an initialized encryptor

Parameters:

out - the output stream to wrap

encryptor - the encryptor

Returns:

the encrypting wrapper

Throws:

IOException

createDecryptionStream

public abstract InputStream createDecryptionStream(InputStream in,
                                                   Context context,
                                                   byte[] iv)
                                            throws IOException

Create a decrypting input stream given a context and IV

Parameters:

in - the input stream to wrap

context - the encryption context

iv - initialization vector

Returns:

the decrypting wrapper

Throws:

IOException

createDecryptionStream

public abstract InputStream createDecryptionStream(InputStream in,
                                                   Decryptor decryptor)
                                            throws IOException

Create a decrypting output stream given an initialized decryptor

Parameters:

in - the input stream to wrap

decryptor - the decryptor

Returns:

the decrypting wrapper

Throws:

IOException