RFC 4931

Extensible Provisioning Protocol (EPP) Domain Name Mapping

📅 published May 2007, from ietf

Extensible Provisioning Protocol (EPP) Domain Name Mapping 🎀

Okay bestie, this is RFC 4931 and it's the EPP domain name mapping, so it's all about how you manage domain names in a shared central repository 🌸

Here's the title block, the important facts first ✨

Author: S. Hollenbeck, VeriSign, Inc. 💅
Network Working Group
Date: May 2007 🦋
Category: Standards Track (it's an actual Internet standard, so it's giving official 👑)
Obsoletes: RFC 3731 (this one replaces it, so RFC 3731 is retired)
Updates: nothing listed in this block

Status of This Memo

This document is an Internet standards track protocol for the Internet community, and it's asking for discussion and suggestions for improvements 💜 If you want to know where this protocol stands in the standardization process, check the current edition of the "Internet Official Protocol Standards" (STD 1). Distribution of this memo is unlimited 🌈

Copyright Notice

Abstract

Okay so this document describes an Extensible Provisioning Protocol (EPP) mapping for provisioning and managing Internet domain names that live in a shared central repository 🍓 It's written in XML, and the mapping defines EPP command syntax and semantics as they apply to domain names. Also, this document obsoletes RFC 3731 💀

1.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  3
  1.1.  Relationship of Domain Objects and Host Objects  . . . . .  3
  1.2.  Conventions Used in This Document  . . . . . . . . . . . .  5
2.  Object Attributes  . . . . . . . . . . . . . . . . . . . . . .  5
  2.1.  Domain and Host Names  . . . . . . . . . . . . . . . . . .  5
  2.2.  Contact and Client Identifiers . . . . . . . . . . . . . .  5
  2.3.  Status Values  . . . . . . . . . . . . . . . . . . . . . .  5
  2.4.  Dates and Times  . . . . . . . . . . . . . . . . . . . . .  7
  2.5.  Validity Periods . . . . . . . . . . . . . . . . . . . . .  8
  2.6.  Authorization Information  . . . . . . . . . . . . . . . .  8
  2.7.  Other DNS Resource Record Attributes . . . . . . . . . . .  8
3.  EPP Command Mapping  . . . . . . . . . . . . . . . . . . . . .  9
  3.1.  EPP Query Commands . . . . . . . . . . . . . . . . . . . .  9
    3.1.1.  EPP <check> Command  . . . . . . . . . . . . . . . . .  9
    3.1.2.  EPP <info> Command . . . . . . . . . . . . . . . . . . 11
    3.1.3.  EPP <transfer> Query Command . . . . . . . . . . . . . 15
  3.2.  EPP Transform Commands . . . . . . . . . . . . . . . . . . 17
    3.2.1.  EPP <create> Command . . . . . . . . . . . . . . . . . 18
    3.2.2.  EPP <delete> Command . . . . . . . . . . . . . . . . . 20
    3.2.3.  EPP <renew> Command  . . . . . . . . . . . . . . . . . 21
    3.2.4.  EPP <transfer> Command . . . . . . . . . . . . . . . . 23
    3.2.5.  EPP <update> Command . . . . . . . . . . . . . . . . . 25
  3.3.  Offline Review of Requested Actions  . . . . . . . . . . . 28
4.  Formal Syntax  . . . . . . . . . . . . . . . . . . . . . . . . 31
5.  Internationalization Considerations  . . . . . . . . . . . . . 40
6.  IANA Considerations  . . . . . . . . . . . . . . . . . . . . . 40
7.  Security Considerations  . . . . . . . . . . . . . . . . . . . 41
8.  Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 41
9.  References . . . . . . . . . . . . . . . . . . . . . . . . . . 42
  9.1.  Normative References . . . . . . . . . . . . . . . . . . . 42
  9.2.  Informative References . . . . . . . . . . . . . . . . . . 43
Appendix A.  Changes from RFC 3731 . . . . . . . . . . . . . . . . 44

1. Introduction ✨

This document describes an Internet domain name mapping for version 1.0 of the Extensible Provisioning Protocol (EPP) 🦋 The mapping is specified using the Extensible Markup Language (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]. This document obsoletes RFC 3731 [RFC3731].

[RFC4930] gives you the full picture of EPP command and response structures. Honestly, you need a solid understanding of the base protocol spec to get this mapping, so go read that first 🧚

XML is case sensitive 🙈 Unless stated otherwise, XML specifications and examples in this document MUST be interpreted in the character case presented, so you can build a conforming implementation.

1.1. Relationship of Domain Objects and Host Objects

The EPP mapping for host objects is described in [RFC4932]. This document assumes domain name objects have a superordinate relationship to subordinate host name objects. For example, the domain name example.com has a superordinate relationship to the host name ns1.example.com. EPP actions (like object transfers) that don't preserve this relationship MUST be explicitly disallowed 🚫

A host name object can be created in a repository where no superordinate domain name object exists. For example, the host name ns1.example.com can be created in the .example repository so DNS domains in .example can be delegated to that host. These hosts are described as "external" hosts in this specification, since the host's name doesn't belong to the name space of the repository where it's being used for delegation 💅

Whether a host is external or internal depends on the repository where it's being used for delegation. Whether or not an internal host is subordinate depends on a domain within the repository. For example, host ns1.example1.com is a subordinate host of domain example1.com, but it is not a subordinate host of domain example2.com. ns1.example1.com can be used as a name server for example2.com. In this case, ns1.example1.com MUST be treated as an internal host, and it's subject to the rules governing operations on subordinate hosts within the same repository 🫶

Name server hosts for domain delegation can be specified either as references to existing host objects, or as domain attributes that describe a host machine. A server operator MUST use one name server specification form consistently 🎀 A server operator that announces support for host objects in an EPP greeting MUST NOT allow domain attributes to describe a name server host machine. A server operator that does not announce support for host objects MUST allow domain attributes to describe a name server host machine. When domain attributes are used to describe a name server host machine, IP addresses SHOULD be required only as needed to generate DNS glue records 🍓

Name servers are specified within a <domain:ns> element. This element MUST contain one or more <domain:hostObj> elements or one or more <domain:hostAttr> elements. A <domain:hostObj> element contains the fully qualified name of a known name server host object. A <domain:hostAttr> element contains the following child elements:

A <domain:hostName> element that contains the fully qualified name of a host.
Zero or more OPTIONAL <domain:hostAddr> elements that contain the IP addresses to be associated with the host. Each element MAY contain an ip attribute to identify the IP address format. The attribute value v4 is used to note IPv4 address format. The attribute value v6 is used to note IPv6 address format. If the ip attribute is not specified, v4 is the default attribute value. IP address syntax requirements are described in Section 2.5 of the EPP host mapping [RFC4932].

Here's an example of host object name server elements for the domain example.com:

<domain:ns>
  <domain:hostObj>ns1.example.com</domain:hostObj>
  <domain:hostObj>ns1.example.net</domain:hostObj>
</domain:ns>

And here's an example of host attribute name server elements for the domain example.com:

<domain:ns>
  <domain:hostAttr>
    <domain:hostName>ns1.example.com</domain:hostName>
    <domain:hostAddr
     ip="v4">192.0.2.2</domain:hostAddr>
    <domain:hostAddr
     ip="v6">1080:0:0:0:8:800:200C:417A</domain:hostAddr>
  </domain:hostAttr>
  <domain:hostAttr>
    <domain:hostName>ns1.example.net</domain:hostName>
  </domain:hostAttr>
</domain:ns>

1.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 only there to show how elements relate, and they are not a REQUIRED feature of this protocol 💖

2. Object Attributes 🌈

An EPP domain object has attributes and associated values that can be viewed and modified by the sponsoring client or the server. This section describes each attribute type in detail. The formal syntax for the attribute values described here can be found in the "Formal Syntax" section of this document and in the appropriate normative references 📚

2.1. Domain and Host Names

