iaik.xml.crypto.enc

Class EncryptionMethodImpl

java.lang.Object

javax.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dsig.AlgorithmMethodImpl

iaik.xml.crypto.enc.EncryptionMethodImpl

All Implemented Interfaces:

AlgorithmMethod, EncryptionMethod, XMLStructure

public class EncryptionMethodImpl
extends AlgorithmMethodImpl
implements EncryptionMethod

An implementation of the EncryptionMethod element that supports the DOM XML representation and processing mechanism.

Nested Class Summary

Nested classes/interfaces inherited from class iaik.xml.crypto.dom.DOMStructure

DOMStructure.NodeWrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected Cipher	cipher_ The Cipher.
protected KeySizeImpl	keySize_ The KeySize.

Fields inherited from class iaik.xml.crypto.dsig.AlgorithmMethodImpl

algorithm_, params_, spec_

Fields inherited from class iaik.xml.crypto.dom.DOMStructure

implMap_, state_, STATE_CREATED, STATE_MARSHALED, STATE_UNINITIALIZED, STATE_UNMARSHALED

Fields inherited from interface javax.xml.crypto.enc.EncryptionMethod

AES128_CBC, AES192_CBC, AES256_CBC, KW_AES128, KW_AES192, KW_AES256, KW_TRIPLEDES, RSA_1_5, RSA_OEAP_MGF1P, TRIPLEDES_CBC

Constructor Summary

Constructors

Constructor and Description
EncryptionMethodImpl(DOMCryptoContext context, Node node) Creates a new instance of this NewEncryptionMethodImpl with the specified context and node to unmarshal from.
EncryptionMethodImpl(String algorithm, Integer keySize, EncryptionMethodParameterSpec params) Creates a new instance of this NewEncryptionMethodImpl with the specified algorithm URI, key size and encryption method parameters.

Method Summary

Modifier and Type	Method and Description
InputStream	decrypt(Key key, InputStream cipherText) Decrypts the given cipherText using the represented encryption method with the given key.
InputStream	encrypt(Key key, InputStream plainText) Encrypts the given plainText using the represented encryption method with the given key.
OutputStream	encrypt(Key key, OutputStream cipherTexgt) Encrypts the given plainText using the represented encryption method with the given key.
protected void	getAlgorithmInstanceUncaught(XSecProvider.Purpose purpose)
protected List	getChildStructures() Returns the list of child structures of this DOMStructure.
Integer	getKeySize() Returns the size of the key to be used with this EncryptionMethod.
String	getLocalName() Returns the local name of the represented XML element.
String	getNamespace() Returns the namespace URI of the represented XML element.
protected Class	getParameterSpecClass() )
protected void	putChildStructure(DOMStructure childStructure) Put an unmarshalled child structure.
protected void	unmarshalStructures(NodeList nodes, DOMCryptoContext context) Unmarshals DOMStructures from the given nodes.
Key	unwrapKey(Key key, byte[] wrappedKey, String wrappedKeyAlgorithm, int wrappedKeyType) Unwraps a key from the given wrappedKey bytes using the represented encryption method with the given key.
byte[]	wrapKey(Key key, Key tbeKey) Wrap the given tbeKey using the represented encryption method using the given key.

Methods inherited from class iaik.xml.crypto.dsig.AlgorithmMethodImpl

containsElements, getAlgorithm, getAlgorithmInstance, getParameterSpec, getParamInstanceUncaught, marshal, marshalAttributes, unmarshalAttributes

Methods inherited from class iaik.xml.crypto.dom.DOMStructure

addBytesToElement, addBytesToElement, clearMarshalling, clearMarshalling, getBytesFromElement, getBytesFromElementStream, getChildStructureVersion, getHere, getImplClass, getInstance, getInstance, getNode, getParentStructure, getParentStructureOf, getQualifiedName, getQualifiedName, hasNSDeclAttrInScope, isFeatureSupported, isNSDeclInScope, marshalElement, marshalIDAttribute, newIDforLookUp, putImplClass, setBackToCompatibilityPrior1_14, setNode, setParentStructure, toString, unmarshal, unmarshalElement, unmarshalIDAttribute, wrapNode

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.xml.crypto.enc.EncryptionMethod

getParameterSpec

Methods inherited from interface javax.xml.crypto.AlgorithmMethod

getAlgorithm

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

Field Detail

cipher_

protected Cipher cipher_

The Cipher.

keySize_

protected KeySizeImpl keySize_

The KeySize.

Constructor Detail

EncryptionMethodImpl

public EncryptionMethodImpl(String algorithm,
                            Integer keySize,
                            EncryptionMethodParameterSpec params)
                     throws NoSuchAlgorithmException,
                            InvalidAlgorithmParameterException

Creates a new instance of this NewEncryptionMethodImpl with the specified algorithm URI, key size and encryption method parameters.

Parameters:

algorithm - the algorithm URI. (must be RFC 2396 complaint)

keySize - the key size (may be null)

params - the encryption method parameters (may be null)

Throws:

NoSuchAlgorithmException - if no implementation of the given algorithm is found

InvalidAlgorithmParameterException - if the specified algorithm params are not appropriate for the given algorithm

EncryptionMethodImpl

public EncryptionMethodImpl(DOMCryptoContext context,
                            Node node)
                     throws MarshalException

Creates a new instance of this NewEncryptionMethodImpl with the specified context and node to unmarshal from.

Parameters:

context - the context

node - the node to unmarshal from

Throws:

MarshalException - if an excpetion occurs during unmarshaling

