Network Working Group K. Fujimura Request for Comments: 4153 NTT Category: Informational M. Terada NTT DoCoMo D. Eastlake 3rd Motorola Laboratories September 2005
XML Voucher: Generic Voucher Language
Status of This Memo
This memo provides information for the Internet community. It does not specify an Internet standard of any kind. Distribution of this memo is unlimited.
Copyright Notice
Copyright (C) The Internet Society (2005).
Abstract
This document specifies rules for defining voucher properties in XML syntax. A voucher is a logical entity that represents a right to claim goods or services. A voucher can be used to transfer a wide range of electronic values, including coupons, tickets, loyalty points, and gift certificates, which often have to be processed in the course of payment and/or delivery transactions.
This document specifies rules for defining voucher properties in XML syntax. The motivation and background of the specification are described in [VTS].
A voucher is a logical entity that represents a certain right and that is logically managed by the Voucher Trading System (VTS). A voucher is generated by the issuer, traded among users, and finally collected by the collector using VTS.
This document defines the syntax and semantics of the Voucher Component, which defines voucher meaning and processing rules in XML syntax [XML]. A Voucher Component defines the properties that must be satisfied to allow the voucher to be processed by VTS or other trading systems; e.g., a wallet or merchant system. VTS definitions and models are also defined in [VTS].
Note: This document uses "voucher" as an "instance of voucher", whose meaning is defined by the Voucher Component. In other words, a Voucher Component is NOT a voucher, and multiple vouchers can be issued and managed by the VTS using the same Voucher Component.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119]
There are several ways of implementing VTS and technologies are continually changing. For discount coupons or event tickets, for example, the smartcard-based offline VTS is often preferred, whereas for bonds or securities, the centralized online VTS is preferred. It is impractical to define standard protocols for issuing, transferring, or redeeming vouchers at this time.
Fujimura, et al. Informational [Page 2]
RFC 4153 XML Voucher: Generic Voucher Language September 2005
To provide implementation flexibility, this document assumes a modular wallet architecture that allows multiple VTSes to be added as plug-ins. In this architecture, instead of specifying a standard voucher transfer protocol, two specifications, Voucher Component and VTS-API, are standardized (Figure 1).
After the sender and receiver agree on which vouchers are to be traded and which VTS is to be used, the issuing system or wallet system requests the corresponding VTS plug-in to permit the issue, transfer, or redeem transactions to be performed via the VTS API. The VTS then rewrites the ownership of the vouchers using the VTS- specific protocol. Finally, a completion event is sent to the wallet systems or issuing/collecting systems.
This document describes the Voucher Component specification. The VTS-API specification is defined in [VTS-API].
A voucher is trusted if the Issuer and VTS Provider are trusted, as the Issuer is responsible for the contents of the voucher and the VTS Provider is responsible for preventing ownership from being assigned to multiple users.
The trust level required for the Issuer and VTS Provider depends on the type (or Promise) of the voucher. To provide the information needed for verification, the conditions of the Issuer and VTS Provider are specified in the Voucher Component and given as input to the verifier; e.g., wallet system or other software. The trust of a voucher is thus verified through the Voucher Component. This model enables trading partners to verify their trust in the voucher regardless of their trust in the partners.
This document assumes that the Voucher Component is the root of trust. If a malicious user could alter the Voucher Component, a forged voucher could be verified as valid.
When a Voucher Component is delivered from the trusted VTS Provider, Issuer, or trusted third party, a secure communication channel (e.g., [TLS], [IPSEC], or object security, such as [XMLDSIG]) should be used to prevent alteration during the delivery.
Note: The Voucher Component does not have to be sent from the sender of the voucher. Note also that a set of trusted Voucher Components can be downloaded before a transaction is conducted.
The Voucher Component provides the information needed to identify the monetary value or merchandize rendered when the voucher is redeemed. It includes
o how much value/items can be claimed in exchange for the voucher, and
o restrictions applied to the voucher
- participants (VTS Provider, Issuer, Holder, and Collector),
- objects (merchandise) to be claimed,
- time when valid (validity period), and
- others.
Fujimura, et al. Informational [Page 4]
RFC 4153 XML Voucher: Generic Voucher Language September 2005
The Voucher Component also provides common properties useful for displaying and manipulating the contents of wallet systems. It includes the title and description of each voucher.
The Voucher Component contains the following components:
Title Component
Provides the title of the voucher. This is mainly for listing the entities stored in a wallet system.
Description Component
Provides a short description of the voucher. This is mainly for listing the entities stored in a wallet system.
Provider Component
Provides restrictions on which VTS Provider (or VTS plug-in) can be used for trading the voucher.
Issuer Component
Provides restrictions on the Issuer of the voucher.
Holder Component
Provides restrictions on the Holder of the voucher.
Collector Component
Provides restrictions on the Collector of the voucher.
Value Component
Provides the value of each voucher. There are two types of values: fixed and ratio values. For a fixed value, the currency and the figure is specified. For a ratio value, the discount ratio of the corresponding merchandize is specified.
The Value Component also indicates the number of vouchers to be redeemed for claiming the merchandise or monetary value specified in the Merchandise Component or Value Component. If "n" (>0) is specified, the merchandize or monetary value can be claimed in exchange for "n sheets of" vouchers. If "0" is specified, it can be used repeatedly.
Fujimura, et al. Informational [Page 5]
RFC 4153 XML Voucher: Generic Voucher Language September 2005
Merchandise Component
Provides restrictions on the object to be claimed. The domain- specific meaning of the voucher (e.g., reference number of the merchandize or seat number for an event ticket) is specified to identify the merchandize rendered when the voucher is redeemed.
ValidPeriod Component
Provides restrictions on the validity period of the voucher; i.e., start date and end date.
Condition Component
Provides any other applicable restrictions. This is intended to cover contracts between the issuer and holder of the voucher in natural language form.
Using the above Components, semantics for diverse types of vouchers can be defined as shown in Table 1.
An example of a Voucher Component is described below. This is an example of a five-dollar discount coupon for specific merchandize, a book with ISBN number 0071355014. The coupon is valid from April 1, 2001, to March 31, 2002. To claim this offer, one voucher must be spent.
<?xml version="1.0" encoding="UTF-8"?> <Voucher xmlns="urn:ietf:params:xml:ns:vts-lang" xmlns:vts="http://www.example.com/vts"> <Title>IOTP Book Coupon</Title> <Description>$5 off IOTP Book</Description> <Provider name="Voucher Exchanger 2002"> <vts:Version>VE2.31</vts:Version> </Provider> <Issuer name="Alice Book Center, Ltd."> <vts:KeyInfo> 1DA8DFCF95521014BBB7171B95545E8D61AE803F </vts:KeyInfo> </Issuer> <Collector name="Alice Book Center, Ltd."/> <Value type="discount" spend="1"> <Fixed amount="5" currency="USD"/> </Value> <Merchandise> <bk:Book xmlns:bk="http://www.example.com/bk" bk:isbn="0071355014"/> </Merchandise> <ValidPeriod start="2002-04-01" end="2003-03-31"/> <Conditions> The value of this coupon is subject to tax. </Conditions> </Voucher>
Fujimura, et al. Informational [Page 7]
RFC 4153 XML Voucher: Generic Voucher Language September 2005
The general structure of an XML Voucher Component is described in Section 4. This section details the Voucher Component features. Features described in this section MUST be implemented unless otherwise indicated. The syntax is defined via [XML-Schema-1] [XML-Schema-2]. For clarity, unqualified elements in schema definitions are in the XML schema namespace:
References to XML Voucher schema defined herein use the prefix "gvl" and are in the namespace:
xmlns:gvl="urn:ietf:params:xml:ns:vts-lang"
This namespace URI for elements defined by this document is a URN [URN] that uses the namespace identifier 'ietf', defined by [URN-NS-IETF] and extended by [XML-Registry].
This namespace is also used for unqualified elements in voucher examples.
The <Voucher> element contains <Title>, <Provider>, and <Value> elements and optionally contains <Description>, <Issuer>, <Holder>, <Collector>, <ValidPeriod>, and <Condition> elements. These sub- elements are defined in the following sections.
The <Voucher> element is defined by the following schema:
The <Provider> element may contain any element that is used to specify or restrict the VTS Provider of the voucher. The sub- elements contained in this element depend on the implementation of the VTS.
An implementation of a wallet system may use this information to identify and/or authenticate the VTS Provider when the VTS plug-in is registered (see Section 7 of [VTS-API]). These implementation- specific elements of the VTS can be extended using [XML-ns]. An example of such a schema definition is described in Section 8.
The <Provider> element has a string-type "name" attribute that is used to specify the name of the VTS Provider.
The <Provider> element is defined by the following schema:
The <Issuer> element may contain any element that is used to specify or restrict the Issuer of the voucher.
The Issuer of the voucher is generally managed by the VTS [VTS-API]. There is no need to specify the Issuer of the voucher using this element if there are no restrictions on the Issuer.
An implementation of a VTS may use this element to describe the authentication data and/or qualification information of the Issuer. This implementation-specific information can be extended through sub-elements using [XML-ns]. An example of such a schema definition is described in Section 8.
The <Issuer> element has a string-type "name" attribute that is used to specify the name of the Issuer.
The <Issuer> element is defined by the following schema:
<element name="Issuer" type="gvl:RoleType"/>
The <RoleType> element type is defined in Section 6.4.
If the <Issuer> element is omitted, it MUST be interpreted that there are no restrictions on the Issuer.
The <Holder> element may contain any element that is used to specify or restrict the Holder of the voucher.
The Holder of the voucher is generally managed by the VTS [VTS-API]. There is no need to specify the Holder of the voucher using this element if there are no restrictions on the Holder.
An implementation of a VTS may use this element to describe the authentication data and/or qualification information of the Holder. This implementation-specific information can be extended through sub-elements using [XML-ns].
The <Holder> element has a string-type "name" attribute that is used to specify the name of the Holder.
Fujimura, et al. Informational [Page 10]
RFC 4153 XML Voucher: Generic Voucher Language September 2005
The <Holder> element is defined by the following schema:
<element name="Holder" type="gvl:RoleType"/>
The <RoleType> element type is defined in Section 6.4.
If the <Holder> element is omitted, it MUST be interpreted that there are no restrictions on the Holder.
The <Collector> element may contain any element that is used to specify or restrict the Collector of the voucher.
There is no need to specify the Collector of the voucher using this element if there are no restrictions on the Collector.
An implementation of a VTS may use this element to describe the authentication data and/or qualification information of the Collector. This implementation-specific information can be extended through sub-elements using [XML-ns].
The <Collector> element has a string-type "name" attribute that is used to specify the name of the Collector.
The <Collector> element is defined by the following schema:
<element name="Collector" type="gvl:RoleType"/>
The <RoleType> element type is defined in Section 6.4.
If the <Collector> element is omitted, it MUST be interpreted that there are no restrictions on the Collector.
The <Value> element optionally contains a <Fixed> or <Ratio> element but not both. These sub-elements are defined in the following sections.
The <Value> element has a "type" attribute that is used to specify the value process type. This attribute is provided to calculate the amount paid when the vouchers are redeemed at Merchant site, etc.
Fujimura, et al. Informational [Page 11]
RFC 4153 XML Voucher: Generic Voucher Language September 2005
The following identifiers are defined for the "type" attribute.
Exchange: Items specified in the <Merchandise> element can be claimed in exchange for the voucher. If this type is selected, neither the <Ratio> nor the <Fixed> element MUST be specified. Note that this value process type has the same meaning as:
Discount: Items specified in the <Merchandise> element can be purchased at the discount price calculated by the <Ratio> or <Fixed> element.
Monetary: Items specified in the <Merchandise> element can be purchased using the value of the voucher. (Note: if the <Merchandise> element is not specified, the voucher can be used for any purchase.) If this type is selected, the <Fixed> element MUST be specified.
The <Value> element also has a "spend" attribute that is used to specify the number of vouchers to be redeemed for claiming the goods, services, or monetary value specified. For example, if "n" (>0) is specified, goods can be claimed in exchange for "n sheets of" vouchers. (Note: Multiple vouchers for the same Voucher Component must exist in this case.) If "0" is specified, it can be used repeatedly.
If the "spend" attribute or the whole element is omitted, it MUST be interpreted that "1" is specified for the "spend" attribute.
The <Value> element is defined by the following schema:
The <Ratio> element does not contain any contents.
The <Ratio> element has a "percentage" attribute that is used to specify the discount ratio of the price of the corresponding merchandize in percentage.
The <RatioValueType> element type is defined by the following schema:
The <Fixed> element does not contain any contents.
The <Fixed> element has "currency" and "amount" attributes and optionally a "decimalPower" attribute as follows:
Currency: Provides the unit of the monetary value in the three letter ISO currency code [ISO4217]. For example, US dollars is "USD".
Amount: Provides the amount of the monetary value per voucher.
DecimalPower: Provides the number of decimal digits from the decimal point applied to the base for the "amount" attribute above. If the "decimalPower" attribute is omitted, it MUST be interpreted that "0" is specified for the "decimalPower" attribute.
Fujimura, et al. Informational [Page 13]
RFC 4153 XML Voucher: Generic Voucher Language September 2005
For example, with a dollar currency denominated in cents, "1" is specified for the "amount" attribute, and "-2" is specified for the "decimalPower" attribute. Alternately, "0.01" is specified for the "amount" attribute, and the "decimalPower" attribute is omitted.
The <Merchandise> element may contain any element used to specify or restrict the goods or services rendered when the voucher is redeemed. The sub-elements contained in this element depend on the application of the voucher and are left to the other domain-specific specifications. Domain-specific elements can be extended as sub- elements using [XML-ns].
This element is intended to be interpreted by a collecting system. An implementation of a wallet system does not have to use this element. Any restrictions applied should also be described in the <Description> element or the <Conditions> elements in natural language form to enable users to check the restrictions.
The <Merchandise> element does not have any attribute.
The <Merchandise> element is defined by the following schema:
If the "start" attribute is omitted, it MUST be interpreted that the voucher is valid on any date up to that specified by the end attribute (inclusive). If the "end" attribute is omitted, it MUST be interpreted that the voucher is valid from the start attribute with no expiry. If neither attribute is specified or the whole element is omitted, it MUST be interpreted that the voucher is valid at any time.
The <Conditions> element contains any other restrictions or conditions applied. This is intended to cover contracts between the issuer and the holder of the voucher in natural language form.
An implementation of a wallet system SHOULD provide a means of displaying the text in this element.
The <Conditions> element has no attribute.
The <Conditions> element is defined by the following schema:
This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism described in [XML-Registry]. IANA has registered two URI assignments.
Registration request for the vts-lang namespace:
URI: urn:ietf:params:xml:ns:vts-lang
Registrant Contact: See the "Authors' Addresses" section of this document.
XML: None. Namespace URIs do not represent an XML specification.
Fujimura, et al. Informational [Page 15]
RFC 4153 XML Voucher: Generic Voucher Language September 2005
Registration request for the vts-lang XML schema:
URI: urn:ietf:params:xml:schema:vts-lang
Registrant Contact: See the "Authors' Addresses" section of this document.
Using this schema definition, the <vts:Version> can be used for specifying the VTS version number, and the <vts:KeyInfo> element can be used for specifying the Issuer in the Voucher Component, as shown in Section 5.
The VTS must provide a means to prevent forgery, alteration, duplicate-redemption, reproduction of a voucher, and non-repudiation of transactions, as described in Section 3.2 of [VTS]. This will commonly require the presence of a unique serial number or the like in each Voucher instance, usually outside the Voucher Component. These security requirements, however, mainly follow the VTS plug-ins and their protocols. This document assumes that the VTS plug-ins are trusted and are installed by some means; e.g., manually checked as are other download applications.
The Voucher Component, however, defines restrictions on the VTS Provider (or VTS plug-in), and, if this information is altered, incorrect VTS plug-ins not accepted by the issuer could be used, allowing a forged voucher to be verified as if it were valid. To prevent this situation, the Voucher Component should be stored and
Fujimura, et al. Informational [Page 18]
RFC 4153 XML Voucher: Generic Voucher Language September 2005
acquired securely; e.g., downloaded from a trusted party using a secure communication channel, such as [TLS] or [IPSEC], or secured by the digital signature of a trusted party [XMLDSIG].
[XML-Registry] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, January 2004.
[XML-Schema-1] Thompson, H., Beech, D., Maloney, M., and N. Mendelsohn, "XML Schema Part 1: Structures W3C Recommendation.", <http://www.w3.org/TR/xmlschema-1/>, May 2001.
[XML-Schema-2] Biron, P. and A. Malhotra, "XML Schema Part 2: Datatypes W3C Recommendation.", <http://www.w3.org/TR/xmlschema-2/>, May 2001.
Fujimura, et al. Informational [Page 19]
RFC 4153 XML Voucher: Generic Voucher Language September 2005
RFC 4153 XML Voucher: Generic Voucher Language September 2005
Full Copyright Statement
Copyright (C) The Internet Society (2005).
This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights.
This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Intellectual Property
The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79.
Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr.
The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf- ipr@ietf.org.
Acknowledgement
Funding for the RFC Editor function is currently provided by the Internet Society.