--- 1/draft-ietf-regext-change-poll-09.txt 2018-10-22 11:15:05.757424263 -0700 +++ 2/draft-ietf-regext-change-poll-10.txt 2018-10-22 11:15:05.805425426 -0700 @@ -1,29 +1,29 @@ Network Working Group J. Gould Internet-Draft VeriSign, Inc. Intended status: Standards Track K. Feher -Expires: April 7, 2019 Neustar - October 4, 2018 +Expires: April 25, 2019 Neustar + October 22, 2018 Change Poll Extension for the Extensible Provisioning Protocol (EPP) - draft-ietf-regext-change-poll-09 + draft-ietf-regext-change-poll-10 Abstract This document describes an Extensible Provisioning Protocol (EPP) - extension for notifying clients of operations on client sponsored + 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 + 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. Status of This Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. @@ -31,21 +31,21 @@ 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 April 7, 2019. + This Internet-Draft will expire on April 25, 2019. Copyright Notice Copyright (c) 2018 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 @@ -54,24 +54,24 @@ 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. 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 . . . . . . . . . . . . . . . . . . . . . . . . . . 4 + 2.2. State . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.3. Who . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.4. Dates and Times . . . . . . . . . . . . . . . . . . . . . 5 - 3. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 5 + 3. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 6 3.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 6 3.1.1. EPP Command . . . . . . . . . . . . . . . . . 6 3.1.2. EPP Command . . . . . . . . . . . . . . . . . 6 3.1.3. EPP Command . . . . . . . . . . . . . . . 16 3.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 16 3.2.1. EPP Command . . . . . . . . . . . . . . . . 16 3.2.2. EPP Command . . . . . . . . . . . . . . . . 16 3.2.3. EPP Command . . . . . . . . . . . . . . . . . 16 3.2.4. EPP Command . . . . . . . . . . . . . . . 16 3.2.5. EPP Command . . . . . . . . . . . . . . . . 16 @@ -82,115 +82,119 @@ 5.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 20 6. Implementation Status . . . . . . . . . . . . . . . . . . . . 20 6.1. Verisign EPP SDK . . . . . . . . . . . . . . . . . . . . 21 6.2. Verisign Consolidated Top Level Domain (CTLD) SRS . . . . 21 6.3. Verisign .COM / .NET SRS . . . . . . . . . . . . . . . . 22 6.4. Neustar EPP SDK . . . . . . . . . . . . . . . . . . . . . 22 7. Security Considerations . . . . . . . . . . . . . . . . . . . 22 8. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 22 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 23 9.1. Normative References . . . . . . . . . . . . . . . . . . 23 - 9.2. Informative References . . . . . . . . . . . . . . . . . 23 + 9.2. Informative References . . . . . . . . . . . . . . . . . 24 Appendix A. Change History . . . . . . . . . . . . . . . . . . . 24 A.1. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 24 A.2. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 24 A.3. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 24 A.4. Change from 03 to 04 . . . . . . . . . . . . . . . . . . 24 A.5. Change from 04 to 05 . . . . . . . . . . . . . . . . . . 24 A.6. Change from 05 to REGEXT 00 . . . . . . . . . . . . . . . 24 A.7. Change from REGEXT 00 to REGEXT 01 . . . . . . . . . . . 24 - A.8. Change from REGEXT 01 to REGEXT 02 . . . . . . . . . . . 24 + A.8. Change from REGEXT 01 to REGEXT 02 . . . . . . . . . . . 25 A.9. Change from REGEXT 02 to REGEXT 03 . . . . . . . . . . . 25 A.10. Change from REGEXT 03 to REGEXT 04 . . . . . . . . . . . 25 A.11. Change from REGEXT 04 to REGEXT 05 . . . . . . . . . . . 25 A.12. Change from REGEXT 05 to REGEXT 06 . . . . . . . . . . . 25 A.13. Change from REGEXT 06 to REGEXT 07 . . . . . . . . . . . 25 A.14. Change from REGEXT 07 to REGEXT 08 . . . . . . . . . . . 26 A.15. Change from REGEXT 08 to REGEXT 09 . . . . . . . . . . . 26 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 26 + A.16. Change from REGEXT 09 to REGEXT 10 . . . . . . . . . . . 26 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 27 1. Introduction 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 command and response defined in [RFC5730]. The extension supports including a "before" operation poll message and an "after" - operation poll message. + operation poll message. The extension only extends the EPP + response in [RFC5730] and does not extend the EPP command. + Please refer to [RFC5730] for information and examples of the EPP + command. 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 interpreted as described in BCP 14 [RFC2119] [RFC8174] 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. - "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. + 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. 2. Object Attributes This extension adds additional elements to EPP object mappings like the EPP domain name mapping [RFC5731]. Only those new elements are described here. 2.1. Operation An operation consists of any transform operation that impacts objects - that the client sponsers and SHOULD be notified of. The + that the client sponsers and should be notified of. The element defines the operation. The OPTIONAL "op" attribute is an identifier, represented in the 7-bit US-ASCII - character set, that is used to define a sub-operation or the name of - a "custom" operation. The enumerated list of - values include: + character set defined in [RFC0020], that is used to define a sub- + operation or the name of a "custom" operation. The enumerated list + of values include: "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 the "op" attribute MUST be set to "purge". "renew": Renew operation as defined in [RFC5730]. "transfer": Transfer operation as defined in [RFC5730] that MUST set the "op" attribute with one of the possible transfer type values that include "request", "approve", "cancel", or "reject". "update": Update operation as defined in [RFC5730]. "restore": Restore operation as defined in [RFC3915] that MUST set the "op" attribute with one of the possible restore type values that include "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 the "op" attribute MUST be set to "purge". "autoPurge": Auto purge operation executed by the server when removing the object after it had the "pendingDelete" status. "custom": Custom operation that MUST set the "op" attribute with the - custom operation name. + custom operation name. The custom operations supported is up to + server policy. 2.2. State 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 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 @@ -248,50 +252,49 @@ This extension does not add any elements to the EPP command or response described in the [RFC5730]. 3.1.2. EPP Command This extension does not add any elements to the EPP command described in the [RFC5730]. This extension adds operation detail of EPP object mapping operations - Section 2.1 to an EPP poll response, as described in [RFC5730], that - 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 + Section 2.1 to an EPP poll response, as described in [RFC5730]. 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 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 element contains the operation detail along with an indication of whether the object reflects the state before or after the operation as defined in Section 2.2. The element includes the operation detail with the following child elements: : Transform operation executed on the object as defined in Section 2.1. : Date and time when the operation was executed. : Server transaction identifier of the operation. : Who executed the operation as defined in Section 2.3. : 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, that is used to - define the name of the "custom" case type. The enumerated list - of case types include: + represented in the 7-bit US-ASCII character set defined in + [RFC0020], that is used to define the name of the "custom" case + type. The enumerated list of case types include: 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. : 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). @@ -443,22 +446,22 @@ S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: Example poll response with the 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 block: + that is immediately purged, with the "before" state. The "before" + state is reflected in the block: S: S: S: S: S: Command completed successfully; ack to dequeue S: S: S: 2013-10-22T14:25:57.0Z S: Registry initiated delete of @@ -467,69 +470,79 @@ 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: xmlns:changePoll="urn:ietf:params:xml:ns:changePoll-1.0" + S: state="before"> + 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 response with the 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 + name that previously had the "pendingDelete" status, with the + "before" state. The "before" state is reflected in the block: S: S: S: S: - S: Command completed successfully; ack to dequeue + 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: Registry purged domain with pendingDelete status. + S: 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: xmlns:changePoll="urn:ietf:params:xml:ns:changePoll-1.0" + S: state="before"> + 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 response with the @@ -549,21 +562,21 @@ 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: 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: @@ -914,20 +927,24 @@ and Sharon Wodjenski. Special suggestions that have been incorporated into this document were provided by Scott Hollenbeck, Michael Holloway, and Patrick Mevzek. 9. References 9.1. Normative References + [RFC0020] Cerf, V., "ASCII format for network interchange", STD 80, + RFC 20, DOI 10.17487/RFC0020, October 1969, + . + [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 @@ -1060,20 +1078,57 @@ done by the Idnits Tool. 3. Changed Kal Feher's contact e-mail address. 4. Changed Neustar's Implementation Status contact e-mail address. A.15. Change from REGEXT 08 to REGEXT 09 1. 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. +A.16. Change from REGEXT 09 to REGEXT 10 + + 1. Updates based on the AD review by Adam Roach, that include: + + 1. Fix the "purge" and "autoPurge" examples to use the + normative "before" state instead of the default "after" + state. + 2. Added the sentences "The extension only extends the EPP + response in [RFC5730] and does not extend the EPP + command. Please refer to [RFC5730] for information + and examples of the EPP command." in the + "Introduction" to clarify what is extended and reference + [RFC5730] for the EPP command. + 3. Added missing hyphens to "client-sponsored" and "court- + directed". + 4. 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. + 5. 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." + 6. Added normative reference to [RFC0020] to define "7-bit US- + ASCII". + 7. Added the sentence "The custom operations supported is up to + server policy." to the description of the "custom" + operation. + + 8. Broke up the "This extension adds operation detail..." + sentence into two seperate sentences to address the "does" + and the "is" seperately. + 9. Removed the commas from "Any transform operation to an + object..." sentence. + 10. 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. + Authors' Addresses James Gould VeriSign, Inc. 12061 Bluemont Way Reston, VA 20190 US Email: jgould@verisign.com URI: http://www.verisigninc.com