Internet Engineering Task Force | W.T. Tan |
Internet-Draft | Cloud Registry |
Intended status: Standards Track | G.B. Brown |
Expires: October 19, 2013 | CentralNic Ltd |
J.G. Gould | |
VeriSign, Inc. | |
April 17, 2013 |
Launch Phase Mapping for the Extensible Provisioning Protocol (EPP)
draft-tan-epp-launchphase-09
This document describes an Extensible Provisioning Protocol (EPP) extension mapping for the provisioning and management of domain name registrations and kapplications during the launch of a domain name registry.
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 http://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 October 19, 2013.
Copyright (c) 2013 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 (http://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.
This document describes an extension mapping for version 1.0 of the Extensible Provisioning Protocol (EPP) [RFC5730]. This EPP mapping specifies a flexible schema that can be used to implement several common use cases related to the provisioning and management of domain name registrations and applications during the launch of a domain name registry.
It is typical for domain registries to operate in special modes during their initial launch to facilitate allocation of domain names, often according to special rules. This document uses the term "launch phase" and the shorter form "launch" to refer to such a period.
The EPP domain name mapping [RFC5731] is designed for the steady-state operation of a registry. During a launch period, the model in place may be different from what is defined in the EPP domain name mapping [RFC5731]. For example, registries often accept multiple applications for the same domain name during the "Sunrise" launch phase, referred to as a Launch Application. A Launch Registration refers to a registration made during a launch phase when the server uses a "first-come, first-served" model. Even in a "first-come, first-served" model, additional steps and information might be required, such as trademark information. In addition, the TMCH Functional Specification defines a registry interface for the Trademark Claims or "claims" launch phase that includes support for presenting a Trademark Claims Notice to the Registrant. This document proposes an extension to the domain name extension in order to unambiguously manage the various launch phases known.
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 RFC 2119 [RFC2119].
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.
"launch-1.0" is used as an abbreviation for "urn:ietf:params:xml:ns:launch-1.0". The XML namespace prefix "launch" 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.
"signedMark-1.0" is used as an abbreviation for "urn:ietf:params:xml:ns:signedMark-1.0" that is defined in [draft-lozano-smd]. The XML namespace prefix "smd" 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.
"mark-1.0" is used as an abbreviation for "urn:ietf:params:xml:ns:mark-1.0" that is defined in [draft-lozano-smd]. The XML namespace prefix "mark" 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.
This extension adds additional elements to the EPP domain name mapping [RFC5731]. Only those new elements are described here.
Servers MAY allow multiple applications, referred to as a Launch Application, of the same domain name during its launch phase operations. Upon receiving a valid request to create a Launch Application, the server MUST create an application object corresponding to the request, assign an application identifier for the Launch Application, set the [RFC5731] pendingCreate status, and return the application identifier to the client with the <launch:applicationID> element. In order to facilitate correlation, all subsequent launch operations on the Launch Application MUST be qualified by the previously assigned application identifier using the <launch:applicationID> element.
The server MAY support multiple launch phases sequentially or simultaneously. The <launch:phase> element MUST be included by the client to define the target launch phase of the command. The server SHOULD validate the <launch:phase> element against the active phase of the server for a create command, and return an EPP error result code of 2004 if there is a mismatch.
The following launch phase values are defined:
For extensibility, the <launch:phase> element includes an OPTIONAL "name" attribute that can define a sub-phase or the full name of the phase when the <launch:phase> element has the "custom" value. For example, the "claims" launch phase could have two sub-phases that include "landrush" and "open".
Launch phases MAY overlap to support the "claims" launch phase, defined in the TMCH Functional Specification, and to support a traditional "landrush" launch phase. The overlap of the "claims" and "landrush" launch phases SHOULD be handled by setting "claims" as the <launch:phase> value and setting "landrush" as the sub-phase with the "name" attribute. For example, the <launch:phase> element SHOULD be <launch:phase name="landrush">claims</launch:phase>.
A Launch Application or Launch Registration object MAY have a launch status value. The <launch:status> element is used to convey the launch status pertaining to the object, beyond what is specified in the object mapping. A Launch Application or Launch Registration MUST set the [RFC5731] pendingCreate status if a launch status is supported and the launch status is not one of the final statuses, including the "allocated" and "rejected" statuses.
The following status values are defined using the required "s" attribute:
Each status value MAY be accompanied by a string of human-readable text that describes the rationale for the status applied to the object. 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).
For extensibility the <launch:status> element includes an OPTIONAL "name" attribute that can define a sub-status or the full name of the status when the status value is "custom". The server SHOULD NOT use the "custom" status value.
Certain status values MAY be combined. For example, an application or registration may be both "invalid" and "rejected". Additionally, certain statuses MAY be skipped. For example, an application or registration MAY immediately start at the "allocated" status or an application or registration MAY skip the "pendingAllocation" status. If the launch phase does not require validation of a request, an application or registration MAY immediately skip to "pendingAllocation". If the <domain:create> command processes a request synchronously without the use of an intermediate application, then an Application Identifier [applicationID] MAY not be needed along with the application status.
| request | v +-------------------+ | | | pendingValidation | | | +---------+---------+ | | +-----------+-----------+ | | | | v v +-----------+ +---------+ | | | | | validated | | invalid | | | | | +-----+-----+ +----+----+ | | | | v | +-------------------+ | | | | | pendingAllocation | | | | | +-------------------+ | | | | | +-----------------------+ | | | | v v +---------+ +--------+ / \ / \ | allocated | | rejected | \ / \ / +---------+ +--------+
Figure 1
A Launch Application MUST and a Launch Registration MAY be handled as a domain name of [RFC5731] in "pendingCreate" status, with the launch status values defined in Section 2.3. As a Launch Application or Launch Registration transitions between the status values defined in Section 2.3, the server SHOULD insert poll messages, per [RFC5730], for the applicable intermediate statuses, including the "pendingValidation", "validated", "pendingAllocation, and "invalid" statuses, using the <domain:infData> element with the <launch:infData> extension. The <domain:infData> element MAY contain non-mandatory information, like contact and name server information. Also, further extensions that would normally be included in the response of a <domain:info> command, per [RFC5731], MAY be included. For the final statuses, including the "allocated" and "rejected" statuses, the server MUST insert a <domain:panData> poll message, per [RFC5731], with the <launch:infData> extension.
The following is an example poll message for a Launch Application that has transitioned to the "pendingAllocation" state.
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <msgQ count="5" id="12345"> <qDate>2013-04-04T22:01:00.0Z</qDate> <msg>Application pendingAllocation.</msg> </msgQ> <resData> <domain:infData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>example.tld</domain:name> ... </domain:infData> </resData> <extension> <launch:infData xmlns:launch="urn:ietf:params:xml:ns:launch-1.0"> <launch:phase>sunrise</launch:phase> <launch:applicationID>abc123</launch:applicationID> <launch:status s="pendingAllocation"/> </launch:infData> </extension> <trID> <clTRID>ABC-12345</clTRID> <svTRID>54322-XYZ</svTRID> </trID> </response> </epp>
The following is an example <domain:panData> poll message for an "allocated" Launch Application.
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <msgQ count="5" id="12345"> <qDate>2013-04-04T22:01:00.0Z</qDate> <msg>Application successfully allocated.</msg> </msgQ> <resData> <domain:panData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name paResult="1">example.tld</domain:name> <domain:paTRID> <clTRID>ABC-12345</clTRID> <svTRID>54321-XYZ</svTRID> </domain:paTRID> <domain:paDate>2013-04-04T22:00:00.0Z</domain:paDate> </domain:panData> </resData> <extension> <launch:infData xmlns:launch="urn:ietf:params:xml:ns:launch-1.0"> <launch:phase>sunrise</launch:phase> <launch:applicationID>abc123</launch:applicationID> <launch:status s="allocated"/> </launch:infData> </extension> <trID> <clTRID>BCD-23456</clTRID> <svTRID>65432-WXY</svTRID> </trID> </response> </epp>
The following is an example <domain:panData> poll message for an "allocated" Launch Registration.
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg>Command completed successfully; ack to dequeue</msg> </result> <msgQ count="5" id="12345"> <qDate>2013-04-04T22:01:00.0Z</qDate> <msg>Registration successfully allocated.</msg> </msgQ> <resData> <domain:panData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name paResult="1">example.tld</domain:name> <domain:paTRID> <clTRID>ABC-12345</clTRID> <svTRID>54321-XYZ</svTRID> </domain:paTRID> <domain:paDate>2013-04-04T22:00:00.0Z</domain:paDate> </domain:panData> </resData> <extension> <launch:infData xmlns:launch="urn:ietf:params:xml:ns:launch-1.0"> <launch:phase>sunrise</launch:phase> <launch:status s="allocated"/> </launch:infData> </extension> <trID> <clTRID>BCD-23456</clTRID> <svTRID>65432-WXY</svTRID> </trID> </response> </epp>
A server MUST support at least one of the following models for validating trademark information:
More than one <launch:codeMark>, <smd:signedMark> [signedMark], or <smd:encodedSignedMark> [encodedSignedMark] element MAY be specified. The maximum number of marks per domain name is up to server policy.
The <launch:codeMark> element that is used by the "code", "mark", and "code with mark" validation models, has the following child elements:
The following is an example <launch:codeMark> element with both a <launch:code> and <mark:mark> [mark] element.
<launch:codeMark> <launch:code>49FD46E6C4B45C55D4AC</launch:code> <mark:mark xmlns:mark="urn:ietf:params:xml:ns:mark-1.0"> ... </mark:mark> </launch:codeMark>
A <mark:mark> element describes an applicant's prior right to a given domain name that is used with the "mark", "mark with code", and the "signed mark" validation models. The <mark:mark> element is defined in [draft-lozano-smd]. A new mark format can be supported by creating a new XML schema for the mark that has an element that substitutes for the <mark:abstractMark> element from [draft-lozano-smd].
Digital signatures MAY be used by the server to validate either the mark information, when using the "signed mark" validation model with the <smd:signedMark> [signedMark] element or the <smd:encodedSignedMark> [encodedSignedMark] element.
The <smd:signedMark> element contains the digitally signed mark information. The <smd:signedMark> element is defined in [draft-lozano-smd]. A new signed mark format can be supported by creating a new XML schema for the signed mark that has an element that substitutes for the <smd:abstractSignedMark> element from [draft-lozano-smd].
The <smd:encodedSignedMark> element contains an encoded form of the digitally signed <smd:signedMark> [signedMark] element. The <smd:encodedSignedMark> element is defined in [draft-lozano-smd]. A new encoded signed mark format can be supported by creating a new XML schema for the encoded signed mark that has an element that substitutes for the <smd:encodedSignedMark> element from [draft-lozano-smd].
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 use in the Launch Phase Extension.
This mapping is designed to be flexible, requiring only a minimum set of required elements.
While it is meant to serve several use cases, it does not prescribe any interpretation by the client or server. Such processing is typically highly policy-dependent and therefore specific to implementations.
Operations on application objects are done via one or more of the existing EPP verbs defined in the EPP domain name mapping [RFC5731]. Registries may choose to support a subset of the operations.
There are two forms of the extension to the EPP <check> command that include the Claims Check Form [claimsCheckForm] and the Availability Check Form [availCheckForm]. The <launch:check> element "type" attribute defines the form, with the value of "claims" for the Claims Check Form [claimsCheckForm] and with the value of "avail" for the Availability Check Form [availCheckForm]. The default value of the "type" attribute is "claims". The check forms supported is up to server policy. The server MUST return an EPP error result code of 2307 if it receives a check form that is not supported.
The Claims Check Form defines additional elements to extend the EPP <check> command and response to be used in conjunction with the EPP domain name mapping [RFC5731]. This form is the default form and MAY be explicitly identified by setting the <launch:check> "type" attribute to "claims".
The Claims Check Form defines a new command called the Claims Check Command that is used to determine whether or not there are any matching trademarks, in the specified launch phase, for each domain name passed in the command. The availability check information defined in the EPP domain name mapping [RFC5731] MUST NOT be returned for the Claims Check Command.
Instead of returning whether the domain name is available, the Claims Check Command will return whether or not at least one matching trademark exists for the domain name. If there is at least one matching trademark that exists for the domain name, a <launch:claimKey> element is returned. The client may then use the value of the <launch:claimKey> element to obtain information needed to generate the trademark Claims Notice from a third-party trademark validator such as the Trademark Clearinghouse (TMCH). The third party trademark validator should also return a unique notice identifier that can be passed in the <launch:noticeID> element of the extension to the Create Command [createCommand].
The <domain:name> elements in the EPP <check> command of EPP domain name mapping [RFC5731] define the domain names to check for matching trademarks. The <launch:check> element contains the following child elements:
Example Claims Check command using the <check> domain command and the <launch:check> extension with the "type" explicitly set to "claims", to determine if "example1.tld" and "example2.tld" have any matching trademarks during the "claims" launch phase:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <check> <domain:check xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>example1.tld</domain:name> <domain:name>example2.tld</domain:name> </domain:check> </check> <extension> <launch:check xmlns:launch="urn:ietf:params:xml:ns:launch-1.0" type="claims"> <launch:phase>claims</launch:phase> </launch:check> </extension> <clTRID>ABC-12345</clTRID> </command> </epp>
If the <check> command has been processed successfully, the EPP <resData> element MUST contain a child <launch:chkData> element that identifies the launch namespace. The <launch:chkData> element contains the following child elements:
Example Claims Check response when no matching trademarks are found for the domain name example1.tld and matching trademarks are found for the domain name example2.tld for the "claims" launch phase:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1000"> <msg>Command completed successfully</msg> </result> <resData> <launch:chkData xmlns:launch="urn:ietf:params:xml:ns:launch-1.0"> <launch:phase>claims</launch:phase> <launch:cd> <launch:name exists="0">example1.tld</launch:name> </launch:cd> <launch:cd> <launch:name exists="1">example2.tld</launch:name> <launch:claimKey>abc123</launch:claimKey> </launch:cd> </launch:chkData> </resData> <trID> <clTRID>ABC-12345</clTRID> <svTRID>54321-XYZ</svTRID> </trID> </response> </epp>
The Availability Check Form defines additional elements to extend the EPP <check> command described in the EPP domain name mapping [RFC5731]. No additional elements are defined for the EPP <check> response. This form MUST be identified by setting the <launch:check> "type" attribute to "avail".
The EPP <check> command is used to determine if an object can be provisioned within a repository. Domain names may be made available only in unique launch phases, whilst remaining unavailable for concurrent launch phases. In addition to the elements expressed in the <domain:check>, the command is extensed with the <launch:check> element that contains the following child elements:
Example Availability Check Form command using the <check> domain command and the <launch:check> extension with the "type" set to "avail", to determine the availability of two domain names in the "idn-release" custom launch phase:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <check> <domain:check xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>example1.tld</domain:name> <domain:name>example2.tld</domain:name> </domain:check> </check> <extension> <launch:check xmlns:launch="urn:ietf:params:xml:ns:launch-1.0" type="avail"> <launch:phase name="idn-release">custom</launch:phase> </launch:check> </extension> <clTRID>ABC-12345</clTRID> </command> </epp>
The Availability Check Form does not define any extension to the response of an <check> domain command. After processing the command, the server replies with a standard EPP response as defined in the EPP domain name mapping [RFC5731].
This extension defines additional elements to extend the EPP <info> command and response to be used in conjunction with the EPP domain name mapping [RFC5731].
The EPP <info> command is used to retrieve information for a launch phase registration or application. The Application Identifier [applicationID] returned in the <launch:creData> element of the create response [createCommand] is used for retrieving information for a Launch Application. A <launch:info> element is sent along with the regular <info> domain command. The <launch:info> element includes an OPTIONAL "includeMark" boolean attribute, with a default value of "false", to indicate whether or not to include the mark in the response. The <launch:info> element contains the following child elements:
Example <info> domain command with the <launch:info> extension to retrieve information for the sunrise application for example.tld and application identifier "abc123":
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <info> <domain:info xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>example.tld</domain:name> </domain:info> </info> <extension> <launch:info xmlns:launch="urn:ietf:params:xml:ns:launch-1.0" includeMark="true"> <launch:phase>sunrise</launch:phase> <launch:applicationID>abc123</launch:applicationID> </launch:info> </extension> <clTRID>ABC-12345</clTRID> </command> </epp>
Example <info> domain command with the <launch:info> extension to retrieve information for the sunrise registration for example.tld:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <info> <domain:info xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>example.tld</domain:name> </domain:info> </info> <extension> <launch:info xmlns:launch="urn:ietf:params:xml:ns:launch-1.0"> <launch:phase>sunrise</launch:phase> </launch:info> </extension> <clTRID>ABC-12345</clTRID> </command> </epp>
If the query was successful, the server replies with a <launch:infData> element along with the regular EPP <resData>. The <launch:infData> contains the following child elements:
Example <info> domain response using the <launch:infData> extension with the mark information:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1000"> <msg>Command completed successfully</msg> </result> <resData> <domain:infData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>example.tld</domain:name> <domain:roid>EXAMPLE1-REP</domain:roid> <domain:status s="pendingCreate"/> <domain:registrant>jd1234</domain:registrant> <domain:contact type="admin">sh8013</domain:contact> <domain:contact type="tech">sh8013</domain:contact> <domain:clID>ClientX</domain:clID> <domain:crID>ClientY</domain:crID> <domain:crDate>2012-04-03T22:00:00.0Z</domain:crDate> <domain:authInfo> <domain:pw>2fooBAR</domain:pw> </domain:authInfo> </domain:infData> </resData> <extension> <launch:infData xmlns:launch="urn:ietf:params:xml:ns:launch-1.0"> <launch:phase>sunrise</launch:phase> <launch:applicationID>abc123</launch:applicationID> <launch:status s="pendingValidation"/> <mark:mark xmlns:mark="urn:ietf:params:xml:ns:mark-1.0"> ... </mark:mark> </launch:infData> </extension> <trID> <clTRID>ABC-12345</clTRID> <svTRID>54321-XYZ</svTRID> </trID> </response> </epp>
There are three forms of the extension to the EPP <create> command that include the Sunrise Create Form [sunriseCreateForm], the Claims Create Form [claimsCreateForm], and the General Create Form [generalCreateForm]. The form is dependent on the supported launch phases [phases] as defined below.
A server MAY support a mix of the create forms, where for example the Sunrise Create Form [sunriseCreateForm] and the Claims Create Form [claimsCreateForm] MAY be supported in a single command by including both the verified trademark information and the information related to the registrant's acceptance of the Claims Notice. The "custom" launch phase SHOULD be used when using a mix of the create forms.
The following is an example <create> domain command using the <launch:create> extension, with using a mix of the Sunrise Create Form [sunriseCreateForm] and the Claims Create Form [claimsCreateForm] by including both a mark and a notice:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <create> <domain:create xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>exampleone.tld</domain:name> <domain:registrant>jd1234</domain:registrant> <domain:contact type="admin">sh8013</domain:contact> <domain:contact type="tech">sh8013</domain:contact> <domain:authInfo> <domain:pw>2fooBAR</domain:pw> </domain:authInfo> </domain:create> </create> <extension> <launch:create xmlns:launch="urn:ietf:params:xml:ns:launch-1.0" type="application"> <launch:phase name="non-tmch-sunrise">custom</launch:phase> <launch:codeMark> <mark:mark xmlns:mark="urn:ietf:params:xml:ns:mark-1.0"> ... </mark:mark> </launch:codeMark> <launch:notice> <launch:noticeID>49FD46E6C4B45C55D4AC</launch:noticeID> <launch:notAfter>2012-06-19T10:00:10.0Z </launch:notAfter> <launch:acceptedDate>2012-06-19T09:01:30.0Z </launch:acceptedDate> </launch:notice> </launch:create> </extension> <clTRID>ABC-12345</clTRID> </command> </epp>
The Sunrise Create Form of the extension to the EPP domain name mapping [RFC5731] includes the verifiable trademark information that the server uses to match against the domain name to authorize the domain create. A server MUST support one of four models in Claim Validation Models [validationModels] to verify the trademark information passed by the client.
A <launch:create> element is sent along with the regular <create> domain command. The <launch:create> element has an OPTIONAL "type" attribute that defines the expected type of object ("application" or "registration") to create. The server SHOULD validate the "type" attribute, when passed, against the type of object that will be created. The <launch:create> element contains the following child elements:
The following is an example <create> domain command using the <launch:create> extension, following the "code" validation model, with multiple sunrise codes:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <create> <domain:create xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>example.tld</domain:name> <domain:registrant>jd1234</domain:registrant> <domain:contact type="admin">sh8013</domain:contact> <domain:contact type="tech">sh8013</domain:contact> <domain:authInfo> <domain:pw>2fooBAR</domain:pw> </domain:authInfo> </domain:create> </create> <extension> <launch:create xmlns:launch="urn:ietf:params:xml:ns:launch-1.0"> <launch:phase>sunrise</launch:phase> <launch:codeMark> <launch:code>49FD46E6C4B45C55D4AC</launch:code> </launch:codeMark> <launch:codeMark> <launch:code>49FD46E6C4B45C55D4AD</launch:code> </launch:codeMark> <launch:codeMark> <launch:code>49FD46E6C4B45C55D4AE</launch:code> </launch:codeMark> </launch:create> </extension> <clTRID>ABC-12345</clTRID> </command> </epp>
The following is an example <create> domain command using the <launch:create> extension, following the "mark" validation model, with the mark information:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <create> <domain:create xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>exampleone.tld</domain:name> <domain:registrant>jd1234</domain:registrant> <domain:contact type="admin">sh8013</domain:contact> <domain:contact type="tech">sh8013</domain:contact> <domain:authInfo> <domain:pw>2fooBAR</domain:pw> </domain:authInfo> </domain:create> </create> <extension> <launch:create xmlns:launch="urn:ietf:params:xml:ns:launch-1.0"> <launch:phase>sunrise</launch:phase> <launch:codeMark> <mark:mark xmlns:mark="urn:ietf:params:xml:ns:mark-1.0"> ... </mark:mark> </launch:codeMark> </launch:create> </extension> <clTRID>ABC-12345</clTRID> </command> </epp>
The following is an example <create> domain command using the <launch:create> extension, following the "code with mark" validation model, with a code and mark information:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <create> <domain:create xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>example.tld</domain:name> <domain:registrant>jd1234</domain:registrant> <domain:contact type="admin">sh8013</domain:contact> <domain:contact type="tech">sh8013</domain:contact> <domain:authInfo> <domain:pw>2fooBAR</domain:pw> </domain:authInfo> </domain:create> </create> <extension> <launch:create xmlns:launch="urn:ietf:params:xml:ns:launch-1.0"> <launch:phase>sunrise</launch:phase> <launch:codeMark> <launch:code>49FD46E6C4B45C55D4AC</launch:code> <mark:mark xmlns:mark="urn:ietf:params:xml:ns:mark-1.0"> ... </mark:mark> </launch:codeMark> </launch:create> </extension> <clTRID>ABC-12345</clTRID> </command> </epp>
The following is an example <create> domain command using the <launch:create> extension, following the "signed mark" validation model, with the signed mark information for a sunrise application:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <create> <domain:create xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>exampleone.tld</domain:name> <domain:registrant>jd1234</domain:registrant> <domain:contact type="admin">sh8013</domain:contact> <domain:contact type="tech">sh8013</domain:contact> <domain:authInfo> <domain:pw>2fooBAR</domain:pw> </domain:authInfo> </domain:create> </create> <extension> <launch:create xmlns:launch="urn:ietf:params:xml:ns:launch-1.0" type="application"> <launch:phase>sunrise</launch:phase> <smd:signedMark id="signedMark" xmlns:smd="urn:ietf:params:xml:ns:signedMark-1.0"> ... </smd:signedMark> </launch:create> </extension> <clTRID>ABC-12345</clTRID> </command> </epp>
The following is an example <create> domain command using the <launch:create> extension, following the "signed mark" validation model, with the base64 encoded signed mark information:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <create> <domain:create xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>exampleone.tld</domain:name> <domain:registrant>jd1234</domain:registrant> <domain:contact type="admin">sh8013</domain:contact> <domain:contact type="tech">sh8013</domain:contact> <domain:authInfo> <domain:pw>2fooBAR</domain:pw> </domain:authInfo> </domain:create> </create> <extension> <launch:create xmlns:launch="urn:ietf:params:xml:ns:launch-1.0"> <launch:phase>sunrise</launch:phase> <smd:encodedSignedMark xmlns:smd="urn:ietf:params:xml:ns:signedMark-1.0"> ... </smd:encodedSignedMark> </launch:create> </extension> <clTRID>ABC-12345</clTRID> </command> </epp>
The Claims Create Form of the extension to the EPP domain name mapping [RFC5731] includes the information related to the registrant's acceptance of the Claims Notice for the "claims" launch phase.
A <launch:create> element is sent along with the regular <create> domain command. The <launch:create> element has an OPTIONAL "type" attribute that defines the expected type of object ("application" or "registration") to create. The server SHOULD validate the "type" attribute, when passed, against the type of object that will be created. The <launch:create> element contains the following child elements:
The following is an example <create> domain command using the <launch:create> extension with the <launch:notice> information for the "claims" launch phase:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <create> <domain:create xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>example.tld</domain:name> <domain:registrant>jd1234</domain:registrant> <domain:contact type="admin">sh8013</domain:contact> <domain:contact type="tech">sh8013</domain:contact> <domain:authInfo> <domain:pw>2fooBAR</domain:pw> </domain:authInfo> </domain:create> </create> <extension> <launch:create xmlns:launch="urn:ietf:params:xml:ns:launch-1.0"> <launch:phase>claims</launch:phase> <launch:notice> <launch:noticeID>49FD46E6C4B45C55D4AC</launch:noticeID> <launch:notAfter>2012-06-19T10:00:10.0Z </launch:notAfter> <launch:acceptedDate>2012-06-19T09:01:30.0Z </launch:acceptedDate> </launch:notice> </launch:create> </extension> <clTRID>ABC-12345</clTRID> </command> </epp>
The General Create Form of the extension to the EPP domain name mapping [RFC5731] includes the launch phase and optionally the object type to create. The OPTIONAL "type" attribute defines the expected type of object ("application" or "registration") to create. The server SHOULD validate the "type" attribute, when passed, against the type of object that will be created.
A <launch:create> element is sent along with the regular <create> domain command. The <launch:create> element contains the following child elements:
The following is an example <create> domain command using the <launch:create> extension for a "landrush" launch phase application:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <create> <domain:create xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>example.tld</domain:name> <domain:registrant>jd1234</domain:registrant> <domain:contact type="admin">sh8013</domain:contact> <domain:contact type="tech">sh8013</domain:contact> <domain:authInfo> <domain:pw>2fooBAR</domain:pw> </domain:authInfo> </domain:create> </create> <extension> <launch:create xmlns:launch="urn:ietf:params:xml:ns:launch-1.0" type="application"> <launch:phase>landrush</launch:phase> </launch:create> </extension> <clTRID>ABC-12345</clTRID> </command> </epp>
If the create was successful, the server MAY reply with the <launch:creData> element along with the regular EPP <resData> to indicate the server generated Application Identifier [applicationID], when multiple applications of a given domain name is supported; otherwise no extension is included with the regular EPP <resData>. The <launch:creData> element contains the following child elements:
An example response when multiple overlapping applications are supported by the server:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1001"> <msg>Command completed successfully; action pending</msg> </result> <resData> <domain:creData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>example.tld</domain:name> <domain:crDate>2010-08-10T15:38:26.623854Z</domain:crDate> <domain:exDate>2012-08-10T15:38:26.623854Z</domain:exDate> </domain:creData> </resData> <extension> <launch:creData xmlns:launch="urn:ietf:params:xml:ns:launch-1.0"> <launch:phase>sunrise</launch:phase> <launch:applicationID>2393-9323-E08C-03B1 </launch:applicationID> </launch:creData> </extension> <trID> <clTRID>ABC-12345</clTRID> <svTRID>54321-XYZ</svTRID> </trID> </response> </epp>
This extension defines additional elements to extend the EPP <update> command to be used in conjunction with the domain name mapping.
A server that does not support multiple applications of a given domain name with an Application Identifier [applicationID] during its launch phase operations MUST return an EPP error result code of 2102.
Registry policies permitting, clients may update an application object by submitting an EPP <update> command along with a <launch:update> element to indicate the application object to be updated. The <launch:update> element contains the following child elements:
The following is an example <update> domain command with the <launch:update> extension to add and remove a name server of a sunrise application with the application identifier "abc123":
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <update> <domain:update xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>example.tld</domain:name> <domain:add> <domain:ns> <domain:hostObj>ns2.example.tld</domain:hostObj> </domain:ns> </domain:add> <domain:rem> <domain:ns> <domain:hostObj>ns1.example.tld</domain:hostObj> </domain:ns> </domain:rem> </domain:update> </update> <extension> <launch:update xmlns:launch="urn:ietf:params:xml:ns:launch-1.0"> <launch:phase>sunrise</launch:phase> <launch:applicationID>abc123</launch:applicationID> </launch:update> </extension> <clTRID>ABC-12345</clTRID> </command> </epp>
This extension does not define any extension to the response of an <update> domain command. After processing the command, the server replies with a standard EPP response as defined in the EPP domain name mapping [RFC5731].
This extension defines additional elements to extend the EPP <delete> command to be used in conjunction with the domain name mapping.
A server that does not support multiple applications of a given domain name with an Application Identifier [applicationID] during its launch phase operations MUST return an EPP error result code of 2102.
Registry policies permitting, clients MAY withdraw an application by submitting an EPP <delete> command along with a <launch:delete> element to indicate the application object to be deleted. The <launch:delete> element contains the following child elements:
The following is an example <delete> domain command with the <launch:delete> extension:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <delete> <domain:delete xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <domain:name>example.tld</domain:name> </domain:delete> </delete> <extension> <launch:delete xmlns:launch="urn:ietf:params:xml:ns:launch-1.0"> <launch:phase>sunrise</launch:phase> <launch:applicationID>abc123</launch:applicationID> </launch:delete> </extension> <clTRID>ABC-12345</clTRID> </command> </epp>
This extension does not define any extension to the response of a <delete> domain command. After processing the command, the server replies with a standard EPP response as defined in the EPP domain name mapping [RFC5731].
This extension does not define any extension to the EPP <renew> command or response described in the EPP domain name mapping [RFC5731].
This extension does not define any extension to the EPP <transfer> command or response described in the EPP domain name mapping [RFC5731].
One schema is presented here that is the EPP Launch Phase Mapping 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 ending of the schema for URI registration purposes.
Copyright (c) 2012 IETF Trust and the persons identified as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
BEGIN <?xml version="1.0" encoding="UTF-8"?> <schema targetNamespace="urn:ietf:params:xml:ns:launch-1.0" xmlns:launch="urn:ietf:params:xml:ns:launch-1.0" xmlns:eppcom="urn:ietf:params:xml:ns:eppcom-1.0" xmlns:mark="urn:ietf:params:xml:ns:mark-1.0" xmlns:smd="urn:ietf:params:xml:ns:signedMark-1.0" xmlns="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"> <!-- Import common element types. --> <import namespace="urn:ietf:params:xml:ns:eppcom-1.0" schemaLocation="eppcom-1.0.xsd"/> <import namespace="urn:ietf:params:xml:ns:mark-1.0" schemaLocation="mark-1.0.xsd"/> <import namespace="urn:ietf:params:xml:ns:signedMark-1.0" schemaLocation="signedMark-1.0.xsd"/> <annotation> <documentation> Extensible Provisioning Protocol v1.0 domain name extension schema for the launch phase processing. </documentation> </annotation> <!-- Child elements found in EPP commands. --> <element name="check" type="launch:checkType"/> <element name="info" type="launch:infoType"/> <element name="create" type="launch:createType"/> <element name="update" type="launch:idContainerType"/> <element name="delete" type="launch:idContainerType"/> <!-- Common container of id (identifier) element --> <complexType name="idContainerType"> <sequence> <element name="phase" type="launch:phaseType"/> <element name="applicationID" type="launch:applicationIDType"/> </sequence> </complexType> <!-- Definition for application identifier --> <simpleType name="applicationIDType"> <restriction base="token"/> </simpleType> <!-- Definition for launch phase. Name is an optional attribute used to extend the phase type. For example, when using the phase type value of &qt;custom>, the name can be used to specify the custom phase. --> <complexType name="phaseType"> <simpleContent> <extension base="launch:phaseTypeValue"> <attribute name="name" type="token"/> </extension> </simpleContent> </complexType> <!-- Enumeration of for launch phase values. --> <simpleType name="phaseTypeValue"> <restriction base="token"> <enumeration value="sunrise"/> <enumeration value="landrush"/> <enumeration value="claims"/> <enumeration value="open"/> <enumeration value="custom"/> </restriction> </simpleType> <!-- Definition for the sunrise code --> <simpleType name="codeType"> <restriction base="base64Binary"> <minLength value="1"/> </restriction> </simpleType> <!-- Definition for the notice identifier --> <simpleType name="noticeIDType"> <restriction base="base64Binary"> <minLength value="1"/> </restriction> </simpleType> <!-- Possible status values for sunrise application --> <simpleType name="statusValueType"> <restriction base="token"> <enumeration value="pendingValidation"/> <enumeration value="validated"/> <enumeration value="invalid"/> <enumeration value="pendingAllocation"/> <enumeration value="allocated"/> <enumeration value="rejected"/> <enumeration value="custom"/> </restriction> </simpleType> <!-- Status type definition --> <complexType name="statusType"> <simpleContent> <extension base="normalizedString"> <attribute name="s" type="launch:statusValueType" use="required"/> <attribute name="lang" type="language" default="en"/> <attribute name="name" type="token"/> </extension> </simpleContent> </complexType> <!-- codeMark Type that contains an optional code with mark information. --> <complexType name="codeMarkType"> <sequence> <element name="code" type="launch:codeType" minOccurs="0"/> <element ref="mark:abstractMark" minOccurs="0"/> </sequence> </complexType> <!-- Child elements for the create command --> <complexType name="createType"> <sequence> <element name="phase" type="launch:phaseType"/> <choice minOccurs="0"> <element name="codeMark" type="launch:codeMarkType" maxOccurs="unbounded"/> <element ref="smd:abstractSignedMark" maxOccurs="unbounded"/> <element ref="smd:encodedSignedMark" maxOccurs="unbounded"/> </choice> <element name="notice" minOccurs="0" type="launch:createNoticeType"/> </sequence> <attribute name="type" type="launch:objectType"/> </complexType> <!-- Type of launch object --> <simpleType name="objectType"> <restriction base="token"> <enumeration value="application"/> <enumeration value="registration"/> </restriction> </simpleType> <!-- Child elements of the create notice element. --> <complexType name="createNoticeType"> <sequence> <element name="noticeID" type="launch:noticeIDType"/> <element name="notAfter" type="dateTime"/> <element name="acceptedDate" type="dateTime"/> </sequence> </complexType> <!-- Child elements of check (Claims Check Command). --> <complexType name="checkType"> <sequence> <element name="phase" type="launch:phaseType"/> </sequence> <attribute name="type" type="launch:checkFormType" default="claims"/> </complexType> <!-- Type of check form (claims check or availability check) --> <simpleType name="checkFormType"> <restriction base="token"> <enumeration value="claims"/> <enumeration value="avail"/> </restriction> </simpleType> <!-- Child elements of info command. --> <complexType name="infoType"> <sequence> <element name="phase" type="launch:phaseType"/> <element name="applicationID" type="launch:applicationIDType" minOccurs="0"/> </sequence> <attribute name="includeMark" type="boolean" default="false"/> </complexType> <!-- Child response elements. --> <element name="chkData" type="launch:chkDataType"/> <element name="creData" type="launch:idContainerType"/> <element name="infData" type="launch:infDataType"/> <!-- <check> response elements. --> <complexType name="chkDataType"> <sequence> <element name="phase" type="launch:phaseType"/> <element name="cd" type="launch:cdType" maxOccurs="unbounded"/> </sequence> </complexType> <complexType name="cdType"> <sequence> <element name="name" type="launch:cdNameType"/> <element name="claimKey" type="token" minOccurs="0"/> </sequence> </complexType> <complexType name="cdNameType"> <simpleContent> <extension base="eppcom:labelType"> <attribute name="exists" type="boolean" use="required"/> </extension> </simpleContent> </complexType> <!-- <info> response elemenets --> <complexType name="infDataType"> <sequence> <element name="phase" type="launch:phaseType"/> <element name="applicationID" type="launch:applicationIDType" minOccurs="0"/> <element name="status" type="launch:statusType" minOccurs="0"/> <element ref="mark:abstractMark" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </schema> END
The authors wish to acknowledge the efforts of the leading participants of the Community TMCH Model that led to many of the changes to this document, which include Chris Wright, Jeff Neuman, Jeff Eckhaus, and Will Shorter.
Special suggestions that have been incorporated into this document were provided by Jothan Frakes, Keith Gaughan, Seth Goldman, Jan Jansen, Rubens Kuhl, Ben Levac, Gustavo Lozano, Klaus Malorny, Patrick Mevzek, James Mitchell, Bernhard Reutner-Fischer, Trung Tran, Ulrich Wisser and Sharon Wodjenski.
This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism described in [RFC3688]. Three URI assignments have been registered by the IANA.
Registration request for the Launch namespace:
The mapping extensions described in this document do not provide any security services beyond those described by EPP [RFC5730], the EPP domain name mapping [RFC5731], and protocol layers used by EPP. The security considerations described in these other specifications apply to this specification as well.
Updates to, and deletion of an application object must be restricted to clients authorized to perform the said operation on the object.
As information contained within an application, or even the mere fact that an application exists may be confidential. Any attempt to operate on an application object by an unauthorized client MUST be rejected with an EPP 2303 (object does not exist) or an appropriate auhorization error. Server policy may allow <info> operation with filtered output by clients other than the sponsoring client, in which case the <domain:infData> and <launch:infData> response SHOULD be filtered to include only fields that are publicly accessible.
[draft-lozano-smd] | Lozano, G.L., "Mark and Signed Mark Objects Mapping", |
[RFC2119] | Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. |
[RFC5730] | Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", STD 69, RFC 5730, August 2009. |
[RFC5731] | Hollenbeck, S., "Extensible Provisioning Protocol (EPP) Domain Name Mapping", STD 69, RFC 5731, August 2009. |
[RFC3688] | Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, January 2004. |