org.apache.hadoop.crypto

Class JceCtrCryptoCodec.JceCtrCipher

java.lang.Object

org.apache.hadoop.crypto.JceCtrCryptoCodec.JceCtrCipher

All Implemented Interfaces:

org.apache.hadoop.crypto.Decryptor, org.apache.hadoop.crypto.Encryptor

Enclosing class:

org.apache.hadoop.crypto.JceCtrCryptoCodec

protected static class JceCtrCryptoCodec.JceCtrCipher
extends Object
implements org.apache.hadoop.crypto.Encryptor, org.apache.hadoop.crypto.Decryptor

Constructor Summary

Constructors

Constructor and Description
JceCtrCipher(int mode, String provider, org.apache.hadoop.crypto.CipherSuite suite, String name)

Method Summary

Modifier and Type	Method and Description
void	decrypt(ByteBuffer inBuffer, ByteBuffer outBuffer) This presents a direct interface decrypting with direct ByteBuffers.
void	encrypt(ByteBuffer inBuffer, ByteBuffer outBuffer) This presents a direct interface encrypting with direct ByteBuffers.
void	init(byte[] key, byte[] iv) Initialize the encryptor and the internal encryption context.
boolean	isContextReset() Indicate whether the encryption context is reset.
void	process(ByteBuffer inBuffer, ByteBuffer outBuffer)

Methods inherited from class java.lang.Object

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

Constructor Detail

JceCtrCipher

public JceCtrCipher(int mode,
                    String provider,
                    org.apache.hadoop.crypto.CipherSuite suite,
                    String name)
             throws GeneralSecurityException

Throws:

GeneralSecurityException

Method Detail

init

public void init(byte[] key,
                 byte[] iv)
          throws IOException

Description copied from interface: org.apache.hadoop.crypto.Encryptor

Initialize the encryptor and the internal encryption context.

Specified by:

init in interface org.apache.hadoop.crypto.Decryptor

Specified by:

init in interface org.apache.hadoop.crypto.Encryptor

Parameters:

key - encryption key.

iv - encryption initialization vector

Throws:

IOException - if initialization fails

encrypt

public void encrypt(ByteBuffer inBuffer,
                    ByteBuffer outBuffer)
             throws IOException

Description copied from interface: org.apache.hadoop.crypto.Encryptor

This presents a direct interface encrypting with direct ByteBuffers.

This function does not always encrypt the entire buffer and may potentially need to be called multiple times to process an entire buffer. The object may hold the encryption context internally.

Some implementations may require sufficient space in the destination buffer to encrypt the entire input buffer.

Upon return, inBuffer.position() will be advanced by the number of bytes read and outBuffer.position() by bytes written. Implementations should not modify inBuffer.limit() and outBuffer.limit().

Specified by:

encrypt in interface org.apache.hadoop.crypto.Encryptor

Parameters:

inBuffer - a direct ByteBuffer to read from. inBuffer may not be null and inBuffer.remaining() must be > 0

outBuffer - a direct ByteBuffer to write to. outBuffer may not be null and outBuffer.remaining() must be > 0

Throws:

IOException - if encryption fails

decrypt

public void decrypt(ByteBuffer inBuffer,
                    ByteBuffer outBuffer)
             throws IOException

Description copied from interface: org.apache.hadoop.crypto.Decryptor

This presents a direct interface decrypting with direct ByteBuffers.

This function does not always decrypt the entire buffer and may potentially need to be called multiple times to process an entire buffer. The object may hold the decryption context internally.

Some implementations may require sufficient space in the destination buffer to decrypt the entire input buffer.

Upon return, inBuffer.position() will be advanced by the number of bytes read and outBuffer.position() by bytes written. Implementations should not modify inBuffer.limit() and outBuffer.limit().

Specified by:

decrypt in interface org.apache.hadoop.crypto.Decryptor

Parameters:

inBuffer - a direct ByteBuffer to read from. inBuffer may not be null and inBuffer.remaining() must be > 0

outBuffer - a direct ByteBuffer to write to. outBuffer may not be null and outBuffer.remaining() must be > 0

Throws:

IOException - if decryption fails

process

public void process(ByteBuffer inBuffer,
                    ByteBuffer outBuffer)
             throws IOException

Throws:

IOException

isContextReset

public boolean isContextReset()

Description copied from interface: org.apache.hadoop.crypto.Encryptor

Indicate whether the encryption context is reset.

Certain modes, like CTR, require a different IV depending on the position in the stream. Generally, the encryptor maintains any necessary context for calculating the IV and counter so that no reinit is necessary during the encryption. Reinit before each operation is inefficient.

Specified by:

isContextReset in interface org.apache.hadoop.crypto.Decryptor

Specified by:

isContextReset in interface org.apache.hadoop.crypto.Encryptor

Returns:

boolean whether context is reset.