Package org.apache.accumulo.core.security.crypto

Interface CryptoModule

All Known Implementing Classes:

DefaultCryptoModule

public interface CryptoModule

Classes that obey this interface may be used to provide encrypting and decrypting streams to the rest of Accumulo. Classes that obey this interface may be configured as the crypto module by setting the property crypto.module.class in the accumulo-site.xml file.

Method Summary

Modifier and Type	Method	Description
CryptoModuleParameters	generateNewRandomSessionKey(CryptoModuleParameters params)	Generates a random session key and sets it into the CryptoModuleParameters.getPlaintextKey() property.
CryptoModuleParameters	getDecryptingInputStream(CryptoModuleParameters params)	Takes a CryptoModuleParameters object containing an InputStream to wrap within a CipherInputStream.
CryptoModuleParameters	getEncryptingOutputStream(CryptoModuleParameters params)	Takes a CryptoModuleParameters object containing an OutputStream to wrap within a CipherOutputStream.
CryptoModuleParameters	initializeCipher(CryptoModuleParameters params)	Generates a Cipher object based on the parameters in the given CryptoModuleParameters object and places it into the CryptoModuleParameters.getCipher() property.

Method Detail

getEncryptingOutputStream

CryptoModuleParameters getEncryptingOutputStream(CryptoModuleParameters params)
                                          throws IOException

Takes a CryptoModuleParameters object containing an OutputStream to wrap within a CipherOutputStream. The various other parts of the CryptoModuleParameters object specify the details about the type of encryption to use. Callers should pay special attention to the CryptoModuleParameters.getRecordParametersToStream() and CryptoModuleParameters.getCloseUnderylingStreamAfterCryptoStreamClose() flags within the CryptoModuleParameters object, as they control whether or not this method will write to the given OutputStream in CryptoModuleParameters.getPlaintextOutputStream().

This method returns a CryptoModuleParameters object. Implementers of this interface maintain a contract that the returned object is the same as the one passed in, always. Return values are enclosed within that object, as some other calls will typically return more than one value.

Parameters:

params - the CryptoModuleParameters object that specifies how to set up the encrypted stream.

Returns:

the same CryptoModuleParameters object with the CryptoModuleParameters.getEncryptedOutputStream() set to a stream that is not null. That stream may be exactly the same stream as CryptoModuleParameters.getPlaintextInputStream() if the params object specifies no cryptography.

Throws:

IOException

getDecryptingInputStream

CryptoModuleParameters getDecryptingInputStream(CryptoModuleParameters params)
                                         throws IOException

Takes a CryptoModuleParameters object containing an InputStream to wrap within a CipherInputStream. The various other parts of the CryptoModuleParameters object specify the details about the type of encryption to use. Callers should pay special attention to the CryptoModuleParameters.getRecordParametersToStream() and CryptoModuleParameters.getCloseUnderylingStreamAfterCryptoStreamClose() flags within the CryptoModuleParameters object, as they control whether or not this method will read from the given InputStream in CryptoModuleParameters.getEncryptedInputStream().

This method returns a CryptoModuleParameters object. Implementers of this interface maintain a contract that the returned object is the same as the one passed in, always. Return values are enclosed within that object, as some other calls will typically return more than one value.

Parameters:

params - the CryptoModuleParameters object that specifies how to set up the encrypted stream.

Returns:

the same CryptoModuleParameters object with the CryptoModuleParameters.getPlaintextInputStream() set to a stream that is not null. That stream may be exactly the same stream as CryptoModuleParameters.getEncryptedInputStream() if the params object specifies no cryptography.

Throws:

IOException

generateNewRandomSessionKey

CryptoModuleParameters generateNewRandomSessionKey(CryptoModuleParameters params)

Generates a random session key and sets it into the CryptoModuleParameters.getPlaintextKey() property. Saves callers from having to set up their own secure random provider. Also will set the CryptoModuleParameters.getSecureRandom() property if it has not already been set by some other function.

Parameters:

params - a CryptoModuleParameters object contained a correctly instantiated set of properties.

Returns:

the same CryptoModuleParameters object with the plaintext key set

initializeCipher

CryptoModuleParameters initializeCipher(CryptoModuleParameters params)

Generates a Cipher object based on the parameters in the given CryptoModuleParameters object and places it into the CryptoModuleParameters.getCipher() property. Callers may choose to use this method if they want to get the initialization vector from the cipher before proceeding to create wrapped streams.

Parameters:

params - a CryptoModuleParameters object contained a correctly instantiated set of properties.

Returns:

the same CryptoModuleParameters object with the cipher set.