]>

mail@tobiassattler.com https://tobiassattler.com

GoDaddy Inc.

2155 E GoDaddy Way Tempe AZ 85284 United States of America rcarney@godaddy.com https://www.godaddy.com

GoDaddy Inc.

2155 E GoDaddy Way Tempe AZ 85284 United States of America jkolker@godaddy.com https://www.godaddy.com

This document describes an Extensible Provisioning Protocol (EPP) extension called "Registry Maintenance Notification", which is used by EPP servers to notify EPP clients and allow EPP clients to query EPP servers regarding maintenance events.

Introduction The Extensible Provisioning Protocol (EPP), as defined in , is a protocol whose original motivation is to provide a standard Internet domain name registration protocol for use between registries and registrars. Registries routinely update systems to ensure a higher quality of service, implement new services, or upgrade protocols to the latest standards. These updates are pushed to various registry environments during time frames communicated to registrars as "maintenance events". Maintenance events may require making services unavailable for some limited time while the upgrade happens. Registries usually inform registrars about maintenance events in various formats, none of which are standardized between registries. The DNS namespace expansion has led to many additional registries that registrars must interact with, adding more maintenance events and formats. It is now desirable to provide an efficient approach to notify registrars. This document describes an extension mapping for version 1.0 of the EPP to provide a mechanism by which EPP servers may notify EPP clients of and allow EPP clients to query EPP servers on upcoming maintenance events.

Terminology and Definitions 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. The XML namespace prefix "maint" is used for the namespace "urn:ietf:params:xml:ns:epp:maintenance-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. "ote" is an abbreviation for "Operational Test and Evaluation". 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.

Migrating to Newer Versions of This Extension Servers that implement this extension SHOULD provide a way for clients to progressively update their implementations when a new version of the extension is deployed. A newer version of the extension is expected to use an XML namespace with a higher version number than the prior versions. Servers SHOULD (for a temporary migration period up to server policy) provide support for older versions of the extension in parallel to the newest version and allow clients to execute their preferred version of the <info> command based on the maintenance <objURI> elements of the server <greeting>. The version of the maintenance <info> response MUST match the version of the maintenance <info> command executed by the server. Servers MUST return a Registry Maintenance Notification poll message matching the newest negotiated version of the maintenance extension, based on an intersection of the maintenance <objURI> elements in the server <greeting> and the client <login> command. If the intersection of the maintenance <objURI> elements of the server <greeting> and the client <login> command results in an empty set, the server MUST return the newest version of the Registry Maintenance Notification poll message supported by the server based on "Usage with Poll-Message EPP Responses" in .

Object Attributes

Internationalized Domain Names Names of affected hosts MUST be provided in A-label form, according to .

Dates and Times All date and time attribute values MUST be expressed in Universal Coordinated Time (UTC) using the Gregorian calendar. The date-time format defined as "date-time" in , with time-offset="Z", MUST be used.

Maintenance Elements The <maint:item> element describes a single registry maintenance event during a specific period. This element is used in a maintenance item EPP <info> command and response as well as in a <poll> response. If an element is not marked as optional, it is mandatory.

<maint:id>

The server-unique identifier for the maintenance event with the OPTIONAL "name" attribute that includes a human-readable name of the event. The server-unique identifier SHALL NOT be changed if the event is updated or deleted. When the "name" attribute is set, the OPTIONAL "lang" attribute, per the language structure in , MAY be present to identify the language if the negotiated value is something other than the default value of "en" (English).

<maint:type>

Zero or more OPTIONAL types of the maintenance event, with the possible set of values defined by server policy, such as "Routine Maintenance", "Software Update", "Software Upgrade", or "Extended Outage". The OPTIONAL "lang" attribute MAY be present to identify the language if the negotiated value is something other than the default value of "en" (English).

<maint:pollType>

The OPTIONAL <maint:pollType> element for a Registry Maintenance Notification poll message; values MUST be "create", "update", "delete", "courtesy", or "end". For the "create" and "update" types, the server includes the state of the maintenance event after the creation or update. For the "delete" type, the server includes the state of the event before the delete. The "courtesy" provides a reminder of an event, and the "end" provides a notification of the end of the event without updating the maintenance object and includes the latest state of the event. This element MUST be present only for poll messages.

<maint:systems>

One or more <maint:system> elements that are affected by the maintenance event.

<maint:system>

The <maint:system> element contains the following child elements:

<maint:name>

The name of the affected system, such as "EPP", "WHOIS", "DNS", "Portal", "RDAP", etc.

<maint:host>

The OPTIONAL affected maintained system's hostname, which SHALL be in A-label form, according to .

<maint:impact>

