XML Signature Syntax and Processing Version 2.0

Abstract

This document specifies XML digital signature processing rules and syntax. XML Signatures provide integrity , message authentication , and/or signer authentication services for data of any type, whether located within the XML that includes the signature or elsewhere.

URI	namespace prefix	XML internal entity
`http://www.w3.org/2000/09/xmldsig#`	default namespace , `ds:`, `dsig:`	`<!ENTITY dsig "http://www.w3.org/2000/09/xmldsig#">`
`http://www.w3.org/2009/xmldsig11#`	`dsig11:`	`<!ENTITY dsig11 "http://www.w3.org/2009/xmldsig11#">`
`http://www.w3.org/2010/xmldsig2#`	`dsig2:`	`<!ENTITY dsig2 "http://www.w3.org/2010/xmldsig2#">`

2. Signature Overview and Examples

This section provides an overview and examples of XML digital signature syntax. The specific processing is given in Processing Rules (section 3). The formal syntax is found in Core Signature Syntax (section 4) and Additional Signature Syntax (section 5).

In this section, an informal representation and examples are used to describe the structure of the XML signature syntax. This representation and examples may omit attributes, details and potential features that are fully explained later.

XML Signatures are applied to arbitrary digital content (data objects) via an indirection. Data objects are digested, the resulting value is placed in an element (with other information) and that element is then digested and cryptographically signed. XML digital signatures are represented by the Signature element which has the following structure (where "?" denotes zero or one occurrence; "+" denotes one or more occurrences; and "*" denotes zero or more occurrences):

  <Signature ID?> 
     <SignedInfo>
       <CanonicalizationMethod/>
       <SignatureMethod/>
       (<Reference URI? >
         (<Transforms>)?
         <DigestMethod>
         <DigestValue>
       </Reference>)+
     </SignedInfo>
     <SignatureValue> 

    (<KeyInfo>)?
    (<Object ID?>)*
   </Signature>

Signatures are related to data objects via URIs [ URI ]. Within an XML document, signatures are related to local data objects via fragment identifiers. Such local data can be included within an enveloping signature or can enclose an enveloped signature. Detached signatures are over external network resources or local data objects that reside within the same XML document as sibling elements; in this case, the signature is neither enveloping (signature is parent) nor enveloped (signature is child). Since a Signature element (and its Id attribute value/name) may co-exist or be combined with other elements (and their IDs) within a single XML document, care should be taken in choosing names such that there are no subsequent collisions that violate the ID uniqueness validity constraint [ XML10 ].

2.1 Simple Example ( `Signature`, `SignedInfo`, `Methods`, and `Reference` s)

The following example is a detached signature of the content of the HTML4 in XML specification. The XML Signature 2.0 Specification is designed to support a new, simplified processing model while remaining backwardly compatible with the older 1.x processing model. These are termed "2.0 Mode" and "Compatibility Mode" respectively. More details in Section 6.4.3.1 Signature modes . This example uses the "compatibility mode".

[s01] <Signature Id="MyFirstSignature" xmlns="http://www.w3.org/2000/09/xmldsig#"> [s02] <SignedInfo> [s03] <CanonicalizationMethod Algorithm="http://www.w3.org/2006/12/xml-c14n11"/> [s04] <SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/> [s05] <Reference URI="http://www.w3.org/TR/2000/REC-xhtml1-20000126/"> [s06] <Transforms> [s07] <Transform Algorithm="http://www.w3.org/2006/12/xml-c14n11"/> [s08] </Transforms> [s09] <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/> [s10] <DigestValue>dGhpcyBpcyBub3QgYSBzaWduYXR1cmUK...</DigestValue> [s11] </Reference> [s12] </SignedInfo> [s13] <SignatureValue>...</SignatureValue> [s14] <KeyInfo> [s15a] <KeyValue> [s15b] <DSAKeyValue> [s15c] <P>...</P><Q>...</Q><G>...</G><Y>...</Y> [s15d] </DSAKeyValue> [s15e] </KeyValue> [s16] </KeyInfo> [s17] </Signature>

[s01] <Signature Id="MyFirstSignature" xmlns="http://www.w3.org/2000/09/xmldsig#"> 
[s02]   <SignedInfo>  
[s03]   <CanonicalizationMethod Algorithm="http://www.w3.org/2006/12/xml-c14n11"/> 
[s04]   <SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/> 
[s05]   <Reference URI="http://www.w3.org/TR/2000/REC-xhtml1-20000126/"> 
[s06]     <Transforms> 
[s07]       <Transform Algorithm="http://www.w3.org/2006/12/xml-c14n11"/> 
[s08]     </Transforms> 
[s09]     <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/> 
[s10]     <DigestValue>dGhpcyBpcyBub3QgYSBzaWduYXR1cmUK...</DigestValue> 
[s11]   </Reference> 
[s12] </SignedInfo> 
[s13]   <SignatureValue>...</SignatureValue> 
[s14]   <KeyInfo> 
[s15a]    <KeyValue>
[s15b]      <DSAKeyValue> 
[s15c]        <P>...</P><Q>...</Q><G>...</G><Y>...</Y> 
[s15d]      </DSAKeyValue> 
[s15e]    </KeyValue> 
[s16]   </KeyInfo> 
[s17]

</Signature>

[s02-12] The required SignedInfo element is the information that is actually signed. Core validation of SignedInfo consists of two mandatory processes: validation of the signature over SignedInfo and validation of each Reference digest within SignedInfo. Note that the algorithms used in calculating the SignatureValue are also included in the signed information while the SignatureValue element is outside SignedInfo.

[s03] The CanonicalizationMethod is the algorithm that is used to canonicalize the SignedInfo element before it is digested as part of the signature operation. Note that this example is not in canonical form. (None of the examples in this specification are in canonical form.)

[s04] The SignatureMethod is the algorithm that is used to convert the canonicalized SignedInfo into the SignatureValue. It is a combination of a digest algorithm and a key dependent algorithm and possibly other algorithms such as padding, for example RSA-SHA1. The algorithm names are signed to resist attacks based on substituting a weaker algorithm. To promote application interoperability we specify a set of signature algorithms that must be implemented, though their use is at the discretion of the signature creator. We specify additional algorithms as recommended or optional for implementation; the design also permits arbitrary user specified algorithms.

[s05-11] Each Reference element includes the digest method and resulting digest value calculated over the identified data object. It also may include transformations that produced the input to the digest operation. A data object is signed by computing its digest value and a signature over that value. The signature is later checked via reference and signature validation .

[s14-16] KeyInfo indicates the key to be used to validate the signature. Possible forms for identification include certificates, key names, and key agreement algorithms and information -- we define only a few. KeyInfo is optional for two reasons. First, the signer may not wish to reveal key information to all document processing parties. Second, the information may be known within the application's context and need not be represented explicitly. Since KeyInfo is outside of SignedInfo, if the signer wishes to bind the keying information to the signature, a Reference can easily identify and include the KeyInfo as part of the signature. Use of KeyInfo is optional, however note that senders and receivers must agree on how it will be used through a mechanism out of scope for this specification.

2.1.1 More on `Reference`

These section ~~explaing~~ explaining the lines [s05] to [s11] of the previous example. This signature is in "compatibility mode".

[s05] <Reference URI="http://www.w3.org/TR/2000/REC-xhtml1-20000126/"> [s06] <Transforms> [s07] <Transform Algorithm="http://www.w3.org/2006/12/xml-c14n11"/> [s08] </Transforms> [s09] <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/> [s10] <DigestValue>dGhpcyBpcyBub3QgYSBzaWduYXR1cmUK...</DigestValue> [s11] </Reference>

[s05]   <Reference URI="http://www.w3.org/TR/2000/REC-xhtml1-20000126/"> 
[s06]     <Transforms> 
[s07]       <Transform Algorithm="http://www.w3.org/2006/12/xml-c14n11"/> 
[s08]     </Transforms> 
[s09]     <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/> 
[s10]     <DigestValue>dGhpcyBpcyBub3QgYSBzaWduYXR1cmUK...</DigestValue> 
[s11]

</Reference>

[s05] The optional URI attribute of Reference identifies the data object to be signed. This attribute may be omitted on at most one Reference in a Signature. (This limitation is imposed in order to ensure that references and objects may be matched unambiguously.)

[s05-08] This identification, along with the transforms, is a description provided by the signer on how they obtained the signed data object in the form it was digested (i.e. the digested content). The verifier may obtain the digested content in another method so long as the digest verifies. In particular, the verifier may obtain the content from a different location such as a local store than that specified in the URI.

[s06-08] Transforms is an optional ordered list of processing steps that were applied to the resource's content before it was digested. Transforms can include operations such as canonicalization, encoding/decoding (including compression/inflation), XSLT, XPath, XML schema validation, or XInclude. XPath transforms permit the signer to derive an XML document that omits portions of the source document. Consequently those excluded portions can change without affecting signature validity. For example, if the resource being signed encloses the signature itself, such a transform must be used to exclude the signature value from its own computation. If no Transforms element is present, the resource's content is digested directly. While the Working Group has specified mandatory (and optional) canonicalization and decoding algorithms, user specified transforms are permitted.

[s09-10] DigestMethod is the algorithm applied to the data after Transforms is applied (if specified) to yield the DigestValue. The signing of the DigestValue is what binds the content of a resource to the signer's key.

2.1.1.1 The Simple Example in "2.0 mode"

Here is the same signature in "2.0 mode". The only differences are in the CanonicalizationMethod and Reference parts. The line numbers in this example match up with the line numbers in the "compatibility mode" example.

[s01] <Signature Id="MyFirstSignature" xmlns="http://www.w3.org/2000/09/xmldsig#"> [s02] <SignedInfo> [s03] <CanonicalizationMethod Algorithm="http://www.w3.org/2010/xml-c14n2"/> [s04] <SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/> [s05] <Reference> [s06] <Transforms> [s07] <Transform Algorithm="http://www.w3.org/2010/xmldsig2#newTransformModel"> [s07a] <dsig2:Selection type="http://www.w3.org/2010/xmldsig2#xml" xmlns:dsig2="http://www.w3.org/2010/xmldsig2#" URI="http://www.w3.org/TR/2000/REC-xhtml1-20000126"> > [s07b] </Selection> [s07c] <CanonicalizationMethod Algorithm="http://www.w3.org/2010/xml-c14n2"/> [s07d] </Transform> [s08] </Transforms> [s09] <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/> [s10] <DigestValue>dGhpcyBpcyBub3QgYSBzaWduYXR1cmUK...</DigestValue> [s11] </Reference> [s12] </SignedInfo> [s13] <SignatureValue>...</SignatureValue> [s14] <KeyInfo> [s15a] <KeyValue> [s15b] <DSAKeyValue> [s15c] <P>...</P><Q>...</Q><G>...</G><Y>...</Y> [s15d] </DSAKeyValue> [s15e] </KeyValue> [s16] </KeyInfo> [s17] </Signature>

[s01] <Signature Id="MyFirstSignature" xmlns="http://www.w3.org/2000/09/xmldsig#"> 
[s02]   <SignedInfo>  
[s03]   <CanonicalizationMethod Algorithm="http://www.w3.org/2010/xml-c14n2"/> 
[s04]   <SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/> 
[s05]   <Reference> 
[s06]     <Transforms> 
[s07]       <Transform Algorithm="http://www.w3.org/2010/xmldsig2#newTransformModel">
[s07a]        <dsig2:Selection type="http://www.w3.org/2010/xmldsig2#xml" xmlns:dsig2="http://www.w3.org/2010/xmldsig2#"
URI="http://www.w3.org/TR/2000/REC-xhtml1-20000126">

>
[s07b]        </Selection>
[s07c]        <CanonicalizationMethod Algorithm="http://www.w3.org/2010/xml-c14n2"/>
[s07d]      </Transform> 
[s08]     </Transforms> 
[s09]     <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/> 
[s10]     <DigestValue>dGhpcyBpcyBub3QgYSBzaWduYXR1cmUK...</DigestValue> 
[s11]   </Reference> 
[s12] </SignedInfo> 
[s13]   <SignatureValue>...</SignatureValue> 
[s14]   <KeyInfo> 
[s15a]    <KeyValue>
[s15b]      <DSAKeyValue> 
[s15c]        <P>...</P><Q>...</Q><G>...</G><Y>...</Y> 
[s15d]      </DSAKeyValue> 
[s15e]    </KeyValue> 
[s16]   </KeyInfo> 
[s17]

</Signature>

[s03] In 2.0 mode, the Canonicalization Method URI should be Canonical XML 2.0 (or a later version) and all the parameters for Canonical XML 2.0 should be present as subelements of this element.

[s05-s08] Note 2.0 mode does not use the concept of transforms, instead each reference object has two parts - a Selection element to choose the data object to be signed, and a Canonicalization element to convert the data object to a canonicalized octet stream. To fit in these two elements, without breaking backwards compatibility with the 1.0 schema, these elements have been put inside a special Transform with URI http://www.w3.org/2010/xmldsig2#newTransformModel. In 2.0 mode the Transforms should have only have this particular Transform.

[s05] In the "2.0 mode", the URI attribute should be omitted from the Reference. Instead it should be in the Selection.

[s07a-s07b] The Selection element identifies the data object to be signed. This specification only defines two types "xml" and "binary", but user specified types are also allowed. For example a new type "database-rows" can be defined to select rows from the database for signing. Usually a URI and a few other bits of information is used to identify the data object, but the URI is not required, for example the "xml" type can identify a local document subset by using an XPath.

[s07c] The CanonicalizationMethod element provides the mechanism to convert the data object into a canonicalized octet stream. This specification only addresses canonicalization for xml data. Other forms of canonicalization can be defined - e.g. a scheme for signing mime attachments, can define a canonicalization for mime headers and data. The output of the canonicalization is digested.

2.2 Extended Example ( `Object` and `SignatureProperty` )

This specification does not address mechanisms for making statements or assertions. Instead, this document defines what it means for something to be signed by an XML Signature ( integrity , message authentication , and/or signer authentication ). Applications that wish to represent other semantics must rely upon other technologies, such as [ XML10 ], [ RDF-PRIMER ]. For instance, an application might use a foo:assuredby attribute within its own markup to reference a Signature element. Consequently, it's the application that must understand and know how to make trust decisions given the validity of the signature and the meaning of assuredby syntax. We also define a SignatureProperties element type for the inclusion of assertions about the signature itself (e.g., signature semantics, the time of signing or the serial number of hardware used in cryptographic processes). Such assertions may be signed by including a Reference for the SignatureProperties in SignedInfo. While the signing application should be very careful about what it signs (it should understand what is in the SignatureProperty ) a receiving application has no obligation to understand that semantic (though its parent trust engine may wish to). Any content about the signature generation may be located within the SignatureProperty element. The mandatory Target attribute references the Signature element to which the property applies.

Consider the preceding example (in compatibility mode) with an additional reference to a local Object that includes a SignatureProperty element. (Such a signature would not only be detached [p02] but enveloping [p03].)

[ ] <Signature Id="MySecondSignature" ...> [p01] <SignedInfo> [ ] ... [p02] <Reference URI="http://www.w3.org/TR/xml-stylesheet/"> [ ] ... [p03] <Reference URI="#AMadeUpTimeStamp" [p04] Type="http://www.w3.org/2000/09/xmldsig#SignatureProperties"> [p05] <Transforms> [p06] <Transform Algorithm="http://www.w3.org/2006/12/xml-c14n11"/> [p07] </Transforms> [p08] <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/> [p09] <DigestValue>dGhpcyBpcyBub3QgYSBzaWduYXR1cmUK...</DigestValue> [p10] </Reference> [p11] </SignedInfo> [p12] ... [p13] <Object> [p14] <SignatureProperties> [p15] <SignatureProperty Id="AMadeUpTimeStamp" Target="#MySecondSignature"> [p16] <timestamp xmlns="http://www.ietf.org/rfcXXXX.txt"> [p17] <date>19990914</date> [p18] <time>14:34:34:34</time> [p19] </timestamp> [p20] </SignatureProperty> [p21] </SignatureProperties> [p22] </Object> [p23]</Signature>

[   ]  <Signature Id="MySecondSignature" ...>
[p01]  <SignedInfo>  
[   ]   ...  
[p02]   <Reference URI="http://www.w3.org/TR/xml-stylesheet/">   
[   ]   ... 
[p03]   <Reference URI="#AMadeUpTimeStamp"  
[p04]         Type="http://www.w3.org/2000/09/xmldsig#SignatureProperties">

[p05]    <Transforms> 
[p06]      <Transform Algorithm="http://www.w3.org/2006/12/xml-c14n11"/> 
[p07]    </Transforms> 
[p08]    <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>    
[p09]    <DigestValue>dGhpcyBpcyBub3QgYSBzaWduYXR1cmUK...</DigestValue>
[p10]   </Reference>    
[p11]  </SignedInfo>  
[p12]  ...  
[p13]  <Object> 
[p14]   <SignatureProperties> 
[p15]     <SignatureProperty Id="AMadeUpTimeStamp" Target="#MySecondSignature"> 
[p16]        <timestamp xmlns="http://www.ietf.org/rfcXXXX.txt">  
[p17]          <date>19990914</date>  
[p18]          <time>14:34:34:34</time>  
[p19]        </timestamp>  
[p20]     </SignatureProperty> 
[p21]   </SignatureProperties> 
[p22]  </Object>  
[p23]

</Signature>

[p04] The optional Type attribute of Reference provides information about the resource identified by the URI. In particular, it can indicate that it is an Object, SignatureProperty, or Manifest element. This can be used by applications to initiate special processing of some Reference elements. References to an XML data element within an Object element should identify the actual element pointed to. Where the element content is not XML (perhaps it is binary or encoded data) the reference should identify the Object and the Reference Type, if given, should indicate Object. Note that Type is advisory and no action based on it or checking of its correctness is required by core behavior.

[p13] Object is an optional element for including data objects within the signature element or elsewhere. The Object can be optionally typed and/or encoded.

[p14-21] Signature properties, such as time of signing, can be optionally signed by identifying them from within a Reference. (These properties are traditionally called signature "attributes" although that term has no relationship to the XML term "attribute".)

This is the same example in the 2.0 mode. Only the Reference part is different.

[ ] ... [p03] <Reference> [p04] [p05] <Transforms> [p06] <Transform Algorithm="http://www.w3.org/2010/xmldsig2#newTransformModel"> [s06a] <dsig2:Selection type="http://www.w3.org/2010/xmldsig2#xml" xmlns:dsig2="http://www.w3.org/2010/xmldsig2#" URI="#AMadeUpTimeStamp" > [p06b] </Selection> [p06c] <CanonicalizationMethod Algorithm="http://www.w3.org/2010/xml-c14n2"/> [p06d] </Transform> [p07] </Transforms> [p08] <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/> [p09] <DigestValue>dGhpcyBpcyBub3QgYSBzaWduYXR1cmUK...</DigestValue> [p10] </Reference> [ ] ...

[   ]  ...
[p03]   <Reference>  
[p04]
[p05]    <Transforms> 
[p06]      <Transform Algorithm="http://www.w3.org/2010/xmldsig2#newTransformModel">
[s06a]        <dsig2:Selection type="http://www.w3.org/2010/xmldsig2#xml" xmlns:dsig2="http://www.w3.org/2010/xmldsig2#"
URI="#AMadeUpTimeStamp"
>

[p06b]        </Selection>
[p06c]        <CanonicalizationMethod Algorithm="http://www.w3.org/2010/xml-c14n2"/>
[p06d]     </Transform> 
[p07]    </Transforms> 
[p08]    <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>    
[p09]    <DigestValue>dGhpcyBpcyBub3QgYSBzaWduYXR1cmUK...</DigestValue>
[p10]   </Reference>    
[
]
...

2.3 Extended Example ( `Object` and `Manifest` )

The Manifest element is provided to meet additional requirements not directly addressed by the mandatory parts of this specification. Two requirements and the way the Manifest satisfies them follow.

First, applications frequently need to efficiently sign multiple data objects even where the signature operation itself is an expensive public key signature. This requirement can be met by including multiple Reference elements within SignedInfo since the inclusion of each digest secures the data digested. However, some applications may not want the core validation behavior associated with this approach because it requires every Reference within SignedInfo to undergo reference validation -- the DigestValue elements are checked. These applications may wish to reserve reference validation decision logic to themselves. For example, an application might receive a signature valid SignedInfo element that includes three Reference elements. If a single Reference fails (the identified data object when digested does not yield the specified DigestValue ) the signature would fail core validation . However, the application may wish to treat the signature over the two valid Reference elements as valid or take different actions depending on which fails. To accomplish this, SignedInfo would reference a Manifest element that contains one or more Reference elements (with the same structure as those in SignedInfo ). Then, reference validation of the Manifest is under application control.

Second, consider an application where many signatures (using different keys) are applied to a large number of documents. An inefficient solution is to have a separate signature (per key) repeatedly applied to a large SignedInfo element (with many Reference s); this is wasteful and redundant. A more efficient solution is to include many references in a single Manifest that is then referenced from multiple Signature elements.

The example (in compatibility mode) below includes a Reference that signs a Manifest found within the Object element.

