or <delete> response described in the EPP domain mapping [2].
4.2.3. EPP <renew> Command
This extension does not add any elements to the EPP <renew> command
or <renew> response described in the EPP domain mapping [2].
4.2.4. 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.5. EPP <update> Command
This extension defines additional elements to extend the EPP <update>
command and response described in the EPP domain mapping [2] for
redemption grace period processing.
The EPP <update> command provides a transform operation that allows a
client to change the state of a domain object. The registry grace
period extension modifies base update processing to support
redemption of domain names for which a <delete> command has been
processed, but the name has not yet been purged.
Section 3.2.5 of the EPP domain mapping describes the elements that
have to be specified within an <update> command. The requirement to
provide at least one <domain:add>, <domain:rem>, or <domain:chg>
element is updated by this extension such that at least one empty
<domain:add>, <domain:rem>, or <domain:chg> element MUST be present
if this extension is specified within an <update> command. This
requirement is updated to disallow the possibility of modifying a
domain object as part of redemption grace period recovery processing.
In addition to the EPP command elements described in the EPP domain
mapping [2], the <update> command MUST contain an <extension>
element. The <extension> element MUST contain a child <rgp:update>
element that identifies the registry grace period namespace and the
location of the registry grace period schema. The <rgp:update>
element contains a single <rgp:restore> element that contains an
OPTIONAL <rgp:report> element that MAY be used to deliver a
redemption grace period restore report.
The <rgp:restore> element contains a REQUIRED "op" attribute that
describes the redemption grace period operation being requested. Two
values are defined: "request" is used to identify a restore request
that does not include a restore report, and "report" is used to
identify a restore request that contains a restore report. A report
MAY be submitted more than once if corrections are required. If the
value of the "op" attribute is "request" an <rgp:report> element MUST
NOT be present. If the value of the "op" attribute is "report" an
<rgp:report> element MUST be present.
The <rgp:report> element contains the following child elements:
- An <rgp:preData> element that contains a copy of the registration
data that existed for the domain name prior to the domain name
being deleted. This element MAY contain both text and XML markup.
- An <rgp:postData> element that contains a copy of the registration
data that exists for the domain name at the time the restore
report is submitted. This element MAY contain both text and XML
markup.
- An <rgp:delTime> element that contains the date and time when the
domain name delete request was sent to the server.
- An <rgp:resTime> element that contains the date and time when the
original <rgp:restore> command was sent to the server.
- An <rgp:resReason> element that contains a brief explanation of
the reason for restoring the domain name.
- An <rgp:statement> element that contains a text statement that the
client has not restored the domain name in order to assume the
rights to use or sell the domain name for itself or for any third
party. Supporting information related to this statement MAY be
supplied in the <rgp:other> element described below. An OPTIONAL
"lang" attribute MAY be present to identify the language if
English (value "en") is not used to represent the statement.
- A second <rgp:statement> element that contains a text statement
that the information in the restore report is factual to the best
of the client’s knowledge. An OPTIONAL "lang" attribute MAY be
present to identify the language if English (value "en") is not
used to represent the statement.
- An OPTIONAL <rgp:other> element that contains any information
needed to support the statements provided by the client. This
element MAY contain both text and XML markup.
More detailed information describing the information required to be
provided in a restore report is available from ICANN.
Example <update> command without a restore report:
C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0"
C: xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
C: xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0
C: epp-1.0.xsd">
C: <command>
C: <update>
C: <domain:update
C: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
C: xsi:schemaLocation="urn:ietf:params:xml:ns:domain-1.0
C: domain-1.0.xsd">
C: <domain:name>example.com</domain:name>
C: <domain:chg/>
C: </domain:update>
C: </update>
C: <extension>
C: <rgp:update xmlns:rgp="urn:ietf:params:xml:ns:rgp-1.0"
C: xsi:schemaLocation="urn:ietf:params:xml:ns:rgp-1.0
C: rgp-1.0.xsd">
C: <rgp:restore op="request"/>
C: </rgp:update>
C: </extension>
C: <clTRID>ABC-12345</clTRID>
C: </command>
C:</epp>
Example <update> command with a restore report:
C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0"
C: xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
C: xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0
C: epp-1.0.xsd">
C: <command>
C: <update>
C: <domain:update
C: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
C: xsi:schemaLocation="urn:ietf:params:xml:ns:domain-1.0
C: domain-1.0.xsd">
C: <domain:name>example.com</domain:name>
C: <domain:chg/>
C: </domain:update>
C: </update>
C: <extension>
C: <rgp:update xmlns:rgp="urn:ietf:params:xml:ns:rgp-1.0"
C: xsi:schemaLocation="urn:ietf:params:xml:ns:rgp-1.0
C: rgp-1.0.xsd">
C: <rgp:restore op="report">
C: <rgp:report>
C: <rgp:preData>Pre-delete registration data goes here.
C: Both XML and free text are allowed.</rgp:preData>
C: <rgp:postData>Post-restore registration data goes here.
C: Both XML and free text are allowed.</rgp:postData>
C: <rgp:delTime>2003-07-10T22:00:00.0Z</rgp:delTime>
C: <rgp:resTime>2003-07-20T22:00:00.0Z</rgp:resTime>
C: <rgp:resReason>Registrant error.</rgp:resReason>
C: <rgp:statement>This registrar has not restored the
C: Registered Name in order to assume the rights to use
C: or sell the Registered Name for itself or for any
C: third party.</rgp:statement>
C: <rgp:statement>The information in this report is
C: true to best of this registrar’s knowledge, and this
C: registrar acknowledges that intentionally supplying
C: false information in this report shall constitute an
C: incurable material breach of the
C: Registry-Registrar Agreement.</rgp:statement>
C: <rgp:other>Supporting information goes
C: here.</rgp:other>
C: </rgp:report>
C: </rgp:restore>
C: </rgp:update>
C: </extension>
C: <clTRID>ABC-12345</clTRID>
C: </command>
C:</epp>
When an extended <update> command without a restore report has been
processed successfully, the EPP response is as described in the EPP
domain mapping [2] except that an extension element is added to
describe grace period status as a result of processing the <update>
command. The extension element contains a single child element
(<upData>) that itself contains a single child element (<rgpStatus>)
that contains a single attribute "s" whose value MUST be
"pendingRestore" if the <restore> request has been accepted.
Example "restore request" <update> response:
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 lang="en">Command completed successfully</msg>
S: </result>
S: <extension>
S: <rgp:upData 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:upData>
S: </extension>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54321-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>
When an extended <update> command with a restore report has been
processed successfully, the EPP response is as described in the EPP
domain mapping [2] with no registry grace period extension. Registry
grace period extension is not required because acceptance of the
restore report completes redemption grace period processing.
5. Formal Syntax
An EPP object mapping is specified in XML Schema notation. 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 ending of the schema for URI
registration purposes.
BEGIN
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="urn:ietf:params:xml:ns:rgp-1.0"
xmlns:rgp="urn:ietf:params:xml:ns:rgp-1.0"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<annotation>
<documentation>
Extensible Provisioning Protocol v1.0
domain name extension schema for registry grace period
processing.
</documentation>
</annotation>
<!--
Child elements found in EPP commands.
-->
<element name="update" type="rgp:updateType"/>
<!--
Child elements of the <update> command for the
redemption grace period.
-->
<complexType name="updateType">
<sequence>
<element name="restore" type="rgp:restoreType"/>
</sequence>
</complexType>
<complexType name="restoreType">
<sequence>
<element name="report" type="rgp:reportType"
minOccurs="0"/>
</sequence>
<attribute name="op" type="rgp:rgpOpType" use="required"/>
</complexType>
<!--
New redemption grace period operations can be defined
by adding to this enumeration.
-->
<simpleType name="rgpOpType">
<restriction base="token">
<enumeration value="request"/>
<enumeration value="report"/>
</restriction>
</simpleType>
<complexType name="reportType">
<sequence>
<element name="preData" type="rgp:mixedType"/>
<element name="postData" type="rgp:mixedType"/>
<element name="delTime" type="dateTime"/>
<element name="resTime" type="dateTime"/>
<element name="resReason" type="rgp:reportTextType"/>
<element name="statement" type="rgp:reportTextType"
maxOccurs="2"/>
<element name="other" type="rgp:mixedType"
minOccurs="0"/>
</sequence>
</complexType>
<complexType name="mixedType">
<complexContent mixed="true">
<restriction base="anyType">
<sequence>
<any processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</restriction>
</complexContent>
</complexType>
<complexType name="reportTextType">
<complexContent mixed="true">
<restriction base="anyType">
<sequence>
<any processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</sequence>
<attribute name="lang" type="language" default="en"/>
</restriction>
</complexContent>
</complexType>
<!--
Child response elements.
-->
<element name="infData" type="rgp:respDataType"/>
<element name="upData" type="rgp:respDataType"/>
<!--
Response elements.
-->
<complexType name="respDataType">
<sequence>
<element name="rgpStatus" type="rgp:statusType"
maxOccurs="unbounded"/>
</sequence>
</complexType>
<!--
Status is a combination of attributes and an optional
human-readable message that may be expressed in languages
other than English.
-->
<complexType name="statusType">
<simpleContent>
<extension base="normalizedString">
<attribute name="s" type="rgp:statusValueType"
use="required"/>
<attribute name="lang" type="language" default="en"/>
</extension>
</simpleContent>
</complexType>
<simpleType name="statusValueType">
<restriction base="token">
<enumeration value="addPeriod"/>
<enumeration value="autoRenewPeriod"/>
<enumeration value="renewPeriod"/>
<enumeration value="transferPeriod"/>
<enumeration value="pendingDelete"/>
<enumeration value="pendingRestore"/>
<enumeration value="redemptionPeriod"/>
</restriction>
</simpleType>
<!--
End of schema.
-->
</schema>
END
6. Internationalization Considerations
EPP is represented in XML, which provides native support for encoding
information using the Unicode character set and its more compact
representations including UTF-8 [10]. Conformant XML processors
recognize both UTF-8 and UTF-16 [11]. Though XML includes provisions
to identify and use other character encodings through use of an
"encoding" attribute in an <?xml?> declaration, use of UTF-8 is
RECOMMENDED in environments where parser encoding support
incompatibility exists.
As an extension of the EPP domain mapping [2], the elements, element
content, attributes, and attribute values described in this document
MUST inherit the internationalization conventions used to represent
higher-layer domain and core protocol structures present in an XML
instance that includes this extension.
7. IANA Considerations
This document uses URNs to describe XML namespaces and XML schemas
conforming to a registry mechanism described in RFC 3688 [8]. Two
URI assignments were requested and have been registered by the IANA.
Registration request for the registry grace period namespace:
URI: urn:ietf:params:xml:ns:rgp-1.0
Registrant Contact: See the "Author’s Address" section of this
document.
XML: None. Namespace URIs do not represent an XML specification.
Registration request for the registry grace period XML schema:
URI: urn:ietf:params:xml:schema:rgp-1.0
Registrant Contact: See the "Author’s Address" section of this
document.
XML: See the "Formal Syntax" section of this document.
8. Security Considerations
The mapping extensions described in this document do not provide any
security services beyond those described by EPP [1], the EPP domain
name mapping [2], and protocol layers used by EPP. The security
considerations described in these other specifications apply to this
specification as well.
As with other domain object updates, redemption of a deleted domain
object MUST be restricted to the sponsoring client as authenticated
using the mechanisms described in sections 2.9.1.1 and 7 of RFC 3730
[1]. Any attempt to recover a deleted domain object by any client
other than the sponsoring client MUST be rejected with an appropriate
EPP authorization error.
9. Acknowledgements
The author would like to thank the following people who have provided
significant contributions to the development of this document:
James Gould, Antony Perkov, and Janusz Sienkiewicz.
10. References
10.1. Normative References
[1] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", RFC
3730, March 2004.
[2] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) Domain
Name Mapping", RFC 3731, March 2004.
[3] Bray, T., Paoli, J., Sperberg-McQueen, C., and E. Maler,
"Extensible Markup Language (XML) 1.0 (2nd ed)", W3C REC-xml,
October 2000, <http://www.w3.org/TR/REC-xml>.
[4] Thompson, H., Beech, D., Maloney, M., and N. Mendelsohn, "XML
Schema Part 1: Structures", W3C REC-xmlschema-1, May 2001,
<http://www.w3.org/TR/xmlschema-1/>.
[5] Biron, P. and A. Malhotra, "XML Schema Part 2: Datatypes", W3C
REC-xmlschema-2, May 2001, <http://www.w3.org/TR/xmlschema-2/>.
[6] Bradner, S., "Key words for use in RFCs to Indicate Requirement
Levels", BCP 14, RFC 2119, March 1997.
[7] Klyne, G. and C. Newman, "Date and Time on the Internet:
Timestamps", RFC 3339, July 2002.
[8] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, January
2004.
10.2. Informative References
[9] Harrenstien, K., Stahl, M., and E. Feinler, "NICNAME/WHOIS", RFC
954, October 1985.
[10] Yergeau, F., "UTF-8, a transformation format of ISO 10646", STD
63, RFC 3629, November 2003.
[11] Hoffman, P. and F. Yergeau, "UTF-16, an encoding of ISO 10646",
RFC 2781, February 2000.
Author’s Address
Scott Hollenbeck
VeriSign, Inc.
21345 Ridgetop Circle
Dulles, VA 20166-6503
US
EMail: shollenbeck@verisign.com
Full Copyright Statement
Copyright (C) The Internet Society (2004).
This document is subject to the rights, licenses and restrictions
contained in BCP 78, and except as set forth therein, the authors
retain all their rights.
This document and the information contained herein are provided on an
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/S HE
REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE
INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Intellectual Property
The IETF takes no position regarding the validity or scope of any
Intellectual Property Rights or other rights that might be claimed to
pertain to the implementation or use of the technology described in
this document or the extent to which any license under such rights
might or might not be available; nor does it represent that it has
made any independent effort to identify any such rights. Information
on the IETF’s procedures with respect to rights in IETF Documents can
be found in BCP 78 and BCP 79.
Copies of IPR disclosures made to the IETF Secretariat and any
assurances of licenses to be made available, or the result of an
attempt made to obtain a general license or permission for the use of
such proprietary rights by implementers or users of this
specification can be obtained from the IETF on-line IPR repository at
http://www.ietf.org/ipr.
The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary
rights that may cover technology that may be required to implement
this standard. Please address the information to the IETF at ietf-
ipr@ietf.org.
Acknowledgement
Funding for the RFC Editor function is currently provided by the
Internet Society.