Extensible Provisioning Protocol E.164 Number Mapping From: http://www.ietf.org/internet-drafts/draft-ietf-enum-epp-e164-00.txt -------------------------------------------------------------------------- Internet Engineering Task Force S. Hollenbeck Internet-Draft VeriSign, Inc. April 5, 2002 Expires: October 5, 2002 Extensible Provisioning Protocol E.164 Number Mapping Status of this Memo This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC2026. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts. 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". The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. Abstract This document describes an Extensible Provisioning Protocol (EPP) extension mapping for the provisioning and management of E.164 numbers representing domain names stored in a shared central repository. Specified in XML, this mapping extends the EPP domain name mapping to provide additional features required for the provisioning of E.164 numbers. 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 [RFC2119]. 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 protocol. Hollenbeck Expires October 5, 2002 [Page 1] Internet-Draft EPP E.164 Mapping April 5, 2002 Table of Contents 1. Introduction ................................................. 3 2. Object Attributes ............................................ 4 2.1 E.164 Domain Names .......................................... 4 2.2 NAPTR Fields ................................................ 4 3. EPP Command Mapping .......................................... 6 3.1 EPP Query Commands .......................................... 6 3.1.1 EPP Command ....................................... 6 3.1.2 EPP Command ........................................ 6 3.1.3 EPP Command .................................... 8 3.2 EPP Transform Commands ...................................... 8 3.2.1 EPP Command ...................................... 8 3.2.2 EPP Command ...................................... 10 3.2.3 EPP Command ....................................... 10 3.2.4 EPP Command .................................... 10 3.2.5 EPP Command ...................................... 10 4. Formal Syntax ................................................ 12 5. Internationalization Considerations .......................... 15 6. IANA Considerations .......................................... 15 7. Security Considerations ...................................... 16 8. Acknowledgements ............................................. 16 9. References ................................................... 17 10. Author's Address ............................................ 18 A. Revisions From Previous Version .............................. 18 B. Full Copyright Statement ..................................... 19 Hollenbeck Expires October 5, 2002 [Page 2] Internet-Draft EPP E.164 Mapping April 5, 2002 1. Introduction This document describes an E.164 number mapping for version 1.0 of the Extensible Provisioning Protocol (EPP). This mapping, an extension of the domain name mapping described in [EPP-D], is specified using the Extensible Markup Language (XML) 1.0 as described in [XML] and XML Schema notation as described in [XMLS-1] and [XMLS-2]. [EPP] 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. [RFC2916bis] describes how the Domain Name System (DNS) can be used to identify services associated with an E.164 number. The EPP mapping described in this document specifies a mechanism for the provisioning and management of E.164 numbers stored in a shared central repository. Information exchanged via this mapping can be extracted from the repository and used to publish DNS resource records as described in [RFC2916bis]. Examples used in this document were chosen specifically to illustrate provisioning concepts for the example resource records described in [RFC2916bis]. 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. Hollenbeck Expires October 5, 2002 [Page 3] Internet-Draft EPP E.164 Mapping April 5, 2002 2. Object Attributes This extension adds additional elements to the domain name mapping described in [EPP-D]. Only new element descriptions are described here. 2.1 E.164 Domain Names An E.164 domain name is a representation of an E.164 number that has been translated to conform to domain name syntax as described in [RFC2916bis]. The labels used to describe the name space of an E.164 domain name are a policy matter that is beyond the scope of this document. 2.2 NAPTR Fields According to [RFC2916bis], Naming Authority Pointer (NAPTR) resource records are used to identify available ways of contacting a specific node identified by a domain name created from the translation of an E.164 number. The format and processing rules for NAPTR records are described in [DDDS-3]. 2.2.1 Order The NAPTR order field, a 16-bit unsigned integer, is represented in this mapping using the XML Schema "unsignedShort" data type. 2.2.2 Preference The NAPTR preference field, a 16-bit unsigned integer, is represented in this mapping using the XML Schema "unsignedShort" data type. 2.2.3 Flags The NAPTR flags field is represented in this mapping using a single character. The case of the flag character is not significant. 2.2.4 Service The NAPTR service field is represented in this mapping using a character string with a maximum length of 65 characters. 2.2.5 Regular Expression The NAPTR regexp field is represented in this mapping using a character string with an unspecified maximum length. This field can contain numerous backslashes and should thus be treated with care. Hollenbeck Expires October 5, 2002 [Page 4] Internet-Draft EPP E.164 Mapping April 5, 2002 2.2.6 Replacement The NAPTR replacement field is represented in this mapping using a character string with a maximum length of 255 characters. Hollenbeck Expires October 5, 2002 [Page 5] Internet-Draft EPP E.164 Mapping April 5, 2002 3. EPP Command Mapping A detailed description of the EPP syntax and semantics can be found in [EPP]. The command mappings described here are specifically for use in provisioning and managing E.164 numbers via EPP. 3.1 EPP Query Commands EPP provides three commands to retrieve object information: to determine if an object is known to the server, to retrieve detailed information associated with an object, and to retrieve object transfer status information. 3.1.1 EPP Command This extension does not add any elements to the EPP command or response described in [EPP-D]. 3.1.2 EPP Command This extension does not add any elements to the EPP command described in [EPP-D]. Additional elements are defined for the response. When an command has been processed successfully, the EPP element MUST contain child elements as described in [EPP-D]. In addition, the EPP element MUST contain a child element that identifies the e164 namespace and the location of the e164 schema. The element contains one or more elements that contain the following child elements: - An element that contains a NAPTR order value. - An element that contains a NAPTR preference value. - An OPTIONAL element that contains a NAPTR flags value. - An OPTIONAL element that contains a NAPTR service value. - An OPTIONAL element that contains a NAPTR regular expression value. - An OPTIONAL element that contains a NAPTR replacement value. Example response: Hollenbeck Expires October 5, 2002 [Page 6] Internet-Draft EPP E.164 Mapping April 5, 2002 S: S: S: S: S: Command completed successfully S: S: S: S: 4.3.2.1.6.7.9.8.6.4.e164.arpa S: EXAMPLE1-REP S: S: jd1234 S: sh8013 S: sh8013 S: ns1.example.tld S: ns2.example.tld S: ns1.example.tld S: ns2.example.tld S: ClientX S: ClientY S: 1999-04-03T22:00:00.0Z S: ClientX S: 1999-12-03T09:00:00.0Z S: 2005-04-03T22:00:00.0Z S: 2000-04-08T09:00:00.0Z S: 2fooBAR S: S: S: S: S: S: 100 S: 10 S: u S: E2U+sip S: "!^.*$!sip:info@tele2.se! S: S: S: 102 S: 10 Hollenbeck Expires October 5, 2002 [Page 7] Internet-Draft EPP E.164 Mapping April 5, 2002 S: u S: E2U+mailto S: "!^.*$!mailto:info@tele2.se! S: S: S: S: S: ABC-12345 S: 54322-XYZ S: S: S: An EPP error response MUST be returned if an command can not be processed for any reason. 3.1.3 EPP Command This extension does not add any elements to the EPP command or response described in [EPP-D]. 3.2 EPP Transform Commands EPP provides five commands to transform objects: to create an instance of an object, to delete an instance of an object, to extend the validity period of an object, to manage object sponsorship changes, and to change information associated with an object. 3.2.1 EPP Command This extension defines additional elements for the EPP command described in [EPP-D]. No additional elements are defined for the EPP response. The EPP command provides a transform operation that allows a client to create a domain object. In addition to the EPP command elements described in [EPP-D], the command MUST contain an element. The element MUST contain a child element that identifies the e164 namespace and the location of the e164 schema. The element contains one or more elements that contain the following child elements: - An element that contains a NAPTR order value. - An element that contains a NAPTR preference value. - An OPTIONAL element that contains a NAPTR flags value. Hollenbeck Expires October 5, 2002 [Page 8] Internet-Draft EPP E.164 Mapping April 5, 2002 - An OPTIONAL element that contains a NAPTR service value. - An OPTIONAL element that contains a NAPTR regular expression value. - An OPTIONAL element that contains a NAPTR replacement value. Example command: C: C: C: C: C: C: 4.3.2.1.6.7.9.8.6.4.e164.arpa C: 2 C: ns1.example.tld C: ns2.example.tld C: jd1234 C: sh8013 C: sh8013 C: 2fooBAR C: C: C: C: C: C: 100 C: 10 C: u C: E2U+sip C: "!^.*$!sip:info@tele2.se! C: C: C: 102 C: 10 C: u C: E2U+mailto Hollenbeck Expires October 5, 2002 [Page 9] Internet-Draft EPP E.164 Mapping April 5, 2002 C: "!^.*$!mailto:info@tele2.se! C: C: C: C: ABC-12345 C: C: When a command has been processed successfully, the EPP response is as described in [EPP-D]. 3.2.2 EPP Command This extension does not add any elements to the EPP command or response described in [EPP-D]. 3.2.3 EPP Command This extension does not add any elements to the EPP command or response described in [EPP-D]. 3.2.4 EPP Command This extension does not add any elements to the EPP command or response described in [EPP-D]. 3.2.5 EPP Command This extension defines additional elements for the EPP command described in [EPP-D]. No additional elements are defined for the EPP response. The EPP command provides a transform operation that allows a client to modify the attributes of a domain object. In addition to the EPP command elements descried in [EPP-D], the command MUST contain an element. The element MUST contain a child element that identifies the e164 namespace and the location of the e164 schema. The element contains one or more or elements. Each and element contains an element that contains the following child elements: - An element that contains a NAPTR order value. - An element that contains a NAPTR preference value. - An OPTIONAL element that contains a NAPTR flags value. Hollenbeck Expires October 5, 2002 [Page 10] Internet-Draft EPP E.164 Mapping April 5, 2002 - An OPTIONAL element that contains a NAPTR service value. - An OPTIONAL element that contains a NAPTR regular expression value. - An OPTIONAL element that contains a NAPTR replacement value. Example command: C: C: C: C: C: C: 4.3.2.1.6.7.9.8.6.4.e164.arpa C: C: C: C: C: C: C: 102 C: 10 C: u C: E2U+mailto C: "!^.*$!mailto:info@tele2.se! C: C: C: C: C: ABC-12345 C: C: When an command has been processed successfully, the EPP response is as described in [EPP-D]. Hollenbeck Expires October 5, 2002 [Page 11] Internet-Draft EPP E.164 Mapping April 5, 2002 4. 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 Extensible Provisioning Protocol v1.0 domain name extension schema for E.164 number provisioning. Hollenbeck Expires October 5, 2002 [Page 12] Internet-Draft EPP E.164 Mapping April 5, 2002 Hollenbeck Expires October 5, 2002 [Page 13] Internet-Draft EPP E.164 Mapping April 5, 2002 END Hollenbeck Expires October 5, 2002 [Page 14] Internet-Draft EPP E.164 Mapping April 5, 2002 5. 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. Compliant XML processors are REQUIRED to understand both UTF-8 and UTF-16. Though XML includes provisions to identify other character set encodings through use of an "encoding" attribute in an XML declaration, EPP use with character sets other than UTF-8 is NOT RECOMMENDED. 6. IANA Considerations This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism described in [IETF-XML]. Two URI assignments are requested. Registration request for the e164 namespace: URI: urn:ietf:params:xml:ns:e164-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 e164 XML schema: URI: urn:ietf:params:xml:schema:e164-1.0 Registrant Contact: See the "Author's Address" section of this document. XML: See the "Formal Syntax" section of this document. Hollenbeck Expires October 5, 2002 [Page 15] Internet-Draft EPP E.164 Mapping April 5, 2002 7. Security Considerations The mapping extensions described in this document do not provide any security services or introduce any additional considerations beyond those described by [EPP] and protocol layers used by EPP. (Actually, there probably does need to be some text added here to address whatever security considerations that differentiate E.164 number provisioning from other domain name provisioning. I'm open to suggestions...) 8. Acknowledgements The author gratefully acknowledges contributions to this document provided by Edward Lewis, Michael Mealling, Chip Sharp, and James Yu. Hollenbeck Expires October 5, 2002 [Page 16] Internet-Draft EPP E.164 Mapping April 5, 2002 9. References Normative references: [DDDS-3] M. Mealling: "Dynamic Delegation Discovery System (DDDS) Part Three: The DNS Database", work in progress. [RFC2916bis] P. Faltstrom, M. Mealling: "The E.164 to URI DDDS Application", work in progress. [EPP] S. Hollenbeck: "Extensible Provisioning Protocol", work in progress. [EPP-D] S. Hollenbeck: "Extensible Provisioning Protocol Domain Name Mapping", work in progress. [IETF-XML] M. Mealling: "The IETF XML Registry", work in progress. [RFC2119] S. Bradner: "Key Words for Use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [XML] Editors T. Bray et al.: "Extensible Markup Language (XML) 1.0 (Second Edition)", W3C Recommendation 6 October 2000. [XMLS-1] Editors H. Thompson et al.: "XML Schema Part 1: Structures", W3C Recommendation 2 May 2001. [XMLS-2] Editors P. Biron, A. Malhotra: "XML Schema Part 2: Datatypes", W3C Recommendation 2 May 2001. Informative references: None. Hollenbeck Expires October 5, 2002 [Page 17] Internet-Draft EPP E.164 Mapping April 5, 2002 10. Author's Address Scott Hollenbeck VeriSign Global Registry Services 21345 Ridgetop Circle Dulles, VA 20166-6503 USA shollenbeck@verisign.com A. Revisions From Previous Version Individual submission -02 to ENUM WG -00: Updated references. Updated examples to keep in synch with the DDDS and 2916bis drafts. Hollenbeck Expires October 5, 2002 [Page 18] Internet-Draft EPP E.164 Mapping April 5, 2002 B. Full Copyright Statement Copyright (C) The Internet Society 2002. All Rights Reserved. This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the Internet Society or other Internet organizations, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet Standards process must be followed, or as required to translate it into languages other than English. The limited permissions granted above are perpetual and will not be revoked by the Internet Society or its successors or assigns. This document and the information contained herein is provided on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIMS 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. Acknowledgement Funding for the RFC Editor function is currently provided by the Internet Society. Hollenbeck Expires October 5, 2002 [Page 19]