The impact level; the values MUST be "full", "partial", or "none". If access is expected to be intermittently unavailable, it is "partial". If access is expected to be completely unavailable, it is "full". If access is not affected, it is "none".

<maint:environment>

The type of the affected system; the attribute "type" is REQUIRED and MUST be "production", "ote", "staging", "dev", or "custom". For extensibility, the <maint:environment> element includes the OPTIONAL "name" attribute that can define the name of the custom environment when the <maint:environment> element "type" attribute has the "custom" value. For example, for the custom "marketing" environment, the <maint:environment> element should be: <maint:environment type="custom" name="marketing"/>.

<maint:start>

The date and time of the start of the maintenance event.

<maint:end>

The date and time of the end of the maintenance event. The <maint:end> element MUST be greater than the <maint:start> element.

<maint:reason>

The reason behind the maintenance event; the values MUST be either "planned" or "emergency".

<maint:detail>

The OPTIONAL URI to the detailed maintenance event description, formatted according to .

<maint:description>

Zero or more OPTIONAL free-form descriptions of the maintenance event, usable without creating and traversing an external resource as defined by the <maint:detail> element. The 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 OPTIONAL "type" attribute MAY be present to identify the format of the description. It MUST be either "plain" for plain text or "html" for HTML text, as defined in , and XML-escaped, with a default value of "plain".

<maint:tlds>

The OPTIONAL <maint:tlds> element contains one or more <maint:tld> child elements. If the <maint:tlds> is not present, the entire system is affected.

<maint:tld>

The affected top-level domain or registry zone, which SHALL be in A-label form, according to .

<maint:intervention>

The OPTIONAL <maint:intervention> element contains the following child elements:

<maint:connection>

The value SHALL be boolean and indicates if a client needs to perform a connection-related action such as a reconnect. The attribute should only be used as a flag to indicate connections will be affected. Servers SHOULD include a description of how the connections are affected in the <maint:description> element or use the <maint:detail> element above.

<maint:implementation>

The value SHALL be boolean and indicates if a client needs to perform an implementation-related action such as a code change. The attribute should only be used as a flag to indicate implementation will be affected. Servers SHOULD include a description of how the implementation is affected in the <maint:description> element or use the <maint:detail> element above.

<maint:crDate>

The date and time of the maintenance object creation.

<maint:upDate>

The OPTIONAL date and time of the most recent maintenance object modification. This element MUST NOT be present if the maintenance object has never been modified.

EPP Command Mapping A detailed description of the EPP syntax and semantics can be found in the EPP core protocol specification . The command mappings described here are specifically used to notify registrars of registry maintenance events and object mapping.

EPP Query Commands 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 EPP <check> and <transfer> commands or responses.

EPP <info> Command EPP provides the <info> command that is used to retrieve registry maintenance information. In addition to the standard EPP command elements, the <info> command MUST contain a <maint:info> element that identifies the maintenance namespace. The <maint:info> element MUST contain a child element. It is either the <maint:id> child element, described in , to query for a specific maintenance item or the <maint:list> child element, described in , to query all maintenance items.

Info Maintenance Item The information regarding a specific maintenance item can be retrieved by using the <info> command with the <maint:info> element and the <maint:id> child element, defined in . If the maintenance identifier does not exist, the server MUST return an EPP error result code of 2303 ("Object does not exist") . The following is an example of retrieving a specific maintenance item in an <info> command. C: C: C: C: C: 2e6df9b0-4092-4491-bcc8-9fb2166dcee6 C: C: C: ABC-12345 C: C: ]]> When an <info> command has been processed successfully, the EPP <resData> element MUST contain a child <maint:infData> element that identifies the maintenance namespace. The <maint:infData> element contains the <maint:item> element defined in . The following is an example of returning a specific maintenance item in an <info> response. S: S: S: S: Command completed successfully S: S: S: S: S: 2e6df9b0-4092-4491-bcc8-9fb2166dcee6 S: S: Routine Maintenance S: S: S: EPP S: epp.registry.example S: S: full S: S: S: S: 2021-12-30T06:00:00Z S: 2021-12-30T07:00:00Z S: planned S: S: https://www.registry.example/notice?123 S: S: free-text S: S: Freitext S: S: S: example S: test S: S: S: false S: false S: S: 2021-11-08T22:10:00Z S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: ]]>

Info Maintenance List The information for a list of maintenance items can be retrieved by using the <info> command with the <maint:info> element and the empty <maint:list> child element. Server policy determines if completed maintenance events will be included in the list of maintenance items. The following is an example of retrieving the list of maintenance items in an <info> command. C: C: C: C: C: C: C: C: ABC-12345 C: C: ]]> When an <info> command has been processed successfully, the EPP <resData> element MUST contain a child <maint:infData> element that identifies the maintenance namespace. The <maint:infData> element contains the <maint:list> element with zero or more <maint:listItem> child elements. The <maint:listItem> element contains the following child elements:

