Internet Engineering Task Force (IETF) L. Zhou Request for Comments: 8544 CNNIC Category: Standards Track N. Kong ISSN: 2070-1721 Consultant J. Wei J. Yao CNNIC J. Gould VeriSign, Inc. April 2019
Organization Extension for the Extensible Provisioning Protocol (EPP)
Abstract
This document describes an extension to Extensible Provisioning Protocol (EPP) object mappings that 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 is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 7841.
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at https://www.rfc-editor.org/info/rfc8544.
Zhou, et al. Standards Track [Page 1]
RFC 8544 Organization Extension for the EPP April 2019
Copyright Notice
Copyright (c) 2019 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 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.
There are many entities, such as registrars, resellers, DNS service operators, and privacy proxies, involved in the domain registration business. These kinds of entities are supported in the Extensible Provisioning Protocol (EPP) by the "organization" entities in [RFC8543]. This document provides a way to associate any EPP object such as domain names in [RFC5731], hosts in [RFC5732], and contacts in [RFC5733] to "organization" entities in [RFC8543]. The examples provided in this document are used for the domain object for illustration purposes. The host and contact object could be extended in the same way as the domain object.
Organization object identifiers, defined in [RFC8543], MUST be known to the server before the organization object can be associated with the EPP object.
This document is specified using XML 1.0 as described in [W3C.REC-xml-20081126] and XML Schema notation as described in [W3C.REC-xmlschema-1-20041028] and [W3C.REC-xmlschema-2-20041028].
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 [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.
The XML namespace prefix "orgext" is used for the namespace "urn:ietf:params:xml:ns:epp:orgext-1.0", but implementations MUST NOT depend on it; instead, they should employ a proper namespace-aware XML parser and serializer to interpret and output the XML documents.
This extension adds additional elements to EPP object mappings such as the EPP domain name mapping [RFC5731]. Only the new elements are described here.
Zhou, et al. Standards Track [Page 3]
RFC 8544 Organization Extension for the EPP April 2019
The organization identifier provides the ID of an organization. Its corresponding element is <orgext:id>, which refers to the <org:id> element defined in [RFC8543]. All organization objects are identified by a server-unique identifier. A "role" attribute is used to represent the relationship that the organization has to the EPP object. Any given object MUST have at most one associated organization ID for any given role value.
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.
EPP provides three commands to retrieve EPP object information: <check> to determine if an object can be provisioned within a repository, <info> to retrieve detailed information associated with an object, and <transfer> to retrieve object transfer status information.
This extension does not add any elements to the EPP <info> command described in the EPP object mapping. However, additional elements are defined for the <info> response in the EPP object mapping.
When an <info> command has been processed successfully, the EPP <resData> element MUST contain child elements as described in the EPP object extensions. In addition, the EPP <extension> element SHOULD contain a child <orgext:infData> element. This element is returned if the object has data that is associated with this extension and that is based on server policy. This element or its ancestor element
Zhou, et al. Standards Track [Page 4]
RFC 8544 Organization Extension for the EPP April 2019
MUST identify the extension namespace "urn:ietf:params:xml:ns:epp:orgext-1.0". The <orgext:infData> element contains the following child elements:
o Zero or more <orgext:id> elements are allowed that contain the identifier of the organization, as defined in Section 3.1. The "role" attribute is used to represent the relationship that the organization has to the object. See Section 7.3 of [RFC8543] for a list of values.
Example <info> response for an authorized client with multiple organizations:
Zhou, et al. Standards Track [Page 5]
RFC 8544 Organization Extension for the EPP April 2019
EPP provides five commands to transform EPP objects: <create> to create an instance of an object, <delete> to delete an instance of an object, <renew> to extend the validity period of an object, <transfer> to manage the object sponsorship changes, and <update> to change information associated with an object.
This extension defines additional elements for the EPP <create> command described in the EPP object extensions. No additional elements are defined for the EPP <create> response.
The EPP <create> 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 <extension> element, and the <extension> element MUST contain a child <orgext:create> element. This element is used if the client wants to associate data defined in this extension to the object. This element or its ancestor element MUST identify the extension namespace "urn:ietf:params:xml:ns:epp:orgext-1.0". The <orgext:create> element contains the following child elements:
o One or more <orgext:id> elements that contain the identifier of the organization, as defined in Section 3.1. The "role" attribute is used to represent the relationship that the organization has to the object. See Section 7.3 of [RFC8543] for a list of values.
Zhou, et al. Standards Track [Page 8]
RFC 8544 Organization Extension for the EPP April 2019
Example <create> command with only one organization:
This extension does not add any elements to the EPP <transfer> command or <transfer> 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.
This extension defines additional elements for the EPP <update> command described in the EPP domain mapping [RFC5731], host mapping [RFC5732], and contact mapping [RFC5733]. No additional elements are defined for the EPP <update> response.
The EPP <update> command provides a transform operation that allows a client to modify the attributes of an object. In addition to the EPP <update> command elements, the command MUST contain an <extension> element, and the <extension> element MUST contain a child <orgext:update> element. This element is used if the client wants to update the object with data defined in this extension. This element or its ancestor element MUST identify the extension namespace "urn:ietf:params:xml:ns:epp:orgext-1.0". The <orgext:update> element contains the following child elements:
o An OPTIONAL <orgext:add> element that contains one or more <orgext:id> elements, as defined in Section 3.1, that add nonexistent organization roles to the object. The <orgext:id> element MUST have a non-empty organization identifier value. The server SHOULD validate that the <orgext:id> element role does not exist.
o An OPTIONAL <orgext:rem> element that contains one or more <orgext:id> elements, as defined in Section 3.1, that remove organization roles from the object. The <orgext:id> element MAY have an empty organization identifier value. The server SHOULD validate the existence of the <orgext:id> element role and the organization identifier if provided.
o An OPTIONAL <orgext:chg> element that contains one or more <orgext:id> elements, as defined in Section 3.1, that change organization role identifiers for the object. The existing organization identifier value will be replaced for the defined role. The server SHOULD validate the existence of the <orgext:id> element role.
At least one <orgext:add>, <orgext:rem>, or <orgext:chg> element MUST be provided.
Zhou, et al. Standards Track [Page 11]
RFC 8544 Organization Extension for the EPP April 2019
RFC 8544 Organization Extension for the EPP April 2019
When an extended <update> command has been processed successfully, the EPP response is as described in the EPP object extension.
An EPP error response MUST be returned if an <update> 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 do 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 do not exist by sending a 2305 error response code. Response format with error value elements is defined in Section 2.6 of [RFC5730].
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.
RFC 8544 Organization Extension for the EPP April 2019
<!-- Child elements found in EPP commands --> <element name="create" type="orgext:createType"/> <element name="update" type="orgext:updateType"/>
<!-- Organization identifier with required role --> <complexType name="orgIdType"> <simpleContent> <extension base="token"> <attribute name="role" type="token" use="required"/> </extension> </simpleContent> </complexType>
<!-- Child elements of the <orgext:create> command. All elements must be present at time of creation. --> <complexType name="createType"> <sequence> <!-- Agent identifier or the organization, e.g., registrar, reseller, privacy proxy, etc. --> <element name="id" type="orgext:orgIdType" maxOccurs="unbounded"/> </sequence> </complexType>
<!-- Child elements of <orgext:update> command --> <complexType name="updateType"> <sequence> <element name="add" type="orgext:addRemChgType" minOccurs="0" />
Zhou, et al. Standards Track [Page 16]
RFC 8544 Organization Extension for the EPP April 2019
EPP is represented in XML, which provides native support for encoding information using the Unicode character set [UNICODE] and its more compact representations, including UTF-8. Conformant XML processors recognize both UTF-8 [RFC3629] and UTF-16 [RFC2781]. Though XML includes provisions to identify and use other character encodings through use of an "encoding" attribute in an <?xml?> declaration, use of UTF-8 is RECOMMENDED.
As an extension of the EPP object mapping, the elements and 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.
This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism described in [RFC3688]. IANA has assigned the following URI.
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.
The organization XML schema:
URI: urn:ietf:params:xml:schema:epp:orgext-1.0
Registrant Contact: IESG
XML: See the "Formal Syntax" section of RFC 8544 (this document).
Zhou, et al. Standards Track [Page 18]
RFC 8544 Organization Extension for the EPP April 2019
The EPP extension described in this document has been registered by IANA in the "Extensions for the Extensible Provisioning Protocol (EPP)" registry described in [RFC7451]. The details of the registration are as follows:
Name of Extension: Organization Extension for the Extensible Provisioning Protocol (EPP)
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.
[W3C.REC-xml-20081126] Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, E., and F. Yergeau, "Extensible Markup Language (XML) 1.0 (Fifth Edition)", World Wide Web Consortium Recommendation REC-xml-20081126, November 2008, <https://www.w3.org/TR/xml/>.
[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, <http://www.w3.org/TR/2004/REC-xmlschema-1-20041028>.
[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, <http://www.w3.org/TR/2004/REC-xmlschema-2-20041028>.
Zhou, et al. Standards Track [Page 20]
RFC 8544 Organization Extension for the EPP April 2019
The authors would like to thank Rik Ribbers, Marc Groeneweg, Patrick Mevzek, Antoin Verschuren, and Scott Hollenbeck for their careful review and valuable comments.
Zhou, et al. Standards Track [Page 21]
RFC 8544 Organization Extension for the EPP April 2019
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
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 United States of America