view Side-By-Side changes
Date: Tue, 09 Apr 2002 09:10:04 GMT Server: Apache/1.3.20 (Unix) Last-Modified: Wed, 09 Feb 2000 17:57:00 GMT ETag: "323e9a-167ef-38a1aa6c" Accept-Ranges: bytes Content-Length: 92143 Connection: close Content-Type: text/plain XML Digital Signatures Working Group D. Eastlake, INTERNET-DRAFT IBMdraft-ietf-xmldsig-core-03.txtdraft-ietf-xmldsig-core-04.txt J. Reagle, ExpiresJuly 04,August 08, 2000 W3C/MIT D. Solo, Citigroup XML-SignatureCoreSyntax Copyright Notice Copyright (c) 2000 The Internet Society & W3C (MIT, INRIA, Keio), All Rights Reserved. IETF Status of this Memo This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC2026. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet- Drafts as reference material or to cite them other than as "work in progress." The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. W3C Status of this document This document is a production of the joint IETF/W3C XML Signature Working Group. http://www.w3.org/Signature The comparable html draft of this version may be found athttp://www.w3.org/TR/2000/WD-xmldsig-core-20000104/http://www.w3.org/TR/2000/WD-xmldsig-core-20000208/ The latest version of this draft series may be found at:http://www.w3.org/TR/xmldsig-corehttp://www.w3.org/TR/xmldsig-core/ This is a publicWG Draft. This draft includes many improvements to the exposition. Few design changes have been made,Working Draft of themost significant change is a moveIETF/W3C XML Signature Working Group . This version follows from theObjectReferenceJanuary face-to-face meeting. We hope tothe Reference element type.issue an institutional (IETF/W3C) Last Call within four weeks. This version includesthe experimental use of XML Schemaand XMLentity referencesSchema definition andDTD declarations. The XML schema declarations within the specificationa DTD; both of which are fairly mature but may containerrors, though thebugs. Eastlke, Reagle, Solo [Page 1] Internet Draft XML-SignatureCoreSyntaxJanuaryFebruary 2000complete WG schema definition does validate to the Schema DTD. We expect the final draft will include a DTD and schema. We hope to issue a Working Group last call soon, and an institutuional (IETF/W3C) last call as soon as possible afterwards.Please send comments to the editors and cc: the list <w3c-ietf-xmldsig@w3.org>. Publication as a Working Draft does not imply endorsement by the W3C membership or IESG. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite W3C Drafts as other than "work in progress." A list of current W3C working drafts can be found at http://www.w3.org/TR Patent disclosures relevant to this specification may be found on the WG's patent disclosure page. Abstract This document specifies XML digital signature processing rules andXMLsyntax. 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. Table of Contents 1. Introduction 1. Editorial Conventions 2. Design Philosophy 3. Namespaces and Identifiers 4.VersionsAcknowledgements 2. Signature Overview 1. The Signature Element 2. The SignedInfo Element 3. The Reference Element 4. The Manifestand Package ElementsElement 5. The SignatureProperties Element 3. Processing Rules 1. Signature Generation 2. Signature Validation 4. Core Signature Syntax 1. The Signature element 2. The SignatureValue Element 3. The SignedInfo Element 4. The KeyInfo Element 5. The Object Element4.5. Additional Signature Syntax 1. The Manifestand Package ElementsElement 2. The SignatureProperties Element 3. Other Useful Types 4. Processing Instructions4.5. Comments in dsig Elements5.6. Algorithms 1. AlgorithmIdentifiers, Parameters,Identifiers and Implementation Requirements 2. Message Digests 3. Message Authentication Codes 4. Signature Algorithms 5. Canonicalization Algorithms 6. Transform Algorithms Eastlke, Reagle, Solo [Page 2] Internet Draft XML-SignatureCoreSyntaxJanuaryFebruary 20005.7. XML CanonicalizationAlgorithms 6. Transform Algorithms 6. Processing Rulesand Syntax Constraint Considerations 1.GenerationXML 1.0, Syntax Constraints, and Canonicalization 2.Signature Validation 7.DOM/SAX Processing and Canonicalization 8. Security Considerations 1. Only What is Signed is Secure 2. Only What is "Seen" Should be Signed 3. Check the Security Model 4. Algorithms, Key Lengths, Etc.8. Example Syntax9.SchemaSchema, DTD, and Data Model 10.DefinitionsExample Syntax 11.Other Useful Types (normative)Definitions 12. References13. Acknowledgements (non-normative) 14. Open Issues (non-normative)_________________________________________________________________ 1.0 Introduction This document specifies XML syntax and processing rules for creating and representing digital signatures. XML Signatures can be applied to any digital content (dataobject)object), includingXML or other data. Furthermore, anXML. An XML Signature may be applied to the content of one or more resources: enveloped orenvolopingenveloping signatures are over data within the same XML document as the signature; detached signatures are over datareferenced externally via a URI.external to the signature document. Thisdocumentspecification also defines other useful types including methods of referencing collections of resources, and key management and algorithm definitions. 1.1 Editorial Conventions For readability we use the term "signature" to refer generically to public key signatures and secret key authenticators. We use the term "authenticator" and "authentication" specifically when reffering to keyed hash message authentication. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in thisdocumentspecification are to be interpreted as described in[RFC2119]. This document includes a list of open issuesRFC2119 [KEYWORDS]: "they MUST only be used where it is actually required for interoperation or to limit behavior whichare still being addressed by the working group and may include editorial comments withinhas potential for causing harm (e.g., limiting retransmissions)" Consequently, we use these capitalized keywords to unambiguously specify requirements over protocol and application features and behavior that affect the interoperability and security of implementations. These key words are not used (capitalized) to describe XML grammar; schema definitions formally and unambiguously describe such requirements and we wish to reserve the prominence of these terms for the natural language descriptions of protocols and features. For instance, an XML attribute might be described as being "optional." Compliance with thetext.XML-namespace specification is Eastlke, Reagle, Solo [Page 3] Internet Draft XML-Signature Syntax February 2000 described as "REQUIRED." 1.2 Design Philosophy The design philosophy and requirements of this specification are addressed in the XML-Signature Requirements document [XML-Signature-RD]. 1.3 Versions, Namespaces and Identifiers No provision is made for an explicit version number in this syntax. If a future version is needed, it will use a different namespace The XML namespace [XML-ns] URI that MUST be used by experimental implementations of this dated specification is:Eastlke, Reagle, Solo [Page 3] Internet Draft XML-Signature Core Syntax January 2000 xmlns="http://www.w3.org/2000/01/xmldsig/"xmlns="http://www.w3.org/2000/01/xmldsig#" This namespace is also used as the prefix for algorithm identifiers used by this specification. While applications MUST support XML and XML-namespaces, the use of internal entities [XML] or our "dsig" XML namespace prefix and defaulting/scoping conventions are OPTIONAL; we use these facilities so as to provide compact and readable examples. This specification uses Uniform Resource Identifiers [URI] to identify resources, algorithms, and semantics. The URI in the namespace declaration above is also used as a prefix for URIs under the control of this specification. For resources not under the control of this specification, we use the designated Uniform Resource Names [URN] or Uniform Resource Locators [URL] defined bytheits normative external specification. If an external specification has not allocated itself a Uniform Resource Identifier we allocate an identifier under our own namespace. For instance: SignatureProperties is identified and defined by thisspecificationsspecification's namespacehttp://www.w3.org/2000/01/xmldsig/SignaturePropertieshttp://www.w3.org/2000/01/xmldsig#SignatureProperties XSLT is identified and defined by an external namespace http://www.w3.org/TR/1999/PR-xslt-19991008 SHA1 is identified via this specification's namespace and defined via a normative referencehttp://www.w3.org/2000/01/xmldsig/SHA1http://www.w3.org/2000/01/xmldsig#sha1 FIPS PUB 180-1. Secure Hash Standard. U.S. Department of Commerce/National Institute of Standards and Technology. This specification uses both XML Schemas [XML-schema] and DTDs[XML]; while the DTD is presently more buggy, it will likely be the normative definition. Readers[XML]. (Readers unfamiliar with DTD syntax may wish to refer to Ron Bourret's "Declaring Elements and Attributes in an XMLDTD."DTD" [Bourret].) Finally, in order to provide for terse namespace declarations we sometimes use XML internal entities[XML]as[XML] as macros within URIs. For instance:<?xml version="1.0" ?> <!DOCTYPE Signature SYSTEM "xmldsig.dtd" [ <!ENTITY dsig 'http://www.w3.org/2000/01/xmldsig/'>]> ... <SignedInfo> <SignatureMethod Algorithm="&dsig;/dsaWithSHA-1"/> ... </SignedInfo> Security Comment: XML processors will automatically expand entity declarations prior to signature generation. Consequently, this feature does not permit a substitution attack whereby an attacker replaces the entity declaration with another so as to change the meaning of theEastlke, Reagle, Solo [Page 4] Internet Draft XML-SignatureCoreSyntaxJanuaryFebruary 2000signature. However, since this specification presently permits a CanonicalizationMethod of null over SignedInfo, entity declarations will not be expanded in those instances (or where the schema is not present) and we have not completely assessed the security risk. 1.4 Versions No provision is made for an explicit version number in this syntax. If a future version is needed, it is expected to use a different Namespace. 2.0 Signature Overview This section provides an overview of XML digital signature syntax and processing; the formal specification is in section-3: Core<?xml version='1.0'?> <!DOCTYPE SignatureSyntax. We assume the reader is familiar with basicSYSTEM "xmldsig-core-schema.dtd" [ <!ENTITY dsig "http://www.w3.org/2000/01/xmldsig#"> ]> <Signature xmlns="&dsig;"> <SignedInfo Id="mypage"> ... 1.4 Acknowledgements * Milton Anderson, FSTC * Mark Bartel, JetForm Corporation (Author) * John Boyer, UWI.com (Author) * Richard Brown, Globeset * Donald Eastlake 3rd, Motorola (Chair, Editor) * Barb Fox, Microsoft (Author) * Phillip Hallam-Baker, VeriSign Inc * Richard Himes, US Courts * Joseph Reagle, W3C (Chair, Editor) * Ed Simon , Entrust Technologies Inc. (Author) * Chris Smithies, PenOp * David Solo, Citigroup (Editor) * Winchel Todd Vincent III, GSU * Greg Whitehead, Signio Inc. * Gregor Karlinger, IAIK 2.0 Signature Overview This section provides an overview of XML digital signature syntax. An overview of processing appears in section 3:Processing Rules. The formal syntax is found in section 4: Core Signature Syntax andXML concepts.section 5: Additional Signature Syntax. In this section, an informal representation is used to describe the structure of the XML signature syntax. This representation omits many attributes and details. The following suffix symbols are used to represent the number of times elements may occur: "?" denotes zero or oneoccurance;occurrence; "+" denotes one or moreoccurances;occurrences; and "*" denotes zero or moreoccurances.occurrences. 2.1 The Signature Element XML Signatures are very flexible and can sign arbitrary digital content (data objects). An XML Signature is applied 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. While the data object(s) are not directly operated on by a cryptographic signature algorithm, we still refer to the signature as being over the data object(s).Frequently,Somtimes content is obtained by dereferencing an identified resource. Within an XML document, signatures are related to data objects via IDREFs [XML] and the data can be included within anenvolopingenveloping Eastlke, Reagle, Solo [Page 5] Internet Draft XML-Signature Syntax February 2000 signature or can enclose an enveloped signature. Signatures are related to external data objects via URIs [URI] and the signature and data object are said to be detached. XML digital signatures are represented by the Signature element which has the following structure: <Signature> (SignedInfo) (SignatureValue) (KeyInfo)? (Object)* </Signature> The required SignedInfo element is the information which is actually signed. SignedInfo includes a list of References to data objects andEastlke, Reagle, Solo [Page 5] Internet Draft XML-Signature Core Syntax January 2000their calculated digest value. The core validation consists of two mandatory processes: validation of the signature over SignedInfo and validation of each Reference digest within SignedInfo. The algorithms used in calculating the SignatureValue are also included in the signed information while the SignatureValue element is outside SignedInfo. KeyInfo indicates what key is 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 isoptionalOPTIONAL for two reasons. First, KeyInfo might contain information the signer does not wish to reveal to all signature verifiers. Second, the information may be known within the application's context and need not be represented explicitly.However,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. Object is an optional element for includingthe signed resourcesdata objects within the signature document. The Object can be optionally typed and/or encoded. Signature properties, such as time of signing, can be optionally included in a SignatureProperties within Object. (These properties are traditionally called signature "attributes" although that term in that context has no relationship to the XML term "attribute".) SignatureProperties can be included within an Object and signed at the signer's discretion. 2.2 The SignedInfo Element The SignedInfo element has the structure indicated below. <Signature> <SignedInfo> (CanonicalizationMethod)? (SignatureMethod) (Reference)+ </SignedInfo> Eastlke, Reagle, Solo [Page 6] Internet Draft XML-Signature Syntax February 2000 (SignatureValue) (KeyInfo)? (Object)* </Signature> The CanonicalizationMethod is the algorithm which is used to canonicalize the SignedInfo element before it is digested as part of the signature operation. In the absence of a CanonicalizationMethod element, no canonicalization is done. The SignatureMethod is the algorithm 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 or HMAC-SHA1. The algorithm names are signed to resist attacks based on substituting a weakerEastlke, Reagle, Solo [Page 6] Internet Draft XML-Signature Core Syntax January 2000algorithm. To promote application interoperability we specify mandatory to implement canonicalization, digest, and signature algorithms. We specify additional algorithms as recommended or optional and the signature design permits arbitrary signer algorithm specification. Each Reference element includes the digest method and resulting digest value calculated over the identified data object. It also may include transformations that produce 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. 2.3 The Reference Element The Reference element has the structure indicated below. ... <SignedInfo> (CanonicalizationMethod)? (SignatureMethod) (<Reference (URI=|IDREF=)? Type=?> (Transforms)? (DigestMethod) (DigestValue) </Reference>)+ </SignedInfo> ... The optional URI/IDREF attribute of Referenceidenitifiesidentifies 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.) This identification, along with the transforms,areis a description provided by the signer on howto obtainthey obtained the signedresourcedata object in the form it was digested (i.e. the digested content). The verifier Eastlke, Reagle, Solo [Page 7] Internet Draft XML-Signature Syntax February 2000 (i.e., relying party) 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(particularlysuch as a local store)otherthan that specified in the URI/IDREF. The optional Type attribute provides information about thecontent of theresource identified by the URI/IDREF. In particular, it can indicate that itcontains ais an Object, SignatureProperties,Manifest,orPackageManifest element. Thisinformation need notcan be usednor verifiedbythe receiving application. Transforms is an optional ordered list ofapplications to initiate special processingsteps that are appliedof some Reference elements. References tothe resource's content before it is digested.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 behaviour. Transforms is an optional ordered list of processing steps that were applied to the resource's content before it is digested. Transforms can includearbitrary specificationsoperations such as canonicalization, encoding/decoding (including compression/inflation), XSLT and XPath. XPath transforms permit the signer to derive an XML document thatEastlke, Reagle, Solo [Page 7] Internet Draft XML-Signature Core Syntax January 2000omits portions of the source document. Consequently those excluded portions can change without affecting signature validity (this is how the Working Group satisfied the requirement of signing portions of a document.) For example, if the resource being signed encloses the signature itself, such a transform must be used to exclude the signature value from its owncomputationcomputation. If no Transforms element is present, the resource's content is digested directly.ArbritraryArbitrary user specified transforms are permitted. To promote interoperability, we specify mandatory to implement canonicalization and decoding transformation algorithms. Additional canonicalization, coding, XSLT, and XPath based transform algorithms are specified as recommended oroptional;optional. 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 bind's a resources content to the signer's key. 2.4 The Manifestand Package ElementsElement The Manifestand Package elements are includedelement is provided to meet additional requirements not directly addressed by thisdocument.mandatory part of this specification. The level of indirection provided by these elements readily meets these requirements. Two examples follow. First, applications frequently need to efficiently sign multiple dataobjects.objects even where the signature operation itself is an expensive public key signature. This requirement can be achieved by including multiple References withinSignedInfo.SignedInfo since the inclusion of each digest secures the data digested. However, some applications may not want the core validationbehaviourbehavior associated with thisapproach: each Referenceapproach Eastlke, Reagle, Solo [Page 8] Internet Draft XML-Signature Syntax February 2000 because it requires References within SignedInfoundergoesto undergo reference validation -- theDigestValuesDigestValue elements are checked. Some 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 References. 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 References as valid. Second, consider an application where many signatures (using different keys) are applied tothousandsa large number of documents. An inefficient solution is to have aseperateseparate signature (per key) repeatedly applied to a large SignedInfo element (withthousands ofmany References); this isverywasteful and redundant. To address these requirements,additionalthe Manifest elementtypes havetype has been defined which may be referenced by SignedInfoReferences.Reference elements. First, the Manifest element may contain a collection ofReferences and Objects,References, but leaves reference validation up to the application. Thus the first case above can be solved by simply putting one reference inside SignedInfo to a Manifest which references the three data objects. Second, multiple signatures overthe thousandsa large number of References need only point to a single Manifest with the many references. The structure of Manifest, which reuses the Referenceand Object elementselement described above, is as follows:Eastlke, Reagle, Solo [Page 8] Internet Draft XML-Signature Core Syntax January 2000<Manifest>(Reference)+ (Object)*(Reference)* </Manifest>A Package is syntactically identical to a Manifest, and may appear anywhere a Manifest may appear, but asserts the identity of each of its Reference elements after Transforms application.Manifestand Packagemay appear as the content of an Object.2.5 The SignatureProperties Element This specification does not address mechanisms for making statements or assertions.Note that an application could decide whether to verify a DigestValue in a Manifest based on the Type given in the enclosing Reference. 2.5 The SignatureProperties Element This specification does not address mechanisms for making statements or assertions. Instead, this whole documentsinglysimply defines what it means for something to be signed by an XML Signature (message authentication, integrity, and/or signer authentication). Applications that wish to represent other semantics must rely upon other technologies, such as [XML, XML-schema, RDF]. However, we do define a SignatureProperties element type for the inclusion of assertions abouthowthe signaturewas produceditself (e.g., the time of signing or the serial number of hardware used in cryptographic processes).We do not define those element types however, they may, orSuch assertions maynot be,be signedviaby including aReference, as desired.Reference for the SignatureProperties in SignedInfo. <SignatureProperties> (SignatureProperty Target=)+)* </SignatureProperties> Eastlke, Reagle, Solo [Page 9] Internet Draft XML-Signature Syntax February 2000 The structure of SignatureProperties is shown above. Any content about the signature generation may be located within the SignatureProperty element. The mandatory Target attribute references the element to which the property applies. In particular, target may include a reference to a SignedInfo or Reference element. 3.0Core Signature SyntaxProcessing Rules Thegeneral structuresections below describe the operations to be performed as part ofan XMLsignatureis described in section-2: Signature Overview. This section provides detailed syntax ofgeneration and validation. 3.1 Generation The REQUIRED steps include thecore signature featuresgeneration of References andactual examples. Features described in this section are mandatorythe SignatureValue over SignedInfo. 3.1.1 Reference Generation For each data object being signed: 1. Apply the Transforms, as determined by the application, toimplement unless otherwise indicated. The syntax is defined via [XML-Schema] withthefollowing XML preamble, declaration,data object. 2. Calculate the digest value over the resulting data object. 3. Create a Reference element, including the (optional) identification of the data object, any (optional) transform elements, the digest algorithm andinternal entity: Schema Definition: <?xml version='1.0'?> <!DOCTYPE schema SYSTEM 'http://www.w3.org/TR/1999/WD-xmlschema-1-19991217/structures.dtd' [ <!ENTITY dsig 'http://www.w3.org/2000/01/xmldsig/'> ]> <schema targetNamespace='http://www.w3.org/2000/01/xmldsig/' Eastlke, Reagle, Solo [Page 9] Internet Draft XML-Signature Core Syntax January 2000 version='0.1' xmlns='http://www.w3.org/1999/XMLSchema'> 3.1 The Signature element Thethe DigestValue. 3.1.2 Signature Generation 1. Create SignedInfo elementiswith SignatureMethod, CanonicalizationMethod if required, and Reference(s). 2. Canonicalize and then calculate therootSignatureValue over SignedInfo based on algorithms specified in SignedInfo. 3. Construct the Signature elementof a XML Signature. A simple example of a complete signature follows: Example: <!DOCTYPE Signature [ <!ENTITY dsig 'http://www.w3.org/2000/01/xmldsig/'>]> <Signature xmlns="http://www.w3.org/2000/01/xmldsig/"> <SignedInfo> <CanonicalizationMethod Algorithm="http://www.w3.org/1999/07/WD-xml-c14n-19990729"/> <SignatureMethod Algorithm="&dsig;/dsaWithSHA-1"/> <Reference Location="http://www.mypage.com"> <DigestMethod Algorithm="&dsig;/sha1"/> <DigestValue encoding="&dsig;/base64">a23bcd43</DigestValue> </Reference> </SignedInfo> <SignatureValue>dd2323dd</SignatureValue> <KeyInfo> <KeyName>Solo</KeyName> </KeyInfo> </Signature> Note: this example willthat includes SignedInfo, Object (s) (if desired, encoding may berevised to include generated hash/signature valuesdifferent than thatvalidate. Schema Definition: <element name='Signature'> <type content='elementOnly'> <group order='seq' minOccurs='1' maxOccurs='1'> <element ref='SignedInfo' minOccurs='1' maxOccurs='1'/> <element ref='SignatureValue' minOccurs='1' maxOccurs='1'/> <element ref='KeyInfo' minOccurs='0' maxOccurs='1'/> <element ref='Object' minOccurs='0' maxOccurs='*'/> </group> <attribute name='Id' type='ID' minOccurs='0' maxOccurs='1'/> </type> </element> DTD: <!ELEMENT Signature (SignedInfo, SignatureValue, KeyInfo?, Object*)> <!ATTLIST SignedInfo Id ID #IMPLIED>used for signing), KeyInfo (if required), and SignatureValue. 3.2 Validation TheSignatureValue Element The SignatureValue element containsREQUIRED steps of core validation include (1) reference validation, theactual valueverification of thedigital signature. The encodingdigest contained in each Reference in SignedInfo, and (2) the cryptographic signature validation ofthis value is determinedthe signature calculated over SignedInfo. 3.2.1 Reference Validation For each Reference in SignedInfo: 1. Obtain the data object to be digested. (The signature application may rely upon the identification (URI/IDREF) and 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. Eastlke, Reagle, Solo [Page 10] Internet Draft XML-SignatureCoreSyntaxJanuaryFebruary 2000SignatureMethod. Base64 [MIME]3. Compare the generated digest value against DigestValue in SignedInfo; if there is any mismatch, validation fails. 3.2.2 Signature Validation 1. Canonicalize the SignedInfo element based on the CanonicalizationMethod, if any, in SignedInfo. 2. Obtain the keying information from KeyInfo or from an external source. 3. Use theencoding method for all SignatureMethodsspecifiedwithin this specification. The ability to define aSignatureMethodand SignatureValue pairto validate the SignatureValue over the (optionally canonicalized) SignedInfo element. 4.0 Core Signature Syntax The general structure of an XML signature is described in section 2: Signature Overview. This section provides detailed syntax of the core signature features and actual examples. Features described in this section are mandatory to implement unless otherwise indicated. The syntax is defined via [XML-Schema] with the following XML preamble, declaration, and internal entity: Schema Definition: <?xml version='1.0'?> <!DOCTYPE schema SYSTEM 'http://www.w3.org/TR/1999/WD-xmlschema-1-19991217/structures.dtd' [ <!ENTITY dsig 'http://www.w3.org/2000/01/xmldsig#'> ]> <schema targetNamespace='&dsig;' version='0.1' xmlns='http://www.w3.org/1999/XMLSchema' xmlns:ds='&dsig;'> 4.1 The Signature element The Signature element is the root element of a XML Signature. A simple example of a complete signature follows: Dummy Example: <!DOCTYPE Signature [ <!ENTITY dsig 'http://www.w3.org/2000/01/xmldsig#'>]> <Signature xmlns="http://www.w3.org/2000/01/xmldsig#"> <SignedInfo> <CanonicalizationMethod Algorithm="http://www.w3.org/1999/07/WD-xml-c14n-19990729/" /> <SignatureMethod Algorithm="&dsig;dsaWithSHA-1"/> <Reference Location="http://www.mypage.com"> <DigestMethod Algorithm="&dsig;sha1"/> <DigestValue>a23bcd43</DigestValue> </Reference> </SignedInfo> Eastlke, Reagle, Solo [Page 11] Internet Draft XML-Signature Syntax February 2000 <SignatureValue>C0CFFrVLtRlk</SignatureValue> <KeyInfo> <KeyValue>MIIBtzCCASwGByqGSM44BAE</KeyValue> </KeyInfo> </Signature> Schema Definition: <element name='Signature'> <type content='elementOnly'> <group order='seq' minOccurs='1' maxOccurs='1'> <element ref='ds:SignedInfo' minOccurs='1' maxOccurs='1'/> <element ref='ds:SignatureValue' minOccurs='1' maxOccurs='1'/> <element ref='ds:KeyInfo' minOccurs='0' maxOccurs='1'/> <element ref='ds:Object' minOccurs='0' maxOccurs='*'/> </group> <attribute name='Id' type='ID' minOccurs='0' maxOccurs='1'/> </type> </element> DTD: <!ELEMENT Signature (SignedInfo, SignatureValue, KeyInfo?, Object*) > <!ATTLIST Signature xmlns CDATA #FIXED 'http://www.w3.org/2000/01/xmldsig#' Id ID #IMPLIED > 4.2 The SignatureValue Element The SignatureValue element contains the actual value of the digital signature. The encoding of this value is determined by SignatureMethod. Base64 [MIME] is the encoding method for all SignatureMethods specified within this specification. The ability to define a SignatureMethod and SignatureValue pair which includes multiple distinct signatures is explicitly permitted (e.g. "rsawithsha-1 and ecdsawithsha-1"). Schema Definition: <element name='SignatureValue' type='string'/> DTD: <!ELEMENT SignatureValueCDATA(#PCDATA) >3.34.3 The SignedInfo Element The structure of SignedInfo includes the canonicalization algorithm (if any), a signature algorithm, and one or morereferences to objects.references. The SignedInfo element may contain an optional ID attribute that will allow it to be referenced by other signatures and objects. Schema Definition: <element name='SignedInfo'> <type content='elementOnly'> <group order='seq' minOccurs='1' maxOccurs='1'> <elementref='CanonicalizationMethod'ref='ds:CanonicalizationMethod' minOccurs='0'maxOccurs='1'/>maxOccurs='1'/ Eastlke, Reagle, Solo [Page 12] Internet Draft XML-Signature Syntax February 2000 > <elementref='SignatureMethod'ref='ds:SignatureMethod' minOccurs='1' maxOccurs='1'/> <elementref='Reference'ref='ds:Reference' minOccurs='1' maxOccurs='*'/> </group> <attribute name='Id' type='ID' minOccurs='0' maxOccurs='1'/> </type> </element> DTD: <!ELEMENTSignedInfo(CanonicalizationMethod,SignedInfo (CanonicalizationMethod?, SignatureMethod,Reference+ )Reference+) > <!ATTLIST SignedInfo Id ID #IMPLIED > SignedInfo does not include explicit signature or digest properties (such assigningcalculation time,signing device,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 found within an Objectelement that is referenced by a Reference. See the SignatureProperties element below. 3.3.1element. 4.3.1 The CanonicalizationMethod Element CanonicalizationMethod is an optional element which specifies the canonicalization algorithm applied to the SignedInfo element prior to performing signature calculations. This element uses the general structure here for algorithms described insection-5.1:section 5.1: Algorithm Identifiers. Possible options may include a minimal algorithm (CRLF and charset normalization), or more extensive operations such as [XML-C14N]. If the CanonicalizationMethod is omitted, no change isEastlke, Reagle, Solo [Page 11] Internet Draft XML-Signature Core Syntax January 2000made toSignedInfo.SignedInfo before digesting. (Note this may lead to interoperability failures as other applications may not serialize it as the creators application did by default.) Schema Definition: <element name='CanonicalizationMethod'> <type content='elementOnly'><element ref='Parameter' minOccurs='1' maxOccurs='1'/><attribute name='Algorithm' type='uri' minOccurs='1' maxOccurs='1'/><type></type> </element> DTD: <!ELEMENT CanonicalizationMethodParameter*ANY > <!ATTLIST CanonicalizationMethod Algorithm CDATA #REQUIRED >3.3.24.3.2 The SignatureMethod Element SignatureMethod is a required element which 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 5.1. While there is a single identifier, that identifier Eastlke, Reagle, Solo [Page 13] Internet Draft XML-Signature Syntax February 2000 may specify a format containing multiple distinct signature values. Schema Definition: <element name='SignatureMethod'> <type content='elementOnly'><element ref='Parameter' minOccurs='0' maxOccurs='*'/><attribute name='Algorithm' type='uri' minOccurs='1' maxOccurs='1'/> </type> </element> DTD: <!ELEMENT SignatureMethodParameter*ANY > <!ATTLIST SignatureMethod Algorithm CDATA #REQUIRED >3.3.34.3.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 the object being signed, the type of the object, and/or a list of transforms to be applied prior to digesting. The identification, and transforms are information provided to inform the verifier how the digested content (i.e., the input to the digest method) may be 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 beeasilyreferenced from elsewhere.Eastlke, Reagle, Solo [Page 12] Internet Draft XML-Signature Core Syntax January 2000Schema Definition: <element name='Reference'> <type content='elementOnly'> <group order='seq' minOccurs='1' maxOccurs='1'> <elementref='Transforms'ref='ds:Transforms' minOccurs='0' maxOccurs='1'/> <elementref='DigestMethod'ref='ds:DigestMethod' minOccurs='1' maxOccurs='1'/> <elementref='DigestValue'ref='ds:DigestValue' minOccurs='1' maxOccurs='1'/> </group> <attribute name='Id' type='ID' minOccurs='0' maxOccurs='1'/> <attribute name='URI' type='uri' minOccurs='0' maxOccurs='1'/> <attribute name='IDREF' type='IDREF' minOccurs='0' maxOccurs='1'/> <attribute name='Type' type='uri' minOccurs='0' maxOccurs='1'/> </type> </element> DTD: <!ELEMENTObjectReference ( Transforms?,Reference (Transforms?, DigestMethod,DigestValue )DigestValue) > <!ATTLISTObjectReferenceReference Id ID #IMPLIED URI CDATA #IMPLIED IDREFCDATAIDREF #IMPLIED Type CDATA #IMPLIED><!-- The values of URI and Type conform to the productions specified by [URI] -->The URI/IDREF attribute identifies a data object using a URI [URI] or IDREF [XML]. We distinguish between URIs and IDREFs so as to provide Eastlke, Reagle, Solo [Page 14] Internet Draft XML-Signature Syntax February 2000 expositional clarity and ease signature processing. Note there is some popular confusion about URIs and fragment identifiers. As specified by RFC2396 [URI], URIs can be used in conjunction with a fragment identifier by use of a separating pound symbol '#', but the URI proper does not include the fragment identifier. (The meaning of the fragment is defined by the resource's MIME type). URI/IDREF only permits a 'clean' URI or IDREF; fragment identification is specified under Transforms. This choice permits References to identify a fragment of a document that is encoded: the Reference identifies the resource, the first Transformspecifiescould specify decoding, and the second Transformspecifiescould specify thefragement.fragment. Note that a null URI (URI="") is permitted and identifies the document the reference is in (the root element). If the URI/IDREF attribute is omitted all-together, the receiving application is expected to know the identity of the object. For example, a lightweight data protocol mightommitomit this attribute given the identity of the object is part of the application context. This attribute may be omitted from at most one Reference in any particular SignedInfo,Manifest,orPackage.Manifest. The digest algorithm is applied to the data octets being secured. Typically that is done by locating (possibly using the URI/IDREF if provided) the data and transforming it. If the data is an XMLEastlke, Reagle, Solo [Page 13] Internet Draft XML-Signature Core Syntax January 2000document, the document is assumed to be unparsed prior to the application of Transforms. If there are no Transforms, then the data is passed to the digest algorithm unmodified. The optional Type attribute contains information about the type of object beingsigned (e.g. manifest, package, signature properties, document).signed. This is represented as a URI. For example:Type="&dsig;/Manifest" Type="&dsig;/SignatureProperty" 3.3.3.1Type="http://www.w3.org/2000/01/xmldsig#Object" Type="http://www.w3.org/2000/01/xmldsig#Manifest" Type="http://www.w3.org/2000/01/xmldsig#SignatureProperty" TheTransforms Element Transforms is an optional element that contains one or more operations to be performed on an indicated data object priorType attribute applies todigest calculation. (These operations are different from the CanonicalizationMethod specified intheSignature whichitem being pointed at, not its contents. For example, a reference that identifies an Object element containing a SignatureProperties element isapplied to SignedInfo.) Ifstill of type #Object. The type attribute is advisory. No validation of theTransforms elementtype information isomitted, no operations are indicated.required by this specification. 4.3.3.1 The Transforms Element The optional Transforms element contains an ordered list of Transformelements.elements; these describe how the signer obtained the data object that was digested. The output of each Transformserves(octets) serve as input to the next Transform. The input to the first Transform is the source data. The output from the last Transform is the input for the DigestMethod algorithm. When transforms are applied the signer is not signing the native (original) document but the resulting (transformed) document[sec-7.2:[section 7.2: Only What is "Seen" Should be Signed]. Eastlke, Reagle, Solo [Page 15] Internet Draft XML-Signature Syntax February 2000 Each Transform consists of an Algorithm attribute, optionalTypeMimeType and Charset attributes, 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 input resource. The optionalTypeMimeType and Charset (IANA registered character set) attributes are made available to algorithms which need and are otherwise unable to deduce that information about the data they are processing. Schema Definition: <element name='Transforms' > <type content='elementOnly'> <elementref='Transform'ref='ds:Transform' minOccurs='1' maxOccurs='*'/> </type> </element> <element name='Transform'> <type content='elementOnly'><element ref='Parameter' minOccurs='0' maxOccurs='*'/><attribute name='Algorithm' type='string' minOccurs='1' maxOccurs='1'/> <attributename='Type' type='uri'name='MimeType' type='string' minOccurs='0' maxOccurs='1'/> <attribute name='Charset' type='string' minOccurs='0'Eastlke, Reagle, Solo [Page 14] Internet Draft XML-Signature Core Syntax January 2000maxOccurs='1'/> </type> </element> DTD: <!ELEMENT TransformsTransform+>(Transform+)> <!ELEMENT Transform ANY><!-- Including dsig:Parameter --><!ATTLIST Transform Algorithm CDATA #REQUIREDTypeMimeType CDATA #IMPLIED Charset CDATA #IMPLIED ><!-- The Type conforms to the productions specified by [URI] -->Examples of transforms include but are not limited to base-64 decoding [MIME], canonicalization [XML-c14n], XPath filtering[Xpath],[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 base-64 encoded parameter tothea 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. Section 5-6: Transform Algorithms defines the list of standard transformations.3.3.3.24.3.3.2 The DigestMethod Element DigestMethod is a required element which identifies the digest algorithm to be applied to the signed object. This element uses the general structure here for algorithms specified insection-5.1:section 5.1: Algorithm Identifiers. Eastlke, Reagle, Solo [Page 16] Internet Draft XML-Signature Syntax February 2000 Schema Definition: <element name='DigestMethod'> <type content='elementOnly'><element ref='Parameter' minOccurs='0' maxOccurs='*'/><attribute name='Algorithm' type='uri' minOccurs='1' maxOccurs='1'/> </type> </element> DTD: <!ELEMENT DigestMethodParameter*ANY > <!ATTLIST DigestMethod Algorithm CDATA #REQUIRED ><!-- Where CDATA conforms to the productions specified by [URI] --> 3.3.3.34.3.3.3 The DigestValue Element DigestValue is an element which contains the encoded value of the digest. Theoptional Encoding attribute gives the encoding method which defaults todigest is always encoded using Base 64 [MIME].Eastlke, Reagle, Solo [Page 15] Internet Draft XML-Signature Core Syntax January 2000Schema Definition: <elementname='DigestValue'> <type source='string'> <attribute name='Encoding' type='uri' default='&dsig;/Base64' minOccurs='0' maxOccurs='1'/> </type> </element>name='DigestValue' type='ds:encoded'/> DTD: <!ELEMENT DigestValueCDATA>(#PCDATA) > <!-- base64 encoded signature value -->3.44.4 The KeyInfo Element KeyInfo may contain keys, names, certificates and other public key management information (such asinbandin-band key distribution or agreement data or data supporting any other method.) This specification defines a few simple types but applications may place their own key identification and exchange semantics within this element through the XML-namespace facility. [XML-namespace] Schema Definition: <element name='KeyInfo'> <type content='elementOnly'> <group order='choice' minOccurs='1'maxOccurs='1'>maxOccurs='*'> <element name='KeyName' type='string'/> <element name='KeyValue' type='string'/> <elementname='SubjectName' type='string'/> <elementname='RetrievalMethod'type='string'/>type='uri'/> <elementref='X509Data'/>ref='ds:X509Data'/> <elementref='PGPData'/>ref='ds:PGPData'/> <element name='MgmtData' type='string' minOccurs='0' maxOccurs='1'/> <any/> </group> <attribute name='Id' type='ID' minOccurs='0' maxOccurs='1'/> </type> </element> DTD: <!ELEMENT KeyInfo(KeyName((KeyName | KeyValue |SubjectName |RetrievalMethod |x509DataX509Data | PGPData |MgmtData)* )>MgmtData)*) > Eastlke, Reagle, Solo [Page 17] Internet Draft XML-Signature Syntax February 2000 <!ATTLIST KeyInfo Id ID #IMPLIED> <!ELEMENT KeyName(#PCDATA)>(#PCDATA) > <!ELEMENT KeyValue(#PCDATA)> <!ELEMENT SubjectName(#PCDATA) > <!ELEMENT RetrievalMethod (#PCDATA) > KeyInfo is an optional element which enables the recipient(s) to obtain the key(s) needed to validate the signature. If omitted, theEastlke, Reagle, Solo [Page 16] Internet Draft XML-Signature Core Syntax January 2000recipient is expected to be able to identify the key based on application context information.This element contains oneMultiple declarations within KeyInfodata element providing information forrefer to therecipient(s).same key. Applications may define and use any mechanism they choose through inclusion of elements from a different namespace. Compliant versions implementing KeyInfo MUST implement KeyValue, and SHOULD implement RetrievalMethod. * KeyName contains an identifier for the key which may be useful to the recipient. This may be a simple string name, index, encoded DN, email address, etc. * KeyValue contains the actual key(s) used to validate the signature. If the key is sent in protected form, the MgmtData element should be used. Specific types must be defined for each algorithm type (see algorithms). *SubjectName contains one or more names for the sender. Forms to be supported include a simple name string, encoded DN, email address, etc. *RetrievalMethod is a URI which may be used to obtain key and/or certificate information. The URI should contain the complete string for retrieving the key needed for this message (rather than a generic URI). * X509Data contains an identifier of the key/cert used for validation (either an IssuerSerial value, a subject name, or a subjectkeyID) and an optional collection of certificates and revocation/status information which may be used by the recipient. IssuerSerial contains the encoded issuer name (RFC 2253) along with the serial number. * PGPData data associated with a PGP key. * MgmtData contains in-band key distribution or agreement data. Examples may include DH key exchange, RSA key encryption etc. SchemaDefinition:Definition <element name='X509Data'> <type content='elementOnly'> <group order='seq' minOccurs='1' maxOccurs='1'> <group order='choice' minOccurs='1' maxOccurs='1'> <elementref='X509IssuerSerial'/>ref='ds:X509IssuerSerial'/> <element name='X509SKI' type='string'/> <elementname='X509Name'name='X509SubjectName' type='string'/> </group> <element name='X509Certificate' type='string' minOccurs='0'maxOccurs='1'/>maxOccurs=' *'/> <element name='X509CRL' type='string' minOccurs='0'maxOccurs='1'/> <group>maxOccurs='*'/> </group> </type> </element> Eastlke, Reagle, Solo [Page 18] Internet Draft XML-Signature Syntax February 2000 <element name='X509IssuerSerial'> <type content='elementOnly'> <group order='seq' minOccurs='1' maxOccurs='1'> <elementname='X509Name'name='X509IssuerName' type='string' minOccurs='1'maxOccurs='1'/>maxOccurs=' 1'/> <element name='X509SerialNumber' type='string' minOccurs='1'Eastlke, Reagle, Solo [Page 17] Internet Draft XML-Signature Core Syntax January 2000 maxOccurs='1'/>maxOccurs ='1'/> </group> </type> </element> <element name='PGPData'> <type content='elementOnly'> <group order='seq' minOccurs='1' maxOccurs='1'> <element name='PGPKeyID' type='string' minOccurs='1' maxOccurs='1'/> <element name='PGPKeyPacket' type='string' minOccurs='1'maxOccurs='1'/>maxOccurs='1' /> </group> </type> </element> DTD: <!ELEMENT X509Data ((X509IssuerSerial | X509SKI |X509Name), (X509Certificate | X509CRL)* ) >X509SubjectName), X509Certificate*, X509CRL*)> <!ELEMENT X509IssuerSerial(X509Name, X509SerialNumber)>(X509IssuerName, X509SerialNumber) > <!ELEMENTX509Name (#PCDATA)> <!-- Where the name is encoded accroding to RFC 2253 -->X509IssuerName (#PCDATA) > <!ELEMENT X509SubjectName (#PCDATA) > <!ELEMENT X509SerialNumber(#PCDATA)> <!-- Where the data is the serial number encoded as a decimal integer -->(#PCDATA) > <!ELEMENT X509SKI(#PCDATA)> <!-- Where the data consists of the SKI base64 encoded -->(#PCDATA) > <!ELEMENT X509Certificate(#PCDATA)> <!-- Where the data conists of the base64 encoded certificate -->(#PCDATA) > <!ELEMENT X509CRL(#PCDATA)> <!-- Where the data consists of the base64 encoded CRL --> <!ELEMENT(#PCDATA) > <!ELEMENT PGPData (PGPKeyID,PGPKeyPacket?)> <!ELEMENT PGPKeyID (#PCDATA)> <!-- Where the data conists of the hex encoding of the key ID. -->PGPKeyPacket?) > <!ELEMENT PGPKeyPacket(#PCDATA)> <!-- Where the data consists of the base64 encoded key packet --->(#PCDATA) > <!ELEMENT PGPKeyID (#PCDATA) > <!ELEMENT MgmtData (#PCDATA)>3.54.5 The Object Element Object is an optional element which 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 MimeType attribute is an optional attribute which describes the data within the Object. This is a string with values defined by [MIME]. For example, if the Object contains XML, the MimeType would be text/xml. This attribute is purely advisory, no validation of the MimeType informatin is required by this specification. The Object's ID is commonly referenced fromana Reference in SignedInfo,ManifestorPackage.Manifest. This element is typically used forenvolopingenveloping signatures where the object being signed is to be included in the signature document. The digest is calculated over the entire Object element including start and end tags. Eastlke, Reagle, Solo [Page 19] Internet Draft XML-Signature Syntax February 2000 Note, if the application wishes to exclude the <Object> tags from the digest calculation the Reference must identify theacualactual data object (easy for XML documents) or a transform must be used to remove the Object tags (likely where the data object is non-XML). Exclusion ofEastlke, Reagle, Solo [Page 18] Internet Draft XML-Signature Core Syntax January 2000the 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 content='mixed'> <any namespace='##targetNamespace'/> <attribute name='Id' type='ID' minOccurs='0' maxOccurs='1'/> <attributename='Type' type='uri'name='MimeType' type='string' minOccurs='0' maxOccurs='1'/> <attribute name='Encoding' type='uri' minOccurs='0' maxOccurs='1'/> </type> </element> DTD: <!ELEMENT ObjectANY>(#PCDATA) > <!ATTLIST Object Id ID #IMPLIEDType CDATA #IMPLIED EncodingMimeType CDATA #IMPLIED> <!-- Where type and encoding CDATA conforms to the productions specified by [URI] --> 3.6 The Parameter Element Algorithms are provided with parameters and input data, when necessary, by having Parameter elements in the content of the algorithm element. Algorithms also have implicit input, such as the canonicalized SignedInfo for SignatureMethod and the transformed data for DigestMethod. Where more than one Parameter appears, they are passed to the algorithm as an ordered vector corresponding to the order they appear in the algorithm element content. Schema Definition: <element name='Parameter'> <type content='mixed'> <attribute name='Encoding' type='uri' minOccurs='0' maxOccurs='1'/> </type> </element> DTD: <!ELEMENT Parameter #PCDATA> <!ATTLIST ParameterEncoding CDATA #IMPLIED ><!-- Encoding CDATA conforms to the productions specified by [URI] --> Eastlke, Reagle, Solo [Page 19] Internet Draft XML-Signature Core Syntax January 2000 4.05.0 Additional Signature Syntax This section describes the optional to implementManifest, SignatureProperties,Manifest andPackageSignatureProperties elements and describes the handling of XML Processing Instructions and Comments. With respect to the elementsManifest, SignatureProperties,Manifest andPackage,SignatureProperties this section specifies syntax and littlebehaviourbehavior -- it is left to the application. These elements can appear anywhere the parent's content model permits; thesignatureSignature content model only permits them within Object.4.15.1 The Manifestand Package ElementsElement The Manifest element provides a list of References. 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 application discretion. If a Manifest is referenced from another Manifest, even the overall digest of this two level deep Manifest might not be checked.A Package is syntactically identical to a Manifest, and may appear anywhere a Manifest may appear, but asserts the identity of each of its Reference elements after Transforms application. The testing of this relationship and consequent action is at the discretion of the applicaiton.Schema Definition: Eastlke, Reagle, Solo [Page 20] Internet Draft XML-Signature Syntax February 2000 <element name='Manifest'> <type content='elementOnly'> <group order='seq' minOccurs='1' maxOccurs='1'> <elementref='Reference' minOccurs='1' maxOccurs='*'/> <element ref='Object' minOccurs='0' maxOccurs='*'/> </group> <attribute name='Id' type='ID' minOccurs='0' maxOccurs='1'/> </type> </element> <element name='Package'> <type content='elementOnly'> <group order='seq' minOccurs='1' maxOccurs='1'> <element ref='Reference'ref='ds:Reference' minOccurs='1' maxOccurs='*'/> <elementref='Object'ref='ds:Object' minOccurs='0' maxOccurs='*'/> </group> <attribute name='Id' type='ID' minOccurs='0' maxOccurs='1'/> </type> </element> DTD: <!ELEMENT Manifest( (Reference((Reference |Object )+ )Object)+) > <!ATTLIST ManifestEastlke, Reagle, Solo [Page 20] Internet Draft XML-Signature Core Syntax January 2000 Id ID #IMPLIED > <!ELEMENT Package ( (Reference | Object )+ ) > <!ATTLIST PackageId ID #IMPLIED >4.25.2 The SignatureProperties Element 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 content='elementOnly'> <elementref='SignatureProperty'ref='ds:SignatureProperty' minOccurs='1' maxOccurs='*'/> <attribute name='Id' type='ID' minOccurs='0' maxOccurs='1'/> </type> </element> <element name='SignatureProperty'> <type content='mixed'> <any namespace='##other'/> <attribute name='Target' type='IDREF' minOccurs='1' maxOccurs='1'/> </type> </element> DTD: <!ELEMENT SignaturePropertiesSignatureProperty(SignatureProperty*) > <!ATTLIST SignatureProperties Id ID#IMPLIED>#IMPLIED > <!ELEMENT SignaturePropertyANY(#PCDATA) > <!ATTLIST SignatureProperty Target IDREF #REQUIRED >4.3 Processing Instructions TDB - will specify the use, if any, of XML processing instructions by this specification and the handling of PIs appearing within elements specified in this document. 4.4 Comments in dsig Elements TDB - will specify5.3 Other Useful Types We define theuse, if any, and handling of XML comments appearing within elements specifiedfollowing URIs for use inthis document. 5.0 Algorithms This section identifies algorithms used with theidentifying XMLdigitalresources that include non-core but signaturestandard. Entries containrelated semantics. http://www.w3.org/2000/01/xmldsig#Object designates that theidentifier to be used in Signature elements,referenced resource is areference to the formal specification, and definitions, where applicable, for the representation of keys and the results of cryptographic operations.Signature Object element type. Eastlke, Reagle, Solo [Page 21] Internet Draft XML-SignatureCoreSyntaxJanuaryFebruary 20005.1 Algorithm Identifiers, Parameters, and Implementation Requirements Algorithms are identified by URIshttp://www.w3.org/2000/01/xmldsig#SignatureProperties designates thatappear as an attribute totheelement that identifiesreferenced resource is a statement about thealgorithms' role (DigestMethod, Transform, SignatureMethod, or CanonicalizationMethod). All algorithms used herein take parameters but in many casesreferring signature. http://www.w3.org/2000/01/xmldsig#Manifest designates that theparameters arereferenced resource is a collection of other resources. 5.5 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 CanonicalizationMethods specified 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.5 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, they will be signed. Consequently, 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-canonicalization], is specified. 6.0 Algorithms This section identifies algorithms used with the XML digital signature standard. 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 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 (or SignedInfo directly if there is no 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 Eastlke, Reagle, Solo [Page 22] Internet Draft XML-Signature Syntax February 2000 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. Algorithm Type Algorithm Requirements Algorithm URI Digest SHA1 REQUIREDhttp://www.w3.org/2000/01/xmldsig/sha1http://www.w3.org/2000/01/xmldsig#sha1 Encoding Base64 REQUIREDhttp://www.w3.org/2000/01/xmldsig/base64http://www.w3.org/2000/01/xmldsig#base64 QuotedPrintable RECOMMENDEDhttp://www.w3.org/2000/01/xmldsig/qphttp://www.w3.org/2000/01/xmldsig#qp MAC HMAC-SHA1 REQUIREDhttp://www.w3.org/2000/01/xmldsig/hmac-sha1http://www.w3.org/2000/01/xmldsig#hmac-sha1 Signature DSAwithSHA1 (DSS) REQUIREDhttp://www.w3.org/2000/01/xmldsig/dsahttp://www.w3.org/2000/01/xmldsig#dsa RSAwithSHA1 RECOMMENDEDhttp://www.w3.org/2000/01/xmldsig/rsa-sha1http://www.w3.org/2000/01/xmldsig#rsa-sha1 [[DELETE]] ECDSAwithSHA1 OPTIONALhttp://www.w3.org/2000/01/xmldsig/ecdsahttp://www.w3.org/2000/01/xmldsig#ecdsa Canonicalization minimal REQUIREDhttp://www.w3.org/2000/01/xmldsig/minimalhttp://www.w3.org/2000/01/xmldsig#minimal XML-Canonicalization RECOMMENDED http://www.w3.org/TR/1999/WD-xml-c14n-19991115 Transform XSLT RECOMMENDED http://www.w3.org/TR/1999/REC-xslt-19991116 XPath RECOMMENDED http://www.w3.org/TR/1999/REC-xpath-19991116 XPointer RECOMMENDED http://www.w3.org/TR/1999/WD-xptr-19991206Java OPTIONAL urn:ECMA-org:javaNote that the normative identifier is the complete URIs in the table though they are frequently abbreviated in XML syntax as"&dsig;/hmac". 5.2"&dsig;base64" or the like. 6.2 Message Digests Only one digest algorithm is defined herein. However, it is expected that one or more additional strong digest algorithms will be developed in connection with the US Advanced Encryption Standard effort. Use of MD5 [MD5] is NOT RECOMMENDED because recent advances in cryptography have cast doubt on its strength.Eastlke, Reagle, Solo [Page 22] Internet Draft XML-Signature Core Syntax January 2000 Digest algorithms take as an implicit parameter a byte string to be digested. 5.2.16.2.1 SHA-1 Identifier:http://www.w3.org/2000/01/xmldsig/sha1http://www.w3.org/2000/01/xmldsig#sha1 The SHA-1 algorithm [SHA-1] takes no explicit parameters. An example of an SHA-1 DigestAlg element is: <DigestMethodAlgorithm="&dsig;/sha1"/>Algorithm="&dsig;sha1"/> A SHA-1 digest is a 160-bit string. The content of the DigestValue Eastlke, Reagle, Solo [Page 23] Internet Draft XML-Signature Syntax February 2000 element shall be the base64 encoding of this bit string viewed as a 20-octet octet stream. Example, the DigestValue element for the message digest: A9993E36 4706816A BA3E2571 7850C26C 9CD0D89D from Appendix A of the SHA-1 standard would be: <DigestValue>qZk+NkcGgWq6PiVxeFDCbJzQ2J0=</DigestValue>5.36.3 Message Authentication Codes MAC algorithms take two implicit parameters, their keying material determined from KeyInfo and the byte stream output by CanonicalizationMethod or SignedInfo directly if there is no CanonicalizationMethod. MACs and signature algorithms are syntactically identical but a MAC implies a shared secret key.5.3.16.3.1 HMAC Identifier:http://www.w3.org/2000/01/xmldsig/hmac-sha1http://www.w3.org/2000/01/xmldsig#hmac-sha1 The HMAC algorithm [RFC2104:HMAC] takes the truncation length in bits as a parameter. An example of an HMAC SignatureMethod element: <SignatureMethodAlgorithm="&dsig;/hmac-sha1"> <hmac-outputlength xmlns="&dsig;/hmac-sha1"> 128 </hmac-outputlength>Algorithm="&dsig;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 theHMAC-MD5HMAC-SHA1 digestEastlke, Reagle, Solo [Page 23] Internet Draft XML-Signature Core Syntax January 20009294727A 3638BB1C 13F48EF8 158BFC9D from the test vectors in [HMAC] would be <SignatureValue>kpRyejY4uxwT9I74FYv8nQ==</SignatureValue>5.4Schema Definition: <element name='HMACOutputLength' type='integer' minOccurs='0' maxOccurs='1'/> DTD: <!ELEMENT HMACOutputLength (#PCDATA)> 6.4 Signature Algorithms Signature algorithms take two implicit parameters, their keying material determined from KeyInfo and the byte stream output by CanonicalizationMethod or SignedInfo directly if there is no Eastlke, Reagle, Solo [Page 24] Internet Draft XML-Signature Syntax February 2000 CanonicalizationMethod. Signature and MAC algorithms are syntactically identical but a signature implies public key cryptography. Note: the schema and DTD declarations within this section are not yet part ofsec-9:section 9: schemas.5.4.16.4.1 DSA Identifier:http://www.w3.org/2000/01/xmldsig/dsahttp://www.w3.org/2000/01/xmldsig#dsa The DSA algorithm[DSA][DSS] takes no explicit parameters. An example of a DSA SignatureMethod element is: <SignatureMethodAlgorithm="&dsig;/dsa"/>Algorithm="&dsig;dsa"/> The output of the DSA algorithm consists of a pair of integers usually referred by the pair (r, s). The signature value shall consist of the base64 encoding of the concatenation of two octet-streams that respectively result from the octet-encoding of the values r and s. Integer to octet-stream conversion shall be done according to the I2OSP operation defined in the RFC 2437 [RSA] specification with a k parameter equal to 20. 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==</SignatureVa lue> DSA key values have the following set of fields: P, Q, G and Y are mandatory when appearing as a key value, J, seed and pgenCounter are optional but SHOULD be present. (The seed and pgenCounter fields MUST both either appear or be absent). All parameters are encoded as base64 values. Schema: <elementname='DSSKeyValue'> Eastlke, Reagle, Solo [Page 24] Internet Draft XML-Signature Core Syntax January 2000name='DSAKeyValue'> <type content='elementOnly'> <group order='seq' minOccurs='1' maxOccurs='1'> <elementname='P'name='ds:P' type='string' minOccurs='1' maxOccurs='1'/> <elementname='Q'name='ds:Q' type='string' minOccurs='1' maxOccurs='1'/> <elementname='G'name='ds:G' type='string' minOccurs='1' maxOccurs='1'/> <elementname='Y'name='ds:Y' type='string' minOccurs='1' maxOccurs='1'/> <elementname='J'name='ds:J' type='string' minOccurs='0' maxOccurs='1'/> </group> <group order='seq' minOccurs='0' maxOccurs='1'> <elementname='seed'name='ds:Seed' type='string' minOccurs='1' maxOccurs='1'/> <elementname='pgenCounterQ'name='ds:PgenCounterQ' type='string' minOccurs='1'maxOccurs='1'/>maxOccurs=' Eastlke, Reagle, Solo [Page 25] Internet Draft XML-Signature Syntax February 2000 1'/> </group> </type> </element> DTD: <!ELEMENTDssKeyValueDSAKeyValue (P, Q, G, Y, J?,(seed, pgenCounter)?)(Seed, PgenCounter)?) > <!ELEMENT P (#PCDATA) > <!ELEMENT Q (#PCDATA) > <!ELEMENT G (#PCDATA) > <!ELEMENT Y (#PCDATA) > <!ELEMENT J (#PCDATA) > <!ELEMENT Seed (#PCDATA) > <!ELEMENT PgenCounter (#PCDATA) > <!-- Each of these fields consists aCDATAPCDATA where the data is base64 encoded -->5.4.26.4.2 RSA Identifier:http://www.w3.org/2000/01/xmldsig/rsa-sha1http://www.w3.org/2000/01/xmldsig#rsa-sha1 The expression "RSA algorithm" as used in thisdocumentspecification refers to the RSASSA-PKCS1-v1_5 algorithm described in RFC 2437 [RSA]. The RSA algorithm takes no parameters. An example of an RSA SignatureMethod element is: <SignatureMethodAlgorithm="&dsig;/rsa-sha1"/>Algorithm="&dsig;rsa-sha1"/> The output of the RSA algorithm is an octet string. The SignatureValue content for an RSA signature shall be the base64 encoding of this octet string. Example: TBD RSA key values have two fields: Modulus and Exponent. Schema: <element name='RSAKeyValue'> <type content='elementOnly'> <elementname='Modulus'name='ds:Modulus' type='string' minOccurs='1' maxOccurs='1'/> <elementname='Exponent'name='ds:Exponent' type='string' minOccurs='1' maxOccurs='1'/> </type> </element> DTD: <!ELEMENT RSAKeyValue( Modulus,(Modulus, Exponent) > <!ELEMENT Modulus (#PCDATA) > <!ELEMENT Exponent)(#PCDATA) > <!-- Each field contains a CDATA which is the value for that item base64 encoded --> 6.5 Canonicalization Algorithms 6.5.1 Minimal Canonicalization Eastlke, Reagle, Solo [Page25]26] Internet Draft XML-SignatureCoreSyntaxJanuaryFebruary 20005.4.3 ECDSA The expression ECDSA [ECDSA] as used in this document refers to the signature algorithms specified in ANSI X9.62. Additional details are to be provided. 5.5 Canonicalization Algorithms 5.5.1 Null Canonicalization Null canonicalization, i.e., no modification whatsoever, can be achieved for digested data by simply not putting any canonicalization in the Transforms element (omitting it entirely if no other tranforms are needed) for a data object or omitting CanonicalizationMethod for SignedInfo. 5.5.2 Minimal CanonicalizationIdentifier:http://www.w3.org/2000/01/xmldsig/minimalhttp://www.w3.org/2000/01/xmldsig#minimal The algorithm identifier for the minimal canonicalization is&dsig;/minimal.&dsig;minimal. An example of a minimal canonicalization element is: <CanonicalizationMethodAlgorithm="&dsig;/minimal"/>Algorithm="&dsig;minimal"/> The minimal canonicalization algorithm: * converts the character encoding to UTF-8, removing the encoding pseudo-attribute * normalizes line endings5.5.3as provided by [XML]. (See section 7: XML and Canonicalization and Syntactical Considerations.) 6.5.1 Canonical XML Identifier: http://www.w3.org/TR/1999/WD-xml-c14n-19991115 An example of an XML canonicalization element is: <CanonicalizationMethod Algorithm="http://www.w3.org/TR/1999/WD-xml-c14n-19991115"/> The normativespecificatinspecification of Canonical XML is [XML-c14n].5.66.6 Transform Algorithms A Transform algorithm has three implicit parameters. The first is a byte stream from the Reference or as the output of an earlier Transform. The second and third are the optional MimeType and Charset attributes that can be specified on the Transform element. Application developers are strongly encouraged to support all transforms listed in this section as RECOMMENDED unless theEastlke, Reagle, Solo [Page 26] Internet Draft XML-Signature Core Syntax January 2000application environment has resource constraints that would make such support impractical. Theworking groupWorking Group goal is to maximize application interoperability on XML signatures, and the working group expects ubiquitous availability of software to support these transforms that can be incorporated into applications without extensive development.5.6.16.6.1 Canonicalization Any canonicalization algorithm that can be used for CanonicalizationMethod can be used as a Transform.5.6.26.6.2 Base-64 and Quoted-Printable Decoding Identifiers:http://www.w3.org/2000/01/xmldsig/base-64 http://www.w3.org/2000/01/xmldsig/qphttp://www.w3.org/2000/01/xmldsig#base-64 http://www.w3.org/2000/01/xmldsig#qp Eastlke, Reagle, Solo [Page 27] Internet Draft XML-Signature Syntax February 2000 The normative specification for base 64 and quoted-printable decoding transforms is [MIME]. The base-64 Transform element has no content. The input is base-64 decoded by this algorithm. This transform is useful if an application needs to sign the raw data associated with base-64 encoded content of an element.5.6.36.6.3 XPath Filtering Identifier: http://www.w3.org/TR/1999/REC-xpath-19991116 The Transform element content MUST conform to the XML Path Language [XPath] syntax. XPath is a language for addressing parts of an XML document. Hence, an XPath expression MUST be applied to an entire well-formed XML document. Note: The current output of a Reference's IDREF cannot be used as input to an XPath transform. The XPath transform could be defined to provide an XML declaration when one is found not to exist since the encoding attribute could be set equal to the XPath transform's Charset attribute. However, there is currently no way to communicate the correct byte order mark to the transform. For security reasons, a default cannot be selected. The XPath transform applies the W3C XML canonicalization [XML-C14N] to the input resource. This ensures all entity reference substitutions and attribute normalizations are performed in a manner consistent with a validating XML processor. Linefeeds are normalized, and CDATA sections are eliminated. The types of quotes around attributes are normalized, and the order of attributes is defined. Namespace attributes are created in descendant elements that use namespace definitions. All of these modifications are necessary to achieve a consistent interpretation of the XPath expression and a consistent output of the XPath transform. Finally, the XPath expression is evaluated assuming that the entityEastlke, Reagle, Solo [Page 27] Internet Draft XML-Signature Core Syntax January 2000references created by canonicalization have been replaced by the corresponding entity values and that each block of consecutive text characters has been replaced by a single text node. The result of the XPath is a string, boolean, number, or node-set. If the result of the XPath expression is a string, then the string is the output of the XPath transform. If the XPath result is a boolean or number, then the result is converted to a string using the XPath string() function. If the result of the XPath expression is a node-set, then the output of the transform is a string containing the text rendering of the nodes in the node-set. The nodes are selected for rendering based on the document order (as defined in [XPath]) of the canonicalized input resource. The text rendering is performed in accordance with [XML-C14N]. It is RECOMMENDED that the XPath be constructed such that the result of this operation is a well-formed XML document. This should be the Eastlke, Reagle, Solo [Page 28] Internet Draft XML-Signature Syntax February 2000 case if root element of the input resource is included by the XPath (even if a number of its descendant elements and attributes are omitted by the XPath).5.6.4 XPointer Filtering6.6.4 XSLT Transform Identifier:http://www.w3.org/TR/1999/WD-xptr-19991206http://www.w3.org/TR/1999/REC-xslt-19991116 The Transform element content MUST conform to theXML Pointer Language [XPointer] syntax. The processing rules for XPointer filtering are identical to those for XPath filtering (stated above), except that the additional functionality offered by XPointer can be utilized in constructing the output. 5.6.5 XSLT Transform Identifier: http://www.w3.org/TR/1999/REC-xslt-19991116 The Transform element content MUST conform to the XSL Transforms [XSLT] languageXSL Transforms [XSLT] language syntax. The processing rules for the XSLT transform are stated in the XSLT specification [XSLT].5.6.6 Java Transform The Algorithm value for7.0 XML Canonicalization and Syntax Constraint Considerations Digital signatures only work if theJava transform is urn:ECMA-org:java. Details to be determined. Althoughverification calculations are performed on exactly theAlgorithm attributesame bits as the signing calculations. If the surface representation ofa Transformthe signed data cantake application-specific values, having a Java transform seemschange between signing and verification, then some way tobestandardize themost reasonable waychangeable aspect must be used before signing and verification. For example, even for simple ASCII text there are at least three widely used line ending sequences. If it is possible for signed text toallow application-specific transforms that canbeprocessed outside ofmodified from one line ending convention to another between theapplication domain. Eastlke, Reagle, Solo [Page 28] Internet Draft XML-Signature Core Syntax January 2000 6.0 Processing rules These sections describetime of signing and signature verification, then theoperationsline endings need to beperformed as part of signature generationcanonicalized to a standard form before signing andvalidation. The descriptionverification or the signatures will break. XML is subject to surface representation changes and to processing which discards some surface information. For this reason, XML digital signatures have a provision for indicating canonicalization methods in the signature so that a verifier can use the same canonicalization as the signer. Throughout this specification we distinguish between the canonicalization of alogical behaviorSignature data object anddoes not specifyother signed XML data objects. It is possible for anorder of execution, nor specify discrete steps. 6.1 Generation 1. apply Transforms determined by applicationisolated XML document toeach object being signed. 2. calculate digest over each transformed object 3. create Reference element(s) including location of object, digest,be treated as if it were binary data so that no changes can occur. In that case, the digestalgorithm,of the document will not change andtransform elements,it need not be canonicalized ifrequired. 4. createit is signed and verified as such. However, XML that is read and processed using standard XML parsing and processing techniques is frequently changed such that some of its surface representation information is lost or modified. In particular, this will occur in many cases for the Signature and enclosed SignedInfoelement with SignatureMethod, CanonicalizationMethodelements since they, and possibly an encompassing XML document, will be processed as XML. Similarly, these considerations apply to Manifest, Object, and SignatureProperties elements ifrequired,those elements have been digested, their DigestValue is to be checked, andReference(s). 5. canonicalizethey are being processed as XML. The kinds of changes in XML that may need to be canonicalized can be divided into three categories. There are those related to the basic Eastlke, Reagle, Solo [Page 29] Internet Draft XML-Signature Syntax February 2000 [XML], as described in 7.1 below. There are those related to [DOM], [SAX], or similar processing as described in 7.2 below. And, third, there is the possibility of character set conversion, such as between UTF-8 andcalculate signature over SignedInfo based on algorithmsUTF-16, both of which all XML standards compliant processors are required to support. Any canonicalization algorithm should yield output instepa specific fixed character set. For both the minimal canonicalization defined in this specification and the W3C Canonical XML [XML-c14n], that character set is UTF-8. 7.1 XML 1.0, Syntax Constraints, and Canonicalization XML 1.0 [XML] defines an interface where a conformant application reading XML is given certain information from that XML and not other information. In particular, 1. line endings are normalized to the single character #xA by dropping #xD characters if they are immediately followed by a #xA and replacing them with #xA in all other cases, 2. missing attributes declared to have default values are provided to the application as if present with the default value, 3. character references are replaced with the corresponding character, 4.6. construct signature documententity references are replaced withSignedInfo, Object (s) (if desired, encoding maythe corresponding declared entity, 5. attribute values are normalized by A. replacing character and entity references as above, B. replacing occurrences of #x9, #xA, and #xD with #x20 (space) except that the sequence #xD#xA is replaced by a single space, and C. if the attribute is not declared to bedifferent thanCDATA, stripping all leading and trailing spaces and replacing all interior runs of spaces with a single space, and 6. for elements declared to have element content, eliminate white space that appears within their content but not within the content of any enclosed element. Note thatused for signing), KeyInfo (if required),items (2), (4), (5C), andSignatureValue. 6.2 Core Validation Validating an XML signature consists of two mandatory processing steps. These are signature validation,(6) depend on specific Schema, DTD, or similar declarations. In thecryptographic validation ofgeneral case, such declarations will not be available to or used by the signaturecalculated over SignedInfo; and reference validation, the verification ofverifier. Thus, to interoperate between different XML implementations, thedigest contained in each Reference in SignedInfo. Both stepsfollowing syntax contraints MUST beperformedobserved when generating any signed material to be processed aspart of all XML signature validations. 6.2.1 Signature Validation 1. canonicalizeXML, including the SignedInfoelement based on the CanonicalizationMethod, if any, in SignedInfo.element: 1. attributes having default values be explicitly present, 2.obtain the validation keying info from KeyInfo or externally.all entity references (except "amp", "lt", "gt", "apos", and "quot" which are pre-defined) be expanded, 3.validate the SignatureValue based on the SignatureMethod in the SignedInfo element,attribute value white space be normalized, and 4. insignificant white space not be generated within elements having element content. 7.2 DOM/SAX Processing and Canonicalization In addition to thekey obtained in step 2,canonicalization and syntax constraints discussed above, many XML applications use theresultsDocument Object Model [DOM] or The Simple API for XML [SAX]. DOM maps XML into a tree structure ofstep 1. Digest calculation is performed over the SignedInfo element including startEastlke, Reagle, Solo [Page 30] Internet Draft XML-Signature Syntax February 2000 nodes andend tags. 6.2.2 Reference Validation 1. For each object reference in SignedInfo, obtain digested content (this maytypically assumes it will beobtained by locating object and applying Transformsused on an entire document with subsequent processing being done on this tree. SAX converts XML into a series of events such as a start tag, content, etc. In either case, many surface characteristics such as the ordering of attributes and insignificant white space within start/end tags is lost. In addition, namespace declarations are mapped over the nodes to which they apply, losing thespecified resource based on each Reference(s)namespace prefixes in theSignedInfo element. Each transform is appliedsource text and, inorder from left to right tomost cases, losing theobject withwhere namespace declarations appeared in theoutput of each transform beingoriginal instance. If an XML Signature is to be produced or verified on a system using theinputDOM or SAX processing, a canonical method is needed to serialize thenext.). 2. calculate digest over each transformed signed object(s)relevant part of a DOM tree or sequence of SAX events. XML canonicalization specifications, such as [XML-c14n], are based only on information which is preserved by DOM and SAX. For an XML Signature to be verifiable by an implementation using DOM or SAX, not only must thealgorithm in Reference(s). 3. compare value against DigestValuesyntax constraints given inSignedInfo for each reference Eastlke, Reagle, Solo [Page 29] Internet Draft XML-Signature Core Syntax January 2000 (if any mismatch, validation fails). Any processing beyond cryptographic validation (e.g. certificate validation, applicability decisions, time related processing) is outsidesection 7.1 be followed but an appropriate XML canonicalization MUST be specified so that thescope of this specification. 7.0verifier can re-serialize DOM/SAX mediated input into the same byte sequence that was signed. 8.0 Security Considerations The XML Signature specification provides a very flexible digital signature mechanism. Implementors must give consideration tothetheir application threat models and to the following factors.7.18.1 Only What is Signed is Secure A requirement of this specification is to permit signatures to "apply to a part or totality of a XML document." [3.1.3 XML-Signature-RD] The Transforms mechanism meets this requirement by permitting one to signa documentdata derived from processing the content of the identifiedsource document.resource. For instance, applications that wish to sign a form, but permit users to enter limited field data without invalidating the form itself might use XPath[XPath] to select only those portions the user does not change. However, Transforms may be arbitrarly specified and may include canonicalization instructions or even XSLT transformations. We stress that the signature is placed over the derived document, and those portions that were excluded by transformation can be arbitrarily modified and the signature will still validate! This is a feature, though one that is used at[XPath] to exclude those portions theapplication's risk. (Some applicationsuser needs to change. Transforms maynotbewilling to trust sucharbitrarily specified and may include canonicalization instructions or even XSLT transformations. Of course, signaturesall-together.)over such a dervied document do not secure any information discarded by the Transforms. Furthermore, core validationbehaviourbehavior does not confirm that the signedresourcedata was obtained by applyingtransforms to the specified source document. This behaviour is left toeach step of theapplication as core validation only checksindicated transforms. (Though it does check that the digestvaluesof thesource document andresulting content matches that specified in the signature.) For example, some application may be satisfied with verifying an XML signature overSignedInfo. If this fact is important, then additional information (such as by including References to both the original anda cached copy of already transformeddocuments) is needed. 7.2data. Other application might require that content be freshly dereferenced and transformed. 8.2 Only What is "Seen" Should be Signed If signing is intended to convey the judgment or consent of an automated mechanism or person concerning some information, then it is Eastlke, Reagle, Solo [Page 31] Internet Draft XML-Signature Syntax February 2000 normally necessary to secure as exactly as practical the information that was presented to that mechanism or person. Note that this can be accomplished by literally signing what was presented, for example the screen images shown a user. However, this may result in data which it is difficult for subsequent software to manipulate. It can be effective instead to secure the full data along with whatever filters, style sheets, or the like were used to control the part of the information that was presented.7.3Also note that the use of Canonical XML [XML-C14N] ensures that all internal entities and XML namespaces are expanded within the content being signed. All entities are replaced with their definitions and the canonical form explitly represents the namespace that an element would otherwise inhereit. Those application that do not canonicalize XML content (especially the SignedInfo element) SHOULD NOT use internal entities and SHOULD represent the name space explicitly within the content being signed since they can not rely upon canonicalization to do this for them. 8.3 Check the Security Model This standard specifies public key signatures andsecret keykeyedEastlke, Reagle, Solo [Page 30] Internet Draft XML-Signature Core Syntax January 2000hash authentication codes. These have substantially different security models. Furthermore, it permits user specified additions which may have other models. With public key signatures, any number of parties can hold the public key and verify signatures while only the parties with thesecretprivate key can create signatures. The number of holders of thesecretprivate key should be minimized and preferably be one. Confidence by verifiers in the public key they are using and its binding to the entity or capabilities represented by the correspondingsecretprivate key is an important issue, usually addressed by certificate or online authority systems. Keyed hash authentication codes, based on secret keys, are typically much more efficient in terms of the computational effort required but have the characteristic that all verifiers need to have possession of the same key as the signer. Thus any verifier can forge signatures. This standard permits user provided signature algorithms and keying information designators. Such user provided algorithms may have further different security models. For example, methods involving biometrics usually depend on a"key" which is aphysical characteristic of the authorized userand thusthat can not be changed the way public or secret keys can be and may have other security model differences.7.48.4 Key Lengths, Algorithms, Certificates, Etc. The strength of a particular signature depends on all links in the security chain. This includes the signature and digest algorithms used, the strength of the key generation[RFC1750][RANDOM] and the size of the key, the security of key and certificate authentication and Eastlke, Reagle, Solo [Page 32] Internet Draft XML-Signature Syntax February 2000 distribution mechanisms, certificate chain valiation policy, protection ofallcryptographic processing from hostile observation and tampering, etc. The security of an overall system would also depend on the security and integrity of its operating procedures, its personnel, and on the administrative enforcement of those procedures. The factors listed in this paragraph, while critical to the overall security of a system, are mostly beyond the scope of thisdocument. 8.0specification. 9.0 Schema, DTD, and Data Model XML Signature Schema Instance xmldsig-core-schema.xsd XML schema instance validates to 19991207 Schema DTD [XML-Schema]. XML Signature DTD xmldsig-core-schema.dtd XML DTD that could still use improvement. RDF Data Model xmldsig-datamodel-20000112.gif 10.0 Example syntax XML Signature Example signature-example.xml Well formed XML that validates under the schema and DTD. The non-normative cryptographic values were generated by Ed Simon and Tamura Kent. The text below was edited for readability. <Signaturexmlns="http://www.w3.org/1999/11/xmldsig-core">xmlns="http://www.w3.org/2000/01/xmldsig"> <SignedInfoID="5">Id="mypage"> <CanonicalizationMethodAlgorithm="http://www.w3.org/1999/07/WD-xml-c14n-19990729"/>Algorithm="http://www.w3.org/1999/07/WD-xml-c14n-19990729"> </CanonicalizationMethod> <SignatureMethodAlgorithm="&dsig;/dsa"/>Algorithm="http://www.w3.org/2000/01/xmldsig/dsa"> </SignatureMethod> <ReferenceURI="http://www.mypage.com">URI="http://www.w3.org/TR/xml-stylesheet/"> <Transforms> <TransformAlgorithm="&dsig;/null"> <Encoding Algorithm="&dsig;/base64"/>Algorithm="http://www.w3.org/2000/01/xmldsig/base64"/> <Transform Algorithm="http://www.w3.org/2000/01/xmldsig/null"/> </Transforms> <DigestMethodAlgorithm="&dsig;/sha1"/> <DigestValue>a23bcd43</DigestValue>Algorithm="http://www.w3.org/2000/01/xmldsig/sha1"> </DigestMethod> <DigestValue>j6lwx3rvEPO0vKtMup4NbeVu8nk=</DigestValue> </Reference> <Reference URI="http://www.w3.org/TR/REC-xml-names/"> <Transforms> <Transform Algorithm="http://www.w3.org/2000/01/xmldsig/base64"/> </Transforms> <DigestMethod Algorithm="http://www.w3.org/2000/01/xmldsig/sha1"> </DigestMethod> <DigestValue>UrXLDLBIta6skoV5/A8Q38GEw44=</DigestValue> Eastlke, Reagle, Solo [Page31]33] Internet Draft XML-SignatureCoreSyntaxJanuaryFebruary 2000 </Reference><Reference IDREF="timestamp" Type="&dsig;/signatureattributes"> <Transforms> <CanonicalizationMethod name="http://..."/> </Transforms> <DigestMethod Algorithm="&dsig;/sha1"/> <DigestValue>a53uud43</DigestValue> </Reference></SignedInfo><SignatureValue>dd2323dd</SignatureValue> <Object ID="timestamp" type="&dsig;/SignatureProperties" > <SignatureProperties> <SignatureProperty> <timestamp about="5" xmlns="http://www.ietf.org/rfcXXXX.txt"> <date>19990908</date> <time>14:34:34:34</time> </timestamp> </SignatureProperty> </SignatureProperties> </Object><SignatureValue>MC0CFFrVLtRlkMc3Daon4BqqnkhCOlEaAhUAk8pH1iRNK+q1I +sisDTz2TFEALE=</SignatureValue> <KeyInfo><keyname>Solo</keyname><KeyValue xmlns:java="http://xsl.lotus.com/java" xmlns:dsig="http://www.w3.org/2000/01/xmldsig"> MIIBtzCCASwGByqGSM44BAEwggEfAoGBAP1/U4EddRIpUt9KnC7s5Of2E bdSPO9EAMMeP4C2USZpRV1AIlH7WT2NWPq/xfW6MPbLm1Vs14E7gB00b/ JmYLdrmVClpJ+f6AR7ECLCT7up1/63xhv4O1fnxqimFQ8E+4P208UewwI1 VBNaFpEy9nXzrith1yrv8iIDGZ3RSAHHAhUAl2BQjxUjC8yykrmCouuEC/ BYHPUCgYEA9+GghdabPd7LvKtcNrhXuXmUr7v6OuqC+VdMCz0HgmdRWVeO utRZT+ZxBxCBgLRJFnEj6EwoFhO3zwkyjMim4TwWeotUfI0o4KOuHiuzpn WRbqN/C/ohNWLx+2J6ASQ7zKTxvqhRkImog9/hWuWfBpKLZl6Ae1UlZAFM O/7PSSoDgYQAAoGAQFL0+RhXZbDxdt17o05PlMzQGqDnAq2NM1eun+ie21 4okrmIp4r0CGKvHM1HbFgwXMlBpkXyStYg64RTMnL9dtShw5rCkEv145TV 0EYVoxBQ5X0gmrQ2NftRHH8imBhx9glz//y6NE4JhfIVPu3o+55VYUwdFP 0cbBvWkKOngo0= </KeyValue> </KeyInfo> </Signature>9.0 Schema http://www.w3.org/TR/2000/WD-xmldsig-core-20000104/xmldsig-core-schema .xml 1011.0 Definitions Authentication, Message "A signature should identify what is signed, making it impracticable to falsify or alter either the signed matter or the signature without detection." [Digital Signature Guidelines, ABA] Authentication, Signer "A signature should indicate who signed a document, message or record, and should be difficult for another person to produce without authorization." [Digital Signature Guidelines, ABA] See non-repudiation. Core The syntax and processing defined by this specification, including core validation. We use this term to distinguish other markup, processing, and applications semantics from our own.Eastlke, Reagle, Solo [Page 32] Internet Draft XML-Signature Core Syntax January 2000Data Object (Content/Document) The actual binary/octet data being operated on (transformed, digested, or signed) by an application -- frequently an HTTP entity [HTTP]. Note that the proper nounObjectdesignatesObject designates a specific XML element. Occasionally we refer to a data object as a document or as a resource's content. The term element content is used to describe the data between XML start and end tags [XML]. The term XML document is used to describe data objects which conform to the XML specification [XML]. Integrity Eastlke, Reagle, Solo [Page 34] Internet Draft XML-Signature Syntax February 2000 The inability to change a message without also changing the signature value. See message authentication. Non-repudiation The inability of a key holder to assert that their key was not associated with a message given a strong signature algorithm. (This definition speaks nothing of the number of key holders, the key length, whether the key is comprised, whether the signature was coerced, etc.) See signer authentication. Object An XML Signature element wherein arbitrary (non-core) data may be placed. An Object element is merely one type of digital data (or document) that can be signed via a Reference. Resource "A resource can be anything that has identity. Familiar examples include an electronic document, an image, a service (e.g., 'today's weather report for Los Angeles'), and a collection of other resources.... The resource is the conceptual mapping to an entity or set of entities, not necessarily the entity which corresponds to that mapping at any particular instance in time. Thus, a resource can remain constant even when its content---the entities to which it currently corresponds---changes over time, provided that the conceptual mapping is not changed in the process." [URI] In order to avoid a collision of the term entity within the URI and XML specifications, we use the term data object, content or document to refer to the actual bits being operated upon. Signature A value generated from the application of a key to a message via a cryptographic algorithm such that it has the properties of signer authentication, integrity, and non-repudiation. A signature may be (non-exclusively) described as detached, enveloping, or enveloped. Signature, Detached The signature is overexternalcontent external to the Signature element, and can be identified via aURI. Cosequently,URI, IDREF, or transform. Consequently, the signature is "detached" from the content it signs. This definition typically applies to separate data objects, but it also includes the instance where the Signature and data object reside within the same XML document but are sibling elements. Signature, Enveloping The signature is over content found within the Object element of the signatureitselfitself. The Object(or its content) is identified via a Reference (via IDREF or transform). The enveloping Signature element is used to provide the root document element. Eastlke, Reagle, Solo [Page33]35] Internet Draft XML-SignatureCoreSyntaxJanuaryFebruary 2000via an IDREF to an Object element. The Signature provides the root XML document element.Signature, Enveloped The signature is over the XML content that contains the signature as an element. The content provides the root XML document element. Obviously, enveloped signatures must take care not to include their own value in the calculation of the SignatureValue. Transform The processing of a byte stream from source content to derived content. Typical transforms include XML Canonicalization, XPath, and XSLT. Validation, Core The core processing requirements of this specification requiring signature validation and SignedInfo reference validation. Validation, Reference The hash value of the identified and transformed content, specified by Reference, matches its specifiedDigetsValue.DigestValue. Validation, Signature The SignatureValue matches the result of processing SignedInfo with CanonicalizationMethod and SignatureMethod as specified in section 6.2. Validation, Trust/Application The application determines that the semantics associated with a signature are valid. For example, an application may validate thetime stamps or the integrity of the signer key -- though this behvaiour is external to this core specification. 11.0 Other Useful Types (normative) We define the following URIs for use in identifying XML resources that include non-core but signature related semantics. http://www.w3.org/1999/11/xmldsig-core/SignatureProperties designates that the referenced resource is a statement about the referring signature. http://www.w3.org/1999/11/xmldsig-core/Manifest designates that the referenced resource is a collection of other resources. http://www.w3.org/1999/11/xmldsig-core/Package designates that the referenced resources is a collection of other resources and the creator of that collection asserts that the specified resources, when transformed as specified, yield the same exact content. Eastlke, Reagle, Solo [Page 34] Internet Draft XML-Signature Core Syntax January 2000time stamps or the integrity of the signer key -- though this behavior is external to this core specification. 12.0 References ABA Digital Signature Guidelines. http://www.abanet.org/scitech/ec/isc/dsgfree.html Bourret Ron Bourret. Declaring Elements and Attributes in an XML DTD. http://www.informatik.tu-darmstadt.de/DVS1/staff/bourret/xml/xm ldtd.html DOM Document Object Model (DOM) Level 1 Specification. http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/ DOMHASH Internet Draft. Digest Values for DOM (DOMHASH) http://search.ietf.org/internet-drafts/draft-hiroshi-dom-hash-0 1.txt . DSS Eastlke, Reagle, Solo [Page 36] Internet Draft XML-Signature Syntax February 2000 FIPS PUB 186-1. Digital Signature Standard (DSS). U.S. Department of Commerce/National Institute of Standards and Technology.http://www.ietf.org/rfc/rfc2104.txt ECSDA ?ANSI X9.62HMAC RFC 2104. HMAC: Keyed-Hashing for Message Authentication. H. Krawczyk, M. Bellare, R. Canetti. INFORMATIONAL. HTTP RFC 2616.Hypertext Transfer Protocol -- HTTP/1.1. J. Gettys, J. Mogul, H. Frystyk, L. Masinter, P. Leach, T. Berners-Lee. http://www.ietf.org/rfc/rfc2616.txt KEYWORDS RFC2119 -- Key words for use in RFCs to Indicate Requirement Levels. http://www.ietf.org/rfc/rfc2119.txt MD5 RFC 1321. The MD5 Message-Digest Algorithm. R. Rivest. INFORMATIONAL. http://www.ietf.org/rfc/rfc1321.txt MIME RFC 2045. Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies. N. Freed & N. Borenstein. DRAFT STANDARD. http://www.ietf.org/rfc/rfc2045.txtRDF RDF Schema http://www.w3.org/TR/1999/PR-rdf-schema-19990303 RDF Model and Syntax http://www.w3.org/TR/1999/REC-rdf-syntax-19990222 RFC1750RANDOM RFC1750 -- Randomness Recommendations for Security. http://www.ietf.org/rfc/rfc1750.txtRFC2119 RFC2119 -- Key words for use in RFCs to Indicate Requirement Eastlke, Reagle, Solo [Page 35] Internet Draft XML-Signature CoreRDF RDF Schema http://www.w3.org/TR/1999/PR-rdf-schema-19990303/ RDF Model and SyntaxJanuary 2000 Levels. http://www.ietf.org/rfc/rfc2119.txthttp://www.w3.org/TR/1999/REC-rdf-syntax-19990222 RSA RFC 2437. PKCS #1: RSA Cryptography Specifications Version 2.0. B. Kaliski, J. Staddon. INFORMATIONAL. http://www.ietf.org/rfc/rfc2432.txt SAX David Megginson et. al. SAX: The Simple API for XML May 1998. http://www.megginson.com/SAX/index.html SHA-1 FIPS PUB 180-1. Secure Hash Standard. U.S. Department of Commerce/National Institute of Standards and Technology. http://csrc.nist.gov/fips/fip180-1.pdf Eastlke, Reagle, Solo [Page 37] Internet Draft XML-Signature Syntax February 2000 URI RFC2396 - Uniform Resource Identifiers (URI): Generic Syntax http://www.ietf.org/rfc/rfc2396.txt URL RFC1738. Uniform Resource Locators (URL). Berners-Lee, T., Masinter, L., and M. McCahill . December 1994. http://www.ietf.org/rfc/rfc1738.txt URN RFC 2141. URN Syntax. R. Moats. PROPOSED STANDARD. ftp://ftp.isi.edu/in-notes/rfc2141.txt RFC 2611. URN Namespace Definition Mechanisms. L. Daigle, D. van Gulik, R. Iannella, P. Falstrom. BEST CURRENT PRACTICE. ftp://ftp.isi.edu/in-notes/rfc2611.txt XLink XML Linking Language http://www.w3.org/1999/07/WD-xlink-19990726 XML Extensible Markup Language (XML) Recommendation. http://www.w3.org/TR/1998/REC-xml-19980210 XML-c14n Canonical XML. W3C Working Draft http://www.w3.org/TR/1999/WD-xml-c14n-19991115 XML-ns Namespaces in XML http://www.w3.org/TR/1999/REC-xml-names-19990114 XPath XML Path Language (XPath)Version 1.0. W3C Proposed Recommendation http://www.w3.org/TR/1999/PR-xpath-19991008 XPointer XML Pointer Language (XPointer). W3C Working Draft. http://www.w3.org/1999/07/WD-xptr-19990709Eastlke, Reagle, Solo [Page 36] Internet Draft XML-Signature Core Syntax January 2000XML-schema XML Schema Part 1: Structures http://www.w3.org/TR/1999/WD-xmlschema-1-19991217/ XML Schema Part 2: Datatypes http://www.w3.org/TR/1999/WD-xmlschema-2-19991217/ XML-Signature-RD XML-Signature Requirements http://www.w3.org/1999/08/WD-xmldsig-requirements-990820 XSL Extensible Stylesheet Language (XSL) W3C Working Drafthttp://www.w3.org/TR/1999/WD-xsl-19990421Eastlke, Reagle, Solo [Page 38] Internet Draft XML-Signature Syntax February 2000 http://www.w3.org/TR/2000/WD-xsl-20000112/ XSLT XSL Transforms (XSLT) Version 1.0. W3C Proposed Recommendation http://www.w3.org/TR/1999/PR-xslt-19991008 WebData Web Architecture: Describing and Exchanging Data. http://www.w3.org/1999/04/WebData13.0 Acknowledgements (non-normative) * Milton Anderson, FSTC * Mark Bartel, JetForm Corporation (Author) * John Boyer, UWI.com (Author) * Richard Brown, Globeset *12. Author's Address [other authors - TBD] Donald E. Eastlake3rd, IBM (Chair, Editor) * Barb Fox, Microsoft (Author) * Phillip Hallam-Baker, VeriSign Inc * Richard Himes, US Courts *3rd Motorola 65 Shindegan Hill Road Carmel, NY 10512 USA Phone: 1-508-261-5434 Email: dee3@torque.pothole.com JosephReagle,M. Reagle Jr., W3C(Chair, Editor) * Ed Simon , Entrust Technologies Inc. * Chris Smithies, PenOp *Massachusetts Institute of Technology Laboratory for Computer Science NE43-350, 545 Technology Square Cambridge, MA 02139 Phone: 1.617.258.7621 Email: reagle@w3.org DavidSolo,Solo Citigroup(Editor) * Winchel Todd Vincent III, GSU * Greg Whitehead, Signio Inc. 14.0 Open Issues (non-normative) 1. More detail for KeyInfo types, based on IETF'46, we need proposals for the actual XML'ized algorithm parameters. 2. Make sure we are consistent with respect to types, algorithm IDs, URIs, etc. 3. The signature data structures specified in this document are not yet associated with a data model.666 Fifth Ave, 3rd Floor NY, NY 10103 USA Phone: +1-212-830-8118 Email: dsolo@alum.mit.edu Eastlke, Reagle, Solo [Page37]39] ----