RFC 8544

Organization Extension for the Extensible Provisioning Protocol (EPP)

πŸ“… published April 2019, from ietf

RFC 8544: Organization Extension for the Extensible Provisioning Protocol (EPP) ✨

okay bestie, let's get the basics down first πŸŽ€ This RFC came out in April 2019 and is a Standards Track document, which means it's a real protocol spec the IETF approved after public review πŸ’… It's part of the ISSN 2070-1721 series.

The authors are:

  • L. Zhou (CNNIC) πŸ‘‘
  • N. Kong (Consultant) 🌸
  • J. Wei (CNNIC) πŸ¦‹
  • J. Yao (CNNIC) πŸ’œ
  • J. Gould (VeriSign, Inc.) 🧚

The header doesn't list anything this document obsoletes or updates, so it's standing on its own πŸ™Œ

Abstract ✨

so the big idea is an extension to EPP object mappings that lets you assign an organization to any existing object (domain, host, contact) and also to any future objects 🌈 main character energy for the whole protocol πŸ’–

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. πŸ”₯

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, since 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
2.  Conventions Used in This Document . . . . . . . . . . . . . .   3
3.  Object Attributes . . . . . . . . . . . . . . . . . . . . . .   3
  3.1.  Organization Identifier . . . . . . . . . . . . . . . . .   4
4.  EPP Command Mapping . . . . . . . . . . . . . . . . . . . . .   4
  4.1.  EPP Query Commands  . . . . . . . . . . . . . . . . . . .   4
    4.1.1.  EPP <check> Command . . . . . . . . . . . . . . . . .   4
    4.1.2.  EPP <info> Command  . . . . . . . . . . . . . . . . .   4
    4.1.3.  EPP <transfer> Query Command  . . . . . . . . . . . .   8
  4.2.  EPP Transform Commands  . . . . . . . . . . . . . . . . .   8
    4.2.1.  EPP <create> Command  . . . . . . . . . . . . . . . .   8
    4.2.2.  EPP <delete> Command  . . . . . . . . . . . . . . . .  10
    4.2.3.  EPP <renew> Command . . . . . . . . . . . . . . . . .  10
    4.2.4.  EPP <transfer> Command  . . . . . . . . . . . . . . .  11
    4.2.5.  EPP <update> Command  . . . . . . . . . . . . . . . .  11
5.  Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . .  15
6.  Internationalization Considerations . . . . . . . . . . . . .  18
7.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  18
  7.1.  XML Namespace . . . . . . . . . . . . . . . . . . . . . .  18
  7.2.  EPP Extension Registry  . . . . . . . . . . . . . . . . .  19
8.  Security Considerations . . . . . . . . . . . . . . . . . . .  19
9.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  19
  9.1.  Normative References  . . . . . . . . . . . . . . . . . .  19
  9.2.  Informative References  . . . . . . . . . . . . . . . . .  21
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . .  21
Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  22

1. Introduction 🌸

okay so picture this πŸ’– there are a LOT of entities in the domain registration business, like registrars, resellers, DNS service operators, and privacy proxies. EPP supports these kinds of entities through the "organization" entities in [RFC8543] ✨

This document gives you a way to link any EPP object to those "organization" entities in [RFC8543]. That includes domain names in [RFC5731], hosts in [RFC5732], and contacts in [RFC5733] πŸ¦‹ The examples here only use the domain object to illustrate things, but host and contact objects could be extended the exact same way as domain objects, so it's giving consistency πŸ’…

Organization object identifiers, defined in [RFC8543], MUST be known to the server before the organization object can be associated with the EPP object. no skipping this step, bestie πŸ™…β€β™€οΈ

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] 🧚

2. Conventions Used in This Document πŸŽ€

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here. these are the ONLY words that count as rules when they're in caps, so pay attention πŸ‘‘

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. the spacing is just there to make things pretty, not a rule ✨

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. the prefix is just a nickname, the namespace is the real deal πŸ’œ

3. Object Attributes πŸ¦‹

This extension adds additional elements to EPP object mappings such as the EPP domain name mapping [RFC5731]. Only the new elements are described here. πŸ’–

3.1. Organization Identifier πŸ’…

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. ngl this part is the core of the whole thing πŸ”₯

