--- 1/draft-ietf-regext-allocation-token-09.txt 2018-08-21 14:19:11.891636522 -0700 +++ 2/draft-ietf-regext-allocation-token-10.txt 2018-08-21 14:19:11.939637690 -0700 @@ -1,20 +1,20 @@ Network Working Group J. Gould Internet-Draft VeriSign, Inc. Intended status: Standards Track K. Feher -Expires: February 4, 2019 Neustar - August 3, 2018 +Expires: February 22, 2019 Neustar + August 21, 2018 Allocation Token Extension for the Extensible Provisioning Protocol (EPP) - draft-ietf-regext-allocation-token-09 + draft-ietf-regext-allocation-token-10 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. @@ -26,21 +26,21 @@ 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 February 4, 2019. + This Internet-Draft will expire on February 22, 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 @@ -49,130 +49,151 @@ 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. 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. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 5 + 3.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 5 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 - 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 15 - 5.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 15 - 5.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 15 - 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 + 3.1.2. EPP Command . . . . . . . . . . . . . . . . . 9 + 3.1.3. EPP Query Command . . . . . . . . . . . . 11 + 3.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 12 + 3.2.1. EPP Command . . . . . . . . . . . . . . . . 12 + 3.2.2. EPP Command . . . . . . . . . . . . . . . . 13 + 3.2.3. EPP Command . . . . . . . . . . . . . . . . . 13 + 3.2.4. EPP Command . . . . . . . . . . . . . . . 13 + 3.2.5. EPP Command . . . . . . . . . . . . . . . . 14 + 4. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 15 + 4.1. Allocation Token Extension Schema . . . . . . . . . . . . 15 + 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 16 + 5.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 16 + 5.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 16 + 6. Implementation Status . . . . . . . . . . . . . . . . . . . . 16 + 6.1. Verisign EPP SDK . . . . . . . . . . . . . . . . . . . . 17 + 6.2. Neustar EPP SDK . . . . . . . . . . . . . . . . . . . . . 17 + 6.3. Neustar gTLD SRS . . . . . . . . . . . . . . . . . . . . 18 + 6.4. Net::DRI . . . . . . . . . . . . . . . . . . . . . . . . 18 + 7. Security Considerations . . . . . . . . . . . . . . . . . . . 19 + 8. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 19 + 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 19 + 9.1. Normative References . . . . . . . . . . . . . . . . . . 19 + 9.2. Informative References . . . . . . . . . . . . . . . . . 20 + Appendix A. Change History . . . . . . . . . . . . . . . . . . . 20 + A.1. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 20 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 . . . . . . . . . . . 21 - A.12. Change from REGEXT 06 to REGEXT 07 . . . . . . . . . . . 22 - A.13. Change from REGEXT 07 to REGEXT 08 . . . . . . . . . . . 22 - A.14. Change from REGEXT 08 to REGEXT 09 . . . . . . . . . . . 23 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 23 + A.3. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 21 + A.4. Change from 03 to 04 . . . . . . . . . . . . . . . . . . 21 + A.5. Change from 04 to REGEXT 00 . . . . . . . . . . . . . . . 21 + A.6. Change from REGEXT 00 to REGEXT 01 . . . . . . . . . . . 21 + A.7. Change from REGEXT 01 to REGEXT 02 . . . . . . . . . . . 21 + A.8. Change from REGEXT 02 to REGEXT 03 . . . . . . . . . . . 21 + A.9. Change from REGEXT 03 to REGEXT 04 . . . . . . . . . . . 21 + A.10. Change from REGEXT 04 to REGEXT 05 . . . . . . . . . . . 21 + A.11. Change from REGEXT 05 to REGEXT 06 . . . . . . . . . . . 22 + A.12. Change from REGEXT 06 to REGEXT 07 . . . . . . . . . . . 23 + A.13. Change from REGEXT 07 to REGEXT 08 . . . . . . . . . . . 23 + A.14. Change from REGEXT 08 to REGEXT 09 . . . . . . . . . . . 24 + A.15. Change from REGEXT 09 to REGEXT 10 . . . . . . . . . . . 24 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 25 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. Allocation is when a server assigns the sponsoring client of an object based on the use of an Allocation Token credential. Examples include allocating a registration based on a pre-eligibility Allocation Token, allocating a premium domain name registration based on an auction Allocation Token, allocating a registration based on a founders Allocation Token, and allocating an existing domain name held by the server or by a different sponsoring client based on an Allocation Token passed with a transfer command. - 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. + Clients pass an Allocation Token to the server for validation, and + the server determines if the supplied Allocation Token is one + supported by the server. 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", "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 + 14 [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. + white space in the examples are provided only to illustrate element + relationships and are not REQUIRED in the protocol. 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. + The "abc123" token value is used as a placeholder value in the + examples. The server MUST support token values that follow the + Security Considerations (Section 7) section. + + The domain object attribute values, including the "2fooBAR" + value, in the examples are provided for illustration + purposes only. Refer to [RFC5731] for details on the domain object + attributes. + 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 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 + supported EPP commands as well as the info response. If the supplied Allocation Token passed to the server does not apply to the object, the server MUST return an EPP error result code of 2201. + Authorization information, like what is defined in the EPP domain + name mapping [RFC5731], is associated with objects to facilitate + transfer operations. The authorization information is assigned when + an object is created. The Allocation Token and the authorization + information are both credentials, but used for different purposes and + used in different ways. The Allocation Token is used to facilitate + the allocation of an object instead of transferring the sponsorship + of the object. The Allocation Token is not managed by the client, + but is validated by the server to authorize assigning the initial + sponsoring client of the object. + An example element with value of "abc123": abc123 3. EPP Command Mapping @@ -228,20 +249,23 @@ 1. If an object requires an Allocation Token and the Allocation Token does apply to the object, then the server MUST return the availability status as available (e.g., "avail" attribute is "1" or "true"). 2. If an object requires an Allocation Token and the Allocation Token does not apply to the object or an object does not require an Allocation Token, then the server SHOULD return the availability status as unavailable (e.g., "avail" attribute is "0" or "false"). + 3. If an object does not require an Allocation Token, the server MAY + return the availability status as available (e.g., "avail" + attribute is "1" or "true"). Example domain response for a command using the extension: S: S: S: S: S: Command completed successfully S: @@ -318,29 +342,32 @@ described in the [RFC5730]. 3.1.2. EPP Command This extension defines additional elements to extend the EPP command of an object mapping like [RFC5731]. 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. - The auhorization is subject to server policy. + information by supplying the element in the + command. 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. The authorization is subject to + server policy. Example command with the allocationToken:info extension for the allocation.example domain name: C: C: C: C: C: C: C: C: ABC-12345 C: C: If the query was successful, the server replies with an - element, as described in - Section 2.1. + element along with the regular EPP + . The element is + described in Section 2.1. Example domain response using the extension: S: S: S: S: S: Command completed successfully S: @@ -530,44 +558,44 @@ The formal syntax presented here is a complete schema representation of the object mapping suitable for automated validation of EPP XML instances. The BEGIN and END tags are not part of the schema; they are used to note the beginning and ending of the schema for URI registration purposes. 4.1. Allocation Token Extension Schema BEGIN - - + targetNamespace="urn:ietf:params:xml:ns:allocationToken-1.0" + elementFormDefault="qualified"> Extensible Provisioning Protocol v1.0 - Allocation - Token Extension. + Allocation Token Extension - + + + + + + + - - END @@ -573,27 +601,27 @@ 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]. Registration request for the allocationToken namespace: - URI: ietf:params:xml:ns:allocationToken-1.0 + URI: urn: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:schema:allocationToken-1.0 + URI: urn: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)" @@ -714,47 +742,50 @@ 7. Security Considerations The mapping described in this document does not provide any security services beyond those described by EPP [RFC5730] and protocol layers used by EPP. The security considerations described in these other specifications apply to this specification as well. The mapping acts as a conduit for the passing of Allocation Tokens between a client and a server. The definition of the Allocation - Token is defined outside of this mapping. The following are security - considerations in the definition and use of an Allocation Token: + Token SHOULD be defined outside of this mapping. The following are + security considerations in the definition and use of an Allocation + Token: 1. An Allocation Token should be considered secret information by - the client and should be protected at rest and in transit. + the client and SHOULD be protected at rest and MUST be protected + in transit. 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 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, - Patrick Mevzek, and Adam Roach. + were provided by Scott Hollenbeck, Benjamin Kaduk, Mirja Kuehlewind, + Rubens Kuhl, Alexander Mayrhofer, Patrick Mevzek, Eric Rescoria, 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, . @@ -783,24 +814,20 @@ . [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 @@ -963,41 +990,92 @@ 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]". + "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 +A.15. Change from REGEXT 09 to REGEXT 10 + 1. Changed "auhorization" to "authorization" in the "EPP + Command" section. + 2. Added 'If an object does not require an Allocation Token, the + server MAY return the availability status as available (e.g., + "avail" attribute is "1" or "true").' to the check response + cases, based on feedback by Mirja Kuehlewind. + 3. Changed the definition of the element in the XML schema to + only allow an empty element, based on IANA's expert review. + + 4. Added normative language to the storage and transport of the + Allocation Token, in the "Security Considerations" section, based + on feedback from Eric Rescoria. + 5. Changed "The definition of the Allocation Token is defined + outside of this mapping" to "The definition of the Allocation + Token SHOULD be defined outside of this mapping", in the + "Security Considerations" section, based on feedback from Eric + Rescoria. + 6. Added the missing "urn:" prefix with the IANA URI registrations. + 7. The URL for the BCP 14 was removed based on feedback from Alissa + Cooper. + 8. Updates based on review by Benjamin Kaduk, that include: + + 1. Added the second paragraph to the "Allocation Token" section + to describe the difference (motivation) of using the + Allocation Token versus the EPP RFC authorization mechanism. + 2. Added a paragraph to the "Conventions Used in This Document" + section for the use of the "abc123" token value and the use + of domain object "2fooBAR" password value in the examples. + 3. Changed the "A client MUST pass an Allocation Token known to + the server to be authorized to use one of the supported EPP + transform commands." sentence in the "Introduction" section + to "Clients pass an Allocation Token to the server for + validation, and the server determines if the supplied + Allocation Token is one supported by the server." + 4. Changed the "Indentation and white space in the examples are + provided only to illustrate element relationships and are not + REQUIRED in the protocol." sentence in the "Conventions Used + in This Document" section to "Indentation and white space in + the examples are provided only to illustrate element + relationships and are not REQUIRED in the protocol." + 5. Changed the "Authorized clients MAY retrieve..." sentence in + the "EPP Command" section. + 6. Changed the "If the query was successful..." sentence in the + "EPP Command" section. + 7. Added "supplied" to the "If the supplied Allocation Token + passed..." sentence in the "Allocation Token" section. + 8. Removed an extra newline in the element in the + "Allocation Token Extension Schema" section. + +Authors' Addresses James Gould VeriSign, Inc. 12061 Bluemont Way Reston, VA 20190 US Email: jgould@verisign.com URI: http://www.verisigninc.com + Kal Feher Neustar lvl 8/10 Queens Road Melbourne, VIC 3004 AU Email: ietf@feherfamily.org URI: http://www.neustar.biz