--- 1/draft-ietf-regext-allocation-token-05.txt 2018-01-29 12:13:15.337761622 -0800 +++ 2/draft-ietf-regext-allocation-token-06.txt 2018-01-29 12:13:15.377762576 -0800 @@ -1,117 +1,130 @@ Network Working Group J. Gould Internet-Draft VeriSign, Inc. Intended status: Standards Track K. Feher -Expires: July 6, 2018 Neustar - January 2, 2018 +Expires: August 2, 2018 Neustar + January 29, 2018 Allocation Token Extension for the Extensible Provisioning Protocol (EPP) - draft-ietf-regext-allocation-token-05 + draft-ietf-regext-allocation-token-06 Abstract This document describes an Extensible Provisioning Protocol (EPP) - extension for including an allocation token or for allocating an - object like a domain name to the client. The allocation token MAY be - transferred out-of-band to a client to give them authorization to - allocate an object using one of the EPP transform commands including - create, update, 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 July 6, 2018. + This Internet-Draft will expire on August 2, 2018. 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 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. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Conventions Used in This Document . . . . . . . . . . . . 3 - 2. Object Attributes . . . . . . . . . . . . . . . . . . . . . . 3 - 2.1. Allocation Token . . . . . . . . . . . . . . . . . . . . 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.2. EPP Command . . . . . . . . . . . . . . . . . 8 - 3.1.3. EPP Command . . . . . . . . . . . . . . . 10 + 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 . . . . . . . . . . . . 15 + 4.1. Allocation Token Extension Schema . . . . . . . . . . . . 14 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 15 5.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 15 - 5.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 16 - 6. Implementation Status . . . . . . . . . . . . . . . . . . . . 16 - 6.1. Verisign EPP SDK . . . . . . . . . . . . . . . . . . . . 17 - 6.2. Neustar EPP SDK . . . . . . . . . . . . . . . . . . . . . 17 + 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 - 7. Security Considerations . . . . . . . . . . . . . . . . . . . 18 + 7. Security Considerations . . . . . . . . . . . . . . . . . . . 17 8. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 18 9. Normative References . . . . . . . . . . . . . . . . . . . . 18 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.5. Change from 04 to REGEXT 00 . . . . . . . . . . . . . . . 19 A.6. Change from REGEXT 00 to REGEXT 01 . . . . . . . . . . . 19 - 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.7. Change from REGEXT 01 to REGEXT 02 . . . . . . . . . . . 19 + A.8. Change from REGEXT 02 to REGEXT 03 . . . . . . . . . . . 19 + A.9. Change from REGEXT 03 to REGEXT 04 . . . . . . . . . . . 19 A.10. Change from REGEXT 04 to REGEXT 05 . . . . . . . . . . . 20 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 20 + A.11. Change from REGEXT 05 to REGEXT 06 . . . . . . . . . . . 20 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 22 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], for passing an allocation token to one of the EPP - transform commands including create, update, and transfer. 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 support 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. + [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. 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 @@ -131,57 +144,56 @@ 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 - the allocation token for each object to match against the allocation - token passed by the client to authorize the allocation of the object. - - The same element is used for all of - the supported EPP transform commands as well as the info response. - If an invalid allocation token is passed the server MUST return an - EPP error result code of 2201. + 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": abc123 3. EPP Command Mapping A detailed description of the EPP syntax and semantics can be found in the EPP core protocol specification [RFC5730]. 3.1. EPP Query Commands EPP provides three commands to retrieve object information: - to determine if an object is known to the server, to retrieve - detailed information associated with an object, and to - retrieve object transfer status 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 - 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 + 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': C: C: C: C: @@ -194,51 +206,63 @@ C: C: abc123 C: C: C: ABC-12345 C: C: - If the query was successful, the server replies with an - response providing availability status of queried object. + If the query was successful, the server replies with a + response providing the availability status of the queried object + based on the following Allocation Token cases, where the object is + otherwise available: + + 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"). Example domain response for a command using the extension: S: S: S: S: S: Command completed successfully S: S: S: S: S: example.tld - S: Invalid domain-token pair + 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': + on the Allocation Token 'abc123': C: C: C: C: C: C: example.tld C: example2.tld C: @@ -261,21 +285,21 @@ S: S: S: S: Command completed successfully S: S: S: S: S: example.tld - S: Invalid domain-token pair + S: Allocation Token mismatch S: S: S: example2.tld S: S: S: S: S: ABC-DEF-12345 S: 54321-XYZ S: @@ -283,34 +307,33 @@ S: This extension does not add any elements to the EPP response 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 on an - existing object. Authorized clients MAY retrieve the allocation - token (Section 2.1) along with the other object information using the - element that identifies the extension - namespace. The element is an empty element - that serves as a marker to the server to return the - element, defined in Section 2.1, in - the info response. If the client is not authorized to receive the - allocation token (Section 2.1), the server MUST return an EPP error + 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 (Section 2.1), but there is no allocation token - (Section 2.1) associated with the object, the server MUST return an - EPP error result code of 2303 object referencing the - element. + 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. Example command with the allocationToken:info extension for the example.tld domain name: C: C: C: C: C: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: -3.1.3. EPP Command +3.1.3. EPP Query Command This extension does not add any elements to the EPP query - command or response described in the [RFC5730]. + command or query response described in the [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 This extension defines additional elements to extend the EPP command of an object mapping like [RFC5731]. The EPP command provides a transform operation that allows a - client to create an object. In addition to the EPP command elements - described in an object mapping like [RFC5731], the command MUST - contain a child element, as defined - in Section 2.1, that identifies the extension namespace for the - client to be authorized to create and allocate the object. If the - allocation token (Section 2.1) does not match the object's allocation - token (Section 2.1), the server MUST return an EPP error result code - of 2201.: + client to create an instance 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 create and allocate the + object. If the Allocation Token does not apply to the object, the + server MUST return an EPP error result code of 2201. - Example command to create a domain object with an allocation - token: + Example command to create a domain object with an Allocation + Token: C: C: C: C: C: C: example.tld C: jd1234 C: sh8013 @@ -444,29 +465,30 @@ 3.2.4. EPP Command This extension defines additional elements to extend the EPP 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, as defined in Section 2.1, - that identifies the extension namespace for the client to be - authorized to transfer and allocate the object. If the allocation - token (Section 2.1) does not match the object's allocation token - (Section 2.1), the server MUST return an EPP error result code of + 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. Example request command to allocate the domain object with - the allocation token: + the Allocation Token: C: C: C: C: C: C: example1.tld C: 1 C: @@ -483,129 +505,96 @@ C: C: ABC-12345 C: C: This extension does not add any elements to the EPP response described in the [RFC5730]. 3.2.5. EPP Command - This extension defines additional elements to extend an extension of - an empty EPP command of an object mapping like [RFC5731]. - An example of an extension of an empty EPP command is the - definition of the restore command within [RFC3915]. - - An extension of an empty EPP command defines a new verb that - transforms an object. In addition to the EPP command elements - described in an object mapping like [RFC5731], the command MUST - contain a child element, as defined - in Section 2.1, that identifies the extension namespace for the - client to be authorized to allocate the object. If the allocation - token (Section 2.1) does not match the object's allocation token - (Section 2.1), the server MUST return an EPP error result code of - 2201. - - Example use an extension of an empty command to release a - domain object with an allocation token: - - C: - C: - C: - C: - C: - C: example1.tld - C: - C: - C: - C: - C: - C: abc123 - C: - C: - C: ABC-12345-XYZ - C: - C: - - This extension does not add any elements to the EPP response - described in the [RFC5730]. + This extension does not add any elements to the EPP command + or response described in the [RFC5730]. 4. Formal Syntax One schema is presented here that is the EPP Allocation Token Extension schema. 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 - - + elementFormDefault="qualified" + > Extensible Provisioning Protocol v1.0 - Allocation Token Extension. + Allocation + Token Extension. - - - - - - + + + + + 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: + 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. - Registrant Contact: See the "Author's Address" section of this - document. + Registration request for the allocationToken XML schema: + URI: ietf:params:xml:ns:allocationToken-1.0 + Registrant Contact: IESG XML: See the "Formal Syntax" section of this document. 5.2. EPP Extension Registry - The EPP extension described in this document should be registered by - the IANA in the EPP Extension Registry described in [RFC7451]. The - details of the registration are as follows: + 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)" Document status: Standards Track Reference: (insert reference to RFC version of this document) Registrant Name and Email Address: IESG, @@ -683,62 +671,79 @@ URL: http://registrytoolkit.neustar 6.3. Neustar gTLD SRS Organisation: Neustar Inc. Name: Neustar generic Top Level Domain (gTLD) Shared Registry System (SRS). Description: The Neustar gTLD SRS implements the server side of - draft-ietf-regext-allocation-token. For several Top Level Domains + draft-ietf-regext-allocation-token for several Top Level Domains. Level of maturity: Production Coverage: All server side aspects of the protocol are implemented. Licensing: Proprietary Contact: kal.feher@team.neustar 7. Security Considerations - The mapping extensions described in this document do 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 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: + + 1. An Allocation Token should be considered secret information by + the client and should be protected at rest and 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 should is signed XML should be encoded (e.g., + base64) 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 Patrick Mevzek. + were provided by Scott Hollenbeck, Rubens Kuhl, Alexander Mayrhofer, + and Patrick Mevzek. 9. 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, . [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . - [RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for - the Extensible Provisioning Protocol (EPP)", RFC 3915, - DOI 10.17487/RFC3915, September 2004, . - [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, . [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) Domain Name Mapping", STD 69, RFC 5731, DOI 10.17487/RFC5731, August 2009, . [RFC6982] Sheffer, Y. and A. Farrel, "Improving Awareness of Running @@ -801,20 +806,99 @@ EPP..." in the Introduction section. 3. Reword the "The allocation token is known to the server..." sentence in the Introduction section. 4. Modify the "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" to clarify who the two separate clients are. 5. Removed an unneeded ":" from the EPP Command and EPP Command sections. +A.11. Change from REGEXT 05 to REGEXT 06 + + 1. Fix description of Neustar gTLD SRS based on feedback from Rubens + Kuhl. + 2. Updates based on feedback from Alexander Mayrhofer, that include: + + 1. Making all references to Allocation Token to use the upper + case form. + 2. Revise the language of the abstract to include "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..." + 3. Replace the title "EPP Command" with "EPP + Query Command" for section 3.1.3. + 4. Revise the second sentence of the Introduction to "The + mapping, ..., supports passing an Allocation Token..." + 5. Change "support" to "require" in the Introduction sentence + "It is up to server policy which EPP transform commands and + which objects support the Allocation Token." + 6. Add the definition of Allocation to the Introduction. + 7. Removed "transform" from "all of the supported EPP transform + commands" in the "Allocation Token" section, since the + Allocation Token can be used with the "check" command as + well. + 8. Remove the word "same" from "The same + element is used for + all..." in the "Allocation Token" section. + 9. Change the description of the use of the 2201 error in the + "Allocation Token" section, the "EPP Command" + section, the "EPP Command" section, and the "EPP + Command" section. + 10. Revise " to determine if an object is known to the + server..." to " to determine if an object can be + provisioned..." and remove "detailed" in the description of + the in the "EPP Query Commands" section. + 11. Add missing description of the expected response + behavior. + 12. Replaced the example reason "Invalid domain-token pair" with + "Allocation Token mismatch". + 13. Replace "information on" with "information associated with" + in the "EPP Command" section. + 14. Removed the "that identifies the extension namespace", the + ", defined in...", the Allocation Token links from the error + response sentences, and the "object referencing the + element" in the "EPP Command" + section. + 15. Added "The authorization is subject to server policy." to + the "EPP Command" section. + 16. Replace "or response>" with "or query + response>" in the EPP Query Command" section. + 17. Replace "create an object" with "create an instance of an + object" in the "EPP Command" section. + 18. Revised the sentence to include "the command MUST contain a + child element for the + client to be authorized to create and allocate the object" + in the "EPP Command" section. + 19. Removed the reference to section 2.1 and the namespace + identification text in the "EPP Command" section. + 20. Added "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." to the "EPP Command" section. + 21. Modified the first sentence of the "EPP Extension Registry" + section to read "The following registration of the EPP + Extension Registry, described in RFC7451, is requested" + 22. Removed support with using the Allocation Token with an + empty extension of update (e.g., release command), based on + the confusion and lack of known applicability. + 3. Updates based on feedback from Scott Hollenbeck, that include: + + 1. Revised XML schema to included a minimum length of 1 for the + allocationTokenType. + 2. Revised the "IANA Considerations" section to include the + registration of the XML schema. + 3. Revised the "Security Considerations" section to include + considerations for the definition of the Allocation Tokens. + Authors' Addresses James Gould VeriSign, Inc. 12061 Bluemont Way Reston, VA 20190 US Email: jgould@verisign.com URI: http://www.verisigninc.com