Any given object MUST have at most one associated organization ID for any given role value. πŸ™…β€β™€οΈ

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: <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. three query commands, three jobs, zero drama πŸ’…

4.1.1. EPP <check> Command ✨

This extension does not add any elements to the EPP <check> command or <check> response described in the EPP object mapping. nothing new to see here, the check command stays exactly the same 🫢

4.1.2. EPP <info> Command ✨

okay so this extension doesn't add any new elements to the EPP <info> command from the EPP object mapping πŸŽ€ but the <info> response gets some extra goodies defined here, and honestly they're giving πŸ’…

When an <info> command has been processed successfully, the EPP <resData> element MUST contain child elements as described in the EPP object extensions. On top of that, the EPP <extension> element SHOULD contain a child <orgext:infData> element 🧚 This element shows up if the object has data linked to this extension and that data is based on server policy. This element or its ancestor element MUST identify the extension namespace "urn:ietf:params:xml:ns:epp:orgext-1.0". The <orgext:infData> element has these child elements:

  • Zero or more <orgext:id> elements are allowed, and each one contains the identifier of the organization, as defined in Section 3.1. The role attribute shows the relationship the organization has to the object. See Section 7.3 of [RFC8543] for a list of values.

Here's an example <info> response for an authorized client with multiple organizations 🌸

S:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S:  <response>
S:   <result code="1000">
S:      <msg lang="en-US">Command completed successfully</msg>
S:    </result>
S:    <resData>
S:      <domain:infData
S:        xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S:        <domain:name>example.com</domain:name>
S:        <domain:roid>EXAMPLE1-REP</domain:roid>
S:        <domain:status s="ok"/>
S:        <domain:registrant>jd1234</domain:registrant>
S:        <domain:contact type="admin">sh8013</domain:contact>
S:        <domain:contact type="billing">sh8013</domain:contact>
S:        <domain:contact type="tech">sh8013</domain:contact>
S:        <domain:ns>
S:          <domain:hostObj>ns1.example.com</domain:hostObj>
S:        </domain:ns>
S:        <domain:clID>ClientX</domain:clID>
S:        <domain:crID>ClientY</domain:crID>
S:        <domain:crDate>2015-02-06T04:01:21.0Z</domain:crDate>
S:        <domain:exDate>2018-02-06T04:01:21.0Z</domain:exDate>
S:        <domain:authInfo>
S:          <domain:pw>2fooBAR</domain:pw>
S:        </domain:authInfo>
S:      </domain:infData>
S:    </resData>
S:    <extension>
S:      <orgext:infData
S:        xmlns:orgext="urn:ietf:params:xml:ns:epp:orgext-1.0">
S:        <orgext:id role="reseller">reseller1523</orgext:id>
S:        <orgext:id role="privacyproxy">proxy2935</orgext:id>
S:      </orgext:infData>
S:    </extension>
S:    <trID>
S:      <clTRID>ngcl-IvJjzMZc</clTRID>
S:      <svTRID>test142AWQONJZ</svTRID>
S:    </trID>
S:  </response>
S:</epp>

And here's one for an authorized client with no organization πŸ™ˆ

S:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S:  <response>
S:   <result code="1000">
S:      <msg lang="en-US">Command completed successfully</msg>
S:    </result>
S:    <resData>
S:      <domain:infData
S:        xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S:        <domain:name>example.com</domain:name>
S:        <domain:roid>EXAMPLE1-REP</domain:roid>
S:        <domain:status s="ok"/>
S:        <domain:registrant>jd1234</domain:registrant>
S:        <domain:contact type="admin">sh8013</domain:contact>
S:        <domain:contact type="billing">sh8013</domain:contact>
S:        <domain:contact type="tech">sh8013</domain:contact>
S:        <domain:ns>
S:          <domain:hostObj>ns1.example.com</domain:hostObj>
S:        </domain:ns>
S:        <domain:clID>ClientX</domain:clID>
S:        <domain:crID>ClientY</domain:crID>
S:        <domain:crDate>2015-02-06T04:01:21.0Z</domain:crDate>
S:        <domain:exDate>2018-02-06T04:01:21.0Z</domain:exDate>
S:        <domain:authInfo>
S:          <domain:pw>2fooBAR</domain:pw>
S:        </domain:authInfo>
S:      </domain:infData>
S:    </resData>
S:    <extension>
S:      <orgext:infData
S:        xmlns:orgext="urn:ietf:params:xml:ns:epp:orgext-1.0"/>
S:    </extension>
S:    <trID>
S:      <clTRID>ngcl-IvJjzMZc</clTRID>
S:      <svTRID>test142AWQONJZ</svTRID>
S:    </trID>
S:  </response>
S:</epp>
An EPP error response MUST be returned if an <info> command cannot be processed for any reason. No exceptions, bestie 🚨

