Test cases for Canonical XML 2.0

2.1 PIs, Comments, and Outside of Document Element

• Loss of XML declaration <?xml version="1.0"?>
• Loss of DTD <!DOCTYPE doc SYSTEM "doc.dtd">
• Normalization of whitespace outside of document element (first character of both canonical forms is '<'; single line breaks separate PIs and comments outside of document element)
• Loss of whitespace between PITarget and its data
• Retention of whitespace inside PI data
• Comment removal from uncommented canonical form, including delimiter for comments outside document element (the last character in both canonical forms is '>')

<?xml version="1.0"?>
<?xml-stylesheet   href="doc.xsl"
   type="text/xsl"   ?>
<!DOCTYPE doc SYSTEM "doc.dtd">
<doc>Hello, world!<!-- Comment 1 --></doc>
<?pi-without-data     ?>
<!-- Comment 2 -->
<!-- Comment 3 -->

<?xml-stylesheet href="doc.xsl"
   type="text/xsl"   ?>
<doc>Hello, world!</doc>
<?pi-without-data?>

<?xml-stylesheet href="doc.xsl"
   type="text/xsl"   ?>
<doc>Hello, world!<!-- Comment 1 --></doc>
<?pi-without-data?>
<!-- Comment 2 -->
<!-- Comment 3 -->

2.2 Whitespace in Document Content

• Retain all whitespace between consecutive start tags, clean or dirty
• Retain all whitespace between consecutive end tags, clean or dirty
• Retain all whitespace between end tag/start tag pair, clean or dirty
• Retain all whitespace in character content, clean or dirty

Note: For "After c14n", the input document and canonical form are identical. Both end with '>' character.

• Retain white space inside text, i.e. inbetween A and B but remove all leading and trailing whitespace

<doc>
   <clean>   </clean>
   <dirty>   A   B   </dirty>
   <mixed>
      A
      <clean>   </clean>
      B
      <dirty>   A   B   </dirty>
      C
   </mixed>
</doc>

<doc>
   <clean>   </clean>
   <dirty>   A   B   </dirty>
   <mixed>
      A
      <clean>   </clean>
      B
      <dirty>   A   B   </dirty>
      C
   </mixed>
</doc>

<doc><clean></clean><dirty>A   B</dirty><mixed>A<clean></clean>B<dirty>A   B</dirty>C</mixed></doc>

2.3 Start and End Tags

• Empty element conversion to start-end tag pair. I.e. <e1 /> becomes <e1></e1>
• Normalization of whitespace in start and end tags. I.e.. <e2 ></e2> becomes <e2></e2>
• Relative order of namespace and attribute axes, I.e. in <e5> the namespace declarations precede the attribute declarations.
• Lexicographic ordering of namespace and attribute axes
• Retention of namespace prefixes from original document
• Elimination of superfluous namespace declarations
• Addition of default attribute. I.e. <e9 attr="default">.

Note: Some start tags in the canonical form are very long, but each start tag in this example is entirely on a single line.

Note: In e5, b:attr precedes a:attr because the primary key is namespace URI not namespace prefix, and attr2 precedes b:attr because the default namespace is not applied to unqualified attributes (so the namespace URI for attr2 is empty).

<!DOCTYPE doc [<!ATTLIST e9 attr CDATA "default">]>
<doc>
   <e1   />
   <e2   ></e2>
   <e3   name = "elem3"   id="elem3"   />
   <e4   name="elem4"   id="elem4"   ></e4>
   <e5 a:attr="out" b:attr="sorted" attr2="all" attr="I'm"
      xmlns:b="https://www.ietf.org"
      xmlns:a="https://www.w3.org"
      xmlns="https://example.org"/>
   <e6 xmlns="" xmlns:a="https://www.w3.org">
      <e7 xmlns="https://www.ietf.org">
         <e8 xmlns="" xmlns:a="https://www.w3.org">
            <e9 xmlns="" xmlns:a="https://www.ietf.org"/>
         </e8>
      </e7>
   </e6>
</doc> 

<doc>
   <e1></e1>
   <e2></e2>
   <e3 id="elem3" name="elem3"></e3>
   <e4 id="elem4" name="elem4"></e4>
   <e5 xmlns="https://example.org" xmlns:a="https://www.w3.org" xmlns:b="https://www.ietf.org" attr="I'm" attr2="all" b:attr="sorted" a:attr="out"></e5>
   <e6>
      <e7 xmlns="https://www.ietf.org">
         <e8 xmlns="">
            <e9 attr="default"></e9>
         </e8>
      </e7>
   </e6>
