Internet Engineering Task Force (IETF) T. Sattler Internet-Draft Intended status: Standards Track R. Carney Expires: June 30, 2021 J. Kolker GoDaddy Inc. December 11, 2020 Registry Maintenance Notifications for the Extensible Provisioning Protocol (EPP) draft-ietf-regext-epp-registry-maintenance-07 Abstract This document describes an Extensible Provision Protocol (EPP) mapping for 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 June 30, 2021. Copyright Notice Copyright (c) 2020 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 June 30, 2021 [Page 1] Internet-Draft EPP Registry Maintenance December 2020 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 . . . . . . . . . . . . . . . . . . . . . 5 3.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 5 3.1.1. EPP Command . . . . . . . . . . . . . . . . . 6 3.1.2. EPP Command . . . . . . . . . . . . . . . 6 3.1.3. EPP Command . . . . . . . . . . . . . . . . . 6 3.1.3.1. Info Maintenance Item . . . . . . . . . . . . . . . 6 3.1.3.2. Info Maintenance List . . . . . . . . . . . . . . . 8 3.1.4. EPP Command . . . . . . . . . . . . . . . . . 9 3.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 10 3.2.1. EPP Command . . . . . . . . . . . . . . . . 10 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 . . . . . . . . . . . . . . . . . . . . . . . . 11 4.1. Registry Maintenance EPP Mapping Schema . . . . . . . . . 11 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 16 5.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 16 5.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 16 6. Security Considerations . . . . . . . . . . . . . . . . . . . 16 7. Implementation Status . . . . . . . . . . . . . . . . . . . . 17 7.1. GoDaddy Registry . . . . . . . . . . . . . . . . . . . . 17 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 17 8.1. Normative References . . . . . . . . . . . . . . . . . . 17 8.2. Informative References . . . . . . . . . . . . . . . . . 18 Appendix A. Change History . . . . . . . . . . . . . . . . . . . 18 A.1. Change from draft-sattler-epp-poll-maintenance-response to draft-sattler-epp-registry-maintenance . . . . . . . . . 18 A.2. Change from draft-sattler-epp-registry-maintenance to draft-ietf-regext-epp-registry-maintenance . . . . . . . 18 A.3. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 18 A.4. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 18 A.5. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 19 A.6. Change from 03 to 04 . . . . . . . . . . . . . . . . . . 19 A.7. Change from 04 to 05 . . . . . . . . . . . . . . . . . . 19 A.8. Change from 05 to 06 . . . . . . . . . . . . . . . . . . 19 A.9. Change from 06 to 07 . . . . . . . . . . . . . . . . . . 19 Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . 19 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 20 Sattler, et al. Expires June 30, 2021 [Page 2] Internet-Draft EPP Registry Maintenance December 2020 1. Introduction Registries usually conduct maintenances and inform registrars in different ways. Given the DNS namespace expansion, it is now desirable to provide methods for EPP servers to notify EPP clients and 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 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. "maint" is used as an abbreviation for "urn:ietf:params:xml:ns:epp: maintenance-0.1". The XML namespace prefix "maint" 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. 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 only 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 as A-label 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 June 30, 2021 [Page 3] Internet-Draft EPP Registry Maintenance December 2020 2.3. Maintenance Elements The element describes a single registry maintenance event during a specific period. This element is used in a maintenance item EPP response and message. Server unique identifier for the maintenance with an OPTIONAL "msg" attribute that includes a human-readable description of the maintenance. The server unique identifier SHALL NOT be changed if the maintenance is updated or deleted. When the "msg" attribute is set, 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). Indicates one or more elements that are affected by the maintenance. The element contains the following child elements: Indicates the name of the affected system, such as "EPP", "WHOIS", "DNS", "Portal", etc. Indicates the affected maintained system contains the hostname, which SHALL be A-label according [RFC5891]. Indicates the impact level; values MUST either be "full" or "partial". Indicates the type of the affected system; the attribute type is REQUIRED and SHOULD either be "production", "ote", "staging", "dev" or "custom". And alternatively, the attribute name could be used to define a server specific affected system, for example. In that case, name MUST be set: Indicates the date and time of the start of the maintenance. Indicates the date and time of the end of the maintenance. The element MUST be equal or greater than the element. Indicates the reason behind the maintenance; values SHOULD either be "planned" or "emergency". Sattler, et al. Expires June 30, 2021 [Page 4] Internet-Draft EPP Registry Maintenance December 2020 Contains URI to detailed maintenance description. A freeform description of the maintenance without having to create and traverse an external resource defined by the element. 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). The element contains the following child element: Contains the affected top-level domain, which SHALL be A-label according [RFC5891]. The element contains the following child elements: The value SHALL be boolean and indicates if a client needs to do something that is connection-related, such as a reconnect. The value SHALL be boolean and indicates if a client needs to do something that is implementation-related, such as a code change. Indicates the date and time of the maintenance object creation. Indicates the date and time of the most recent maintenance object modification. This element MUST NOT be present if the maintenance object has never been modified. 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. Sattler, et al. Expires June 30, 2021 [Page 5] Internet-Draft EPP Registry Maintenance December 2020 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 , described in Section 3.1.3.1, to query for a specific maintenance item or , described in Section 3.1.3.2, to query all maintenance items. 3.1.3.1. Info Maintenance Item The information on a specific maintenance item can be retrieved by using the command with the element and the child element, defined in Section 2.3. If the maintenance identifier does not exist, the server MUST return an EPP error result code of 2303 [RFC5730]. Example to retrieve a specific maintenance item in an command. C: C: C: C: C: C: 2e6df9b0-4092-4491-bcc8-9fb2166dcee6 C: C: C: ABC-12345 C: C: When an command has been processed successfully, the EPP element MUST contain a child element that identifies the maintenance namespace. The element contains the element defined in Section 2.3. Example of returning a specific maintenance item in an response. Sattler, et al. Expires June 30, 2021 [Page 6] Internet-Draft EPP Registry Maintenance December 2020 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: S: full S: S: S: S: 2020-12-30T06:00:00Z S: 2020-12-30T14:25:57Z S: planned S: S: https://www.registry.example/notice?123 S: S: free text S: S: S: example S: test S: S: S: false S: false S: S: 2020-09-08T22:10:00Z S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: Sattler, et al. Expires June 30, 2021 [Page 7] Internet-Draft EPP Registry Maintenance December 2020 3.1.3.2. Info Maintenance List The information for a list of maintenance items can be retrieved by using the command with the element and the empty child element. Server policy determines if previous maintenances will be included in the list of maintenance items. Example to retrieve the maintenance list in an command. C: C: C: C: C: C: C: C: C: ABC-12345 C: C: When an command has been processed successfully, the EPP element MUST contain a child element that identifies the maintenance namespace. The element contains the element with zero or more child elements. The element contains the following child elements: : defined in Section 2.3. : defined in Section 2.3. : defined in Section 2.3. : defined in Section 2.3. : OPTIONAL defined in Section 2.3. Example of returning the maintenance list in an response. S: S: S: S: S: Command completed successfully S: S: S: S: S: S: 2e6df9b0-4092-4491-bcc8-9fb2166dcee6 S: S: 2020-12-30T06:00:00Z S: 2020-12-30T07:00:00Z S: 2020-09-08T22:10:00Z S: Sattler, et al. Expires June 30, 2021 [Page 8] Internet-Draft EPP Registry Maintenance December 2020 S: S: 91e9dabf-c4e9-4c19-a56c-78e3e89c2e2f S: S: 2021-02-15T04:30:00Z S: 2021-02-15T05:30:00Z S: 2020-09-08T22:11:00Z S: 2020-10-17T15:00: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. A poll message applies when a maintenance is created, updated, or deleted. In the case of a Registry Maintenance specific message, a element will be included within the element of the standard response. The element contains the element defined in Section 2.3. 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: 2020-10-08T22:10:00Z S: Registry Maintenance Notification Sattler, et al. Expires June 30, 2021 [Page 9] Internet-Draft EPP Registry Maintenance December 2020 S: S: S: S: S: 2e6df9b0-4092-4491-bcc8-9fb2166dcee6 S: S: S: EPP S: epp.registry.example S: S: full S: S: S: S: 2020-12-30T06:00:00Z S: 2020-12-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: S: 2020-10-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. Sattler, et al. Expires June 30, 2021 [Page 10] Internet-Draft EPP Registry Maintenance December 2020 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. 4. Formal Syntax The EPP Registry Maintenance schema is presented here. The formal syntax presented here is a complete schema representation of the object mapping suitable for automated validation of EPP XML instances. The and 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 Extensible Provisioning Protocol v1.0 Registry Maintenance Mapping Schema. Sattler, et al. Expires June 30, 2021 [Page 11] Internet-Draft EPP Registry Maintenance December 2020 Sattler, et al. Expires June 30, 2021 [Page 12] Internet-Draft EPP Registry Maintenance December 2020 Sattler, et al. Expires June 30, 2021 [Page 13] Internet-Draft EPP Registry Maintenance December 2020 Sattler, et al. Expires June 30, 2021 [Page 14] Internet-Draft EPP Registry Maintenance December 2020 Sattler, et al. Expires June 30, 2021 [Page 15] Internet-Draft EPP Registry Maintenance December 2020 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:epp:maintenance-0.1 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. 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. Sattler, et al. Expires June 30, 2021 [Page 16] Internet-Draft EPP Registry Maintenance December 2020 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. 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". 7.1. GoDaddy Registry Organization: GoDaddy Registry Name: GoDaddy Registry Description: GoDaddy Registry provides maintenance notifications to their registrars. Level of maturity: Production Coverage: All aspects of the protocol according to the draft version 2 are implemented with further updates to come. Licensing: Proprietary Contact: quoc@registry.godaddy URL: https://registry.godaddy 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, . Sattler, et al. Expires June 30, 2021 [Page 17] Internet-Draft EPP Registry Maintenance December 2020 [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, . [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, . Appendix A. Change History A.1. Change from draft-sattler-epp-poll-maintenance-response to draft-sattler-epp-registry-maintenance Updated to be EPP based instead of JSON document. A.2. Change from draft-sattler-epp-registry-maintenance to draft-ietf-regext-epp-registry-maintenance Adopted by the REGEXT working group. A.3. Change from 00 to 01 Clarified maint:description and maint:environment. Changed maint:description from complexType to simpleType. Fixed typo. Added acknowledgment. A.4. Change from 01 to 02 Update language from Domain Name Registry to Registry. Clarified XML namespace urn:ietf:params:xml:ns:maintenance-1.0. Changed host to contain hostName and hostAddr. Changed maint:tlds from MUST to SHOULD. Fixed maint:status in Schema. Changed UUID to a server unique id. Sattler, et al. Expires June 30, 2021 [Page 18] Internet-Draft EPP Registry Maintenance December 2020 A.5. Change from 02 to 03 Changed maint:connection from MUST to SHOULD. A.6. Change from 03 to 04 A lot of clarifications and editoral changes. A.7. Change from 04 to 05 Changed XML namespace from urn:ietf:params:xml:ns:maintenance-1.0 to urn:ietf:params:xml:ns:epp:maintenance-0.1. Removed . Clarified for retrieving maintenance items and the list. A.8. Change from 05 to 06 Changed dates in examples to more recent dates. Renamed Query Maintenance Item and List to Info Maintenance Item and List. Removed blackout in favor of full. Added GoDaddy Registry implementation. A.9. Change from 06 to 07 Removed IP addresses for . Editoral changes. Acknowledgments The authors wish to thank the following persons for their feedback and suggestions: James Gould, Patrick Mevzek, Quoc-Anh Pham, Raymond Zylstra, Christopher Martens, Anthony Eden, Neal McPherson, Craig Marchant, and Andreas Huber. Sattler, et al. Expires June 30, 2021 [Page 19] Internet-Draft EPP Registry Maintenance December 2020 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 June 30, 2021 [Page 20]