[ ] ... [m01] <Reference URI="#MyFirstManifest" [m02] Type="http://www.w3.org/2000/09/xmldsig#Manifest"> [m03] <Transforms> [m04] <Transform Algorithm="http://www.w3.org/2006/12/xml-c14n11"/> [m05] </Transforms> [m06] <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/> [m07] <DigestValue>dGhpcyBpcyBub3QgYSBzaWduYXR1cmUK...=</DigestValue> [m08] </Reference> [ ] ... [m09] <Object> [m10] <Manifest Id="MyFirstManifest"> [m11] <Reference> [m12] ... [m13] </Reference> [m14] <Reference> [m15] ... [m16] </Reference> [m17] </Manifest> [m18] </Object>

[   ] ...
[m01]   <Reference URI="#MyFirstManifest"
[m02]     Type="http://www.w3.org/2000/09/xmldsig#Manifest">

[m03]     <Transforms> 
[m04]       <Transform Algorithm="http://www.w3.org/2006/12/xml-c14n11"/> 
[m05]     </Transforms> 
[m06]     <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/> 
[m07]     <DigestValue>dGhpcyBpcyBub3QgYSBzaWduYXR1cmUK...=</DigestValue> 
[m08]   </Reference>  
[   ] ...
[m09] <Object>
[m10]   <Manifest Id="MyFirstManifest">
[m11]     <Reference>
[m12]     ...
[m13]     </Reference>   
[m14]     <Reference>
[m15]     ...
[m16]     </Reference>
[m17]   </Manifest>
[m18]

</Object>

Here is the modified Reference in 2.0 mode

[m01] <Reference [m02] Type="http://www.w3.org/2000/09/xmldsig#Manifest"> [m03] <Transforms> [m04] <Transform Algorithm="http://www.w3.org/2010/xmldsig2#newTransformModel"> [m04a] <dsig2:Selection type="http://www.w3.org/2010/xmldsig2#xml" xmlns:dsig2="http://www.w3.org/2010/xmldsig2#" URI="#MyFirstManifest"> [m04b] </Selection> [m04c] <CanonicalizationMethod Algorithm="http://www.w3.org/2010/xml-c14n2"/> [m04d] </Transform> [m05] </Transforms> [m06] <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/> [m07] <DigestValue>dGhpcyBpcyBub3QgYSBzaWduYXR1cmUK...=</DigestValue> [m08] </Reference>

[m01]   <Reference
[m02]     Type="http://www.w3.org/2000/09/xmldsig#Manifest">
[m03]     <Transforms> 
[m04]      <Transform Algorithm="http://www.w3.org/2010/xmldsig2#newTransformModel">
[m04a]        <dsig2:Selection type="http://www.w3.org/2010/xmldsig2#xml" xmlns:dsig2="http://www.w3.org/2010/xmldsig2#"
URI="#MyFirstManifest">

[m04b]        </Selection>
[m04c]        <CanonicalizationMethod Algorithm="http://www.w3.org/2010/xml-c14n2"/>
[m04d]     </Transform> 
[m05]     </Transforms> 
[m06]     <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/> 
[m07]     <DigestValue>dGhpcyBpcyBub3QgYSBzaWduYXR1cmUK...=</DigestValue> 
[m08]

</Reference>

3. Processing Rules

The sections below describe the operations to be performed as part of signature generation and validation.

3.1 Signature Generation

The required steps include the generation of Reference elements and the SignatureValue over SignedInfo.

3.1.1 Reference Generation in Compatibility mode

For each data object being signed:

Apply the Transforms, as determined by the application, to the data object.
Calculate the digest value over the resulting data object.
Create a Reference element, including the (optional) identification of the data object, any (optional) transform elements, the digest algorithm and the DigestValue. (Note, it is the canonical form of these references that are signed in 3.1.2 and validated in 3.2.1 .)

The Reference Processing Model (section 4.4.3.2) requires use of Canonical XML 1.0 [ XML-C14N ] as default processing behavior when a transformation is expecting an octet-stream, but the data object resulting from URI dereferencing or from the previous transformation in the list of


Transform

elements is a node-set. We RECOMMEND that, when generating signatures, signature applications do not rely on this default behavior, but explicitly identify the transformation that is applied to perform this mapping. In cases in which inclusive canonicalization is desired, we RECOMMEND that Canonical XML 1.1 [ XML-C14N11 ] be used.

3.1.2 Reference Generation in 2.0 mode

For each Reference:

Decide how to represent the data object as a Selection.
Use the Canonicalization to convert the data object into an octet stream. This is not required for binary data.
Calculate the digest value over the resulting data object.
Create a Reference element, including the Selection element, Canonicalization element, the digest algorithm and the DigestValue. (Note, it is the canonical form of these references that are signed in 3.1.2 and validated in 3.2.1 .)

XML data objects must be canonicalized using Canonical XML 2.0 [ XML-C14N20 ] or later.

3.1.3 Signature Generation

Create SignedInfo element with SignatureMethod, CanonicalizationMethod and Reference (s).
Canonicalize and then calculate the SignatureValue over SignedInfo based on algorithms specified in SignedInfo. Canonicalization in this step must use a canonicalization algorithm designated as compatible with 2.0 mode for signatures created in 2.0 mode. This 2.0 mode canonicalization algorithm should be the same as used for Reference canonicalization.
Construct the Signature element that includes SignedInfo, Object (s) (if desired, encoding may be different than that used for signing), KeyInfo (if required), and SignatureValue.
Note, if the Signature includes same-document references, [ XML10 ] or [ XMLSCHEMA-1 ] ,[ XMLSCHEMA-2 ] validation of the document might introduce changes that break the signature. Consequently, applications should be careful to consistently process the document or refrain from using external contributions (e.g., defaults and entities).

3.2 Core Validation

The required steps of core validation include

establishing trust in the signing key mentioned in the KeyInfo. (Note in some environments, the signing key is implicitly known, and KeyInfo is not used at all).
Checking each Reference to to see if the data object matches with the expected data object.
the cryptographic signature validation of the signature calculated over SignedInfo.
reference validation , the verification of the digest contained in each Reference in SignedInfo.

These steps are present in ascending order of complexity, which ensures that the verifier rejects invalid signatures as quickly as possible.

Note, there may be valid signatures that some signature applications are unable to validate. Reasons for this include failure to implement optional parts of this specification, inability or unwillingness to execute specified algorithms, or inability or unwillingness to dereference specified URIs (some URI schemes may cause undesirable side effects), etc.

Comparison of each value in reference and signature validation is over the numeric (e.g., integer) or decoded octet sequence of the value. Different implementations may produce different encoded digest and signature values when processing the same resources because of variances in their encoding, such as accidental white space. But if one uses numeric or octet comparison (choose one) on both the stated and computed values these problems are eliminated.

3.2.1 Reference check in compatibility mode

It is very important to check that the Reference is really including the data that is expected to be signed. The [ XMLDSIG-BESTPRACTICES ] document lists a number of attacks, where what is apparently being signed is not actually signed.

One way to check the reference is to allow only certain combinations of transforms. For example [ SAML2-CORE ] and [ EBXML-MSG ] follow this approach.

Another option is for Dsig libraries to return the pre-digest data to the application, so that application can inspect it to verify what is actually signed. This too may not be enough, for example in a Web Services scenario, if the reference is pointing to a soap:Body, it is not sufficient to just check the name of the "soap:Body" element, as it can lead to wrapping attacks [ MCINTOSH-WRAP ];Instead the application should check if this soap:Body is in the correct position, i.e. as a child of the top level soap:Envelope.

3.2.2 Reference check in 2.0 mode

The absence of transforms makes Reference checking much more simpler in 2.0 mode. In this mode the Dsig library should process the Selection of each Reference to return a list of data objects that are included in the signature. For example each reference in a signature may point to a different part of the same document. The signature implementation should return all these parts (possibly as DOM elements) to the calling application, which should then compare against its policy to make sure what was expected to be signed is actually signed.

3.2.3 Signature Validation in Compatibility mode

Obtain the keying information from KeyInfo or from an external source.
Obtain the canonical form of the SignatureMethod using the CanonicalizationMethod and use the result (and previously obtained KeyInfo ) to confirm the SignatureValue over the SignedInfo element.

Note, KeyInfo (or some transformed version thereof) may be signed via a Reference element. Transformation and validation of this reference (3.2.1) is orthogonal to Signature Validation which uses the KeyInfo as parsed.

Additionally, the SignatureMethod URI may have been altered by the canonicalization of SignedInfo (e.g., absolutization of relative URIs) and it is the canonical form that must be used. However, the required canonicalization [ XML-C14N ] of this specification does not change URIs.

3.2.4 Signature Validation in 2.0 mode

Signature Validation is 2.0 mode is very similar, except that in this mode KeyInfo cannot have any transforms, and that the canonicalization of SignatureMethod is not required. These are the steps.

Obtain the keying information from KeyInfo or from an external source.
Using the CanonicalizationMethod (which must be Canonical XML 2.0) and use the result (and previously obtained KeyInfo ) to confirm the SignatureValue over the SignedInfo element.

3.2.5 Reference Validation in compatibility mode

Canonicalize the SignedInfo element based on the CanonicalizationMethod in SignedInfo.
For each Reference in SignedInfo:
1. Obtain the data object to be digested. (For example, the signature application may dereference the URI and execute Transforms provided by the signer in the Reference element, or it may obtain the content through other means such as a local cache.)
2. Digest the resulting data object using the DigestMethod specified in its Reference specification.
3. Compare the generated digest value against DigestValue in the SignedInfo Reference ; if there is any mismatch, validation fails.

Note, SignedInfo is canonicalized in step 1. The application must ensure that the CanonicalizationMethod has no dangerous side effects, such as rewriting URIs, (see CanonicalizationMethod Note (section 4.4.1)) and that it Sees What is Signed , which is the canonical form.

Note, After a Signature element has been created in Signature Generation for a signature with a same document reference, an implementation can serialize the XML content with variations in that serialization. This means that Reference Validation needs to canonicalize the XML document before digesting in step 1 to avoid issues related to variations in serialization.

3.2.6 Reference Validation in 2.0 mode

Reference Validation in 2.0 mode is very similar, except that the SignedInfo need not be canonicalized, ~~and~~ there are no transforms to ~~execute.~~ execute, and there is an optional dsig2:Verification step.

For each Reference in SignedInfo:
1. Obtain the data object to be digested by looking at the Selection.
2. Optional step : If the selection uses an ID based reference, and there is a dsig2:Verification element with dsig2:IDAssertion subelement, then use the specific ID attribute defined in the IDAssertion for obtaining the data object in the previous step.
3. Optional step : If the selection uses an ID based reference, and there is a dsig2:Verification element with dsig2:PositionAssertion subelement, then verify that the data object obtained in the first step is the same as that would be obtained by resolving the XPath expression in the PositionAssertion.
4. Perform the Canonicalization to compute an octet stream.
5. Optional step : If there is dsig2:Verification element with dsig2:DigestDataLength subelement, then verify that the length of the octet stream computed above is the same as the length specified in DigestDataLength.
6. Digest the resulting data object using the DigestMethod specified in its Reference specification. The canonicalization and digesting can be combined in one step for efficiency.
7. Compare the generated digest value against DigestValue in the SignedInfo Reference ; if there is any mismatch, validation fails.

4. Core Signature Syntax

The general structure of an XML signature is described in Signature Overview (section 2). This section provides detailed syntax of the core signature features. Features described in this section are mandatory to implement unless otherwise indicated. The syntax is defined via an [ XMLSCHEMA-1 ][ XMLSCHEMA-2 ] with the following XML preamble, declaration, and internal entity.

