Internet Engineering Task Force T. Sattler, Editor Internet-Draft Intended status: Standard Track R. Carney Expires: September 26, 2019 J. Kolker GoDaddy Inc. March 27, 2019 Registry Maintenance Notifications for the Extensible Provisioning Protocol (EPP) draft-sattler-epp-registry-maintenance-09 Abstract This document describes an Extensible Provision Protocol (EPP) mapping for domain name registry's maintenance notifications. Status of This Memo 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 https://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 26, 2019. Copyright Notice Copyright (c) 2019 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 (https://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. Sattler, et al. Expires September 26, 2019 [Page 1] Internet-Draft EPP Registry Maintenance March 2019 Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Terminology and Definitions . . . . . . . . . . . . . . . 3 2. Object Attributes . . . . . . . . . . . . . . . . . . . . . . 3 2.1. Internationalized Domain Names . . . . . . . . . . . . . 3 2.2. Dates and Times . . . . . . . . . . . . . . . . . . . . . 3 2.3. Maintenance Elements . . . . . . . . . . . . . . . . . . 4 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 . . . . . . . . . . . . . . . . . 6 3.1.4. EPP Command . . . . . . . . . . . . . . . . . 9 3.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 11 3.2.1. EPP Command . . . . . . . . . . . . . . . . 11 3.2.2. EPP Command . . . . . . . . . . . . . . . . 11 3.2.3. EPP Command . . . . . . . . . . . . . . . . . 11 3.2.4. EPP Command . . . . . . . . . . . . . . . 11 3.2.5. EPP Command . . . . . . . . . . . . . . . . 11 4. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 12 4.1. Registry Maintenance EPP Mapping Schema . . . . . . . . . 12 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 16 5.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 16 5.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 17 6. Security Considerations . . . . . . . . . . . . . . . . . . . 17 7. Implementation Status . . . . . . . . . . . . . . . . . . . . 17 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 18 8.1. Normative References . . . . . . . . . . . . . . . . . . 18 8.2. Informative References . . . . . . . . . . . . . . . . . 18 Appendix A. Change History . . . . . . . . . . . . . . . . . . . 19 A.1. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 19 A.2. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 19 A.3. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 19 A.4. Change from 03 to 04 . . . . . . . . . . . . . . . . . . 19 A.5. Change from 04 to 05 . . . . . . . . . . . . . . . . . . 19 A.6. Change from 05 to 06 . . . . . . . . . . . . . . . . . . 20 A.7. Change from 06 to 07 . . . . . . . . . . . . . . . . . . 20 A.8. Change from 07 to EPPMAINT 00 . . . . . . . . . . . . . . 20 A.9. Change from EPPMAINT 00 to EPPMAINT 01 . . . . . . . . . 20 A.10. Change from EPPMAINT 01 to EPPMAINT 02 . . . . . . . . . 20 A.11. Change from EPPMAINT 02 to EPPMAINT 03 . . . . . . . . . 20 A.12. Change from EPPMAINT 03 to EPPMAINT 04 . . . . . . . . . 20 A.13. Change from EPPMAINT 04 to EPPMAINT 05 . . . . . . . . . 20 A.14. Change from EPPMAINT 05 to EPPMAINT 06 . . . . . . . . . 20 A.15. Change from EPPMAINT 06 to EPPMAINT 07 . . . . . . . . . 21 A.16. Change from EPPMAINT 07 to EPPMAINT 08 . . . . . . . . . 21 A.17. Change from EPPMAINT 08 to EPPMAINT 09 . . . . . . . . . 21 Appendix B. Acknowledgements . . . . . . . . . . . . . . . . . . 21 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 21 Sattler, et al. Expires September 26, 2019 [Page 2] Internet-Draft EPP Registry Maintenance March 2019 1. Introduction Domain name registries usually conduct maintenances and inform domain name registrars in different ways. Given the expansion of the DNS namespace, it is now desirable to provide a method for EPP servers to notify EPP clients as well as a method for EPP clients to query EPP servers for upcoming maintenances. This document describes an extension mapping for version 1.0 of the Extensible Provision Protocol [RFC5730]. This mapping provides a mechanism by which EPP servers may notify and EPP clients to query for upcoming maintenances. 1.1. Terminology and Definitions 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 [RFC2119] when specified in their uppercase forms. XML is case sensitive. Unless stated otherwise, XML specifications moreover, examples provided in this document MUST be interpreted in the character case presented 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. 2. Object Attributes 2.1. Internationalized Domain Names Names of affected hosts MUST be provided in Punycode according to [RFC5891]. 2.2. Dates and Times All dates and times attribute values MUST be expressed in Universal Coordinated Time (UTC) using the Gregorian calendar. The extended date-time form using upper case "T" and "Z" characters defined in ISO 8601 [RFC3339] MUST be used to represent date-time values. Sattler, et al. Expires September 26, 2019 [Page 3] Internet-Draft EPP Registry Maintenance March 2019 2.3. Maintenance Elements The element describes a single registry maintenance event during a specific period. This element will be used at EPP messages and to extend the EPP command. For creating a new maintenance the attribute MUST be 'active', the attribute MUST be set and the attribute SHALL NOT be present. For updating a maintenance the attribute MUST be 'active', the attributes and MUST be set. For deleting a maintenance the attribute MUST be 'inactive', and the attributes and MUST be set. MUST be present and a UUID according [RFC4122] and SHALL NOT be changed if maintenance got updated or deleted. A human-readable description of the maintenance is identified via an OPTIONAL "msg" attribute. MUST be present and contains one or more elements. The server SHOULD NOT list systems which are not affected by the maintenance. MUST be present at least once and is an element of , and . MUST be present and indicates the name of the affected system, such as 'EPP', 'WHOIS', 'DNS', 'Portal', etc. MUST be present and indicates the affected maintained system (host or IP address). Hostname SHALL be Punycode according [RFC5891]. IPv4 addresses SHALL be dotted-decimal notation. An example of this textual representation is "192.0.2.0". IPv6 addresses SHALL be according [RFC5952]. An example of this textual representation is "2001:db8::1:0:0:1". Sattler, et al. Expires September 26, 2019 [Page 4] Internet-Draft EPP Registry Maintenance March 2019 MUST be present and contains the impact level; values SHOULD either be 'blackout' or 'partial'. MUST be present and indicates the type of the affected system; values SHOULD either be 'production', 'ote', 'staging' or 'dev'. MUST be present and indicates the start of the maintenance according ISO 8601 [RFC3339]. Format: YYYY-MM-DDThh:mm:ssTZ MUST be present and indicates the end of the maintenance according to ISO 8601 [RFC3339], and MUST be equal to or greater than . Format: YYYY-MM-DDThh:mm:ssTZ MUST be present and contains the reason behind the maintenance; values SHOULD either be 'planned' or 'emergency'. MAY be present and contains URI to detailed maintenance description. MAY be present and provides a freeform description of the maintenance without having to create and traverse an external resource. The maximum length MUST NOT exceed 1024 bit. MUST be present and contains elements. MUST be present and contains the affected top-level domain. Punycode encoded according to [RFC5891]. MUST be present and contains and . MUST be present and indicates if a client needs to do something that is connection-related, such as a reconnect. The value SHALL be boolean. MUST be present and indicates if a client needs to do something that is implementation-related, such as a code change. The value SHALL be boolean. Sattler, et al. Expires September 26, 2019 [Page 5] Internet-Draft EPP Registry Maintenance March 2019 MUST be present and indicates the status of the maintenance. The value SHALL be either 'active' or 'inactive'. MUST be present and contains the creation date of the maintenance according ISO 8601 [RFC3339]. Format: YYYY-MM-DDThh:mm:ssTZ MAY be present and contains the updated date of the maintenance according to ISO 8601 [RFC3339], and if set MUST be equal to or greater than . Format: YYYY-MM-DDThh:mm:ssTZ 3. EPP Command Mapping A detailed description of the EPP syntax and semantics can be found in the EPP core protocol specification [RFC5730]. The command mappings described here are specifically for the use to notify of Registry Maintenances and Registry Maintenance object mapping. 3.1. EPP Query Commands EPP [RFC5730] provides three commands to retrieve object information: to determine if an object is known to the server, to retrieve detailed information associated with an object, and to retrieve object transfer status information. 3.1.1. EPP Command Available check semantics do not apply to maintenance objects, so there is no mapping defined for the EPP command. 3.1.2. EPP Command Transfer semantics do not apply to maintenance objects, so there is no mapping defined for the EPP command. 3.1.3. EPP Command EPP provides the command that is used to retrieve registry maintenance information. In addition to the standard EPP command elements, the command MUST contain a element that identifies the maintenance namespace. The element MUST contain a child element. It is either to retrieve a specific maintenance notification or to query all maintenance notifications. Sattler, et al. Expires September 26, 2019 [Page 6] Internet-Draft EPP Registry Maintenance March 2019 Example command with to get one specific maintenance: C: C: C: C: C: C: 2e6df9b0-4092-4491-bcc8-9fb2166dcee6 C: C: C: ABC-12345 C: C: Example response for one specific maintenance notification: S: S: S: S: S: Command completed successfully S: S: S: S: S: 2e6df9b0-4092-4491-bcc8-9fb2166dcee6 S: S: S: S: EPP S: epp.registry.example S: blackout S: S: S: S: 2017-09-30T06:00:00Z S: 2017-09-30T14:25:57Z S: planned S: S: https://www.registry.example/notice?123 S: Sattler, et al. Expires September 26, 2019 [Page 7] Internet-Draft EPP Registry Maintenance March 2019 S: free text S: S: example S: test S: S: S: false S: false S: S: active S: 2017-03-08T22:10:00Z S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: Example command with to query all maintenances: C: C: C: C: C: C: C: C: C: ABC-12345 C: C: Example response querying all maintenances: S: S: S: S: S: Command completed successfully S: S: S: Sattler, et al. Expires September 26, 2019 [Page 8] Internet-Draft EPP Registry Maintenance March 2019 S: S: S: 2e6df9b0-4092-4491-bcc8-9fb2166dcee6 S: S: 2017-04-30T06:00:00Z S: 2017-04-30T07:00:00Z S: 2017-02-08T22:10:00Z S: S: S: 91e9dabf-c4e9-4c19-a56c-78e3e89c2e2f S: S: 2017-06-15T04:30:00Z S: 2017-06-15T05:30:00Z S: 2017-02-08T22:10:00Z S: 2017-03-08T20:11:00Z S: S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: 3.1.4. EPP Command The EPP command and response is defined in Section 2.9.2.3 of [RFC5730]. The Registry Maintenance Notification is included in the EPP response of [RFC5730]. For the Registry Maintenance Notification, there are three types of poll messages. The poll messages apply whenever the domain name registry creates, updates or deletes maintenance. In the case of a Registry Maintenance specific message, a element will be included within the element of the standard response. The element will include a reference to the Registry Maintenance namespace. EPP data contained within the element is formatted according to the maintenance-poll schema. Sattler, et al. Expires September 26, 2019 [Page 9] Internet-Draft EPP Registry Maintenance March 2019 Example command: C: C: C: C: C: ABC-12345 C: C: Example response with the Registry Maintenance poll message: S: S: S: S: S: Command completed successfully; ack to dequeue S: S: S: 2017-02-08T22:10:00Z S: Registry Maintenance Notification S: S: S: S: S: 2e6df9b0-4092-4491-bcc8-9fb2166dcee6 S: S: S: EPP S: epp.registry.example S: blackout S: S: S: S: 2017-10-30T06:00:00Z S: 2017-10-30T14:25:57Z S: planned S: S: https://www.registry.example/notice?123 S: S: S: example S: test S: S: S: false S: false S: Sattler, et al. Expires September 26, 2019 [Page 10] Internet-Draft EPP Registry Maintenance March 2019 S: active S: 2017-02-08T22:10:00Z S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: 3.2. EPP Transform Commands EPP provides five commands to transform objects: to create an instance of an object, to delete an instance of an object, to extend the validity period of an object, to manage object sponsorship changes, and to change information associated with an object. 3.2.1. EPP Command Create semantics do not apply to maintenance objects, so there is no mapping defined for the EPP command. 3.2.2. EPP Command Delete semantics do not apply to maintenance objects, so there is no mapping defined for the EPP command. 3.2.3. EPP Command Renew semantics do not apply to maintenance objects, so there is no mapping defined for the EPP command. 3.2.4. EPP Command Transfer semantics do not apply to maintenance objects, so there is no mapping defined for the EPP command. 3.2.5. EPP Command Update semantics do not apply to maintenance objects, so there is no mapping defined for the EPP command. Sattler, et al. Expires September 26, 2019 [Page 11] Internet-Draft EPP Registry Maintenance March 2019 4. Formal Syntax One schema is presented here that is the EPP Registry Maintenance 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 end of the schema for URI registration purposes. 4.1. Registry Maintenance EPP Mapping Schema BEGIN Extensible Provisioning Protocol v1.0 Maintenance Mapping Schema. Sattler, et al. Expires September 26, 2019 [Page 12] Internet-Draft EPP Registry Maintenance March 2019 Sattler, et al. Expires September 26, 2019 [Page 13] Internet-Draft EPP Registry Maintenance March 2019 Sattler, et al. Expires September 26, 2019 [Page 14] Internet-Draft EPP Registry Maintenance March 2019 Sattler, et al. Expires September 26, 2019 [Page 15] Internet-Draft EPP Registry Maintenance March 2019 END 5. IANA Considerations 5.1. XML Namespace This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism defined in [RFC3688]. Registration request for the maintenance namespace: URI: urn:ietf:params:xml:ns:maintenance-1.0 Registrant Contact: IESG XML: None. Namespace URIs do not represent an XML specification. Registration request for the maintenance schema: URI: urn:ietf:params:xml:schema:maintenance-1.0 Registrant Contact: IESG XML: See the "Formal Syntax" section of this document. Sattler, et al. Expires September 26, 2019 [Page 16] Internet-Draft EPP Registry Maintenance March 2019 5.2. EPP Extension Registry The following registration of the EPP Extension Registry, described in [RFC7451], is requested: Name of Extension: "Registry Maintenance Notifications for the Extensible Provisioning Protocol (EPP)" Document status: Standards Track Reference: (insert the reference to RFC version of this document) Registrant Name and Email Address: IESG, TLDs: Any IPR Disclosure: None Status: Active Notes: None 6. Security Considerations The mapping extensions described in this document do not provide any security services beyond those specified by EPP [RFC5730] and protocol layers used by EPP. The security considerations described in these other specifications apply to this specification as well. 7. Implementation Status Note to RFC Editor: Please remove this section and the reference to [RFC7942] 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 [RFC7942]. 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. Sattler, et al. Expires September 26, 2019 [Page 17] Internet-Draft EPP Registry Maintenance March 2019 According to [RFC7942], "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". Add implementation details once available. 8. References 8.1. Normative References [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997, . [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", STD 69, RFC 5730, August 2009, . 8.2. Informative References [RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the Internet: Timestamps", RFC 3339, July 2002, . [RFC5891] Klensin, J., "Internationalized Domain Names in Applications (IDNA): Protocol", RFC 5891, August 2010, . [RFC4122] Leach, P., Mealling, M. and Salz, R., "A Universally Unique IDentifier (UUID) URN Namespace", RFC 4122, July 2015, . [RFC5952] Kawamura, S. and Kawashima, M., "A Recommendation for IPv6 Address Text Representation", RFC 5952, August 2010, . [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, February 2015, . [RFC7942] Sheffer, Y. and Farrel, A., "Improving Awareness of Running Code: The Implementation Status Section", RFC 7942, July 2016, . Sattler, et al. Expires September 26, 2019 [Page 18] Internet-Draft EPP Registry Maintenance March 2019 Appendix A. Change History A.1. Change from 00 to 01 Removed JSON Schema. Clarified unique id with UUID. Added Common Data Structures for a better explanation. Fixed EPP poll response example. Added und fixed References. A.2. Change from 01 to 02 Clarified host field. Added TLDs to Common Data Structure. Added Internationalization Considerations. Changed authors address and contact details. A.3. Change from 02 to 03 Added date-time Values to Internationalization Considerations. Sorted Terminology and Definitions alphabetically. Changed start and end date-time. Changed Reference URI to HTTPS. A.4. Change from 03 to 04 Added Acknowledgements. Clarified UUID field to be not changed at all Clarified environment field with production, ote, staging and dev. Clarified connection and implementation fields. Fixed writing of systems field. Removed author's private address. Moved this draft from Experimental to Standard Track. A.5. Change from 04 to 05 Changed title of this draft to be more specific. Added changelog. Split References into Normative and Informative References. Clarified Common Data Types. Rephrased Abstract and Introduction. Added Implementation Status Section. Sattler, et al. Expires September 26, 2019 [Page 19] Internet-Draft EPP Registry Maintenance March 2019 A.6. Change from 05 to 06 Added IANA Considerations. Changed URIs from HTTP to HTTPS. Added new main Section 4. EPP Command Mapping. Added new JSON field 'purpose' for announce, change or cancel of a maintenance notification. A.7. Change from 06 to 07 Fixed typo in Section 3.4. and added missing comma in the example of Section 4.1. Added the field specification to help facilitate the adoption of this document. Changed possible purposes to create, update and delete to be closer to the EPP syntax. Cleaned whitespaces. Updated Acknowledgements. A.8. Change from 07 to EPPMAINT 00 Removed JSON payload in message and switched to specific EPP message. Extended EPP command to provide details on specific maintenance or list all maintenances. A.9. Change from EPPMAINT 00 to EPPMAINT 01 Fixed typos and added missing changelog text for EPPMAINT 00. Added BEGIN and END flag to the XML schema. Removed Character Encoding Section. Fixed indentation in Section 2.3. A.10. Change from EPPMAINT 01 to EPPMAINT 02 Changed the element to . Fixed indentation in Section 4.1. Cleaned up whitespaces. A.11. Change from EPPMAINT 02 to EPPMAINT 03 Changed reference from RFC3492 to RFC5891. Fixed minor typos. Added for a freeform maintenance description with a maximum length of 1024. Added optional "msg" attribute to and . A.12. Change from EPPMAINT 03 to EPPMAINT 04 Fixed minor typos and added one acknowledgment. A.13. Change from EPPMAINT 04 to EPPMAINT 05 Added missing whitespace. Fixed dates in examples. Added clarification that must be equal to or greater than , same applies for and if set. A.14. Change from EPPMAINT 05 to EPPMAINT 06 Added Roger Carney and Jody Kolker as Co-Authors to this draft. Sattler, et al. Expires September 26, 2019 [Page 20] Internet-Draft EPP Registry Maintenance March 2019 A.15. Change from EPPMAINT 06 to EPPMAINT 07 Changed Acknowledgements. A.16. Change from EPPMAINT 07 to EPPMAINT 08 Added IANA consideration section 5.1. and 5.2. Added editor flag to author. Changed abstract and introduction. Minor formatting changes. A.17. Change from EPPMAINT 08 to EPPMAINT 09 Editorial changes. Appendix B. Acknowledgements The authors wish to thank the following persons for their feedback and suggestions (sorted alphabetically by company): o Patrick Mevzek o Neal McPherson, 1&1 IONOS o Anthony Eden, DNSimple o Christopher Martens, Donuts o Raymond Zylstra, Neustar o Andreas Huber, united-domains o Craig Marchant, VentraIP o James Gould, Verisign Authors' Addresses Tobias Sattler Email: tobias.sattler@me.com URI: https://tobiassattler.com Roger Carney GoDaddy Inc. 14455 N. Hayden Rd. #219 Scottsdale, AZ 85260 US Email: rcarney@godaddy.com URI: http://www.godaddy.com Jody Kolker GoDaddy Inc. 14455 N. Hayden Rd. #219 Scottsdale, AZ 85260 US Email: jkolker@godaddy.com URI: http://www.godaddy.com Sattler, et al. Expires September 26, 2019 [Page 21]