</doc>

<n0:doc xmlns:n0="">
   <n0:e1></n0:e1>
   <n0:e2></n0:e2>
   <n0:e3 id="elem3" name="elem3"></n0:e3>
   <n0:e4 id="elem4" name="elem4"></n0:e4>
   <n1:e5 xmlns:n1="https://example.org" xmlns:n2="https://www.ietf.org" xmlns:n3="https://www.w3.org" attr="I'm" attr2="all" n2:attr="sorted" n3:attr="out"></n1:e5>
   <n0:e6>
      <n2:e7 xmlns:n2="https://www.ietf.org">
         <n0:e8>
            <n0:e9 attr="default"></n0:e9>
         </n0:e8>
      </n2:e7>
   </n0:e6>
</n0:doc>

<doc><e1></e1><e2></e2><e3 id="elem3" name="elem3"></e3><e4 id="elem4" name="elem4"></e4><e5 xmlns="https://example.org" xmlns:a="https://www.w3.org" xmlns:b="https://www.ietf.org" attr="I'm" attr2="all" b:attr="sorted" a:attr="out"></e5><e6><e7 xmlns="https://www.ietf.org"><e8 xmlns=""><e9 attr="default"></e9></e8></e7></e6></doc>

2.4 Character Modifications and Character References

• Character reference replacement
• Attribute value delimiters set to quotation marks (double quotes)
• Attribute value normalization
• CDATA section replacement
• Encoding of special characters as character references in attribute values (&amp;, &lt;, &quot;, &#xD;, &#xA;, &#x9;)
• Encoding of special characters as character references in text (&amp;, &lt;, &gt;, &#xD;)

Note: The last element, normId, is well-formed but violates a validity constraint for attributes of type ID. For testing canonical XML implementations based on validating processors, remove the line containing this element from the input and canonical form. In general, XML consumers should be discouraged from using this feature of XML.

Note: Whitespace character references other than &#x20; are not affected by attribute value normalization [XML10].

Note: In the canonical form, the value of the attribute named attr in the element norm begins with a space, an apostrophe (single quote), then four spaces before the first character reference.

Note: The expr attribute of the second compute element contains no line breaks.

<!DOCTYPE doc [
<!ATTLIST normId id ID #IMPLIED>
<!ATTLIST normNames attr NMTOKENS #IMPLIED>
]>
<doc>
   <text>First line
Second line</text>
   <value>2</value>
   <compute><![CDATA[value>"0" && value<"10" ?"valid":"error"]]></compute>
   <compute expr='value>"0" && value<"10" ?"valid":"error"'>valid</compute>
   <norm attr=' '    
	   ' '/>
   <normNames attr='   A    
	   B   '/>
   <normId id=' ' 
	 ' '/>
</doc>

<doc>
   <text>First line
Second line</text>
   <value>2</value>
   <compute>value>"0" && value<"10" ?"valid":"error"</compute>
   <compute expr="value>"0" && value<"10" ?"valid":"error"">valid</compute>
   <norm attr=" '    
	   ' "></norm>
   <normNames attr="A 
	 B"></normNames>
   <normId id="' 
	 '"></normId>
</doc>

<doc><text>First line
Second line</text><value>2</value><compute>value>"0" && value<"10" ?"valid":"error"</compute><compute expr="value>"0" && value<"10" ?"valid":"error"">valid</compute><norm attr=" '    
	   ' "></norm><normNames attr="A 
	 B"></normNames><normId id="' 
	 '"></normId></doc>

2.5 Entity References

• Internal parsed entity reference replacement
• External parsed entity reference replacement (including whitespace outside elements and PIs)
• External unparsed entity reference

<!DOCTYPE doc [
<!ATTLIST doc attrExtEnt CDATA #IMPLIED>
<!ENTITY ent1 "Hello">
<!ENTITY ent2 SYSTEM "world.txt">
<!ENTITY entExt SYSTEM "earth.gif" NDATA gif>
<!NOTATION gif SYSTEM "viewgif.exe">
]>
<doc attrExtEnt="entExt">
   &ent1;, &ent2;!
</doc>
<!-- Let world.txt contain "world" (excluding the quotes) -->

<doc attrExtEnt="entExt">
   Hello, world!
</doc>

<doc attrExtEnt="entExt">Hello, world!</doc>

2.6 UTF-8 Encoding

• Effect of transcoding from a sample encoding to UTF-8

Note: The content of the doc element are two octets whose hexadecimal values are C2 and A9, which is the UTF-8 encoding of the UCS codepoint for the copyright sign (©).

<?xml version="1.0" encoding="ISO-8859-1"?>
<doc>©</doc>

<doc>©</doc>

3.1 Namespaces declarations are pushed down

<a:foo xmlns:a="https://a" xmlns:b="https://b" xmlns:c="https://c">
 <b:bar/>
 <b:bar/>
 <b:bar/>
 <a:bar b:att1="val"/>
</a:foo>

<a:foo xmlns:a="https://a">
 <b:bar xmlns:b="https://b"></b:bar>
 <b:bar xmlns:b="https://b"></b:bar>
 <b:bar xmlns:b="https://b"></b:bar>
 <a:bar xmlns:b="https://b" b:att1="val"></a:bar>
</a:foo>

<n0:foo xmlns:n0="https://a">
 <n1:bar xmlns:n1="https://b"></n1:bar>
 <n1:bar xmlns:n1="https://b"></n1:bar>
 <n1:bar xmlns:n1="https://b"></n1:bar>
 <n0:bar xmlns:n1="https://b" n1:att1="val"></n0:bar>
</n0:foo>

3.2 Default namespace declarations

<foo xmlns:a="https://a" xmlns:b="https://b">
 <b:bar b:att1="val" att2="val"/>
</foo>

<foo>
 <b:bar xmlns:b="https://b" att2="val" b:att1="val"></b:bar>
</foo>

<n0:foo xmlns:n0="">
 <n1:bar xmlns:n1="https://b" att2="val" n1:att1="val"></n1:bar>
</n0:foo>

3.3 Sorting namespace declarations

In this example there are four prefixes declarations: "a", "b", "c" and "d". They map to namespace URIs "https://z3", "https://z2", "https://z1" and "https://z0" respectively.

Notice the following things in the default canonicalization ("After c14n"):

• In "a:foo" all the namespace declarations appear before the attribute declarations, even though they were mixed up in the original document.
• In "a:foo" the attributes are sorted in this order - "c:att3", "b:att1", "b:att2". This is because attributes are sorted by namespaceURI as primary key and localName as secondary key. Since "c" is https://z1 and "b" is https://z2, all the "c" attributes appear before "b" attributes. Note that within the "b" attributes "att1" appears before "att2".
• In "a:foo" all the namespace declarations are sorted by prefixes i.e. "a", "b", "c", and NOT by namespace URIs.

• New prefixes are assigned in the order in which they are visibly utilized:
  1. At first "a:foo" visibly utilizes prefixes "a", "b" and "c". These are then sorted by namespace URI, resulting in "c", "b", "a". Then they are assigned prefixes "https://z1"->"n0", "https://z2"->"n1" and "https://z3"->"n2"
  2. After that "c:bar" visibly utilizes prefix "d". This gets assigned prefix "n3"
• In "a:foo" all rewritten prefixes are sorted by prefixes i.e. "n0", "n1", "n2".

<a:foo xmlns:a="https://z3" xmlns:b="https://z2" b:att1="val1" c:att3="val3" b:att2="val2" xmlns:c="https://z1" xmlns:d="https://z0">
 <c:bar/>
 <c:bar d:att3="val3"/>
</a:foo>

<a:foo xmlns:a="https://z3" xmlns:b="https://z2" xmlns:c="https://z1" c:att3="val3" b:att1="val1" b:att2="val2">
 <c:bar></c:bar>
 <c:bar xmlns:d="https://z0" d:att3="val3"></c:bar>
</a:foo>

<n2:foo xmlns:n0="https://z1" xmlns:n1="https://z2" xmlns:n2="https://z3" n0:att3="val3" n1:att1="val1" n1:att2="val2">
 <n0:bar></n0:bar>
 <n0:bar xmlns:n3="https://z0" n3:att3="val3"></n0:bar>
</n2:foo>

3.4 Namespace Re-declarations

In this example there are three prefixes "a", "b" and the default prefix. The "foo" element defines them to be "https://z3", "https://z2" and "" respectively. But the "bar" redeclares these prefixes to "https://z2", "https://z3" abd "https://z0" respectively.

Notice the following things in the default canonicalization ("After c14n"):

• The redeclarations of the prefixes by the "bar" element are not removed by canonicalization, since these declarations are not superfluous.

And notice these things in canonicalization with prefix rewriting ("After c14n with PrefixRewrite"):

• With prefix rewriting, the new prefixes are never redeclared. Instead the same prefix gets rewritten to two different values depending on what namespace it currently declares. For example, for element "foo" attribute "a:att1" gets rewritten to "n2:att1", whereas for element "bar" attribute "a:att1" gets rewritten to "n1:att1". Essentially with prefix rewriting, the current prefixes are completely ignored, and canonicalization assigns new prefixes based on namespace values.

<foo xmlns:a="https://z3" xmlns:b="https://z2" a:att1="val1" b:att2="val2"> 
 <bar xmlns="https://z0" xmlns:a="https://z2" a:att1="val1" b:att2="val2" xmlns:b="https://z3" />
</foo>

<foo xmlns:a="https://z3" xmlns:b="https://z2" b:att2="val2" a:att1="val1"> 
 <bar xmlns="https://z0" xmlns:a="https://z2" xmlns:b="https://z3" a:att1="val1" b:att2="val2"></bar>
</foo>

<n0:foo xmlns:n0="" xmlns:n1="https://z2" xmlns:n2="https://z3" n1:att2="val2" n2:att1="val1"> 
 <n3:bar xmlns:n3="https://z0" n1:att1="val1" n2:att2="val2"></n3:bar>
</n0:foo>

3.5 Superfluous Namespace declarations

In this example there are five prefixes "a", "b", "c", "d" and the default prefix and they are all declared to the same namespace URI "https://z0". The "a" prefix is defined twice, one in the "foo" element, and then again in "c:bar" element; obviously the definition of "a" in "c:bar" is unnecessary.

Notice the following things in the default canonicalization ("After c14n"):

• It does not attempt to recognize that "a", "b", "c", "d" and default are pointing to the same thing.
• It removes the extra declaration of "xmlns:a" in the "c:bar" as that is superfluous.

• All the file prefixes "a", "b", "c", "d" are rewritten to the same prefix - "z0".

<foo xmlns:a="https://z0" xmlns:b="https://z0" a:att1="val1" b:att2="val2" xmlns="https://z0"> 
 <c:bar xmlns:a="https://z0" xmlns:c="https://z0" c:att3="val3"/>
 <d:bar xmlns:d="https://z0"/>
</foo>

<foo xmlns="https://z0" xmlns:a="https://z0" xmlns:b="https://z0" a:att1="val1" b:att2="val2"> 
 <c:bar xmlns:c="https://z0" c:att3="val3"></c:bar>
 <d:bar xmlns:d="https://z0"></d:bar>
</foo>

<n0:foo xmlns:n0="https://z0" n0:att1="val1" n0:att2="val2"> 
 <n0:bar n0:att3="val3"></n0:bar>
 <n0:bar></n0:bar>
</n0:foo>

3.6 Special namespaces "xml", "xsi", "xsd"

In this example there are are three special namespace declaration the "xml" namespace used in the attribute xml:id="23" and also the "xsi" and "xsd" namespaces used in xsi:type="xsd:string".

Canonicalization only treats "xml" as a special namespace. It is never rewritten by prefix-rewriting. "xsi" and "xsd" are treated as regular namespaces.

Notice the following things in the default canonicalization ("After c14n"):

• It does not consider the "xsd" prefix as visibly utilized since it is embedded in the content. That is why it removes the "xsd" namespace declaration completely.

• It also removes the "xsd" declaration completely.
• It doesn't change the "xml" prefix to anything else, also it doesn't emit the namespace declaration for the "xml" prefix.
• But it does rewrite the "xsi" prefix to "ns1".

• Look at the CanonicalzationMethod in c14nQname.xml. it lists "xsi:type" as a Qualified Attribute in the QNameAware element.
• So now the canonicalization looks into the "xsi:type" for prefixes. It finds the "xsd" element and considers it visibly utilized, and hence emits the "xsd" namespace declaration.

• Look at the CanonicalzationMethod in c14nPrefixQname.xml. it lists "xsi:type" as a Qualified Attribute in the QNameAware element. It also PrefixRewite=sequential
• So now "xsd" is considered visibly utilized, and it is rewritten to "n1". I.e. xsi:type="xsd:string" changes to n2:type="n1:string".

<foo xmlns="https://z0" xml:id="23">
  <bar xsi:type="xsd:string" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">data</bar>
</foo>

<foo xmlns="https://z0" xml:id="23">
  <bar xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xsi:type="xsd:string">data</bar>
</foo>

<n0:foo xmlns:n0="https://z0" xml:id="23">
  <n0:bar xmlns:n1="https://www.w3.org/2001/XMLSchema-instance" n1:type="xsd:string">data</n0:bar>
</n0:foo>

<foo xmlns="https://z0" xml:id="23">
  <bar xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xsi:type="xsd:string">data</bar>
</foo>

<n0:foo xmlns:n0="https://z0" xml:id="23">
  <n0:bar xmlns:n1="https://www.w3.org/2001/XMLSchema" xmlns:n2="https://www.w3.org/2001/XMLSchema-instance" n2:type="n1:string">data</n0:bar>
</n0:foo>

3.7 Prefixes in Element content

Notice the following things in the default canonicalization ("After c14n"):

• It does not consider the "xsd", "soap-env" and "b" prefixes as visibly utilized since they are embedded in the content. That is why it removes these namespace declarations completely.

Notice the following things in the default canonicalization ("After c14n with QNameAware <a:bar>"):

• It considers the "xsd", as visbily utilized in element, but not "soap-env" and "b" prefixes as visibly utilized since they are embedded in the XPath content.

Notice the following things in the default canonicalization ("After c14n with QNameAware <a:bar> and <dsig2:IncludedXPath>"):

• All three embedded prefixes "xsd", "soap-env" and "b" prefixes as considered as visibly utilized.
• prefix "c" is not considered visibly utilized since it is inside an XPath sring. Single and double quoted strings inside an XPath expression are not searched for prefixes.
• "child:" is not a prefix, it is an XPath axis, as indicated by the double colon.

Notice the following things in the default canonicalization ("After c14n with QNameAware <a:bar> and <dsig2:IncludedXPath> and PrefixRewrite"):

• All three embedded prefixes "xsd", "soap-env" and "b" prefixes as considered as visibly utilized. They are rewritten to "n1", "n3" and "n2" respectively.
• The text content is modified because of prefix rewriting.
• Even though the "xsd" prefix is rewritten to "n1", the 'xsd:string' is left unchanged, as it inside a single quoted string.

<a:foo xmlns:a="https://a" xmlns:b="https://b" xmlns:child="https://c" xmlns:soap-env="https://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
 <a:bar>xsd:string</a:bar>
 <dsig2:IncludedXPath xmlns:dsig2="https://www.w3.org/2010/xmldsig2#">/soap-env:body/child::b:foo[@att1 != "c:val" and @att2 != 'xsd:string']</dsig2:IncludedXPath>
</a:foo>

<a:foo xmlns:a="https://a">
 <a:bar>xsd:string</a:bar>
 <dsig2:IncludedXPath xmlns:dsig2="https://www.w3.org/2010/xmldsig2#">/soap-env:body/child::b:foo[@att1 != "c:val" and @att2 != 'xsd:string']</dsig2:IncludedXPath>
</a:foo>

<a:foo xmlns:a="https://a">
 <a:bar xmlns:xsd="https://www.w3.org/2001/XMLSchema">xsd:string</a:bar>
 <dsig2:IncludedXPath xmlns:dsig2="https://www.w3.org/2010/xmldsig2#">/soap-env:body/child::b:foo[@att1 != "c:val" and @att2 != 'xsd:string']</dsig2:IncludedXPath>
</a:foo>

<a:foo xmlns:a="https://a">
 <a:bar xmlns:xsd="https://www.w3.org/2001/XMLSchema">xsd:string</a:bar>
 <dsig2:IncludedXPath xmlns:b="https://b" xmlns:dsig2="https://www.w3.org/2010/xmldsig2#" xmlns:soap-env="https://schemas.xmlsoap.org/wsdl/soap/">/soap-env:body/child::b:foo[@att1 != "c:val" and @att2 != 'xsd:string']</dsig2:IncludedXPath>
</a:foo>

<n0:foo xmlns:n0="https://a">
 <n0:bar xmlns:n1="https://www.w3.org/2001/XMLSchema">n1:string</n0:bar>
 <n4:IncludedXPath xmlns:n2="https://b" xmlns:n3="https://schemas.xmlsoap.org/wsdl/soap/" xmlns:n4="https://www.w3.org/2010/xmldsig2#">/n3:body/child::n2:foo[@att1 != "c:val" and @att2 != 'xsd:string']</n4:IncludedXPath>
</n0:foo>