The syntax for domain and host names described in this document MUST conform to [RFC0952] as updated by [RFC1123] 🌸 At the time of writing, RFC 3490 [RFC3490] describes a standard for using certain ASCII name labels to represent non-ASCII name labels. These conformance requirements might change as a result of progressing work on standards for internationalized domain names. A server MAY restrict allowable domain names to a particular top-level domain, second-level domain, or other domain for which the server is authoritative. The trailing dot required when these names are stored in a DNS zone is implicit, and it MUST NOT be provided when exchanging host and domain names 🙅‍♀️

2.2. Contact and Client Identifiers

All EPP contacts are identified by a server-unique identifier 🔥 Contact identifiers are character strings with a specified minimum length, a specified maximum length, and a specified format. Contact identifiers use the "clIDType" client identifier syntax described in [RFC4930] ✨

2.3. Status Values ✨

Okay so every domain object MUST always have at least one status value attached, no exceptions 💅 Only the client that sponsors the object and the server it lives on can set status values. Clients can change them with the EPP <update> command 🎀 Each status value MAY come with a bit of human-readable text explaining why it was applied, which is so iconic of the server to share the tea 🫶

A client MUST NOT alter status values that the server set. Server-side, a server MAY alter or override status values a client set, but that's subject to local server policies 👑 And the status of an object MAY change because of either a client-initiated transform command or something a server operator did 🦋

Status values that a client can add or remove start with "client" (client), and the server-side versions that the server can add or remove start with "server" (server) 🌸 Anything that doesn't start with either one is server-managed 💜

Status Value Descriptions:

clientDeleteProhibited, serverDeleteProhibited

Requests to delete the object MUST be rejected. 🙈

clientHold, serverHold

DNS delegation information MUST NOT be published for the object. 💀

clientRenewProhibited, serverRenewProhibited

Requests to renew the object MUST be rejected.

clientTransferProhibited, serverTransferProhibited

Requests to transfer the object MUST be rejected. 🔥

clientUpdateProhibited, serverUpdateProhibited

Requests to update the object (other than to remove this status) MUST be rejected.

inactive

Delegation information has not been associated with the object. 🥀

ok

This is the normal status for an object with no pending operations or prohibitions ✨ The server sets and removes this one by itself as the other status values get added or removed.

pendingCreate, pendingDelete, pendingRenew, pendingTransfer, pendingUpdate

A transform command has been processed for the object, but the server hasn't finished the action yet. Server operators can delay completion for all sorts of reasons, like letting a human review it or waiting on a third party 🧚 A transform command that gets processed but has a pending requested action comes back with response code 1001.

When the requested action is finished, the pendingCreate, pendingDelete, pendingRenew, pendingTransfer, or pendingUpdate status value MUST be removed 🌈 Every client that was involved in the transaction MUST be notified with a service message saying the action is complete and the object's status has changed. Main character update, honestly 👑

ok status MUST NOT be combined with any other status. Nope, not even a little 🙅

pendingDelete status MUST NOT be combined with either clientDeleteProhibited or serverDeleteProhibited status. 💅

pendingRenew status MUST NOT be combined with either clientRenewProhibited or serverRenewProhibited status.

pendingTransfer status MUST NOT be combined with either clientTransferProhibited or serverTransferProhibited status.

pendingUpdate status MUST NOT be combined with either clientUpdateProhibited or serverUpdateProhibited status.

The pendingCreate, pendingDelete, pendingRenew, pendingTransfer, and pendingUpdate status values MUST NOT be combined with each other. Pending vibes only, one at a time 🫠

Any other status combinations that aren't expressly prohibited MAY be used 🌷

2.4. Dates and Times ⏰

Date and time attribute values MUST be represented in Universal Coordinated Time (UTC) using the Gregorian calendar 🌍 The extended date-time form, with upper case "T" and "Z" characters, is defined in [W3C.REC-xmlschema-2-20041028] and it MUST be used to represent date-time values. The reason is that XML Schema doesn't support truncated date-time forms or lower case "T" and "Z" characters, so no cap, it has to be this exact way 💖

2.5. Validity Periods 🗓️

A domain name object MAY have a specified validity period. If server policy supports domain object validity periods, the period gets defined when the domain object is created, and it MAY be extended by the EPP <renew> or <transfer> commands 🦋 As a matter of server policy, this specification does not define any actions to take when a domain object's validity period expires. That's between the server and its policy, bestie 🤷

Validity periods are measured in years or months, and the unit gets specified with the unit attribute 🌸 The valid values for unit are "y" for years and "m" for months. The minimum allowable period value is 1. The maximum allowable value is 99. A server MAY support a lower maximum value 🎀

2.6. Authorization Information 🔐

Authorization information is attached to domain objects so transfer operations can happen smoothly ✨ It gets assigned when the domain object is created, and it might be updated later on. This specification describes password-based authorization information, though other mechanisms are possible 🗝️

2.7. Other DNS Resource Record Attributes 🧁

The DNS lets lots of resource record types be associated with a domain, but this mapping only explicitly specifies the elements that describe resource records used for domain delegation and resolution 💜 If you want to provision other domain-related resource record types, you can develop that by extending this mapping 🌈

The provisioning method in this mapping separates discrete data elements by data type. That's lowkey genius, because it lets XML Schema processors do basic syntax validation, which cuts down on ambiguity and on the amount of parsing and syntax checking that protocol processors have to do 🧠 Provisioning and extension methods that bundle data into opaque strings are possible, but they SHOULD NOT be used, because they pile on extra parsing, interpretation, and validation requirements for protocol processors 🙃

3. EPP Command Mapping 📮

A detailed description of the EPP syntax and semantics can be found in [RFC4930] 📖 The command mappings here are specifically for provisioning and managing Internet domain names via EPP ✨

3.1. EPP Query Commands 🔍

EPP gives you three commands to retrieve domain information. There's <check>, which figures out if a domain object can be provisioned within a repository. There's <info>, which retrieves detailed information about a domain object. And there's <transfer>, which retrieves domain object transfer status information 💅

3.1.1. EPP <check> Command 💫

The EPP <check> command is used to find out if an object can be provisioned within a repository 🔎 It gives you a hint so you can anticipate whether provisioning an object with the <create> command will succeed or fail. Object provisioning requirements are ultimately a matter of server policy, so the hint isn't a guarantee, babe 🫶

In addition to the standard EPP command elements, the <check> command MUST contain a <domain:check> element that identifies the domain namespace. The <domain:check> element contains the following child elements:

One or more <domain:name> elements that contain the fully qualified names of the domain objects to be queried. 🎀

Example <check> 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:    <check>
C:      <domain:check
C:       xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:        <domain:name>example.com</domain:name>
C:        <domain:name>example.net</domain:name>
C:        <domain:name>example.org</domain:name>
C:      </domain:check>
C:    </check>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

When a <check> command has been processed successfully, the EPP <resData> element MUST contain a child <domain:chkData> element that identifies the domain namespace 🌸 The <domain:chkData> element contains one or more <domain:cd> elements, and each of those contains the following child elements:

A <domain:name> element that contains the fully qualified name of the queried domain object. This element MUST contain an avail attribute whose value indicates object availability (whether it can be provisioned or not) at the moment the <check> command was completed. A value of "1" or "true" means that the object can be provisioned. A value of "0" or "false" means that the object can not be provisioned. 🥹
An OPTIONAL <domain:reason> element that MAY be provided when an object cannot be provisioned. If it's present, this element contains server-specific text to help explain why the object can't be provisioned. This text MUST be represented in the response language previously negotiated with the client. An OPTIONAL lang attribute MAY be present to identify the language if the negotiated value is something other than the default value of "en" (English) 🌍

Example <check> response:

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>Command completed successfully</msg>
S:    </result>
S:    <resData>
S:      <domain:chkData
S:       xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S:        <domain:cd>
S:          <domain:name avail="1">example.com</domain:name>
S:        </domain:cd>
S:        <domain:cd>
S:          <domain:name avail="0">example.net</domain:name>
S:          <domain:reason>In use</domain:reason>
S:        </domain:cd>
S:        <domain:cd>
S:          <domain:name avail="1">example.org</domain:name>
S:        </domain:cd>
S:      </domain:chkData>
S:    </resData>
S:    <trID>
S:      <clTRID>ABC-12345</clTRID>
S:      <svTRID>54322-XYZ</svTRID>
S:    </trID>
S:  </response>
S:</epp>

