Summary: Configuration | Message Processors
org.mule.module.xmlsecurity

xml-security-module

1.0
Namespacehttp://www.mulesoft.org/schema/mule/xmlsecurity
Schema Locationhttp://www.mulesoft.org/schema/mule/xmlsecurity/1.0/mule-xmlsecurity.xsd
Version1.0
Minimum Mule Version3.2

Module Overview

Generic module

Summary

Configuration
<xmlsecurity:config>
Configure an instance of this module
Message Processors
<xmlsecurity:sign>
Custom processor
<xmlsecurity:validate>
Custom processor

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:xmlsecurity="http://www.mulesoft.org/schema/mule/xmlsecurity"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/xmlsecurity
               http://www.mulesoft.org/schema/mule/xmlsecurity/1.0/mule-xmlsecurity.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necesary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
TypeNameDefault ValueDescription
xs:string name Optional. Give a name to this configuration so it can be later referenced.
canonicalizationAlgorithm EXCLUSIVE Optional. Canonicalization Method For a canonicalization specification see @see{http://www.w3.org/TR/2009/WD-xmlsec-algorithms-20090226/#canonicalization-uris} Accepted Values: EXCLUSIVE, EXCLUSIVE_WITH_COMMENTS, INCLUSIVE, INCLUSE_WITH_COMMENTS,
digestMethodAlgorithm SHA256 Optional. Digest Method Algorithm For a reference on the Digest Method Algorithms see @see{http://www.w3.org/TR/2009/WD-xmlsec-algorithms-20090226/#digest-method-uris} ACCEPTED VALUES: RIPEMD160, SHA1, SHA256, SHA512
xs:string keyPairAlgorithm DSA Optional. Algorithm used to generate a key Pair.
xs:string keystore Optional. Keystore path
xs:string keystoreKey Optional. Keystore key
xs:string password Optional. Private Key, if you shared a private key use it.
xs:string referenceURI Optional. Reference URI, if you wish to use an external reference URI for Detached signatures.
xs:string secretKeyAlgorithm Optional. The Algorithm which is used to encrypt the private key For example: HmacSHA256
signatureMethodAlgorithm RSA_SHA1 Optional. Signature Method Algorithm For Signature Method Algorithms specification see @see{http://www.w3.org/TR/2009/WD-xmlsec-algorithms-20090226/#signature-method-uris} Accepted Values: RSA_SHA1, DSA_SHA1, HMAC_SHA1
signatureType The signature type ACCEPTED VALUES: DETACHED, ENVELOPED, ENVELOPING

Message Processors

<xmlsecurity:sign>

Custom processor

XML Sample
INCLUDE_ERROR

Attributes
config-ref Optional. Specify which configuration to use.
payload Content to be processed
retryMax 1 Optional. Specify how many times this operation can be retried automatically
Child Elements
Return Payload
  • Some string

<xmlsecurity:validate>

Custom processor

XML Sample
INCLUDE_ERROR

Attributes
config-ref Optional. Specify which configuration to use.
payload Content to be processed
retryMax 1 Optional. Specify how many times this operation can be retried automatically
Child Elements
Return Payload
  • true/false