]> Extensible Provisioning Protocol (EPP) Internationalized Domain Name (IDN) Table Mapping VeriSign, Inc.
12061 Bluemont Way Reston VA 20190 US jgould@verisign.com http://www.verisigninc.com
Uniregistry Corp.
3-110 Governors Square Grand Cayman, Grand Cayman KY1-1108 KY fobispo@uniregistry.com http://www.uniregistry.com/
Uniregistry Corp.
3-110 Governors Square Grand Cayman, Grand Cayman KY1-1108 KY fobispo@uniregistry.com http://www.uniregistry.com/
This document describes an Extensible Provisioning Protocol (EPP) mapping for getting Internationalized Domain Name (IDN) Table information for the registration of IDNs, using the EPP domain name mapping, and optionally with the IDN mapping extension. An IDN Table defines the valid set of characters (code points) that can be used in a domain name. Code points may overlap across IDN Tables and the IDN Tables supported by the servers are up to server policy. The IDN Table information can be used to validate an IDN prior to registration, can be cached by the client for pre-validation, can be used to select the best IDN Table for the IDN, and can be used to know if and what IDN Table Identifier to pass in a domain create.
This document describes an extension mapping for version 1.0 of the Extensible Provisioning Protocol (EPP). This EPP mapping provides Internationalized Domain Name (IDN) Table information for the registration of IDNs, using the EPP domain name mapping, and optionally with the IDN mapping extension. An IDN Table defines the valid set of characters (code points) that can be used in a domain name. Code points may overlap across IDN Tables and the IDN Tables supported by the servers are up to server policy. This mapping provides the information clients need to register IDNs across a variety of servers with differing IDN policies. The IDN Table Mapping can be used for the following: Validate that an IDN meets the server IDN policy. The validation can be done prior to submitting a domain create, per . Since IDN Table code points may overlap, the mapping can be used to identify the matching set of IDN Tables (language or script), along with the IDN Table meta-data. Clients can query for the complete list of IDN Tables and can get the IDN Table meta-data, based on server policy, to support pre-validation in the client. Each IDN Table includes a server unique IDN Table Identifier that may be used as the value of the <idn:table> element in the IDN mapping extension. A flag indicates whether the IDN mapping extension is needed for the domain name.
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. 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. 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. "idnTable-1.0" is used as an abbreviation for "urn:ietf:params:xml:ns:idnTable-1.0". The XML namespace prefix "idnTable" 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.
An EPP IDN Table object has attributes and associated values that can help in the registration of IDNs. This section describes each type in detail. The formal syntax for the attribute values described here can be found in the "Formal Syntax" section of this document and in the appropriate normative references.
The IDN Table Identifier is a server-defined unique value for an IDN Table object. It is represented using an <idnTable:table> element or an <idnTable:name> element. The IDN Table Identifier is used in the <check> and <info> commands and responses. The IDN Table Identifier MAY also be used as the value for the IDN mapping extension <idn:table> element with a domain create of an IDN object.
A Domain Name, as represented by an <idnTable:domain> element, is used to enable validating the code points against the server IDN Tables and IDN policies and for retrieving IDN Table information associated with the domain name. The Domain Name MUST be represented as either a U-label or A-label as defined in . An OPTIONAL attribute "form" MAY be used to specify the representation. When present, the "form" attribute MUST be set to either "aLabel" for A-label or "uLabel" for U-label, depending on the chosen representation for the domain name. The default "form" attribute is "aLabel" for A-label.
A detailed description of the EPP syntax and semantics can be found in the EPP core protocol specification .
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.
There are two forms of the EPP <check> command: the Domain Check Form and the Table Check Form.
The Domain Check Form is used to check the validity of the domain name against the server IDN Tables and IDN policies, return whether the IDN mapping extension is needed with a domain <create> command, and provide the matching list of IDN Table Identifiers. This mapping is not intended to determine the availability of the domain name. In addition to the standard EPP command elements, the <check> command MUST contain an <idnTable:check> element that identifies the idnTable namespace. The <idnTable:check> element in the Domain Check Form contains the following child elements: One or more <idnTable:domain> elements that contain the fully qualified names of the domain objects, as defined in , to validate.
Example Domain Check Form <check> command with three IDNs: C: C: C: C: C: idn1.example C: idn2.example C: idn3.example C: C: C: ABC-12345 C: C:]]>
When a <check> command has been processed successfully, the EPP <resData> element MUST contain a child <idnTable:chkData> element that identifies the idnTable namespace. The <idnTable:chkData> element in the Domain Check Form contain one or more <idnTable:domain> elements that contain the following child elements: The fully qualified name of the domain object, as defined in . The element MUST contain a "valid" attribute whose value indicates whether the domain name is valid according to the server IDN Tables and IDN policies. A value of "1" or "true" means that the domain name is valid according to the server IDN Tables and policies. A value of "0" or "false" means that the domain name is not valid according to the server IDN Tables and policies. The element MAY contain an "idnmap" attribute value that indicates whether the server requires the use of the IDN mapping extension with a domain create of the domain name. A value of "1" or "true" means that the IDN mapping extension is required using one of the <idnTable:table> values. A value of "0" or "false" means that the IDN mapping extension is not required. OPTIONAL reason that the domain name is not valid. If present, this element contains server-specific text to help explain why the domain name is not valid. This text MUST be represented in the response language previously negotiated with the client; an OPTIONAL "lang" attribute MAY be present to identify the language if the negotiated value is something other than the default value of "en" (English). Zero or more OPTIONAL <idnTable:table> elements that contain the server defined IDN Table Identifier, as defined in , that matches the code points of the <idnTable:name> element. The <idnTable:table> MAY be used as the value of the <idn:table> element in the IDN mapping extension for creating the IDN object or MAY be used as the value of the <idnTable:table> element of the Table Info Form <info> command, as described in , to retrieve more information about the IDN Table.
Example Domain Check Form <check> response with three IDNs: S: S: S: S: Command completed successfully S: S: S: S: S: S: idn1.example S: CHI S: S: S: S: idn2.example S: CHI S: JPN S: S: S: S: idn3.example S: Commingled scripts S: S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S:]]>
The Table Check Form is used to check the existence of an IDN Table using the IDN Table Identifier represented by the <idnTable:table> element. In addition to the standard EPP command elements, the <check> command MUST contain an <idnTable:check> element that identifies the idnTable namespace. The <idnTable:check> element in the Table Check Form contains the following child elements: One or more <idnTable:table> elements that contain the IDN Table Identifier, as defined in , to check for existence.
Example Table Check Form <check> command with three IDN Table Identifiers: C: C: C: C: C: CHI C: JPN C: INVALID C: C: C: ABC-12345 C: C:]]>
When a <check> command has been processed successfully, the EPP <resData> element MUST contain a child <idnTable:chkData> element that identifies the idnTable namespace. The <idnTable:chkData> element in the Table Check Form contains the following child elements: One or more <idnTable:table> elements that contain the IDN Table Identifier, as defined in . The element MUST contain an "exists" attribute whose value indicates the existence of the IDN Table Identifier. A value of "1" or "true" means that the IDN Table Identifier exists. A value of "0" or "false" means that the IDN Table Identifier does not exist.
Example Table Check Form <check> response with three IDN Table Identifiers: S: S: S: S: Command completed successfully S: S: S: S: CHI S: S: JPN S: S: INVALID S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S:]]>
There are three forms of the EPP <info> command: the Domain Info Form, the Table Info Form, and the List Info Form.
The Domain Info Form is used to validate the domain name code points against the IDN Tables and IDN policies, and to return the matching IDN Table meta-data. The domain name, as defined in can be provided as either a U-label or A-label. In addition to the standard EPP command elements, the <info> command MUST contain an <idnTable:info> element that identifies the idnTable namespace. The <idnTable:info> element in the Domain Info Form contains the following child elements: The domain name, as defined in , to validate against the IDN Tables and IDN policies, and to retrieve the matching IDN Table meta-data.
Example Domain Info Form <info> command using a U-label Domain Name: C: C: C: C: C: idn1.example C: C: C: ABC-12345 C: C:]]>
Example Domain Info Form <info> command using an A-label Domain Name: C: C: C: C: C: xn--idn1.example C: C: C: ABC-12345 C: C:]]>
When an <info> command has been processed successfully, the EPP <resData> element MUST contain a child <idnTable:infData> element that identifies the idnTable namespace. The <idnTable:infData> element in the Domain Info Form contains the <idnTable:domain> element that contains the following child elements: The fully qualified name of the domain object, as defined in . The element MUST contain a "valid" attribute whose value indicates whether the domain name is valid according to the server IDN Tables and IDN policies. A value of "1" or "true" means that the domain name is valid according to the server IDN Tables and policies. A value of "0" or "false" means that the domain name is not valid according to the server IDN Tables and policies. The element MAY contain an "idnmap" attribute value that indicates whether the server requires the use of the IDN mapping extension with a domain create of the domain name. A value of "1" or "true" means that the IDN mapping extension is required using one of the <idnTable:table> <idnTable:name> values. A value of "0" or "false" means that the IDN mapping extension is not required. OPTIONAL U-label or A-label form of the domain name value of the <idnTable:name> element in the opposite form, as defined in . Zero or more OPTIONAL <idnTable:table> elements that provide the IDN Table meta-data information. The <idnTable:table> element contains the following child elements: Server defined IDN Table Identifier, as defined in . The type of the IDN Table with the possible values of "language", to reflect a Language IDN Table, and "script", to reflect a Script IDN Table. Server defined description of the IDN Table. This text MUST be represented in the response language previously negotiated with the client; an OPTIONAL "lang" attribute MAY be present to identify the language if the negotiated value is something other than the default value of "en" (English). OPTIONAL boolean flag indicating that domains created using the IDN Table will have IDN variants generated. The management of variants is up to server policy.
Example Domain Info Form <info> response for a U-label Domain Name: S: S: S: S: Command completed successfully S: S: S: S: S: idn1.example S: S: xn--idn1.example S: S: THAI S: script S: Thai S: S: false S: S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S:]]>
Example Domain Info Form <info> response for an A-label Domain Name: S: S: S: S: Command completed successfully S: S: S: S: S: S: xn--idn1.example S: S: idn1.example S: S: CHI S: language S: Chinese (CHI) S: S: true S: S: S: JPN S: language S: Japanese (JPN) S: S: false S: S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S:]]>
The Table Info Form is used to retrieve information associated with an IDN Table object. The information provided meta-data about the IDN Table object. In addition to the standard EPP command elements, the <info> command MUST contain an <idnTable:info> element that identifies the idnTable namespace. The <idnTable:info> element in the Table Info Form contains the following child elements: Contains the IDN Table Identifier, as defined in , of the IDN Table object to be queried.
Example Table Info Form <info> command for the "CHI" IDN Table Identifier, which represents a Language IDN Table: C: C: C: C: C: CHI C: C: C: ABC-12345 C: C:]]>
Example Table Info Form <info> command for the "THAI" IDN Table Identifier, which represents a Script IDN Table: C: C: C: C: C: THAI C: C: C: ABC-12345 C: C:]]>
When an <info> command has been processed successfully, the EPP <resData> element MUST contain a child <idnTable:infData> element that identifies the idnTable namespace. The <idnTable:infData> element in the Table Info Form contains the <idnTable:table> element that contains the following child elements: Server defined IDN Table Identifier, as defined in . The type of the IDN Table with the possible values of "language", to reflect a Language IDN Table, and "script", to reflect a Script IDN Table. Server defined description of the IDN Table. This text MUST be represented in the response language previously negotiated with the client; an OPTIONAL "lang" attribute MAY be present to identify the language if the negotiated value is something other than the default value of "en" (English). Contains the date and time that the IDN Table was created or last updated. OPTIONAL server defined version number of the IDN Table. OPTIONAL effective date for the IDN Table. OPTIONAL boolean flag indicating that domains created using the IDN Table will have IDN variants generated. The management of variants is up to server policy. OPTIONAL URL for downloading the IDN Table with the applicable set of code points and rules.
Example Table Info Form <info> response for the "CHI" IDN Table Identifier, which represents a Language IDN Table: S: S: S: S: Command completed successfully S: S: S: S: S: CHI S: language S: Chinese (CHI) S: S: 2015-02-04T09:30:00.0Z S: S: 1.0 S: 2014-11-24 S: S: true S: S: https://www.iana.org/domains/idn-tables/tables/tld_chi_1.0.txt S: S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S:]]>
Example Table Info Form <info> response for the "THAI" IDN Table Identifier, which represents a Script IDN Table: S: S: S: S: Command completed successfully S: S: S: S: S: THAI S: script S: Thai S: 2014-08-16T09:20:00.0Z S: S: 1.0 S: 2014-11-24 S: S: false S: S: https://www.iana.org/domains/idn-tables/tables/tld_thai_1.0.txt S: S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S:]]>
The List Info Form is used to retrieve the list of IDN Tables supported by the server. The list of IDN Table Identifiers MAY be used to query for the IDN Table information using the Table Info Form. In addition to the standard EPP command elements, the <info> command MUST contain an <idnTable:info> element that identifies the idnTable namespace. The <idnTable:info> element in the List Info Form contains the following child elements: Empty element used as a marker to the server of the List Info Form to retrieve the list of IDN Tables.
Example List Info Form <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 <idnTable:infData> element that identifies the idnTable namespace. The <idnTable:infData> element in the List Info Form contains the <idnTable:list> element that contains the following child elements: Zero or more <idnTable:table> elements that contain the following child elements: Server defined IDN Table Identifier, as defined in , that is supported by the server. The <idnTable:table> element value MAY be used as the value of the <idnTable:table> element value in the Table Info Form <info> command to retrieve the information on the IDN Table. Contains the date and time that the IDN Table was created or last updated. This element can be used to determine whether a client-side cache needs to be refreshed for the IDN Table using the Table Info Form.
Example List Info Form <info> response that contains three IDN Table Identifiers: S: S: S: S: Command completed successfully S: S: S: S: S: S: CHI S: 2015-02-04T09:30:00.0Z S: S: S: S: JPN S: 2015-01-01T09:40:00.0Z S: S: S: S: THAI S: 2014-08-16T09:20:00.0Z S: S: S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S:]]>
Transfer semantics do not apply to IDN table objects, so there is no mapping defined for the EPP <transfer> command.
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.
Create semantics do not apply to IDN table objects, so there is no mapping defined for the EPP <create> command.
Delete semantics do not apply to IDN table objects, so there is no mapping defined for the EPP <delete> command.
Renewal semantics do not apply to IDN table objects, so there is no mapping defined for the EPP <renew> command.
Transfer semantics do not apply to IDN table objects, so there is no mapping defined for the EPP <transfer> command.
Update semantics do not apply to IDN table objects, so there is no mapping defined for the EPP <update> command.
One schema is presented here that is the EPP IDN Table 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.
Extensible Provisioning Protocol v1.0 IDN Table Mapping. END]]>
This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism described in . The following URI assignment is requested of IANA: URI: urn:ietf:params:xml:ns:idnTable-1.0 Registrant Contact: See the "Author's Address" section of this document. XML: See the "Formal Syntax" section of this document.
The EPP extension described in this document should be registered by the IANA in the EPP Extension Registry described in . The details of the registration are as follows: Name of Extension: "Extensible Provisioning Protocol (EPP) Internationalized Domain Name (IDN) Table Mapping" Document status: Standards Track Reference: (insert reference to RFC version of this document) Registrant Name and Email Address: IESG, <iesg@ietf.org> TLDs: Any IPR Disclosure: None Status: Active Notes: None
The mapping extensions described in this document do not provide any security services beyond those described by EPP and protocol layers used by EPP. The security considerations described in these other specifications apply to this specification as well.
&RFC2119; &RFC3688; &RFC5730; &RFC5731; &RFC5890; &RFC7451; &I-D.ietf-eppext-idnmap;
Amended XML Namespace section of IANA Considerations, added EPP Extension Registry section.
Removed support for returning the idnTable:codePoint and idnTable:codeRange elements in the table info response based on the feedback at the Registration Operations Workshop (ROW), held on March 22, 2015, prior to IETF-92. Fixed info command samples that referenced the <check> element instead of the <info> element.
Ping update.
Ping update.
Ping update.