Request for Comments: 3915 VeriSign, Inc.
Category: Standards Track September 2004
Domain Registry Grace Period Mapping for the
Extensible Provisioning Protocol (EPP)
Status of this Memo
This document specifies an Internet standards track protocol for the
Internet community, and requests discussion and suggestions for
improvements. Please refer to the current edition of the "Internet
Official Protocol Standards" (STD 1) for the standardization state
and status of this protocol. Distribution of this memo is unlimited.
Copyright Notice
Copyright (C) The Internet Society (2004).
Abstract
This document describes an Extensible Provisioning Protocol (EPP)
extension mapping for the management of Domain Name System (DNS)
domain names subject to "grace period" policies defined by the
Internet Corporation for Assigned Names and Numbers (ICANN). Grace
period policies exist to allow protocol actions to be reversed or
otherwise revoked during a short period of time after the protocol
action has been performed. Specified in XML, this mapping extends
the EPP domain name mapping to provide additional features required
for grace period processing.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Conventions Used In This Document. . . . . . . . . . . . 4
2. Redemption Grace Period State Diagram . . . . . . . . . . . . 4
3. Object Attributes . . . . . . . . . . . . . . . . . . . . . . 6
3.1. Status Values . . . . . . . . . . . . . . . . . . . . . 6
3.2. Registration Data and Supporting Information . . . . . . 7
3.3. Dates and Times . . . . . . . . . . . . . . . . . . . . 7
3.4. Client Statements . . . . . . . . . . . . . . . . . . . 8
4. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 8
4.1 EPP Query Commands . . . . . . . . . . . . . . . . . . . 8
4.1.1. EPP <check> Command . . . . . . . . . . . . . . 8
4.1.2. EPP <info> Command . . . . . . . . . . . . . . . 8
4.1.3. EPP <transfer> Command . . . . . . . . . . . . . 11
4.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 11
4.2.1. EPP <create> Command . . . . . . . . . . . . . . 12
4.2.2. EPP <delete> Command . . . . . . . . . . . . . . 12
4.2.3. EPP <renew> Command . . . . . . . . . . . . . . 12
4.2.4. EPP <transfer> Command . . . . . . . . . . . . . 12
4.2.5. EPP <update> Command . . . . . . . . . . . . . . 12
5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 16
6. Internationalization Considerations . . . . . . . . . . . . . 19
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 20
8. Security Considerations . . . . . . . . . . . . . . . . . . . 20
9. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 20
10. References . . . . . . . . . . . . . . . . . . . . . . . . . . 21
10.1. Normative References . . . . . . . . . . . . . . . . . . 21
10.2. Informative References . . . . . . . . . . . . . . . . . 21
Author’s Address . . . . . . . . . . . . . . . . . . . . . . . . . 22
Full Copyright Statement . . . . . . . . . . . . . . . . . . . . . 23
1. Introduction
This document describes an extension mapping for version 1.0 of the
Extensible Provisioning Protocol (EPP) described in RFC 3730 [1].
This mapping, an extension of the domain name mapping described in
RFC 3731 [2], is specified using the Extensible Markup Language (XML)
1.0 [3] and XML Schema notation ([4], [5]).
The EPP core protocol specification [1] provides a complete
description of EPP command and response structures. A thorough
understanding of the base protocol specification is necessary to
understand the mapping described in this document.
Over the course of several months in 2002, The Internet Corporation
for Assigned Names and Numbers (ICANN) developed an implementation
proposal to provide a "grace period" for Domain Name System (DNS)
domain name recovery (or redemption) before a domain name is purged
from the repository of the authoritative registry for the domain
name. This mapping extends the EPP domain <update> command to
initiate the redemption process for a domain name that has entered
the Redemption Grace Period (RGP) and it extends the EPP domain
<info> response to identify the status of domains that have entered
various grace periods defined by ICANN policy.
In March 2003, ICANN published a task force report describing other
domain registry grace periods related to EPP operations. This
mapping describes extension status values to note the grace periods
described in the report, including:
o An "add grace period" after the initial registration of a domain
name. If the domain name is deleted by the registrar during this
period, the registry provides a credit to the registrar for the
cost of the registration.
o An "auto-renew grace period" after a domain name registration
period expires and is extended (renewed) automatically by the
registry. If the domain name is deleted by the registrar during
this period, the registry provides a credit to the registrar for
the cost of the renewal.
o A "renew grace period" after a domain name registration period is
explicitly extended (renewed) by the registrar. If the domain
name is deleted by the registrar during this period, the registry
provides a credit to the registrar for the cost of the renewal.
o A "transfer grace period" after the successful transfer of domain
name registration sponsorship from one registrar to another
registrar. If the domain name is deleted by the new sponsoring
registrar during this period, the registry provides a credit to
the registrar for the cost of the transfer.
Each grace period exists for a specific period of time that is
typically measured in days. The duration of each grace period is a
matter of registry operational policy that is not addressed in this
document.
1.1. Conventions Used In This Document
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 BCP 14, RFC 2119 [6].
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 is provided only to illustrate element
relationships and is not a REQUIRED feature of this specification.
XML is case sensitive. Unless stated otherwise, XML specifications
and examples provided in this document MUST be interpreted in the
character case presented to develop a conforming implementation.
2. Redemption Grace Period State Diagram
The Redemption Grace Period (RGP) involves several domain state
transitions as a domain name moves through the redemption process:
1. A domain is initially in the EPP "ok" status, or some other
status that allows processing of the EPP <delete> command.
2. A <delete> command is received and processed for the domain name.
3. RGP begins once the <delete> command is processed successfully.
The EPP status changes to "pendingDelete", and the RGP status is
initialized to "redemptionPeriod". The domain remains in this
state until either a <restore> operation is requested or the
redemption period elapses.
4. A <restore> operation can be requested using the extended EPP
<update> command. Go to step 8 if the redemption period elapses
before a <restore> request is received.
5. If the <restore> is successful, the Registry waits to receive a
restore report from the registrar for a period of time defined by
the Registry. The EPP status remains "pendingDelete" and the RGP
status changes to "pendingRestore". While this extension defines
a method to deliver a restore report via EPP, an out-of-band
mechanism (such as a web site) can also be used to deliver
restore reports.
6. The domain name returns to the redemption period state (state 3)
if a restore report is not received.
7. If a restore report is received the EPP status returns to "ok"
(or whatever it was prior to processing the <delete> command),
and the RGP status is removed completely.
8. The redemption period elapses before a <restore> request is
received.
9. The EPP status remains "pendingDelete" and the RGP status changes
to "pendingDelete". The domain name remains in this state for a
period of time defined by the Registry.
10. The domain name is purged once the pending delete period elapses.
11. The domain name is available for re-registration.
Figure 1: RGP State Diagram
|
v
+----------------------+ (2) +----------------------+
|EPP: ok (1)| <delete> |EPP: pendingDelete (3)|
|RGP: N/A |--------->|RGP: redemptionPeriod |
+----------------------+ +----------------------+
^ (4) | ^ |
| <restore> | | No (8) |
| +-----------+ | <restore> |
| | | |
| v | v
| +----------------------+ | +----------------------+
| |EPP: pendingDelete (5)| | |EPP: pendingDelete (9)|
| |RGP: pendingRestore |---------+ |RGP: pendingDelete |
| +----------------------+ Report +----------------------+
| | not (6) |
| (7) | Received Purge (10) |
| Report Received | |
+--------------------+ v
+----------------------+
| Purged (11)|
| |
+----------------------+
3. Object Attributes
This extension adds additional elements to the EPP domain name
mapping [2]. Only new element descriptions are described here.
3.1. Status Values
This extension defines new status values to represent the different
states that a domain name can be in as a result of grace period
processing. These are:
addPeriod: This grace period is provided after the initial
registration of a domain name. If the domain name is deleted by
the registrar during this period, the registry provides a credit
to the registrar for the cost of the registration.
autoRenewPeriod: This grace period is provided after a domain
name registration period expires and is extended (renewed)
automatically by the registry. If the domain name is deleted by
the registrar during this period, the registry provides a credit
to the registrar for the cost of the renewal.
renewPeriod: This grace period is provided after a domain name
registration period is explicitly extended (renewed) by the
registrar. If the domain name is deleted by the registrar during
this period, the registry provides a credit to the registrar for
the cost of the renewal.
transferPeriod: This grace period is provided after the
successful transfer of domain name registration sponsorship from
one registrar to another registrar. If the domain name is deleted
by the new sponsoring registrar during this period, the registry
provides a credit to the registrar for the cost of the transfer.
redemptionPeriod: This status value is used to describe a
domain for which a <delete> command has been received, but the
domain has not yet been purged because an opportunity exists to
restore the domain and abort the deletion process.
pendingRestore: This status value is used to describe a domain that
is in the process of being restored after being in the
redemptionPeriod state.
pendingDelete: This status value is used to describe a domain that
has entered the purge processing state after completing the
redemptionPeriod state. A domain in this status MUST also be in
the pendingDelete status described in the EPP domain mapping [2].
3.2. Registration Data and Supporting Information
This extension allows a client to provide copies of registration data
(whois [9] data, for example) and supporting information in a restore
report as required by the RGP process. No specific format is
required by this extension; both free text and XML markup MAY be
used.
Operators of servers that provide registration data might find it
useful to provide grace period status values in their responses to
client queries. This information can be useful to people who want to
understand the operations that can be performed on a domain name at
any give time.
3.3. 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 RFC
3339 [7] 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.4. Client Statements
The RGP process requires a client to make two statements regarding
the data included in a restore report. No specific format is
required by this extension; both free text and XML markup MAY be
used. English is the default language used within the statements,
but other languages MAY be used.
4. EPP Command Mapping
A detailed description of the EPP syntax and semantics can be found
in the EPP core protocol specification [1]. The command mappings
described here are specifically for use in implementing redemption
grace period processes via EPP.
4.1. 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.
4.1.1. EPP <check> Command
This extension does not add any elements to the EPP <check> command
or <check> response described in the EPP domain mapping [2].
4.1.2. EPP <info> Command
This extension does not add any elements to the EPP <info> command
described in the EPP domain mapping [2]. Additional elements are
defined for the <info> response.
When an <info> command has been processed successfully, the EPP
<resData> element MUST contain child elements as described in [2]. In
addition, the EPP <extension> element MUST contain a child
<rgp:infData> element that identifies the registry grace period
namespace and the location of the registry grace period schema. The
<rgp:infData> element contains a single <rgp:rgpStatus> element that
contains a single attribute "s" whose value describes the current
grace period status of the domain. Possible status values are
described in section Section 3.1.
Example <info> response for "addPeriod" status:
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0"
S: xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
S: xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0
S: epp-1.0.xsd">
S: <response>
S: <result code="1000">
S: <msg>Command completed successfully</msg>
S: </result>
S: <resData>
S: <domain:infData
S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
S: xsi:schemaLocation="urn:ietf:params:xml:ns:domain-1.0
S: domain-1.0.xsd">
S: <domain:name>example.com</domain:name>
S: <domain:roid>EXAMPLE1-REP</domain:roid>
S: <domain:status s="ok"/>
S: <domain:registrant>jd1234</domain:registrant>
S: <domain:contact type="admin">sh8013</domain:contact>
S: <domain:contact type="tech">sh8013</domain:contact>
S: <domain:ns>
S: <domain:hostObj>ns1.example.com</domain:hostObj>
S: <domain:hostObj>ns1.example.net</domain:hostObj>
S: </domain:ns>
S: <domain:host>ns1.example.com</domain:host>
S: <domain:host>ns2.example.com</domain:host>
S: <domain:clID>ClientX</domain:clID>
S: <domain:crID>ClientX</domain:crID>
S: <domain:crDate>2003-11-26T22:00:00.0Z</domain:crDate>
S: <domain:exDate>2005-11-26T22:00:00.0Z</domain:exDate>
S: <domain:authInfo>
S: <domain:pw>2fooBAR</domain:pw>
S: </domain:authInfo>
S: </domain:infData>
S: </resData>
S: <extension>
S: <rgp:infData xmlns:rgp="urn:ietf:params:xml:ns:rgp-1.0"
S: xsi:schemaLocation="urn:ietf:params:xml:ns:rgp-1.0
S: rgp-1.0.xsd">
S: <rgp:rgpStatus s="addPeriod"/>
S: </rgp:infData>
S: </extension>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54322-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>
Example <info> response for "redemptionPeriod" status:
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0"
S: xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
S: xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0
S: epp-1.0.xsd">
S: <response>
S: <result code="1000">
S: <msg>Command completed successfully</msg>
S: </result>
S: <resData>
S: <domain:infData
S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
S: xsi:schemaLocation="urn:ietf:params:xml:ns:domain-1.0
S: domain-1.0.xsd">
S: <domain:name>example.com</domain:name>
S: <domain:roid>EXAMPLE1-REP</domain:roid>
S: <domain:status s="pendingDelete"/>
S: <domain:registrant>jd1234</domain:registrant>
S: <domain:contact type="admin">sh8013</domain:contact>
S: <domain:contact type="tech">sh8013</domain:contact>
S: <domain:ns>
S: <domain:hostObj>ns1.example.com</domain:hostObj>
S: <domain:hostObj>ns1.example.net</domain:hostObj>
S: </domain:ns>
S: <domain:host>ns1.example.com</domain:host>
S: <domain:host>ns2.example.com</domain:host>
S: <domain:clID>ClientX</domain:clID>
S: <domain:crID>ClientY</domain:crID>
S: <domain:crDate>1999-04-03T22:00:00.0Z</domain:crDate>
S: <domain:upID>ClientX</domain:upID>
S: <domain:upDate>1999-12-03T09:00:00.0Z</domain:upDate>
S: <domain:exDate>2005-04-03T22:00:00.0Z</domain:exDate>
S: <domain:trDate>2000-04-08T09:00:00.0Z</domain:trDate>
S: <domain:authInfo>
S: <domain:pw>2fooBAR</domain:pw>
S: </domain:authInfo>
S: </domain:infData>
S: </resData>
S: <extension>
S: <rgp:infData xmlns:rgp="urn:ietf:params:xml:ns:rgp-1.0"
S: xsi:schemaLocation="urn:ietf:params:xml:ns:rgp-1.0
S: rgp-1.0.xsd">
S: <rgp:rgpStatus s="redemptionPeriod"/>
S: </rgp:infData>
S: </extension>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54322-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>
Example <info> response extension for "pendingRestore" status (note
that only the extension element changes from the first example):
S:<extension>
S: <rgp:infData xmlns:rgp="urn:ietf:params:xml:ns:rgp-1.0"
S: xsi:schemaLocation="urn:ietf:params:xml:ns:rgp-1.0
S: rgp-1.0.xsd">
S: <rgp:rgpStatus s="pendingRestore"/>
S: </rgp:infData>
S:</extension>
Example <info> response extension for "pendingDelete" status (note
that only the extension element changes from the first example):
S:<extension>
S: <rgp:infData xmlns:rgp="urn:ietf:params:xml:ns:rgp-1.0"
S: xsi:schemaLocation="urn:ietf:params:xml:ns:rgp-1.0
S: rgp-1.0.xsd">
S: <rgp:rgpStatus s="pendingDelete"/>
S: </rgp:infData>
S:</extension>
4.1.3. EPP <transfer> Command
This extension does not add any elements to the EPP <transfer>
command or <transfer> response described in the EPP domain mapping
[2].
4.2. 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.
4.2.1. EPP <create> Command
This extension does not add any elements to the EPP <create> command
or <create> response described in the EPP domain mapping [2].
4.2.2. EPP <delete> Command
This extension does not add any elements to the EPP <delete> command