com.entrust.toolkit.xencrypt.algorithms

Interface EncryptionAlgorithm

All Known Subinterfaces:

KeyWrapAlgorithm

All Known Implementing Classes:

EncryptionAlgorithmImpl3DES, EncryptionAlgorithmImplAES, EncryptionAlgorithmImplRSA, KeyWrapAlgorithmImpl3DES, KeyWrapAlgorithmImplAES

public interface EncryptionAlgorithm

Defines the common behavior of encryption algorithms used by XMLE.

The application does not normally need to use this interface because the Toolkit already contains classes that implement it.

The following symmetric algorithms are supported:

• AES with a 256-bit key
• AES with a 192-bit key
• AES with a 128-bit key
• Triple DES (EDE)

The following asymmetric algorithms are supported:

• RSA with PKCS#1 v2.0 (OAEP)
• RSA with PKCS#1 v1.5

Note

All symmetric ciphers are used in CBC mode.

Method Summary

Modifier and Type	Method and Description
byte[]	decrypt(byte[] toBeDecrypted) Decrypts a byte array.
byte[]	encrypt(byte[] toBeEncrypted) Encrypts a byte array.
byte[]	getEncoded() Retrieves the encoded symmetric key associated with this EncryptionAlgorithm.
java.lang.String	getIVparameters() Retrieves a Base 64 encoding of the initialization vector that was used at the most recent invocation of initEncrypt() or initDecrypt().
URI	getURI() Retrieves the algorithm identifier, which is a URI.
void	initDecrypt(byte[] keyBytes, byte[] iv) Initializes the EncryptionAlgorithm for decrypting.
void	initEncrypt() Initializes the EncryptionAlgorithm for encrypting a DOM element or a set of DOM elements.
void	setPrivateKey(java.security.PrivateKey decryptionKey) Sets a private key for decrypting an <EncryptedKey> element.
void	setPublicKey(java.security.PublicKey encryptionKey) Sets a public key for encrypting an <EncryptedKey> element.
void	setURI(URI uri) Sets the algorithm identifier, which is a URI.

Method Detail

getURI

URI getURI()

Retrieves the algorithm identifier, which is a URI.

Returns:

a URI that identifies the algorithm

See Also:

XMLEConstants.ALGORITHM_RSA, XMLEConstants.ALGORITHM_RSA_OAEP, XMLEConstants.ALGORITHM_3DES, XMLEConstants.ALGORITHM_AES_256, XMLEConstants.ALGORITHM_AES_192, XMLEConstants.ALGORITHM_AES_128

setURI

void setURI(URI uri)
     throws EncryptionAlgorithmException

Sets the algorithm identifier, which is a URI.

Parameters:

uri - a URI reference that identifies the algorithm.

Throws:

EncryptionAlgorithmException

See Also:

XMLEConstants.ALGORITHM_RSA, XMLEConstants.ALGORITHM_RSA_OAEP, XMLEConstants.ALGORITHM_3DES, XMLEConstants.ALGORITHM_AES_256, XMLEConstants.ALGORITHM_AES_192, XMLEConstants.ALGORITHM_AES_128

getEncoded

byte[] getEncoded()

Retrieves the encoded symmetric key associated with this EncryptionAlgorithm.

If the implementation is a public key algorithm, returns null. Used internally by XMLE to encrypt the symmetric key with a public key.

Returns:

the SecretKey associated with this EncryptionAlgorithm.

initEncrypt

void initEncrypt()
          throws EncryptionAlgorithmException

Initializes the EncryptionAlgorithm for encrypting a DOM element or a set of DOM elements.

Generates fresh secret key material for each set of elements, and generates a fresh random initialization vector for each element in the set.

Applies only to symmetric algorithms; for asymmetric algorithms, does nothing.

Throws:

EncryptionAlgorithmException

initDecrypt

void initDecrypt(byte[] keyBytes,
                 byte[] iv)
          throws EncryptionAlgorithmException

Initializes the EncryptionAlgorithm for decrypting.

Applies only to symmetric algorithms.

Parameters:

keyBytes - the key material for a secret key

iv - initialization vector to be used in the decryption operation

Throws:

EncryptionAlgorithmException

setPrivateKey

void setPrivateKey(java.security.PrivateKey decryptionKey)
            throws EncryptionAlgorithmException

Sets a private key for decrypting an <EncryptedKey> element. Applies only to asymmetric algorithms.

Parameters:

decryptionKey - the private decryption key

Throws:

EncryptionAlgorithmException

See Also:

PrivateKey

setPublicKey

void setPublicKey(java.security.PublicKey encryptionKey)
           throws EncryptionAlgorithmException

Sets a public key for encrypting an <EncryptedKey> element. Applies only to asymmetric algorithms.

Throws:

EncryptionAlgorithmException

See Also:

PublicKey

encrypt

byte[] encrypt(byte[] toBeEncrypted)
        throws EncryptionAlgorithmException

Encrypts a byte array.

Parameters:

toBeEncrypted - a byte[] containing plaintext to be encrypted

Returns:

a byte[] that contains the encryption of the plaintext

Throws:

EncryptionAlgorithmException

decrypt

byte[] decrypt(byte[] toBeDecrypted)
        throws EncryptionAlgorithmException

Decrypts a byte array.

Parameters:

toBeDecrypted - a byte[] containing data to be decrypted

Returns:

a byte[] that contains the decrypted plaintext

Throws:

EncryptionAlgorithmException

getIVparameters

java.lang.String getIVparameters()
                          throws EncryptionAlgorithmException

Retrieves a Base 64 encoding of the initialization vector that was used at the most recent invocation of initEncrypt() or initDecrypt().

Returns:

a String containing the initialization vector

Throws:

EncryptionAlgorithmException