An EPP error response MUST be returned if a <check> command can't be processed for any reason. No excuses, it's giving strict 🚨

3.1.2. EPP <info> Command ✨

okay so the EPP <info> command is how you go fishing for everything the server knows about a domain object 🦋 the answer you get back MAY vary depending on who's asking, whether they bring authorization information, and what the server's policy says about unauthorized clients 💅 if you're the sponsoring client, you get ALL the available info, no cap 👑 if you're not the sponsoring client BUT you show valid authorization information, you ALSO get all the available info 🫶 if you're not the sponsoring client and your authorization info is missing or invalid, the server policy decides which OPTIONAL elements you get back 💀

in addition to the standard EPP command elements, the <info> command MUST contain a <domain:info> element that identifies the domain namespace 🎀 that <domain:info> element has these child elements:

a <domain:name> element that holds the fully qualified name of the domain object you're querying 💖 there's also an OPTIONAL "hosts" attribute that controls which host information comes back 🌸 "all" is the default (and the attribute MAY be left off completely) and gives you info on both subordinate and delegated hosts ✨ "del" gives you ONLY delegated hosts 🍓 "sub" gives you ONLY subordinate hosts 🧚 and "none" gives you zero info about delegated or subordinate hosts 🙈
an OPTIONAL <domain:authInfo> element that carries authorization information for the domain object, or for its registrant or associated contacts 🔥 the OPTIONAL "roid" attribute MUST be used to point at the registrant or contact object if and only if the authInfo belongs to that registrant or contact, and NOT to the domain object itself 🫶 if you don't send this element at all, or the authorization info is invalid, the server policy decides whether your command gets rejected or whether you still get response info back 💅

here are two example <info> commands, one without authorization information and one with it:

C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C:  <command>
C:    <info>
C:      <domain:info
C:       xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:        <domain:name hosts="all">example.com</domain:name>
C:      </domain:info>
C:    </info>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C:  <command>
C:    <info>
C:      <domain:info
C:       xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:        <domain:name hosts="all">example.com</domain:name>
C:        <domain:authInfo>
C:          <domain:pw>2fooBAR</domain:pw>
C:        </domain:authInfo>
C:      </domain:info>
C:    </info>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

when an <info> command goes through successfully, the EPP <resData> element MUST contain a child <domain:infData> element that identifies the domain namespace 🌈 the rule is: anything that isn't OPTIONAL MUST come back 💖 the OPTIONAL stuff only shows up based on your authorization and the server's policy 🧚 the <domain:infData> element has these child elements:

a <domain:name> element with the fully qualified name of the domain object 🎀
a <domain:roid> element with the Repository Object IDentifier that was assigned when the domain object got created 🦋
zero or more OPTIONAL <domain:status> elements with the current status descriptors for the domain 🌸
if the server supports it, one OPTIONAL <domain:registrant> element and one or more OPTIONAL <domain:contact> elements with the identifiers for the human or organizational social information objects tied to the domain object 👑
an OPTIONAL <domain:ns> element with the fully qualified names of the delegated host objects or host attributes (name servers) linked to the domain object 💅 see Section 1.1 for how host objects and host attributes get specified 📖
zero or more OPTIONAL <domain:host> elements with the fully qualified names of the subordinate host objects that live under this superordinate domain object 🍓
a <domain:clID> element with the identifier of the sponsoring client 🫶
an OPTIONAL <domain:crID> element with the identifier of the client that created the domain object ✨
an OPTIONAL <domain:crDate> element with the date and time the domain object was created 🕰️
an OPTIONAL <domain:exDate> element with the date and time that marks the end of the domain object's registration period 💀
an OPTIONAL <domain:upID> element with the identifier of the client that last updated the domain object 🙈 this element MUST NOT be present if the domain has never been modified ✋
an OPTIONAL <domain:upDate> element with the date and time of the most recent domain object modification 🔥 this element MUST NOT be present if the domain object has never been modified 🙅‍♀️
an OPTIONAL <domain:trDate> element with the date and time of the most recent successful domain object transfer 🦋 this element MUST NOT be provided if the domain object has never been transferred 🛑
an OPTIONAL <domain:authInfo> element with the authorization information for the domain object 🔐 this element MUST only be returned if the querying client is the current sponsoring client, or if the client gave valid authorization information with the command 💖

here's what an authorized client gets back:

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>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="tech">sh8013</domain:contact>
S:        <domain:ns>
S:          <domain:hostObj>ns1.example.com</domain:hostObj>
S:          <domain:hostObj>ns1.example.net</domain:hostObj>
S:        </domain:ns>
S:        <domain:host>ns1.example.com</domain:host>
S:        <domain:host>ns2.example.com</domain:host>
S:        <domain:clID>ClientX</domain:clID>
S:        <domain:crID>ClientY</domain:crID>
S:        <domain:crDate>1999-04-03T22:00:00.0Z</domain:crDate>
S:        <domain:upID>ClientX</domain:upID>
S:        <domain:upDate>1999-12-03T09:00:00.0Z</domain:upDate>
S:        <domain:exDate>2005-04-03T22:00:00.0Z</domain:exDate>
S:        <domain:trDate>2000-04-08T09:00:00.0Z</domain:trDate>
S:        <domain:authInfo>
S:          <domain:pw>2fooBAR</domain:pw>
S:        </domain:authInfo>
S:      </domain:infData>
S:    </resData>
S:    <trID>
S:      <clTRID>ABC-12345</clTRID>
S:      <svTRID>54322-XYZ</svTRID>
S:    </trID>
S:  </response>
S:</epp>

a server with a different information return policy MAY send back less information in its response 🤷‍♀️ that's just how it goes 💅

and here's what an unauthorized client gets:

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>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:clID>ClientX</domain:clID>
S:      </domain:infData>
S:    </resData>
S:    <trID>
S:      <clTRID>ABC-12345</clTRID>
S:      <svTRID>54322-XYZ</svTRID>
S:    </trID>
S:  </response>
S:</epp>

⚠️ if an <info> command can't be processed for ANY reason, the server MUST return an EPP error response 🚨 no exceptions, bestie 😭

3.1.3. EPP <transfer> Query Command ✨

okay so the EPP <transfer> command has a query operation that lets a client check the real-time status of pending and finished transfer requests 👀 🦋 In addition to the standard EPP command elements, the <transfer> command MUST contain an "op" attribute with value "query", and a <domain:transfer> element that identifies the domain namespace. 💅 The <domain:transfer> element has these child elements:

A <domain:name> element that contains the fully qualified name of the domain object being queried. 🎀
An OPTIONAL <domain:authInfo> element that contains authorization information tied to the domain object, or authorization information tied to the domain object's registrant or associated contacts. 🫶 An OPTIONAL "roid" attribute MUST be used to identify the registrant or contact object if and only if the given authInfo is associated with a registrant or contact object, and not the domain object itself. If this element isn't provided, or if the authorization information is invalid, server policy decides whether the command gets rejected or whether response information is returned to the client. 🙈

Example <transfer> query 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:    <transfer op="query">
C:      <domain:transfer
C:       xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:        <domain:name>example.com</domain:name>
C:        <domain:authInfo>
C:          <domain:pw roid="JD1234-REP">2fooBAR</domain:pw>
C:        </domain:authInfo>
C:      </domain:transfer>
C:    </transfer>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

When a <transfer> query command has been processed successfully, the EPP <resData> element MUST contain a child <domain:trnData> element that identifies the domain namespace. 🧚 The <domain:trnData> element has these child elements:

A <domain:name> element that contains the fully qualified name of the domain object. 💖
A <domain:trStatus> element that contains the state of the most recent transfer request. ⭐
A <domain:reID> element that contains the identifier of the client that requested the object transfer. 🍓
A <domain:reDate> element that contains the date and time that the transfer was requested. 🌈
A <domain:acID> element that contains the identifier of the client that SHOULD act upon a PENDING transfer request. For all other status types, the value identifies the client that took the indicated action. 👑
A <domain:acDate> element that contains the date and time of a required or completed response. For a PENDING request, the value identifies the date and time by which a response is required before an automated response action will be taken by the server. For all other status types, the value identifies the date and time when the request was completed. 🔥
An OPTIONAL <domain:exDate> element that contains the end of the domain object's validity period if the <transfer> command caused or causes a change in the validity period. 🦋

Example <transfer> query response: 💜

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>Command completed successfully</msg>
S:    </result>
S:    <resData>
S:      <domain:trnData
S:       xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S:        <domain:name>example.com</domain:name>
S:        <domain:trStatus>pending</domain:trStatus>
S:        <domain:reID>ClientX</domain:reID>
S:        <domain:reDate>2000-06-06T22:00:00.0Z</domain:reDate>
S:        <domain:acID>ClientY</domain:acID>
S:        <domain:acDate>2000-06-11T22:00:00.0Z</domain:acDate>
S:        <domain:exDate>2002-09-08T22:00:00.0Z</domain:exDate>
S:      </domain:trnData>
S:    </resData>
S:    <trID>
S:      <clTRID>ABC-12345</clTRID>
S:      <svTRID>54322-XYZ</svTRID>
S:    </trID>
S:  </response>
S:</epp>

An EPP error response MUST be returned if a <transfer> query command cannot be processed for any reason. 😭

3.2. EPP Transform Commands ✨

EPP gives us five commands to transform domain objects! 🌈 <create> makes a domain object, <delete> deletes one, <renew> extends the validity period of a domain object, <transfer> manages sponsorship changes, and <update> changes the info attached to a domain object. 💅

Transform commands are usually processed and completed in real time. ⏱️ Server operators MAY receive and process transform commands, but defer completing the requested action if human or third-party review is required before it can be completed. 🙌 In those situations the server MUST return a 1001 response code to the client to note that the command has been received and processed, but the requested action is pending. ⏳ The server MUST also manage the status of the object that is the subject of the command so it reflects the start and finish of the requested action. 🔥 Once the action is completed, all clients involved in the transaction MUST be notified using a service message that the action has been completed and that the status of the object has changed. 📣

3.2.1. EPP <create> Command ✨

The EPP <create> command is the transform operation that lets a client create a domain object. 🎀 In addition to the standard EPP command elements, the <create> command MUST contain a <domain:create> element that identifies the domain namespace. The <domain:create> element has these child elements:

A <domain:name> element that contains the fully qualified name of the domain object to be created. 💖
An OPTIONAL <domain:period> element that contains the initial registration period of the domain object. A server MAY define a default initial registration period if the client doesn't specify one. 🦋
An OPTIONAL <domain:ns> element that contains the fully qualified names of the delegated host objects or host attributes (name servers) associated with the domain object to provide resolution services for the domain. See Section 1.1 for a description of the elements used to specify host objects or host attributes. A host object MUST be known to the server before it can be associated with a domain object. 🧚
An OPTIONAL <domain:registrant> element that contains the identifier for the human or organizational social information (contact) object to be associated with the domain object as the object registrant. This object identifier MUST be known to the server before the contact object can be associated with the domain object. The EPP mapping for contact objects is described in [RFC4933]. 🌸
Zero or more OPTIONAL <domain:contact> elements that contain the identifiers for other contact objects to be associated with the domain object. Contact object identifiers MUST be known to the server before the contact object can be associated with the domain object. ⭐
A <domain:authInfo> element that contains authorization information to be associated with the domain object. This mapping includes a password-based authentication mechanism, but the schema allows new mechanisms to be defined in new schemas. 🔐

Example <create> 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:    <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">2</domain:period>
C:        <domain:ns>
C:          <domain:hostObj>ns1.example.com</domain:hostObj>
C:          <domain:hostObj>ns1.example.net</domain:hostObj>
C:        </domain:ns>
C:        <domain:registrant>jd1234</domain:registrant>
C:        <domain:contact type="admin">sh8013</domain:contact>
C:        <domain:contact type="tech">sh8013</domain:contact>
C:        <domain:authInfo>
C:          <domain:pw>2fooBAR</domain:pw>
C:        </domain:authInfo>
C:      </domain:create>
C:    </create>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

When a <create> command has been processed successfully, the EPP <resData> element MUST contain a child <domain:creData> element that identifies the domain namespace. 🎉 The <domain:creData> element has these child elements:

A <domain:name> element that contains the fully qualified name of the domain object. 💖
A <domain:crDate> element that contains the date and time of domain object creation. 📅
An OPTIONAL <domain:exDate> element that contains the date and time identifying the end of the domain object's registration period. ✨

Example <create> response: 🦋

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>Command completed successfully</msg>
S:    </result>
S:    <resData>
S:      <domain:creData
S:       xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S:        <domain:name>example.com</domain:name>
S:        <domain:crDate>1999-04-03T22:00:00.0Z</domain:crDate>
S:        <domain:exDate>2001-04-03T22:00:00.0Z</domain:exDate>
S:      </domain:creData>
S:    </resData>
S:    <trID>
S:      <clTRID>ABC-12345</clTRID>
S:      <svTRID>54321-XYZ</svTRID>
S:    </trID>
S:  </response>
S:</epp>

An EPP error response MUST be returned if a <create> command cannot be processed for any reason. 💀

3.2.2. EPP <delete> Command 🗑️

Okay bestie, the EPP <delete> command is a transform operation that lets a client delete a domain object 💅 Besides the standard EPP command elements, the <delete> command MUST contain a <domain:delete> element that identifies the domain namespace. That element has one child:

A <domain:name> element that contains the fully qualified name of the domain object to be deleted.

Now the main tea ☕ A domain object SHOULD NOT be deleted if subordinate host objects are associated with it 🙈 Say domain "example.com" exists and host object "ns1.example.com" also exists. Then "example.com" SHOULD NOT be deleted until "ns1.example.com" has been either deleted or renamed to exist in a different superordinate domain. A server SHOULD let clients know these object relationships exist by sending a 2305 error response code when a <delete> command is attempted and fails because of them. You can find the delegated and subordinate host objects tied to a domain by using the <info> query command on that domain object 🔍

Example <delete> 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:    <delete>
C:      <domain:delete
C:       xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:        <domain:name>example.com</domain:name>
C:      </domain:delete>
C:    </delete>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

When a <delete> command has been processed successfully, a server MUST respond with an EPP response with no <resData> element. Slay 💖

Example <delete> response:

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>Command completed successfully</msg>
S:    </result>
S:    <trID>
S:      <clTRID>ABC-12345</clTRID>
S:      <svTRID>54321-XYZ</svTRID>
S:    </trID>
S:  </response>
S:</epp>

An EPP error response MUST be returned if a <delete> command cannot be processed for any reason. No exceptions, no cap 🚨

3.2.3. EPP <renew> Command 🔁

The EPP <renew> command is a transform operation that lets a client extend the validity period of a domain object 🦋 Along with the standard EPP command elements, the <renew> command MUST contain a <domain:renew> element that identifies the domain namespace. That element has these child elements:

A <domain:name> element that contains the fully qualified name of the domain object whose validity period is to be extended.
A <domain:curExpDate> element that contains the date on which the current validity period ends. This is the trick that keeps repeated <renew> commands from producing multiple unanticipated successful renewals 🧠
An OPTIONAL <domain:period> element that contains the number of units to be added to the registration period of the domain object. The number of units available MAY be subject to limits imposed by the server.

Example <renew> 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:    <renew>
C:      <domain:renew
C:       xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:        <domain:name>example.com</domain:name>
C:        <domain:curExpDate>2000-04-03</domain:curExpDate>
C:        <domain:period unit="y">5</domain:period>
C:      </domain:renew>
C:    </renew>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

