| Network Working Group | J. Gould |
| Internet-Draft | VeriSign, Inc. |
| Intended status: Standards Track | S. Wodjenski |
| Expires: September 16, 2016 | Neustar |
| March 15, 2016 |
Change Poll Extension for the Extensible Provisioning Protocol (EPP)
draft-gould-change-poll-04
This document describes an Extensible Provisioning Protocol (EPP) extension for notifying clients of operations on client sponsored objects that were not initiated by the client through EPP. These operations MAY include contractual or policy requirements including but not limited to regular batch processes, customer support actions, Uniform Domain-Name Dispute-Resolution Policy (UDRP) or Uniform Rapid Suspension (URS) actions, court directed actions, and bulk updates based on customer requests. Since the client is not directly involved or knowledgable of these operations, the extension is used along with an EPP object mapping to provide the resulting state of the post-operation object, and optionally a pre-operation object, with the operation meta-data of what, when, who, and why.
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."
This Internet-Draft will expire on September 16, 2016.
Copyright (c) 2016 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 (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
This document describes an extension mapping for version 1.0 of the Extensible Provisioning Protocol (EPP) [RFC5730]. This mapping, an extension to EPP object mappings like the EPP domain name mapping [RFC5731], is used to notify clients of operations they are not directly involved in, on objects that the client sponsors. It is up to server policy to determine what transform operations and clients to notify. Using this extension clients can more easily keep their systems in-sync with the objects stored in the server. When a change occurs that a client needs to be notified of, a poll message can be inserted by the server for consumption by the client using the EPP <poll> command and response defined in [RFC5730]. The extension supports including a "before" operation poll message and an "after" operation poll message.
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 RFC 2119 [RFC2119].
XML is case sensitive. Unless stated otherwise, XML specifications and examples provided in this document MUST be interpreted in the character case presented in order to develop a conforming implementation.
In examples, "C:" represents lines sent by a protocol client and "S:" represents lines returned by a protocol server. Indentation and white space in examples are provided only to illustrate element relationships and are not a REQUIRED feature of this protocol.
"changePoll-1.0" is used as an abbreviation for "urn:ietf:params:xml:ns:changePoll-1.0". The XML namespace prefix "changePoll" is used, but implementations MUST NOT depend on it and instead employ a proper namespace-aware XML parser and serializer to interpret and output the XML documents.
This extension adds additional elements to EPP object mappings like the EPP domain name mapping [RFC5731]. Only those new elements are described here.
An operation consists of any transform operation that impacts objects that the client sponsers and SHOULD be notified of. The <changePoll:operation> element defines the operation. The OPTIONAL "op" attribute is used to define a sub-operation or the name of a "custom" operation. The enumerated list of <changePoll:operation> values include:
Who defines who executed the operation for audit purposes, and is represented using the <changePoll:who> element. The scheme used for the possible set of Who values is up to server policy. The server MAY identify Who based on:
A detailed description of the EPP syntax and semantics can be found in the EPP core protocol specification [RFC5730].
EPP provides three commands to retrieve object information: <check> to determine if an object is known to the server, <info> to retrieve detailed information associated with an object, and <transfer> to retrieve object transfer status information.
This extension does not add any elements to the EPP <check> command or <check> response described in the [RFC5730].
This extension does not add any elements to the EPP <info> command described in the [RFC5730].
This extension adds transaction detail of the operations to the EPP <info> poll response, as described in [RFC5730], of an EPP Object Mapping like [RFC5731]. 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 for inserting an EPP poll message with the operation detail. The sponsoring client will then receive the state of the object with operation detail like what, who, when, and why the object was changed. The <changePoll:changeData> element contains the operation detail along with an indication of whether the object reflects the state before or after the operation, using the OPTIONAL "state" attribute, with the possible values of "before" or "after", and with a default value of "after". The "state" attribute describes the state of the response data or <resData> block returned in the poll response. The server MAY support providing the "before" state and "after" state to the operation, by using one poll message for the "before" state and one poll message for the "after" state. When using the "before" state poll message, it MUST be inserted prior to the "after" state poll message. The <changePoll:changeData> element includes the operation detail with the following child elements:
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>
Example poll <info> response with the <changePoll:changeData> extension for a URS lock transaction on the domain.example domain name, 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>
Example poll <info> response with the <changePoll:changeData> extension for a custom "sync" operation on the domain.example domain name, 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 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>
Example poll <info> response with the <changePoll:changeData> extension for a "delete" operation on the domain.example domain name that is immediately purged, 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="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: <changePoll:operation op="purge"> S: delete</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>Court order</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>
Example poll <info> response with the <changePoll:changeData> extension for an "autoPurge" operation on the domain.example domain name that previously had the "pendingDelete" status, 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="200" count="1"> S: <qDate>2013-10-22T14:25:57.0Z</qDate> S: <msg>Registry purged domain with pendingDelete status.</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: <changePoll:operation> S: autoPurge</changePoll:operation> S: <changePoll:date>2013-10-22T14:25:57.0Z</changePoll:date> S: <changePoll:svTRID>12345-XYZ</changePoll:svTRID> S: <changePoll:who>Batch</changePoll:who> S: <changePoll:reason> S: 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>
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">1080:0:0:0:8:800:200C:417A</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>
This extension does not add any elements to the EPP <transfer> query command or <transfer> response described in the [RFC5730].
EPP provides five commands to transform objects: <create> to create an instance of an object, <delete> to delete an instance of an object, <renew> to extend the validity period of an object, <transfer> to manage object sponsorship changes, and <update> to change information associated with an object.
This extension does not add any elements to the EPP <create> command or <create> response described in the [RFC5730].
This extension does not add any elements to the EPP <delete> command or <delete> response described in the [RFC5730].
This extension does not add any elements to the EPP <renew> command or <renew> response described in the [RFC5730].
This extension does not add any elements to the EPP <transfer> command or <transfer> response described in the [RFC5730].
This extension does not add any elements to the EPP <update> command or <update> response described in the [RFC5730].
One schema is presented here that is the EPP Change Poll Extension schema.
The formal syntax presented here is a complete schema representation of the object mapping suitable for automated validation of EPP XML instances. The BEGIN and END tags are not part of the schema; they are used to note the beginning and ending of the schema for URI registration purposes.
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 of 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>
END
This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism described in [RFC3688]. The following URI assignment is requested of IANA:
URI: urn:ietf:params:xml:ns:changePoll-1.0
Registrant Contact: See the "Author's Address" section of this document.
XML: See the "Formal Syntax" section of this document.
The EPP extension described in this document should be registered by the IANA in the EPP Extension Registry described in [RFC7451]. The details of the registration are as follows:
Name of Extension: "Change Poll Extension for the Extensible Provisioning Protocol (EPP)"
Document status: Standards Track
Reference: (insert reference to RFC version of this document)
Registrant Name and Email Address: IESG, <iesg@ietf.org>
TLDs: Any
IPR Disclosure: None
Status: Active
Notes: None
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.
The authors wish to acknowledge the original concept for this draft and the efforts in the initial versions of this draft by Trung Tran.
Special suggestions that have been incorporated into this document were provided by Michael Holloway.
| [RFC2119] | Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997. |
| [RFC3688] | Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004. |
| [RFC3915] | Hollenbeck, S., "Domain Registry Grace Period Mapping for the Extensible Provisioning Protocol (EPP)", RFC 3915, DOI 10.17487/RFC3915, September 2004. |
| [RFC5730] | Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009. |
| [RFC5731] | Hollenbeck, S., "Extensible Provisioning Protocol (EPP) Domain Name Mapping", STD 69, RFC 5731, DOI 10.17487/RFC5731, August 2009. |
| [RFC7451] | Hollenbeck, S., "Extension Registry for the Extensible Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, February 2015. |