Internet Engineering Task Force G. Brown Internet-Draft CentralNic Group plc Intended status: Experimental December 9, 2013 Expires: June 12, 2014 Registry Fee Extension for the Extensible Provisioning Protocol (EPP) draft-brown-epp-fees-01 Abstract This document describes an Extensible Provisioning Protocol (EPP) extension mapping for registry fees. Status of this Memo 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 June 12, 2014. Copyright Notice 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. Brown Expires June 12, 2014 [Page 1] Internet-Draft Registry Fee Extension for EPP December 2013 Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Conventions Used in This Document . . . . . . . . . . . . 3 2. Client Actions . . . . . . . . . . . . . . . . . . . . . . . . 3 3. Currency Codes . . . . . . . . . . . . . . . . . . . . . . . . 4 4. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 4 4.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . . 4 4.1.1. EPP Command . . . . . . . . . . . . . . . . . 4 4.1.2. EPP Command . . . . . . . . . . . . . . . . . . 8 4.1.3. EPP Transfer Query Command . . . . . . . . . . . . . . 11 4.2. EPP Transform Commands . . . . . . . . . . . . . . . . . . 12 4.2.1. EPP Command . . . . . . . . . . . . . . . . . 12 4.2.2. EPP Command . . . . . . . . . . . . . . . . . 14 4.2.3. EPP Command . . . . . . . . . . . . . . . . . 15 4.2.4. EPP Command . . . . . . . . . . . . . . . . 17 4.2.5. EPP Command . . . . . . . . . . . . . . . . . 19 4.3. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . 21 5. Security Considerations . . . . . . . . . . . . . . . . . . . 25 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 25 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 25 8. Change History . . . . . . . . . . . . . . . . . . . . . . . . 26 8.1. Change from 0.1 to 0.2 . . . . . . . . . . . . . . . . . . 26 8.2. Change from 0.2 to 0.3 . . . . . . . . . . . . . . . . . . 26 8.3. Change from 0.3 to 0.4 . . . . . . . . . . . . . . . . . . 26 9. Normative References . . . . . . . . . . . . . . . . . . . . . 27 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 27 Brown Expires June 12, 2014 [Page 2] Internet-Draft Registry Fee Extension for EPP December 2013 1. Introduction Historically, domain name registries have applied a simple fee structure for billable transactions, namely a basic unit price applied to domain , , 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. 1.1. Conventions Used in This Document 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.4". 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.4". 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. 2. Client Actions The element is used in EPP query commands to determine the command to which a fee is applicable. Brown Expires June 12, 2014 [Page 3] Internet-Draft Registry Fee Extension for EPP December 2013 The element values permitted by the server is a matter of repository policy, but MUST include as a minimum the following values: o "create" indicating a command; o "renew" indicating a command; o "transfer" indicating a command; If the server supports the Registry Grace Period Mapping [RFC3915], then the server MUST also support the "restore" value. The element MAY have an OPTIONAL "phase" attribute specifying a launch phase as described in [draft-tan-epp-launchphase]. It may also contain an OPTIONAL "subphase" attribute identifying the custom or sub-phase as described in [draft-tan-epp-launchphase]. 3. Currency Codes The element is used to indicate which currency fees are charged in. This value of this element MUST be a three-character currency code from [ISO4217]. Note that ISO 4217 provides the special "XXX" code, which may be used if the server uses a non-currency based system for assessing fees, such as a system of credits. 4. EPP Command Mapping A detailed description of the EPP syntax and semantics can be found in [RFC5730]. 4.1. EPP Query Commands This extension does not add any elements to the EPP command or response. 4.1.1. EPP Command This extension defines additional elements for the EPP command. The command frame MAY contain an element which MAY contain one or more child elements with the following child elements: Brown Expires June 12, 2014 [Page 4] Internet-Draft Registry Fee Extension for EPP December 2013 o A element that contains a domain name. o A element that contains the currency the fee is charged in. o A element identifying the command. o A element that contains the number of units to be added to the registration period of the domain object. Example command: Brown Expires June 12, 2014 [Page 5] Internet-Draft Registry Fee Extension for EPP December 2013 C: C: C: C: C: C: example.com C: example.net C: example.org C: C: C: C: C: example.com C: USD C: create C: 1 C: C: C: example.net C: EUR C: C: create C: 2 C: C: C: example.org C: EUR C: transfer C: 2 C: C: C: ABC-12345 C: C: When the server receives a command that includes the extension elements described above, its response MUST contain an element, which MUST contain a child element for each element contained in the command. The MUST contain the following child elements: o A element that contains a domain name which matches the name in the corresponding element. Brown Expires June 12, 2014 [Page 6] Internet-Draft Registry Fee Extension for EPP December 2013 o A element that contains same currency code that appeared in the corresponding element. o A element that contains same action that appeared in the corresponding element. This element MAY have the OPTIONAL "phase" and "subphase" elements, which MUST match the same attributes in the corresponding element. o A element that contains same unit that appeared in the corresponding element. o A element that contains the fee associated with the specified transaction. Example response: S: S: S: S: S: Command completed successfully S: S: S: S: S: example.com S: S: S: example.net S: In use S: S: S: example.org S: In use S: S: S: S: S: S: example.com S: USD S: create S: 1 S: 10.00 S: S: S: example.net S: EUR S: S: create S: 2 S: 5.00 S: S: S: example.org S: EUR S: transfer S: 2 S: 2.50 S: S: S: S: ABC-12345 S: 54322-XYZ S: S: S: 4.1.2. EPP Command This extension defines additional elements for the EPP command. The command frame MAY contain an element which contains a element with the following child elements: o A element that contains the currency the fee is charged in. o A element identifying the command. o A element that contains the number of units to be added to the registration period of the domain object. Example command: Brown Expires June 12, 2014 [Page 8] Internet-Draft Registry Fee Extension for EPP December 2013 C: C: C: C: C: C: example.com C: C: C: C: C: USD C: create C: 1 C: C: C: ABC-12345 C: C: When the server receives an command that includes the extension element described above, its response MUST (subject to the exceptions described below) contain an element, which MUST contain a child element. The MUST contain the following child elements: o A element that contains same currency code that appeared in the original element. o A element that contains same action that appeared in the original element. This element MAY have the OPTIONAL "phase" and "subphase" elements, which MUST match the same attributes in the original element. o A element that contains same unit that appeared in the original element. o A element that contains the fee associated with the specified transaction. 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 element and return an error instead. Example response: Brown Expires June 12, 2014 [Page 9] Internet-Draft Registry Fee Extension for EPP December 2013 S: S: S: S: S: Command completed successfully S: S: S: S: example.com S: EXAMPLE1-REP S: S: jd1234 S: sh8013 S: sh8013 S: S: ns1.example.com S: ns1.example.net S: S: ns1.example.com S: ns2.example.com S: ClientX S: ClientY S: 1999-04-03T22:00:00.0Z S: ClientX S: 1999-12-03T09:00:00.0Z S: 2005-04-03T22:00:00.0Z S: 2000-04-08T09:00:00.0Z S: S: 2fooBAR S: S: S: S: S: S: USD S: create S: 1 S: 10.00 S: S: S: S: ABC-12345 S: 54322-XYZ S: S: S: Brown Expires June 12, 2014 [Page 10] Internet-Draft Registry Fee Extension for EPP December 2013 Example response where the domain name is not registered: S: S: S: S: S: Object does not exist. S: S: S: S: USD S: create S: 1 S: 10.00 S: S: S: S: ABC-12345 S: 54322-XYZ S: S: S: 4.1.3. EPP Transfer Query Command This extension does not add any elements to the EPP query command, but does include elements in the response, when the extension has been selected during a command. When the 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 section of the EPP response a element that contains a element containing the fee associated with this command. If no element is included in the response, then no fee has been assessed by the server for this transaction. Example query response: Brown Expires June 12, 2014 [Page 11] Internet-Draft Registry Fee Extension for EPP December 2013 S: S: S: S: S: Command completed successfully; action pending S: S: S: S: example.com S: pending S: ClientX S: 2000-06-08T22:00:00.0Z S: ClientY S: 2000-06-13T22:00:00.0Z S: 2002-09-08T22:00:00.0Z S: S: S: S: S: USD S: 5.00 S: S: S: S: ABC-12345 S: 54322-XYZ S: S: S: 4.2. EPP Transform Commands 4.2.1. EPP Command This extension adds elements to both the EPP command and response, when the extension has been selected during a command. When submitting a command to the server, the client MAY include in the element a element which includes the following child elements: o A element containing the currency of the fee that the command will result in. o A element that contains the fee associated with the command. Brown Expires June 12, 2014 [Page 12] Internet-Draft Registry Fee Extension for EPP December 2013 Depending on server policy, the server MAY choose to accept or refuse the command depending on whether the currency and fee provided by the client agrees with the server's own calculation of the fee. If the server chooses to refuse the command due to an incorrect fee, it MUST respond with a 2004 "Parameter value range error". When the command has been processed successfully, and the client selected the extension when it logged in, the server MAY include in the section of the EPP response a element that contains the following child elements: o A element containing the currency of the fee. o A element that contains the fee. If no element is included in the response, then no fee has been assessed by the server for this transaction. Example command: C: C: C: C: C: C: example.com C: 2 C: C: ns1.example.net C: ns2.example.net C: C: jd1234 C: sh8013 C: sh8013 C: C: 2fooBAR C: C: C: C: C: C: USD C: 5.00 C: C: C: ABC-12345 C: Brown Expires June 12, 2014 [Page 13] Internet-Draft Registry Fee Extension for EPP December 2013 C: Example response: S: S: S: S: S: Command completed successfully S: S: S: S: example.com S: 1999-04-03T22:00:00.0Z S: 2001-04-03T22:00:00.0Z S: S: S: S: S: USD S: 5.00 S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: 4.2.2. EPP Command This extension does not add any elements to the EPP command, but does include elements in the response, when the extension has been selected during the command. When the command has been processed successfully, and the client selected the extension when it logged in, the server MAY include in the section of the EPP response a element that contains the following child elements: o A element containing the currency of the credit. o A element that contains the credit associated with the deletion of the domain. If no element is included in the response, then no Brown Expires June 12, 2014 [Page 14] Internet-Draft Registry Fee Extension for EPP December 2013 credit has been assessed by the server for this transaction. Example response: S: S: S: S: S: Command completed successfully S: S: S: S: USD S: 5.00 S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: 4.2.3. EPP Command This extension adds elements to both the EPP command and response, when the extension has been selected during a command. When submitting a command to the server, the client MAY include in the element a element which includes the following child elements: o A element containing the currency of the fee that the command will result in. o A element that contains the fee associated with the command. Depending on server policy, the server MAY choose to accept or refuse the command depending on whether the currency and fee provided by the client agrees with the server's own calculation of the fee. If the server chooses to refuse the command due to an incorrect fee, it MUST respond with a 2004 "Parameter value range error". When the command has been processed successfully, and the client selected the extension when it logged in, the server MAY include in the section of the EPP response a element that contains the following child elements: o A element containing the currency of the fee. o A element that contains the fee. If no element is included in the response, then no fee has been assessed by the server for this transaction. Example command: C: C: C: C: C: C: example.com C: 2000-04-03 C: 5 C: C: C: C: C: USD C: 5.00 C: C: C: ABC-12345 C: C: Example response: Brown Expires June 12, 2014 [Page 16] Internet-Draft Registry Fee Extension for EPP December 2013 S: S: S: S: S: Command completed successfully S: S: S: S: example.com S: 2005-04-03T22:00:00.0Z S: S: S: S: S: USD S: 5.00 S: S: S: S: ABC-12345 S: 54322-XYZ S: S: S: 4.2.4. EPP Command This extension adds elements to both the EPP command and response, when the value of the "op" attribute of the command element is "request", and the extension has been selected during the command. When submitting a command to the server, the client MAY include in the element a element which includes the following child elements: o A element containing the currency of the fee that the command will result in. o A element that contains the fee associated with the command. Depending on server policy, the server MAY choose to accept or refuse the command depending on whether the currency and fee provided by the client agrees with the server's own calculation of the fee. If the server chooses to refuse the command due to an incorrect fee, it MUST respond with a 2004 "Parameter value range error". Brown Expires June 12, 2014 [Page 17] Internet-Draft Registry Fee Extension for EPP December 2013 When the command has been processed successfully, and the client selected the extension when it logged in, the server MAY include in the section of the EPP response a element that contains the following child elements: o A element containing the currency of the fee. o A element that contains the fee. If no element is included in the response, then no fee has been assessed by the server for this transaction. Example command: C: C: C: C: C: C: example.com C: 1 C: C: 2fooBAR C: C: C: C: C: C: USD C: 5.00 C: C: C: ABC-12345 C: C: Example response: Brown Expires June 12, 2014 [Page 18] Internet-Draft Registry Fee Extension for EPP December 2013 S: S: S: S: S: Command completed successfully; action pending S: S: S: S: example.com S: pending S: ClientX S: 2000-06-08T22:00:00.0Z S: ClientY S: 2000-06-13T22:00:00.0Z S: 2002-09-08T22:00:00.0Z S: S: S: S: S: USD S: 5.00 S: S: S: S: ABC-12345 S: 54322-XYZ S: S: S: 4.2.5. EPP Command This extension adds elements to both the EPP command and response, when the extension has been selected during a has been selected during the command. When submitting a command to the server, the client MAY include in the element a element which includes the following child elements: o A element containing the currency of the fee that the command will result in. o A element that contains the fee associated with the command. Depending on server policy, the server MAY choose to accept or refuse Brown Expires June 12, 2014 [Page 19] Internet-Draft Registry Fee Extension for EPP December 2013 the command depending on whether the currency and fee provided by the client agrees with the server's own calculation of the fee. If the server chooses to refuse the command due to an incorrect fee, it MUST respond with a 2004 "Parameter value range error". When the command has been processed successfully, and the client selected the extension when it logged in, the server MAY include in the section of the EPP response a element that contains the following child elements: o A element containing the currency of the fee. o A element that contains the fee. If no element is included in the response, then no fee has been assessed by the server for this transaction. Example command: C: C: C: C: C: C: example.com C: C: sh8013 C: C: C: C: C: C: USD C: 5.00 C: C: C: ABC-12345 C: C: Example response: Brown Expires June 12, 2014 [Page 20] Internet-Draft Registry Fee Extension for EPP December 2013 S: S: S: S: S: Command completed successfully S: S: S: S: USD S: 5.00 S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: 4.3. Formal Syntax 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: o Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. o Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. o Neither the name of Internet Society, IETF or IETF Trust, nor the names of specific contributors, may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT Brown Expires June 12, 2014 [Page 21] Internet-Draft Registry Fee Extension for EPP December 2013 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 Extensible Provisioning Protocol v1.0 domain name extension schema for fee information. Brown Expires June 12, 2014 [Page 22] Internet-Draft Registry Fee Extension for EPP December 2013 Brown Expires June 12, 2014 [Page 23] Internet-Draft Registry Fee Extension for EPP December 2013 Brown Expires June 12, 2014 [Page 24] Internet-Draft Registry Fee Extension for EPP December 2013 END 5. Security Considerations 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. 6. IANA Considerations 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.4 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.4 Registrant Contact: See the "Author's Address" section of this document. XML: See the "Formal Syntax" section of this document. 7. Acknowledgements The author wishes to thank the following persons for their feedback Brown Expires June 12, 2014 [Page 25] Internet-Draft Registry Fee Extension for EPP December 2013 and suggestions: o James Gould of Verisign o Luis Munoz of ISC o Michael Young of Architelos o Ben Levac and Jeff Eckhaus of Demand Media 8. Change History 8.1. Change from 0.1 to 0.2 1. Added note about the use of the "XXX" code for non-currency transactions. 2. Added phase attribute to the element, and normative reference to [draft-tan-epp-launchphase]. 3. Added description of extension to transform and transfer query commands. 4. Added Acknowledgements and Change History sections. 8.2. Change from 0.2 to 0.3 1. Added the subphase attribute to the element. 2. Removed the enumeration for the element so any token may be used. 3. Moved the fee lookup command from to . 4. Added an extension to the command to return credit information. 5. Changed MUSTs to MAYs so that the response extension elements can be omitted where no fee is applicable. 6. Update of introductory text. 8.3. Change from 0.3 to 0.4 1. Restore the command extension; either or can be used. Brown Expires June 12, 2014 [Page 26] Internet-Draft Registry Fee Extension for EPP December 2013 2. added extension elements for , , and so that the server can reject the command if the fee is incorrect. 9. Normative References [ISO4217] International Organization for Standardization, "ISO 4217: 2008, Codes for the representation of currencies and funds", 2008. [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. [draft-tan-epp-launchphase] Gould, J., Tan, W., and G. Brown, "Launch Phase Mapping for the Extensible Provisioning Protocol (EPP)", 2013. Author's Address Gavin Brown CentralNic Group plc 35-39 Moorgate London, England EC2R 6AR GB Phone: +44 20 33 88 0600 Email: gavin.brown@centralnic.com URI: https://www.centralnic.com Brown Expires June 12, 2014 [Page 27]