4.1.3. EPP <transfer> Query Command πŸ¦‹

This extension doesn't add anything to the EPP <transfer> query command or the <transfer> query response from the EPP object mapping. Nothing new here, so you're good ✨

4.2. EPP Transform Commands πŸ”₯

EPP gives us five commands to transform EPP objects: <create> to make an instance of an object, <delete> to delete one, <renew> to extend the validity period of an object, <transfer> to manage sponsorship changes on an object, and <update> to change the information attached to an object. Five commands, five chances to be iconic πŸ‘‘

4.2.1. EPP <create> Command 🌈

This extension defines extra elements for the EPP <create> command from the EPP object extensions. It doesn't define any additional elements for the EPP <create> response, so the response stays simple πŸ“

The EPP <create> command is a transform operation that lets a client create an object. On top of the EPP command elements from the EPP object extensions, the command MUST contain an <extension> element, and that <extension> element MUST contain a child <orgext:create> element. The client uses this element when it wants to link the 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 has these child elements:

  • One or more <orgext:id> elements that contain the identifier of the organization, as defined in Section 3.1. The role attribute shows the relationship the organization has to the object. See Section 7.3 of [RFC8543] for a list of values.

Here's an example <create> command with only one organization πŸ’–

C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C:  <command>
C:    <create>
C:      <domain:create
C:        xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:        <domain:name>example.com</domain:name>
C:        <domain:period unit="y">3</domain:period>
C:        <domain:ns>
C:          <domain:hostObj>ns1.example.com</domain:hostObj>
C:        </domain:ns>
C:        <domain:registrant>jd1234</domain:registrant>
C:        <domain:contact type="tech">sh8013</domain:contact>
C:        <domain:contact type="billing">sh8013</domain:contact>
C:        <domain:contact type="admin">sh8013</domain:contact>
C:        <domain:authInfo>
C:          <domain:pw>fooBAR</domain:pw>
C:        </domain:authInfo>
C:      </domain:create>
C:    </create>
C:    <extension>
C:      <orgext:create
C:        xmlns:orgext="urn:ietf:params:xml:ns:epp:orgext-1.0">
C:        <orgext:id role="reseller">reseller1523</orgext:id>
C:      </orgext:create>
C:    </extension>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

And here's one with multiple organizations 🧚

C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C:  <command>
C:    <create>
C:      <domain:create
C:        xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:        <domain:name>example.com</domain:name>
C:        <domain:period unit="y">3</domain:period>
C:        <domain:ns>
C:          <domain:hostObj>ns1.example.com</domain:hostObj>
C:        </domain:ns>
C:        <domain:registrant>jd1234</domain:registrant>
C:        <domain:contact type="tech">sh8013</domain:contact>
C:        <domain:contact type="billing">sh8013</domain:contact>
C:        <domain:contact type="admin">sh8013</domain:contact>
C:        <domain:authInfo>
C:          <domain:pw>fooBAR</domain:pw>
C:        </domain:authInfo>
C:      </domain:create>
C:    </create>
C:    <extension>
C:      <orgext:create
C:        xmlns:orgext="urn:ietf:params:xml:ns:epp:orgext-1.0">
C:        <orgext:id role="reseller">reseller1523</orgext:id>
C:        <orgext:id role="privacyproxy">proxy2935</orgext:id>
C:      </orgext:create>
C:    </extension>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

When a <create> 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 <create> command cannot be processed for any reason. Don't skip this one, it's a big deal πŸ’€

4.2.2. EPP <delete> Command 🌸

This extension doesn't add any elements to the EPP <delete> command or the <delete> response from the EPP object mapping. Easy breezy 🫢

4.2.3. EPP <renew> Command πŸŽ€

This extension doesn't add any elements to the EPP <renew> command or the <renew> response from the EPP object mapping. Still no new stuff, we're cruising ✨

