RFC 5731
Extensible Provisioning Protocol (EPP) Domain Name Mapping
RFC 5731: Extensible Provisioning Protocol (EPP) Domain Name Mapping 💖
RFC number: 5731 Authors: S. Hollenbeck, VeriSign, Inc. Date: August 2009 Category: Standards Track Series: STD 69 Obsoletes: RFC 4931
Okay bestie, this is the one that defines how EPP handles domain names 🌸 It's the official Standards Track doc from August 2009, written by S. Hollenbeck at VeriSign, and it obsoletes RFC 4931 🫶
Abstract ✨
This doc describes an EPP mapping for provisioning and managing Internet domain names that live in a shared central repository 🦋 It's written in XML, and it spells out the EPP command syntax and semantics for domain names. It also says this document obsoletes RFC 4931.
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 💅 For the standardization state and status of this protocol, check the current edition of the "Internet Official Protocol Standards" (STD 1). Distribution of this memo is unlimited ✨
Copyright Notice 🎀
Copyright (c) 2009 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 in effect on the date of publication of this document (http://trustee.ietf.org/license-info). Please read these carefully, because they explain your rights and restrictions for this document 🧚
Table of Contents 🍓
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 ................................22
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 ..................................................30
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 4931 ................................441. Introduction ✨
This doc describes an Internet domain name mapping for version 1.0 of the Extensible Provisioning Protocol (EPP) 🌈 The mapping is specified using 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]. It obsoletes RFC 4931 [RFC4931].
[RFC5730] has the full scoop on EPP command and response structures. You really need a solid grip on the base protocol spec before the mapping in this document makes sense 🧠
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 [RFC5732]. This document assumes that domain name objects have a superordinate relationship to subordinate host name objects. For example, the domain name "example.com" is superordinate to the host name "ns1.example.com". EPP actions (such as object transfers) that do not 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 that DNS domains in ".example" can be delegated to it. These hosts are called "external" hosts in this specification, since the host's name doesn't belong to the namespace of the repository where it's being used for delegation 💅
Whether a host is external or internal depends on the repository where it's used for delegation. Whether an internal host is subordinate depends on a domain within the repository. For example, the host ns1.example1.com is a subordinate host of the domain example1.com, but it is not a subordinate host of the domain example2.com. ns1.example1.com can be used as a name server for example2.com. In that case, ns1.example1.com MUST be treated as an internal host, subject to the rules for operations on subordinate hosts within the same repository 👑
Name server hosts for domain delegation can be specified in one of two ways: 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" notes IPv4 address format, and the value "v6" notes 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 [RFC5732].
Here's an example of host-object name server elements for the domain example.com 🎀
<domain:ns>
<domain:hostObj>ns1.example.net</domain:hostObj>
<domain:hostObj>ns2.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.net</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>ns2.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 element relationships, 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] and [RFC1123]. As 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 work on standards for internationalized domain names progresses. 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 [RFC5730] 💖
2.3. Status Values 🎀
okay so every domain object MUST always have at least one status value, no exceptions 💅 Only the client that sponsors the object and the server where it lives can set statuses. A client can change a domain's status with the EPP <update> command, and each status value MAY come with a little human-readable note explaining why it got applied 📝
clients are NOT allowed to touch statuses the server set (MUST NOT, bestie, hands off 🙅♀️). A server MAY change or override a client's statuses, but that's subject to its local server policies 👑 And the status of an object MAY change because of a client-initiated transform command or because a server operator did something 🦋
Status values that a client can add or remove start with "client" 💖 The server-side versions start with "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 hasn't been linked to the object yet. This is the default when a domain object is first created and there are no host objects for the DNS delegation. The server can also set this when all the host-object associations get removed 🥱
ok
This is the normal, main-character status for an object with no pending operations or prohibitions ✨ The server adds and removes it as other status values come and go 💅
pendingCreate,pendingDelete,pendingRenew,pendingTransfer,pendingUpdate
A transform command got processed for the object, but the server hasn't finished the action yet ⏳ Server operators can delay completion for all sorts of reasons, like human review or third-party action. A processed transform command whose action is still pending comes back with response code 1001 🧚
When the requested action is finished, the pendingCreate, pendingDelete, pendingRenew, pendingTransfer, or pendingUpdate status value MUST be removed 🎉 And every client involved in the transaction MUST be notified with a service message saying the action is done and the object's status has changed 📣
"ok" status MUST NOT be combined with any other status. That's a hard no, bestie 🙅♀️
"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. They're all in their own lane 🛣️
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, from [W3C.REC-xmlschema-2-20041028] MUST be used for date-time values. XML Schema doesn't support truncated date-time forms or lower case "T" and "Z" characters, so no cutting corners here 🙅♀️⏰
2.5. Validity Periods ⏳
A domain name object MAY have a specified validity period 🦋 If the server policy supports validity periods for domain objects, the period gets defined when the object is created, and it MAY be extended by the EPP <renew> or <transfer> commands 🔁 As a matter of server policy, this spec does NOT define what happens when a domain object's validity period expires 🤷♀️
Validity periods are measured in years or months, and the units are set with the "unit" attribute 📅 Valid "unit" values are "y" for years and "m" for months. The minimum period value is one (1). The maximum is ninety-nine decimal (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 a domain object is created and it might be updated later on. This spec describes password-based authorization information, though other mechanisms are possible 🗝️
2.7. Other DNS Resource Record Attributes 📚
The DNS lets a domain be associated with lots of resource record types, but this mapping only explicitly specifies the elements for resource records used in domain delegation and resolution 🧩 Other domain-related resource record types can be provisioned later by extending this mapping ✨
The provisioning method here splits discrete data elements up by data type 🍰 That lets XML Schema processors handle basic syntax-validation, which cuts down on ambiguity and on the parsing and syntax-checking work 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 is in [RFC5730] 📖 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 🧁 <check> tells you if a domain object can be provisioned within a repository, <info> retrieves the detailed info tied to a domain object, and <transfer> retrieves domain-object transfer status information 🦋
3.1.1. EPP <check> Command ✅
The EPP <check> command figures out if an object can be provisioned within a repository 🔮 It gives the client a hint about whether a <create> will succeed, but object-provisioning requirements are ultimately up to server policy, so it's a hint, not a promise 🫠
Besides the standard EPP command elements, the <check> command MUST contain a <domain:check> element that identifies the domain namespace 🎀 The <domain:check> element holds these child elements:
- One or more <domain:name> elements that contain the fully qualified names of the domain objects you want to query 🔎
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 holds these child elements:
- A <domain:name> element with the fully qualified name of the queried domain object. This element MUST contain an "avail" attribute whose value shows whether the object is available (can it be provisioned or not) at the moment the <check> command was completed 👀 A value of "1" or "true" means it CAN be provisioned ✅ A value of "0" or "false" means it can NOT be provisioned ❌
- An OPTIONAL <domain:reason> element that MAY show up when an object can't be provisioned 🙋♀️ If it's there, it has server-specific text explaining why 💬 That text MUST be in the response language already negotiated with the client. An OPTIONAL "lang" attribute MAY be present to name the language if the negotiated value isn't the default "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 exceptions, no drama 🙅♀️💜
3.1.2. EPP <info> Command ✨
okay so the EPP <info> command is how you pull up everything the server knows about a domain object 🔍 what you get back can change depending on who's asking, whether they bring authorization info, and what the server's policy says about unauthorized clients 🫣 the MAY there is doing a lot of work, bestie. if you're the sponsoring client, you MUST get all the available info 💅 if you're not the sponsoring client BUT you bring valid authorization information, you MUST also get all the available info 🔑 and if you're not the sponsoring client and you don't bring valid authorization info, the server policy decides which OPTIONAL elements you get back 🙃
in addition to the usual EPP command elements, the <info> command MUST contain a <domain:info> element that tells the server you're talking the domain namespace 🎀 that <domain:info> element has these child elements:
- a <domain:name> element holding the fully qualified name of the domain object you want to query. there's an OPTIONAL "hosts" attribute that controls whether you get info about the hosts tied to the domain 🧚 a value of "all" is the default (so it can be totally absent, MAY be left out) and gives you info on both subordinate and delegated hosts 🌈 "del" gives you only the delegated hosts, "sub" gives you only the subordinate hosts, and "none" gives you zero info about delegated or subordinate hosts 🙈
- an OPTIONAL <domain:authInfo> element holding authorization info tied to the domain object, or to the domain's registrant or associated contacts 🔐 if the authInfo belongs to a registrant or contact object instead of the domain itself, an OPTIONAL "roid" attribute MUST be used to identify that registrant or contact object, and only then 💖 if you leave this element out, or the authorization info is invalid, the server policy decides whether your command gets rejected or whether it still sends response info back 🤷♀️
example <info> command without authorization information:
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>example <info> command with authorization information:
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>okay now the good part 🥹 when an <info> command gets processed successfully, the EPP <resData> element MUST contain a child <domain:infData> element that flags the domain namespace 💜 anything that isn't OPTIONAL MUST come back, and the OPTIONAL stuff only shows up based on your authorization and the server's policy 🫶 the <domain:infData> element holds 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 got assigned to the domain object when it was 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, holding identifiers for the human or organizational social information objects tied to the domain object 👑
- an OPTIONAL <domain:ns> element listing the fully qualified names of the delegated host objects or host attributes (name servers) tied to the domain object. see Section 1.1 for how host objects or 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 got created 📅
- an OPTIONAL <domain:exDate> element with the date and time marking 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, so don't go looking for it 🙅♀️
- 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 either, no exceptions 🫠
- 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 authorization info tied to the domain object 🔒 this element MUST only be returned if the querying client is the current sponsoring client, or if the client supplied valid authorization information with the command 💅
example <info> response for an authorized client:
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 provide less information in a response, so don't be shocked if yours is a bit more minimal 🤏
example <info> response for an unauthorized client:
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>and last but not least 🫡 if an <info> command can't be processed for any reason, an EPP error response MUST be returned 🚨 no ghosting, periodt 💀
3.1.3. EPP <transfer> Query Command ✨
Okay bestie, the EPP <transfer> command has a query op 🦋 It lets a client check the real-time status of pending and completed transfer requests, which is so useful. Besides the usual EPP command elements, a <transfer> command MUST have an "op" attribute set to "query", plus a <domain:transfer> element that names the domain namespace. That element holds these children:
- A
<domain:name>element with the fully qualified name of the domain object you're querying 🌸 - An OPTIONAL
<domain:authInfo>element with authorization info tied to the domain object, or to its 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 included, or the auth info is invalid, server policy decides whether the command gets rejected or whether response info still gets sent back to the client 🤷♀️
Here's an 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 names the domain namespace. The <domain:trnData> element has these children, and they're the juicy details 🔥
- A
<domain:name>element with the fully qualified name of the domain object. - A
<domain:trStatus>element with the state of the most recent transfer request. - A
<domain:reID>element with the identifier of the client that requested the object transfer. - A
<domain:reDate>element with the date and time the transfer was requested. - A
<domain:acID>element with 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 with the date and time of a required or completed response. For a PENDING request, the value is the date and time by which a response is needed before the server takes an automated response action. For all other status types, the value is the date and time the request was completed ⏰ - An OPTIONAL
<domain:exDate>element with the end of the domain object's validity period, if the<transfer>command caused or causes a change to that 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>⚠️ If a <transfer> query command can't be processed for any reason, an EPP error response MUST be returned. No exceptions, periodt 💀
3.2. EPP Transform Commands 🌈
EPP gives us five commands to transform domain objects: <create> makes a new domain object, <delete> removes one, <renew> extends its validity period, <transfer> manages sponsorship changes, and <update> changes the info attached to a domain object. It's a whole glow-up squad 💅
Transform commands are usually processed and completed in real time ⚡ Server operators MAY receive and process transform commands but hold off on completing the requested action if human or third-party review is needed first. In that case the server MUST return a 1001 response code to the client, which basically says "got it, processed, but still pending" 🫶 The server MUST also keep the status of the object that's the subject of the command up to date, so it reflects the start and finish of the action. Once the action is done, all clients involved in the transaction MUST be notified with a service message saying the action is complete and the object's status has changed 📣 Other notification methods MAY be used on top of that required service message.
Server operators SHOULD confirm that a client is authorized to run a transform command on a given object 🔐 Any attempt to transform an object by an unauthorized client MUST be rejected, and the server MUST return a 2201 response code to the client to say the client lacks the privileges for that command 🙅♀️
3.2.1. EPP <create> Command 🍓
The EPP <create> command is the transform op that lets a client create a domain object 🧁 Besides the usual EPP command elements, the <create> command MUST contain a <domain:create> element that names the domain namespace. The <domain:create> element has these children:
- A
<domain:name>element with the fully qualified name of the domain object being created. - An OPTIONAL
<domain:period>element with the initial registration period of the domain object. A server MAY define a default initial registration period if the client doesn't give one 📅 - 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 so it can handle resolution services. See Section 1.1 for how 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 with the identifier of the human or organizational social information (contact) object that becomes 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 [RFC5733]. 👩💻 - Zero or more OPTIONAL
<domain:contact>elements with the identifiers of other contact objects to associate 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 with authorization info to attach to the domain object. This mapping includes a password-based authentication mechanism, but the schema lets new mechanisms be defined in new schemas later on 🔑
Here's an 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.net</domain:hostObj>
C: <domain:hostObj>ns2.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 names the domain namespace. The <domain:creData> element has these children 🦋
- A
<domain:name>element with the fully qualified name of the domain object. - A
<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 🗓️
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 can't 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 🗑️💅 on top of the standard EPP command elements, the <delete> command MUST contain a <domain:delete> element that identifies the domain namespace 🎀 that <domain:delete> element has one child element:
- A <domain:name> element that contains the fully qualified name of the domain object to be deleted.
ngl this part is so important 😭 a domain object SHOULD NOT be deleted if subordinate host objects are associated with it. for example, if domain "example.com" exists and host object "ns1.example.com" also exists, then domain "example.com" SHOULD NOT be deleted until host "ns1.example.com" has either been deleted or renamed to exist in a different superordinate domain 🧚 a server SHOULD notify clients that object relationships exist by sending a 2305 error response code when a <delete> command is attempted and fails due to existing object relationships. and delegated and subordinate host objects linked to a domain object can be found with the <info> query command for that domain object 🔥
here's an 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 🦋
and here's what the example <delete> response looks like 💖
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>⚠️ bestie, if a <delete> command can't be processed for any reason, an EPP error response MUST be returned. no exceptions, no excuses 💀
3.2.3. EPP <renew> Command 🔁✨
the EPP <renew> command is another transform operation, and it lets a client extend the validity period of a domain object 🌈 plus the standard EPP command elements, the <renew> command MUST contain a <domain:renew> element that identifies the domain namespace 💜 that <domain:renew> element holds 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 value is the safety net 🛟 that makes sure repeated <renew> commands don't result in 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, here we go 🎀
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 ✨ the <domain:renData> 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.
and the example <renew> response is giving main character energy 👑
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>⚠️ and if a <renew> command cannot be processed for any reason, an EPP error response MUST be returned 🙈
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 🍓 on top of the standard EPP command elements, the <transfer> command MUST contain a <domain:transfer> element that identifies the domain namespace. that <domain:transfer> 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 🧚 the valid values, definitions, and authorizations for all attribute values are defined in [RFC5730] ✨
the 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 you transfer a domain object are listed in the response to an EPP <info> command performed on that domain object 💅
here's an 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.
and here's the 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>⚠️ bestie, if a <transfer> command can not be processed for any reason, an EPP error response MUST be returned 😭
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 🦋 In addition to the standard EPP command elements, the <update> command MUST contain a <domain:update> element that identifies the domain namespace. The <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 these 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 these 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. 🔐
Here's the example <update> command, periodt 🎀
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. ✅
Here's the 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. 🚨
3.3. Offline Review of Requested Actions
okay so commands get processed by a server in the order the client sends them 📬 The server sends back an immediate response confirming it got and processed the command, but a server operator MAY do an offline review of requested transform commands before finishing the action. In that case, the response from the server MUST clearly note that the transform command has been received and processed, but that 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 once offline processing of the action is completed 🔔
Here are examples of a <create> command that needs offline review. Check out the result code and message in the 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: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>After returning this response, the status of the domain object MUST include "pendingCreate" 🧚 The server operator reviews the request offline and tells the client 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 that describes the notification in the child <msg> element of the response <msgQ> element. On top of that, the EPP <resData> element MUST contain a child <domain:panData> element that identifies the domain namespace. The <domain:panData> element has these 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 means the request has been approved and completed. A negative boolean value means 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.
Here's an 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 ✨
okay this part is the blueprint 📐 An EPP object mapping is specified in XML Schema notation. The formal syntax here is a complete schema representation of the object mapping, so you can do 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.
Copyright (c) 2009 IETF Trust and the persons identified as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of Internet Society, IETF or IETF Trust, nor the names of specific contributors, may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Here's where the schema begins 🎀
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">Okay bestie, this part is all schema, the XML that pins down exactly what every EPP domain command and response is allowed to look like 🎀 Every element, type, and enum value below is copied straight from the spec, so it's giving precision 💅
<!--
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>
END5. Internationalization Considerations ✨
okay so EPP is written in XML, and XML already speaks Unicode 🌍 It's giving built-in global main character energy. Conformant XML processors understand both UTF-8 and UTF-16 [RFC2781]. XML can also handle other character encodings if you name them in an encoding attribute on the <?xml?> declaration, but using UTF-8 is RECOMMENDED in places where some parsers just don't support the encoding 🫶
All date-time values sent over EPP MUST be written 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. Use the extended date-time form with upper case "T" and "Z" characters, which is defined in [W3C.REC-xmlschema-2-20041028]. It's a MUST be used for date-time values, bestie, because XML Schema doesn't support truncated date-time forms or lower case "T" and "Z" characters 💅
This document needs domain and host name syntax as specified in [RFC0952] as updated by [RFC1123]. At the time of writing, RFC 3490 [RFC3490] describes a way to use certain ASCII name labels to stand in for non-ASCII name labels 🌸 These conformance requirements might change as work on internationalized domain names keeps progressing, so keep an eye out 👀
6. IANA Considerations ✨
This document uses URNs to describe XML namespaces and XML schemas that follow a registry mechanism described in [RFC3688]. IANA has registered two URI assignments already, which is so iconic 🦋
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 part is SERIOUS. Read it twice.
Authorization information, as described in Section 2.6, is REQUIRED to create a domain object 🔐 The server uses that information in some query and transfer operations as an extra way to check whether a client is allowed to run the command. If authorization information isn't protected from accidental disclosure, that can lead to unauthorized transfer operations and unauthorized information release 💀 So both client and server MUST ensure that authorization information is stored and exchanged with high-grade encryption mechanisms to provide privacy services. No shortcuts, periodt 🔒
The object mapping in this document doesn't add any other security services or new considerations beyond the ones covered by [RFC5730], or the ones that come from the protocol layers EPP uses 🧚
8. Acknowledgements ✨
RFC 3731 came out of the PROVREG working group, which suggested improvements and gave lots of super valuable comments 🫶 The author also wants to thank WG chairs Edward Lewis and Jaap Akkerhuis for their process and editorial help. RFC 4931 and this document are individual submissions, based on the work done in RFC 3731 🌷
Specific suggestions that made it into 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. Thank you all, you're the real MVPs 👑💖
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.[RFC5730]Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", STD 69, RFC 5730, August 2009.[RFC5732]Hollenbeck, S., "Extensible Provisioning Protocol (EPP) Host Mapping", STD 69, RFC 5732, August 2009.[RFC5733]Hollenbeck, S., "Extensible Provisioning Protocol (EPP) Contact Mapping", STD 69, RFC 5733, August 2009.[W3C.REC-xml-20040204]Sperberg-McQueen, C., Maler, E., Yergeau, F., Paoli, J., and T. Bray, "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]Maloney, M., Thompson, H., 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]Malhotra, A. and P. Biron, "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.[RFC4931]Hollenbeck, S., "Extensible Provisioning Protocol (EPP) Domain Name Mapping", RFC 4931, May 2007.
Appendix A. Changes from RFC 4931 ✨
okay, the glow-up log 💅 Here's everything that changed from RFC 4931:
- Changed "This document obsoletes RFC 3731" to "This document obsoletes RFC 4931".
- Replaced references to RFC 3731 with references to 4931.
- Replaced references to RFC 4930 with references to 5730.
- Replaced references to RFC 4932 with references to 5732.
- Replaced references to RFC 4933 with references to 5733.
- Updated description of inactive status in Section 2.3.
- Fixed example host names in the Section 1.1 and Section 3.2.1 examples.
- Changed "but such methods SHOULD NOT be used" to "but such methods should not be used" in Section 2.7.
- Added "Other notification methods MAY be used in addition to the required service message" in Section 3.2.
- Added 2201 response code text in Section 3.2.
- Added BSD license text to XML schema section.
Author's Address 🎀
Scott Hollenbeck
VeriSign, Inc.
21345 Ridgetop Circle
Dulles, VA 20166-6503
US
EMail: shollenbeck@verisign.com📦 where this page comes from
- ietf: rfc5731 2009-08
- 💖 girlified by claude-haiku-5-5 on : a language model's rewrite of the original, under its terms