--- 1/draft-ietf-regext-allocation-token-08.txt 2018-08-03 06:13:21.678832733 -0700 +++ 2/draft-ietf-regext-allocation-token-09.txt 2018-08-03 06:13:21.722833789 -0700 @@ -1,46 +1,46 @@ Network Working Group J. Gould Internet-Draft VeriSign, Inc. Intended status: Standards Track K. Feher -Expires: November 17, 2018 Neustar - May 16, 2018 +Expires: February 4, 2019 Neustar + August 3, 2018 Allocation Token Extension for the Extensible Provisioning Protocol (EPP) - draft-ietf-regext-allocation-token-08 + draft-ietf-regext-allocation-token-09 Abstract This document describes an Extensible Provisioning Protocol (EPP) - extension for including an Allocation Token in query and transform - commands. The Allocation Token is used as a credential that - authorizes a client to request the allocation of a specific object - from the server, using one of the EPP transform commands including - create and transfer. + extension for including an Allocation Token in "query" and + "transform" commands. The Allocation Token is used as a credential + that authorizes a client to request the allocation of a specific + object from the server, using one of the EPP transform commands + including create and transfer. 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 November 17, 2018. + This Internet-Draft will expire on February 4, 2019. Copyright Notice Copyright (c) 2018 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 @@ -51,21 +51,21 @@ described in the Simplified BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Conventions Used in This Document . . . . . . . . . . . . 3 2. Object Attributes . . . . . . . . . . . . . . . . . . . . . . 4 2.1. Allocation Token . . . . . . . . . . . . . . . . . . . . 4 3. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 4 3.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 4 - 3.1.1. EPP Command . . . . . . . . . . . . . . . . . 4 + 3.1.1. EPP Command . . . . . . . . . . . . . . . . . 5 3.1.2. EPP Command . . . . . . . . . . . . . . . . . 8 3.1.3. EPP Query Command . . . . . . . . . . . . 10 3.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 11 3.2.1. EPP Command . . . . . . . . . . . . . . . . 11 3.2.2. EPP Command . . . . . . . . . . . . . . . . 12 3.2.3. EPP Command . . . . . . . . . . . . . . . . . 12 3.2.4. EPP Command . . . . . . . . . . . . . . . 12 3.2.5. EPP Command . . . . . . . . . . . . . . . . 13 4. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 14 4.1. Allocation Token Extension Schema . . . . . . . . . . . . 14 @@ -75,35 +75,37 @@ 6. Implementation Status . . . . . . . . . . . . . . . . . . . . 15 6.1. Verisign EPP SDK . . . . . . . . . . . . . . . . . . . . 16 6.2. Neustar EPP SDK . . . . . . . . . . . . . . . . . . . . . 16 6.3. Neustar gTLD SRS . . . . . . . . . . . . . . . . . . . . 17 6.4. Net::DRI . . . . . . . . . . . . . . . . . . . . . . . . 17 7. Security Considerations . . . . . . . . . . . . . . . . . . . 18 8. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 18 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 18 9.1. Normative References . . . . . . . . . . . . . . . . . . 18 9.2. Informative References . . . . . . . . . . . . . . . . . 19 + 9.3. URIs . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Appendix A. Change History . . . . . . . . . . . . . . . . . . . 19 A.1. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 19 - A.2. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 19 - A.3. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 19 - A.4. Change from 03 to 04 . . . . . . . . . . . . . . . . . . 19 + A.2. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 20 + A.3. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 20 + A.4. Change from 03 to 04 . . . . . . . . . . . . . . . . . . 20 A.5. Change from 04 to REGEXT 00 . . . . . . . . . . . . . . . 20 A.6. Change from REGEXT 00 to REGEXT 01 . . . . . . . . . . . 20 A.7. Change from REGEXT 01 to REGEXT 02 . . . . . . . . . . . 20 A.8. Change from REGEXT 02 to REGEXT 03 . . . . . . . . . . . 20 A.9. Change from REGEXT 03 to REGEXT 04 . . . . . . . . . . . 20 A.10. Change from REGEXT 04 to REGEXT 05 . . . . . . . . . . . 20 - A.11. Change from REGEXT 05 to REGEXT 06 . . . . . . . . . . . 20 + A.11. Change from REGEXT 05 to REGEXT 06 . . . . . . . . . . . 21 A.12. Change from REGEXT 06 to REGEXT 07 . . . . . . . . . . . 22 A.13. Change from REGEXT 07 to REGEXT 08 . . . . . . . . . . . 22 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 22 + A.14. Change from REGEXT 08 to REGEXT 09 . . . . . . . . . . . 23 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 23 1. Introduction This document describes an extension mapping for version 1.0 of the Extensible Provisioning Protocol (EPP) [RFC5730]. This mapping, an extension to EPP object mappings like the EPP domain name mapping [RFC5731], supports passing an Allocation Token as a credential that authorizes a client to request the allocation of a specific object from the server, using one of the EPP transform commands including create and transfer. @@ -120,49 +122,50 @@ A client MUST pass an Allocation Token known to the server to be authorized to use one of the supported EPP transform commands. It is up to server policy which EPP transform commands and which objects require the Allocation Token. The Allocation Token MAY be returned to an authorized client for passing out-of-band to a client that uses it with an EPP transform command. 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]. + "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and + "OPTIONAL" in this document are to be interpreted as described in BCP + 14 [1] [RFC2119] [RFC8174] when, and only when, they appear in all + capitals, as shown here. 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. In examples, "C:" represents lines sent by a protocol client and "S:" represents lines returned by a protocol server. Indentation and white space in examples are provided only to illustrate element relationships and are not a REQUIRED feature of this protocol. - "allocationToken-1.0" is used as an abbreviation for - "urn:ietf:params:xml:ns:allocationToken-1.0". The XML namespace - prefix "allocationToken" 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 "allocationToken" is used for the namespace + "urn:ietf:params:xml:ns:allocationToken-1.0", 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. 2. Object Attributes This extension adds additional elements to EPP object mappings like the EPP domain name mapping [RFC5731]. Only those new elements are described here. 2.1. Allocation Token The Allocation Token is a simple XML "token" type. The exact format - of the Allocation Token is up to server policy. The server MUST have + of the Allocation Token is up to server policy. The server MAY have the Allocation Token for each object to match against the Allocation Token passed by the client to authorize the allocation of the object. The element is used for all of the supported EPP commands as well as the info response. If the Allocation Token passed to the server does not apply to the object, the server MUST return an EPP error result code of 2201. An example element with value of "abc123": @@ -181,37 +184,37 @@ EPP provides three commands to retrieve object information: to determine if an object can be provisioned, to retrieve information associated with an object, and to retrieve object transfer status information. 3.1.1. EPP Command This extension defines additional elements to extend the EPP command of an object mapping like [RFC5731]. - This extension allow clients to check the availability of an object + This extension allows clients to check the availability of an object with an Allocation Token, as described in Section 2.1. Clients can check if an object can be created using the Allocation Token. The Allocation Token is applied to all object names included in the EPP command. - Example command for the example.tld domain name using the - extension with the allocation token - of 'abc123': + Example command for the allocation.example domain name using + the extension with the allocation + token of 'abc123': C: C: C: C: C: - C: example.tld + C: allocation.example C: C: C: C: C: abc123 C: C: C: ABC-12345 @@ -239,44 +242,44 @@ S: S: S: S: S: Command completed successfully S: S: S: S: - S: example.tld + S: allocation.example S: Allocation Token mismatch S: S: S: S: S: ABC-DEF-12345 S: 54321-XYZ S: S: S: Example command with the - extension for the example.tld and example2.tld domain names. - Availability of example.tld and example2.tld domain names are based - on the Allocation Token 'abc123': + extension for the allocation.example and allocation2.example domain + names. Availability of allocation.example and allocation2.example + domain names are based on the Allocation Token 'abc123': C: C: C: C: C: - C: example.tld - C: example2.tld + C: allocation.example + C: allocation2.example C: C: C: C: C: abc123 C: C: C: ABC-DEF-12345 @@ -289,25 +292,25 @@ S: S: S: S: S: Command completed successfully S: S: S: S: - S: example.tld + S: allocation.example S: Allocation Token mismatch S: S: - S: example2.tld + S: allocation2.example S: S: S: S: S: ABC-DEF-12345 S: 54321-XYZ S: S: S: @@ -322,36 +325,35 @@ The EPP command allows a client to request information associated with an existing object. Authorized clients MAY retrieve the Allocation Token (Section 2.1) along with the other object information using the element. The element is an empty element that serves as a marker to the server to return the element in the info response. If the client is not authorized to receive the Allocation Token, the server MUST return an EPP error result code of 2201. If the client is authorized to receive the Allocation Token, but there is no Allocation Token associated with - the object, the server MUST return an EPP error result code of 2303 - object referencing the element. The - auhorization is subject to server policy. + the object, the server MUST return an EPP error result code of 2303. + The auhorization is subject to server policy. Example command with the allocationToken:info extension for - the example.tld domain name: + the allocation.example domain name: C: C: C: C: C: - C: example.tld + C: allocation.example C: C: C: C: C: C: ABC-12345 C: C: @@ -365,21 +367,21 @@ S: S: S: S: S: Command completed successfully S: S: S: - S: example.tld + S: allocation.example S: EXAMPLE1-REP S: S: jd1234 S: sh8013 S: sh8013 S: ClientX S: ClientY S: 2012-04-03T22:00:00.0Z S: S: 2fooBAR @@ -396,21 +398,21 @@ S: S: ABC-12345 S: 54321-XYZ S: S: S: 3.1.3. EPP Query Command This extension does not add any elements to the EPP query - command or query response described in the [RFC5730]. + command or query response described in [RFC5730]. 3.2. EPP Transform Commands EPP provides five commands to transform objects: to create an instance of an object, to delete an instance of an object, to extend the validity period of an object, to manage object sponsorship changes, and to change information associated with an object. 3.2.1. EPP Command @@ -428,21 +430,21 @@ Example command to create a domain object with an Allocation Token: C: C: C: C: C: - C: example.tld + C: allocation.example C: jd1234 C: sh8013 C: sh8013 C: C: 2fooBAR C: C: C: C: C: request command of an object mapping like [RFC5731]. The EPP request command provides a transform operation that allows a client to request the transfer of an object. In addition to the EPP command elements described in an object mapping like [RFC5731], the command MUST contain a child element for the client to be authorized to transfer and allocate the object. The authorization associated with the Allocation Token is in addition to and does not replace the authorization mechanism defined for the object's - request command. If the Allocation Token does not apply - to the object, the server MUST return an EPP error result code of - 2201. + request command. If the Allocation Token is invalid or + not required for the object, the server MUST return an EPP error + result code of 2201. Example request command to allocate the domain object with the Allocation Token: C: C: C: C: C: @@ -567,32 +569,31 @@ END 5. IANA Considerations 5.1. XML Namespace This document uses URNs to describe XML namespaces and XML schemas - conforming to a registry mechanism described in [RFC3688]. The - following URI assignment is requested of IANA: + conforming to a registry mechanism described in [RFC3688]. Registration request for the allocationToken namespace: URI: ietf:params:xml:ns:allocationToken-1.0 Registrant Contact: IESG XML: None. Namespace URIs do not represent an XML specification. Registration request for the allocationToken XML schema: - URI: ietf:params:xml:ns:allocationToken-1.0 + URI: ietf:params:xml:schema:allocationToken-1.0 Registrant Contact: IESG XML: See the "Formal Syntax" section of this document. 5.2. EPP Extension Registry The following registration of the EPP Extension Registry, described in [RFC7451], is requested: Name of Extension: "Allocation Token Extension for the Extensible Provisioning Protocol (EPP)" @@ -727,32 +729,32 @@ 2. An Allocation Token should be single use, meaning it should be unique per object and per allocation operation. 3. An Allocation Token should have a limited life with some form of expiry in the Allocation Token if generated by a trusted 3rd third party, or with a server-side expiry if generated by the server. 4. An Allocation Token should use a strong random value if it is based on an unsigned code. 5. An Allocation Token should leverage digital signatures to confirm its authenticity if generated by a trusted 3rd party. - 6. An Allocation Token should is signed XML should be encoded (e.g., - base64) to mitigate server validation issues. + 6. An Allocation Token that is signed XML should be encoded (e.g., + base64 [RFC4648]) to mitigate server validation issues. 8. Acknowledgements The authors wish to acknowledge the original concept for this draft and the efforts in the initial versions of this draft by Trung Tran and Sharon Wodjenski. Special suggestions that have been incorporated into this document were provided by Scott Hollenbeck, Rubens Kuhl, Alexander Mayrhofer, - and Patrick Mevzek. + Patrick Mevzek, and Adam Roach. 9. References 9.1. Normative References [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . @@ -769,24 +771,36 @@ DOI 10.17487/RFC5731, August 2009, . [RFC7942] Sheffer, Y. and A. Farrel, "Improving Awareness of Running Code: The Implementation Status Section", BCP 205, RFC 7942, DOI 10.17487/RFC7942, July 2016, . 9.2. Informative References + [RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data + Encodings", RFC 4648, DOI 10.17487/RFC4648, October 2006, + . + [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, February 2015, . + [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC + 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, + May 2017, . + +9.3. URIs + + [1] https://tools.ietf.org/html/bcp14 + Appendix A. Change History A.1. Change from 00 to 01 1. Amended XML Namespace section of IANA Considerations, added EPP Extension Registry section. 2. Moved Change History to the back section as an Appendix. A.2. Change from 01 to 02 @@ -925,20 +939,57 @@ 1. Updated obsoleted RFC 7942 to RFC 7942. 2. Moved RFC 7451 to an informational reference. A.13. Change from REGEXT 07 to REGEXT 08 1. Changed Kal Feher's contact e-mail address. 2. Changed Neustar's Implementation Status contact e-mail address. 3. Added the Net::DRI sub-section to the Implementation Status section. +A.14. Change from REGEXT 08 to REGEXT 09 + + 1. Updates based on the AD review by Adam Roach, that include: + + 1. In "Abstract", set "query" and "transform" off in some way + (e.g., using quotation marks) + 2. In "Conventions Used in This Document", please update to use + the boilerplate from RFC 8174. + 3. Remove "allocationToken-1.0" is used as an abbreviation for + "urn:ietf:params:xml:ns:allocationToken-1.0". + 4. In "Allocation Token", change "The server MUST have the + Allocation Token" to "The server MAY have the Allocation + Token". + 5. In "EPP Command", change "This extension allow + clients" to "This extension allows clients". + 6. Use domains reserved by RFC 2026 for the examples. The + example domain "example.tld" was changed to + "allocation.example" and the example domain "example2.tld" + was changed to "allocation2.example". + 7. In "EPP Command", change "...the server MUST return + an EPP error result code of 2303 object referencing the + element." to "...the server MUST + return an EPP error result code of 2303." + 8. In "EPP Query Command", remove "the" before + "[RFC5730]". + 9. In "EPP Command", change "If the Allocation Token + does not apply to the object..." to "If the Allocation Token + is invalid or not required for the object...". + 10. In "XML Namespace", remove the sentence "The following URI + assignment is requested of IANA:" + 11. In "Security Considerations", change "An Allocation Token + should is" to "An Allocation Token that is". Also + informatively cite RFC 4648 for the base64 reference. + 2. Change "ietf:params:xml:ns:allocationToken-1.0" to + "ietf:params:xml:schema:allocationToken-1.0" for the XML schema + IANA registration. + Authors' Addresses James Gould VeriSign, Inc. 12061 Bluemont Way Reston, VA 20190 US Email: jgould@verisign.com URI: http://www.verisigninc.com