iaik.xml.crypto.enc

Class XMLEncryptionFactory

java.lang.Object

javax.xml.crypto.enc.XMLEncryptionFactory

iaik.xml.crypto.enc.XMLEncryptionFactory

public class XMLEncryptionFactory
extends XMLEncryptionFactory

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

Constructor Summary

Constructors

Constructor and Description
XMLEncryptionFactory()

Method Summary

Modifier and Type	Method and Description
boolean	isFeatureSupported(String feature) Indicates whether a specified feature is supported.
AgreementMethod	newAgreementMethod(String algorithm, byte[] kaNonce, XMLStructure originatorKeyInfo, XMLStructure recipientKeyInfo, AgreementMethodParameterSpec params) Creates an AgreementMethod.
CanonicalizationMethod	newCanonicalizationMethod(String algorithm, C14NMethodParameterSpec params) Creates a CanonicalizationMethod for the specified algorithm URI and parameters.
CipherReference	newCipherReference(String uri, List transforms) Creates a CipherReference from the specified parameters.
DataReference	newDataReference(String uri, List content) Creates a DataReference from the specified URI.
EncryptedData	newEncryptedData(ToBeEncrypted toBeEncrypted, EncryptionMethod encMethod, KeyInfo keyInfo, EncryptionProperties properties, String id) Creates an EncryptedData which contains a CipherValue.
EncryptedData	newEncryptedData(ToBeEncrypted toBeEncrypted, EncryptionMethod encMethod, KeyInfo keyInfo, EncryptionProperties properties, String id, CipherReference cipherRef) Creates an EncryptedData which contains a CiphereReference.
EncryptedKey	newEncryptedKey(ToBeEncryptedKey key, EncryptionMethod encMethod, KeyInfo keyInfo, EncryptionProperties properties, List references, String id, String carriedKeyName, String recipient) Creates an EncryptedKey which contains a CipherValue.
EncryptedKey	newEncryptedKey(ToBeEncryptedKey key, EncryptionMethod encMethod, KeyInfo keyInfo, EncryptionProperties properties, List references, String id, String carriedKeyName, String recipient, CipherReference cipherRef) Creates an EncryptedKey which contains a CipherReference.
EncryptionMethod	newEncryptionMethod(String algorithm, Integer keySize, EncryptionMethodParameterSpec params) Creates a EncryptionMethod for the specified algorithm URI, key size, and parameters.
EncryptionProperties	newEncryptionProperties(List properties, String id) Creates EncryptionPropertiescontaining the specified list of EncryptionPropertys and optional id.
EncryptionProperty	newEncryptionProperty(List content, String target, String id, Map attributes) Creates an EncryptionProperty containing the specified list of XMLStructure s, target URI and optional id.
KeyReference	newKeyReference(String uri, List content) Creates a KeyReference from the specified URI.
EncryptedType	unmarshalEncryptedType(XMLDecryptContext context) Unmarshals a new EncryptedType instance from a mechanism-specific XMLDecryptContext instance.

Methods inherited from class javax.xml.crypto.enc.XMLEncryptionFactory

getInstance, getInstance, getInstance, getInstance, getMechanismType, getProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLEncryptionFactory

public XMLEncryptionFactory()

Method Detail

newEncryptedData

public EncryptedData newEncryptedData(ToBeEncrypted toBeEncrypted,
                                      EncryptionMethod encMethod,
                                      KeyInfo keyInfo,
                                      EncryptionProperties properties,
                                      String id)
                               throws IllegalArgumentException

Description copied from class: javax.xml.crypto.enc.XMLEncryptionFactory

Creates an EncryptedData which contains a CipherValue.

Specified by:

newEncryptedData in class XMLEncryptionFactory

Parameters:

toBeEncrypted - the data to be encrypted in this EncryptedData

encMethod - the encryption method (may be null)

keyInfo - the key info (may be null)

properties - the encryption properties (may be null)

id - the ID (may be null)

Returns:

an EncryptedData

Throws:

IllegalArgumentException - if ToBeEncryptedKey is passed in as toBeEncrypted

See Also:

XMLEncryptionFactory.newEncryptedData(javax.xml.crypto.enc.ToBeEncrypted, javax.xml.crypto.enc.EncryptionMethod, javax.xml.crypto.dsig.keyinfo.KeyInfo, javax.xml.crypto.enc.EncryptionProperties, java.lang.String)

newEncryptedData

public EncryptedData newEncryptedData(ToBeEncrypted toBeEncrypted,
                                      EncryptionMethod encMethod,
                                      KeyInfo keyInfo,
                                      EncryptionProperties properties,
                                      String id,
                                      CipherReference cipherRef)
                               throws IllegalArgumentException

Description copied from class: javax.xml.crypto.enc.XMLEncryptionFactory

Creates an EncryptedData which contains a CiphereReference.

Specified by:

newEncryptedData in class XMLEncryptionFactory

Parameters:

toBeEncrypted - the data to be encrypted in this EncryptedData

encMethod - the encryption method (may be null)

keyInfo - the key info (may be null)

properties - the encryption properties (may be null)

id - the ID (may be null)

cipherRef - the CiphereReference this EncryptedData will contain.

Returns:

an EncryptedData

Throws:

IllegalArgumentException - if ToBeEncryptedKey is passed in as toBeEncrypted

See Also:

XMLEncryptionFactory.newEncryptedData(javax.xml.crypto.enc.ToBeEncrypted, javax.xml.crypto.enc.EncryptionMethod, javax.xml.crypto.dsig.keyinfo.KeyInfo, javax.xml.crypto.enc.EncryptionProperties, java.lang.String, javax.xml.crypto.enc.CipherReference)

newEncryptedKey

public EncryptedKey newEncryptedKey(ToBeEncryptedKey key,
                                    EncryptionMethod encMethod,
                                    KeyInfo keyInfo,
                                    EncryptionProperties properties,
                                    List references,
                                    String id,
                                    String carriedKeyName,
                                    String recipient)

Description copied from class: javax.xml.crypto.enc.XMLEncryptionFactory

Creates an EncryptedKey which contains a CipherValue.

Specified by:

newEncryptedKey in class XMLEncryptionFactory

Parameters:

key - the key to be encrypted

encMethod - the encryption method (may be null)

keyInfo - the key info (may be null)

properties - the encryption properties (may be null)

references - a list of DataReferences or KeyReferences (may be null or empty)

id - the Id (may be null)

carriedKeyName - the carried key name (may be null)

recipient - the recipient (may be null)

Returns:

the EncryptedKey

See Also:

XMLEncryptionFactory.newEncryptedKey(javax.xml.crypto.enc.ToBeEncryptedKey, javax.xml.crypto.enc.EncryptionMethod, javax.xml.crypto.dsig.keyinfo.KeyInfo, javax.xml.crypto.enc.EncryptionProperties, java.util.List, java.lang.String, java.lang.String, java.lang.String)

newEncryptedKey

public EncryptedKey newEncryptedKey(ToBeEncryptedKey key,
                                    EncryptionMethod encMethod,
                                    KeyInfo keyInfo,
                                    EncryptionProperties properties,
                                    List references,
                                    String id,
                                    String carriedKeyName,
                                    String recipient,
                                    CipherReference cipherRef)

Description copied from class: javax.xml.crypto.enc.XMLEncryptionFactory

Creates an EncryptedKey which contains a CipherReference.

Specified by:

newEncryptedKey in class XMLEncryptionFactory

Parameters:

key - the key to be encrypted

encMethod - the encryption method (may be null)

keyInfo - the key info (may be null)

properties - the encryption properties (may be null)

references - a list of DataReferences or KeyReferences (may be null or empty)

id - the Id (may be null)

carriedKeyName - the carried key name (may be null)

recipient - the recipient (may be null)

cipherRef - the CiphereReference this EncryptedData will contain.

