com.entrust.toolkit.xencrypt.algorithms

Class KeyWrapAlgorithmImpl3DES

java.lang.Object

com.entrust.toolkit.xencrypt.algorithms.KeyWrapAlgorithmImpl3DES

All Implemented Interfaces:

EncryptionAlgorithm, KeyWrapAlgorithm

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

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

Method Summary

Modifier and Type	Method and Description
byte[]	decrypt(byte[] bytesToBeUnwrapped) Decrypts a byte array.
byte[]	encrypt(byte[] bytesToBeWrapped) Encrypts a byte array.
byte[]	getEncoded() Retrieves the KeyEncryptionKey associated with this KeyWrapAlgorithm.
java.lang.String	getIVparameters() Retrieves a Base 64 encoding of the initialization vector that was used at the most recent invocation of initWrap() or initUnwrap().
URI	getURI() Gets the algorithm identifier, which is a URI.
void	initDecrypt(byte[] keyBytes, byte[] iv) Initializes the symmetric cipher for unwrapping.
void	initEncrypt() Initializes the symmetric cipher for wrapping a key data using TripleDES.
void	setPrivateKey(java.security.PrivateKey decryptionKey) Required to implement the EncryptionAlgorithm interface, but does nothing, since TripleDES is a symmetric cipher.
void	setPublicKey(java.security.PublicKey encryptionKey) Required to implement the EncryptionAlgorithm interface, but does nothing, since TripleDES is a symmetric cipher.
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()

Gets the algorithm identifier, which is a URI.

Specified by:

getURI in interface EncryptionAlgorithm

Returns:

The algorithm identifier.

See Also:

XMLEConstants.ALGORITHM_3DES_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_3DES_KEY_WRAP

getEncoded

public byte[] getEncoded()

Retrieves the KeyEncryptionKey associated with this KeyWrapAlgorithm.

Specified by:

getEncoded in interface EncryptionAlgorithm

Returns:

The KeyEncryptionKey associated with this KeyWrapAlgorithm.

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 unwrapping

Throws:

EncryptionAlgorithmException

initEncrypt

public void initEncrypt()
                 throws EncryptionAlgorithmException

Initializes the symmetric cipher for wrapping a key data using TripleDES.

Uses the application provided key encryption key.

Specified by:

initEncrypt in interface EncryptionAlgorithm

Throws:

EncryptionAlgorithmException

initDecrypt

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

Initializes the symmetric cipher for unwrapping.

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

encrypt

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

Encrypts a byte array.

Specified by:

encrypt in interface EncryptionAlgorithm

Parameters:

bytesToBeWrapped - a byte[] containing key data to be wrapped

Returns:

A byte[] that contains the wrapped key data.

Throws:

EncryptionAlgorithmException

decrypt

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

Decrypts a byte array.

Specified by:

decrypt in interface EncryptionAlgorithm

Parameters:

bytesToBeUnwrapped - a byte[] containing data to be decrypted

Returns:

A byte[] that contains the decrypted key data.

Throws:

EncryptionAlgorithmException

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 initWrap() or initUnwrap().

Specified by:

getIVparameters in interface EncryptionAlgorithm

Returns:

A String containing the initialization vector.

Throws:

EncryptionAlgorithmException

setPrivateKey

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

Required to implement the EncryptionAlgorithm interface, but does nothing, since TripleDES is a symmetric cipher.

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 TripleDES is a symmetric cipher.

Specified by:

setPublicKey in interface EncryptionAlgorithm

Throws:

EncryptionAlgorithmException

See Also:

PublicKey