com.entrust.toolkit.xencrypt.algorithms

Class KeyWrapAlgorithmImplAES

java.lang.Object

com.entrust.toolkit.xencrypt.algorithms.KeyWrapAlgorithmImplAES

All Implemented Interfaces:

EncryptionAlgorithm, KeyWrapAlgorithm

public final class KeyWrapAlgorithmImplAES
extends java.lang.Object
implements KeyWrapAlgorithm

Implements the KeyWrapAlgorithm interface, so the Toolkit's AES key wrap implementation is made available for XML encryption.

Method Summary

Modifier and Type	Method and Description
byte[]	decrypt(byte[] bytesToBeUnwrapped) Unwraps (decrypts) wrapped key data.
byte[]	encrypt(byte[] bytesToBeWrapped) Wraps (encrypts) key data.
byte[]	getEncoded() Retrieves the encoded key encryption key associated with this KeyWrapAlgorithm.
java.lang.String	getIVparameters() Returns null because there is no IV generated for this algorithm.
URI	getURI() Retrieves the algorithm identifier, which is a URI.
void	initDecrypt(byte[] keyBytes, byte[] iv) Initializes the symmetric cipher for unwrapping key data.
void	initEncrypt() Initializes the symmetric cipher for wrapping key data.
void	setPrivateKey(java.security.PrivateKey decryptionKey) Required to implement the EncryptionAlgorithm interface, but does nothing, since AES Key Wrap is a symmetric algorithm.
void	setPublicKey(java.security.PublicKey encryptionKey) Required to implement the EncryptionAlgorithm interface, but does nothing, since AES Key Wrap is a symmetric algorithm.
void	setSecretKey(javax.crypto.SecretKey secretKey) Sets a secret key to wrap or unwrap an <EncryptedKey> element.
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

getURI

public URI getURI()

Retrieves the algorithm identifier, which is a URI.

Specified by:

getURI in interface EncryptionAlgorithm

Returns:

the algorithm identifier

See Also:

XMLEConstants.ALGORITHM_AES_256_KEY_WRAP, XMLEConstants.ALGORITHM_AES_192_KEY_WRAP, XMLEConstants.ALGORITHM_AES_128_KEY_WRAP

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_KEY_WRAP, XMLEConstants.ALGORITHM_AES_192_KEY_WRAP, XMLEConstants.ALGORITHM_AES_128_KEY_WRAP

getEncoded

public byte[] getEncoded()

Retrieves the encoded key encryption key associated with this KeyWrapAlgorithm.

Specified by:

getEncoded in interface EncryptionAlgorithm

Returns:

the encoded key associated with this KeyWrapAlgorithm

getIVparameters

public java.lang.String getIVparameters()

Returns null because there is no IV generated for this algorithm.

Specified by:

getIVparameters in interface EncryptionAlgorithm

Returns:

null

initEncrypt

public void initEncrypt()
                 throws EncryptionAlgorithmException

Initializes the symmetric cipher for wrapping key data.

Uses the application provided key encryption key.

Specified by:

initEncrypt in interface EncryptionAlgorithm

Throws:

EncryptionAlgorithmException - if an error occurs during initialization

initDecrypt

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

Initializes the symmetric cipher for unwrapping key data.

Uses the application-provided key encryption key. The parameters keyBytes and iv are ignored.

Specified by:

initDecrypt in interface EncryptionAlgorithm

Parameters:

keyBytes - the key material for a secret key

iv - initialization vector to be used in the decryption operation

Throws:

EncryptionAlgorithmException - if an error occurs during initialization

See Also:

initEncrypt()

encrypt

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

Wraps (encrypts) key data.

Specified by:

encrypt in interface EncryptionAlgorithm

Parameters:

bytesToBeWrapped - the key data to be wrapped

Returns:

the wrapped key data

Throws:

EncryptionAlgorithmException - if an error occurs during wrapping

decrypt

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

Unwraps (decrypts) wrapped key data.

Specified by:

decrypt in interface EncryptionAlgorithm

Parameters:

bytesToBeUnwrapped - the wrapped key data to be unwrapped

Returns:

the unwrapped key data

Throws:

EncryptionAlgorithmException - if an error occurs during unwrapping

setSecretKey

public void setSecretKey(javax.crypto.SecretKey secretKey)
                  throws EncryptionAlgorithmException

Sets a secret key to wrap or unwrap an <EncryptedKey> element.

Specified by:

setSecretKey in interface KeyWrapAlgorithm

Parameters:

secretKey - the secret key to be used for wrapping or unwraping

Throws:

EncryptionAlgorithmException

setPrivateKey

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

Required to implement the EncryptionAlgorithm interface, but does nothing, since AES Key Wrap is a symmetric algorithm.

Specified by:

setPrivateKey in interface EncryptionAlgorithm

Parameters:

decryptionKey - the private decryption key

Throws:

EncryptionAlgorithmException

See Also:

PrivateKey

setPublicKey

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

Required to implement the EncryptionAlgorithm interface, but does nothing, since AES Key Wrap is a symmetric algorithm.

Specified by:

setPublicKey in interface EncryptionAlgorithm

Throws:

EncryptionAlgorithmException

See Also:

PublicKey