Schema Definition: <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE schema PUBLIC "-////DTD XMLSchema 200102//EN" "http://www.w3.org/2001/XMLSchema.dtd" [ <!ATTLIST schema xmlns:ds CDATA #FIXED "http://www.w3.org/2000/09/xmldsig#"> <!ENTITY dsig 'http://www.w3.org/2000/09/xmldsig#'> <!ENTITY % p ''> <!ENTITY % s ''> ]> <schema xmlns="http://www.w3.org/2001/XMLSchema" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" targetNamespace="http://www.w3.org/2000/09/xmldsig#" version="0.1" elementFormDefault="qualified">

   Schema Definition:

   <?xml version="1.0" encoding="utf-8"?>
   <!DOCTYPE schema
     PUBLIC "-//W3C//DTD XMLSchema 200102//EN" "http://www.w3.org/2001/XMLSchema.dtd"
     [
      <!ATTLIST schema
        xmlns:ds CDATA #FIXED "http://www.w3.org/2000/09/xmldsig#">

      <!ENTITY dsig 'http://www.w3.org/2000/09/xmldsig#'>
      <!ENTITY % p ''>
      <!ENTITY % s ''>
     ]>

   <schema xmlns="http://www.w3.org/2001/XMLSchema"
           xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
           targetNamespace="http://www.w3.org/2000/09/xmldsig#"
           version="0.1" elementFormDefault="qualified">

Additional markup defined in version 1.1 of this specification uses the dsig11: namespace. The syntax is defined in an XML schema with the following preamble:

<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE schema PUBLIC "-////DTD XMLSchema 200102//EN" "http://www.w3.org/2001/XMLSchema.dtd" [ <!ENTITY dsig 'http://www.w3.org/2000/09/xmldsig#'> <!ENTITY dsig11 'http://www.w3.org/2009/xmldsig11#'> <!ENTITY % p ''> <!ENTITY % s ''> ]> <schema xmlns="http://www.w3.org/2001/XMLSchema" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" xmlns:dsig11="http://www.w3.org/2009/xmldsig11#" targetNamespace="http://www.w3.org/2009/xmldsig11#" version="0.1" elementFormDefault="qualified">

   <?xml version="1.0" encoding="utf-8"?>
   <!DOCTYPE schema
     PUBLIC "-//W3C//DTD XMLSchema 200102//EN" "http://www.w3.org/2001/XMLSchema.dtd"
     [
      <!ENTITY dsig 'http://www.w3.org/2000/09/xmldsig#'>
      <!ENTITY dsig11 'http://www.w3.org/2009/xmldsig11#'>
      <!ENTITY % p ''>
      <!ENTITY % s ''>
     ]>

   <schema xmlns="http://www.w3.org/2001/XMLSchema"
           xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
           xmlns:dsig11="http://www.w3.org/2009/xmldsig11#"
           targetNamespace="http://www.w3.org/2009/xmldsig11#"
           version="0.1" elementFormDefault="qualified">

Notwithstanding the presence of a mixed content model (via mixed="true" declarations) in the definitions of various elements that follow, use of mixed content in conjunction with any elements defined by this specification is not recommended .

When these elements are used in conjunction with "2.0 Mode" signatures, mixed content must not be used.

4.1 The `ds:CryptoBinary` Simple Type

This specification defines the ds:CryptoBinary simple type for representing arbitrary-length integers (e.g. "bignums") in XML as octet strings. The integer value is first converted to a "big endian" bitstring. The bitstring is then padded with leading zero bits so that the total number of bits == 0 mod 8 (so that there are an integral number of octets). If the bitstring contains entire leading octets that are zero, these are removed (so the high-order octet is always non-zero). This octet string is then base64 [ RFC2045 ] encoded. (The conversion from integer to octet string is equivalent to IEEE 1363's I2OSP [ IEEE1363 ] with minimal length).

This type is used by "bignum" values such as RSAKeyValue and DSAKeyValue. If a value can be of type base64Binary or ds:CryptoBinary they are defined as base64Binary . For example, if the signature algorithm is RSA or DSA then SignatureValue represents a bignum and could be ds:CryptoBinary. However, if HMAC-SHA1 is the signature algorithm then SignatureValue could have leading zero octets that must be preserved. Thus SignatureValue is generically defined as of type base64Binary.

~~Schema Definition: <simpleType name="CryptoBinary"> <restriction base="base64Binary"> </restriction> </simpleType>~~

   Schema Definition:

   <simpleType name="CryptoBinary">
     <restriction base="base64Binary">
     </restriction>
   </simpleType>

4.2 The `Signature` element

The Signature element is the root element of an XML Signature. Implementation must generate laxly schema valid [ XMLSCHEMA-1 ][ XMLSCHEMA-2 ] Signature elements as specified by the following schema:

Schema Definition: <element name="Signature" type="ds:SignatureType"/> <complexType name="SignatureType"> <sequence> <element ref="ds:SignedInfo"/> <element ref="ds:SignatureValue"/> <element ref="ds:KeyInfo" minOccurs="0"/> <element ref="ds:Object" minOccurs="0" maxOccurs="unbounded"/> </sequence> <attribute name="Id" type="ID" use="optional"/> </complexType>

   Schema Definition:

   <element name="Signature" type="ds:SignatureType"/>
   <complexType name="SignatureType">
     <sequence> 
       <element ref="ds:SignedInfo"/> 
       <element ref="ds:SignatureValue"/> 
       <element ref="ds:KeyInfo" minOccurs="0"/> 
       <element ref="ds:Object" minOccurs="0" maxOccurs="unbounded"/> 
     </sequence>  
     <attribute name="Id" type="ID" use="optional"/>
   </complexType>

4.3 The `SignatureValue` Element

The SignatureValue element contains the actual value of the digital signature; it is always encoded using base64 [ RFC2045 ].

Schema Definition: <element name="SignatureValue" type="ds:SignatureValueType"/> <complexType name="SignatureValueType"> <simpleContent> <extension base="base64Binary"> <attribute name="Id" type="ID" use="optional"/> </extension> </simpleContent> </complexType>

   Schema Definition:

   <element name="SignatureValue" type="ds:SignatureValueType"/> 
   <complexType name="SignatureValueType">
     <simpleContent>
       <extension base="base64Binary">
         <attribute name="Id" type="ID" use="optional"/>
       </extension>
     </simpleContent>
   </complexType>

4.4 The `SignedInfo` Element

The structure of SignedInfo includes the canonicalization algorithm, a signature algorithm, and one or more references. The SignedInfo element may contain an optional ID attribute that will allow it to be referenced by other signatures and objects.

SignedInfo does not include explicit signature or digest properties (such as calculation time, cryptographic device serial number, etc.). If an application needs to associate properties with the signature or digest, it may include such information in a SignatureProperties element within an Object element.

Schema Definition: <element name="SignedInfo" type="ds:SignedInfoType"/> <complexType name="SignedInfoType"> <sequence> <element ref="ds:CanonicalizationMethod"/> <element ref="ds:SignatureMethod"/> <element ref="ds:Reference" maxOccurs="unbounded"/> </sequence> <attribute name="Id" type="ID" use="optional"/> </complexType>

   Schema Definition:

   <element name="SignedInfo" type="ds:SignedInfoType"/> 
   <complexType name="SignedInfoType">
     <sequence> 
       <element ref="ds:CanonicalizationMethod"/>
       <element ref="ds:SignatureMethod"/> 
       <element ref="ds:Reference" maxOccurs="unbounded"/> 
     </sequence>  
     <attribute name="Id" type="ID" use="optional"/> 
   </complexType>

4.4.1 The `CanonicalizationMethod` Element

CanonicalizationMethod is a required element that specifies the canonicalization algorithm applied to the SignedInfo element prior to performing signature calculations. This element uses the general structure for algorithms described in Algorithm Identifiers and Implementation Requirements (section 6.1). Implementations must support the required canonicalization algorithms .

Schema Definition: <element name="CanonicalizationMethod" type="ds:CanonicalizationMethodType"/> <complexType name="CanonicalizationMethodType" mixed="true"> <sequence> <any namespace="##any" minOccurs="0" maxOccurs="unbounded"/>  </sequence> <attribute name="Algorithm" type="anyURI" use="required"/> </complexType>

   Schema Definition:

   <element name="CanonicalizationMethod" type="ds:CanonicalizationMethodType"/> 
   <complexType name="CanonicalizationMethodType" mixed="true">
     <sequence>
       <any namespace="##any" minOccurs="0" maxOccurs="unbounded"/>
       <!-- (0,unbounded) elements from (1,1) namespace -->
     </sequence>
     <attribute name="Algorithm" type="anyURI" use="required"/> 
   </complexType>

In 2.0 mode the SignedInfo element is presented as a single subtree with no exclusions to the Canonicalization 2.0 algorithm. All the subelements of Canonicalization are presented as parameters.

2.0 mode uses CanonicalizationMethod in more way - as a canonicalization for the Reference.

The rest of the section is only applicable for compatibility mode.

Alternatives to the required canonicalization algorithms (section 6.5), such as Canonical XML with Comments (section 6.5.1) or a minimal canonicalization (such as CRLF and charset normalization) , may be explicitly specified but are not required . Consequently, their use may not interoperate with other applications that do not support the specified algorithm (see XML Canonicalization and Syntax Constraint Considerations , section 7). Security issues may also arise in the treatment of entity processing and comments if non-XML aware canonicalization algorithms are not properly constrained (see section 8.1.2: Only What is "Seen" Should be Signed ).

The way in which the SignedInfo element is presented to the canonicalization method is dependent on that method. The following applies to algorithms which process XML as nodes or characters:

XML based canonicalization implementations must be provided with an [ XPATH ] node-set originally formed from the document containing the SignedInfo and currently indicating the SignedInfo, its descendants, and the attribute and namespace nodes of SignedInfo and its descendant elements.
Text based canonicalization algorithms (such as CRLF and charset normalization) should be provided with the UTF-8 octets that represent the well-formed SignedInfo element, from the first character to the last character of the XML representation, inclusive. This includes the entire text of the start and end tags of the SignedInfo element as well as all descendant markup and character data (i.e., the text ) between those tags. Use of text based canonicalization of SignedInfo is not recommended .

We recommend applications that implement a text-based instead of XML-based canonicalization -- such as resource constrained apps -- generate canonicalized XML as their output serialization so as to mitigate interoperability and security concerns. For instance, such an implementation should (at least) generate standalone XML instances [ XML10 ].

NOTE : The signature application must exercise great care in accepting and executing an arbitrary CanonicalizationMethod. For example, the canonicalization method could rewrite the URIs of the Reference s being validated. Or, the method could massively transform SignedInfo so that validation would always succeed (i.e., converting it to a trivial signature with a known key over trivial data). Since CanonicalizationMethod is inside SignedInfo, in the resulting canonical form it could erase itself from SignedInfo or modify the SignedInfo element so that it appears that a different canonicalization function was used! Thus a Signature which appears to authenticate the desired data with the desired key, DigestMethod, and SignatureMethod, can be meaningless if a capricious CanonicalizationMethod is used.

4.4.2 The `SignatureMethod` Element

SignatureMethod is a required element that specifies the algorithm used for signature generation and validation. This algorithm identifies all cryptographic functions involved in the signature operation (e.g. hashing, public key algorithms, MACs, padding, etc.). This element uses the general structure here for algorithms described in section 6.1: Algorithm Identifiers and Implementation Requirements . While there is a single identifier, that identifier may specify a format containing multiple distinct signature values.

Schema Definition: <element name="SignatureMethod" type="ds:SignatureMethodType"/> <complexType name="SignatureMethodType" mixed="true"> <sequence> <element name="HMACOutputLength" minOccurs="0" type="ds:HMACOutputLengthType"/> <any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>  </sequence> <attribute name="Algorithm" type="anyURI" use="required"/> </complexType>

   Schema Definition:

   <element name="SignatureMethod" type="ds:SignatureMethodType"/>
   <complexType name="SignatureMethodType" mixed="true">
     <sequence>
       <element name="HMACOutputLength" minOccurs="0" type="ds:HMACOutputLengthType"/>
       <any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
       <!-- (0,unbounded) elements from (1,1) external namespace -->
      </sequence>
    <attribute name="Algorithm" type="anyURI" use="required"/> 
   </complexType>

The ds:HMACOutputLength parameter is used for HMAC [ HMAC ] algorithms. The parameter specifies a truncation length in bits. If this parameter is trusted without further verification, then this can lead to a security bypass [ CVE-2009-0217 ]. Signatures must be deemed invalid if the truncation length is below the larger of (a) half the underlying hash algorithm's output length, and (b) 80 bits. Note that some implementations are known to not accept truncation lengths that are lower than the underlying hash algorithm's output length.

4.4.3 The `Reference` Element

Reference is an element that may occur one or more times. It specifies a digest algorithm and digest value, and optionally an identifier of the object being signed, the type of the object, and/or a list of transforms to be applied prior to digesting. The identification (URI) and transforms describe how the digested content (i.e., the input to the digest method) was created. The Type attribute facilitates the processing of referenced data. For example, while this specification makes no requirements over external data, an application may wish to signal that the referent is a Manifest. An optional ID attribute permits a Reference to be referenced from elsewhere.

Schema Definition: <element name="Reference" type="ds:ReferenceType"/> <complexType name="ReferenceType"> <sequence> <element ref="ds:Transforms" minOccurs="0"/> <element ref="ds:DigestMethod"/> <element ref="ds:DigestValue"/> </sequence> <attribute name="Id" type="ID" use="optional"/> <attribute name="URI" type="anyURI" use="optional"/> <attribute name="Type" type="anyURI" use="optional"/> </complexType>

   Schema Definition:

   <element name="Reference" type="ds:ReferenceType"/>
   <complexType name="ReferenceType">
     <sequence> 
       <element ref="ds:Transforms" minOccurs="0"/> 
       <element ref="ds:DigestMethod"/> 
       <element ref="ds:DigestValue"/> 
     </sequence>
     <attribute name="Id" type="ID" use="optional"/> 
     <attribute name="URI" type="anyURI" use="optional"/> 
     <attribute name="Type" type="anyURI" use="optional"/> 
   </complexType>

4.4.3.1 Signature Modes

The XML Signature 2.0 Specification is designed to support a new, simplified processing model while remaining backwardly compatible with the older 1.x processing model. These are termed "2.0 Mode" and "Compatibility Mode" respectively.

A generic signature processor can determine the mode of a signature by examining the Reference element's attributes and the child element(s) of the Transforms element. If the URI attributes is present, "Compatibility Mode" is used. If the URI attributes is not present, and the Transforms element contains exactly one Transform element with an Algorithm of "http://www.w3.org/2010/xmldsig2#newTransformModel", then "2.0 Mode" is used. Otherwise, "Compatibility Mode" is used. All the references of a signature should have the same mode, i.e. they should all be in 2.0 mode, or all be in Compatibility mode.

4.4.3.2 The `URI` Attribute for `Reference` in compatibility mode

The URI attribute must be omitted for "2.0 Mode" signatures. If the attribute is omitted for a "Compatibility Mode" signature, then the receiving application is expected to know the identity of the object. For example, a lightweight data protocol might omit this attribute given the identity of the object is part of the application context.

In "Compatibility mode" at most one Reference element without a URI attribute may be present in any particular SignedInfo, or Manifest.

The remainder of this section applies only to "Compatibility Mode".

The URI attribute identifies a data object using a URI-Reference [ URI ].

The mapping from this attribute's value to a URI reference must be performed as specified in section 3.2.17 of [ XMLSCHEMA-2 ]. Additionally: Some existing implementations are known to verify the value of the URI attribute against the grammar in [ URI ]. It is therefore safest to perform any necessary escaping while generating the URI attribute.

We RECOMMEND XML Signature applications be able to dereference URIs in the HTTP scheme. Dereferencing a URI in the HTTP scheme must comply with the Status Code Definitions of [ HTTP11 ] (e.g., 302, 305 and 307 redirects are followed to obtain the entity-body of a 200 status code response). Applications should also be cognizant of the fact that protocol parameter and state information, (such as HTTP cookies, HTML device profiles or content negotiation), may affect the content yielded by dereferencing a URI.

If a resource is identified by more than one URI, the most specific should be used (e.g. http://www.w3.org/2000/06/interop-pressrelease.html.en instead of http://www.w3.org/2000/06/interop-pressrelease). (See the Reference Validation section (section 3.2.1) for further information on reference processing.)

If the URI attribute is omitted altogether, the receiving application is expected to know the identity of the object. For example, a lightweight data protocol might omit this attribute given the identity of the object is part of the application context. In Compatibility mode, this attribute may be omitted from at most one Reference in any particular SignedInfo, or Manifest.

The optional Type attribute contains information about the type of object being signed after all ds:Reference transforms have been applied. This is represented as a URI. For example:

Type= "http://www.w3.org/2000/09/xmldsig#Object" Type= "http://www.w3.org/2000/09/xmldsig#Manifest"

The Type attribute applies to the item being pointed at, not its contents. For example, a reference that results in the digesting of an Object element containing a SignatureProperties element is still of type #Object. The Type attribute is advisory. No validation of the type information is required by this specification.

4.4.3.3 The "Compatibility Mode" Reference Processing Model

Note : XPath is recommended . Signature applications need not conform to [ XPATH ] specification in order to conform to this specification. However, the XPath data model, definitions (e.g., node-sets ) and syntax is used within this document in order to describe functionality for those that want to process XML-as-XML (instead of octets) as part of signature generation. For those that want to use these features, a conformant [ XPATH ] implementation is one way to implement these features, but it is not required. Such applications could use a sufficiently functional replacement to a node-set and implement only those XPath expression behaviors required by this specification. However, for simplicity we generally will use XPath terminology without including this qualification on every point. Requirements over "XPath node-sets" can include a node-set functional equivalent. Requirements over XPath processing can include application behaviors that are equivalent to the corresponding XPath behavior.

The data-type of the result of URI dereferencing or subsequent Transforms is either an octet stream or an XPath node-set.

The Transforms specified in this document are defined with respect to the input they require. The following is the default signature application behavior:

If the data object is an octet stream and the next transform requires a node-set, the signature application must attempt to parse the octets yielding the required node-set via [ XML10 ] well-formed processing.
If the data object is a node-set and the next transform requires octets, the signature application must attempt to convert the node-set to an octet stream using Canonical XML [ XML-C14N ].

Users may specify alternative transforms that override these defaults in transitions between transforms that expect different inputs. The final octet stream contains the data octets being secured. The digest algorithm specified by DigestMethod is then applied to these data octets, resulting in the DigestValue.

Note: The Reference Generation Model (section 3.1.1) includes further restrictions on the reliance upon defined default transformations when applications generate signatures.

In this specification, a 'same-document' reference is defined as a URI-Reference that consists of a hash sign ('#') followed by a fragment or alternatively consists of an empty URI [ URI ].

Unless the URI-Reference is such a 'same-document' reference , the result of dereferencing the URI-Reference must be an octet stream. In particular, an XML document identified by URI is not parsed by the signature application unless the URI is a same-document reference or unless a transform that requires XML parsing is applied. (See Transforms (section 4.4.3.4).)

When a fragment is preceded by an absolute or relative URI in the URI-Reference, the meaning of the fragment is defined by the resource's MIME type [ RFC2045 ]. Even for XML documents, URI dereferencing (including the fragment processing) might be done for the signature application by a proxy. Therefore, reference validation might fail if fragment processing is not performed in a standard way (as defined in the following section for same-document references). Consequently, we RECOMMEND in this case that the URI attribute not include fragment identifiers and that such processing be specified as an additional XPath Transform or XPath Filter 2 Transform [ XMLDSIG-XPATH-FILTER2 ].

When a fragment is not preceded by a URI in the URI-Reference, XML Signature applications must support the null URI and shortname XPointer [ XPTR-FRAMEWORK ]. We RECOMMEND support for the same-document XPointers ' #xpointer(/) ' and ' #xpointer(id('ID')) ' if the application also intends to support any canonicalization that preserves comments. (Otherwise URI="#foo" will automatically remove comments before the canonicalization can even be invoked due to the processing defined in Same-Document URI-References (section 4.4.3.3).) All other support for XPointers is optional , especially all support for shortname and other XPointers in external resources since the application may not have control over how the fragment is generated (leading to interoperability problems and validation failures).

' #xpointer(/) ' must be interpreted to identify the root node [ XPATH ] of the document that contains the URI attribute.

' #xpointer(id(' ID ')) ' must be interpreted to identify the element node identified by ' #element( ID ) ' [ XPTR-ELEMENT ] when evaluated with respect to the document that contains the URI attribute.

The original edition of this specification [ XMLDSIG-CORE ] referenced the XPointer Candidate Recommendation [ XPTR-XPOINTER-CR2001 ] and some implementations support it optionally. That Candidate Recommendation has been superseded by the [ XPTR-FRAMEWORK ], [ XPTR-XMLNS ] and [ XPTR-ELEMENT ] Recommendations, and -- at the time of this edition -- the [ XPTR-XPOINTER ] Working Draft. Therefore, the use of the xpointer() scheme [ XPTR-XPOINTER ] beyond the usage discussed in this section is discouraged.

The following examples demonstrate what the URI attribute identifies and how it is dereferenced:

URI="http://example.com/bar.xml": Identifies the octets that represent the external resource 'http://example.com/bar.xml', that is probably an XML document given its file extension.
URI="http://example.com/bar.xml#chapter1": Identifies the element with ID attribute value 'chapter1' of the external XML resource 'http://example.com/bar.xml', provided as an octet stream. Again, for the sake of interoperability, the element identified as 'chapter1' should be obtained using an XPath transform rather than a URI fragment (shortname XPointer resolution in external resources is not required in this specification).
URI="": Identifies the node-set (minus any comment nodes) of the XML resource containing the signature
URI="#chapter1": Identifies a node-set containing the element with ID attribute value 'chapter1' of the XML resource containing the signature. XML Signature (and its applications) modify this node-set to include the element plus all descendants including namespaces and attributes -- but not comments.

4.4.3.4 "Compatibility Mode" Same-Document URI-References

Dereferencing a same-document reference must result in an XPath node-set suitable for use by Canonical XML [ XML-C14N ]. Specifically, dereferencing a null URI ( URI="" ) must result in an XPath node-set that includes every non-comment node of the XML document containing the URI attribute. In a fragment URI, the characters after the number sign ('#') character conform to the XPointer syntax [ XPTR-FRAMEWORK ]. When processing an XPointer, the application must behave as if the XPointer was evaluated with respect to the XML document containing the URI attribute . The application must behave as if the result of XPointer processing [ XPTR-FRAMEWORK ] were a node-set derived from the resultant subresource as follows:

include XPath nodes having full or partial content within the subresource
replace the root node with its children (if it is in the node-set)
replace any element node E with E plus all descendants of E (text, comment, PI, element) and all namespace and attribute nodes of E and its descendant elements.
if the URI has no fragment identifier or the fragment identifier is a shortname XPointer, then delete all comment nodes

The second to last replacement is necessary because XPointer typically indicates a subtree of an XML document's parse tree using just the element node at the root of the subtree, whereas Canonical XML treats a node-set as a set of nodes in which absence of descendant nodes results in absence of their representative text from the canonical form.

The last step is performed for null URIs and shortname XPointers . It is necessary because when [ XML-C14N ] or [ XML-C14N11 ] is passed a node-set, it processes the node-set as is: with or without comments. Only when it is called with an octet stream does it invoke its own XPath expressions (default or without comments). Therefore to retain the default behavior of stripping comments when passed a node-set, they are removed in the last step if the URI is not a scheme-based XPointer. To retain comments while selecting an element by an identifier ID , use the following scheme-based XPointer: URI='#xpointer(id(' ID '))'. To retain comments while selecting the entire document, use the following scheme-based XPointer: URI='#xpointer(/)'.

The interpretation of these XPointers is defined in The Reference Processing Model (section 4.4.3.2).

4.4.3.5 The `Transforms` Element

The optional Transforms element contains an ordered list of Transform elements; these describe how the signer obtained the data object that was digested. Each Transform consists of an Algorithm attribute and content parameters, if any, appropriate for the given algorithm. The Algorithm attribute value specifies the name of the algorithm to be performed, and the Transform content provides additional data to govern the algorithm's processing of the transform input. (See Algorithm Identifiers and Implementation Requirements (section 6).)

If the Transforms element is present and contains exactly one Transform element with an Algorithm of "http://www.w3.org/2010/xmldsig2#newTransformModel", then "2.0 Mode" is used. Otherwise, "Compatibility Mode" is used. The following two sections detail the use of this element in each case.

Schema Definition: <element name="Transforms" type="ds:TransformsType"/> <complexType name="TransformsType"> <sequence> <element ref="ds:Transform" maxOccurs="unbounded"/> </sequence> </complexType> <element name="Transform" type="ds:TransformType"/> <complexType name="TransformType" mixed="true"> <choice minOccurs="0" maxOccurs="unbounded"> <any namespace="##other" processContents="lax"/>  <element name="XPath" type="string"/> </choice> <attribute name="Algorithm" type="anyURI" use="required"/> </complexType>

   Schema Definition:

   <element name="Transforms" type="ds:TransformsType"/>
   <complexType name="TransformsType">
     <sequence>
       <element ref="ds:Transform" maxOccurs="unbounded"/>  
     </sequence>
   </complexType>


   <element name="Transform" type="ds:TransformType"/>
   <complexType name="TransformType" mixed="true">
     <choice minOccurs="0" maxOccurs="unbounded"> 
       <any namespace="##other" processContents="lax"/>
       <!-- (1,1) elements from (0,unbounded) namespaces -->
       <element name="XPath" type="string"/> 
     </choice>
     <attribute name="Algorithm" type="anyURI" use="required"/> 
   </complexType>

4.4.3.6 The "Compatibility Mode" Transforms Processing Model

In this mode, the Transforms element is optional and its presence indicates that the signer is not signing the native (original) document but the resulting (transformed) document. (See Only What is Signed is Secure (section 8.1).)

The output of each Transform serves as input to the next Transform. The input to the first Transform is the result of dereferencing the URI attribute of the Reference element. The output from the last Transform is the input for the DigestMethod algorithm.

As described in The "Compatibility Mode" Reference Processing Model (section 4.4.3.2), some transforms take an XPath node-set as input, while others require an octet stream. If the actual input matches the input needs of the transform, then the transform operates on the unaltered input. If the transform input requirement differs from the format of the actual input, then the input must be converted.

Some Transform s may require explicit MIME type, charset (IANA registered "character set"), or other such information concerning the data they are receiving from an earlier Transform or the source data, although no Transform algorithm specified in this document needs such explicit information. Such data characteristics are provided as parameters to the Transform algorithm and should be described in the specification for the algorithm.

Examples of transforms include but are not limited to base64 decoding [ RFC2045 ], canonicalization [ XML-C14N ], XPath filtering [ XPATH ], and XSLT [ XSLT ]. The generic definition of the Transform element also allows application-specific transform algorithms. For example, the transform could be a decompression routine given by a Java class appearing as a base64 encoded parameter to a Java Transform algorithm. However, applications should refrain from using application-specific transforms if they wish their signatures to be verifiable outside of their application domain. Transform Algorithms (section 6.6) defines the list of standard transformations.

4.4.3.7 The "2.0 Mode" Transforms Processing Model

In "2.0 Mode" signatures, the use of extensible Transform algorithms is replaced with a construct that combines selection of the content to sign, and canonicalization, into a single unit with an extensible syntax for reference and selection processing. This construct is modeled as special Transform, so as not to break existing schema.

This special Transform has an Algorithm of "http://www.w3.org/2010/xmldsig2#newTransformModel". In 2.0 signatures, each Reference must contain the Transforms element, and this must contain just one transform - this one. Legacy implementations will react to this as an undefined Transform algorithm and report failure in the fashion that is normal for them.

The semantics of the "2.0 Mode" Transform are such that its input is determined solely from within the Transform itself rather than via the surrounding Reference element. The output is guaranteed to be an octet stream.

The special Transform element consists of a required dsig2:Selection element followed by an optional CanonicalizationMethod element and an optional dsig2:Verification element.

4.4.3.8 The `dsig2:Selection` Element

The dsig2:Selection element describes the data being signed for a "2.0 Mode" signature reference. The content and processing model for this element depends on the value of the required Type and an optional SubType attributes, which identifies the selection algorithm in use. The other attributes of dsig2:Selection and any subelements are passed in as parameters to the selection processing.

Schema Definition: <xs:element name="Selection" type="dsig2:SelectionType"/> <xs:complexType name="dsig2:SelectionType"> <xs:sequence> <xs:any namespace="##any" minOccurs="0 maxOccurs="unbounded"/> </xs:sequence> <xs:attribute name="URI" type="xs:anyURI" use="required"/> <xs:attribute name="Type" type="xs:anyURI" use="required"/> <xs:attribute name="Subtype" type="xs:string" use="optional"/> </xs:complexType>

  Schema Definition:

  <xs:element name="Selection" type="dsig2:SelectionType"/>
  <xs:complexType name="dsig2:SelectionType">
    <xs:sequence>
      <xs:any namespace="##any" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="URI" type="xs:anyURI" use="required"/>
    <xs:attribute name="Type" type="xs:anyURI" use="required"/>
    <xs:attribute name="Subtype" type="xs:string" use="optional"/>
  </xs:complexType>

The Type (and optionally the SubType ) attribute is an extensibility point and users are allowed to add their own types. Each type/subtype should define the parameters that is expects, how they are laid out inside the Selection element, how to process the Selection, what user defined object does the selection produce, and what canonicalization algorithm to use to canonicalize it into an octet stream.

The following values of Type and SubType are defined by this specification.

Type="...xml" Type="http://www.w3.org/2010/xmldsig2#xml" : Select complete XML documents, or XML fragments.
Type = "...binary" "http://www.w3.org/2010/xmldsig2#binary" and Subtype = "...fromURI" "http://www.w3.org/2010/xmldsig2#fromURI": Select binary data from an external URI.
Type = "...binary" "http://www.w3.org/2010/xmldsig2#binary" and Subtype = "...fromBase64Node" "http://www.w3.org/2010/xmldsig2#fromBase64Node": Select binary data from a base64 encoded text node inside an XML document.

These algorithms are defined in 2.0 Mode Selection Algorithms . Users can define new types, e.g. they can define a "text" type with associated text canonicalization, or they can define a "DataBase rowset" type to sign database content.

The result of processing the dsig2:Selection element must be one of the following:

~~subtress~~ subtrees with optional exclusions. See Subtrees with exclusions
an octet stream.
any user defined object.

In the first case, a canonicalization algorithm compatible with these inputs must be applied to produce an octet stream for the digest algorithm. The contents of the sibling CanonicalizationMethod element, if present, will specify the algorithm to use, and supply any non-default parameters to that algorithm. If no sibling CanonicalizationMethod element is present, then the XML Canonicalization 2.0 Algorithm [ XML-C14N20 ] must be used with no non-default parameters.

For octet stream, no further processing is applied to the resulting octet stream, which will be supplied directly to the digest algorithm.

4.4.3.9 The `dsig2:Verification` element

The dsig2:Verification is an optional element that will contain information to help in signature Verification. It will contain the following subelements, each of which can be present at most once, but in any order.

<dsig2:DigestDataLength> which is an integer that specifies the number of bytes that were digested in this reference. This can be used for multiple purposes, a) to debug digest verification failures, b) to indicate intentional signing of 0 bytes, this can happen if an XPath expression did not choose anything, c) to bypass the expensive digest calculation if the during verification the computed length doesn't match length found in reference.
<dsig2:PositionAssertion> is used to enable ID-based referencing that is more resistant to signature wrapping attacks. It contains an XPath expression that has to match the referenced content's position in the document. This way, instead of "selecting" the referenced element via XPath we just "verify" its position (which then is way more flexible in terms of what is really enforced), but stick to ID-based referencing in selection.
<dsig2:IDAttributes> is used for ID-based references to precisely define the ID attribute that the signer has used for a particular reference. It can have one of the following two subelements:
- <dsig2:QualifiedID name="..." ns="..."/> to define a namespace qualified ID attributes. The localname and the namespace URI of the ID attribute needs to be specified.
- <dsig2:UnqualifiedID name="..." parentname="..." parentns="..."/> to define unqualified ID attributes. This needs the localname of the ID attribute, the localname of the owner element (i.e. the element that is the parent of the ID attribute) and the namespace URI of the owner element.
Without a DTD, there is technically no way to define IDness in an XML document. In practice, this typing was extended to documents validated by an XML Schema, and then to the creation of xml:id. Unfortunately, DTDs have mostly fallen out of practice, and schemas are expensive, rarely used in many runtime scenarios, and can't be counted in to be completely known by the verifying entity in the presence of extensible XML scenarios.
xml:id has not seen wide adoption yet, mainly because a lot of the standards that needed it (SAML, WS-Security) predated it.
The result of all this is that applications that rely on ID-based references for signing have typically made insecure assumptions about the IDness of attributes based on their name ( ID,id,Id, etc.), or have to provide APIs for applications to call before verification (which is also a problem for extensibility). DOM level 3, which is now fairly widely implemented, also provides the ability to identify attributes as an ID at runtime, although often without guaranteeing the uniqueness property.
This <dsig2:IDAttributes> element provides a deterministic way of defining the ID, that is independent of DTD, XML Schema, DOM 3 or any application specific mechanism.

