Page History

keyAccessor

KeyAccessor

null

Provides the signing key and the KeyInfo instance. There is an example implementation which uses a keystore, see DefaultKeyAccessor

addKeyInfoReference

Boolean

Boolean.TRUE

Indicator whether a Reference element refering the KeyInfo element provided by the key accessor should be added to the XML signature.

signatureAlgorithm

String

http://www.w3.org/2000/09/xmldsig#rsa-sha1

signature algorithm consisting of a digest and encryption algorithm. The digest algorithm is used to calculate the digest of the SignedInfo element and the encryption algorithm is used to sign this digest. Possible values: http://www.w3.org/2000/09/xmldsig#dsa-sha1, http://www.w3.org/2000/09/xmldsig#rsa-sha1, http://www.w3.org/2001/04/xmldsig-more#rsa-sha256, http://www.w3.org/2001/04/xmldsig-more#rsa-sha384, http://www.w3.org/2001/04/xmldsig-more#rsa-sha512

digestAlgorithm

String

see description

Digest algorithm for calculating the digest of the in-message body. If not specified then the digest algorithm of the signature algorithm is used. Possible values: http://www.w3.org/2000/09/xmldsig#sha1, http://www.w3.org/2001/04/xmlenc#sha256, http://www.w3.org/2001/04/xmldsig-more#sha384, http://www.w3.org/2001/04/xmlenc#sha512

parentLocalName

String

null

Local name of the parent of the Signature element. The Signature element will be added at the end of the children of the parent. Necessary for enveloped XML signature. If this option is null, then an enveloping XML signature is created. See also option parentNamespace.

parentNamespace

String

null

Namespace of the parent of the Signature element. See option parentLocalName

canonicalizationMethod

javax.xml.crypto.AlgorithmMethod

C14n

Canonicalization method used to canonicalize the SignedInfo element before the digest is calculated. You can use the helper methods XmlSignatureHelper.getCanonicalizationMethod(String algorithm) or getCanonicalizationMethod(String algorithm, List<String> inclusiveNamespacePrefixes) to create a canonicalization method.

transformMethods

List<javax.xml.crypto.AlgorithmMethod>

see description

Transforms which are executed on the message body before the digest is calculated. By default, C14n is added and in the case of enveloped signature (see option parentLocalName) also http://www.w3.org/2000/09/xmldsig#enveloped-signature is added at position 0 of the list. Use methods in XmlSignatureHelper to create the transform methods.

prefixForXmlSignatureNamespace

String

ds

Prefix for the XML signature namespace. If null is specified or an empty string then no prefix is used for the signature namespace.

contentReferenceUri

String

see description

The URI of the reference to the signed content (in-message body). If null and we are in the enveloped XML signature case then the URI is set to "". If null and we are in the enveloping XML signature case then the URI is set to "generated_object_id" which means that the reference points to the Object element containing the in-message body. You can use this option to reference a specific part in your in-message body if you do not want to sign the complete in-message body. This value can be overwritten by the header "CamelXmlSignatureContentReferenceUri". Please be aware, if you want to use a value of an XML ID attribute (example: "#ID_value"), then you must provide the information about the ID attribute via a doctype definition contained in the input XML document. This option is ignored in the case of detached signature when the option xpathsToIdAttributes is set.

contentReferenceType

String

null

Value of the type attribute of the content reference. This value can be overwritten by the header "CamelXmlSignatureContentReferenceType"

plainText

Boolean

Boolean.FALSE

Indicator whether the in-message body contains plain text. Normally, the signature generator treats the incoming message body as XML. If the message body is plain text, then you must set this option to true. The value can be overwritten by the header "CamelXmlSignatureMessageIsPlainText".

plainTextEncoding

String

null

Only used when the option plainText is set to true. Then you can specify the encoding of the plain text. If null then UTF-8 is used. The value can be overwritten by the header "CamelXmlSignatureMessageIsPlainTextEncoding".

properties

XmlSignatureProperties

null

For adding additional References and Objects to the XML signature which contain additional properties, you can provide a bean which implements the XmlSignatureProperties interface.

contentObjectId

String

null

Value of the Id attribute of the Object element. Only used in the enveloping XML signature case. If null then a unique value is generated. Available as of 2.12.2