When a <renew> command has been processed successfully, the EPP <resData> element MUST contain a child <domain:renData> element that identifies the domain namespace. That element has these child elements:

A <domain:name> element that contains the fully qualified name of the domain object.
An OPTIONAL <domain:exDate> element that contains the date and time identifying the end of the domain object's registration period 📅

Example <renew> response:

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>Command completed successfully</msg>
S:    </result>
S:    <resData>
S:      <domain:renData
S:       xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S:        <domain:name>example.com</domain:name>
S:        <domain:exDate>2005-04-03T22:00:00.0Z</domain:exDate>
S:      </domain:renData>
S:    </resData>
S:    <trID>
S:      <clTRID>ABC-12345</clTRID>
S:      <svTRID>54322-XYZ</svTRID>
S:    </trID>
S:  </response>
S:</epp>

An EPP error response MUST be returned if a <renew> command cannot be processed for any reason. Iconic energy only 👑

3.2.4. EPP <transfer> Command 🌸

The EPP <transfer> command is a transform operation that lets a client manage requests to transfer the sponsorship of a domain object 🧚 Along with the standard EPP command elements, the <transfer> command MUST contain a <domain:transfer> element that identifies the domain namespace. That element has these child elements:

A <domain:name> element that contains the fully qualified name of the domain object for which a transfer request is to be created, approved, rejected, or cancelled.
An OPTIONAL <domain:period> element that contains the number of units to be added to the registration period of the domain object at completion of the transfer process. This element can only be used when a transfer is requested, and it MUST be ignored if used otherwise. The number of units available MAY be subject to limits imposed by the server.
A <domain:authInfo> element that contains authorization information associated with the domain object, or authorization information associated with the domain object's registrant or associated contacts. An OPTIONAL "roid" attribute MUST be used to identify the registrant or contact object if and only if the given authInfo is associated with a registrant or contact object, and not the domain object itself 🔐

Every EPP <transfer> command MUST contain an "op" attribute that identifies the transfer operation to be performed. Valid values, definitions, and authorizations for all attribute values are defined in [RFC4930] 📖

Transfer of a domain object MUST implicitly transfer all host objects that are subordinate to the domain object. For example, if domain object "example.com" is transferred and host object "ns1.example.com" exists, the host object MUST be transferred as part of the "example.com" transfer process. The host objects that are subject to transfer when a domain object is transferred are listed in the response to an EPP <info> command performed on the domain object 🫶

Example <transfer> request 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:    <transfer op="request">
C:      <domain:transfer
C:       xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:        <domain:name>example.com</domain:name>
C:        <domain:period unit="y">1</domain:period>
C:        <domain:authInfo>
C:          <domain:pw roid="JD1234-REP">2fooBAR</domain:pw>
C:        </domain:authInfo>
C:      </domain:transfer>
C:    </transfer>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

When a <transfer> command has been processed successfully, the EPP <resData> element MUST contain a child <domain:trnData> element that identifies the domain namespace. The <domain:trnData> element contains the same child elements defined for a transfer query response 📦

Example <transfer> response:

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="1001">
S:      <msg>Command completed successfully; action pending</msg>
S:    </result>
S:    <resData>
S:      <domain:trnData
S:       xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S:        <domain:name>example.com</domain:name>
S:        <domain:trStatus>pending</domain:trStatus>
S:        <domain:reID>ClientX</domain:reID>
S:        <domain:reDate>2000-06-08T22:00:00.0Z</domain:reDate>
S:        <domain:acID>ClientY</domain:acID>
S:        <domain:acDate>2000-06-13T22:00:00.0Z</domain:acDate>
S:        <domain:exDate>2002-09-08T22:00:00.0Z</domain:exDate>
S:      </domain:trnData>
S:    </resData>
S:    <trID>
S:      <clTRID>ABC-12345</clTRID>
S:      <svTRID>54322-XYZ</svTRID>
S:    </trID>
S:  </response>
S:</epp>

An EPP error response MUST be returned if a <transfer> command can not be processed for any reason. Not me being serious about this one 💀

3.2.5. EPP <update> Command ✨

okay bestie, the EPP <update> command is the glow-up move 💅 It's a transform operation that lets a client modify the attributes of a domain object. Besides the standard EPP command elements, the <update> command MUST contain a <domain:update> element that identifies the domain namespace. That <domain:update> element has these child elements:

A <domain:name> element that contains the fully qualified name of the domain object to be updated.
An OPTIONAL <domain:add> element that contains attribute values to be added to the object.
An OPTIONAL <domain:rem> element that contains attribute values to be removed from the object.
An OPTIONAL <domain:chg> element that contains object attribute values to be changed.

At least one <domain:add>, <domain:rem>, or <domain:chg> element MUST be provided if the command is not being extended. All of these elements MAY be omitted if an <update> extension is present. The <domain:add> and <domain:rem> elements contain the following child elements:

An OPTIONAL <domain:ns> element that contains the fully qualified names of the delegated host objects or host attributes (name servers) associated with the domain object to provide resolution services for the domain. See Section 1.1 for a description of the elements used to specify host objects or host attributes. A host object MUST be known to the server before the host object can be associated with a domain object. If host attributes are used to specify name servers, note that IP address elements are not needed to identify a name server that is being removed. IP address elements can safely be absent or ignored in this situation. 🌸
Zero or more <domain:contact> elements that contain the identifiers for contact objects to be associated with or removed from the domain object. Contact object identifiers MUST be known to the server before the contact object can be associated with the domain object. 🫶
Zero or more <domain:status> elements that contain status values to be applied to or removed from the object. When specifying a value to be removed, only the attribute value is significant. Element text is not required to match a value for removal. 🎀

A <domain:chg> element contains the following child elements:

A <domain:registrant> element that contains the identifier for the human or organizational social information (contact) object to be associated with the domain object as the object registrant. This object identifier MUST be known to the server before the contact object can be associated with the domain object. An empty element can be used to remove registrant information. 🦋
A <domain:authInfo> element that contains authorization information associated with the domain object. This mapping includes a password-based authentication mechanism, but the schema allows new mechanisms to be defined in new schemas. A <domain:null> element can be used within the <domain:authInfo> element to remove authorization information. 🔐

Example <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:add>
C:          <domain:ns>
C:            <domain:hostObj>ns2.example.com</domain:hostObj>
C:          </domain:ns>
C:          <domain:contact type="tech">mak21</domain:contact>
C:          <domain:status s="clientHold"
C:           lang="en">Payment overdue.</domain:status>
C:        </domain:add>
C:        <domain:rem>
C:          <domain:ns>
C:            <domain:hostObj>ns1.example.com</domain:hostObj>
C:          </domain:ns>
C:          <domain:contact type="tech">sh8013</domain:contact>
C:          <domain:status s="clientUpdateProhibited"/>
C:        </domain:rem>
C:        <domain:chg>
C:          <domain:registrant>sh8013</domain:registrant>
C:          <domain:authInfo>
C:            <domain:pw>2BARfoo</domain:pw>
C:          </domain:authInfo>
C:        </domain:chg>
C:      </domain:update>
C:    </update>
C:    <clTRID>ABC-12345</clTRID>
C:  </command>
C:</epp>

When an <update> command has been processed successfully, a server MUST respond with an EPP response with no <resData> element. ✅

Example <update> response:

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>Command completed successfully</msg>
S:    </result>
S:    <trID>
S:      <clTRID>ABC-12345</clTRID>
S:      <svTRID>54321-XYZ</svTRID>
S:    </trID>
S:  </response>
S:</epp>

🚨 An EPP error response MUST be returned if an <update> command cannot be processed for any reason. No excuses, no ghosting, the server always answers. 💀

3.3. Offline Review of Requested Actions 🔍

Commands are processed by a server in the order they are received from a client. Even though an immediate response confirming receipt and processing of the command is produced by the server, a server operator MAY perform an offline review of requested transform commands before completing the requested action. In those situations, the response from the server MUST clearly note that the transform command has been received and processed, but the requested action is pending. The status of the corresponding object MUST clearly reflect processing of the pending action. The server MUST notify the client when offline processing of the action has been completed. 🧚

