]> VeriSign, Inc.

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

Neustar

lvl 8/10 Queens Road Melbourne VIC 3004 AU ietf@feherfamily.org 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 extension only extends the EPP <poll> response in and does not extend the EPP <poll> command. Please refer to for information and examples of the EPP <poll> command.

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 interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here. 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. The XML namespace prefix "changePoll" is used for the namespace "urn:ietf:params:xml:ns:changePoll-1.0", 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 an identifier, represented in the 7-bit US-ASCII character set defined in , that is used to define a sub-operation or the name of a "custom" operation. The enumerated list of <changePoll:operation> values is: 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 that MUST set the "op" attribute with one of the possible transfer type values that include "request", "approve", "cancel", or "reject". Update operation as defined in . Restore operation as defined in that MUST set the "op" attribute with one of the possible restore type values that include "request" or "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 MUST set the "op" attribute with the custom operation name. The custom operations supported is up to server policy.

The state attribute reflects the state of the object "before" or "after" the operation. The state is defined using the OPTIONAL "state" attribute of the <changePoll:changeData> element, with the possible values "before" or "after" and with a default value of "after". The server MAY support both the "before" state and the "after" state of the operation, by using one poll message for the "before" state and one poll message for the "after" state. The "before" state poll message MUST be inserted into the message queue prior to the "after" state poll message. For operations in that don't have an "after" state, the server MUST use the "before" state poll message. For example, for the "delete" operation with the "op" attribute set to "purge", or the "autoPurge" operation, the server includes the state of the object prior to being purged in the "before" state poll message. For operations in that don't have a "before" state, the server MUST use the "after" state poll message. For example, for the "create" operation, the server includes the state of the object after creation in the "after" state poll message.

The <changePoll:who> element defines who executed the operation for audit purposes. It is a freeform value that is strictly meant for audit purposes and not meant to drive client-side logic. The scheme used for the possible set of <changePoll:who> element values is up to server policy. The server MAY identify the <changePoll:who> element value 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.

Date and time attribute values MUST be represented in Universal Coordinated Time (UTC) using the Gregorian calendar. The extended date-time form using upper case "T" and "Z" characters defined in MUST be used to represent date-time values, as XML Schema does not support truncated date-time forms or lower case "T" and "Z" characters.

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 operation detail of EPP object mapping operations to an EPP poll response, as described in . The extension is an extension of the EPP object mapping info response. 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 as defined in . 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. The OPTIONAL "name" attribute is an identifier, represented in the 7-bit US-ASCII character set defined in , that is used to define the name of the "custom" case type. The enumerated list of case types is: 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 "before" state. The "before" 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: delete S: S: 2013-10-22T14:25:57.0Z S: S: 12345-XYZ S: S: ClientZ S: S: Court order S: 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 "before" state. The "before" state is reflected in the <resData> block: S: S: S: S: Command completed successfully; ack to dequeue S: S: S: S: 2013-10-22T14:25:57.0Z S: Registry purged domain with pendingDelete status. S: S: S: S: S: domain.example S: EXAMPLE1-REP S: ClientX S: S: S: S: S: autoPurge S: S: 2013-10-22T14:25:57.0Z S: S: 12345-XYZ S: 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: 2001:db8:0:0:1:0:0:1 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: Registration request 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 request 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.

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

Note to RFC Editor: Please remove this section and the reference to RFC 7942 before publication. This section records the status of known implementations of the protocol defined by this specification at the time of posting of this Internet-Draft, and is based on a proposal described in RFC 7942. The description of implementations in this section is intended to assist the IETF in its decision processes in progressing drafts to RFCs. Please note that the listing of any individual implementation here does not imply endorsement by the IETF. Furthermore, no effort has been spent to verify the information presented here that was supplied by IETF contributors. This is not intended as, and must not be construed to be, a catalog of available implementations or their features. Readers are advised to note that other implementations may exist. According to RFC 7942, "this will allow reviewers and working groups to assign due consideration to documents that have the benefit of running code, which may serve as evidence of valuable experimentation and feedback that have made the implemented protocols more mature. It is up to the individual working groups to use this information as they see fit".

Organization: Verisign Inc. Name: Verisign EPP SDK Description: The Verisign EPP SDK includes both a full client implementation and a full server stub implementation of draft-ietf-regext-change-poll. Level of maturity: Production Coverage: All aspects of the protocol are implemented. Licensing: GNU Lesser General Public License Contact: jgould@verisign.com URL: https://www.verisign.com/en_US/channel-resources/domain-registry-products/epp-sdks

