]> VeriSign, Inc.

12061 Bluemont Way Reston VA 20190 US jgould@verisign.com http://www.verisigninc.com

Neustar

21575 Ridgetop Circle Sterling VA 20166 US Sharon.Wodjenski@neustar.biz http://www.neustar.biz

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 document describes an extension mapping for version 1.0 of the Extensible Provisioning Protocol (EPP). This mapping, an extension to EPP object mappings like the EPP domain name mapping, 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 . 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. 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. 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: Create operation as defined in . Delete operation as defined in . If the delete operation results in an immediate purge of the object, then the "op" attribute MUST be set to "purge". Renew operation as defined in . Transfer operation as defined in with the OPTIONAL "op" attribute defining the transfer type with the possible values of "request", "approve", "cancel", and "reject". Update operation as defined in . Restore operation as defined in with the OPTIONAL "op" attribute defining the restore type with the possible values of "request" and "report". Auto renew operation executed by the server. Auto delete operation executed by the server. If the "autoDelete" operation results in an immediate purge of the object, then the "op" attribute MUST be set to "purge". Auto purge operation executed by the server when removing the object after it had the "pendingDelete" status. Custom operation that uses the "op" attribute to define the custom operation name.

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: Unique user identifier of the user that executed the operation. An example is "ClientX". Name of the user that executed the operation. An example is "John Doe". Role of the user that executed operation. An example is "CSR" for a Customer Support Representative or "Batch" for a server batch.

A detailed description of the EPP syntax and semantics can be found in the EPP core protocol specification .

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 .

This extension does not add any elements to the EPP <info> command described in the . This extension adds transaction detail of the operations to the EPP <info> poll response, as described in , of an EPP Object Mapping like . 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: Transform operation executed on the object as defined in . Date and time when the operation was executed. Server transaction identifier of the operation. Who executed the operation as defined in . OPTIONAL case identifer associated with the operation. The required "type" attribute defines the type of case with an enumerated list of case types including: a Uniform Domain-Name Dispute-Resolution Policy (UDRP) case. a Uniform Rapid Suspension (URS) case. A custom case that is defined using the "name" attribute. OPTIONAL reason for executing the operation. If present, this element contains the server-specific text to help explain the reason the operation was executed. This text MUST be represented in the response language previously negotiated with the client; an OPTIONAL "lang" attribute MAY be present to identify the language if the negotiated value is something other than the default value of "en" (English).

Example 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: S: S: S: S: Command completed successfully; ack to dequeue S: S: S: 2013-10-22T14:25:57.0Z S: Registry initiated update of domain. S: S: S: S: domain.example S: EXAMPLE1-REP S: S: jd1234 S: sh8013 S: sh8013 S: ClientX S: ClientY S: 2012-04-03T22:00:00.0Z S: 2014-04-03T22:00:00.0Z S: S: S: S: S: update S: 2013-10-22T14:25:57.0Z S: 12345-XYZ S: URS Admin S: urs123 S: URS Lock S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S:]]>

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: S: S: S: S: Command completed successfully; ack to dequeue S: S: S: 2013-10-22T14:25:57.0Z S: Registry initiated update of domain. S: S: S: S: domain.example S: EXAMPLE1-REP S: S: S: S: jd1234 S: sh8013 S: sh8013 S: ClientX S: ClientY S: 2012-04-03T22:00:00.0Z S: ClientZ S: 2013-10-22T14:25:57.0Z S: 2014-04-03T22:00:00.0Z S: S: S: S: S: update S: 2013-10-22T14:25:57.0Z S: 12345-XYZ S: URS Admin S: urs123 S: URS Lock S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S:]]>

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: S: S: S: Command completed successfully; ack to dequeue S: S: S: 2013-10-22T14:25:57.0Z S: Registry initiated Sync of Domain Expiration Date S: S: S: S: domain.example S: EXAMPLE1-REP S: S: jd1234 S: sh8013 S: sh8013 S: ClientX S: ClientY S: 2012-04-03T22:00:00.0Z S: ClientZ S: 2013-10-22T14:25:57.0Z S: 2014-04-03T22:00:00.0Z S: S: S: S: S: custom S: S: 2013-10-22T14:25:57.0Z S: 12345-XYZ S: CSR S: Customer sync request S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S:]]>

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: S: S: S: Command completed successfully; ack to dequeue S: S: S: 2013-10-22T14:25:57.0Z S: Registry initiated delete of S: domain resulting in immediate purge. S: S: S: S: domain.example S: EXAMPLE1-REP S: ClientX S: S: S: S: S: S: delete S: 2013-10-22T14:25:57.0Z S: 12345-XYZ S: ClientZ S: Court order S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S:]]>

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: S: S: S: Command completed successfully; ack to dequeue S: S: S: 2013-10-22T14:25:57.0Z S: Registry purged domain with pendingDelete status. S: S: S: S: domain.example S: EXAMPLE1-REP S: ClientX S: S: S: S: S: S: autoPurge S: 2013-10-22T14:25:57.0Z S: 12345-XYZ S: Batch S: S: Past pendingDelete 5 day period S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S:]]>

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: S: S: S: Command completed successfully; ack to dequeue S: S: S: 2013-10-22T14:25:57.0Z S: Registry initiated update of host. S: S: S: S: ns1.domain.example S: NS1_EXAMPLE1-REP S: S: S: S: 192.0.2.2 S: 1080:0:0:0:8:800:200C:417A S: ClientX S: ClientY S: 2012-04-03T22:00:00.0Z S: ClientY S: 2013-10-22T14:25:57.0Z S: S: S: S: S: update S: 2013-10-22T14:25:57.0Z S: 12345-XYZ S: ClientZ S: Host Lock S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S:]]>

This extension does not add any elements to the EPP <transfer> query command or <transfer> response described in the .

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 .

This extension does not add any elements to the EPP <delete> command or <delete> response described in the .

This extension does not add any elements to the EPP <renew> command or <renew> response described in the .

This extension does not add any elements to the EPP <transfer> command or <transfer> response described in the .

This extension does not add any elements to the EPP <update> command or <update> response described in the .

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.

Extensible Provisioning Protocol v1.0 Change Poll Mapping Schema. END]]>

This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism described in . 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 . 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 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; &RFC3688; &RFC3915; &RFC5730; &RFC5731; &RFC7451;

Added an optional caseId element that defines the case identifier from UDRP, URS, or custom case, based on feedback from Michael Holloway.

Amended XML Namespace section of IANA Considerations, added EPP Extension Registry section. Moved Change History to the back section as an Appendix.

Fixed "before" state example to use the "before" state value based on feedback from Patrick Mevzek.

Updated the authors for the draft.

Ping update.