Package org.opends.server.crypto

Class CryptoSuite

java.lang.Object

org.opends.server.crypto.CryptoSuite

public class CryptoSuite
extends Object

Defines cipher transformation and hash algorithm for cryptographic related operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CryptoSuite.CipherInfo	Cipher specific settings that can change at runtime.

Constructor Summary

Constructors

Constructor	Description
CryptoSuite(CryptoManager cryptoManager, String cipherTransformation, int cipherKeyLength, boolean encrypt)	Declares a new CryptoSuite with provided parameters.

Method Summary

Modifier and Type	Method	Description
byte[]	decrypt(byte[] data)	Decrypts data using the key specified in the prologue.
byte[]	encrypt(byte[] data)	Encrypts data with the configured cipher transformation and key length.
CipherInputStream	getCipherInputStream(InputStream is)	Returns a CipherInputStream for decrypting through a sequence of InputStreams.
CipherOutputStream	getCipherOutputStream(OutputStream os)	Returns a CipherOutputStream for encrypting through a sequence of OutputStreams.
ByteString	hash48(ByteSequence data)	Returns a ByteString of 6 bytes hash of the data.
boolean	isEncrypted()	Returns whether the user of the crypto suite needs encryption.
void	newParameters(String cipherTransformation, int cipherKeyLength, boolean enabled)	Set new cipher and enable parameters for the crypto suite.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CryptoSuite

public CryptoSuite(CryptoManager cryptoManager,
                   String cipherTransformation,
                   int cipherKeyLength,
                   boolean encrypt)

Declares a new CryptoSuite with provided parameters.

Parameters:

cryptoManager - the CryptoManager to use for cryptographic operations

cipherTransformation - the initial cipher transformation

cipherKeyLength - the initial key length for the cipher

encrypt - if the user of the crypto suite needs encryption

Method Detail

newParameters

public void newParameters(String cipherTransformation,
                          int cipherKeyLength,
                          boolean enabled)

Set new cipher and enable parameters for the crypto suite.

Parameters:

cipherTransformation - the new cipher transformation

cipherKeyLength - the new key length

enabled - true if the user of the crypto suite needs encryption

decrypt

public byte[] decrypt(byte[] data)
               throws GeneralSecurityException,
                      CryptoManagerException

Decrypts data using the key specified in the prologue.

Parameters:

data - the cipher-text to be decrypted (contains prologue)

Returns:

a byte array with the clear-text

Throws:

GeneralSecurityException - if a problem occurs while decrypting the data

CryptoManagerException - if a problem occurs during cipher initialization

encrypt

public byte[] encrypt(byte[] data)
               throws GeneralSecurityException,
                      CryptoManagerException

Encrypts data with the configured cipher transformation and key length.

Parameters:

data - the clear-text data to encrypt

Returns:

a byte array with a prologue containing the key identifier followed by cipher-text

Throws:

GeneralSecurityException - if a problem occurs while encrypting the data

CryptoManagerException - if a problem occurs during cipher initialization

getCipherOutputStream

public CipherOutputStream getCipherOutputStream(OutputStream os)
                                         throws CryptoManagerException

Returns a CipherOutputStream for encrypting through a sequence of OutputStreams.

Parameters:

os - the up-link OutputStream

Returns:

a CipherOutputStream for encrypting through a sequence of OutputStreams

Throws:

CryptoManagerException - if a problem occurs during cipher initialization

getCipherInputStream

public CipherInputStream getCipherInputStream(InputStream is)
                                       throws CryptoManagerException

Returns a CipherInputStream for decrypting through a sequence of InputStreams.

Parameters:

is - the up-link InputStream

Returns:

a CipherInputStream for decrypting through a sequence of InputStreams.

Throws:

CryptoManagerException - if a problem occurs during cipher initialization

hash48

public ByteString hash48(ByteSequence data)
                  throws DecodeException

Returns a ByteString of 6 bytes hash of the data.

Parameters:

data - a ByteSequence containing the input data to be hashed

Returns:

a ByteString of 6 bytes hash of the data.

Throws:

DecodeException - if digest of the data cannot be computed

isEncrypted

public boolean isEncrypted()

Returns whether the user of the crypto suite needs encryption.

Returns:

true if the user of the crypto suite needs encryption

toString

public String toString()

Overrides:

toString in class Object