| Internet Engineering Task Force | G. Brown |
| Internet-Draft | CentralNic Group plc |
| Intended status: Experimental | November 04, 2013 |
| Expires: May 08, 2014 |
Registry Fee Extension for the Extensible Provisioning Protocol (EPP)
draft-brown-epp-fees-00
This document describes an Extensible Provisioning Protocol (EPP) extension mapping for registry fees.
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.
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."
This Internet-Draft will expire on May 08, 2014.
Copyright (c) 2013 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
Historically, domain name registries have applied a simple fee structure for billable transactions, namely a basic unit price applied to domain <create>, <renew>, <transfer> and RGP restore commands. Given the relatively small number of EPP servers to which EPP clients have been required to connect, it has generally been the case that client operators have been able to obtain details of these fees out-of-band by contacting the server operators.
Given the imminent expansion of the DNS namespace, and the proliferation of novel business models, it is now desirable to provide a method for EPP clients to query EPP servers for the fees and credits associated with certain commands and specific objects.
This document describes an extension mapping for version 1.0 of the Extensible Provisioning Protocol (EPP) [RFC5730]. This EPP mapping provides a mechanism by which EPP clients may query the fees and credits associated with various billable transactions.
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 RFC 2119 [RFC2119].
XML is case sensitive. Unless stated otherwise, XML specifications and examples provided in this document MUST be interpreted in the character case presented in order to develop a conforming implementation.
"fee" is used as an abbreviation for "urn:ietf:params:xml:ns:fee-0.3". The XML namespace prefix "fee" is used, but implementations MUST NOT depend on it and instead employ a proper namespace-aware XML parser and serializer to interpret and output the XML documents.
The XML namespace prefix above contains a version number, specifically "0.3". This version number will increment with successive versions of this document, and will reach 1.0 if and when this document is published as an RFC. This permits clients to distinguish which version of the extension a server has implemented.
A detailed description of the EPP syntax and semantics can be found in [RFC5730].
This extension does not add any elements to the EPP <check> or <poll> commands or responses.
This extension defines additional elements for the EPP <info> command.
The command frame MAY contain an <extension> element which contains a <fee:info> element with the following child elements:
If the server supports the
Registry Grace Period Mapping [RFC3915], then the server MUST also support the "restore" value. The <fee:action> element MAY have an OPTIONAL "phase" attribute specifying a launch phase as described in [draft-tan-epp-launchphase]. The <fee:action> element may also contain an OPTIONAL "subphase" attribute identifying the custom or sub-phase as described in [draft-tan-epp-launchphase].Example <info> command:
C: <?xml version="1.0" encoding="UTF-8" standalone="no"?> C: <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> C: <command> C: <info> C: <domain:info C: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> C: <domain:name hosts="all">example.com</domain:name> C: </domain:info> C: </info> C: <extension> C: <fee:info xmlns:fee="urn:ietf:params:xml:ns:fee-0.3"> C: <fee:currency>USD</fee:currency> C: <fee:action phase="sunrise">create</fee:action> C: <fee:period unit="y">1</fee:period> C: </fee:info> C: </extension> C: <clTRID>ABC-12345</clTRID> C: </command> C: </epp>
When the server receives an <info> command that includes the extension element described above, its response MUST (subject to the exceptions described below) contain an <extension> element, which MUST contain a child <fee:infData> element. The <fee:infData> MUST contain the following child elements:
If the domain name requested in the command is invalid, sponsored by another client, or otherwise ineligible for registration, the server MAY choose to omit the <fee:infData> element and return an error instead.
Example <info> response:
S: <?xml version="1.0" encoding="UTF-8" standalone="no"?> S: <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> S: <response> S: <result code="1000"> S: <msg>Command completed successfully</msg> S: </result> S: <resData> S: <domain:infData S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> S: <domain:name>example.com</domain:name> S: <domain:roid>EXAMPLE1-REP</domain:roid> S: <domain:status s="ok"/> S: <domain:registrant>jd1234</domain:registrant> S: <domain:contact type="admin">sh8013</domain:contact> S: <domain:contact type="tech">sh8013</domain:contact> S: <domain:ns> S: <domain:hostObj>ns1.example.com</domain:hostObj> S: <domain:hostObj>ns1.example.net</domain:hostObj> S: </domain:ns> S: <domain:host>ns1.example.com</domain:host> S: <domain:host>ns2.example.com</domain:host> S: <domain:clID>ClientX</domain:clID> S: <domain:crID>ClientY</domain:crID> S: <domain:crDate>1999-04-03T22:00:00.0Z</domain:crDate> S: <domain:upID>ClientX</domain:upID> S: <domain:upDate>1999-12-03T09:00:00.0Z</domain:upDate> S: <domain:exDate>2005-04-03T22:00:00.0Z</domain:exDate> S: <domain:trDate>2000-04-08T09:00:00.0Z</domain:trDate> S: <domain:authInfo> S: <domain:pw>2fooBAR</domain:pw> S: </domain:authInfo> S: </domain:infData> S: </resData> S: <extension> S: <fee:infData xmlns:fee="urn:ietf:params:xml:ns:fee-0.3"> S: <fee:currency>USD</fee:currency> S: <fee:action phase="sunrise">create</fee:action> S: <fee:period unit="y">1</fee:period> S: <fee:fee>10.00</fee:fee> S: </fee:infData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54322-XYZ</svTRID> S: </trID> S: </response> S: </epp>
Example <info> response where the domain name is not registered:
S: <?xml version="1.0" encoding="UTF-8" standalone="no"?> S: <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> S: <response> S: <result code="2303"> S: <msg>Object does not exist.</msg> S: </result> S: <extension> S: <fee:infData xmlns:fee="urn:ietf:params:xml:ns:fee-0.3"> S: <fee:currency>USD</fee:currency> S: <fee:action phase="sunrise">create</fee:action> S: <fee:period unit="y">1</fee:period> S: <fee:fee>10.00</fee:fee> S: </fee:infData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54322-XYZ</svTRID> S: </trID> S: </response> S: </epp>
This extension does not add any elements to the EPP <transfer> query command, but does include elements in the response, when the extension has been selected during a <login> command.
When the <transfer> query command has been processed successfully, the client selected the extension when it logged in, and the client is authorised by the server to view information about the transfer, the server MAY include in the <extension> section of the EPP response a <fee:trnData> element that contains a <fee:fee> element containing the fee associated with this command. If no <fee:trnData> element is included in the response, then no fee has been assessed by the server for this transaction.
Example <transfer> query response:
S: <?xml version="1.0" encoding="UTF-8" standalone="no"?> S: <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> S: <response> S: <result code="1001"> S: <msg>Command completed successfully; action pending</msg> S: </result> S: <resData> S: <domain:trnData S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> S: <domain:name>example.com</domain:name> S: <domain:trStatus>pending</domain:trStatus> S: <domain:reID>ClientX</domain:reID> S: <domain:reDate>2000-06-08T22:00:00.0Z</domain:reDate> S: <domain:acID>ClientY</domain:acID> S: <domain:acDate>2000-06-13T22:00:00.0Z</domain:acDate> S: <domain:exDate>2002-09-08T22:00:00.0Z</domain:exDate> S: </domain:trnData> S: </resData> S: <extension> S: <fee:trnData xmlns:fee="urn:ietf:params:xml:ns:fee-0.3"> S: <fee:fee>5.00</fee:fee> S: </fee:trnData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54322-XYZ</svTRID> S: </trID> S: </response> S: </epp>
This extension does not add any elements to the EPP <create> command, but does include elements in the response, when the extension has been selected during a <login> command.
When the <create> command has been processed successfully, and the client selected the extension when it logged in, the server MAY include in the <extension> section of the EPP response a <fee:creData> element that contains a <fee:fee> element containing the fee associated with this command. If no <fee:creData> element is included in the response, then no fee has been assessed by the server for this transaction.
Example <create> response:
S: <?xml version="1.0" encoding="UTF-8" standalone="no"?> S: <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> S: <response> S: <result code="1000"> S: <msg>Command completed successfully</msg> S: </result> S: <resData> S: <domain:creData S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> S: <domain:name>example.com</domain:name> S: <domain:crDate>1999-04-03T22:00:00.0Z</domain:crDate> S: <domain:exDate>2001-04-03T22:00:00.0Z</domain:exDate> S: </domain:creData> S: </resData> S: <extension> S: <fee:creData xmlns:fee="urn:ietf:params:xml:ns:fee-0.3"> S: <fee:fee>5.00</fee:fee> S: </fee:creData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54321-XYZ</svTRID> S: </trID> S: </response> S: </epp>
This extension does not add any elements to the EPP <delete> command, but does include elements in the response, when the extension has been selected during a <login> command.
When the <delete> command has been processed successfully, and the client selected the extension when it logged in, the server MAY include in the <extension> section of the EPP response a <fee:delData> element that contains a <fee:credit> element containing any credit associated with the deletion of the domain. If no <fee:delData> element is included in the response, then no credit has been assessed by the server for this transaction.
Example <delete> response:
S: <?xml version="1.0" encoding="UTF-8" standalone="no"?> S: <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> S: <response> S: <result code="1000"> S: <msg>Command completed successfully</msg> S: </result> S: <extension> S: <fee:delData xmlns:fee="urn:ietf:params:xml:ns:fee-0.3"> S: <fee:credit>5.00</fee:credit> S: </fee:delData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54321-XYZ</svTRID> S: </trID> S: </response> S: </epp>
This extension does not add any elements to the EPP <renew> command, but does include elements in the response, when the extension has been selected during a <login> command.
When the <renew> command has been processed successfully, and the client selected the extension when it logged in, the server MAY include in the <extension> section of the EPP response a <fee:renData> element that contains a <fee:fee> element containing the fee associated with this command. If no <fee:renData> element is included in the response, then no fee has been assessed by the server for this transaction.
Example <renew> response:
S: <?xml version="1.0" encoding="UTF-8" standalone="no"?> S: <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> S: <response> S: <result code="1000"> S: <msg>Command completed successfully</msg> S: </result> S: <resData> S: <domain:renData S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> S: <domain:name>example.com</domain:name> S: <domain:exDate>2005-04-03T22:00:00.0Z</domain:exDate> S: </domain:renData> S: </resData> S: <extension> S: <fee:renData xmlns:fee="urn:ietf:params:xml:ns:fee-0.3"> S: <fee:fee>5.00</fee:fee> S: </fee:renData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54322-XYZ</svTRID> S: </trID> S: </response> S: </epp>
This extension does not add any elements to the EPP <transfer> command, but does include elements in the response, when the extension has been selected during a <login> command.
When the <transfer> command has been processed successfully, and the client selected the extension when it logged in, and if the "op" attribute of the <transfer> element of the request was "request", the server MAY include in the <extension> section of the EPP response a <fee:trnData> element that contains a <fee:fee> element containing the fee associated with this command. If no <fee:trnData> element is included in the response, then no fee has been assessed by the server for this transaction.
Example <transfer> response:
S: <?xml version="1.0" encoding="UTF-8" standalone="no"?> S: <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> S: <response> S: <result code="1001"> S: <msg>Command completed successfully; action pending</msg> S: </result> S: <resData> S: <domain:trnData S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> S: <domain:name>example.com</domain:name> S: <domain:trStatus>pending</domain:trStatus> S: <domain:reID>ClientX</domain:reID> S: <domain:reDate>2000-06-08T22:00:00.0Z</domain:reDate> S: <domain:acID>ClientY</domain:acID> S: <domain:acDate>2000-06-13T22:00:00.0Z</domain:acDate> S: <domain:exDate>2002-09-08T22:00:00.0Z</domain:exDate> S: </domain:trnData> S: </resData> S: <extension> S: <fee:trnData xmlns:fee="urn:ietf:params:xml:ns:fee-0.3"> S: <fee:fee>5.00</fee:fee> S: </fee:trnData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54322-XYZ</svTRID> S: </trID> S: </response> S: </epp>
This extension does not add any elements to the EPP <update> command, but does include elements in the response, when the extension has been selected during a <login> command.
When the <update> command has been processed successfully, and the client selected the extension when it logged in, the server MAY include in the <extension> section of the EPP response a <fee:updData> element that contains a <fee:fee> element containing any fee associated with this command. If no <fee:updData> element is included in the response, then no fee has been assessed by the server for this transaction.
Example <update> response:
S: <?xml version="1.0" encoding="UTF-8" standalone="no"?> S: <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> S: <response> S: <result code="1000"> S: <msg>Command completed successfully</msg> S: </result> S: <extension> S: <fee:updData xmlns:fee="urn:ietf:params:xml:ns:fee-0.3"> S: <fee:fee>5.00</fee:fee> S: </fee:updData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54321-XYZ</svTRID> S: </trID> S: </response> S: </epp>
An EPP object mapping is specified in XML Schema notation. The formal syntax presented here is a complete schema representation of the object mapping suitable for automated validation of EPP XML instances.
Copyright (c) 2013 IETF Trust and the persons identified as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
BEGIN
<?xml version="1.0" encoding="utf-8"?>
<schema xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:fee="urn:ietf:params:xml:ns:fee-0.3"
xmlns:eppcom="urn:ietf:params:xml:ns:eppcom-1.0"
xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
targetNamespace="urn:ietf:params:xml:ns:fee-0.3"
elementFormDefault="qualified">
<import namespace="urn:ietf:params:xml:ns:eppcom-1.0" />
<import namespace="urn:ietf:params:xml:ns:domain-1.0" />
<annotation>
<documentation>Extensible Provisioning Protocol
v1.0 domain name extension schema for
fee information.</documentation>
</annotation>
<!--
Child elements found in EPP commands and responses
-->
<element name="info" type="fee:infoType" />
<element name="infData" type="fee:infDataType" />
<element name="creData" type="fee:transformDataType" />
<element name="renData" type="fee:transformDataType" />
<element name="trnData" type="fee:transformDataType" />
<element name="updData" type="fee:transformDataType" />
<element name="delData" type="fee:deleteDataType" />
<!--
client <info> command
-->
<complexType name="infoType">
<sequence>
<element name="currency" type="fee:currencyType" />
<element name="action" type="fee:actionType" />
<element name="period" type="domain:periodType" />
</sequence>
</complexType>
<!--
server <info> result
-->
<complexType name="infDataType">
<sequence>
<element name="currency" type="fee:currencyType" />
<element name="action" type="fee:actionType" />
<element name="period" type="domain:periodType" />
<element name="fee" type="fee:feeType" />
</sequence>
</complexType>
<!--
general transform (create, renew, update, transfer) result
-->
<complexType name="transformDataType">
<sequence>
<element name="fee" type="fee:feeType" />
</sequence>
</complexType>
<!--
delete result
-->
<complexType name="deleteDataType">
<sequence>
<element name="credit" type="fee:feeType" />
</sequence>
</complexType>
<!--
common types
-->
<simpleType name="currencyType">
<restriction base="string">
<pattern value="[A-Z]{3}" />
</restriction>
</simpleType>
<complexType name="actionType">
<simpleContent>
<extension base="fee:actionTypeValue">
<attribute name="phase" type="token" />
<attribute name="subphase" type="token" />
</extension>
</simpleContent>
</complexType>
<simpleType name="actionTypeValue">
<restriction base="token">
<minLength value="3"/>
<maxLength value="16"/>
</restriction>
</simpleType>
<simpleType name="feeType">
<restriction base="decimal" />
</simpleType>
</schema>
END
The mapping extensions described in this document do not provide any security services beyond those described by EPP [RFC5730], the EPP domain name mapping [RFC5731], and protocol layers used by EPP. The security considerations described in these other specifications apply to this specification as well.
This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism described in [RFC3688]. Two URI assignments were requested and have been registered by the IANA.
Registration request for the digital signature namespace:
URI: urn:ietf:params:xml:ns:fee-0.3
Registrant Contact: See the "Author's Address" section of this document.
XML: None. Namespace URIs do not represent an XML specification.
Registration request for the EPP fee XML schema:
URI: urn:ietf:params:xml:ns:fee-0.3
Registrant Contact: See the "Author's Address" section of this document.
XML: See the "Formal Syntax" section of this document.
The author wishes to thank James Gould of Verisign, Luis Muñoz of ISC, and Michael Young of Architelos for their feedback and suggestions.
| [RFC2119] | Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. |
| [RFC3688] | Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, January 2004. |
| [RFC3915] | Hollenbeck, S., "Domain Registry Grace Period Mapping for the Extensible Provisioning Protocol (EPP)", RFC 3915, September 2004. |
| [RFC5730] | Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", STD 69, RFC 5730, August 2009. |
| [RFC5731] | Hollenbeck, S., "Extensible Provisioning Protocol (EPP) Domain Name Mapping", STD 69, RFC 5731, August 2009. |
| [ISO4217] | International Organization for Standardization, "ISO 4217:2008, Codes for the representation of currencies and funds", 2008. |
| [draft-tan-epp-launchphase] | Gould, J., Tan, W. and G. Brown, "Launch Phase Mapping for the Extensible Provisioning Protocol (EPP)", 2013. |