Verification of the


<dsig2:Verification>

element by validators is optional, even if the element is present. For example validators can ignore the


<dsig2:PositionAssertion>

, and just rely on ID-based referencing (with the risk of being vulnerable to signature wrapping attacks) for simplicity.

4.4.3.10 Subtrees with optional exclusions in 2.0 mode

~~Signture~~ Signature 2.0 does not use an XPath nodeset to represent an XML fragment to be signed. Instead it uses the following concept:

The xml fragment to be signed is represented as one or more inclusion subtrees, and a set of zero or more exclusions consisting of subtrees and/or attribute nodes.
Exclusions override inclusions, i.e. the selection ~~constains~~ constrains all the nodes in the inclusion subtrees minus all the nodes in the exclusion subtrees.
A "subtree" is a part of the xml document, consisting of all the descendants of an particular element node, or the document root node. The subtree is ~~identfied~~ identified by the element node/document root node.
If in the inclusion list, one subtree is included in another one, the included one is effectively ignored.
Each subtree (except when the subtree is the complete document), should have this additional information:
- The list of namespace declarations in context, i.e. inherited from the ancestors of this subtree.
- The inherited value of the xml:space attribute.
- The inherited value of the xml:base attribute. If there are multiple ancestor elements having xml:base they need to be combined together.
The last two are only required if the canonicalization requires them.

4.4.3.10 4.4.3.11 The `URI` Attribute for `Selection` in 2.0 mode

In "2.0 Mode", the URI attribute must be omitted in Reference and be present in the Selection.

The Selection 's URI attribute is a a slightly simplified version of the Reference 's URI

Dereferencing is carried out in the context of the Selection, i.e if the Type is "...xml "http://www.w3.org/2010/xmldsig2#xml", then the URI is dereferenced and then parsed into an XML document, whereas if the Type is "...binary" "http://www.w3.org/2010/xmldsig2#binary" and SubType is "...fromURI" "http://www.w3.org/2010/xmldsig2#fromURI" then the URI is dererefenced as an octet stream. Other user defined Type can specify different dereferencing mechanisms.
Dereferencing a same-document reference does not result in a XPath node set. As mentioned in the previous bullet, referencing is in the context of the Selection.
- In Type="...xml" Type="http://www.w3.org/2010/xmldsig2#xml" same document reference results in the entire document if URI="" or in a subtree is the URI refers to a fragment.
- In Type="...binary" Type="http://www.w3.org/2010/xmldsig2#binary" and SubType="...fromURI" SubType="http://www.w3.org/2010/xmldsig2#fromURI", same document references are not allowed.
- In Type="...binary" Type="http://www.w3.org/2010/xmldsig2#binary" and SubType="...fromBase64Node" SubType="http://www.w3.org/2010/xmldsig2#fromBase64Node", same document references result in a subtree.
xpointer URIs are not supported.
There is no comment removal during URI dereferencing.

4.4.3.11 4.4.3.12 XPaths in 2.0 mode

The XPath mentioned in the IncludedXPath and ExcludedXPath are "normal" XPath, i.e. it is not like the XPath in XPath Filter transform which is evaluated as a binary expression. Instead this XPath is a path to the root of the subtree being included or excluded. E.g. /book/chapter refers to the all chapter children of all book children of root node. The IncludedXPath element should only select element nodes, whereas the ExcludedXPath element can choose element or attribute nodes. Again this is consistent with the C14N 2.0 data model.

We have identified a profile of XPath, with the following goals in mind. The profile should produce results that are compatible with the C14N 2.0 data model. I.e it should only result in element nodes or attribute nodes (but not xml: attribute and namespace attributes). It should possible to execute this XPath in a streamable XPath implementation. The capabilities of various streamable XPath implementations vary. Some XPaths cans be executed by even the most rudimentary streaming XPath implementations e.g. /book/chapter , whereas some can be executed by none of them e.g. child::para[position()=last()-1] . Streaming XPath implementation by definition do a forward only pass over the document, so knowing that a particular element's position is last but one, requires it to reach the end and then backtrack. Streaming parsers read the document one "event" at a time. Usually the entire element tag including all the attributes are read in a single event, however text nodes can are often split up into separate events because some text nodes can be very large. So any XPath that requires comparison of text node value may not work in streaming XPath implementations. This XPath subset should include some of the known usages of XPath in XML Signatures. ebXML messages require a signature to exclude elements whose @SOAP:actor attribute matches a certain value. Refer section 4.1.3 of [[!EBXML-MSG"]] UK government specification requires signature to include the GovTalkMessage/Body subtree, but exclude the GovTalkMessage/Body/IRevenvelope/IRHeader/IRmark subtree. [[!HMRMC"]] This ~~subset can be expressed precisely using the following grammar, which is still under development. Streamable~~ XPath subset Grammar Explanation [0a] IncludedXPath ::= ( LocationPath '|' )* LocationPath [0b] ExcludedXPath ::= ( LocationPath '|' )* LocationPath The Included and Excluded Xpath do not use the generic XPath Expr. Instead they are just a union of LocationPath. There is a slight difference between IncludedXPath and ExcludedXPath, ExcludedXpath can select attributes and element, whereas IncludedXPath can only select elements. [1] LocationPath ::= RelativeLocationPath | AbsoluteLocationPath [2] AbsoluteLocationPath ::= '/' RelativeLocationPath? | AbbreviatedAbsoluteLocationPath [3] RelativeLocationPath ::= Step | RelativeLocationPath '/' Step ( StepNoPredicate '/')* Step | AbbreviatedRelativeLocationPath RelativeLocationPath is not allowed, only Absolute is allowed. This is because if you use relative, it would probably mean relative to the <Signature> element, and then you would have to support the ancestor axis to reach the other nodes, but that axis is not streamable. Only the last Step can have a predicate. So I have created a non-terminal "StepNoPredicate" [4] Step ::= AxisSpecifier NodeTest Predicate* | AbbreviatedStep [4a] StepNoPredicate ::= AxisSpecifier NodeTest | AbbreviatedStep [4b] StepAttributeOnly ::= 'attribute' '::' NameTest | '@' '::' NameTest Added two new versions of Step. One is a Step with no Predicate, and the other is a step attribute only e.g. in this XPath expression: /doc/chapter[@type="warning"] /doc is StepNoPredicate chapter[@type="warning"] is Step @type is StepAttributeOnly [5] AxisSpecifier ::= AxisName '::' | AbbreviatedAxisSpecifier unchanged [6] AxisName ::= 'ancestor' | 'ancestor-or-self' | 'attribute' | 'child' | 'descendant' | 'descendant-or-self' | 'following' | 'following-sibling' | 'namespace' | 'parent' | 'preceding' | 'preceding-sibling' | 'self' All the non streamable axes have been removed - ancestor, ancestor-or-self, following, following-sibling, namespace, parent, preceding, preceding-sibling [7] NodeTest ::= NameTest | NodeType '(' ')' | 'processing-instruction' '(' Literal ')' processing instruction test is not allowed. only the node() node test is allowed, not comment() , text() and processing-instruction() [8] Predicate ::= '[' PredicateExpr ']' [9] PredicateExpr ::= Expr unchanged but the definition of Expr has changed, so it is only a additive/relative expressions of StepAttributeOnly and Literals. [10] AbbreviatedAbsoluteLocationPath ::= '//' RelativeLocationPath [11] AbbreviatedRelativeLocationPath ::= RelativeLocationPath '//' Step [12] AbbreviatedStep ::= '.' | '..' [13] AbbreviatedAxisSpecifier ::= '@'? unchanged [14] Expr ::= OrExpr [15] PrimaryExpr ::= VariableReference | '(' Expr ')' | Literal | Number | FunctionCall unchanged [16] FunctionCall ::= FunctionName '(' ( Argument ( ',' Argument )* )? ')' [17] Argument ::= Expr unchanged [18] UnionExpr ::= PathExpr | UnionExpr '|' PathExpr [19] PathExpr ::= LocationPath | FilterExpr | FilterExpr '/' RelativeLocationPath | FilterExpr '//' RelativeLocationPath [20] FilterExpr ::= PrimaryExpr | FilterExpr Predicate UnionExpr, PathExpr and FilterExpr have been removed. [21] OrExpr ::= AndExpr | OrExpr 'or' AndExpr [22] AndExpr ::= EqualityExpr | AndExpr 'and' EqualityExpr [23] EqualityExpr ::= RelationalExpr | EqualityExpr '=' RelationalExpr | EqualityExpr '!=' RelationalExpr [24] RelationalExpr ::= AdditiveExpr | RelationalExpr '<' AdditiveExpr | RelationalExpr '>' AdditiveExpr | RelationalExpr '<=' AdditiveExpr | RelationalExpr '>=' AdditiveExpr unchanged [25] AdditiveExpr ::= MultiplicativeExpr | AdditiveExpr '+' MultiplicativeExpr | AdditiveExpr '-' MultiplicativeExpr [26] MultiplicativeExpr ::= UnaryExpr | MultiplicativeExpr MultiplyOperator UnaryExpr | MultiplicativeExpr 'div' UnaryExpr | MultiplicativeExpr 'mod' UnaryExpr [27] UnaryExpr ::= UnionExpr PrimaryExpr | StepAttributeOnly | '-' UnaryExpr The unaryExpr is changed to only allow a PrimaryExpr or StepAttributeOnly [28] ExprToken ::= '(' | ')' | '[' | ']' | '.' | '..' | '@' | ',' | '::' | NameTest | NodeType | Operator | FunctionName | AxisName | Literal | Number | VariableReference [29] Literal ::= '"' [^"]* '"' | "'" [^']* "'" [30] Number ::= Digits ('.' Digits?)? | '.' Digits [31] Digits ::= [0-9]+ [32] Operator ::= OperatorName | MultiplyOperator | '/' | '//' | '|' | '+' | '-' | '=' | '!=' | '<' | '<=' | '>' | '>=' [33] OperatorName ::= 'and' | 'or' | 'mod' | 'div' [34] MultiplyOperator ::= '*' [35] FunctionName ::= QName - NodeType [36] VariableReference ::= '$' QName [37] NameTest ::= '*' | NCName ':' '*' | QName [38] NodeType ::= 'comment' | 'text' | 'processing-instruction' | 'node' [39] ExprWhitespace ::= S unchanged, expect for the NodeTest Node set functions last() position() count(nodeset) id() local-name(nodeset) namespace-uri(nodeset) name(nodeset) String functions string(object) concat(string, string, string*) starts-with(string, string) contains(string, string) substring-before(string, string) substring-after(string, string) substring(string, number, number) string-length(string?) normalize-space(string?) Boolean functions boolean(object) true() false() lang(string) Number functions number(object?) sum(node-set) floor(number) ceiling(number) round(number) Note: As mentioned before, only the last Step can have a Predicate, and this predicate's expression can only involve attribute nodes of the current element. Functions can only be used inside this last step's predicate, and this function can only accept a single attribute as an argument. There profile is ~~no way to use element names, text nodes, comments and processing instructions~~ defined in functions. The "string-value" become just the attributes value. All functions involving context position and context size are not supported i.e.. last, position, count or their shortcut versions e.g. foo[1]. the streaming parser cannot maintain counts. String, number and boolean functions are all supported. Here is an algorithm for Streaming XPath. For simplicity this algorithm assumes that excludedXPath is not present: For parsing: Split up the union expression by "|" . i.e. break up the locationPath | locationPath | .. into individual location paths. Split up each location paths to get individual steps and the final predicate. i.e. break up the / step / step / step .. / step [ predicate ] to get the steps and optional predicate. Two slashes together indicates descendant axis. The predicate will have an expression involving attribute names e.g. @a = "foo" and @b > "bar" You need to have an expression parsing and evaluating engine to do this. For executing: A streaming XML Parser (e.g. StAX), reads an XML document and produces "events" like StartElement, EndElement, TextNode etc. At any point this parser only remembers the current node. If the current node is an start element, then it also reads all the attributes for that element. To execute a streaming XPath you maintain a stack of ancestor element names, i.e whenever you get a StartElement tag, you need to push the element QName onto this stack, and when you get an EndElement tag you need to pop it off. As you stream through the nodes, you need to execute this XPath expression for every node. I.e. utilize the current element, the current element's attributes and the stack of ancestors to evaluate the XPath expression. XMLDSIG-XPATH For each locationPath , match up the step s to the ancestor stack, If they match, evaluate the predicate with the current element's expression. If that passes too, this element and all its descendants are included. ].

4.4.3.12 4.4.3.13 The `DigestMethod` Element

DigestMethod is a required element that identifies the digest algorithm to be applied to the signed object. This element uses the general structure here for algorithms specified in Algorithm Identifiers and Implementation Requirements (section 6.1).

For "Compatibility Mode" signatures, if the result of the URI dereference and application of Transforms is an XPath node-set (or sufficiently functional replacement implemented by the application) then it must be converted as described in the "Compatibility Mode" Reference Processing Model (section 4.4.3.2). If the result of URI dereference and application of transforms is an octet stream, then no conversion occurs (comments might be present if the Canonical XML with Comments was specified in the Transforms). The digest algorithm is applied to the data octets of the resulting octet stream.

For "2.0 Mode" signatures, the result of processing the Reference is an octet stream, and the digest algorithm is applied to the resulting data octets.

Schema Definition: <element name="DigestMethod" type="ds:DigestMethodType"/> <complexType name="DigestMethodType" mixed="true"> <sequence> <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </sequence> <attribute name="Algorithm" type="anyURI" use="required"/> </complexType>

   Schema Definition:

   <element name="DigestMethod" type="ds:DigestMethodType"/>
   <complexType name="DigestMethodType" mixed="true"> 
     <sequence>
       <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
     </sequence>    
     <attribute name="Algorithm" type="anyURI" use="required"/> 
   </complexType>

4.4.3.13 4.4.3.14 The `DigestValue` Element

DigestValue is an element that contains the encoded value of the digest. The digest is always encoded using base64 [ RFC2045 ].

~~Schema Definition: <element name="DigestValue" type="ds:DigestValueType"/> <simpleType name="DigestValueType"> <restriction base="base64Binary"/> </simpleType>~~

   Schema Definition:

   <element name="DigestValue" type="ds:DigestValueType"/>
   <simpleType name="DigestValueType">
     <restriction base="base64Binary"/>
   </simpleType>

4.5 The `KeyInfo` Element

KeyInfo is an optional element that enables the recipient(s) to obtain the key needed to validate the signature. KeyInfo may contain keys, names, certificates and other public key management information, such as in-band key distribution or key agreement data. This specification defines a few simple types but applications may extend those types or all together replace them with their own key identification and exchange semantics using the XML namespace facility [ XML-NAMES ]. However, questions of trust of such key information (e.g., its authenticity or strength) are out of scope of this specification and left to the application.

If KeyInfo is omitted, the recipient is expected to be able to identify the key based on application context. Multiple declarations within KeyInfo refer to the same key. While applications may define and use any mechanism they choose through inclusion of elements from a different namespace, compliant versions must implement KeyValue (section 4.5.2) and should implement RetrievalMethod (section 4.5.3).

The schema specification of many of KeyInfo 's children (e.g., PGPData, SPKIData, X509Data ) permit their content to be extended/complemented with elements from another namespace. This may be done only if it is safe to ignore these extension elements while claiming support for the types defined in this specification. Otherwise, external elements, including alternative structures to those defined by this specification, must be a child of KeyInfo. For example, should a complete XML-PGP standard be defined, its root element must be a child of KeyInfo. (Of course, new structures from external namespaces can incorporate elements from the dsig: namespace via features of the type definition language. For instance, they can create a schema that permits, includes, imports, or derives new types based on dsig: elements.)

The following list summarizes the KeyInfo types that are allocated an identifier in the dsig: namespace; these can be used within the RetrievalMethod Type attribute to describe a remote KeyInfo structure.

The following list summarizes the additional KeyInfo types that are allocated an identifier in the dsig11: namespace.

In addition to the types above for which we define an XML structure, we specify one additional type to indicate a binary (ASN.1 DER) X.509 Certificate .

http://www.w3.org/2000/09/xmldsig#rawX509Certificate

Schema Definition: <element name="KeyInfo" type="ds:KeyInfoType"/> <complexType name="KeyInfoType" mixed="true"> <choice maxOccurs="unbounded"> <element ref="ds:KeyName"/> <element ref="ds:KeyValue"/> <element ref="ds:RetrievalMethod"/> <element ref="ds:X509Data"/> <element ref="ds:PGPData"/> <element ref="ds:SPKIData"/> <element ref="ds:MgmtData"/>         <any processContents="lax" namespace="##other"/>  </choice> <attribute name="Id" type="ID" use="optional"/> </complexType>

   Schema Definition:

   <element name="KeyInfo" type="ds:KeyInfoType"/> 
   <complexType name="KeyInfoType" mixed="true">
     <choice maxOccurs="unbounded">     
       <element ref="ds:KeyName"/> 
       <element ref="ds:KeyValue"/> 
       <element ref="ds:RetrievalMethod"/> 
       <element ref="ds:X509Data"/> 
       <element ref="ds:PGPData"/> 
       <element ref="ds:SPKIData"/>
       <element ref="ds:MgmtData"/>
       <!-- <element ref="dsig11:DEREncodedKeyValue"/> -->
       <!-- DEREncodedKeyValue (XMLDsig 1.1) will use the any element -->
       <!-- <element ref="dsig11:KeyInfoReference"/> -->
       <!-- KeyInfoReference (XMLDsig 1.1) will use the any element -->
       <!-- <element ref="xenc:EncryptedKey"/> -->
       <!-- EncryptedKey (XMLEnc) will use the any element -->
       <!-- <element ref="xenc:Agreement"/> -->
       <!-- Agreement (XMLEnc) will use the any element -->
       <any processContents="lax" namespace="##other"/>
       <!-- (1,1) elements from (0,unbounded) namespaces -->
     </choice>
     <attribute name="Id" type="ID" use="optional"/>
   </complexType>

4.5.1 The `KeyName` Element

The KeyName element contains a string value (in which white space is significant) which may be used by the signer to communicate a key identifier to the recipient. Typically, KeyName contains an identifier related to the key pair used to sign the message, but it may contain other protocol-related information that indirectly identifies a key pair. (Common uses of KeyName include simple string names for keys, a key index, a distinguished name (DN), an email address, etc.)

~~Schema Definition: <element name="KeyName" type="string"/>~~

   Schema Definition:

   <element name="KeyName" type="string"/>

4.5.2 The `KeyValue` Element

The KeyValue element contains a single public key that may be useful in validating the signature. Structured formats for defining DSA ( required ), RSA ( required ) and ECDSA ( required ) public keys are defined in Signature Algorithms (section 6.4). The KeyValue element may include externally defined public keys values represented as PCDATA or element types from an external namespace.