4.2.4. EPP <transfer> Command πŸ’œ

This extension doesn't add any elements to the EPP <transfer> command or the <transfer> response from the EPP object mapping. BUT, and this is a big but πŸ‘€, after a successful transfer of an object with an assigned organization, how that organization gets handled depends on the organization roles and server policy. So the plot thickens 🍿

4.2.5. EPP <update> Command ✨

okay so this extension adds extra bits to the EPP <update> command from the domain mapping [RFC5731], host mapping [RFC5732], and contact mapping [RFC5733] πŸ’…. there are no extra elements for the <update> response though, so nothing new to see there 🫢

the EPP <update> command is the transform op that lets a client change an object's attributes πŸ¦‹. on top of the usual <update> stuff, the command MUST contain an <extension> element, and that <extension> element MUST contain a child <orgext:update> element. you use this when you want to update the object with the data from this extension πŸŽ€. that <orgext:update> element, or its ancestor, MUST identify the extension namespace urn:ietf:params:xml:ns:epp:orgext-1.0 ✨. the <orgext:update> element has these child elements:

  • An OPTIONAL <orgext:add> element 🌸 that holds one or more <orgext:id> elements (see Section 3.1) to add organization roles that don't exist yet. 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.
  • An OPTIONAL <orgext:rem> element 🧚 that holds one or more <orgext:id> elements (see Section 3.1) to 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 one is provided.
  • An OPTIONAL <orgext:chg> element πŸ“ that holds one or more <orgext:id> elements (see Section 3.1) to change organization role identifiers for the object. The existing organization identifier value gets 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. no empty commands, bestie πŸ™ˆ

ok, examples time πŸ’– first up, an <update> command adding a reseller:

C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C:  <command>
C:    <update>
C:      <domain:update
C:        xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:        <domain:name>example.com</domain:name>
C:      </domain:update>
C:    </update>
C:    <extension>
C:      <orgext:update
C:        xmlns:orgext="urn:ietf:params:xml:ns:epp:orgext-1.0">
C:        <orgext:add>
C:          <orgext:id role="reseller">reseller1523</orgext:id>
C:        </orgext:add>
C:      </orgext:update>
C:    </extension>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

next, an <update> command adding multiple organizations πŸŽ€:

C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C:  <command>
C:    <update>
C:      <domain:update
C:        xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:        <domain:name>example.com</domain:name>
C:      </domain:update>
C:    </update>
C:    <extension>
C:      <orgext:update
C:        xmlns:orgext="urn:ietf:params:xml:ns:epp:orgext-1.0">
C:        <orgext:add>
C:          <orgext:id role="reseller">reseller1523</orgext:id>
C:          <orgext:id role="privacyproxy">proxy2935</orgext:id>
C:        </orgext:add>
C:      </orgext:update>
C:    </extension>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

now removing a reseller, an <update> command πŸ₯€:

C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C:  <command>
C:    <update>
C:      <domain:update
C:        xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:        <domain:name>example.com</domain:name>
C:      </domain:update>
C:    </update>
C:    <extension>
C:      <orgext:update
C:        xmlns:orgext="urn:ietf:params:xml:ns:epp:orgext-1.0">
C:        <orgext:rem>
C:          <orgext:id role="reseller"/>
C:        </orgext:rem>
C:      </orgext:update>
C:    </extension>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

and removing multiple organizations, also an <update> command 🌈:

C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C:  <command>
C:    <update>
C:      <domain:update
C:        xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:        <domain:name>example.com</domain:name>
C:      </domain:update>
C:    </update>
C:    <extension>
C:      <orgext:update
C:        xmlns:orgext="urn:ietf:params:xml:ns:epp:orgext-1.0">
C:        <orgext:rem>
C:          <orgext:id role="reseller"/>
C:          <orgext:id role="privacyproxy"/>
C:        </orgext:rem>
C:      </orgext:update>
C:    </extension>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

updating a reseller identifier, an <update> command ⭐:

C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C:  <command>
C:    <update>
C:      <domain:update
C:        xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:        <domain:name>example.com</domain:name>
C:      </domain:update>
C:    </update>
C:    <extension>
C:      <orgext:update
C:        xmlns:orgext="urn:ietf:params:xml:ns:epp:orgext-1.0">
C:        <orgext:chg>
C:          <orgext:id role="reseller">reseller1523</orgext:id>
C:        </orgext:chg>
C:      </orgext:update>
C:    </extension>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