• <maint:id>

  The <maint:id> element defined in .

  <maint:start>

  The <maint:start> element defined in .

  <maint:end>

  The <maint:end> element defined in .

  <maint:crDate>

  The <maint:crDate> element defined in .

  <maint:upDate>

  The OPTIONAL <maint:upDate> element defined in .

The following is an example of returning the list of maintenance items in an <info> response. S: S: S: S: Command completed successfully S: S: S: S: S: S: 2e6df9b0-4092-4491-bcc8-9fb2166dcee6 S: S: 2021-12-30T06:00:00Z S: 2021-12-30T07:00:00Z S: 2021-11-08T22:10:00Z S: S: S: 91e9dabf-c4e9-4c19-a56c-78e3e89c2e2f S: S: 2021-12-15T04:30:00Z S: 2021-12-15T05:30:00Z S: 2021-11-08T22:11:00Z S: 2021-11-17T15:00:00Z S: S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: ]]>

EPP <poll> Command The EPP <poll> command and response are defined in . The Registry Maintenance Notification is included in the EPP <poll> response in . There are five types of poll messages for the Registry Maintenance Notification, defined by the <maint:pollType> element in . A poll message might be generated when a maintenance event is created, updated, or deleted. A courtesy poll message can be sent as a reminder of an upcoming maintenance event. An end poll message can be sent when the maintenance event is completed. In the case of a message specific to Registry Maintenance, a <maint:infData> element that identifies the maintenance namespace will be included within the <resData> element of the standard <poll> response. The <maint:infData> element contains the <maint:item> element defined in . The following is an example of a <poll> command: C: C: C: C: ABC-12345 C: C: ]]> Example <poll> response: S: S: S: S: Command completed successfully; ack to dequeue S: S: S: 2021-11-08T22:10:00Z S: Registry Maintenance Notification S: S: S: S: S: 2e6df9b0-4092-4491-bcc8-9fb2166dcee6 S: create S: S: S: EPP S: epp.registry.example S: S: full S: S: S: S: 2021-12-30T06:00:00Z S: 2021-12-30T07:00:00Z S: planned S: S: https://www.registry.example/notice?123 S: S: S: example S: test S: S: S: false S: false S: S: 2021-11-08T22:10:00Z S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: ]]>

EPP Transform Commands 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>, <delete>, <renew>, <transfer>, and <update> commands.

Formal Syntax The EPP Registry Maintenance Notification schema is presented here. The formal syntax is a complete schema representation of the object mapping suitable for automated validation of EPP XML instances. The <CODE BEGINS> and <CODE ENDS> tags are not part of the schema; they are used to note the beginning and end of the schema for URI registration purposes.

Registry Maintenance Notification EPP Mapping Schema Extensible Provisioning Protocol v1.0 Registry Maintenance Notification Mapping Schema. ]]>

IANA Considerations

XML Namespace This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism defined in . The following entry has been registered as an XML namespace:

URI:

urn:ietf:params:xml:ns:epp:maintenance-1.0

Registrant Contact:

IESG

XML:

None. Namespace URIs do not represent an XML specification.

The following entry has been registered to the XML maintenance schema:

URI:

urn:ietf:params:xml:schema:epp:maintenance-1.0

Registrant Contact:

IESG

XML:

See the "Formal Syntax" section of this document.

EPP Extension Registry The following entry has been added to the "Extensions for the Extensible Provisioning Protocol (EPP)" registry, described in :

Name of Extension:

Registry Maintenance Notification for the Extensible Provisioning Protocol (EPP)

Document status:

Standards Track

Reference:

RFC 9167

Registrant Name and Email Address:

IESG <iesg@ietf.org>

TLDs:

Any

IPR Disclosure:

None

Status:

Active

Notes:

None

Security Considerations The security considerations of apply in this document. Additionally, a server MUST only provide maintenance information to clients that are authorized. Suppose a client queries a maintenance identifier that it is not authorized to access per , "Info Maintenance Item". In that case, the server SHOULD return an EPP error result code of 2201 ("Authorization error") or 2303 ("Object does not exist") . The list of top-level domains or registry zones returned in the "Info Maintenance Item" response SHOULD be filtered based on the top-level domains or registry zones for which the client is authorized. Authorization of poll messages is done at the time of poll message insertion and not at the time of poll message consumption.

References Normative References WHATWG World Wide Web Consortium Recommendation REC-xml-20081126 Informative References

Acknowledgments The authors wish to thank the following persons for their feedback and suggestions: , , , , , , , , , and .