Internet Engineering Task Force L. Zhou Internet-Draft CNNIC Intended status: Standards Track N. Kong Expires: February 25, 2019 Consultant J. Wei J. Yao CNNIC J. Gould Verisign, Inc. August 24, 2018 Organization Extension for the Extensible Provisioning Protocol (EPP) draft-ietf-regext-org-ext-09 Abstract This document describes an extension to EPP object mappings, which is designed to support assigning an organization to any existing object (domain, host, contact) as well as any future objects. 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 https://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 25, 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 (https://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 Zhou, et al. Expires February 25, 2019 [Page 1] Internet-Draft Organization Extension for the EPP August 2018 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 . . . . . . . . . . . . . . . . . . . . . . . . 2 2. Conventions Used in This Document . . . . . . . . . . . . . . 3 3. Object Attributes . . . . . . . . . . . . . . . . . . . . . . 4 3.1. Organization Identifier . . . . . . . . . . . . . . . . . 4 4. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 4 4.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 4 4.1.1. EPP Command . . . . . . . . . . . . . . . . . 4 4.1.2. EPP Command . . . . . . . . . . . . . . . . . 4 4.1.3. EPP Query Command . . . . . . . . . . . . 7 4.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 8 4.2.1. EPP Command . . . . . . . . . . . . . . . . 8 4.2.2. EPP Command . . . . . . . . . . . . . . . . 10 4.2.3. EPP Command . . . . . . . . . . . . . . . . . 10 4.2.4. EPP Command . . . . . . . . . . . . . . . 11 4.2.5. EPP Command . . . . . . . . . . . . . . . . 11 5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 15 6. Internationalization Considerations . . . . . . . . . . . . . 17 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 18 7.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 18 7.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 18 8. Implementation Status . . . . . . . . . . . . . . . . . . . . 19 8.1. Verisign EPP SDK . . . . . . . . . . . . . . . . . . . . 19 8.2. CNNIC Implementation . . . . . . . . . . . . . . . . . . 20 9. Security Considerations . . . . . . . . . . . . . . . . . . . 20 10. Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . 20 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 20 11.1. Normative References . . . . . . . . . . . . . . . . . . 20 11.2. Informative References . . . . . . . . . . . . . . . . . 21 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 22 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 24 1. Introduction In the business model of domain registration, we usually have 3 roles of entities: a registrant, a registrar and a registry. There may be other roles of entities involved in the domain registration process which are not formally defined, such as resellers, DNS service operators, privacy proxies, etc. A domain reseller is an individual or a company that acts as an agent for accredited registrars. A third-party DNS service operator is Zhou, et al. Expires February 25, 2019 [Page 2] Internet-Draft Organization Extension for the EPP August 2018 responsible for a zone where the operator is neither the registrant nor the registrar of record for the delegation. A privacy proxy is an entity used for domain registrations to protect the private information of the individuals and organizations. These kind of entities are defined as "organizations" with different role types in this document. In order to facilitate provisioning and management of organization information in a shared central repository, this document proposes an organization extension mapping for any EPP object like domain names in [RFC5731], hosts in [RFC5732] and contacts in [RFC5733]. The examples provided in this document are used for the domain object for illustration purpose. The host and contact object could be extended in the same way with the domain object. An organization mapping object defined in [ID.draft-ietf-regext-org] SHOULD be created first. The organization information specified in this document MUST reference the existing organization identifier. This document is specified using the XML 1.0 as described in [W3C.REC-xml-20040204] and XML Schema notation as described in [W3C.REC-xmlschema-1-20041028] and [W3C.REC-xmlschema-2-20041028]. 2. 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 BCP 14 [RFC2119][RFC8174] when, and only when, they appear in all capitals, as shown here. 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 specification. XML is case sensitive. Unless stated otherwise, XML specifications and examples provided in this document MUST be interpreted in the character case presented to develop a conforming implementation. The XML namespace prefix "orgext" 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. Zhou, et al. Expires February 25, 2019 [Page 3] Internet-Draft Organization Extension for the EPP August 2018 3. Object Attributes This extension adds additional elements to EPP object mappings like the EPP domain name mapping [RFC5731]. Only the new elements are described here. 3.1. Organization Identifier Organization identifier provides the ID of an organization. Its corresponding element is which refers to the element defined in [ID.draft-ietf-regext-org]. All organization objects are identified by a server-unique identifier. 4. EPP Command Mapping A detailed description of the EPP syntax and semantics can be found in the EPP core protocol specification [RFC5730]. The command mappings described here are specifically for assigning organizations to EPP objects. 4.1. EPP Query Commands EPP provides three commands to retrieve EPP object information: to determine if an object can be provisioned within a repository, to retrieve detailed information associated with an object, and to retrieve object transfer status information. 4.1.1. EPP Command This extension does not add any elements to the EPP command or response described in the EPP object mapping. 4.1.2. EPP Command This extension does not add any elements to the EPP command described in the EPP object mapping. However, additional elements are defined for the response in the EPP object mapping. When an command has been processed successfully, the EPP element MUST contain child elements as described in the EPP object extensions. In addition, the EPP element SHOULD contain a child element. This element or its ancestor element MUST identify the extension namespace if the object has data associated with this extension and based on server policy. The element contains the following child elements: Zhou, et al. Expires February 25, 2019 [Page 4] Internet-Draft Organization Extension for the EPP August 2018 o Zero or more elements are allowed that contain the identifier of the organization. The "role" attribute is used to represent the relationship that the organization has to the object. See Section 7.3 in [ID.draft-ietf-regext-org] for a list of values. Example response for an authorized client with multiple organizations: Zhou, et al. Expires February 25, 2019 [Page 5] Internet-Draft Organization Extension for the EPP August 2018 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: sh8013 S: S: ns1.example.com S: S: ClientX S: ClientY S: 2015-02-06T04:01:21.0Z S: 2018-02-06T04:01:21.0Z S: S: 2fooBAR S: S: S: S: S: S: myreseller S: myproxy S: S: S: S: ngcl-IvJjzMZc S: test142AWQONJZ S: S: S: Example response for an authorized client with no organization: Zhou, et al. Expires February 25, 2019 [Page 6] Internet-Draft Organization Extension for the EPP August 2018 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: sh8013 S: S: ns1.example.com S: S: ClientX S: ClientY S: 2015-02-06T04:01:21.0Z S: 2018-02-06T04:01:21.0Z S: S: 2fooBAR S: S: S: S: S: S: S: S: ngcl-IvJjzMZc S: test142AWQONJZ S: S: S: An EPP error response MUST be returned if an command cannot be processed for any reason. 4.1.3. EPP Query Command This extension does not add any elements to the EPP query command or query response described in the EPP object mapping. Zhou, et al. Expires February 25, 2019 [Page 7] Internet-Draft Organization Extension for the EPP August 2018 4.2. EPP Transform Commands EPP provides five commands to transform EPP 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 the object sponsorship changes, and to change information associated with an object. 4.2.1. EPP Command This extension defines additional elements for the EPP command described in the EPP object extensions. No additional elements are defined for the EPP response. The EPP command provides a transform operation that allows a client to create an object. In addition to the EPP command elements described in the EPP object extensions, the command MUST contain an element, and the element MUST contain a child element. This element or its ancestor element MUST identify the extension namespace if the client wants to associate data defined in this extension to the object. The element contains the following child elements: o One or more elements that contain the identifier of the organization. The "role" attribute is used to represent the relationship that the organization has to the object. See Section 7.3 in [ID.draft-ietf-regext-org] for a list of values. Example Command with only one organization: Zhou, et al. Expires February 25, 2019 [Page 8] Internet-Draft Organization Extension for the EPP August 2018 C: C: C: C: C: C: example.com C: 3 C: C: ns1.example.com C: C: jd1234 C: sh8013 C: sh8013 C: sh8013 C: C: fooBAR C: C: C: C: C: C: myreseller C: C: C: ABC-12345 C: C: Example Command with multiple organizations: Zhou, et al. Expires February 25, 2019 [Page 9] Internet-Draft Organization Extension for the EPP August 2018 C: C: C: C: C: C: example.com C: 3 C: C: ns1.example.com C: C: jd1234 C: sh8013 C: sh8013 C: sh8013 C: C: fooBAR C: C: C: C: C: C: myreseller C: myproxy C: C: C: ABC-12345 C: C: When a command has been processed successfully, the EPP response is as described in the EPP object extension. An EPP error response MUST be returned if a command cannot be processed for any reason. 4.2.2. EPP Command This extension does not add any elements to the EPP command or response described in the EPP object mapping. 4.2.3. EPP Command This extension does not add any elements to the EPP command or response described in the EPP object mapping. Zhou, et al. Expires February 25, 2019 [Page 10] Internet-Draft Organization Extension for the EPP August 2018 4.2.4. EPP Command This extension does not add any elements to the EPP command or response described in the EPP object mapping, but after a successful transfer of an object with an assigned organization, the handling of the assigned organization is dependent on the organization roles and server policy. 4.2.5. EPP Command This extension defines additional elements for the EPP command described in the EPP domain mapping [RFC5731], host mapping [RFC5732] and contact mapping [RFC5733]. No additional elements are defined for the EPP response. The EPP command provides a transform operation that allows a client to modify the attributes of an object. In addition to the EPP command elements, the command MUST contain an element, and the element MUST contain a child element. This element or its ancestor element MUST identify the extension namespace if the client wants to update the object with data defined in this extension. The element contains the following child elements: o An OPTIONAL element that contains attribute values to be added to the object. o An OPTIONAL element that contains attribute values to be removed from the object. o An OPTIONAL element that contains attribute values to be changed. At least one , or element MUST be provided. The , and elements contain the following child element: o One or more elements that contain the identifier of the organization. The "role" attribute is used to represent the relationship that the organization has to the object. See Section 7.3 in [ID.draft-ietf-regext-org] for a list of values. Example command, adding a reseller: Zhou, et al. Expires February 25, 2019 [Page 11] Internet-Draft Organization Extension for the EPP August 2018 C: C: C: C: C: C: example.com C: C: C: C: C: C: myreseller C: C: C: C: ABC-12345 C: C: Example command, adding multiple organizations: C: C: C: C: C: C: example.com C: C: C: C: C: C: myreseller C: myproxy C: C: C: C: ABC-12345 C: C: Example command, removing a reseller: Zhou, et al. Expires February 25, 2019 [Page 12] Internet-Draft Organization Extension for the EPP August 2018 C: C: C: C: C: C: example.com C: C: C: C: C: C: C: C: C: C: ABC-12345 C: C: Example command, removing multiple organizations: C: C: C: C: C: C: example.com C: C: C: C: C: C: C: C: C: C: C: ABC-12345 C: C: Example command, updating reseller identifier: Zhou, et al. Expires February 25, 2019 [Page 13] Internet-Draft Organization Extension for the EPP August 2018 C: C: C: C: C: C: example.com C: C: C: C: C: C: myreseller C: C: C: C: ABC-12345 C: C: Example command, updating multiple organization identifiers: C: C: C: C: C: C: example.com C: C: C: C: C: C: myreseller C: myproxy C: C: C: C: ABC-12345 C: C: When an extended command has been processed successfully, the EPP response is as described in the EPP object extension. Zhou, et al. Expires February 25, 2019 [Page 14] Internet-Draft Organization Extension for the EPP August 2018 An EPP error response MUST be returned if an command cannot be processed for any reason. An attempt to add one organization ID or multiple organization IDs with a particular role value when at least one of them already exists does not change the object at all. A server SHOULD notify clients that object relationships exist by sending a 2305 error response code. An attempt to remove an organization ID or multiple organization IDs with a particular role value when at least one of them does not exist does not change the object at all. A server SHOULD notify clients that object relationships does not exist by sending a 2305 error response code. An attempt to change an organization ID or multiple organization IDs with a particular role value when at least one of them does not exist does not change the object at all. A server SHOULD notify clients that object relationships does not exist by sending a 2305 error response code. Response format with error value elements is defined in Section 2.6 of [RFC5730]. 5. 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. 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. BEGIN Extensible Provisioning Protocol v1.0 Organization Extension Schema v1.0 Zhou, et al. Expires February 25, 2019 [Page 15] Internet-Draft Organization Extension for the EPP August 2018 Zhou, et al. Expires February 25, 2019 [Page 16] Internet-Draft Organization Extension for the EPP August 2018 END 6. Internationalization Considerations EPP is represented in XML, which provides native support for encoding information using the Unicode character set and its more compact representations including UTF-8. Conformant XML processors recognize both UTF-8 and UTF-16. Though XML includes provisions to identify Zhou, et al. Expires February 25, 2019 [Page 17] Internet-Draft Organization Extension for the EPP August 2018 and use other character encodings through use of an "encoding" attribute in an declaration, use of UTF-8 is RECOMMENDED. As an extension of the EPP object mapping, the elements, element content described in this document MUST inherit the internationalization conventions used to represent higher-layer domain and core protocol structures present in an XML instance that includes this extension. 7. IANA Considerations 7.1. XML Namespace This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism described in [RFC3688]. IANA is requested to assignment the following URI. Registration request for the organization extension namespace: URI: urn:ietf:params:xml:ns:epp:orgext-1.0 Registrant Contact: IESG XML: None. Namespace URIs do not represent an XML specification. Registration request for the organization XML schema: URI: urn:ietf:params:xml:schema:epp:orgext-1.0 Registrant Contact: IESG XML: See the "Formal Syntax" section of this document. 7.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: Name of Extension: Organization Extension for the Extensible Provisioning Protocol (EPP) Registrant Name and Email Address: IESG, iesg@ietf.org TLDs: Any IPR Disclosure: None Zhou, et al. Expires February 25, 2019 [Page 18] Internet-Draft Organization Extension for the EPP August 2018 Status: Active Notes: None 8. Implementation Status Note to RFC Editor: Please remove this section and the reference to [RFC7942] before publication. This section records the status of known implementations of the protocol defined by this specification at the time of posting of this Internet-Draft, and is based on a proposal described in [RFC7942]. The description of implementations in this section is intended to assist the IETF in its decision processes in progressing drafts to RFCs. Please note that the listing of any individual implementation here does not imply endorsement by the IETF. Furthermore, no effort has been spent to verify the information presented here that was supplied by IETF contributors. This is not intended as, and must not be construed to be, a catalog of available implementations or their features. Readers are advised to note that other implementations may exist. According to [RFC7942], "this will allow reviewers and working groups to assign due consideration to documents that have the benefit of running code, which may serve as evidence of valuable experimentation and feedback that have made the implemented protocols more mature. It is up to the individual working groups to use this information as they see fit". 8.1. Verisign EPP SDK Organization: Verisign Inc. Name: Verisign EPP SDK Description: The Verisign EPP SDK includes both a full client implementation and a full server stub implementation of draft-ietf- regext-org-ext. Level of maturity: Development Coverage: All aspects of the protocol are implemented. Licensing: GNU Lesser General Public License Contact: jgould@verisign.com URL: https://www.verisign.com/en_US/channel-resources/domain- registry-products/epp-sdks Zhou, et al. Expires February 25, 2019 [Page 19] Internet-Draft Organization Extension for the EPP August 2018 8.2. CNNIC Implementation Organization: CNNIC Name: Organization Extension for EPP Description: CNNIC is trying to update organization extension from previous reseller extension according to this document. Level of maturity: Development Coverage: Organization extension for EPP Contact: zhouguiqing@cnnic.cn 9. Security Considerations The object mapping extension described in this document does not provide any other security services or introduce any additional considerations beyond those described by [RFC5730], [RFC5731], [RFC5732] and [RFC5733] or those caused by the protocol layers used by EPP. 10. Acknowledgment The authors would like to thank Rik Ribbers, Marc Groeneweg, Patrick Mevzek, Antoin Verschuren and Scott Hollenbeck for their careful review and valuable comments. 11. References 11.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, . [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, . Zhou, et al. Expires February 25, 2019 [Page 20] Internet-Draft Organization Extension for the EPP August 2018 [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) Domain Name Mapping", STD 69, RFC 5731, DOI 10.17487/RFC5731, August 2009, . [RFC5732] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) Host Mapping", STD 69, RFC 5732, DOI 10.17487/RFC5732, August 2009, . [RFC5733] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) Contact Mapping", STD 69, RFC 5733, DOI 10.17487/RFC5733, 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, . [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, . [W3C.REC-xml-20040204] Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, E., and F. Yergeau, ""Extensible Markup Language (XML) 1.0 (Third Edition)", World Wide Web Consortium FirstEdition REC-xml- 20040204", February 2004, . [W3C.REC-xmlschema-1-20041028] Thompson, H., Beech, D., Maloney, M., and N. Mendelsohn, ""XML Schema Part 1: Structures Second Edition", World Wide Web Consortium Recommendation REC-xmlschema- 1-20041028", October 2004, . [W3C.REC-xmlschema-2-20041028] Biron, P. and A. Malhotra, ""XML Schema Part 2: Datatypes Second Edition", World Wide Web Consortium Recommendation REC-xmlschema-2-20041028", October 2004, . 11.2. Informative References Zhou, et al. Expires February 25, 2019 [Page 21] Internet-Draft Organization Extension for the EPP August 2018 [ID.draft-ietf-regext-org] Zhou, L., Kong, N., Zhou, G., Lee, X., and J. Gould, "Extensible Provisioning Protocol (EPP) Reseller Mapping", Apr 2018, . [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, February 2015, . Appendix A. Change Log Initial -00: Individual document submitted. -01: * Updated abstract and introduction. * Revised typos in info response. * Added explanations on how to process reseller extension after successful transfer operation. * Modified explanation. * Deleted reseller name element in and commands. * Removed some inaccurate comments from xml schema. * Modified the element name of reseller id and reseller name. -02: * Changed author information. * Updated xml typos to in response. -03: * Changed author information. * Updated section 3.1. * Removed reseller name element in response. * Added acknowledgment. Zhou, et al. Expires February 25, 2019 [Page 22] Internet-Draft Organization Extension for the EPP August 2018 * Revised the typo "resellerr" to "resellerext". WG document-00: WG document submitted WG document-01: Keep document alive for further discussion. The requirement of reseller information is clear for both registrar and registry. What we should reach a consensus is whether the extension should support only a name or ID and name. Organization WG document-00: Change to a generic organization object extension. Organization WG document-01: Added "Implementation Status" section. Organization WG document-02: Accepted some of the feedbacks on the mailing list. Modified the examples in the document. Organization WG document-03: * Updated typos. * Changed some descriptions about and role attribute. * Modified the example of "domain with no organization". * Updated section 8, adding implementation status of Verisign. Organization WG document-04: * Updated typos. * Removed the example of command, domain with no organization. * Updated references. * Updated section 8 of implementation status. Organization WG document-05: * Removed the minOccurs="0" from the addRemChgType type of the XML schema * Removed the third paragraph of "Implementation Status". * Remove the Informative Reference to draft-ietf-regext-reseller- ext from the draft. Zhou, et al. Expires February 25, 2019 [Page 23] Internet-Draft Organization Extension for the EPP August 2018 Organization WG document-06: * Updated "Abstraction". * Added "Query" for " Query Command". * Change "Registrant Contact" to IESG in section 7.1. * Modified section 7.2. Organization WG document-07: * Updated "Abstraction". Organization WG document-08: * Updated error codes of response. * Modified XML namespace and schema. Organization WG document-09: * Modified XML namespace and schema. * Changed "Exactly one" to "At least one" in section 4.2.5. Authors' Addresses Linlin Zhou CNNIC 4 South 4th Street, Zhongguancun, Haidian District Beijing, Beijing 100190 China Email: zhoulinlin@cnnic.cn Ning Kong Consultant Email: ietfing@gmail.com Zhou, et al. Expires February 25, 2019 [Page 24] Internet-Draft Organization Extension for the EPP August 2018 Junkai Wei CNNIC 4 South 4th Street, Zhongguancun, Haidian District Beijing, Beijing 100190 China Email: weijunkai@cnnic.cn Jiankang Yao CNNIC 4 South 4th Street, Zhongguancun, Haidian District Beijing, Beijing 100190 China Email: yaojk@cnnic.cn James Gould Verisign, Inc. 12061 Bluemont Way Reston, VA 20190 US Email: jgould@verisign.com Zhou, et al. Expires February 25, 2019 [Page 25]