com.mulesoft.modules.cryptography.internal.xml

Class XmlOperations

java.lang.Object

com.mulesoft.modules.cryptography.internal.xml.XmlOperations

public class XmlOperations
extends Object

XML operations.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
XmlOperations()

Method Summary

Modifier and Type	Method and Description
InputStream	xmlDecrypt(JceConfiguration config, InputStream content, String elementPath, JceKeySelection keySelection) Decrypt the XML document.
InputStream	xmlEncrypt(JceConfiguration config, InputStream content, XmlEncryptionAlgorithm algorithm, String elementPath, boolean encryptContent, JceKeySelection keySelection, EphemeralKeyInfo ephemeralKeyInfo) Encrypt the XML document.
InputStream	xmlSign(JceConfiguration config, InputStream content, XmlSignDigestAlgorithm digestAlgorithm, XmlCanonicalizationAlgorithm canonicalizationAlgorithm, XmlSignatureType type, String elementPath, JceKeySelection keySelection) Sign an XML document.
void	xmlValidate(JceConfiguration config, InputStream content, String elementPath, JceKeySelection keySelection, boolean useInlineCertificateIfPresent) Validate an XML signed document.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlOperations

public XmlOperations()

Method Detail

xmlEncrypt

@MediaType(value="application/xml")
 @Throws(value={EncryptionErrorTypeProvider.class,ParametersErrorTypeProvider.class})
 @Execution(value=CPU_INTENSIVE)
public InputStream xmlEncrypt(@Config
                                                                                                                                                                                         JceConfiguration config,
                                                                                                                                                                                         @Content
                                                                                                                                                                                         InputStream content,
                                                                                                                                                                                         @Optional(defaultValue="AES_CBC")
                                                                                                                                                                                         XmlEncryptionAlgorithm algorithm,
                                                                                                                                                                                         @Optional
                                                                                                                                                                                         String elementPath,
                                                                                                                                                                                         @Optional(defaultValue="true") @Summary(value="Encrypt the XML element or its content, if false the whole XML element is encrypted.")
                                                                                                                                                                                         boolean encryptContent,
                                                                                                                                                                                         @ParameterGroup(name="Key selection")
                                                                                                                                                                                         JceKeySelection keySelection,
                                                                                                                                                                                         @ParameterGroup(name="Ephemeral key")
                                                                                                                                                                                         EphemeralKeyInfo ephemeralKeyInfo)

Encrypt the XML document.

Parameters:

config - the XML configuration

content - the document to encrypt

algorithm - the algorithm for encryption

elementPath - the path to the element to encrypt, if empty the whole document is considered

encryptContent - encrypt the XML element or its content, if false the whole XML element is encrypted.

keySelection - the encryption key

ephemeralKeyInfo - the ephemeral key configuration to use in case of asymmetric algorithms

Returns:

an encrypted version of the input, which is also a valid XML document

xmlDecrypt

@MediaType(value="application/xml")
 @Throws(value={DecryptionErrorTypeProvider.class,ParametersErrorTypeProvider.class})
 @Execution(value=CPU_INTENSIVE)
public InputStream xmlDecrypt(@Config
                                                                                                                                                                                         JceConfiguration config,
                                                                                                                                                                                         @Content @Optional(defaultValue="#[payload]")
                                                                                                                                                                                         InputStream content,
                                                                                                                                                                                         @Optional
                                                                                                                                                                                         String elementPath,
                                                                                                                                                                                         @ParameterGroup(name="Key selection")
                                                                                                                                                                                         JceKeySelection keySelection)

Decrypt the XML document.

Parameters:

config - the XML configuration

content - the document to decrypt

keySelection - the decryption key

Returns:

the original unencrypted XML document

xmlSign

@MediaType(value="application/xml")
 @Throws(value={SignatureErrorTypeProvider.class,ParametersErrorTypeProvider.class})
 @Execution(value=CPU_INTENSIVE)
public InputStream xmlSign(@Config
                                                                                                                                                                                     JceConfiguration config,
                                                                                                                                                                                     @Content
                                                                                                                                                                                     InputStream content,
                                                                                                                                                                                     @Optional(defaultValue="SHA256")
                                                                                                                                                                                     XmlSignDigestAlgorithm digestAlgorithm,
                                                                                                                                                                                     @Optional(defaultValue="EXCLUSIVE")
                                                                                                                                                                                     XmlCanonicalizationAlgorithm canonicalizationAlgorithm,
                                                                                                                                                                                     @Optional(defaultValue="ENVELOPED")
                                                                                                                                                                                     XmlSignatureType type,
                                                                                                                                                                                     @Optional
                                                                                                                                                                                     String elementPath,
                                                                                                                                                                                     @ParameterGroup(name="Key selection")
                                                                                                                                                                                     JceKeySelection keySelection)

Sign an XML document.

Parameters:

config - the XML configuration

content - the XML document to sign

digestAlgorithm - the hashing algorithm for signing

canonicalizationAlgorithm - the canonicalization method for whitespace and namespace unification

type - the type of signature to create

elementPath - for internally detached signatures, an unambiguous XPath expression resolving to the element to sign

keySelection - the key for signing

Returns:

the original XML document, plus signature nodes

xmlValidate

@Validator
 @Throws(value={ValidationErrorTypeProvider.class,ParametersErrorTypeProvider.class})
 @Execution(value=CPU_INTENSIVE)
public void xmlValidate(@Config
                                                                                                                                                          JceConfiguration config,
                                                                                                                                                          @Content
                                                                                                                                                          InputStream content,
                                                                                                                                                          @Optional
                                                                                                                                                          String elementPath,
                                                                                                                                                          @ParameterGroup(name="Key selection")
                                                                                                                                                          JceKeySelection keySelection,
                                                                                                                                                          @Optional @Summary(value="Use inline defined certificate if found")
                                                                                                                                                          boolean useInlineCertificateIfPresent)

Validate an XML signed document.

Parameters:

config - the XML configuration

content - the document to verify (includes the signature)

elementPath - for internally detached signatures, an unambiguous XPath expression resolving to the signed element

keySelection - the key for validation