Returns:

the EncryptedKey

See Also:

XMLEncryptionFactory.newEncryptedKey(javax.xml.crypto.enc.ToBeEncryptedKey, javax.xml.crypto.enc.EncryptionMethod, javax.xml.crypto.dsig.keyinfo.KeyInfo, javax.xml.crypto.enc.EncryptionProperties, java.util.List, java.lang.String, java.lang.String, java.lang.String, javax.xml.crypto.enc.CipherReference)

newEncryptionMethod

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

Description copied from class: javax.xml.crypto.enc.XMLEncryptionFactory

Creates a EncryptionMethod for the specified algorithm URI, key size, and parameters.

Specified by:

newEncryptionMethod in class XMLEncryptionFactory

Parameters:

algorithm - the URI identifying the digest algorithm

keySize - the size of the key to be used (or null if not applicable)

params - algorithm-specific encryption parameters (may be null)

Returns:

the EncryptionMethod

Throws:

NoSuchAlgorithmException - if an implementation of the specified algorithm cannot be found

InvalidAlgorithmParameterException - if the specified parameters are inappropriate for the requested algorithm

See Also:

XMLEncryptionFactory.newEncryptionMethod(java.lang.String, java.lang.Integer, javax.xml.crypto.enc.spec.EncryptionMethodParameterSpec)

newAgreementMethod

public AgreementMethod newAgreementMethod(String algorithm,
                                          byte[] kaNonce,
                                          XMLStructure originatorKeyInfo,
                                          XMLStructure recipientKeyInfo,
                                          AgreementMethodParameterSpec params)
                                   throws NoSuchAlgorithmException,
                                          InvalidAlgorithmParameterException

Description copied from class: javax.xml.crypto.enc.XMLEncryptionFactory

Creates an AgreementMethod.

Specified by:

newAgreementMethod in class XMLEncryptionFactory

Parameters:

algorithm - the URI identifying the key agreement algorithm

kaNonce - the KA-Nonce (may be null)

originatorKeyInfo - the originator's key info (may be null)

recipientKeyInfo - the recipient's key info (may be null)

params - algorithm-specific agreement method parameters (may be null)

Returns:

the AgreementMethod

Throws:

NoSuchAlgorithmException - if an implementation of the specified algorithm cannot be found

InvalidAlgorithmParameterException - if the specified parameters are inappropriate for the requested algorithm

See Also:

XMLEncryptionFactory.newAgreementMethod(java.lang.String, byte[], javax.xml.crypto.XMLStructure, javax.xml.crypto.XMLStructure, javax.xml.crypto.enc.spec.AgreementMethodParameterSpec)

newCanonicalizationMethod

public CanonicalizationMethod newCanonicalizationMethod(String algorithm,
                                                        C14NMethodParameterSpec params)
                                                 throws NoSuchAlgorithmException,
                                                        InvalidAlgorithmParameterException

Description copied from class: javax.xml.crypto.enc.XMLEncryptionFactory

Creates a CanonicalizationMethod for the specified algorithm URI and parameters.

Specified by:

newCanonicalizationMethod in class XMLEncryptionFactory

Parameters:

algorithm - the URI identifying the canonicalization algorithm

params - algorithm-specific canonicalization parameters (may be null)

Returns:

a CanonicalizationMethod

Throws:

NoSuchAlgorithmException - if an implementation of the specified algorithm cannot be found

InvalidAlgorithmParameterException - if the specified parameters are inappropriate for the requested algorithm

See Also:

XMLEncryptionFactory.newCanonicalizationMethod(java.lang.String, javax.xml.crypto.dsig.spec.C14NMethodParameterSpec)

newCipherReference

public CipherReference newCipherReference(String uri,
                                          List transforms)

Description copied from class: javax.xml.crypto.enc.XMLEncryptionFactory

Creates a CipherReference from the specified parameters.

Specified by:

newCipherReference in class XMLEncryptionFactory

Parameters:

uri - the URI that identifies the encrypted octet sequence

transforms - a list of Transforms. The list is defensively copied to protect against subsequent modification. May be null or empty.

Returns:

a CipherReference

See Also:

XMLEncryptionFactory.newCipherReference(java.lang.String, java.util.List)

newDataReference

public DataReference newDataReference(String uri,
                                      List content)

Description copied from class: javax.xml.crypto.enc.XMLEncryptionFactory

Creates a DataReference from the specified URI.

Specified by:

newDataReference in class XMLEncryptionFactory

Parameters:

uri - the uri that refers to an EncryptedData element

content - a list of XMLStructure s (may be null). The list is defensively copied to protect against subsequent modification.

Returns:

a DataReference

See Also:

XMLEncryptionFactory.newDataReference(java.lang.String, java.util.List)

newKeyReference

public KeyReference newKeyReference(String uri,
                                    List content)

Description copied from class: javax.xml.crypto.enc.XMLEncryptionFactory

Creates a KeyReference from the specified URI.

Specified by:

newKeyReference in class XMLEncryptionFactory

Parameters:

uri - the uri that refers to an EncryptedKey element

content - a list of XMLStructure s (may be null). The list is defensively copied to protect against subsequent modification.

Returns:

a KeyReference

See Also:

XMLEncryptionFactory.newKeyReference(java.lang.String, java.util.List)

newEncryptionProperties

public EncryptionProperties newEncryptionProperties(List properties,
                                                    String id)

Description copied from class: javax.xml.crypto.enc.XMLEncryptionFactory

Creates EncryptionPropertiescontaining the specified list of EncryptionPropertys and optional id.

Specified by:

newEncryptionProperties in class XMLEncryptionFactory

Parameters:

properties - a list of one or more EncryptionPropertys. The list is defensively copied to protect against subsequent modification.

id - the id (may be null)

Returns:

a EncryptionProperties

See Also:

XMLEncryptionFactory.newEncryptionProperties(java.util.List, java.lang.String)

newEncryptionProperty

public EncryptionProperty newEncryptionProperty(List content,
                                                String target,
                                                String id,
                                                Map attributes)

Description copied from class: javax.xml.crypto.enc.XMLEncryptionFactory

Creates an EncryptionProperty containing the specified list of XMLStructure s, target URI and optional id.

Specified by:

newEncryptionProperty in class XMLEncryptionFactory

Parameters:

content - a list of one or more XMLStructures. The list is defensively copied to protect against subsequent modification.

target - the target URI of the EncryptedType that this property applies to (may be null)

id - the id (may be null)

attributes - a map of attributes from the XML namespace (may be empty or null)

Returns:

an EncryptionProperty

See Also:

XMLEncryptionFactory.newEncryptionProperty(java.util.List, java.lang.String, java.lang.String, java.util.Map)

unmarshalEncryptedType

public EncryptedType unmarshalEncryptedType(XMLDecryptContext context)
                                     throws MarshalException

Description copied from class: javax.xml.crypto.enc.XMLEncryptionFactory

Unmarshals a new EncryptedType instance from a mechanism-specific XMLDecryptContext instance.

Specified by:

unmarshalEncryptedType in class XMLEncryptionFactory

Parameters:

context - the mechanism-specific decryption context

Returns:

the EncryptedType

Throws:

MarshalException - if an unrecoverable exception occurs during unmarshalling

See Also:

XMLEncryptionFactory.unmarshalEncryptedType(javax.xml.crypto.enc.XMLDecryptContext)

isFeatureSupported

public boolean isFeatureSupported(String feature)

Description copied from class: javax.xml.crypto.enc.XMLEncryptionFactory

Indicates whether a specified feature is supported.

Specified by:

isFeatureSupported in class XMLEncryptionFactory

Parameters:

feature - the feature name (as an absolute URI)

Returns:

true if the specified feature is supported, false otherwise

See Also:

XMLEncryptionFactory.isFeatureSupported(java.lang.String)