Organization: Verisign Inc. Name: Verisign Consolidated Top Level Domain (CTLD) Shared Registry System (SRS) Description: The Verisign Consolidated Top Level Domain (CTLD) Shared Registry System (SRS) implements the server-side of draft-ietf-regext-change-poll for a variety of Top Level Domains (TLD's). Level of maturity: Production Coverage: The "after" state poll message for an "update" transform operation of a domain name due to server policy. Licensing: Proprietary Contact: jgould@verisign.com

Organization: Verisign Inc. Name: Verisign .COM / .NET Shared Registry System (SRS) Description: The Verisign Shared Registry System (SRS) for .COM and .NET implements the server-side of draft-ietf-regext-change-poll. Level of maturity: Production Coverage: The "after" state poll message for an "update" transform operation of a domain name due to server policy. Licensing: Proprietary Contact: jgould@verisign.com

Organisation: Neustar Inc. Name: Neustar EPP SDK Description: The Neustar EPP SDK includes a full client implementation of draft-ietf-regext-change-poll. Level of maturity: Production Coverage: All client side aspects of the protocol are implemented. Licensing: GNU Lesser General Public License Contact: quoc-anh.np@team.neustar

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 and Sharon Wodjenski. Special suggestions that have been incorporated into this document were provided by Scott Hollenbeck, Michael Holloway, and Patrick Mevzek.

&RFC0020; &RFC2119; &RFC3688; &RFC3915; &RFC5730; &RFC5731; &RFC7942; &W3C.REC-xmlschema-2-20041028; &RFC7451; &RFC8174;

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.

Changed to regext working group draft by changing draft-gould-change-poll to draft-ietf-regext-change-poll.

Ping update.

Added the Implementation Status section.

Changed Neustar author to Kal Feher.

Added Neustar implementation to the Implementation Status section.

Updates based on feedback from Patrick Mevzek, that include: Added a missing comma to "Using this extension, clients" in the Introduction section. Modified the description of the "transfer", "restore", and "custom" operations to include "MUST set the "op" attribute" language. Rephrased the first sentence of the Who section. Added references to the <changePoll:who> element in the Who section. Revise the sentence that describes how the extension extends the info response in the EPP <info> Command section. Refer to EPP Object Mapping as EPP object mapping throughout the document. Add a Dates and Times section to the Object Attributes section.

Added the "State" sub-section to the "Object Attributes" section to describe the expected behavior for the "before" and "after" states, based on feedback from Patrick Mevzek. Added a colon suffix to each hangText entry to provide better separation.

Updates based on feedback from Scott Hollenbeck, that include: Changed MAY to may in the Abstract. Revised the "IANA Considerations" section to include the registration of the XML schema. Revised the description of the <changePoll:caseId> "name" attribute and the "changePoll:operation> "op" attribute as containing 7-bit US-ASCII identifiers for the case type or the operation type, respectively.

Updated obsoleted RFC 6982 to RFC 7942. Moved RFC 7451 to an informational reference based on a check done by the Idnits Tool. Changed Kal Feher's contact e-mail address. Changed Neustar's Implementation Status contact e-mail address.

Fixed Section 1.1 (Conventions) to contain the updated language (e.g. "NOT RECOMMENDED", RFC 8174, BCP 14), based on feedback from the Document Shepherd.

Updates based on the AD review by Adam Roach, that include: Fix the "purge" and "autoPurge" examples to use the normative "before" state instead of the default "after" state. Added the sentences "The extension only extends the EPP <poll> response in and does not extend the EPP <poll> command. Please refer to for information and examples of the EPP <poll> command." in the "Introduction" to clarify what is extended and reference for the EPP <poll> command. Added missing hyphens to "client-sponsored" and "court-directed". Removed "changePoll-1.0" is used as an abbreviation for "urn:ietf:params:xml:ns:changePoll-1.0" and replaced the paragraph based on what was done in draft-ietf-regext-allocation-token. Changed normative "SHOULD" to non-normative "should" in "An operation consists of any transform operation that impacts objects that the client sponsers and should be notified of." Added normative reference to to define "7-bit US-ASCII". Added the sentence "The custom operations supported is up to server policy." to the description of the "custom" operation. Broke up the "This extension adds operation detail..." sentence into two seperate sentences to address the "does" and the "is" seperately. Removed the commas from "Any transform operation to an object..." sentence. Changed to use an IPv6 address from the documentation-only prefix "2001:DB8::/32" in RFC 3849. The IPv6 address 2001:db8:0:0:1:0:0:1 was used.

Updates based on the review by Benjamin Kaduk, that include: Change references of "The enumerated list ... include:" to "The enumerated list ... is:". In section 2.2, explicitly state what the message is inserted into, with the change of "... MUST be inserted prior to ..." to "... MUST be inserted into the message queue prior to ...".

Added clarification for the <changePoll:who> element based on the feedback from Benjamin Kaduk.