RFC 8590
Change Poll Extension for the Extensible Provisioning Protocol (EPP)
RFC 8590 💖 Change Poll Extension for the Extensible Provisioning Protocol (EPP)
- Published by: the Internet Engineering Task Force (IETF) ✨
- Authors: J. Gould (VeriSign, Inc.) and K. Feher (Neustar) 👯
- Category: Standards Track 🎀
- Date: May 2019 📅
- ISSN: 2070-1721
- Obsoletes / Updates: the header doesn't list any RFCs it obsoletes or updates 🧚
Abstract ✨
okay so this doc describes an EPP extension that tells clients about stuff that happened to their sponsored objects without the client asking for it through EPP 🫶 that could be contract or policy stuff like regular batch runs, customer support actions, UDRP or URS actions, court-ordered actions, and bulk updates from customer requests 📋. the client is literally not involved in any of this and might not even know it happened, so the extension pairs with an EPP object mapping to show the resulting state of the post-operation object (and optionally the pre-operation object too) plus the metadata of what, when, who, and why 🔍💅
Status of This Memo ✨
this is an Internet Standards Track document 🎀
it's a product of the Internet Engineering Task Force (IETF) 💖 and it represents the consensus of the IETF community 🫶. it got public review and was approved for publication by the Internet Engineering Steering Group (IESG) 👑. if you want more on Internet Standards, check Section 2 of RFC 7841 📚
for the current status, any errata, and how to give feedback, go to https://www.rfc-editor.org/info/rfc8590 🌸
Copyright Notice ✨
Copyright (c) 2019 IETF Trust and the persons identified as the document authors. All rights reserved. 🎀
this document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) as they stand on the date of publication 📜. please actually read these, bestie, because they spell out your rights and restrictions for this document 🙈. code components pulled out of this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions, and they come with no warranty, as described in the Simplified BSD License ⚠️
Table of Contents 📑
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Conventions Used in This Document . . . . . . . . . . . . 3
2. Object Attributes . . . . . . . . . . . . . . . . . . . . . . 4
2.1. Operation . . . . . . . . . . . . . . . . . . . . . . . . 4
2.2. State . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.3. Who . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.4. Dates and Times . . . . . . . . . . . . . . . . . . . . . 5
3. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 6
3.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 6
3.1.1. EPP <check> Command . . . . . . . . . . . . . . . . . 6
3.1.2. EPP <info> Command . . . . . . . . . . . . . . . . . 6
3.1.3. EPP <transfer> Command . . . . . . . . . . . . . . . 14
3.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 14
3.2.1. EPP <create> Command . . . . . . . . . . . . . . . . 14
3.2.2. EPP <delete> Command . . . . . . . . . . . . . . . . 14
3.2.3. EPP <renew> Command . . . . . . . . . . . . . . . . . 14
3.2.4. EPP <transfer> Command . . . . . . . . . . . . . . . 14
3.2.5. EPP <update> Command . . . . . . . . . . . . . . . . 14
4. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 15
4.1. Change Poll Extension Schema . . . . . . . . . . . . . . 15
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 18
5.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 18
5.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 18
6. Security Considerations . . . . . . . . . . . . . . . . . . . 19
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 19
7.1. Normative References . . . . . . . . . . . . . . . . . . 19
7.2. Informative References . . . . . . . . . . . . . . . . . 20
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . 20
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 201. Introduction ✨
this doc describes an extension mapping for version 1.0 of the Extensible Provisioning Protocol (EPP) [RFC5730] 💅. it's an extension to EPP object mappings, like the EPP domain name mapping [RFC5731], and it's used to tell clients about operations they aren't directly involved in, on objects those clients sponsor 🦋. which operations and which clients get notified is up to server policy 🎀. with this extension, clients can keep their systems in sync with the objects stored on the server way more easily 🫶
when something changes that a client needs to hear about, the server can insert a poll message, and the client grabs it with the EPP <poll> command and response defined in [RFC5730] 📬. the extension supports a "before" operation poll message and an "after" operation poll message 🔁. quick note: it only extends the EPP <poll> response in [RFC5730] and does not extend the EPP <poll> command 🙈. for info and examples of the <poll> command, go check [RFC5730] 💜
1.1. Conventions Used in This Document 📜
the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be read as described in BCP 14 [RFC2119] [RFC8174], but only when they show up in all capitals, just like here 🎀
XML is case sensitive 🙌. unless it says otherwise, XML specs and examples in this doc MUST be interpreted in the character case they're shown in, so you can build a conforming implementation 💖
in examples, "C:" means lines sent by a protocol client, and "S:" means lines sent back by a protocol server 🧚. the indentation and whitespace are just there to show how elements relate, and they are not a REQUIRED feature of this protocol 🌸
the XML namespace prefix changePoll is used for the namespace urn:ietf:params:xml:ns:changePoll-1.0 🦄. implementations MUST NOT depend on that prefix though 🙈, so instead they should use a proper namespace-aware XML parser and serializer to read and write the XML docs 💅
2. Object Attributes 🎀
this extension adds extra elements to EPP object mappings, like the EPP domain name mapping [RFC5731] ✨. only those new elements get described here, so you don't have to re-read the whole mapping 📚
2.1. Operation 🔥
an operation is any transform operation that affects sponsored objects and that the client should be notified about 💫. the <changePoll:operation> element defines the operation 🎀. the OPTIONAL op attribute is an identifier written in the 7-bit US-ASCII character set defined in [RFC20], and it's used to define a sub-operation or to name a "custom" operation 🫶. here's the enumerated list of <changePoll:operation> values:
"create": Create operation as defined in [RFC5730]."delete": Delete operation as defined in [RFC5730]. If the delete operation results in an immediate purge of the object, then theopattribute MUST be set to"purge"💀."renew": Renew operation as defined in [RFC5730] 🔄."transfer": Transfer operation as defined in [RFC5730] that MUST set theopattribute to one of the possible transfer-type values. those are"request","approve","cancel", or"reject"🦋."update": Update operation as defined in [RFC5730] ✏️."restore": Restore operation as defined in [RFC3915] that MUST set theopattribute to one of the possible restore-type values. those are"request"or"report"🌈."autoRenew": Auto renew operation executed by the server 🤖."autoDelete": Auto delete operation executed by the server. If the"autoDelete"operation results in an immediate purge of the object, then theopattribute MUST be set to"purge"🫠."autoPurge": Auto purge operation executed by the server when it removes the object after it has had the status"pendingDelete"🧹."custom": Custom operation that MUST set theopattribute to the custom operation name. which custom operations are supported is up to server policy 🎨.
2.2. State 🌙
the state attribute reflects what the object looked like "before" or "after" the operation 🪞. the state is set with the OPTIONAL "state" attribute of the <changePoll:changeData> element, which can be "before" or "after", and the default is "after" 💜. the server MAY support both the "before" state and the "after" state of an operation by sending one poll message for "before" and one poll message for "after" ✌️. the "before" state poll message MUST be inserted into the message queue ahead of the "after" state poll message 📬
for operations from Section 2.1 that don't have an "after" state, the server MUST use the "before" state poll message 🗑️. for example, with the "delete" operation when the op attribute is "purge", or with the "autoPurge" operation, the server puts the state of the object from before it got purged into the "before" state poll message 💀
for operations from Section 2.1 that don't have a "before" state, the server MUST use the "after" state poll message 🌱. for example, with the "create" operation, the server puts the state of the object after it was created into the "after" state poll message 🎂
2.3. Who 👯
the <changePoll:who> element says who ran the operation, and it's there for audit purposes 🕵️♀️. it's a free-form value that is meant strictly for auditing and not for driving client-side logic, so don't build your app around it 🙅♀️. the scheme for the possible <changePoll:who> values is up to server policy 📋. the server MAY identify the <changePoll:who> value based on:
"Identifier": Unique user identifier of the user who ran the operation. An example is"ClientX"🪪."Name": Name of the user who ran the operation. An example is"John Doe"🧑."Role": Role of the user who ran the operation. Examples are"CSR"for a Customer Support Representative, or"Batch"for a server batch 🎧.
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 uppercase "T" and "Z" characters, defined in [W3C.REC-xmlschema-2-20041028] MUST be used to represent date-time values. the reason is that XML Schema doesn't support truncated date-time forms or lowercase "T" and "Z" characters, so no cutting corners here 🙅♀️💖
3. EPP Command Mapping 🧚
a detailed description of the EPP syntax and semantics lives in the EPP core protocol spec [RFC5730], so go there for the full scoop 📖
3.1. EPP Query Commands 🔎
EPP gives you three commands to retrieve object info. there's <check> to see if the server knows about an object, <info> to get the detailed info tied to an object, and <transfer> to get object-transfer status info 💅✨
3.1.1. EPP <check> Command 🔍
this extension does not add any elements to the EPP <check> command or the <check> response described in [RFC5730], so nothing new to see here 🫶
3.1.2. EPP <info> Command 📋
this extension does not add any elements to the EPP <info> command described in [RFC5730] 🌸
Okay so this extension is basically a poll response glow-up 💖 It adds the operational detail of EPP object-mapping operations (Section 2.1) to an EPP poll response, as described in [RFC5730]. It's an extension of the EPP object-mapping info response, bestie 🎀 Any transform operation to an object defined in an EPP object mapping by a client other than the sponsoring client MAY result in extending the <info> response of the object so an EPP poll message with the operation detail gets inserted ✨ The sponsoring client then gets the state of the object with the operation detail, like what, who, when, and why it was changed. Main character info energy 💅
The <changePoll:changeData> element holds the operation detail, plus an indication of whether the object reflects the state before or after the operation, as defined in Section 2.2 🦋 It includes the operation detail with these child elements:
<changePoll:operation>: The transform operation executed on the object, as defined in Section 2.1.<changePoll:date>: The date and time when the operation was executed.<changePoll:svTRID>: The server transaction identifier of the operation.<changePoll:who>: Who executed the operation, as defined in Section 2.3.<changePoll:caseId>: OPTIONAL case identifier associated with the operation 🌸 The required "type" attribute defines the type of case. The OPTIONAL "name" attribute is an identifier, represented in the 7-bit US-ASCII character set defined in [RFC20], and it's used to define the name of the "custom" case type. The enumerated list of case types is:udrp: A Uniform Domain-Name Dispute-Resolution Policy (UDRP) case.urs: A Uniform Rapid Suspension (URS) case.custom: A custom case that is defined using the "name" attribute.
<changePoll:reason>: OPTIONAL reason for executing the operation 🧚 If it's present, this element contains the server-specific text that helps explain why the operation was executed. This text MUST be represented in the response language previously negotiated with the client, and 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) 🌈
Here's an example poll <info> response with the <changePoll:changeData> extension for a URS lock transaction on the domain.example domain name, with the "before" state 🔥 The "before" state is reflected in the <resData> block:
S:<?xml version="1.0" encoding="UTF-8"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S: <response>
S: <result code="1301">
S: <msg lang="en-US">
S: Command completed successfully; ack to dequeue</msg>
S: </result>
S: <msgQ id="201" count="1">
S: <qDate>2013-10-22T14:25:57.0Z</qDate>
S: <msg>Registry initiated update of domain.</msg>
S: </msgQ>
S: <resData>
S: <domain:infData
S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S: <domain:name>domain.example</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:clID>ClientX</domain:clID>
S: <domain:crID>ClientY</domain:crID>
S: <domain:crDate>2012-04-03T22:00:00.0Z</domain:crDate>
S: <domain:exDate>2014-04-03T22:00:00.0Z</domain:exDate>
S: </domain:infData>
S: </resData>
S: <extension>
S: <changePoll:changeData
S: xmlns:changePoll="urn:ietf:params:xml:ns:changePoll-1.0"
S: state="before">
S: <changePoll:operation>update</changePoll:operation>
S: <changePoll:date>2013-10-22T14:25:57.0Z</changePoll:date>
S: <changePoll:svTRID>12345-XYZ</changePoll:svTRID>
S: <changePoll:who>URS Admin</changePoll:who>
S: <changePoll:caseId type="urs">urs123</changePoll:caseId>
S: <changePoll:reason>URS Lock</changePoll:reason>
S: </changePoll:changeData>
S: </extension>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54321-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>Here's another example poll <info> response with the <changePoll:changeData> extension for that same URS lock transaction on domain.example, but this time with the "after" state 💜 The "after" state is reflected in the <resData> block:
S:<?xml version="1.0" encoding="UTF-8"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S: <response>
S: <result code="1301">
S: <msg lang="en-US">
S: Command completed successfully; ack to dequeue</msg>
S: </result>
S: <msgQ id="202" count="1">
S: <qDate>2013-10-22T14:25:57.0Z</qDate>
S: <msg>Registry initiated update of domain.</msg>
S: </msgQ>
S: <resData>
S: <domain:infData
S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S: <domain:name>domain.example</domain:name>
S: <domain:roid>EXAMPLE1-REP</domain:roid>
S: <domain:status s="serverUpdateProhibited"/>
S: <domain:status s="serverDeleteProhibited"/>
S: <domain:status s="serverTransferProhibited"/>
S: <domain:registrant>jd1234</domain:registrant>
S: <domain:contact type="admin">sh8013</domain:contact>
S: <domain:contact type="tech">sh8013</domain:contact>
S: <domain:clID>ClientX</domain:clID>
S: <domain:crID>ClientY</domain:crID>
S: <domain:crDate>2012-04-03T22:00:00.0Z</domain:crDate>
S: <domain:upID>ClientZ</domain:upID>
S: <domain:upDate>2013-10-22T14:25:57.0Z</domain:upDate>
S: <domain:exDate>2014-04-03T22:00:00.0Z</domain:exDate>
S: </domain:infData>
S: </resData>
S: <extension>
S: <changePoll:changeData
S: xmlns:changePoll="urn:ietf:params:xml:ns:changePoll-1.0"
S: state="after">
S: <changePoll:operation>update</changePoll:operation>
S: <changePoll:date>2013-10-22T14:25:57.0Z</changePoll:date>
S: <changePoll:svTRID>12345-XYZ</changePoll:svTRID>
S: <changePoll:who>URS Admin</changePoll:who>
S: <changePoll:caseId type="urs">urs123</changePoll:caseId>
S: <changePoll:reason>URS Lock</changePoll:reason>
S: </changePoll:changeData>
S: </extension>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54321-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>Next up is a custom "sync" operation on the domain.example domain name 🍓 This one uses the default "after" state, so the "after" state is reflected in the <resData> block:
S:<?xml version="1.0" encoding="UTF-8"?>
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 id="201" count="1">
S: <qDate>2013-10-22T14:25:57.0Z</qDate>
S: <msg>Registry initiated Sync of Domain Expiration Date</msg>
S: </msgQ>
S: <resData>
S: <domain:infData
S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S: <domain:name>domain.example</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:clID>ClientX</domain:clID>
S: <domain:crID>ClientY</domain:crID>
S: <domain:crDate>2012-04-03T22:00:00.0Z</domain:crDate>
S: <domain:upID>ClientZ</domain:upID>
S: <domain:upDate>2013-10-22T14:25:57.0Z</domain:upDate>
S: <domain:exDate>2014-04-03T22:00:00.0Z</domain:exDate>
S: </domain:infData>
S: </resData>
S: <extension>
S: <changePoll:changeData
S: xmlns:changePoll="urn:ietf:params:xml:ns:changePoll-1.0">
S: <changePoll:operation op="sync">custom
S: </changePoll:operation>
S: <changePoll:date>2013-10-22T14:25:57.0Z</changePoll:date>
S: <changePoll:svTRID>12345-XYZ</changePoll:svTRID>
S: <changePoll:who>CSR</changePoll:who>
S: <changePoll:reason lang="en">Customer sync request
S: </changePoll:reason>
S: </changePoll:changeData>
S: </extension>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54321-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>Now for a "delete" operation on the domain.example domain name that gets immediately purged 🦋 This one shows the "before" state, which is reflected in the <resData> block:
S:<?xml version="1.0" encoding="UTF-8"?>
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 id="200" count="1">
S: <qDate>2013-10-22T14:25:57.0Z</qDate>
S: <msg>Registry initiated delete of
S: domain resulting in immediate purge.</msg>
S: </msgQ>
S: <resData>
S: <domain:infData
S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S: <domain:name>domain.example</domain:name>
S: <domain:roid>EXAMPLE1-REP</domain:roid>
S: <domain:clID>ClientX</domain:clID>
S: </domain:infData>
S: </resData>
S: <extension>
S: <changePoll:changeData
S: xmlns:changePoll="urn:ietf:params:xml:ns:changePoll-1.0"
S: state="before">
S: <changePoll:operation op="purge">delete
S: </changePoll:operation>
S: <changePoll:date>2013-10-22T14:25:57.0Z
S: </changePoll:date>
S: <changePoll:svTRID>12345-XYZ
S: </changePoll:svTRID>
S: <changePoll:who>ClientZ
S: </changePoll:who>
S: <changePoll:reason>Court order
S: </changePoll:reason>
S: </changePoll:changeData>
S: </extension>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54321-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>Last one for this part! ✨ It's an "autoPurge" operation on the domain.example domain name that previously had the "pendingDelete" status 👑 This example uses the "before" state, which is reflected in the <resData> block:
Okay so first up is the poll message we've been building toward 💅 This is what the server sends back when an autoPurge happens:
S:<?xml version="1.0" encoding="UTF-8"?>
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
S: </msg>
S: </result>
S: <msgQ id="200" count="1">
S: <qDate>2013-10-22T14:25:57.0Z</qDate>
S: <msg>Registry purged domain with pendingDelete status.
S: </msg>
S: </msgQ>
S: <resData>
S: <domain:infData
S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S: <domain:name>domain.example</domain:name>
S: <domain:roid>EXAMPLE1-REP</domain:roid>
S: <domain:status s="pendingDelete"/>
S: <domain:clID>ClientX</domain:clID>
S: </domain:infData>
S: </resData>
S: <extension>
S: <changePoll:changeData
S: xmlns:changePoll="urn:ietf:params:xml:ns:changePoll-1.0"
S: state="before">
S: <changePoll:operation>autoPurge
S: </changePoll:operation>
S: <changePoll:date>2013-10-22T14:25:57.0Z
S: </changePoll:date>
S: <changePoll:svTRID>12345-XYZ
S: </changePoll:svTRID>
S: <changePoll:who>Batch
S: </changePoll:who>
S: <changePoll:reason>Past pendingDelete 5 day period
S: </changePoll:reason>
S: </changePoll:changeData>
S: </extension>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54321-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>The following is an example poll <info> response with the <changePoll:changeData> extension for an "update" operation on the ns1.domain.example host, with the default "after" state. The "after" state is reflected in the <resData> block:
S:<?xml version="1.0" encoding="UTF-8"?>
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 id="201" count="1">
S: <qDate>2013-10-22T14:25:57.0Z</qDate>
S: <msg>Registry initiated update of host.</msg>
S: </msgQ>
S: <resData>
S: <host:infData
S: xmlns:host="urn:ietf:params:xml:ns:host-1.0">
S: <host:name>ns1.domain.example</host:name>
S: <host:roid>NS1_EXAMPLE1-REP</host:roid>
S: <host:status s="linked"/>
S: <host:status s="serverUpdateProhibited"/>
S: <host:status s="serverDeleteProhibited"/>
S: <host:addr ip="v4">192.0.2.2</host:addr>
S: <host:addr ip="v6">2001:db8:0:0:1:0:0:1</host:addr>
S: <host:clID>ClientX</host:clID>
S: <host:crID>ClientY</host:crID>
S: <host:crDate>2012-04-03T22:00:00.0Z</host:crDate>
S: <host:upID>ClientY</host:upID>
S: <host:upDate>2013-10-22T14:25:57.0Z</host:upDate>
S: </host:infData>
S: </resData>
S: <extension>
S: <changePoll:changeData
S: xmlns:changePoll="urn:ietf:params:xml:ns:changePoll-1.0">
S: <changePoll:operation>update</changePoll:operation>
S: <changePoll:date>2013-10-22T14:25:57.0Z</changePoll:date>
S: <changePoll:svTRID>12345-XYZ</changePoll:svTRID>
S: <changePoll:who>ClientZ</changePoll:who>
S: <changePoll:reason>Host Lock</changePoll:reason>
S: </changePoll:changeData>
S: </extension>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54321-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>3.1.3. EPP <transfer> Command ✨
Good news, bestie 🌸 This extension doesn't add any elements to the EPP <transfer> query command or <transfer> response described in the [RFC5730]. Nothing new to memorize here, we're literally just vibing 🫶
3.2. EPP Transform Commands
3.2. EPP Transform Commands 🦋
EPP gives us five transform commands: <create> to create an instance of an object, <delete> to delete an instance of an object, <renew> to extend the validity period of an object, <transfer> to manage object-sponsorship changes, and <update> to change information associated with an object. Five commands, five main character moments 👑
3.2.1. EPP <create> Command
Lowkey simple: this extension doesn't add any elements to the EPP <create> command or <create> response described in [RFC5730]. 💖
3.2.2. EPP <delete> Command
Same energy here 🙈 This extension doesn't add any elements to the EPP <delete> command or <delete> response described in [RFC5730].
3.2.3. EPP <renew> Command
No new elements for <renew> either ✨ This extension doesn't add any elements to the EPP <renew> command or <renew> response described in [RFC5730].
3.2.4. EPP <transfer> Command
The <transfer> transform gets the same treatment 🦋 This extension doesn't add any elements to the EPP <transfer> command or <transfer> response described in [RFC5730].
3.2.5. EPP <update> Command
And last but not least, <update> 💅 This extension doesn't add any elements to the EPP <update> command or <update> response described in [RFC5730].
4. Formal Syntax ✨
Okay here's the schema bit, and it's giving official 📜 Only one schema lives in this section: the EPP Change Poll Extension schema. It's a complete schema representation of the object mapping, built so automated validation of EPP XML instances can actually work. The BEGIN and END tags aren't part of the schema. They just mark where it starts and ends for URI registration purposes 🎀
4.1. Change Poll Extension Schema
BEGIN
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="urn:ietf:params:xml:ns:changePoll-1.0"
xmlns:eppcom="urn:ietf:params:xml:ns:eppcom-1.0"
xmlns:epp="urn:ietf:params:xml:ns:epp-1.0"
xmlns:changePoll="urn:ietf:params:xml:ns:changePoll-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"/>
<annotation>
<documentation>
Extensible Provisioning Protocol v1.0
Change Poll Mapping Schema.
</documentation>
</annotation>
<!--
Change element.
-->
<element name="changeData" type="changePoll:changeDataType"/>
<!--
Attributes associated with the change.
-->
<complexType name="changeDataType">
<sequence>
<element name="operation" type="changePoll:operationType"/>
<element name="date" type="dateTime"/>
<element name="svTRID" type="epp:trIDStringType"/>
<element name="who" type="changePoll:whoType"/>
<element name="caseId" type="changePoll:caseIdType"
minOccurs="0"/>
<element name="reason" type="eppcom:reasonType"
minOccurs="0"/>
</sequence>
<attribute name="state" type="changePoll:stateType"
default="after"/>
</complexType>
<!--
Enumerated list of operations, with extensibility via "custom".
-->
<simpleType name="operationEnum">
<restriction base="token">
<enumeration value="create"/>
<enumeration value="delete"/>
<enumeration value="renew"/>
<enumeration value="transfer"/>
<enumeration value="update"/>
<enumeration value="restore"/>
<enumeration value="autoRenew"/>
<enumeration value="autoDelete"/>
<enumeration value="autoPurge"/>
<enumeration value="custom"/>
</restriction>
</simpleType>
<!--
Enumerated state of the object in the poll message.
-->
<simpleType name="stateType">
<restriction base="token">
<enumeration value="before"/>
<enumeration value="after"/>
</restriction>
</simpleType>
<!--
Transform operation type
-->
<complexType name="operationType">
<simpleContent>
<extension base="changePoll:operationEnum">
<attribute name="op" type="token"/>
</extension>
</simpleContent>
</complexType>
<!--
Case identifier type
-->
<complexType name="caseIdType">
<simpleContent>
<extension base="token">
<attribute name="type" type="changePoll:caseTypeEnum"
use="required"/>
<attribute name="name" type="token"
use="optional"/>
</extension>
</simpleContent>
</complexType>
<!--
Enumerated list of case identifier types
-->
<simpleType name="caseTypeEnum">
<restriction base="token">
<enumeration value="udrp"/>
<enumeration value="urs"/>
<enumeration value="custom"/>
</restriction>
</simpleType>
<!--
Who type
-->
<simpleType name="whoType">
<restriction base="normalizedString">
<minLength value="1"/>
<maxLength value="255"/>
</restriction>
</simpleType>
<!--
End of schema.
-->
</schema>
END5. IANA Considerations ✨
5.1. XML Namespace
This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism described in [RFC3688]. Registry vibes, but make it IANA 🌈 The following URI assignment has been made by IANA:
Registration for the changePoll namespace:
URI: urn:ietf:params:xml:ns:changePoll-1.0
Registrant Contact: IESG
XML: None. Namespace URIs do not represent an XML specification.
Registration for the changePoll XML schema:
URI: urn:ietf:params:xml:ns:changePoll-1.0
Registrant Contact: IESG
XML: See the "Formal Syntax" section of this document.5.2. EPP Extension Registry
The EPP extension described in this document has been registered by the IANA in the Extensions for the "Extensible Provisioning Protocol (EPP)" registry described in [RFC7451]. Our extension is officially in the registry now, bestie 🥹 Here are the details:
Name of Extension: Change Poll Extension for the Extensible
Provisioning Protocol (EPP)
Document Status: Standards Track
Reference: RFC 8590
Registrant Name and Email Address: IESG <iesg@ietf.org>
TLDs: Any
IPR Disclosure: None
Status: Active
Notes: None6. Security Considerations ✨
Okay, this part is seriously important, so no skipping it 🚨
The mapping extensions described in this document do not provide any security services beyond those described by EPP [RFC5730] and protocol layers used by EPP. The security considerations described in these other specifications apply to this specification as well. Basically, the extension doesn't bring its own security protections, so everything EPP [RFC5730] and its underlying layers already do still applies here 🔒💀
7. References ✨
7.1. Normative References
okay so the normative refs are the ones the spec needs you to read, bestie 📚✨ here they are, copied exactly:
[RFC20] Cerf, V., "ASCII format for network interchange", STD 80,
RFC 20, DOI 10.17487/RFC0020, October 1969,
<https://www.rfc-editor.org/info/rfc20>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
[RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for
the Extensible Provisioning Protocol (EPP)", RFC 3915,
DOI 10.17487/RFC3915, September 2004,
<https://www.rfc-editor.org/info/rfc3915>.
[RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)",
STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009,
<https://www.rfc-editor.org/info/rfc5730>.
[RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
Domain Name Mapping", STD 69, RFC 5731,
DOI 10.17487/RFC5731, August 2009,
<https://www.rfc-editor.org/info/rfc5731>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[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>.7.2. Informative References
these ones are just helpful extra reading, not required 🦋
[RFC7451] Hollenbeck, S., "Extension Registry for the Extensible
Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451,
February 2015, <https://www.rfc-editor.org/info/rfc7451>.Acknowledgments 🫶
the authors wanted to give a big shoutout to the original concept for this doc, plus the work on the early versions by Trung Tran and Sharon Wodjenski 💖
special suggestions that made it into the doc came from Scott Hollenbeck, Michael Holloway, and Patrick Mevzek 👑
Authors' Addresses 💌
and here are the people who wrote it, in case you wanna slide into their inbox 💅
James Gould
VeriSign, Inc.
12061 Bluemont Way
Reston, VA 20190
United States of America
Email: jgould@verisign.com
URI: http://www.verisign.com
Kal Feher
Neustar
lvl 8/10 Queens Road
Melbourne, VIC 3004
Australia
Email: ietf@feherfamily.org
URI: http://www.neustar.biz📦 where this page comes from
- ietf: rfc8590 2019-05
- 💖 girlified by claude-haiku-5-5 on : a language model's rewrite of the original, under its terms