Method Detail

getAlgorithmInstanceUncaught

protected void getAlgorithmInstanceUncaught(XSecProvider.Purpose purpose)
                                     throws NoSuchAlgorithmException

Specified by:

getAlgorithmInstanceUncaught in class AlgorithmMethodImpl

Throws:

NoSuchAlgorithmException

getLocalName

public String getLocalName()

Description copied from class: DOMStructure

Returns the local name of the represented XML element.

Specified by:

getLocalName in class DOMStructure

Returns:

the local name of the represented XML element

See Also:

DOMStructure.getLocalName()

getNamespace

public String getNamespace()

Description copied from class: DOMStructure

Returns the namespace URI of the represented XML element.

Specified by:

getNamespace in class DOMStructure

Returns:

the namespace URI of the represented XML element

See Also:

DOMStructure.getNamespace()

getKeySize

public Integer getKeySize()

Description copied from interface: javax.xml.crypto.enc.EncryptionMethod

Returns the size of the key to be used with this EncryptionMethod.

Specified by:

getKeySize in interface EncryptionMethod

Returns:

the key size, or null if not specified.

See Also:

EncryptionMethod.getKeySize()

unmarshalStructures

protected void unmarshalStructures(NodeList nodes,
                                   DOMCryptoContext context)
                            throws MarshalException

Description copied from class: DOMStructure

Unmarshals DOMStructures from the given nodes.

This method is called by DOMStructure.unmarshal(DOMCryptoContext).

This method calls DOMStructure.getInstance(Node, DOMCryptoContext) for every Element in the list of nodes. If DOMStructure.getInstance(Node, DOMCryptoContext) returns a DOMStructure DOMStructure.putChildStructure(DOMStructure) is called with the returned DOMStructure as parameter.

Overrides:

unmarshalStructures in class AlgorithmMethodImpl

Parameters:

nodes - the nodes to unmarshal from

context - the marshal context

Throws:

MarshalException - if an exception occurs during marshaling

See Also:

DOMStructure.unmarshalStructures(org.w3c.dom.NodeList, DOMCryptoContext)

getChildStructures

protected List getChildStructures()

Description copied from class: DOMStructure

Returns the list of child structures of this DOMStructure.

This method is called by DOMStructure.marshal(DOMCryptoContext, Node, Node).

A subclass has to overwrite this method to return a list of DOMStrucutres represented by this subclass.

Overrides:

getChildStructures in class DOMStructure

Returns:

a list of DOMStructures (may be empty, but never null)

See Also:

DOMStructure.getChildStructures()

putChildStructure

protected void putChildStructure(DOMStructure childStructure)
                          throws MarshalException

Description copied from class: DOMStructure

Put an unmarshalled child structure.

This method is called by DOMStructure.unmarshalStructures(NodeList, DOMCryptoContext) for every unmarshalled child structure.

A subclass has to overwrite this method to store the given child structure in its the corresponding field.

Overrides:

putChildStructure in class DOMStructure

Parameters:

childStructure - the unmarshalled child structure

Throws:

MarshalException

See Also:

DOMStructure.putChildStructure(iaik.xml.crypto.dom.DOMStructure)

wrapKey

public byte[] wrapKey(Key key,
                      Key tbeKey)
               throws XMLEncryptionException

Wrap the given tbeKey using the represented encryption method using the given key.

Parameters:

key - the key used for wrapping

tbeKey - the key to be wrapped

Returns:

the raw wrapped key

Throws:

XMLEncryptionException - if an unexpected exception occurs during encryption

unwrapKey

public Key unwrapKey(Key key,
                     byte[] wrappedKey,
                     String wrappedKeyAlgorithm,
                     int wrappedKeyType)
              throws XMLEncryptionException

Unwraps a key from the given wrappedKey bytes using the represented encryption method with the given key.

Parameters:

key - the key used for unwrapping

wrappedKey - the raw wrapped key

wrappedKeyAlgorithm - the algorithm of the wrapped key

wrappedKeyType - the type of wrapped key

Returns:

the unwrapped key

Throws:

XMLEncryptionException - if an unexpected exception occurs during unwrapping

decrypt

public InputStream decrypt(Key key,
                           InputStream cipherText)
                    throws XMLEncryptionException

Decrypts the given cipherText using the represented encryption method with the given key.

Parameters:

key - the key used for decryption

cipherText - the cipher bytes

Returns:

the plaintext bytes

Throws:

XMLEncryptionException - if an exception occurs during decryption

encrypt

public InputStream encrypt(Key key,
                           InputStream plainText)
                    throws XMLEncryptionException

Encrypts the given plainText using the represented encryption method with the given key.

Parameters:

key - the key used for encryption

plainText - the plain text bytes

Returns:

the cipher bytes

Throws:

XMLEncryptionException - if an exception occurs during encryption

encrypt

public OutputStream encrypt(Key key,
                            OutputStream cipherTexgt)
                     throws XMLEncryptionException

Encrypts the given plainText using the represented encryption method with the given key.

Parameters:

key - the key used for encryption

cipherTexgt - the cipher text bytes

Returns:

the cipher bytes

Throws:

XMLEncryptionException - if an exception occurs during encryption

getParameterSpecClass

protected Class getParameterSpecClass()

)

Specified by:

getParameterSpecClass in class AlgorithmMethodImpl

Returns:

the Class of the concrete parameter spec to be returned by AlgorithmMethodImpl.getParameterSpec().

Since:

1.17

See Also:

AlgorithmMethodImpl.getParameterSpecClass()