Internet Engineering Task Force L. Zhou Internet-Draft N. Kong Intended status: Standards Track J. Wei Expires: November 13, 2017 X. Lee CNNIC J. Gould VeriSign, Inc. May 12, 2017 Organization Extension for the Extensible Provisioning Protocol (EPP) draft-ietf-regext-org-ext-00 Abstract This mapping, an extension to EPP object mappings like the EPP domain name mapping [RFC5731], to support assigning an organization to any existing object (domain, host, contact) as well as any future objects. Specified in Extensible Markup Language (XML), this extended mapping is applied to provide additional features required for the provisioning of organizations. 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 13, 2017. Copyright Notice Copyright (c) 2017 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 Zhou, et al. Expires November 13, 2017 [Page 1] Internet-Draft Organization Extension for the EPP May 2017 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. This document may contain material from IETF Documents or IETF Contributions published or made publicly available before November 10, 2008. The person(s) controlling the copyright in some of this material may not have granted the IETF Trust the right to allow modifications of such material outside the IETF Standards Process. Without obtaining an adequate license from the person(s) controlling the copyright in such materials, this document may not be modified outside the IETF Standards Process, and derivative works of it may not be created outside the IETF Standards Process, except to format it for publication as an RFC or to translate it into languages other than English. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 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 Command . . . . . . . . . . . . . . . 7 4.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 7 4.2.1. EPP Command . . . . . . . . . . . . . . . . 7 4.2.2. EPP Command . . . . . . . . . . . . . . . . 8 4.2.3. EPP Command . . . . . . . . . . . . . . . . . 8 4.2.4. EPP Command . . . . . . . . . . . . . . . 9 4.2.5. EPP Command . . . . . . . . . . . . . . . . 9 5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 11 6. Internationalization Considerations . . . . . . . . . . . . . 13 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 13 7.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 14 7.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 14 8. Security Considerations . . . . . . . . . . . . . . . . . . . 14 9. Acknowledgement . . . . . . . . . . . . . . . . . . . . . . . 15 10. References . . . . . . . . . . . . . . . . . . . . . . . . . 15 10.1. Normative References . . . . . . . . . . . . . . . . . . 15 10.2. Informative References . . . . . . . . . . . . . . . . . 16 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 16 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 17 Zhou, et al. Expires November 13, 2017 [Page 2] Internet-Draft Organization Extension for the EPP May 2017 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 have some other roles of entities involved in the domain registration process which are not formally defined, such as resellers, DNS service operators, privacy proxy, etc. A domain reseller is an individual or a company that acts as a agent for accredited registrars. A third-party DNS service operator is responsible for a zone where the operator is neither the registrant nor the registrar of records for the delegation. And a privacy proxy is an entity that provides with individuals or organizations domain registration without exposing their private information. 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 a 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. A 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 [RFC2119]. 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. Zhou, et al. Expires November 13, 2017 [Page 3] Internet-Draft Organization Extension for the EPP May 2017 orgext-1.0 in this document is used as an abbreviation for urn:ietf:params:xml:ns:orgext-1.0. 3. Object Attributes This extension adds additional elements to 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 use in provisioning and managing organization information via EPP. 4.1. EPP Query Commands EPP provides three commands to retrieve domain information: to determine if a domain object can be provisioned within a repository, to retrieve detailed information associated with a domain object, and to retrieve domain-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 domain name mapping [RFC5731], host mapping [RFC5732] and contact mapping [RFC5733]. 4.1.2. EPP Command This extension does not add any element to the EPP command described in the EPP domain mapping [RFC5731], host mapping [RFC5732] and contact mapping [RFC5733]. However, additional elements are defined for the response. Example command: Zhou, et al. Expires November 13, 2017 [Page 4] Internet-Draft Organization Extension for the EPP May 2017 C: C: C: C: C: C: example.com C: C: fooBAR C: C: C: C: ngcl-mIFICBNP C: C: 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 that identifies the extension namespace if the object has data associated with this extension and based on its service policy. The element contains the following child elements: o A element that contains the identifier of the organization. An attribute "role" associated with is used to represent the relationship an organization would have. See Section 7.3 in [ID.draft-ietf-regext-org] for a list of values. Example response for an authorized client: Zhou, et al. Expires November 13, 2017 [Page 5] Internet-Draft Organization Extension for the EPP May 2017 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: An EPP error response MUST be returned if an command cannot be processed for any reason. Zhou, et al. Expires November 13, 2017 [Page 6] Internet-Draft Organization Extension for the EPP May 2017 4.1.3. EPP Command This extension does not add any elements to the EPP command or response described in the EPP domain name mapping [RFC5731], host mapping [RFC5732] and contact mapping [RFC5733]. 4.2. EPP Transform Commands EPP provides five commands to transform domain objects: to create an instance of a domain object, to delete an instance of a domain object, to extend the validity period of a domain object, to manage domain object sponsorship changes, and to change information associated with a domain 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 that identifies 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 A element that contains the identifier of the organization. An attribute "role" associated with is used to represent the relationship an organization would have. See Section 7.3 in [ID.draft-ietf-regext-org] for a list of values. Example Command: Zhou, et al. Expires November 13, 2017 [Page 7] Internet-Draft Organization Extension for the EPP May 2017 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: 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 domain mapping [RFC5731], host mapping [RFC5732] and contact mapping [RFC5733]. 4.2.3. EPP Command This extension does not add any elements to the EPP command or response described in the EPP domain mapping [RFC5731], host mapping [RFC5732] and contact mapping [RFC5733]. Zhou, et al. Expires November 13, 2017 [Page 8] Internet-Draft Organization Extension for the EPP May 2017 4.2.4. EPP Command This extension does not add any elements to the EPP command or response described in the EPP domain mapping [RFC5731], host mapping [RFC5732] and contact mapping [RFC5733], 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 a domain object. In addition to the EPP command elements described in the EPP domain mapping, the command MUST contain an element, and the element MUST contain a child element that identifies the extension namespace if the client wants to update the domain 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 and only one , or element MUST be provided. The , and elements contain the following child element: o A element that contains the identifier of the organization. An attribute "role" associated with is used to represent the relationship an organization would have. See Section 7.3 in [ID.draft-ietf-regext-org] for a list of values. Example command, adding a reseller: Zhou, et al. Expires November 13, 2017 [Page 9] Internet-Draft Organization Extension for the EPP May 2017 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, removing a reseller: 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 reseller identifier: Zhou, et al. Expires November 13, 2017 [Page 10] Internet-Draft Organization Extension for the EPP May 2017 C: C: C: C: C: C: example.com C: C: C: C: C: C: myreseller 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. 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 Zhou, et al. Expires November 13, 2017 [Page 11] Internet-Draft Organization Extension for the EPP May 2017 Extensible Provisioning Protocol v1.0 Organization Extension Schema v1.0 Zhou, et al. Expires November 13, 2017 [Page 12] Internet-Draft Organization Extension for the EPP May 2017 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 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 domain name 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 Zhou, et al. Expires November 13, 2017 [Page 13] Internet-Draft Organization Extension for the EPP May 2017 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 namespace: o URI: urn:ietf:params:xml:ns:orgext-1.0 o Registrant Contact: See the "Author's Address" section of this document. o 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 Document status: Standards Track Reference: (insert reference to RFC version of this document) Registrant Name and Email Address: See the "Author's Address" section of this document. TLDs: any IPR Disclosure: none Status: active Notes: none 8. 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. Zhou, et al. Expires November 13, 2017 [Page 14] Internet-Draft Organization Extension for the EPP May 2017 9. Acknowledgement The authors would like to thank Rik Ribbers, Marc Groeneweg, Patrick Mevzek, Antoin Verschuren and Scott Hollenbeck for their careful review and valuable comments. 10. References 10.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, . [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, . [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, February 2015, . [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, . Zhou, et al. Expires November 13, 2017 [Page 15] Internet-Draft Organization Extension for the EPP May 2017 [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, . 10.2. Informative References [ID.draft-ietf-regext-org] Zhou, L., Kong, N., Zhou, G., Lee, X., Gould, J., and S. Hollenbeck, "Extensible Provisioning Protocol (EPP) Reseller Mapping", Apr 2017, . 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. Zhou, et al. Expires November 13, 2017 [Page 16] Internet-Draft Organization Extension for the EPP May 2017 * Updated xml typos to in response. -03: * Changed author information. * Updated section 3.1. * Removed reseller name element in response. * Added acknowledgement. * 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. Authors' Addresses Linlin Zhou CNNIC 4 South 4th Street, Zhongguancun, Haidian District Beijing, Beijing 100190 China Phone: +86 10 5881 2677 Email: zhoulinlin@cnnic.cn Ning Kong CNNIC 4 South 4th Street, Zhongguancun, Haidian District Beijing, Beijing 100190 China Phone: +86 10 5881 3147 Email: nkong@cnnic.cn Zhou, et al. Expires November 13, 2017 [Page 17] Internet-Draft Organization Extension for the EPP May 2017 Junkai Wei CNNIC 4 South 4th Street, Zhongguancun, Haidian District Beijing, Beijing 100190 China Phone: +86 10 5881 3494 Email: weijunkai@cnnic.cn Xiaodong Lee CNNIC 4 South 4th Street, Zhongguancun, Haidian District Beijing, Beijing 100190 China Phone: +86 10 5881 3020 Email: xl@cnnic.cn James Gould VeriSign, Inc. 12061 Bluemont Way Reston, VA 20190 US Email: jgould@verisign.com Zhou, et al. Expires November 13, 2017 [Page 18]