last example, updating multiple organization identifiers at once πŸ‘‘:

C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C:  <command>
C:    <update>
C:      <domain:update
C:        xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:        <domain:name>example.com</domain:name>
C:      </domain:update>
C:    </update>
C:    <extension>
C:      <orgext:update
C:        xmlns:orgext="urn:ietf:params:xml:ns:epp:orgext-1.0">
C:        <orgext:chg>
C:          <orgext:id role="reseller">reseller1523</orgext:id>
C:          <orgext:id role="privacyproxy">proxy2935</orgext:id>
C:        </orgext:chg>
C:     </orgext:update>
C:    </extension>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

when an extended <update> command goes through successfully, the EPP response looks like whatever the EPP object extension says 🫢

if an <update> command can't be processed for any reason, an EPP error response MUST be returned 😭. if you try to add one organization ID, or several, with a particular role value and at least one of them already exists, the object doesn't change at all πŸ™…β€β™€οΈ. the server SHOULD tell clients that object relationships exist by sending a 2305 error response code. if you try to remove one organization ID, or several, with a particular role value and at least one of them doesn't exist, the object doesn't change at all either. the server SHOULD tell clients that object relationships do not exist by sending a 2305 error response code. same deal for changing: if you try to change one organization ID, or several, with a particular role value and at least one of them doesn't exist, nothing changes. the server SHOULD tell clients that object relationships do not exist by sending a 2305 error response code. the error response format with its error value elements is defined in Section 2.6 of [RFC5730] πŸ’€

5. Formal Syntax 🧾

an EPP object mapping is specified in XML Schema notation πŸŽ€. this formal syntax is a complete schema representation of the object mapping, so automated validation of EPP XML instances can use it πŸ’…. the BEGIN and END tags aren't part of the schema. they just mark where the schema starts and ends for URI registration purposes πŸ¦‹

BEGIN
<?xml version="1.0" encoding="UTF-8"?>

<schema
  targetNamespace="urn:ietf:params:xml:ns:epp:orgext-1.0"
  xmlns:orgext="urn:ietf:params:xml:ns:epp:orgext-1.0"
  xmlns="http://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified"
>

  <annotation>
    <documentation>
      Extensible Provisioning Protocol v1.0
      Organization Extension Schema v1.0
    </documentation>
  </annotation>
  <!-- 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"
      />
      <element
        name="rem"
        type="orgext:addRemChgType"
        minOccurs="0"
      />
      <element
        name="chg"
        type="orgext:addRemChgType"
        minOccurs="0"
      />
    </sequence>
  </complexType>

  <complexType name="addRemChgType">
    <sequence>
      <!-- Agent identifier of the organization,
        e.g., registrar, reseller, privacy proxy, etc. -->
      <element
        name="id"
        type="orgext:orgIdType"
        maxOccurs="unbounded"/>
    </sequence>
  </complexType>

  <!-- Child response element -->
  <element
    name="infData"
    type="orgext:infDataType"/>

  <!-- <orgext:infData> response elements -->
  <complexType name="infDataType">
    <sequence>
      <!-- Agent identifier the organization,
        e.g., registrar, reseller, privacy proxy, etc. -->
      <element
        name="id"
        type="orgext:orgIdType"
        minOccurs="0"
        maxOccurs="unbounded"/>
    </sequence>
  </complexType>

  <!-- End of schema -->
</schema>
END

6. Internationalization Considerations 🌍

EPP is written in XML, and XML natively handles info encoded with the Unicode character set [UNICODE] and its more compact forms, like UTF-8 🫧. conformant XML processors recognize both UTF-8 [RFC3629] and UTF-16 [RFC2781] πŸ’œ. XML does have a way to use other character encodings through an "encoding" attribute in the <?xml?> declaration, but using UTF-8 is RECOMMENDED ✨

as an extension of the EPP object mapping, the elements and element content in this document MUST inherit the internationalization conventions already used for the higher-layer domain and core protocol structures in any XML instance that includes this extension πŸ¦‹

7. IANA Considerations 🌸

7.1. XML Namespace πŸŽ€