Schema Definition: <element name="KeyValue" type="ds:KeyValueType"/> <complexType name="KeyValueType" mixed="true"> <choice> <element ref="ds:DSAKeyValue"/> <element ref="ds:RSAKeyValue"/>   <any namespace="##other" processContents="lax"/> </choice> </complexType>

   Schema Definition:

   <element name="KeyValue" type="ds:KeyValueType"/> 
   <complexType name="KeyValueType" mixed="true">
    <choice>
      <element ref="ds:DSAKeyValue"/>
      <element ref="ds:RSAKeyValue"/>
      <!-- <element ref="dsig11:ECKeyValue"/> -->
      <!-- ECC keys (XMLDsig 1.1) will use the any element -->
      <any namespace="##other" processContents="lax"/>
    </choice>
   </complexType>

4.5.2.1 The `DSAKeyValue` Element

Identifier: Type=" http://www.w3.org/2000/09/xmldsig#DSAKeyValue " (this can be used within a RetrievalMethod or Reference element to identify the referent's type)

DSA keys and the DSA signature algorithm are specified in [ FIPS-186-3 ]. DSA public key values can have the following fields:

P: a prime modulus meeting the [ FIPS-186-3 ] requirements
Q: an integer in the range 2**159 < Q < 2**160 which is a prime divisor of P-1
G: an integer with certain properties with respect to P and Q
Y: G**X mod P (where X is part of the private key and not made public)
J: (P - 1) / Q
seed: a DSA prime generation seed
pgenCounter: a DSA prime generation counter

Parameter J is available for inclusion solely for efficiency as it is calculatable from P and Q. Parameters seed and pgenCounter are used in the DSA prime number generation algorithm specified in [ FIPS-186-3 ]. As such, they are optional but must either both be present or both be absent. This prime generation algorithm is designed to provide assurance that a weak prime is not being used and it yields a P and Q value. Parameters P, Q, and G can be public and common to a group of users. They might be known from application context. As such, they are optional but P and Q must either both appear or both be absent. If all of P, Q, seed, and pgenCounter are present, implementations are not required to check if they are consistent and are free to use either P and Q or seed and pgenCounter. All parameters are encoded as base64 [ RFC2045 ] values.

Arbitrary-length integers (e.g. "bignums" such as RSA moduli) are represented in XML as octet strings as defined by the ds:CryptoBinary type .

   Schema Definition:

   <element name="DSAKeyValue" type="ds:DSAKeyValueType"/> 
   <complexType name="DSAKeyValueType"> 
     <sequence>
       <sequence minOccurs="0">
         <element name="P" type="ds:CryptoBinary"/> 
         <element name="Q" type="ds:CryptoBinary"/>
       </sequence>
       <element name="G" type="ds:CryptoBinary" minOccurs="0"/> 
       <element name="Y" type="ds:CryptoBinary"/> 
       <element name="J" type="ds:CryptoBinary" minOccurs="0"/>
       <sequence minOccurs="0">
         <element name="Seed" type="ds:CryptoBinary"/> 
         <element name="PgenCounter" type="ds:CryptoBinary"/> 
       </sequence>
     </sequence>
   </complexType>

4.5.2.2 The `RSAKeyValue` Element

Identifier: Type=" http://www.w3.org/2000/09/xmldsig#RSAKeyValue " (this can be used within a RetrievalMethod or Reference element to identify the referent's type)

RSA key values have two fields: Modulus and Exponent.

<RSAKeyValue> <Modulus>xA7SEU+e0yQH5rm9kbCDN9o3aPIo7HbP7tX6WOocLZAtNfyxSZDU16ksL6W jubafOqNEpcwR3RdFsT7bCqnXPBe5ELh5u4VEy19MzxkXRgrMvavzyBpVRgBUwUlV 5foK5hhmbktQhyNdy/6LpQRhDUDsTvK+g9Ucj47es9AQJ3U= </Modulus> <Exponent>AQAB</Exponent> </RSAKeyValue>

<RSAKeyValue>
  <Modulus>xA7SEU+e0yQH5rm9kbCDN9o3aPIo7HbP7tX6WOocLZAtNfyxSZDU16ksL6W
   jubafOqNEpcwR3RdFsT7bCqnXPBe5ELh5u4VEy19MzxkXRgrMvavzyBpVRgBUwUlV
   5foK5hhmbktQhyNdy/6LpQRhDUDsTvK+g9Ucj47es9AQJ3U=
  </Modulus>
  <Exponent>AQAB</Exponent>

</RSAKeyValue>

Arbitrary-length integers (e.g. "bignums" such as RSA moduli) are represented in XML as octet strings as defined by the ds:CryptoBinary type .

   Schema Definition:

   <element name="RSAKeyValue" type="ds:RSAKeyValueType"/>
   <complexType name="RSAKeyValueType">
     <sequence>
       <element name="Modulus" type="ds:CryptoBinary"/> 
       <element name="Exponent" type="ds:CryptoBinary"/>
     </sequence>
   </complexType>

4.5.2.3 The `ECKeyValue` Element

Identifier: Type=" http://www.w3.org/2009/xmldsig11#ECKeyValue " (this can be used within a RetrievalMethod or Reference element to identify the referent's type)

The ECPublicKey element is defined in the http://www.w3.org/2009/xmldsig11# namespace.

EC public key values consists of two sub components: Domain parameters and PublicKey.

<ECKeyValue xmlns="http://www.w3.org/2009/xmldsig11#"> <NamedCurve URI="urn:oid:1.2.840.10045.3.1.7" /> <PublicKey> vWccUP6Jp3pcaMCGIcAh3YOev4gaa2ukOANC7Ufg Cf8KDO7AtTOsGJK7/TA8IC3vZoCy9I5oPjRhyTBulBnj7Y </PublicKey> </ECKeyValue>

<ECKeyValue xmlns="http://www.w3.org/2009/xmldsig11#">
  <NamedCurve URI="urn:oid:1.2.840.10045.3.1.7" />
  <PublicKey>
     vWccUP6Jp3pcaMCGIcAh3YOev4gaa2ukOANC7Ufg
Cf8KDO7AtTOsGJK7/TA8IC3vZoCy9I5oPjRhyTBulBnj7Y
  </PublicKey>

</ECKeyValue>

Note - A line break has been added to the PublicKey content to preserve printed page width.

Domain parameters can be encoded explicitly using the ECParameters element or by reference using the NamedCurve element. A named curve is specified through the URN URI attribute. For named curves that are identified by OIDs, such as those defined in [ RFC3279 ][ RFC4055 ], and [ SECG1 ], the OID should be encoded according to [ URN-OID ]. Conformant applications must support the NamedCurve element and the 256-bit prime field curve as identified by the OID 1.2.840.10045.3.1.7.

The PublicKey element contains a Base64 encoding of a binary representation of the x and y coordinates of the point. Its value is computed as follows:

Convert the elliptic curve point (x,y) to an octet string as specified in Section 2.3.3 of [ SECG1 ]. Support for Elliptic-Curve-Point-to-Octet-String conversion without point compression is required .
Base64 encode the octet string resulting from the conversion in Step 1.

<element name="ECKeyValue" type="dsig11:ECKeyValueType"/> <complexType name="ECKeyValueType"> <sequence> <choice> <element name="ECParameters" type="dsig11:ECParametersType"/> <element name="NamedCurve" type="dsig11:NamedCurveType"/> </choice> <element name="PublicKey" type="dsig11:ECPointType"/> </sequence> <attribute name="Id" type="ID" use="optional"/> </complexType> <complexType name="NamedCurveType"> <attribute name="URI" type="anyURI" use="required"/> </complexType> <simpleType name="ECPointType"> <restriction base="ds:CryptoBinary"/> </simpleType>

    Schema Definition:
    
    <!-- targetNamespace="http://www.w3.org/2009/xmldsig11#" -->

    
    <element name="ECKeyValue" type="dsig11:ECKeyValueType"/>
    <complexType name="ECKeyValueType">
      <sequence>
        <choice>
          <element name="ECParameters" type="dsig11:ECParametersType"/>
          <element name="NamedCurve" type="dsig11:NamedCurveType"/>
        </choice>
        <element name="PublicKey" type="dsig11:ECPointType"/>
      </sequence>
      <attribute name="Id" type="ID" use="optional"/>
    </complexType>

    
    <complexType name="NamedCurveType">
      <attribute name="URI" type="anyURI" use="required"/>
    </complexType>

      
    <simpleType name="ECPointType">
      <restriction base="ds:CryptoBinary"/>
    </simpleType>

4.5.2.3.1 Explicit Curve Parameters

The ECParameters element consists of the following subelements. Note these definitions are based on the those described in [ RFC3279 ].

The FieldID element identifies the finite field over which the elliptic curve is defined. Additional details on the structures for defining prime and characteristic two fields is provided below.
The Curve element specifies the coefficients a and b of the elliptic curve E. Each coefficient is first converted from a field element to an octet string as specified in section 2.3.5 of [ SECG1 ], then the resultant octet string is encoded in base64.
The Base element specifies the base point P on the elliptic curve. The base point is represented as a value of type ECPointType.
The Order element specifies the order n of the base point and is encoded as a positiveInteger.
The Cofactor element is an optional element that specifies the integer h = #E(Fq)/n. The cofactor is not required to support ECDSA, except in parameter validation. The cofactor may be included to support parameter validation for ECDSA keys. Parameter validation is not required by this specification. The cofactor is required in ECDH public key parameters.
The ValidationData element is an optional element that specifies the hash algorithm used to generate the elliptic curve E and the base point G verifiably at random. It also specifies the seed that was used to generate the curve and the base point. When verifiably random curves and base points are used, they shall be generated as described in Section 3.1.3 of [ SECG1 ].

<complexType name="ECParametersType"> <sequence> <element name="FieldID" type="dsig11:FieldIDType"/> <element name="Curve" type="dsig11:CurveType"/> <element name="Base" type="dsig11:ECPointType"/> <element name="Order" type="ds:CryptoBinary"/> <element name="CoFactor" type="integer" minOccurs="0"/> <element name="ValidationData" type="dsig11:ECValidationDataType" minOccurs="0"/> </sequence> </complexType> <complexType name="FieldIDType"> <choice> <element ref="dsig11:Prime"/> <element ref="dsig11:TnB"/> <element ref="dsig11:PnB"/> <element ref="dsig11:GnB"/> <any namespace="##other" processContents="lax"/> </choice> </complexType> <complexType name="CurveType"> <sequence> <element name="A" type="ds:CryptoBinary"/> <element name="B" type="ds:CryptoBinary"/> </sequence> </complexType> <complexType name="ECValidationDataType"> <sequence> <element name="seed" type="ds:CryptoBinary"/> </sequence> <attribute name="hashAlgorithm" type="anyURI" use="required"/> </complexType>

Schema Definition:
  
    <!-- targetNamespace="http://www.w3.org/2009/xmldsig11#" -->


    <complexType name="ECParametersType">
      <sequence>
        <element name="FieldID" type="dsig11:FieldIDType"/>
        <element name="Curve" type="dsig11:CurveType"/>
        <element name="Base" type="dsig11:ECPointType"/>
        <element name="Order" type="ds:CryptoBinary"/>
        <element name="CoFactor" type="integer" minOccurs="0"/>
        <element name="ValidationData" type="dsig11:ECValidationDataType" minOccurs="0"/>
      </sequence>
    </complexType>

    
    <complexType name="FieldIDType">
      <choice>
        <element ref="dsig11:Prime"/>
        <element ref="dsig11:TnB"/>
        <element ref="dsig11:PnB"/>
        <element ref="dsig11:GnB"/>
        <any namespace="##other" processContents="lax"/>
      </choice>
    </complexType>


    <complexType name="CurveType">
      <sequence>
        <element name="A" type="ds:CryptoBinary"/>
        <element name="B" type="ds:CryptoBinary"/>
      </sequence>
    </complexType>


  <complexType name="ECValidationDataType">
    <sequence>
      <element name="seed" type="ds:CryptoBinary"/>
    </sequence>
    <attribute name="hashAlgorithm" type="anyURI" use="required"/>
  </complexType>

Prime fields are described by a single subelement P, which represents the field size in bits. It is encoded as a positiveInteger.

<element name="Prime" type="dsig11:PrimeFieldParamsType"/> <complexType name="PrimeFieldParamsType"> <sequence> <element name="P" type="ds:CryptoBinary"/> </sequence> </complexType>

Schema Definition:
  
   <!-- targetNamespace="http://www.w3.org/2009/xmldsig11#" -->

  
    <element name="Prime" type="dsig11:PrimeFieldParamsType"/>
    <complexType name="PrimeFieldParamsType">
      <sequence>
        <element name="P" type="ds:CryptoBinary"/>
      </sequence>
    </complexType>

Structures are defined for three types of characteristic two fields: gaussian normal basis, pentanomial basis and trinomial basis.

<element name="GnB" type="dsig11:CharTwoFieldParamsType"/> <complexType name="CharTwoFieldParamsType"> <sequence> <element name="M" type="positiveInteger"/> </sequence> </complexType> <element name="TnB" type="dsig11:TnBFieldParamsType"/> <complexType name="TnBFieldParamsType"> <complexContent> <extension base="dsig11:CharTwoFieldParamsType"> <sequence> <element name="K" type="positiveInteger"/> </sequence> </extension> </complexContent> </complexType> <element name="PnB" type="dsig11:PnBFieldParamsType"/> <complexType name="PnBFieldParamsType"> <complexContent> <extension base="dsig11:CharTwoFieldParamsType"> <sequence> <element name="K1" type="positiveInteger"/> <element name="K2" type="positiveInteger"/> <element name="K3" type="positiveInteger"/> </sequence> </extension> </complexContent> </complexType>

Schema Definition:
  
   <!-- targetNamespace="http://www.w3.org/2009/xmldsig11#" -->

  
    <element name="GnB" type="dsig11:CharTwoFieldParamsType"/>
    <complexType name="CharTwoFieldParamsType">
      <sequence>
        <element name="M" type="positiveInteger"/>
      </sequence>
    </complexType>

    
    <element name="TnB" type="dsig11:TnBFieldParamsType"/>
    <complexType name="TnBFieldParamsType">
      <complexContent>
        <extension base="dsig11:CharTwoFieldParamsType">
          <sequence>
            <element name="K" type="positiveInteger"/>
          </sequence>
        </extension>
      </complexContent>
    </complexType>


    <element name="PnB" type="dsig11:PnBFieldParamsType"/>
    <complexType name="PnBFieldParamsType">
      <complexContent>
        <extension base="dsig11:CharTwoFieldParamsType">
          <sequence>
            <element name="K1" type="positiveInteger"/>
            <element name="K2" type="positiveInteger"/>
            <element name="K3" type="positiveInteger"/>
          </sequence>
        </extension>
      </complexContent>
    </complexType>

4.5.2.3.2 Compatibility with RFC 4050

Implementations that need to support the [ RFC4050 ] format for ECDSA keys can avoid known interoperability problems with that specification by adhering to the following profile:

Avoid validating the ECDSAKeyValue element against the [ RFC4050 ] schema. XML schema validators may not support integer types with decimal data exceeding 18 decimal digits. [ XMLSCHEMA-1 ][ XMLSCHEMA-2 ].
Support only the NamedCurve element.
Support the 256-bit prime field curve, as identified by the URN urn:oid:1.2.840.10045.3.1.7.

The following is an example of a ECDSAKeyValue element that meets the profile described in this section.

<ECDSAKeyValue xmlns="http://www.w3.org/2001/04/xmldsig-more#">
  <DomainParameters>
    <NamedCurve URN="urn:oid:1.2.840.10045.3.1.7" />
  </DomainParameters>
  <PublicKey>
      <X Value="5851106065380174439324917904648283332
0204931884267326155134056258624064349885">
      <Y Value="1024033521368277752409102672177795083
59028642524881540878079119895764161434936">
  </PublicKey>

</ECDSAKeyValue>

Note - A line break has been added to the X and Y Value attribute values to preserve printed page width.

4.5.3 The `RetrievalMethod` Element

A RetrievalMethod element within KeyInfo is used to convey a reference to KeyInfo information that is stored at another location. For example, several signatures in a document might use a key verified by an X.509v3 certificate chain appearing once in the document or remotely outside the document; each signature's KeyInfo can reference this chain using a single RetrievalMethod element instead of including the entire chain with a sequence of X509Certificate elements.

RetrievalMethod uses the same syntax and dereferencing behavior as Reference 's URI (section 4.4.3.1) and The Reference Processing Model (section 4.4.3.2) except that there are no DigestMethod or DigestValue child elements and presence of the URI attribute is mandatory.

Type is an optional identifier for the type of data retrieved after all transforms have been applied. The result of dereferencing a RetrievalMethod Reference for all KeyInfo types defined by this specification (section 4.5) with a corresponding XML structure is an XML element or document with that element as the root. The rawX509Certificate KeyInfo (for which there is no XML structure) returns a binary X509 certificate.

Note that when referencing one of the defined KeyInfo types within the same document, or some remote documents, at least one Transform is required to turn an ID-based reference to a KeyInfo element into a child element located inside it. This is due to the lack of an XML ID attribute on the defined KeyInfo types.

Transforms in RetrievalMethod are more attack prone, since they need to be evaluated in the first step of the SignatureValidation, where the trust in the key has not yet been established, and the SignedInfo has not yet been verified. As noted in the [ XMLDSIG-BESTPRACTICES ] an attacker can easily causes a Denial of service, by adding a specially ~~crafter tranform~~ crafted transform in the RetrievalMethod without even bothering to have the key validate or the signature match.

In 2.0 Mode, Transforms are not allowed in RetrievalMethod. Use of KeyInfoReference is encouraged instead, see section 4.5.10.

Schema Definition <element name="RetrievalMethod" type="ds:RetrievalMethodType"/> <complexType name="RetrievalMethodType"> <sequence> <element ref="ds:Transforms" minOccurs="0"/> </sequence> <attribute name="URI" type="anyURI"/> <attribute name="Type" type="anyURI" use="optional"/> </complexType>

   Schema Definition

   <element name="RetrievalMethod" type="ds:RetrievalMethodType"/> 
   <complexType name="RetrievalMethodType">
     <sequence>
       <element ref="ds:Transforms" minOccurs="0"/> 
     </sequence>  
     <attribute name="URI" type="anyURI"/>
     <attribute name="Type" type="anyURI" use="optional"/>
   </complexType>

Note: The schema for the URI attribute of RetrievalMethod erroneously omitted the attribute: use="required". However, this error only results in a more lax schema which permits all valid RetrievalMethod elements. Because the existing schema is embedded in many applications, which may include the schema in their signatures, the schema has not been corrected to be more restrictive.

4.5.4 The `X509Data` Element

Identifier: Type=" http://www.w3.org/2000/09/xmldsig#X509Data " (this can be used within a RetrievalMethod or Reference element to identify the referent's type)

An X509Data element within KeyInfo contains one or more identifiers of keys or X509 certificates (or certificates' identifiers or a revocation list). The content of X509Data is:

At least one element, from the following set of element types; any of these may appear together or more than once iff (if and only if) each instance describes or is related to the same certificate:
- The X509IssuerSerial element, which contains an X.509 issuer distinguished name/serial number pair. The distinguished name should be represented as a string that complies with section 3 of RFC4514 [ LDAP-DN ], to be generated according to the Distinguished Name Encoding Rules section below,
- The X509SubjectName element, which contains an X.509 subject distinguished name that should be represented as a string that complies with section 3 of RFC4514 [ LDAP-DN ], to be generated according to the Distinguished Name Encoding Rules section below,
- The X509SKI element, which contains the base64 encoded plain (i.e. non-DER-encoded) value of a X509 V.3 SubjectKeyIdentifier extension,
- The X509Certificate element, which contains a base64-encoded [ X509V3 ] certificate, and
- Elements from an external namespace which accompanies/complements any of the elements above.
- The X509CRL element, which contains a base64-encoded certificate revocation list (CRL) [ X509V3 ].
- The dsig11:OCSPResponse element contains a base64-encoded OCSP response in DER encoding. [ OCSP ].

Any X509IssuerSerial, X509SKI, and X509SubjectName elements that appear must refer to the certificate or certificates containing the validation key. All such elements that refer to a particular individual certificate must be grouped inside a single X509Data element and if the certificate to which they refer appears, it must also be in that X509Data element.

Any X509IssuerSerial, X509SKI, and X509SubjectName elements that relate to the same key but different certificates must be grouped within a single KeyInfo but may occur in multiple X509Data elements.

All certificates appearing in an X509Data element must relate to the validation key by either containing it or being part of a certification chain that terminates in a certificate containing the validation key.

No ordering is implied by the above constraints. The comments in the following instance demonstrate these constraints:

<KeyInfo> <X509Data>  <X509IssuerSerial> <X509IssuerName>CN=TAMURA Kent, OU=TRL, O=IBM, L=Yamato-shi, ST=Kanagawa, C=JP</X509IssuerName> <X509SerialNumber>12345678</X509SerialNumber> </X509IssuerSerial> <X509SKI>31d97bd7</X509SKI> </X509Data> <X509Data> <X509SubjectName>Subject of Certificate B</X509SubjectName> </X509Data> <X509Data>   <X509Certificate>MIICXTCCA..</X509Certificate>  <X509Certificate>MIICPzCCA...</X509Certificate>  <X509Certificate>MIICSTCCA...</X509Certificate> </X509Data> </KeyInfo>

<KeyInfo>
  <X509Data> <!-- two pointers to certificate-A -->
    <X509IssuerSerial> 
      <X509IssuerName>CN=TAMURA Kent, OU=TRL, O=IBM, 
        L=Yamato-shi, ST=Kanagawa, C=JP</X509IssuerName>
      <X509SerialNumber>12345678</X509SerialNumber>
    </X509IssuerSerial>
    <X509SKI>31d97bd7</X509SKI> 
  </X509Data>
  <X509Data><!-- single pointer to certificate-B -->
    <X509SubjectName>Subject of Certificate B</X509SubjectName>
  </X509Data>
  <X509Data> <!-- certificate chain -->
    <!--Signer cert, issuer CN=arbolCA,OU=FVT,O=IBM,C=US, serial 4-->
    <X509Certificate>MIICXTCCA..</X509Certificate>
    <!-- Intermediate cert subject CN=arbolCA,OU=FVT,O=IBM,C=US 
         issuer CN=tootiseCA,OU=FVT,O=Bridgepoint,C=US -->
    <X509Certificate>MIICPzCCA...</X509Certificate>
    <!-- Root cert subject CN=tootiseCA,OU=FVT,O=Bridgepoint,C=US -->
    <X509Certificate>MIICSTCCA...</X509Certificate>
  </X509Data>

</KeyInfo>

Note, there is no direct provision for a PKCS#7 encoded "bag" of certificates or CRLs. However, a set of certificates and CRLs can occur within an X509Data element and multiple X509Data elements can occur in a KeyInfo. Whenever multiple certificates occur in an X509Data element, at least one such certificate must contain the public key which verifies the signature.

While in principle many certificate encodings are possible, it is recommended that certificates appearing in an X509Certificate element be limited to an encoding of BER or its DER subset, allowing that within the certificate other content may be present. The use of other encodings may lead to interoperability issues. In any case, XML Signature implementations should not alter or re-encode certificates, as doing so could invalidate their signatures.

Deployments that expect to make use of the X509IssuerSerial element should be aware that many Certificate Authorities issue certificates with large, random serial numbers. ~~Such deployments should avoid schema-validating the X509IssuerSerial element as~~ XML Schema validators may not support integer types with decimal data exceeding 18 decimal digits [XML-schema]. Therefore such deployments should avoid schema-validating the X509IssuerSerial element, or make use of a local copy of the schema that adjusts the data type of the X509SerialNumber child element from "integer" to "string".

4.5.4.1 Distinguished Name Encoding Rules

To encode a distinguished name ( X509IssuerSerial, X509SubjectName, and KeyName if appropriate), the encoding rules in section 2 of RFC 4514 [ LDAP-DN ] should be applied, except that the character escaping rules in section 2.4 of RFC 4514 [ LDAP-DN ] may be augmented as follows:

Escape all occurrences of ASCII control characters (Unicode range \x00 - \x1f) by replacing them with "\" followed by a two digit hex number showing its Unicode number.
Escape any trailing space characters (Unicode \x20) by replacing them with "\20", instead of using the escape sequence "\ ".

Since an XML document logically consists of characters, not octets, the resulting Unicode string is finally encoded according to the character encoding used for producing the physical representation of the XML document.

Schema Definition <element name="X509Data" type="ds:X509DataType"/> <complexType name="X509DataType"> <sequence maxOccurs="unbounded"> <choice> <element name="X509IssuerSerial" type="ds:X509IssuerSerialType"/> <element name="X509SKI" type="base64Binary"/> <element name="X509SubjectName" type="string"/> <element name="X509Certificate" type="base64Binary"/> <element name="X509CRL" type="base64Binary"/>   <any namespace="##other" processContents="lax"/> </choice> </sequence> </complexType> <complexType name="X509IssuerSerialType"> <sequence> <element name="X509IssuerName" type="string"/> <element name="X509SerialNumber" type="integer"/> </sequence> </complexType>

   Schema Definition

   <element name="X509Data" type="ds:X509DataType"/> 
   <complexType name="X509DataType">
     <sequence maxOccurs="unbounded">
       <choice>
         <element name="X509IssuerSerial" type="ds:X509IssuerSerialType"/>
         <element name="X509SKI" type="base64Binary"/>
         <element name="X509SubjectName" type="string"/>
         <element name="X509Certificate" type="base64Binary"/>
         <element name="X509CRL" type="base64Binary"/>
         <!-- <element ref="dsig11:OCSPResponse"/> -->
         <!-- OCSPResponse elements (XMLDsig 1.1) will use the any element -->
         <any namespace="##other" processContents="lax"/>
       </choice>
     </sequence>
   </complexType>


   <complexType name="X509IssuerSerialType"> 
     <sequence> 
       <element name="X509IssuerName" type="string"/> 
       <element name="X509SerialNumber" type="integer"/> 
     </sequence>
   </complexType>


   <!-- Note, this schema permits X509Data to be empty; this is 
   precluded by the text in KeyInfo Element (section 4.5) which states 
   that at least one element from the dsig namespace should be present 
   in the PGP, SPKI, and X509 structures. This is easily expressed for 
   the other key types, but not for X509Data because of its rich 
   structure. -->

~~ <element name="OCSPResponse" type="base64Binary" />~~

  <!-- targetNameSpace="http://www.w3.org/2009/xmldsig11#" -->
  
  <element name="OCSPResponse" type="base64Binary" />

4.5.5 The `PGPData` Element

Identifier: Type=" http://www.w3.org/2000/09/xmldsig#PGPData " (this can be used within a RetrievalMethod or Reference element to identify the referent's type)

The PGPData element within KeyInfo is used to convey information related to PGP public key pairs and signatures on such keys. The PGPKeyID 's value is a base64Binary sequence containing a standard PGP public key identifier as defined in [ PGP ] section 11.2]. The PGPKeyPacket contains a base64-encoded Key Material Packet as defined in [ PGP ] section 5.5]. These children element types can be complemented/extended by siblings from an external namespace within PGPData, or PGPData can be replaced all together with an alternative PGP XML structure as a child of KeyInfo. PGPData must contain one PGPKeyID and/or one PGPKeyPacket and 0 or more elements from an external namespace.

Schema Definition: <element name="PGPData" type="ds:PGPDataType"/> <complexType name="PGPDataType"> <choice> <sequence> <element name="PGPKeyID" type="base64Binary"/> <element name="PGPKeyPacket" type="base64Binary" minOccurs="0"/> <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </sequence> <sequence> <element name="PGPKeyPacket" type="base64Binary"/> <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </sequence> </choice> </complexType>

   Schema Definition:

   <element name="PGPData" type="ds:PGPDataType"/> 
   <complexType name="PGPDataType"> 
     <choice>
       <sequence>
         <element name="PGPKeyID" type="base64Binary"/> 
         <element name="PGPKeyPacket" type="base64Binary" minOccurs="0"/> 
         <any namespace="##other" processContents="lax" minOccurs="0"
          maxOccurs="unbounded"/>
       </sequence>
       <sequence>
         <element name="PGPKeyPacket" type="base64Binary"/> 
         <any namespace="##other" processContents="lax" minOccurs="0"
          maxOccurs="unbounded"/>
       </sequence>
     </choice>
   </complexType>

4.5.6 The `SPKIData` Element

Identifier: Type=" http://www.w3.org/2000/09/xmldsig#SPKIData " (this can be used within a RetrievalMethod or Reference element to identify the referent's type)

The SPKIData element within KeyInfo is used to convey information related to SPKI public key pairs, certificates and other SPKI data. SPKISexp is the base64 encoding of a SPKI canonical S-expression. SPKIData must have at least one SPKISexp ; SPKISexp can be complemented/extended by siblings from an external namespace within SPKIData, or SPKIData can be entirely replaced with an alternative SPKI XML structure as a child of KeyInfo.

Schema Definition: <element name="SPKIData" type="ds:SPKIDataType"/> <complexType name="SPKIDataType"> <sequence maxOccurs="unbounded"> <element name="SPKISexp" type="base64Binary"/> <any namespace="##other" processContents="lax" minOccurs="0"/> </sequence> </complexType>

   Schema Definition:

   <element name="SPKIData" type="ds:SPKIDataType"/> 
   <complexType name="SPKIDataType">
     <sequence maxOccurs="unbounded">
       <element name="SPKISexp" type="base64Binary"/>
       <any namespace="##other" processContents="lax" minOccurs="0"/>
     </sequence>
   </complexType>

4.5.7 The `MgmtData` Element

Identifier: Type=" http://www.w3.org/2000/09/xmldsig#MgmtData " (this can be used within a RetrievalMethod or Reference element to identify the referent's type)

The


MgmtData

element within


KeyInfo

is a string value used to convey in-band key distribution or agreement data. However, use of this element is not recommended and should not be used. Section 4.5.8 describes new


KeyInfo

types for conveying key information. ~~Schema Definition: <element name="MgmtData" type="string"/>~~

   Schema Definition:

   <element name="MgmtData" type="string"/>

4.5.8 XML Encryption `EncryptedKey` and `DerivedKey` Elements

The


<xenc:EncryptedKey>

and


<xenc:DerivedKey>

elements defined in [ XMLENC-CORE1 ] as children of


ds:KeyInfo

can be used to convey in-band encrypted or derived key material. In particular, the


xenc:DerivedKey

> element may be present when the key used in calculating a Message Authentication Code is derived from a shared secret.

4.5.9 The `DEREncodedKeyValue` Element

Identifier: Type=" http://www.w3.org/2009/xmldsig11#DEREncodedKeyValue " (this can be used within a RetrievalMethod or Reference element to identify the referent's type)

The public key algorithm and value are DER-encoded in accordance with the value that would be used in the Subject Public Key Info field of an X.509 certificate, per section 4.1.2.7 of [ RFC5280 ]. The DER-encoded value is then base64-encoded.

For the key value types supported in this specification, refer to the following for normative references on the format of Subject Public Key Info and the relevant OID values that identify the key/algorithm type:

RSA: See section 2.3.1 of [ RFC3279 ]
DSA: See section 2.3.2 of [ RFC3279 ]
EC: See section 2 of [ RFC5480 ]

Specifications that define additional key types should provide such a normative reference for their own key types where possible.

Schema Definition:  <element name="DEREncodedKeyValue" type="dsig11:DEREncodedKeyValueType"/> <complexType name="DEREncodedKeyValueType"> <simpleContent> <extension base="base64Binary"> <attribute name="Id" type="ID" use="optional"/> </extension> </simpleContent> </complexType>

   Schema Definition:

   <!-- targetNamespace="http://www.w3.org/2009/xmldsig11#" -->
  <element name="DEREncodedKeyValue" type="dsig11:DEREncodedKeyValueType"/>
  <complexType name="DEREncodedKeyValueType">
    <simpleContent>
      <extension base="base64Binary">
        <attribute name="Id" type="ID" use="optional"/>
      </extension>
    </simpleContent>
  </complexType>

Historical note: The DEREncodedKeyValue element was added to XML Signature 1.1 in order to support certain interoperability scenarios where at least one of signer and/or verifier are not able to serialize keys in the XML formats described in Section 4.5.2 above. The KeyValue element is to be used for "bare" XML key representations (not XML wrappings around other binary encodings like ASN.1 DER); for this reason the DEREncodedKeyValue element is not a child of KeyValue. The DEREncodedKeyValue element is also not a child of the X509Data element, as the keys represented by DEREncodedKeyValue may not have X.509 certificates associated with them (a requirement for X509Data ).

4.5.10 The `KeyInfoReference` Element

A KeyInfoReference element within KeyInfo is used to convey a reference to a KeyInfo element at another location in the same or different document. For example, several signatures in a document might use a key verified by an X.509v3 certificate chain appearing once in the document or remotely outside the document; each signature's KeyInfo can reference this chain using a single KeyInfoReference element instead of including the entire chain with a sequence of X509Certificate elements repeated in multiple places.

KeyInfoReference uses the same syntax and dereferencing behavior as Reference 's URI (section 4.4.3.1) and the Reference Processing Model (section 4.4.3.2) except that there are no child elements and the presence of the URI attribute is mandatory.

The result of dereferencing a KeyInfoReference must be a KeyInfo element, or an XML document with a KeyInfo element as the root.

Note: The KeyInfoReference element is a desirable alternative to the use of RetrievalMethod when the data being referred to is a KeyInfo element and the use of RetrievalMethod would require one or more Transform child elements, which introduce security risk and implementation challenges.

Schema Definition  <element name="KeyInfoReference" type="dsig11:KeyInfoReferenceType"/> <complexType name="KeyInfoReferenceType"> <attribute name="URI" type="anyURI" use="required"/> <attribute name="Id" type="ID" use="optional"/> </complexType>

Schema Definition

   <!-- targetNamespace="http://www.w3.org/2009/xmldsig11#" -->


   <element name="KeyInfoReference" type="dsig11:KeyInfoReferenceType"/> 
   <complexType name="KeyInfoReferenceType">
     <attribute name="URI" type="anyURI" use="required"/>
     <attribute name="Id" type="ID" use="optional"/>
   </complexType>

4.6 The `Object` Element

Identifier: Type= "http://www.w3.org/2000/09/xmldsig#Object" (this can be used within a Reference element to identify the referent's type)

Object is an optional element that may occur one or more times. When present, this element may contain any data. The Object element may include optional MIME type, ID, and encoding attributes.

The Object 's Encoding attributed may be used to provide a URI that identifies the method by which the object is encoded (e.g., a binary file).

The MimeType attribute is an optional attribute which describes the data within the Object (independent of its encoding). This is a string with values defined by [ RFC2045 ]. For example, if the Object contains base64 encoded PNG , the Encoding may be specified as 'http://www.w3.org/2000/09/xmldsig#base64' and the MimeType as 'image/png'. This attribute is purely advisory; no validation of the MimeType information is required by this specification. Applications ~~which~~ that require normative type and encoding information for signature validation should specify the Type and possibly SubType in the Selection element ("2.0 mode") or specify Transforms with well defined resulting types and/or ~~encodings.~~ encodings ("compatibility mode").

The Object 's Id is commonly referenced from a Reference in SignedInfo, or Manifest. This element is typically used for enveloping signatures where the object being signed is to be included in the signature element. The digest is calculated over the entire Object element including start and end tags.

Note, if the application wishes to exclude the <Object> tags from the digest calculation the Reference must identify the actual data object ~~(easy for XML documents) or~~ using standard Referencing mechanisms. E.g.

if the data object is a ~~transform must be used~~ single XML subtree, then use an ID based reference to ~~remove~~ the data object.
if the data object is multiple XML subtrees under the Object <Object> ~~tags (likely where~~ tag, then use an XPath Transform (compatibility mode) or IncludedXPath (2.0 mode) to refer to these nodes. Note in 2.0 mode it is not possible to refer to non-element nodes.
if the data object is ~~non-XML).~~ base64 text, then use a Base64 transform (compatibility mode) or dsig2:Selection with a Subtype="http://www.w3.org/2010/xmldsig2#fromBase64Node" (2.0 mode)
if the data is something else, then use a custom Transform (compatibility mode) or a dsig2:Selection with custom Type and Subtype (2.0 mode)

Exclusion of the object tags may be desired for cases where one wants the signature to remain valid if the data object is moved from inside a signature to outside the signature (or vice versa), or where the content of the Object is an encoding of an original binary document and it is desired to extract and decode so as to sign the original bitwise representation. Schema Definition: <element name="Object" type="ds:ObjectType"/> <complexType name="ObjectType" mixed="true"> <sequence minOccurs="0" maxOccurs="unbounded"> <any namespace="##any" processContents="lax"/> </sequence> <attribute name="Id" type="ID" use="optional"/> <attribute name="MimeType" type="string" use="optional"/> <attribute name="Encoding" type="anyURI" use="optional"/> </complexType>

   Schema Definition:

   <element name="Object" type="ds:ObjectType"/> 
   <complexType name="ObjectType" mixed="true">
     <sequence minOccurs="0" maxOccurs="unbounded">
       <any namespace="##any" processContents="lax"/>
     </sequence>
     <attribute name="Id" type="ID" use="optional"/> 
     <attribute name="MimeType" type="string" use="optional"/>
     <attribute name="Encoding" type="anyURI" use="optional"/> 
   </complexType>

5. Additional Signature Syntax

This section describes the optional to implement Manifest and SignatureProperties elements and describes the handling of XML processing instructions and comments. With respect to the elements Manifest and SignatureProperties this section specifies syntax and little behavior -- it is left to the application. These elements can appear anywhere the parent's content model permits; the Signature content model only permits them within Object.

5.1 The `Manifest` Element

Identifier: Type= "http://www.w3.org/2000/09/xmldsig#Manifest" (this can be used within a Reference element to identify the referent's type)

The Manifest element provides a list of Reference s. The difference from the list in SignedInfo is that it is application defined which, if any, of the digests are actually checked against the objects referenced and what to do if the object is inaccessible or the digest compare fails. If a Manifest is pointed to from SignedInfo, the digest over the Manifest itself will be checked by the core signature validation behavior. The digests within such a Manifest are checked at the application's discretion. If a Manifest is referenced from another Manifest, even the overall digest of this two level deep Manifest might not be checked.

Schema Definition: <element name="Manifest" type="ds:ManifestType"/> <complexType name="ManifestType"> <sequence> <element ref="ds:Reference" maxOccurs="unbounded"/> </sequence> <attribute name="Id" type="ID" use="optional"/> </complexType>

   Schema Definition:

   <element name="Manifest" type="ds:ManifestType"/> 
   <complexType name="ManifestType">
     <sequence>
       <element ref="ds:Reference" maxOccurs="unbounded"/> 
     </sequence>  
     <attribute name="Id" type="ID" use="optional"/> 
   </complexType>

5.2 The `SignatureProperties` Element


Identifier: Type=" http://www.w3.org/2000/09/xmldsig#SignatureProperties " (this can be used within a Reference element to identify the referent's type)

Additional information items concerning the generation of the signature(s) can be placed in a SignatureProperty element (i.e., date/time stamp or the serial number of cryptographic hardware used in signature generation).

Schema Definition: <element name="SignatureProperties" type="ds:SignaturePropertiesType"/> <complexType name="SignaturePropertiesType"> <sequence> <element ref="ds:SignatureProperty" maxOccurs="unbounded"/> </sequence> <attribute name="Id" type="ID" use="optional"/> </complexType> <element name="SignatureProperty" type="ds:SignaturePropertyType"/> <complexType name="SignaturePropertyType" mixed="true"> <choice maxOccurs="unbounded"> <any namespace="##other" processContents="lax"/>  </choice> <attribute name="Target" type="anyURI" use="required"/> <attribute name="Id" type="ID" use="optional"/> </complexType>

   Schema Definition:

   <element name="SignatureProperties" type="ds:SignaturePropertiesType"/> 
   <complexType name="SignaturePropertiesType">
     <sequence>
       <element ref="ds:SignatureProperty" maxOccurs="unbounded"/> 
     </sequence>
     <attribute name="Id" type="ID" use="optional"/> 
   </complexType>


      <element name="SignatureProperty" type="ds:SignaturePropertyType"/> 
      <complexType name="SignaturePropertyType" mixed="true">
        <choice maxOccurs="unbounded">
          <any namespace="##other" processContents="lax"/>
          <!-- (1,1) elements from (1,unbounded) namespaces -->
        </choice>
        <attribute name="Target" type="anyURI" use="required"/> 
        <attribute name="Id" type="ID" use="optional"/> 
      </complexType>

5.3 Processing Instructions in Signature Elements

No XML processing instructions (PIs) are used by this specification.

Note that PIs placed inside SignedInfo by an application will be signed unless the CanonicalizationMethod algorithm discards them. (This is true for any signed XML content.) All of the CanonicalizationMethod s identified within this specification retain PIs. When a PI is part of content that is signed (e.g., within SignedInfo or referenced XML documents) any change to the PI will obviously result in a signature failure.

5.4 Comments in Signature Elements

XML comments are not used by this specification.

Note that unless CanonicalizationMethod removes comments within SignedInfo or any other referenced XML (which [ XML-C14N ] does), they will be signed. Consequently, if they are retained, a change to the comment will cause a signature failure. Similarly, the XML signature over any XML data will be sensitive to comment changes unless a comment-ignoring canonicalization/transform method, such as the Canonical XML [ XML-C14N ], is specified.

6. Algorithms

This section identifies algorithms used with the XML digital signature specification. Entries contain the identifier to be used in Signature elements, a reference to the formal specification, and definitions, where applicable, for the representation of keys and the results of cryptographic operations.

6.1 Algorithm Identifiers and Implementation Requirements

There is currently no consensus on mandatory to implement algorithms; the current draft text represents one possible outcome. Positions of some Working Group members against the currently expressed set of mandatory to implement algorithms include:

RSA and DSA are acceptable as a mandatory to implement signature algorithms. Given limited support in parts of the industry, elliptic curve DSA is not acceptable as a mandatory to implement algorithm, and might lead to lack of implementation of this version of the specification.
There should be recommended algorithms, but no mandatory to implement algorithms. The rationale is that this gives greater flexibility to deployments. (Other WG members argued against this since it could harm interoperability not having mandatory algorithms.)

The opposing position is that, going forward, this specification needs to have credible algorithm agility for both hash and public-key algorithms: Should one set of algorithms prove weak, this would enable a quick switch-over. Therefore, there should be two mandatory to implement public-key algorithms from different families. At this time, elliptic curve based algorithms are the only credible contenders. They have the additional benefit of providing a reasonable balance between key sizes and security level. As profiles built on top of XML Signature that currently rely on DSA-SHA1 or RSA-SHA1 as the only supported signature algorithm will need to be updated in the future, the Signature core specification should outline a clear way forward in terms of choice of algorithms. This choice should be Elliptic Curve DSA.

Algorithms are identified by URIs that appear as an attribute to the element that identifies the algorithms' role ( DigestMethod, Transform, SignatureMethod, or CanonicalizationMethod ). All algorithms used herein take parameters but in many cases the parameters are implicit. For example, a SignatureMethod is implicitly given two parameters: the keying info and the output of CanonicalizationMethod. Explicit additional parameters to an algorithm appear as content elements within the algorithm role element. Such parameter elements have a descriptive element name, which is frequently algorithm specific, and must be in the XML Signature namespace or an algorithm specific namespace.

This specification defines a set of algorithms, their URIs, and requirements for implementation. Requirements are specified over implementation, not over requirements for signature use. Furthermore, the mechanism is extensible; alternative algorithms may be used by signature applications.

Digest

Required

SHA1 (Use is DISCOURAGED; see SHA-1 Warning ) http://www.w3.org/2000/09/xmldsig#sha1
SHA256 http://www.w3.org/2001/04/xmlenc#sha256

Optional

SHA384 http://www.w3.org/2001/04/xmldsig-more#sha384
SHA512 http://www.w3.org/2001/04/xmlenc#sha512

Encoding

Required

base64 http://www.w3.org/2000/09/xmldsig# base64

MAC

Required

HMAC-SHA1 (Use is DISCOURAGED; see SHA-1 Warning ) http://www.w3.org/2000/09/xmldsig#hmac-sha1
HMAC-SHA256 http://www.w3.org/2001/04/xmldsig-more#hmac-sha256

Recommended

HMAC-SHA384 http://www.w3.org/2001/04/xmldsig-more#hmac-sha384
HMAC-SHA512 http://www.w3.org/2001/04/xmldsig-more#hmac-sha512

Signature

Required

RSAwithSHA256 http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 [ RFC4051 ]
ECDSAwithSHA256 http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha256 [ RFC4051 ]
DSAwithSHA1 ( signature verification ) http://www.w3.org/2000/09/xmldsig#dsa-sha1 [ RFC4051 ]

Recommended

RSAwithSHA1 ( signature verification ; use for signature generation is DISCOURAGED; see SHA-1 Warning ) http://www.w3.org/2000/09/xmldsig# rsa-sha1

Optional

RSAwithSHA384 http://www.w3.org/2001/04/xmldsig-more#rsa-sha384 [ RFC4051 ]
RSAwithSHA512 http://www.w3.org/2001/04/xmldsig-more#rsa-sha512
ECDSAwithSHA1 (Use is DISCOURAGED; see SHA-1 Warning ) http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha1 [ RFC4051 ]
ECDSAwithSHA384 http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha384 [ RFC4051 ]
ECDSAwithSHA512 http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha512 [ RFC4051 ]
DSAwithSHA1 ( signature generation ) http://www.w3.org/2000/09/xmldsig#dsa-sha1
DSAwithSHA256 http://www.w3.org/2009/xmldsig11#dsa-sha256

Canonicalization

Required

Canonical XML 1.0 (omits comments) http://www.w3.org/TR/2001/REC-xml-c14n-20010315
Canonical XML 1.1 (omits comments) http://www.w3.org/2006/12/xml-c14n11
Exclusive XML Canonicalization 1.0 (omits comments) http://www.w3.org/2001/10/xml-exc-c14n#

Recommended

Canonical XML 1.0 with Comments http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments
Canonical XML 1.1 with Comments http://www.w3.org/2006/12/xml-c14n11#WithComments
Exclusive XML Canonicalization 1.0 with Comments http://www.w3.org/2001/10/xml-exc-c14n#WithComments

Transform

Required

Enveloped Signature* http://www.w3.org/2000/09/xmldsig#enveloped-signature

Recommended

XPath http://www.w3.org/TR/1999/REC-xpath-19991116
XPath Filter 2.0 http://www.w3.org/2002/06/xmldsig-filter2

Optional

XSLT http://www.w3.org/TR/1999/REC-xslt-19991116

* The Enveloped Signature transform removes the Signature element from the calculation of the signature when the signature is within the content that it is being signed. This may be implemented via the XPath specification specified in 6.6.4: Enveloped Signature Transform ; it must have the same effect as that specified by the XPath Transform.

When using transforms, we RECOMMEND selecting the least expressive choice that still accomplishes the needs of the use case at hand: Use of XPath filter 2.0 is recommended over use of XPath filter. Use of XPath filter is recommended over use of XSLT.

Note: Implementation requirements for the XPath transform may be downgraded to optional in a future version of this specification.

6.2 Message Digests

This specification defines several possible digest algorithms for the DigestMethod element, including required algorithm SHA-256. Use of SHA-256 is strongly recommended over SHA-1 because recent advances in cryptanalysis (see e.g. [ SHA-1-Analysis ]) have cast doubt on the long-term collision resistance of SHA-1. Therefore, SHA-1 support is required in this specification only for backwards-compatibility reasons.

Digest algorithms that are known not to be collision resistant should not be used in DigestMethod elements. For example, the MD5 message digest algorithm should not be used as specific collisions have been demonstrated for that algorithm.

6.2.1 SHA-1

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

Use of SHA-256 is strongly recommended over SHA-1 because recent advances in cryptanalysis (see e.g. [ SHA-1-Analysis ], [ SHA-1-Collisions ] ) have cast doubt on the long-term collision resistance of SHA-1.

The SHA-1 algorithm [ FIPS-186-3 ] takes no explicit parameters. An example of an SHA-1 DigestAlg element is:



<DigestMethod

Algorithm

=

"

http://www.w3.org/2000/09/xmldsig#

sha1"

/>

A SHA-1 digest is a 160-bit string. The content of the DigestValue element shall be the base64 encoding of this bit string viewed as a 20-octet octet stream. For example, the DigestValue element for the message digest:

~~A9993E36 4706816A BA3E2571 7850C26C 9CD0D89D~~

A9993E36
4706816A
BA3E2571
7850C26C
9CD0D89D

from Appendix A of the SHA-1 standard would be:

~~<DigestValue>qZk+NkcGgWq6PiVxeFDCbJzQ2J0=</DigestValue>~~


<DigestValue>

qZk+NkcGgWq6PiVxeFDCbJzQ2J0=

</DigestValue>

6.2.2 SHA-256

Identifier:: http://www.w3.org/2001/04/xmlenc#sha256

The SHA-256 algorithm [ FIPS-180-3 ] takes no explicit parameters. A SHA-256 digest is a 256-bit string. The content of the DigestValue element shall be the base64 encoding of this bit string viewed as a 32-octet octet stream.

6.2.3 SHA-384

Identifier:: http://www.w3.org/2000/09/xmldsig#sha384

The SHA-384 algorithm [ FIPS-180-3 ] takes no explicit parameters. A SHA-384 digest is a 384-bit string. The content of the DigestValue element shall be the base64 encoding of this bit string viewed as a 48-octet octet stream.

6.2.4 SHA-512

Identifier:: http://www.w3.org/2001/04/xmlenc#sha512

The SHA-512 algorithm [ FIPS-180-3 ] takes no explicit parameters. A SHA-512 digest is a 512-bit string. The content of the DigestValue element shall be the base64 encoding of this bit string viewed as a 64-octet octet stream.

6.3 Message Authentication Codes

MAC algorithms take two implicit parameters, their keying material determined from KeyInfo and the octet stream output by CanonicalizationMethod. MACs and signature algorithms are syntactically identical but a MAC implies a shared secret key.

6.3.1 HMAC

Identifier:: http://www.w3.org/2000/09/xmldsig#hmac-sha1; http://www.w3.org/2001/04/xmldsig-more#hmac-sha256; http://www.w3.org/2001/04/xmldsig-more#hmac-sha384; http://www.w3.org/2001/04/xmldsig-more#hmac-sha512

The HMAC algorithm (RFC2104 [ HMAC ]) takes the output (truncation) length in bits as a parameter; this specification REQUIRES that the truncation length be a multiple of 8 (i.e. fall on a byte boundary) because Base64 encoding operates on full bytes. If the truncation parameter is not specified then all the bits of the hash are output. Any signature with a truncation length that is less than half the output length of the underlying hash algorithm must be deemed invalid. An example of an HMAC SignatureMethod element:

~~<SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#hmac-sha1"> <HMACOutputLength>128</HMACOutputLength> </SignatureMethod>~~

<SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#hmac-sha1">
   <HMACOutputLength>128</HMACOutputLength>

</SignatureMethod>

The output of the HMAC algorithm is ultimately the output (possibly truncated) of the chosen digest algorithm. This value shall be base64 encoded in the same straightforward fashion as the output of the digest algorithms. Example: the SignatureValue element for the HMAC-SHA1 digest

~~9294727A 3638BB1C 13F48EF8 158BFC9D~~

9294727A
3638BB1C
13F48EF8
158BFC9D

from the test vectors in [ HMAC ] would be

~~<SignatureValue>kpRyejY4uxwT9I74FYv8nQ==</SignatureValue> Schema Definition:~~

   <simpleType name="HMACOutputLengthType">
     <restriction base="integer"/>
   </simpleType>


<SignatureValue>

kpRyejY4uxwT9I74FYv8nQ==

</SignatureValue>

   Schema Definition:


   <simpleType name="HMACOutputLengthType">
     <restriction base="integer"/>
   </simpleType>

6.4 Signature Algorithms

Signature algorithms take two implicit parameters, their keying material determined from KeyInfo and the octet stream output by CanonicalizationMethod. Signature and MAC algorithms are syntactically identical but a signature implies public key cryptography.

6.4.1 DSA

Identifier:: http://www.w3.org/2000/09/xmldsig#dsa-sha1; http://www.w3.org/2009/xmldsig11#dsa-sha256

The DSA family of algorithms is defined in FIPS 186-3 [ FIPS-186-3 ]. FIPS 186-3 defines DSA in terms of two security parameters L and N where L = |p|, N = |q|, p is the prime modulus, q is a prime divisor of (p-1). FIPS 186-3 defines four valid pairs of (L, N); they are: (1024, 160), (2048, 224), (2048, 256) and (3072, 256). The pair (1024, 160) corresponds to the algorithm DSAwithSHA1, which is identified in this specification by the URI http://www.w3.org/2000/09/xmldsig#dsa-sha1 . The pairs (2048, 256) and (3072, 256) correspond to the algorithm DSAwithSHA256, which is identified in this specification by the URI http://www.w3.org/2009/xmldsig11#dsa-sha256 . This specification does not use the (2048, 224) instance of DSA (which corresponds to DSAwithSHA224).

DSA takes no explicit parameters; an example of a DSA SignatureMethod element is:

   <SignatureMethod Algorithm="http://www.w3.org/2009/xmldsig11#dsa-sha256"/>

The output of the DSA algorithm consists of a pair of integers usually referred by the pair (r, s). The signature value consists of the base64 encoding of the concatenation of two octet-streams that respectively result from the octet-encoding of the values r and s in that order. Integer to octet-stream conversion must be done according to the I2OSP operation defined in the RFC 3447 [ PKCS1 ] specification with a l parameter equal to 20. For example, the SignatureValue element for a DSA signature ( r, s ) with values specified in hexadecimal:

r = 8BAC1AB6 6410435C B7181F95 B16AB97C 92B341C0

s
=
41E2345F
1F56DF24
58F426D1
55B4BA2D
B6DCD8C8

from the example in Appendix 5 of the DSS standard would be

<SignatureValue>

i6watmQQQ1y3GB+VsWq5fJKzQcBB4jRfH1bfJFj0JtFVtLotttzYyA==

</SignatureValue>

Security considerations regarding DSA key sizes

Per FIPS 186-3 [ FIPS-186-3 ], the DSA security parameter L is defined to be 1024, 2048 or 3072 bits and the corresponding DSA q value is defined to be 160, 224/256 and 256 bits respectively. Special Publication SP 800-57 Part 1 [ SP800-57 ], NIST recommends using at least at 2048-bit public keys for securing information beyond 2010 (and 3072-bit keys for securing information beyond 2030).

Since XML Signature 1.0 requires implementations to support DSA-based digital signatures, this XML Signature 1.1 revision REQUIRES signature verifiers to implement DSA only for keys of 1024 bits in order to guarantee interoperability with XML Signature 1.0 generators. XML Signature 1.1 implementations may but are not required to support DSA-based signature generation, and given the short key size and the SP800-57 guidelines, DSA with 1024-bit prime moduli should not be used for signatures that will be verified beyond 2010.

6.4.2 RSA (PKCS#1 v1.5)

Identifier:: 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

The expression "RSA algorithm" as used in this specification refers to the RSASSA-PKCS1-v1_5 algorithm described in RFC 3447 [ PKCS1 ]. The RSA algorithm takes no explicit parameters. An example of an RSA SignatureMethod element is:



<SignatureMethod

Algorithm

=

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

/>

The SignatureValue content for an RSA signature is the base64 [ RFC2045 ] encoding of the octet string computed as per RFC 3447 [ PKCS1 ], section 8.2.1: Signature generation for the RSASSA-PKCS1-v1_5 signature scheme]. Computation of the signature will require concatenation of the hash value and a constant string determined by RFC 3447. Signature computation and verification does not require implementation of an ASN.1 parser.

The resulting base64 [ RFC2045 ] string is the value of the child text node of the SignatureValue element, e.g.

~~<SignatureValue> IWijxQjUrcXBYoCei4QxjWo9Kg8D3p9tlWoT4t0/gyTE96639In0FZFY2/rvP+/bMJ01EArmKZsR5VW3rwoPxw=~~

<SignatureValue>
IWijxQjUrcXBYoCei4QxjWo9Kg8D3p9tlWoT4t0/gyTE96639In0FZFY2/rvP+/bMJ01EArmKZsR5VW3rwoPxw=

</SignatureValue>

Security considerations regarding RSA key sizes

In Special Publication SP 800-57 Part 1 [ SP800-57 ], NIST recommends using at least 2048-bit public keys for securing information beyond 2010 (and 3072-bit keys for securing information beyond 2030). All conforming implementations of XML Signature 1.1 must support RSA signature generation and verification with public keys at least 2048 bits in length. RSA public keys of 1024 bits or less should not be used for signatures that will be verified beyond 2010. XML Signature 1.1 implementations should use at least 2048-bit keys for all signatures, and should use at least 3072-bit keys for signatures that will be verified beyond 2030.

6.4.3 ECDSA

Identifiers:: http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha1; http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha256; http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha384; http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha512

The ECDSA algorithm [ FIPS-186-3 ] takes no explicit parameters. An example of a ECDSA SignatureMethod element is:

~~<SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha256"/>~~


    <SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha256"/>

The output of the ECDSA algorithm consists of a pair of integers usually referred by the pair (r, s). The signature value consists of the base64 encoding of the concatenation of two octet-streams that respectively result from the octet-encoding of the values r and s in that order. Integer to octet-stream conversion must be done according to the I2OSP operation defined in the RFC 3447 [ PKCS1 ] specification with the l parameter equal to the size of the base point order of the curve in bytes (e.g. 32 for the P-256 curve and 66 for the P-521 curve).

This specification REQUIRES implementations to support the ECDSAwithSHA256 signature algorithm, which is ECDSA over the P-256 prime curve specified in Section D.2.3 of FIPS 186-3 [ FIPS-186-3 ] (and using the SHA-256 hash algorithm). It is further recommended that implementations also support ECDSA over the P-384 and P-521 prime curves; these curves are defined in Sections D.2.4 and D.2.5 of FIPS 186-3, respectively.

6.5 "Compatibility Mode" Canonicalization Algorithms

All 2.0 mode ~~signatures,~~ signatures must use ~~the 2.0 mode~~ Canonicalization ~~algorithms. They are described in section~~ algorithms designated as compatible with 2.0 ~~Mode~~ mode. Section "2.0 Mode" Canonicalization Algorithms lists such compatible algorithms as of publication.

If canonicalization is performed over octets, the canonicalization algorithms take two implicit parameters: the content and its charset. The charset is derived according to the rules of the transport protocols and media types (e.g, [ XML-MEDIA-TYPES ] defines the media types for XML). This information is necessary to correctly sign and verify documents and often requires careful server side configuration.

Various canonicalization algorithms require conversion to [ UTF-8 ]. The algorithms below understand at least [ UTF-8 ] and [ UTF-16 ] as input encodings. We RECOMMEND that externally specified algorithms do the same. Knowledge of other encodings is optional .

Various canonicalization algorithms transcode from a non-Unicode encoding to Unicode. The output of these algorithms will be in NFC [ NFC ]. This is because the XML processor used to prepare the XPath data model input is required (by the Data Model) to use Normalization Form C when converting an XML document to the UCS character domain from any encoding that is not UCS-based.

We RECOMMEND that externally specified canonicalization algorithms do the same. (Note, there can be ambiguities in converting existing charsets to Unicode, for an example see the XML Japanese Profile Note [ XML-Japanese ].)

This specification REQUIRES implementation of Canonical XML 1.0 [ XML-C14N ], Canonical XML 1.1 [ XML-C14N11 ]] and Exclusive XML Canonicalization [ XML-EXC-C14N ]. We RECOMMEND that applications that generate signatures choose Canonical XML 1.1 [ XML-C14N11 ] when inclusive canonicalization is desired.

Note : Canonical XML 1.0 [ XML-C14N ] and Canonical XML 1.1 [ XML-C14N11 ] specify a standard serialization of XML that, when applied to a subdocument, includes the subdocument's ancestor context including all of the namespace declarations and some attributes in the 'xml:' namespace. However, some applications require a method which, to the extent practical, excludes unused ancestor context from a canonicalized subdocument. The Exclusive XML Canonicalization Recommendation [ XML-EXC-C14N ] may be used to address requirements resulting from scenarios where a subdocument is moved between contexts.

6.5.1 Canonical XML 1.0

Identifier for required Canonical XML 1.0 (omits comments):: http://www.w3.org/TR/2001/REC-xml-c14n-20010315
Identifier for Canonical XML 1.0 with Comments:: http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments
Input:: octet-stream, node-set
Output:: octet-stream

An example of an XML canonicalization element is:



<CanonicalizationMethod

Algorithm

=

"

http://www.w3.org/TR/2001/REC-xml-c14n-20010315

"

/>

The normative specification of Canonical XML1.0 is [ XML-C14N ]. The algorithm is capable of taking as input either an octet stream or an XPath node-set (or sufficiently functional alternative). The algorithm produces an octet stream as output. Canonical XML is easily parameterized (via an additional URI) to omit or retain comments.

6.5.2 Canonical XML 1.1

Identifier for required Canonical XML 1.1 (omits comments):: http://www.w3.org/2006/12/xml-c14n11
Identifier for Canonical XML 1.1 with Comments:: http://www.w3.org/2006/12/xml-c14n11#WithComments
Input:: octet-stream, node-set
Output:: octet-stream

The normative specification of Canonical XML 1.1 is [ XML-C14N11 ]. The algorithm is capable of taking as input either an octet stream or an XPath node-set (or sufficiently functional alternative). The algorithm produces an octet stream as output. Canonical XML 1.1 is easily parameterized (via an additional URI) to omit or retain comments.

6.5.3 Exclusive XML Canonicalization 1.0

Identifier for Exclusive XML Canonicalization 1.0 (omits comments):: http://www.w3.org/2001/10/xml-exc-c14n#
Identifier for Exclusive XML Canonicalization 1.0 with Comments:: http://www.w3.org/2001/10/xml-exc-c14n#WithComments
Input:: octet-stream, node-set
Output:: octet-stream

The normative specification of Exclusive XML Canonicalization 1.0 is [XML-EXC-C14N]].

6.6 "Compatibility mode" `Transform` Algorithms

2.0 mode signatures do not use these Transform algorithms. See section.

A Transform algorithm has a single implicit parameter: an octet stream from the Reference or the output of an earlier Transform.

For implementation requirements, please see Algorithm Identifiers and Implementation Requirements . Application developers are strongly encouraged to support all transforms that are listed as recommended unless the application environment has resource constraints that would make such support impractical. Compliance with this recommendation will maximize application interoperability and libraries should be available to enable support of these transforms in applications without extensive development.

6.6.1 Canonicalization

Any canonicalization algorithm that can be used for CanonicalizationMethod (such as those in Canonicalization Algorithms (section 6.5)) can be used as a Transform.

6.6.2 Base64

Identifiers:: http://www.w3.org/2000/09/xmldsig#base64
Input:: octet-stream, node-set
Output:: octet-stream

The normative specification for base64 decoding transforms is [ RFC2045 ]. The base64 Transform element has no content. The input is decoded by the algorithms. This transform is useful if an application needs to sign the raw data associated with the encoded content of an element.

This transform accepts either an octet-stream or a node-set as input. If an octet-string is given as input, then this octet-stream is processed directly. If an XPath node-set (or sufficiently functional alternative) is given as input, then it is converted to an octet stream by performing operations logically equivalent to 1) applying an XPath transform with expression self::text(), then 2) taking the string-value of the node-set. Thus, if an XML element is identified by a shortname XPointer in the Reference URI, and its content consists solely of base64 encoded character data, then this transform automatically strips away the start and end tags of the identified element and any of its descendant elements as well as any descendant comments and processing instructions. The output of this transform is an octet stream.

6.6.3 XPath Filtering

Identifier:: http://www.w3.org/TR/1999/REC-xpath-19991116
Input:: octet-stream, node-set
Output:: node-set

The normative specification for XPath expression evaluation is [ XPATH ]. The XPath expression to be evaluated appears as the character content of a transform parameter child element named XPath.

The input required by this transform is an XPath node-set or an octet-stream. Note that if the actual input is an XPath node-set resulting from a null URI or shortname XPointer dereference, then comment nodes will have been omitted. If the actual input is an octet stream, then the application must convert the octet stream to an XPath node-set suitable for use by Canonical XML with Comments. (A subsequent application of the required Canonical XML algorithm would strip away these comments.) In other words, the input node-set should be equivalent to the one that would be created by the following process:

Initialize an XPath evaluation context by setting the initial node equal to the input XML document's root node, and set the context position and size to 1.
Evaluate the XPath expression (//. | //@* | //namespace::*)

The evaluation of this expression includes all of the document's nodes (including comments) in the node-set representing the octet stream.

The transform output is always an XPath node-set. The XPath expression appearing in the XPath parameter is evaluated once for each node in the input node-set. The result is converted to a boolean. If the boolean is true, then the node is included in the output node-set. If the boolean is false, then the node is omitted from the output node-set.

Note: Even if the input node-set has had comments removed, the comment nodes still exist in the underlying parse tree and can separate text nodes. For example, the markup <e>Hello, world!</e> contains two text nodes. Therefore, the expression self::text()[string()="Hello, world!"] would fail. Should this problem arise in the application, it can be solved by either canonicalizing the document before the XPath transform to physically remove the comments or by matching the node based on the parent element's string value (e.g. by using the expression self::text()[string(parent::e)="Hello, world!"] ).

The primary purpose of this transform is to ensure that only specifically defined changes to the input XML document are permitted after the signature is affixed. This is done by omitting precisely those nodes that are allowed to change once the signature is affixed, and including all other input nodes in the output. It is the responsibility of the XPath expression author to include all nodes whose change could affect the interpretation of the transform output in the application context.

Note that the XML-Signature XPath Filter 2.0 Recommendation [ XMLDSIG-XPATH-FILTER2 ] may be used for this purpose. That recommendation defines an XPath transform that permits the easy specification of subtree selection and omission that can be efficiently implemented.

An important scenario would be a document requiring two enveloped signatures. Each signature must omit itself from its own digest calculations, but it is also necessary to exclude the second signature element from the digest calculations of the first signature so that adding the second signature does not break the first signature.

The XPath transform establishes the following evaluation context for each node of the input node-set:

A context node equal to a node of the input node-set.
A context position , initialized to 1.
A context size , initialized to 1.
A library of functions equal to the function set defined in [ XPATH ] a function named here .
A set of variable bindings. No means for initializing these is defined. Thus, the set of variable bindings used when evaluating the XPath expression is empty, and use of a variable reference in the XPath expression results in an error.
The set of namespace declarations in scope for the XPath expression.

As a result of the context node setting, the XPath expressions appearing in this transform will be quite similar to those used in used in [ XSLT ], except that the size and position are always 1 to reflect the fact that the transform is automatically visiting every node (in XSLT, one recursively calls the command apply-templates to visit the nodes of the input tree).

The function here() is defined as follows:

Function: node-set here ()

The here function returns a node-set containing the attribute or processing instruction node or the parent element of the text node that directly bears the XPath expression. This expression results in an error if the containing XPath expression does not appear in the same XML document against which the XPath expression is being evaluated.

As an example, consider creating an enveloped signature (a Signature element that is a descendant of an element being signed). Although the signed content should not be changed after signing, the elements within the Signature element are changing (e.g. the digest value must be put inside the DigestValue and the SignatureValue must be subsequently calculated). One way to prevent these changes from invalidating the digest value in DigestValue is to add an XPath Transform that omits all Signature elements and their descendants. For example,

<Document> ... <Signature xmlns="http://www.w3.org/2000/09/xmldsig#"> <SignedInfo> ... <Reference URI=""> <Transforms> <Transform Algorithm="http://www.w3.org/TR/1999/REC-xpath-19991116"> <XPath xmlns:dsig="&dsig;"> not(ancestor-or-self::dsig:Signature) </XPath> </Transform> </Transforms> <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/> <DigestValue></DigestValue> </Reference> </SignedInfo> <SignatureValue></SignatureValue> </Signature> ... </Document>

<Document>
...   
<Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
  <SignedInfo>

   ...
    <Reference URI="">
      <Transforms>
        <Transform Algorithm="http://www.w3.org/TR/1999/REC-xpath-19991116">
          <XPath xmlns:dsig="&dsig;">

          not(ancestor-or-self::dsig:Signature)
          </XPath>
        </Transform>
      </Transforms>
      <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
      <DigestValue></DigestValue>
    </Reference>
  </SignedInfo>
  <SignatureValue></SignatureValue>
 </Signature>

 ...

</Document>

Due to the null Reference URI in this example, the XPath transform input node-set contains all nodes in the entire parse tree starting at the root node (except the comment nodes). For each node in this node-set, the node is included in the output node-set except if the node or one of its ancestors has a tag of Signature that is in the namespace given by the replacement text for the entity &dsig;.

A more elegant solution uses the here function to omit only the Signature containing the XPath Transform, thus allowing enveloped signatures to sign other signatures. In the example above, use the XPath element:

~~<XPath xmlns:dsig="&dsig;"> count(ancestor-or-self::dsig:Signature | here()/ancestor::dsig:Signature[1]) > count(ancestor-or-self::dsig:Signature)</XPath>~~

<XPath xmlns:dsig="&dsig;">
count(ancestor-or-self::dsig:Signature |
here()/ancestor::dsig:Signature[1]) >
count(ancestor-or-self::dsig:Signature)

</XPath>

Since the XPath equality operator converts node sets to string values before comparison, we must instead use the XPath union operator (|). For each node of the document, the predicate expression is true if and only if the node-set containing the node and its Signature element ancestors does not include the enveloped Signature element containing the XPath expression (the union does not produce a larger set if the enveloped Signature element is in the node-set given by ancestor-or-self::Signature ).

6.6.4 Signature Transform

Identifier:: http://www.w3.org/2000/09/xmldsig#enveloped-signature
Input:: node-set
Output:: node-set

An enveloped signature transform T removes the whole Signature element containing T from the digest calculation of the Reference element containing T . The entire string of characters used by an XML processor to match the Signature with the XML production element is removed. The output of the transform is equivalent to the output that would result from replacing T with an XPath transform containing the following XPath parameter element:

~~<XPath xmlns:dsig="&dsig;"> count(ancestor-or-self::dsig:Signature | here()/ancestor::dsig:Signature[1]) > count(ancestor-or-self::dsig:Signature)</XPath>~~

   <XPath xmlns:dsig="&dsig;">
   count(ancestor-or-self::dsig:Signature |
   here()/ancestor::dsig:Signature[1]) >
   count(ancestor-or-self::dsig:Signature)</XPath>

The input and output requirements of this transform are identical to those of the XPath transform, but may only be applied to a node-set from its parent XML document. Note that it is not necessary to use an XPath expression evaluator to create this transform. However, this transform must produce output in exactly the same manner as the XPath transform parameterized by the XPath expression above.

6.6.5 XSLT Transform

Identifier:: http://www.w3.org/TR/1999/REC-xslt-19991116
Input:: octet-stream
Output:: octet-stream

The normative specification for XSL Transformations is [ XSLT ]. Specification of a namespace-qualified stylesheet element, which must be the sole child of the Transform element, indicates that the specified style sheet should be used. Whether this instantiates in-line processing of local XSLT declarations within the resource is determined by the XSLT processing model; the ordered application of multiple stylesheet may require multiple Transforms. No special provision is made for the identification of a remote stylesheet at a given URI because it can be communicated via an xsl:include or xsl:import within the stylesheet child of the Transform.

This transform requires an octet stream as input.

The output of this transform is an octet stream. The processing rules for the XSL style sheet [ XSL10 ] or transform element are stated in the XSLT specification [ XSLT ].

We RECOMMEND that XSLT transform authors use an output method of xml for XML and HTML. As XSLT implementations do not produce consistent serializations of their output, we further RECOMMEND inserting a transform after the XSLT transform to canonicalize the output. These steps will help to ensure interoperability of the resulting signatures among applications that support the XSLT transform. Note that if the output is actually HTML, then the result of these steps is logically equivalent [ XHTML10 ].

6.7 "2.0 Mode" `Selection` Algorithms

The following selection algorithms are required .

6.7.1 Selection `Type="...xml" Type="http://www.w3.org/2010/xmldsig2#xml"`

Type and SubType	`Type="http://www.w3.org/2008/xmlsec/experimental#xml" Type="http://www.w3.org/2010/xmldsig2#xml"`
Parameters	`URI`: See section URIs for 2.0 mode . `IncludedXPath`: The XPath to be included. See section XPaths in 2.0 mode . `ExcludeXPath`: The XPath to be excluded. `EnvelopedSignature`: "true" or "false". Whether the current signature should be excluded from the selection. The parameter `EnvelopedSignature` may be removed, because in an enveloped signature, sign an EnvelopedSignature without ~~exluding~~ excluding the signature itself.
URI syntax	The `URI` can be an external reference or a same document reference.
Parameter Syntax	~~<Selection Type SubType? URI> (<IncludedXPath/>)? (<ExcludedXPath/>)? (<EnvelopedSignature/>)? </Selection>~~ <Selection Type SubType? URI> (<IncludedXPath/>)? (<ExcludedXPath/>)? (<EnvelopedSignature/>)? </Selection>
Processing	If the URI is a same document reference, compute the subtree pointed to by this reference. If it is an external reference, fetch the document and use an xml parser to parse it into a complete document tree. Select this subtree or whole document. `URI=""` indicates the whole of the current document. If present, evaluate the `IncludedXPath` with the context set at the root of subtree/whole document identified by the URI. The xpath expression should result in one or more element nodes. Modify the selection to include only those subtree(s) identified by these element node(s). Similarly evaluate the `ExcludedXPath` with the context set at the root of subtree/whole document identified by the URI. This xpath should result in one or more element nodes and/or attributes. Modify the selection to exclude all these attributes, and exclude all those subtrees identified by the element nodes If the `EnvelopedSignature` is "true", set add the current signature subtree to the list of excluded subtrees.
Selection output	a set of one or more element nodes (such that no element is a descendant of any other), and a set of zero or more exclusions consisting of element and/or ~~attribite~~ attribute nodes
Canonicalization	The canonicalization algorithm must be compatible with this selection output. [ XML-C14N20 ] must be supported.

6.7.2 Selection `Type = "...binary" "http://www.w3.org/2010/xmldsig2#binary"` and `Subtype = "...fromURI" "http://www.w3.org/2010/xmldsig2#fromURI"`

Type and SubType	`Type = "http://www.w3.org/2008/xmlsec/experimental#binary" "http://www.w3.org/2010/xmldsig2#binary"` and `Subtype = "http://www.w3.org/2008/xmlsec/experimental#fromURI" "http://www.w3.org/2010/xmldsig2#fromURI"`
Parameters	`URI`: A URI to fetch the bytes from. See section URIs for 2.0 mode . `IncludedXPath`: The XPath to be include. See section XPaths in 2.0 mode . `ByteRange`: The optional byte range parameter can be used to indicate that only a portion of the binary data should be signed. E.g. `ByteRange="0-20,220-270,320-"` indicates that the first `20` bytes, then bytes `220` to `270`, and finally bytes `320` to end of file are included.
URI syntax	The `URI` should be an external reference.
Parameter Syntax	~~<Selection Type SubType? URI> (<ByteRange/>)? </Selection>~~ <Selection Type SubType? URI> (<ByteRange/>)? </Selection>
Processing	The `URI` is expected to be an external reference. Fetch the document as an octet stream. If there is a `ByteRange` parameter, create a new octet stream with a subset of the bytes fetched. Alternatively this can be combined with the first step to intelligently fetch only the bytes in the byte range.
Selection Output	An octet stream
Canonicalization	No canonicalization should be used with this type.

6.7.3 Selection `Type = "...binary" "http://www.w3.org/2010/xmldsig2#binary"` and `Subtype = "...fromBase64Node" "http://www.w3.org/2010/xmldsig2#fromBase64Node"`

Type and SubType	`Type = "http://www.w3.org/2008/xmlsec/experimental#binary" "http://www.w3.org/2010/xmldsig2#binary"` and `Subtype = "http://www.w3.org/2008/xmlsec/experimental#fromBase64Node" "http://www.w3.org/2010/xmldsig2#fromBase64Node"`
Parameters	`URI`: A URI to a text node. See section URIs for 2.0 mode . `IncludedXPath`: The XPath to be include. See section XPaths in 2.0 mode . `ByteRange`: The optional byte range parameter can be used to indicate that only a portion of the binary data should be signed. E.g. `ByteRange="0-20,220-270,320-"` indicates that the first `20` bytes, then bytes `220` to `270`, and finally bytes `320` to end of file are included.
URI syntax	The `URI` can be an external reference or a same document reference.
Parameter Syntax	~~<Selection Type SubType? URI> (<IncludedXPath/>)? (<ByteRange/>)? </Selection>~~ <Selection Type SubType? URI> (<IncludedXPath/>)? (<ByteRange/>)? </Selection>
Processing	If the URI is a same document reference, compute the subtree pointed to by this reference. If it is an external reference, fetch the document and use an xml parser to parse it into a complete document tree. Select this subtree or whole document. `URI=""` indicates the whole of the current document. If present, evaluate the `IncludedXPath` with the context set at the root of subtree/whole document identified by the URI. The xpath expression should result in a single element node. Modify the selection to include only that subtree identified by this element node. Coalesce all the text node values into one large string and Base64 Decode that string to obtain an octet stream. If there is a `ByteRange` parameter, create a new octet stream with a subset of the bytes in the previous step.
Selection Output	An octet stream
Canonicalization	No canonicalization should be used with this type.

6.8 "2.0 Mode" Canonicalization Algorithms

[ XML-C14N20 ] must be supported. This algorithm's input consists of:

a list of subtrees with exclusions
parameter values

In addition applications may also support other canonicalization algorithms that support the same input model (subtrees with exclusions).

User defined Selection Types may define their own canonicalization algorithms, which may use this input model or even a different one.

XML Signature Syntax and Processing Version 2.0

W3C Working Draft 04 March 31 August 2010

Abstract

Status of This Document

Table of Contents

1. Introduction

1.1 Editorial and Conformance Conventions

1.2 Design Philosophy

1.3 Versions Namespaces and Identifiers

1.4 Acknowledgements

2. Signature Overview and Examples

2.1 Simple Example ( Signature , SignedInfo , Methods , and Reference s)

2.1.1 More on Reference

2.1.1.1 The Simple Example in "2.0 mode"

2.2 Extended Example ( Object and SignatureProperty )

2.3 Extended Example ( Object and Manifest )

3. Processing Rules

3.1 Signature Generation

3.1.1 Reference Generation in Compatibility mode

3.1.2 Reference Generation in 2.0 mode

3.1.3 Signature Generation

3.2 Core Validation

3.2.1 Reference check in compatibility mode

3.2.2 Reference check in 2.0 mode

3.2.3 Signature Validation in Compatibility mode

3.2.4 Signature Validation in 2.0 mode

3.2.5 Reference Validation in compatibility mode

3.2.6 Reference Validation in 2.0 mode

4. Core Signature Syntax

4.1 The ds:CryptoBinary Simple Type

4.2 The Signature element

4.3 The SignatureValue Element

4.4 The SignedInfo Element

4.4.1 The CanonicalizationMethod Element

4.4.2 The SignatureMethod Element

4.4.3 The Reference Element

4.4.3.1 Signature Modes

4.4.3.2 The URI Attribute for Reference in compatibility mode

4.4.3.3 The "Compatibility Mode" Reference Processing Model

4.4.3.4 "Compatibility Mode" Same-Document URI-References

4.4.3.5 The Transforms Element

4.4.3.6 The "Compatibility Mode" Transforms Processing Model

4.4.3.7 The "2.0 Mode" Transforms Processing Model

4.4.3.8 The dsig2:Selection Element

4.4.3.9 The dsig2:Verification element

4.4.3.10 Subtrees with optional exclusions in 2.0 mode

4.4.3.10 4.4.3.11 The URI Attribute for Selection in 2.0 mode

4.4.3.11 4.4.3.12 XPaths in 2.0 mode

4.4.3.12 4.4.3.13 The DigestMethod Element

4.4.3.13 4.4.3.14 The DigestValue Element

4.5 The KeyInfo Element

4.5.1 The KeyName Element

4.5.2 The KeyValue Element

4.5.2.1 The DSAKeyValue Element

4.5.2.2 The RSAKeyValue Element

4.5.2.3 The ECKeyValue Element

4.5.2.3.1 Explicit Curve Parameters

4.5.2.3.2 Compatibility with RFC 4050

4.5.3 The RetrievalMethod Element

4.5.4 The X509Data Element

4.5.4.1 Distinguished Name Encoding Rules

4.5.5 The PGPData Element

4.5.6 The SPKIData Element

4.5.7 The MgmtData Element

4.5.8 XML Encryption EncryptedKey and DerivedKey Elements

4.5.9 The DEREncodedKeyValue Element

4.5.10 The KeyInfoReference Element

4.6 The Object Element

5. Additional Signature Syntax

5.1 The Manifest Element

5.2 The SignatureProperties Element

5.3 Processing Instructions in Signature Elements

5.4 Comments in Signature Elements

6. Algorithms

6.1 Algorithm Identifiers and Implementation Requirements

6.2 Message Digests

6.2.1 SHA-1

6.2.2 SHA-256

6.2.3 SHA-384

6.2.4 SHA-512

2.1 Simple Example ( `Signature`, `SignedInfo`, `Methods`, and `Reference` s)

2.1.1 More on `Reference`

2.2 Extended Example ( `Object` and `SignatureProperty` )

2.3 Extended Example ( `Object` and `Manifest` )

4.1 The `ds:CryptoBinary` Simple Type

4.2 The `Signature` element

4.3 The `SignatureValue` Element

4.4 The `SignedInfo` Element

4.4.1 The `CanonicalizationMethod` Element

4.4.2 The `SignatureMethod` Element

4.4.3 The `Reference` Element

4.4.3.2 The `URI` Attribute for `Reference` in compatibility mode

4.4.3.5 The `Transforms` Element

4.4.3.8 The `dsig2:Selection` Element

4.4.3.9 The `dsig2:Verification` element

4.4.3.10 4.4.3.11 The `URI` Attribute for `Selection` in 2.0 mode

4.4.3.12 4.4.3.13 The `DigestMethod` Element

4.4.3.13 4.4.3.14 The `DigestValue` Element

4.5 The `KeyInfo` Element

4.5.1 The `KeyName` Element

4.5.2 The `KeyValue` Element

4.5.2.1 The `DSAKeyValue` Element

4.5.2.2 The `RSAKeyValue` Element

4.5.2.3 The `ECKeyValue` Element

4.5.3 The `RetrievalMethod` Element

4.5.4 The `X509Data` Element

4.5.5 The `PGPData` Element

4.5.6 The `SPKIData` Element

4.5.7 The `MgmtData` Element

4.5.8 XML Encryption `EncryptedKey` and `DerivedKey` Elements

4.5.9 The `DEREncodedKeyValue` Element

4.5.10 The `KeyInfoReference` Element

4.6 The `Object` Element

5.1 The `Manifest` Element

5.2 The `SignatureProperties` Element

6.6 "Compatibility mode" `Transform` Algorithms

6.7 "2.0 Mode" `Selection` Algorithms

6.7.1 Selection `Type="...xml" Type="http://www.w3.org/2010/xmldsig2#xml"`

6.7.2 Selection `Type = "...binary" "http://www.w3.org/2010/xmldsig2#binary"` and `Subtype = "...fromURI" "http://www.w3.org/2010/xmldsig2#fromURI"`

6.7.3 Selection `Type = "...binary" "http://www.w3.org/2010/xmldsig2#binary"` and `Subtype = "...fromBase64Node" "http://www.w3.org/2010/xmldsig2#fromBase64Node"`