Here are examples describing a <create> command that requires offline review. Peek at the result code and message returned in response to the <create> command 👀

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="1001">
S:      <msg>Command completed successfully; action pending</msg>
S:    </result>
S:    <resData>
S:      <domain:creData
S:       xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S:        <domain:name>example.com</domain:name>
S:        <domain:crDate>1999-04-03T22:00:00.0Z</domain:crDate>
S:        <domain:exDate>2001-04-03T22:00:00.0Z</domain:exDate>
S:      </domain:creData>
S:    </resData>
S:    <trID>
S:      <clTRID>ABC-12345</clTRID>
S:      <svTRID>54321-XYZ</svTRID>
S:    </trID>
S:  </response>
S:</epp>

The status of the domain object after returning this response MUST include "pendingCreate". 🌈 The server operator reviews the request offline, then informs the client of the outcome either by queuing a service message for retrieval via the <poll> command, or by using an out-of-band mechanism to inform the client of the request.

The service message MUST contain text in the <response>, <msgQ>, <msg> element that describes the notification. On top of that, the EPP <resData> element MUST contain a child <domain:panData> element that identifies the domain namespace. The <domain:panData> element contains the following child elements:

A <domain:name> element that contains the fully qualified name of the domain object. The <domain:name> element contains a REQUIRED "paResult" attribute. A positive boolean value indicates that the request has been approved and completed. A negative boolean value indicates that the request has been denied and the requested action has not been taken. 🍓
A <domain:paTRID> element that contains the client transaction identifier and server transaction identifier returned with the original response to process the command. The client transaction identifier is OPTIONAL and will only be returned if the client provided an identifier with the original <create> command. 🫧
A <domain:paDate> element that contains the date and time describing when review of the requested action was completed. ⏰

Example "review completed" service message:

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="1301">
S:      <msg>Command completed successfully; ack to dequeue</msg>
S:    </result>
S:    <msgQ count="5" id="12345">
S:      <qDate>1999-04-04T22:01:00.0Z</qDate>
S:      <msg>Pending action completed successfully.</msg>
S:    </msgQ>
S:    <resData>
S:      <domain:panData
S:       xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S:        <domain:name paResult="1">example.com</domain:name>
S:        <domain:paTRID>
S:          <clTRID>ABC-12345</clTRID>
S:          <svTRID>54321-XYZ</svTRID>
S:        </domain:paTRID>
S:        <domain:paDate>1999-04-04T22:00:00.0Z</domain:paDate>
S:      </domain:panData>
S:    </resData>
S:    <trID>
S:      <clTRID>BCD-23456</clTRID>
S:      <svTRID>65432-WXY</svTRID>
S:    </trID>
S:  </response>
S:</epp>

4. Formal Syntax 💅

An EPP object mapping is specified in XML Schema notation. ✨ The formal syntax 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 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:domain-1.0"
     xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
     xmlns:host="urn:ietf:params:xml:ns:host-1.0"
     xmlns:epp="urn:ietf:params:xml:ns:epp-1.0"
     xmlns:eppcom="urn:ietf:params:xml:ns:eppcom-1.0"
     xmlns="http://www.w3.org/2001/XMLSchema"
     elementFormDefault="qualified">

<!--
Import common element types.
-->
<import namespace="urn:ietf:params:xml:ns:eppcom-1.0"/>
<import namespace="urn:ietf:params:xml:ns:epp-1.0"/>
<import namespace="urn:ietf:params:xml:ns:host-1.0"/>

<annotation>
 <documentation>
   Extensible Provisioning Protocol v1.0
   domain provisioning schema.
 </documentation>
</annotation>

<!--
Child elements found in EPP commands.
-->
<element name="check" type="domain:mNameType"/>
<element name="create" type="domain:createType"/>
<element name="delete" type="domain:sNameType"/>
<element name="info" type="domain:infoType"/>
<element name="renew" type="domain:renewType"/>
<element name="transfer" type="domain:transferType"/>
<element name="update" type="domain:updateType"/>
<!--
Child elements of the <create> command.
-->
<complexType name="createType">

 <sequence>
   <element name="name" type="eppcom:labelType"/>
   <element name="period" type="domain:periodType"
    minOccurs="0"/>
   <element name="ns" type="domain:nsType"
    minOccurs="0"/>
   <element name="registrant" type="eppcom:clIDType"
    minOccurs="0"/>
   <element name="contact" type="domain:contactType"
    minOccurs="0" maxOccurs="unbounded"/>
   <element name="authInfo" type="domain:authInfoType"/>
 </sequence>
</complexType>

<complexType name="periodType">
 <simpleContent>
   <extension base="domain:pLimitType">
     <attribute name="unit" type="domain:pUnitType"
      use="required"/>
   </extension>
 </simpleContent>
