| {"component":{"kind":"component","name":"xmlsecurity-sign","title":"XML Security Sign","description":"Sign XML payloads using the XML signature specification.","deprecated":false,"firstVersion":"2.12.0","label":"security,transformation","javaType":"org.apache.camel.component.xmlsecurity.XmlSignerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-xmlsecurity","version":"3.18.1","scheme":"xmlsecurity-sign","extendsScheme":"","syntax":"xmlsecurity-sign:name","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelXmlSignatureMessageIsPlainText":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Header for indicating that the message body contains non-xml plain text. This header is used in the XML signature generator. If the value is set to Boolean#TRUE then the message body is treated as plain text Overwrites the configuration parameter XmlSignerConfiguration#setPlainText(Boolean)","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_MESSAGE_IS_PLAIN_TEXT"},"CamelXmlSignaturePlainTextEncoding":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Header indicating the encoding of the plain text message body. Used in the XML signature generator if the header HEADER_MESSAGE_IS_PLAIN_TEXT is set to Boolean#TRUE. Overwrites the configuration parameter XmlSignerConfiguration#setPlainTextEncoding(String).","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_PLAIN_TEXT_ENCODING"},"CamelXmlSignatureOmitXmlDeclaration":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Header which indicates that either the resulting signature document in the signature generation case or the resulting output of the verifier should not contain an XML declaration. If the header is not specified then a XML declaration is created. There is one exception: If the verifier result is a plain text this header has no effect. Possible values of the header are Boolean#TRUE or Boolean#FALSE. Overwrites the configuration parameter XmlSignatureConfiguration#setOmitXmlDeclaration(Boolean).","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_OMIT_XML_DECLARATION"},"CamelXmlSignatureContentReferenceUri":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content reference URI","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_CONTENT_REFERENCE_URI"},"CamelXmlSignatureContentReferenceType":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The content reference type","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_CONTENT_REFERENCE_TYPE"},"CamelXmlSignatureSchemaResourceUri":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The schema resource URI","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_SCHEMA_RESOURCE_URI"},"CamelXmlSignatureXpathsToIdAttributes":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"XPaths to id attributes","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XPATHS_TO_ID_ATTRIBUTES"},"CamelXmlSignatureTransformMethods":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Header for dynamic specifying the transform methods of the reference to the signed data. The value of the header must be a comma separated list with the transform algorithms, for example: http://www.w3.org/2000/09/xmldsig#enveloped-signature,http://www.w3.org/TR/2001/REC-xml-c14n-20010315 Used for the XML signer. This header will overwrite the configuration property transformMethods. You cannot use transform algorithms, which need parameters like http://www.w3.org/TR/1999/REC-xslt-19991116, http://www.w3.org/2002/06/xmldsig-filter2, or http://www.w3.org/TR/1999/REC-xpath-19991116.","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_TRANSFORM_METHODS"},"CamelXmlSignatureXAdESQualifyingPropertiesId":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the 'Id' attribute value of QualifyingProperties element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_QUALIFYING_PROPERTIES_ID"},"CamelXmlSignatureXAdESSignedDataObjectPropertiesId":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the 'Id' attribute value of SignedDataObjectProperties element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_SIGNED_DATA_OBJECT_PROPERTIES_ID"},"CamelXmlSignatureXAdESSignedSignaturePropertiesId":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the 'Id' attribute value of SignedSignatureProperties element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_SIGNED_SIGNATURE_PROPERTIES_ID"},"CamelXmlSignatureXAdESDataObjectFormatEncoding":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"for the value of the Encoding element of the DataObjectFormat element","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_DATA_OBJECT_FORMAT_ENCODING"},"CamelXmlSignatureXAdESNamespace":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"overwrites the XAdES namespace parameter value","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_NAMESPACE"},"CamelXmlSignatureXAdESPrefix":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"overwrites the XAdES prefix parameter value","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#HEADER_XADES_PREFIX"},"CamelCharsetName":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the charset","constantName":"org.apache.camel.component.xmlsecurity.api.XmlSignatureConstants#CHARSET_NAME"}},"properties":{"name":{"kind":"path","displayName":"Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name part in the URI can be chosen by the user to distinguish between different signer endpoints within the camel context."},"addKeyInfoReference":{"kind":"parameter","displayName":"Add Key Info Reference","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"In order to protect the KeyInfo element from tampering you can add a reference to the signed info element so that it is protected via the signature value. The default value is true. Only relevant when a KeyInfo is returned by KeyAccessor. and KeyInfo#getId() is not null."},"baseUri":{"kind":"parameter","displayName":"Base Uri","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"You can set a base URI which is used in the URI dereferencing. Relative URIs are then concatenated with the base URI."},"canonicalizationMethod":{"kind":"parameter","displayName":"Canonicalization Method","group":"producer","label":"","required":false,"type":"object","javaType":"javax.xml.crypto.AlgorithmMethod","deprecated":false,"autowired":false,"secret":false,"defaultValue":"http://www.w3.org/TR/2001/REC-xml-c14n-20010315","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"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 inclusiveNamespacePrefixes) to create a canonicalization method."},"clearHeaders":{"kind":"parameter","displayName":"Clear Headers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Determines if the XML signature specific headers be cleared after signing and verification. Defaults to true."},"contentObjectId":{"kind":"parameter","displayName":"Content Object Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Sets the content object Id attribute value. By default a UUID is generated. If you set the null value, then a new UUID will be generated. Only used in the enveloping case."},"contentReferenceType":{"kind":"parameter","displayName":"Content Reference Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Type of the content reference. The default value is null. This value can be overwritten by the header XmlSignatureConstants#HEADER_CONTENT_REFERENCE_TYPE."},"contentReferenceUri":{"kind":"parameter","displayName":"Content Reference Uri","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Reference URI for the content to be signed. Only used in the enveloped case. If the reference URI contains an ID attribute value, then the resource schema URI ( setSchemaResourceUri(String)) must also be set because the schema validator will then find out which attributes are ID attributes. Will be ignored in the enveloping or detached case."},"cryptoContextProperties":{"kind":"parameter","displayName":"Crypto Context Properties","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.util.Map<java.lang.String, java.lang.Object>","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Sets the crypto context properties. See {link XMLCryptoContext#setProperty(String, Object)}. Possible properties are defined in XMLSignContext an XMLValidateContext (see Supported Properties). The following properties are set by default to the value Boolean#TRUE for the XML validation. If you want to switch these features off you must set the property value to Boolean#FALSE. org.jcp.xml.dsig.validateManifests javax.xml.crypto.dsig.cacheReference"},"digestAlgorithm":{"kind":"parameter","displayName":"Digest Algorithm","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Digest algorithm URI. Optional parameter. This digest algorithm is used for calculating the digest of the input message. If this digest algorithm is not specified then the digest algorithm is calculated from the signature algorithm. Example: http://www.w3.org/2001/04/xmlenc#sha256"},"disallowDoctypeDecl":{"kind":"parameter","displayName":"Disallow Doctype Decl","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"true","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Disallows that the incoming XML document contains DTD DOCTYPE declaration. The default value is Boolean#TRUE."},"keyAccessor":{"kind":"parameter","displayName":"Key Accessor","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xmlsecurity.api.KeyAccessor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"For the signing process, a private key is necessary. You specify a key accessor bean which provides this private key. The key accessor bean must implement the KeyAccessor interface. The package org.apache.camel.component.xmlsecurity.api contains the default implementation class DefaultKeyAccessor which reads the private key from a Java keystore."},"omitXmlDeclaration":{"kind":"parameter","displayName":"Omit Xml Declaration","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Indicator whether the XML declaration in the outgoing message body should be omitted. Default value is false. Can be overwritten by the header XmlSignatureConstants#HEADER_OMIT_XML_DECLARATION."},"outputXmlEncoding":{"kind":"parameter","displayName":"Output Xml Encoding","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"The character encoding of the resulting signed XML document. If null then the encoding of the original XML document is used."},"parentLocalName":{"kind":"parameter","displayName":"Parent Local Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Local name of the parent element to which the XML signature element will be added. Only relevant for enveloped XML signature. Alternatively you can also use setParentXpath(XPathFilterParameterSpec). Default value is null. The value must be null for enveloping and detached XML signature. This parameter or the parameter setParentXpath(XPathFilterParameterSpec) for enveloped signature and the parameter setXpathsToIdAttributes(List) for detached signature must not be set in the same configuration. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown."},"parentNamespace":{"kind":"parameter","displayName":"Parent Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Namespace of the parent element to which the XML signature element will be added."},"parentXpath":{"kind":"parameter","displayName":"Parent Xpath","group":"producer","label":"","required":false,"type":"object","javaType":"javax.xml.crypto.dsig.spec.XPathFilterParameterSpec","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Sets the XPath to find the parent node in the enveloped case. Either you specify the parent node via this method or the local name and namespace of the parent with the methods setParentLocalName(String) and setParentNamespace(String). Default value is null. The value must be null for enveloping and detached XML signature. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown."},"plainText":{"kind":"parameter","displayName":"Plain Text","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":"false","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Indicator whether the message body contains plain text. The default value is false, indicating that the message body contains XML. The value can be overwritten by the header XmlSignatureConstants#HEADER_MESSAGE_IS_PLAIN_TEXT."},"plainTextEncoding":{"kind":"parameter","displayName":"Plain Text Encoding","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"UTF-8","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Encoding of the plain text. Only relevant if the message body is plain text (see parameter plainText. Default value is UTF-8."},"prefixForXmlSignatureNamespace":{"kind":"parameter","displayName":"Prefix For Xml Signature Namespace","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ds","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Namespace prefix for the XML signature namespace http://www.w3.org/2000/09/xmldsig#. Default value is ds. If null or an empty value is set then no prefix is used for the XML signature namespace. See best practice http://www.w3.org/TR/xmldsig-bestpractices/#signing-xml- without-namespaces"},"properties":{"kind":"parameter","displayName":"Properties","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.xmlsecurity.api.XmlSignatureProperties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"For adding additional References and Objects to the XML signature which contain additional properties, you can provide a bean which implements the XmlSignatureProperties interface."},"schemaResourceUri":{"kind":"parameter","displayName":"Schema Resource Uri","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Classpath to the XML Schema. Must be specified in the detached XML Signature case for determining the ID attributes, might be set in the enveloped and enveloping case. If set, then the XML document is validated with the specified XML schema. The schema resource URI can be overwritten by the header XmlSignatureConstants#HEADER_SCHEMA_RESOURCE_URI."},"signatureAlgorithm":{"kind":"parameter","displayName":"Signature Algorithm","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"http://www.w3.org/2001/04/xmldsig-more#rsa-sha256","configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Signature algorithm. Default value is http://www.w3.org/2000/09/xmldsig#rsa-sha1."},"signatureId":{"kind":"parameter","displayName":"Signature Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Sets the signature Id. If this parameter is not set (null value) then a unique ID is generated for the signature ID (default). If this parameter is set to (empty string) then no Id attribute is created in the signature element."},"transformMethods":{"kind":"parameter","displayName":"Transform Methods","group":"producer","label":"","required":false,"type":"array","javaType":"java.util.List<javax.xml.crypto.AlgorithmMethod>","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","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."},"xpathsToIdAttributes":{"kind":"parameter","displayName":"Xpaths To Id Attributes","group":"producer","label":"","required":false,"type":"array","javaType":"java.util.List<javax.xml.crypto.dsig.spec.XPathFilterParameterSpec>","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"Define the elements which are signed in the detached case via XPATH expressions to ID attributes (attributes of type ID). For each element found via the XPATH expression a detached signature is created whose reference URI contains the corresponding attribute value (preceded by '#'). The signature becomes the last sibling of the signed element. Elements with deeper hierarchy level are signed first. You can also set the XPATH list dynamically via the header XmlSignatureConstants#HEADER_XPATHS_TO_ID_ATTRIBUTES. The parameter setParentLocalName(String) or setParentXpath(XPathFilterParameterSpec) for enveloped signature and this parameter for detached signature must not be set in the same configuration."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."},"uriDereferencer":{"kind":"parameter","displayName":"Uri Dereferencer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.xml.crypto.URIDereferencer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration","configurationField":"configuration","description":"If you want to restrict the remote access via reference URIs, you can set an own dereferencer. Optional parameter. If not set the provider default dereferencer is used which can resolve URI fragments, HTTP, file and XPpointer URIs. Attention: The implementation is provider dependent!"}}} |