--- 1/draft-ietf-regext-change-poll-05.txt 2018-01-05 05:13:18.159450361 -0800 +++ 2/draft-ietf-regext-change-poll-06.txt 2018-01-05 05:13:18.207451499 -0800 @@ -1,19 +1,19 @@ Network Working Group J. Gould Internet-Draft VeriSign, Inc. Intended status: Standards Track K. Feher -Expires: July 6, 2018 Neustar - January 2, 2018 +Expires: July 9, 2018 Neustar + January 5, 2018 Change Poll Extension for the Extensible Provisioning Protocol (EPP) - draft-ietf-regext-change-poll-05 + draft-ietf-regext-change-poll-06 Abstract 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 @@ -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 July 6, 2018. + This Internet-Draft will expire on July 9, 2018. 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,59 +54,61 @@ 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. Who . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 - 2.3. Dates and Times . . . . . . . . . . . . . . . . . . . . . 5 + 2.2. State . . . . . . . . . . . . . . . . . . . . . . . . . . 4 + 2.3. Who . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 + 2.4. Dates and Times . . . . . . . . . . . . . . . . . . . . . 5 3. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 5 3.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 5 - 3.1.1. EPP Command . . . . . . . . . . . . . . . . . 5 - 3.1.2. EPP Command . . . . . . . . . . . . . . . . . 5 - 3.1.3. EPP Command . . . . . . . . . . . . . . . 15 - 3.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 15 - 3.2.1. EPP Command . . . . . . . . . . . . . . . . 15 - 3.2.2. EPP Command . . . . . . . . . . . . . . . . 15 - 3.2.3. EPP Command . . . . . . . . . . . . . . . . . 15 - 3.2.4. EPP Command . . . . . . . . . . . . . . . 15 - 3.2.5. EPP Command . . . . . . . . . . . . . . . . 15 - 4. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 15 - 4.1. Change Poll Extension Schema . . . . . . . . . . . . . . 16 - 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 18 - 5.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 18 - 5.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 19 - 6. Implementation Status . . . . . . . . . . . . . . . . . . . . 19 - 6.1. Verisign EPP SDK . . . . . . . . . . . . . . . . . . . . 20 - 6.2. Verisign Consolidated Top Level Domain (CTLD) SRS . . . . 20 - 6.3. Verisign .COM / .NET SRS . . . . . . . . . . . . . . . . 20 - 6.4. Neustar EPP SDK . . . . . . . . . . . . . . . . . . . . . 21 - 7. Security Considerations . . . . . . . . . . . . . . . . . . . 21 - 8. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 21 - 9. Normative References . . . . . . . . . . . . . . . . . . . . 22 - Appendix A. Change History . . . . . . . . . . . . . . . . . . . 22 - A.1. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 22 - A.2. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 23 - A.3. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 23 - A.4. Change from 03 to 04 . . . . . . . . . . . . . . . . . . 23 - A.5. Change from 04 to 05 . . . . . . . . . . . . . . . . . . 23 - A.6. Change from 05 to REGEXT 00 . . . . . . . . . . . . . . . 23 - A.7. Change from REGEXT 00 to REGEXT 01 . . . . . . . . . . . 23 - A.8. Change from REGEXT 01 to REGEXT 02 . . . . . . . . . . . 23 - A.9. Change from REGEXT 02 to REGEXT 03 . . . . . . . . . . . 23 - A.10. Change from REGEXT 03 to REGEXT 04 . . . . . . . . . . . 23 - A.11. Change from REGEXT 04 to REGEXT 05 . . . . . . . . . . . 23 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 24 + 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 + 4. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 16 + 4.1. Change Poll Extension Schema . . . . . . . . . . . . . . 17 + 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 19 + 5.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 19 + 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 . . . . . . . . . . . . . . . . 21 + 6.4. Neustar EPP SDK . . . . . . . . . . . . . . . . . . . . . 22 + 7. Security Considerations . . . . . . . . . . . . . . . . . . . 22 + 8. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 22 + 9. Normative References . . . . . . . . . . . . . . . . . . . . 23 + Appendix A. Change History . . . . . . . . . . . . . . . . . . . 23 + A.1. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 23 + 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.9. Change from REGEXT 02 to REGEXT 03 . . . . . . . . . . . 24 + A.10. Change from REGEXT 03 to REGEXT 04 . . . . . . . . . . . 24 + A.11. Change from REGEXT 04 to REGEXT 05 . . . . . . . . . . . 24 + A.12. Change from REGEXT 05 to REGEXT 06 . . . . . . . . . . . 25 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 25 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 @@ -147,58 +149,80 @@ 2.1. Operation An operation consists of any transform operation that impacts objects that the client sponsers and SHOULD be notified of. The 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 values include: - "create" Create operation as defined in [RFC5730]. - "delete" Delete operation as defined in [RFC5730]. If the delete + "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 + "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 + "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 + "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 + "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": Custom operation that MUST set the "op" attribute with the custom operation name. -2.2. Who +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 + "before" state poll message MUST be inserted prior to the "after" + state poll message. + + For operations in Section 2.1 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 Section 2.1 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. + +2.3. Who The element defines who executed the operation for audit purposes. The scheme used for the possible set of element values is up to server policy. The server MAY identify the element value based on: - "Identifier" Unique user identifier of the user that executed the + "Identifier": Unique user identifier of the user that executed the operation. An example is "ClientX". - "Name" Name of the user that executed the operation. An example is + "Name": Name of the user that executed the operation. An example is "John Doe". - - "Role" Role of the user that executed operation. An example is + "Role": Role of the user that executed operation. An example is "CSR" for a Customer Support Representative or "Batch" for a server batch. -2.3. Dates and Times +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 using upper case "T" and "Z" characters defined in [W3C.REC-xmlschema-2-20041028] 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. 3. EPP Command Mapping @@ -225,53 +249,46 @@ 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 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, 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 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 - element includes the operation detail with the following child - elements: + 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.2. - OPTIONAL case identifer associated with the + : 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 with an enumerated list of case types including: - udrp a Uniform Domain-Name Dispute-Resolution Policy (UDRP) + 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). + 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). Example poll response with the extension for a URS lock transaction on the domain.example domain name, with the "before" state. The "before" state is reflected in the block: S: S: S: S: @@ -983,20 +1000,28 @@ 3. Rephrased the first sentence of the Who section. 4. Added references to the element in the Who section. 5. Revise the sentence that describes how the extension extends the info response in the EPP Command section. 6. Refer to EPP Object Mapping as EPP object mapping throughout the document. 7. Add a Dates and Times section to the Object Attributes section. +A.12. Change from REGEXT 05 to REGEXT 06 + + 1. 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. + 2. Added a colon suffix to each hangText entry to provide better + separation. + Authors' Addresses James Gould VeriSign, Inc. 12061 Bluemont Way Reston, VA 20190 US Email: jgould@verisign.com URI: http://www.verisigninc.com