com.entrust.toolkit.xencrypt.algorithms

Class EncryptionAlgorithmImplAES

java.lang.Object

com.entrust.toolkit.xencrypt.algorithms.EncryptionAlgorithmImplAES

All Implemented Interfaces:

EncryptionAlgorithm

public final class EncryptionAlgorithmImplAES
extends java.lang.Object
implements EncryptionAlgorithm

Implements the EncryptionAlgorithm interface, making the Toolkit's AES implementation available for use in XML encryption.

Method Summary

Modifier and Type	Method and Description
byte[]	decrypt(byte[] bytesToBeDecrypted) Decrypts a byte array.
byte[]	encrypt(byte[] bytesToBeEncrypted) Encrypts a byte array.
byte[]	getEncoded() Retrieves the encoded secret key associated with this EncryptionAlgorithm instance.
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() Gets the algorithm identifier, which is a URI.
void	initDecrypt(byte[] keyBytes, byte[] iv) Initializes this symmetric cipher for decrypting, using the key material and initialization vector provided.
void	initEncrypt() Initializes the symmetric cipher for encryption using AES.
void	setPrivateKey(java.security.PrivateKey decryptionKey) This method is required to implement the EncryptionAlgorithm interface, but it applies only to asymmetric ciphers, so this method does nothing.
void	setPublicKey(java.security.PublicKey encryptionKey) This method is required to implement the EncryptionAlgorithm interface, but it applies only to asymmetric ciphers, so this method does nothing.
void	setURI(URI uri) Sets the algorithm identifier, which is a URI.

Methods inherited from class java.lang.Object

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

Method Detail

initEncrypt

public void initEncrypt()
                 throws EncryptionAlgorithmException

Initializes the symmetric cipher for encryption using AES.

Generates a random secret key the first time it is invoked, and generates a fresh IV on each subsequent invocation.

Specified by:

initEncrypt in interface EncryptionAlgorithm

Throws:

EncryptionAlgorithmException

initDecrypt

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

Initializes this symmetric cipher for decrypting, using the key material and initialization vector provided.

If the secret key has been initialized already, the invocation does not change it, but the initialization vector is always updated to the value provided.

Specified by:

initDecrypt in interface EncryptionAlgorithm

Parameters:

keyBytes - key material from which a SecretKeySpec of type AES can be constructed

iv - an initialization vector

Throws:

EncryptionAlgorithmException

See Also:

initEncrypt()

setPrivateKey

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

This method is required to implement the EncryptionAlgorithm interface, but it applies only to asymmetric ciphers, so this method does nothing.

Specified by:

setPrivateKey in interface EncryptionAlgorithm

Parameters:

decryptionKey - not used

Throws:

EncryptionAlgorithmException

See Also:

PrivateKey

setPublicKey

public void setPublicKey(java.security.PublicKey encryptionKey)

This method is required to implement the EncryptionAlgorithm interface, but it applies only to asymmetric ciphers, so this method does nothing.

Specified by:

setPublicKey in interface EncryptionAlgorithm

Parameters:

encryptionKey - not used

See Also:

PublicKey

getEncoded

public byte[] getEncoded()

Retrieves the encoded secret key associated with this EncryptionAlgorithm instance.

Specified by:

getEncoded in interface EncryptionAlgorithm

Returns:

The key material from the SecretKey associated with this EncryptionAlgorithm.

getURI

public URI getURI()

Gets the algorithm identifier, which is a URI.

Specified by:

getURI in interface EncryptionAlgorithm

Returns:

The algorithm identifier.

See Also:

XMLEConstants.ALGORITHM_AES_256, XMLEConstants.ALGORITHM_AES_192, XMLEConstants.ALGORITHM_AES_128

setURI

public void setURI(URI uri)

Sets the algorithm identifier, which is a URI.

Specified by:

setURI in interface EncryptionAlgorithm

Parameters:

uri - a URI reference that identifies the algorithm.

See Also:

XMLEConstants.ALGORITHM_AES_256, XMLEConstants.ALGORITHM_AES_192, XMLEConstants.ALGORITHM_AES_128

getIVparameters

public 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().

Specified by:

getIVparameters in interface EncryptionAlgorithm

Returns:

A String containing the initialization vector.

Throws:

EncryptionAlgorithmException - if the Base 64 encoding fails

decrypt

public byte[] decrypt(byte[] bytesToBeDecrypted)
               throws EncryptionAlgorithmException

Decrypts a byte array.

Specified by:

decrypt in interface EncryptionAlgorithm

Parameters:

bytesToBeDecrypted - a byte[] containing data to be decrypted

Returns:

A byte[] that contains the decrypted plaintext.

Throws:

EncryptionAlgorithmException

encrypt

public byte[] encrypt(byte[] bytesToBeEncrypted)
               throws EncryptionAlgorithmException

Encrypts a byte array.

Specified by:

encrypt in interface EncryptionAlgorithm

Parameters:

bytesToBeEncrypted - a byte[] containing plaintext to be encrypted

Returns:

A byte[] that contains the encryption of the plaintext.

Throws:

EncryptionAlgorithmException