</complexType>

   <simpleType name="pLimitType">
    <restriction base="unsignedShort">
      <minInclusive value="1"/>
      <maxInclusive value="99"/>
    </restriction>
   </simpleType>

   <simpleType name="pUnitType">
    <restriction base="token">
      <enumeration value="y"/>
      <enumeration value="m"/>
    </restriction>
   </simpleType>

   <complexType name="nsType">
    <choice>
      <element name="hostObj" type="eppcom:labelType"
       maxOccurs="unbounded"/>
      <element name="hostAttr" type="domain:hostAttrType"
       maxOccurs="unbounded"/>
    </choice>
   </complexType>
   <!--
   Name servers are either host objects or attributes.
   -->
   <complexType name="hostAttrType">
    <sequence>
      <element name="hostName" type="eppcom:labelType"/>
      <element name="hostAddr" type="host:addrType"
       minOccurs="0" maxOccurs="unbounded"/>
    </sequence>
   </complexType>
   <!--
   If attributes, addresses are optional and follow the
   structure defined in the host mapping.
   -->

   <complexType name="contactType">
    <simpleContent>
      <extension base="eppcom:clIDType">
        <attribute name="type" type="domain:contactAttrType"/>
      </extension>
    </simpleContent>
   </complexType>

   <simpleType name="contactAttrType">
    <restriction base="token">
      <enumeration value="admin"/>
      <enumeration value="billing"/>
      <enumeration value="tech"/>
    </restriction>
   </simpleType>

   <complexType name="authInfoType">
    <choice>
      <element name="pw" type="eppcom:pwAuthInfoType"/>
      <element name="ext" type="eppcom:extAuthInfoType"/>
    </choice>
   </complexType>

   <!--
   Child element of commands that require a single name.
   -->
   <complexType name="sNameType">
    <sequence>
      <element name="name" type="eppcom:labelType"/>
    </sequence>
   </complexType>
   <!--
   Child element of commands that accept multiple names.
   -->
   <complexType name="mNameType">
    <sequence>

      <element name="name" type="eppcom:labelType"
       maxOccurs="unbounded"/>
    </sequence>
   </complexType>

   <!--
   Child elements of the <info> command.
   -->
   <complexType name="infoType">
    <sequence>
      <element name="name" type="domain:infoNameType"/>
      <element name="authInfo" type="domain:authInfoType"
       minOccurs="0"/>
    </sequence>
   </complexType>

   <complexType name="infoNameType">
    <simpleContent>
      <extension base = "eppcom:labelType">
        <attribute name="hosts" type="domain:hostsType"
         default="all"/>
      </extension>
    </simpleContent>
   </complexType>

   <simpleType name="hostsType">
    <restriction base="token">
      <enumeration value="all"/>
      <enumeration value="del"/>
      <enumeration value="none"/>
      <enumeration value="sub"/>
    </restriction>
   </simpleType>

   <!--
   Child elements of the <renew> command.
   -->
   <complexType name="renewType">
    <sequence>
      <element name="name" type="eppcom:labelType"/>
      <element name="curExpDate" type="date"/>
      <element name="period" type="domain:periodType"
       minOccurs="0"/>
    </sequence>
   </complexType>

   <!--
   Child elements of the <transfer> command.

   -->
   <complexType name="transferType">
    <sequence>
      <element name="name" type="eppcom:labelType"/>
      <element name="period" type="domain:periodType"
       minOccurs="0"/>
      <element name="authInfo" type="domain:authInfoType"
       minOccurs="0"/>
    </sequence>
   </complexType>

   <!--
   Child elements of the <update> command.
   -->
   <complexType name="updateType">
    <sequence>
      <element name="name" type="eppcom:labelType"/>
      <element name="add" type="domain:addRemType"
       minOccurs="0"/>
      <element name="rem" type="domain:addRemType"
       minOccurs="0"/>
      <element name="chg" type="domain:chgType"
       minOccurs="0"/>
    </sequence>
   </complexType>

   <!--
   Data elements that can be added or removed.
   -->
   <complexType name="addRemType">
    <sequence>
      <element name="ns" type="domain:nsType"
       minOccurs="0"/>
      <element name="contact" type="domain:contactType"
       minOccurs="0" maxOccurs="unbounded"/>
      <element name="status" type="domain:statusType"
       minOccurs="0" maxOccurs="11"/>
    </sequence>
   </complexType>

   <!--
   Data elements that can be changed.
   -->
   <complexType name="chgType">
    <sequence>
      <element name="registrant" type="domain:clIDChgType"
       minOccurs="0"/>
      <element name="authInfo" type="domain:authInfoChgType"

       minOccurs="0"/>
    </sequence>
   </complexType>

   <!--
   Allow the registrant value to be nullified by changing the
   minLength restriction to "0".
   -->
   <simpleType name="clIDChgType">
    <restriction base="token">
      <minLength value="0"/>
      <maxLength value="16"/>
    </restriction>
   </simpleType>

   <!--
   Allow the authInfo value to be nullified by including an
   empty element within the choice.
   -->
   <complexType name="authInfoChgType">
    <choice>
      <element name="pw" type="eppcom:pwAuthInfoType"/>
      <element name="ext" type="eppcom:extAuthInfoType"/>
      <element name="null"/>
    </choice>
   </complexType>

   <!--
   Child response elements.
   -->
   <element name="chkData" type="domain:chkDataType"/>
   <element name="creData" type="domain:creDataType"/>
   <element name="infData" type="domain:infDataType"/>
   <element name="panData" type="domain:panDataType"/>
   <element name="renData" type="domain:renDataType"/>
   <element name="trnData" type="domain:trnDataType"/>

   <!--
   <check> response elements.
   -->
   <complexType name="chkDataType">
    <sequence>
      <element name="cd" type="domain:checkType"
       maxOccurs="unbounded"/>
    </sequence>
   </complexType>

   <complexType name="checkType">

    <sequence>
      <element name="name" type="domain:checkNameType"/>
      <element name="reason" type="eppcom:reasonType"
       minOccurs="0"/>
    </sequence>
   </complexType>

   <complexType name="checkNameType">
    <simpleContent>
      <extension base="eppcom:labelType">
        <attribute name="avail" type="boolean"
         use="required"/>
      </extension>
    </simpleContent>
   </complexType>

   <!--
   <create> response elements.
   -->
   <complexType name="creDataType">
    <sequence>
      <element name="name" type="eppcom:labelType"/>
      <element name="crDate" type="dateTime"/>
      <element name="exDate" type="dateTime"
       minOccurs="0"/>
    </sequence>
   </complexType>

   <!--
   <info> response elements.
   -->
   <complexType name="infDataType">
    <sequence>
      <element name="name" type="eppcom:labelType"/>
      <element name="roid" type="eppcom:roidType"/>
      <element name="status" type="domain:statusType"
       minOccurs="0" maxOccurs="11"/>
      <element name="registrant" type="eppcom:clIDType"
       minOccurs="0"/>
      <element name="contact" type="domain:contactType"
       minOccurs="0" maxOccurs="unbounded"/>
      <element name="ns" type="domain:nsType"
       minOccurs="0"/>
      <element name="host" type="eppcom:labelType"
       minOccurs="0" maxOccurs="unbounded"/>
      <element name="clID" type="eppcom:clIDType"/>
      <element name="crID" type="eppcom:clIDType"
       minOccurs="0"/>

      <element name="crDate" type="dateTime"
       minOccurs="0"/>
      <element name="upID" type="eppcom:clIDType"
       minOccurs="0"/>
      <element name="upDate" type="dateTime"
       minOccurs="0"/>
      <element name="exDate" type="dateTime"
       minOccurs="0"/>
      <element name="trDate" type="dateTime"
       minOccurs="0"/>
      <element name="authInfo" type="domain:authInfoType"
       minOccurs="0"/>
    </sequence>
   </complexType>

   <!--
   Status is a combination of attributes and an optional
   human-readable message that may be expressed in languages other
   than English.
   -->
   <complexType name="statusType">
    <simpleContent>
      <extension base="normalizedString">
        <attribute name="s" type="domain:statusValueType"
         use="required"/>
        <attribute name="lang" type="language"
         default="en"/>
      </extension>
    </simpleContent>
   </complexType>

   <simpleType name="statusValueType">
    <restriction base="token">
      <enumeration value="clientDeleteProhibited"/>
      <enumeration value="clientHold"/>
      <enumeration value="clientRenewProhibited"/>
      <enumeration value="clientTransferProhibited"/>
      <enumeration value="clientUpdateProhibited"/>
      <enumeration value="inactive"/>
      <enumeration value="ok"/>
      <enumeration value="pendingCreate"/>
      <enumeration value="pendingDelete"/>
      <enumeration value="pendingRenew"/>
      <enumeration value="pendingTransfer"/>
      <enumeration value="pendingUpdate"/>
      <enumeration value="serverDeleteProhibited"/>
      <enumeration value="serverHold"/>
      <enumeration value="serverRenewProhibited"/>
      <enumeration value="serverTransferProhibited"/>
      <enumeration value="serverUpdateProhibited"/>
    </restriction>
   </simpleType>

   <!--
   Pending action notification response elements.
   -->
   <complexType name="panDataType">
    <sequence>
      <element name="name" type="domain:paNameType"/>
      <element name="paTRID" type="epp:trIDType"/>
      <element name="paDate" type="dateTime"/>
    </sequence>
   </complexType>

   <complexType name="paNameType">
    <simpleContent>
      <extension base="eppcom:labelType">
        <attribute name="paResult" type="boolean"
         use="required"/>
      </extension>
    </simpleContent>
   </complexType>

   <!--
   <renew> response elements.
   -->
   <complexType name="renDataType">
   <sequence>
    <element name="name" type="eppcom:labelType"/>
    <element name="exDate" type="dateTime"
     minOccurs="0"/>
   </sequence>
   </complexType>

   <!--
   <transfer> response elements.
   -->
   <complexType name="trnDataType">
   <sequence>
    <element name="name" type="eppcom:labelType"/>
    <element name="trStatus" type="eppcom:trStatusType"/>
    <element name="reID" type="eppcom:clIDType"/>
    <element name="reDate" type="dateTime"/>
    <element name="acID" type="eppcom:clIDType"/>
    <element name="acDate" type="dateTime"/>
    <element name="exDate" type="dateTime"

     minOccurs="0"/>
   </sequence>
   </complexType>

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

5. Internationalization Considerations 🌍✨

okay so EPP is written in XML, and XML comes with built-in support for Unicode characters, plus the more compact ways of storing them, like UTF-8 💅 Conformant XML processors recognize both UTF-8 and UTF-16 [RFC2781]. XML can handle other character encodings too, through an "encoding" attribute in the <?xml?> declaration, but UTF-8 is RECOMMENDED wherever parsers don't fully support the encoding you picked 🫶