okay so this section is where IANA hands out the XML namespace URNs for this extension. bestie, the URNs are the official names, so they have to stay exactly as written, character for character πŸ’… this document uses URNs to name XML namespaces and schemas that follow the registry mechanism from [RFC3688]. IANA assigned the two URIs below.

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). ✨

7.2. EPP Extension Registry πŸ¦‹

IANA also put this extension in the "Extensions for the Extensible Provisioning Protocol (EPP)" registry, which is described in [RFC7451]. here's the full registration entry, no cap 🧾

Name of Extension: Organization Extension for the Extensible
Provisioning Protocol (EPP)

Document Status: Standards Track

Reference: RFC 8544

Registrant Name and Email Address: IESG, iesg@ietf.org

TLDs: Any

IPR Disclosure: None

Status: Active

Notes: None

8. Security Considerations πŸ”

okay bestie, listen up, this part is serious 😭 the object mapping extension in this document doesn't give you any extra security services, and it doesn't add any new security concerns beyond the ones already covered in [RFC5730], [RFC5731], [RFC5732], and [RFC5733]. it also doesn't add anything beyond what the protocol layers underneath EPP already bring. so if you're worried about security, go read those four documents and the lower layers too, bestie 🫢


9. References πŸ“š

9.1. Normative References πŸ’œ

these are the references the spec leans on hard, so you need them to read this doc properly ✨ the entries are listed exactly as written:

[RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
           Requirement Levels", BCP 14, RFC 2119,
           DOI 10.17487/RFC2119, March 1997,
           <https://www.rfc-editor.org/info/rfc2119>.

[RFC3629]  Yergeau, F., "UTF-8, a transformation format of ISO
           10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November
           2003, <https://www.rfc-editor.org/info/rfc3629>.

[RFC3688]  Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
           DOI 10.17487/RFC3688, January 2004,
           <https://www.rfc-editor.org/info/rfc3688>.

[RFC5730]  Hollenbeck, S., "Extensible Provisioning Protocol (EPP)",
           STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009,
           <https://www.rfc-editor.org/info/rfc5730>.

[RFC5731]  Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
           Domain Name Mapping", STD 69, RFC 5731,
           DOI 10.17487/RFC5731, August 2009,
           <https://www.rfc-editor.org/info/rfc5731>.

[RFC5732]  Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
           Host Mapping", STD 69, RFC 5732, DOI 10.17487/RFC5732,
           August 2009, <https://www.rfc-editor.org/info/rfc5732>.

[RFC5733]  Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
           Contact Mapping", STD 69, RFC 5733, DOI 10.17487/RFC5733,
           August 2009, <https://www.rfc-editor.org/info/rfc5733>.

[RFC8174]  Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
           2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
           May 2017, <https://www.rfc-editor.org/info/rfc8174>.

[UNICODE]  The Unicode Consortium, "The Unicode Standard",
           <http://www.unicode.org/versions/latest/>.

[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>.

9.2. Informative References 🌸

these ones are just for background, so they're extra helpful but not required reading 🧚

[RFC2781]  Hoffman, P. and F. Yergeau, "UTF-16, an encoding of ISO
           10646", RFC 2781, DOI 10.17487/RFC2781, February 2000,
           <https://www.rfc-editor.org/info/rfc2781>.

[RFC7451]  Hollenbeck, S., "Extension Registry for the Extensible
           Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451,
           February 2015, <https://www.rfc-editor.org/info/rfc7451>.

[RFC8543]  Zhou, L., Kong, N., Yao, J., Gould, J., and G. Zhou,
           "Extensible Provisioning Protocol (EPP) Organization
           Mapping", RFC 8543, DOI 10.17487/RFC8543, March 2019,
           <https://www.rfc-editor.org/info/rfc8543>.

Acknowledgments 🫢

the authors want to thank Rik Ribbers, Marc Groeneweg, Patrick Mevzek, Antoin Verschuren, and Scott Hollenbeck for reviewing this carefully and leaving really valuable comments. they're literally the MVPs πŸ‘‘


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

Email: jgould@verisign.com
URI:   http://www.verisign.com

that's the whole RFC, bestie!! πŸŒˆπŸ’– the authors are all listed, the references are complete, and the registry details are exactly as written πŸ¦‹βœ¨

πŸ“¦ where this page comes from