Home > Articles > Web Services > XML

  • Print
  • + Share This
This chapter is from the book

Canonical XML Example: Different but Equal

In this section, we'll examine two XML instances that are physically different and determine whether they are logically equivalent based on a comparision of their canonical forms. To accomplish this, we'll use a handy utility called xmlcanon, the Canonical XML Processor, from ElCel Technology, which generates the canonical form of a document; xmlcanon is freely available (see http://www.elcel.com/products/xmlcanonman.html). See this book's CD-ROM.

Listings 5-3 and 5-4 show the two original XML documents in their noncanonical form.

Listing 5-3 Input Variation 1 (catalog1.xml)

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

<!DOCTYPE Disc:DiscountCatalog [
<!ELEMENT Disc:DiscountCatalog (Disc:category) >
<!ATTLIST Disc:DiscountCatalog 
     xmlns:Disc CDATA #FIXED 
     "http://www.HouseOfDiscounts.com/namespaces/Discounts" >
<!ELEMENT Disc:category (Disc:item+) >
<!ATTLIST Disc:category name CDATA #REQUIRED >
<!ELEMENT Disc:item   (Disc:price, Disc:extra*) >
<!ATTLIST Disc:item name CDATA #REQUIRED >
<!ELEMENT Disc:price (#PCDATA) >
<!ATTLIST Disc:price type (wholesale|retail) "wholesale">
<!ATTLIST Disc:price currency CDATA '$US' >
<!ELEMENT Disc:extra (#PCDATA) >
<!ENTITY internalEnt  "Internal Entity Replacement Text" >
<!ENTITY externalEnt  SYSTEM  "oz.txt">
]>

<!-- Comment outside doc root may or may not be discarded. -->
<Disc:DiscountCatalog>
<!-- Note quotes around 'Wild Animals' and 'Lion' on input. -->
 <Disc:category name='Wild Animals'>
  <Disc:item      name = '   Lion'>
   <Disc:price   type="wholesale">999.99</Disc:price>
  </Disc:item>

<?somePI    target1="foo"    target2="bar"  ?>
<!-- Comment with entity ref &internalEnt; which won't expand. -->

  <Disc:item name="Tiger">
   <Disc:price type="wholesale">879.99</Disc:price>
   <Disc:extra>&#169;</Disc:extra>
   <Disc:extra>&internalEnt;</Disc:extra>
   <Disc:extra/>  <!-- empty element -->
  </Disc:item>

  <Disc:item name="Bear"><Disc:price type="wholesale">1199.99</Disc:price>
<Disc:extra>External entity replacement: &externalEnt;</Disc:extra>
<Disc:extra>
<![CDATA[
  sale > "500.00" && sale < "2000.00" ? 'munchkin' : 'monkey'
]]>
</Disc:extra></Disc:item>
 </Disc:category>
</Disc:DiscountCatalog>

Listing 5-4 Input Variation 2 (catalog2.xml)

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE Disc:DiscountCatalog [
<!-- Different order of declarations in DTD -->
<!ENTITY externalEnt  SYSTEM  "oz.txt">
<!ELEMENT Disc:DiscountCatalog (Disc:category) >
<!ATTLIST Disc:DiscountCatalog 
     xmlns:Disc CDATA #FIXED 
     "http://www.HouseOfDiscounts.com/namespaces/Discounts" >
<!ELEMENT Disc:item   (Disc:price, Disc:extra*) >
<!ATTLIST Disc:item name CDATA #REQUIRED >
<!ELEMENT Disc:price (#PCDATA) >
<!ATTLIST Disc:price type (wholesale|retail) "wholesale">
<!-- Inline in this version: ATTLIST Disc:price currency CDATA '$US' -->
<!ELEMENT Disc:extra (#PCDATA) >
<!ELEMENT Disc:category (Disc:item+) >
<!ATTLIST Disc:category name CDATA #REQUIRED >
]>

<!-- Comment outside doc root may or may not be discarded. -->
<Disc:DiscountCatalog>
<!-- Note quotes around 'Wild Animals' and 'Lion' on input. -->
 <Disc:category name="Wild Animals">
  <Disc:item name="   Lion">
   <Disc:price type="wholesale" currency="$US" >999.99</Disc:price>
  </Disc:item>

<?somePI target1="foo"    target2="bar"  ?>
<!-- Comment with entity ref &internalEnt; which won't expand. -->

  <Disc:item        name="Tiger">
   <Disc:price   currency = "$US"   type="wholesale"   >879.99</ Disc:price>
   <Disc:extra>&#169;</Disc:extra>
   <Disc:extra>Internal Entity Replacement Text</Disc:extra>
   <Disc:extra></Disc:extra>  <!-- empty element -->
  </Disc:item>

  <Disc:item name="Bear"><Disc:price currency="$US" type="wholesale">1199.99</Disc:price>
<Disc:extra>External entity replacement: &externalEnt;</Disc:extra>
<Disc:extra>
<![CDATA[
  sale > "500.00" && sale < "2000.00" ? 'munchkin' : 'monkey'
]]>
</Disc:extra></Disc:item>
 </Disc:category>
</Disc:DiscountCatalog>

Some of the differences are fairly obvious, but others are subtle, so I've used the UNIX diff command to compare the two input documents.2 The comparison appears in Listing 5-5, in which < marks lines from variation 1 and > denotes lines from variation 2. The major differences between the two XML documents include:

  • The DTDs (internal subset) differ in order of declarations.

  • The DTD portion of variation 1 contains a default attribute declaration for currency, but variation 2 explicitly provides the values in the XML instance.

  • Variation 1 declares the internal entity internalEnt as the string "Internal Entity Replacement Text" but variation 2 explicity provides this string as CDATA.

  • The words Wild Animals and Lions appear with single quotes in variation 1 but double quotes in variation 2.

  • In variation 1, the empty element is shown as <Disc:extra/>, whereas it is expanded in variation 2.

  • There are many differences concerning the use of white space between the two versions.

  • Variation 1 is 1,735 bytes, whereas variation 2 is 1,834 bytes, as determined by the UNIX wc (word count) command.

Listing 5-5 UNIX-Style Differences between Variations 1 and 2 (diff-input.txt)

2d1
< 
3a3,4
> <!-- Different order of declarations in DTD -->
> <!ENTITY externalEnt  SYSTEM  "oz.txt">
8,9d8
< <!ELEMENT Disc:category (Disc:item+) >
< <!ATTLIST Disc:category name CDATA #REQUIRED >
14c13
< <!ATTLIST Disc:price currency CDATA '$US' >
---
> <!-- Inline in this version: ATTLIST Disc:price currency CDATA '$US' -->
16,17c15,16
< <!ENTITY internalEnt  "Internal Entity Replacement Text" >
< <!ENTITY externalEnt  SYSTEM  "oz.txt">
---
> <!ELEMENT Disc:category (Disc:item+) >
> <!ATTLIST Disc:category name CDATA #REQUIRED >
23,25c22,24
<  <Disc:category name='Wild Animals'>
<   <Disc:item      name = '   Lion'>
<    <Disc:price   type="wholesale">999.99</Disc:price>
---
>  <Disc:category name="Wild Animals">
>   <Disc:item name="   Lion">
>    <Disc:price type="wholesale" currency="$US" >999.99</Disc:price>
28c27
< <?somePI    target1="foo"    target2="bar"  ?>
---
> <?somePI target1="foo"    target2="bar"  ?>
31,32c30,31
<   <Disc:item name="Tiger">
<    <Disc:price type="wholesale">879.99</Disc:price>
---
>   <Disc:item        name="Tiger">
>    <Disc:price   currency = "$US"   type="wholesale"   >879.99</Disc:price>
34,35c33,34
<    <Disc:extra>&internalEnt;</Disc:extra>
<    <Disc:extra/>  <!-- empty element -->
---
>    <Disc:extra>Internal Entity Replacement Text</Disc:extra>
>    <Disc:extra></Disc:extra>  <!-- empty element -->
38c37
<   <Disc:item name="Bear"><Disc:price type="wholesale">1199.99</Disc:price>
---
>   <Disc:item name="Bear"><Disc:price currency="$US" type="wholesale">1199.99</Disc:price>

So, now that we have a good idea of how the two files differ, our next step is to generate the canonical form of each variation and compare the results. Although xmlcanon supports a number of useful options, for our purposes, we can use the default behavior.

C:\>xmlcanon catalog1.xml > canon1.xml
C:\>xmlcanon catalog2.xml > canon2.xml

Listing 5-6 shows the canonical form of the first file (canon1.xml). There are several noteworthy aspects of the canonical form when compared to the input file catalog1.xml (Listing 5-3).

  • The entire DTD (an internal subset) has been stripped, along with the XML declaration.

  • All single quotes surrounding attribute values that have been replaced by double quotes, although single quotes appearing in comments have remained intact.

  • White space in start tags has been reduced (normalized), except where it occurred within attribute values, such as " Lion".

  • The default value for the currency attribute of the Disc:price element has been substituted.

  • White space after the target of the PI has been removed, but white space has been preserved in the content of the PI.

  • The entity reference &internalEnt; was not expanded within a comment, but was expanded in the Disc:extra element.

  • The character code &#169; has been replaced with the copyright symbol.

  • The external entity &internalEnt; has been replaced by the content of the file oz.txt, which is just the string Oh, my! plus a newline.

  • The CDATA section has been replaced by characters and entity references.

  • The canonical form is only 1,107 bytes, due largely to the removal of the DTD and partially due to stripping unnecessary white space.

Listing 5-6 Canonical Form of Input Variation 1 (canon1.xml)

<!-- Comment outside doc root may or may not be discarded. -->
<Disc:DiscountCatalog xmlns:Disc="http://www.HouseOfDiscounts.com/ namespaces/Discounts">
<!-- Note quotes around 'Wild Animals' and 'Lion' on input. -->
 <Disc:category name="Wild Animals">
  <Disc:item name="   Lion">
   <Disc:price currency="$US" type="wholesale">999.99</Disc:price>
  </Disc:item>

<?somePI target1="foo"    target2="bar"  ?>
<!-- Comment with entity ref &internalEnt; which won't expand. -->

  <Disc:item name="Tiger">
   <Disc:price currency="$US" type="wholesale">879.99</Disc:price>
   <Disc:extra>©</Disc:extra>
   <Disc:extra>Internal Entity Replacement Text</Disc:extra>
   <Disc:extra></Disc:extra>  <!-- empty element -->
  </Disc:item>

  <Disc:item name="Bear"><Disc:price currency="$US" type="wholesale">1199.99</Disc:price>
<Disc:extra>External entity replacement: Oh, my!
</Disc:extra>
<Disc:extra>

  sale &gt; "500.00" &amp;&amp; sale &lt; "2000.00" ? 'munchkin' : 'monkey'

</Disc:extra></Disc:item>
 </Disc:category>
</Disc:DiscountCatalog>

From a cygwin UNIX shell window, I used the diff command to verify that the two canonical forms were in fact identical:

$ diff canon1.xml canon2.xml

The diff command produced no output, which indicates that the inputs were identical.

ElCel's xmlcanon gives you the option of trying the original XML canonicalization method proposed by XML expert James Clark (http://www.jclark.com/xml/canonxml.html) in one of the working drafts of Canonical XML. While the canonical form that Clark's method produces is very different from that produced by the final W3C Recommendation, I verified that it too produced equivalent canonical forms for the two sample input files, using the command lines:

C:\>xmlcanon --method="JClark" catalog1.xml > clark1.xml
C:\>xmlcanon --method="JClark" catalog2.xml > clark2.xml
$ diff clark1.xml clark2.xml

Listing 5-7 shows clark1.xml, the canonical form first proposed by James Clark. The output that appears without line breaks has been wrapped to make it at least semireadable. It contains only 990 bytes.

Listing 5-7 James Clark's Canonical Form (clark1.xml)

<Disc:DiscountCatalog
xmlns:Disc="http://www.HouseOfDiscounts.com/namespaces/Discounts">&#10;
&#10; <Disc:category name="Wild Animals">&#10; <Disc:item name="
Lion">&#10; <Disc:price currency="$US"
type="wholesale">999.99</Disc:price>&#10; </Disc:item>&#10;&#10;<?somePI
target1="foo" target2="bar" ?>&#10;&#10;&#10; <Disc:item
name="Tiger">&#10; <Disc:price currency="$US"
type="wholesale">879.99</Disc:price>&#10;
<Disc:extra>©</Disc:extra>&#10; <Disc:extra>Internal Entity Replacement
Text</Disc:extra>&#10; <Disc:extra></Disc:extra> &#10;
</Disc:item>&#10;&#10; <Disc:item name="Bear"><Disc:price currency="$US"
type="wholesale">1199.99</Disc:price>&#10;<Disc:extra>External entity
replacement: Oh, my!&#10;</Disc:extra>&#10;<Disc:extra>&#10;&#10; sale
&gt; &quot;500.00&quot; &amp;&amp; sale &lt; &quot;2000.00&quot; ?
'munchkin' : 'monkey'&#10;&#10;</Disc:extra></Disc:item>&#10;
</Disc:category>&#10;</Disc:DiscountCatalog> 

When we again use the UNIX diff command to compare clark1.xml and clark2.xml, we find no difference. Therefore, although the canonicalization method that produced these files in not the same as the one the W3C ultimately implemented, Clark's method also proves that our original two input files, catalog1.xml and catalog2.xml, have the same canonical form (i.e., they are logically equivalent despite many physical differences).

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020