All date-time values sent through EPP MUST be expressed in Universal Coordinated Time using the Gregorian calendar 🕰️ XML Schema lets you attach time zone identifiers to show offsets from the zero meridian, but that option MUST NOT be used with EPP 🙈 The extended date-time form, with uppercase "T" and "Z" characters, is defined in [W3C.REC-xmlschema-2-20041028], and it MUST be used to represent date-time values. XML Schema doesn't support truncated date-time forms or lowercase "T" and "Z" characters, so no shortcuts here, bestie 💀

This document requires domain and host name syntax as specified in [RFC0952] as updated by [RFC1123] 🍓 At the time of this writing, RFC 3490 [RFC3490] describes a standard for using certain ASCII name labels to represent non-ASCII name labels 🦋 These conformance requirements might change as a result of ongoing work on standards for internationalized domain names, so keep an eye on this one, iykyk 👀

6. IANA Considerations 🧚

okay so this section is all about URNs 🎀 This doc uses them to name XML namespaces and XML schemas, following the registry mechanism from [RFC3688]. IANA has registered two URI assignments, and here they are:

Registration request for the domain namespace:

URI: urn:ietf:params:xml:ns:domain-1.0
Registrant Contact: See the "Author's Address" section of this
document.

XML: None.  Namespace URIs do not represent an XML specification.

Registration request for the domain XML schema:

URI: urn:ietf:params:xml:schema:domain-1.0

Registrant Contact: See the "Author's Address" section of this
document.

XML: See the "Formal Syntax" section of this document.

7. Security Considerations 🚨🔐

bestie, this is the serious part and I'm not joking 😭 Authorization information, as described in section 2.6, is REQUIRED to create a domain object. 🔑 It gets used in some query and transfer operations as an extra way to check whether a client is allowed to run the command. If authorization information leaks by accident, you can end up with unauthorized transfers and unauthorized information release. Yikes. 💀 So both client and server MUST make sure authorization information is stored and exchanged with high-grade encryption mechanisms, so it stays private. 🛡️

The object mapping in this document doesn't add any other security services, and it doesn't add any extra considerations beyond what [RFC4930] and the protocol layers EPP uses already cover. 💜

8. Acknowledgements 🫶

This doc started life as an individual Internet-Draft ✨ Later the PROVREG working group adopted it as a working group document, and they gave tons of invaluable comments and suggested improvements. 🙌 The author also wants to thank WG chairs Edward Lewis and Jaap Akkerhuis for their process and editorial contributions. 👑

Specific suggestions that ended up in this document came from Joe Abley, Chris Bason, Eric Brunner-Williams, Jordyn Buchanan, Dave Crocker, Ayesha Damaraju, Anthony Eden, Sheer El-Showk, Klaus Malorny, Dan Manley, Michael Mealling, Patrick Mevzek, Asbjorn Steira, Bruce Tonkin, and Rick Wesson. Iconic cast 🌈

9. References 📚

9.1. Normative References

[RFC0952] Harrenstien, K., Stahl, M., and E. Feinler, "DoD Internet host table specification", RFC 952, October 1985.
[RFC1123] Braden, R., "Requirements for Internet Hosts - Application and Support", STD 3, RFC 1123, October 1989.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, January 2004.
[RFC4930] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", RFC 4930, May 2007.
[RFC4932] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) Host Mapping", RFC 4932, May 2007.
[RFC4933] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) Contact Mapping", RFC 4933, May 2007.
[W3C.REC-xml-20040204] Maler, E., Yergeau, F., Paoli, J., Bray, T., and C. Sperberg-McQueen, "Extensible Markup Language (XML) 1.0 (Third Edition)", World Wide Web Consortium FirstEdition REC-xml-20040204, February 2004, <http://www.w3.org/TR/2004/REC-xml-20040204>.
[W3C.REC-xmlschema-1-20041028] Thompson, H., Maloney, M., Mendelsohn, N., and D. Beech, "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

[RFC2781] Hoffman, P. and F. Yergeau, "UTF-16, an encoding of ISO 10646", RFC 2781, February 2000.
[RFC3490] Faltstrom, P., Hoffman, P., and A. Costello, "Internationalizing Domain Names in Applications (IDNA)", RFC 3490, March 2003.
[RFC3731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) Domain Name Mapping", RFC 3731, March 2004.

Appendix A. Changes from RFC 3731 🦋

Here's the tea on what changed since RFC 3731 ☕ 👀

Minor reformatting as a result of converting I-D source format from nroff to XML. Tidying up, nothing spicy 💅
Removed this text from Section 2.3:

"With one exception, transform commands MUST be rejected when a
pendingCreate, pendingDelete, pendingRenew, pendingTransfer, or
pendingUpdate status is set.  The only exception is that a
<transfer> command to approve, reject, or cancel a transfer MAY
be processed while an object is in "pendingTransfer" status."

Changed text in Section 3.1.3 from this:

"A <domain:acID> element that contains the identifier of the
client that SHOULD act upon the transfer request"

to this:

"A <domain:acID> element that contains the identifier of the
client that SHOULD act upon a PENDING transfer request.  For all
other status types, the value identifies the client that took the
indicated action"

Changed text in Section 3.2.5 (old Section 3.2.1.4) from this:

"At least one <domain:add>, <domain:rem>, or <domain:chg> element
MUST be provided."

to this:

"At least one <domain:add>, <domain:rem>, or <domain:chg> element
MUST be provided if the command is not being extended.  All of
these elements MAY be omitted if an <update> extension is present."

Renumbered old Section 3.2.6 to new Section 3.3. 🔢
Changed text in Section 3.3 (old Section 3.2.6) from this:

"The server operator reviews the request offline, and informs the
client of the outcome of the review by queuing a service message
for retrieval via the <poll> command."

to this:

"The server operator reviews the request offline, and informs the
client of the outcome of the review either by queuing a service
message for retrieval via the <poll> command or by using an out-
of-band mechanism to inform the client of the request."

Removed text describing use of the XML Schema schemaLocation attribute. This is an optional attribute that doesn't need to be mandated for use in EPP. ✂️
Removed references to RFC 3339 and replaced them with references to the W3C XML Schema specification. 🔄
Updated EPP and XML references. 💖

Author's Address 💌

Scott Hollenbeck
VeriSign, Inc.
21345 Ridgetop Circle
Dulles, VA  20166-6503
US

EMail: shollenbeck@verisign.com

This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights.

This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Intellectual Property 🏷️

The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79.

Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr.

The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org.

Acknowledgement 💐

Funding for the RFC Editor function is currently provided by the Internet Society. 🌸

📦 where this page comes from

ietf: rfc4931 2007-05
💖 girlified by claude-haiku-5-5 on 2026-10-17: a language model's rewrite of the original, under its terms

RFC 4931

Extensible Provisioning Protocol (EPP) Domain Name Mapping 🎀

Status of This Memo

Copyright Notice

Abstract

Table of Contents

1. Introduction ✨

1.1. Relationship of Domain Objects and Host Objects

1.2. Conventions Used in This Document

2. Object Attributes 🌈

2.1. Domain and Host Names

2.2. Contact and Client Identifiers

2.3. Status Values ✨

2.4. Dates and Times ⏰

2.5. Validity Periods 🗓️

2.6. Authorization Information 🔐

2.7. Other DNS Resource Record Attributes 🧁

3. EPP Command Mapping 📮

3.1. EPP Query Commands 🔍

3.1.1. EPP <check> Command 💫

3.1.2. EPP <info> Command ✨

3.2. EPP Transform Commands ✨

3.2.1. EPP <create> Command ✨

3.2.2. EPP <delete> Command 🗑️

3.2.3. EPP <renew> Command 🔁

3.2.4. EPP <transfer> Command 🌸

3.2.5. EPP <update> Command ✨

3.3. Offline Review of Requested Actions 🔍

4. Formal Syntax 💅

5. Internationalization Considerations 🌍✨

6. IANA Considerations 🧚

7. Security Considerations 🚨🔐

8. Acknowledgements 🫶

9. References 📚

9.1. Normative References

9.2. Informative References

Appendix A. Changes from RFC 3731 🦋

Author's Address 💌

Full Copyright Statement ©️

Intellectual Property 🏷️

Acknowledgement 💐