Internet Engineering Task Force S. Hollenbeck Internet-Draft VeriSign, Inc. October 2, 2001 Expires: April 2, 2002 Extensible Provisioning Protocol Host 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) map- ping for the provisioning and management of Internet host names stored in a shared central repository. Specified in XML, the mapping defines EPP command syntax and semantics as applied to host names. 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 in exam- ples is provided only to illustrate element relationships and is not a REQUIRED feature of this protocol. Hollenbeck Expires April 2, 2002 [Page 1] Internet-Draft EPP Host Mapping October 2, 2001 Table of Contents 1. Introduction ................................................. 3 2. Object Attributes ............................................ 4 2.1 Host Names .................................................. 4 2.2 Client Identifiers .......................................... 4 2.3 Status Values ............................................... 4 2.4 Dates and Times ............................................. 5 2.5 IP Addresses ................................................ 5 3. EPP Command Mapping .......................................... 6 3.1 EPP Query Commands .......................................... 6 3.1.1 EPP Command ....................................... 6 3.1.2 EPP Command ........................................ 8 3.1.3 EPP Command .................................... 11 3.2 EPP Transform Commands ...................................... 11 3.2.1 EPP Command ...................................... 12 3.2.2 EPP Command ...................................... 14 3.2.3 EPP Command ....................................... 15 3.2.4 EPP Command .................................... 16 3.2.5 EPP Command ...................................... 16 4. Formal Syntax ................................................ 19 5. Internationalization Considerations .......................... 24 6. IANA Considerations .......................................... 24 7. Security Considerations ...................................... 24 8. Acknowledgements ............................................. 26 9. References ................................................... 27 10. Author's Address ............................................ 28 A. Revisions From Previous Version .............................. 29 B. Full Copyright Statement ..................................... 30 Hollenbeck Expires April 2, 2002 [Page 2] Internet-Draft EPP Host Mapping October 2, 2001 1. Introduction This document describes an Internet host name mapping for version 1.0 of the Extensible Provisioning Protocol (EPP). This mapping 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. This document assumes that host name objects have a subordinate relationship to a superordinate domain name object. For example, host name "ns1.example.com" has a subordinate relationship to domain name "example.com". EPP actions (such as object transfers) that do not preserve this relationship MUST be explicitly disallowed. 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. This document is being discussed on the "ietf-provreg" mailing list. To join the list, send a message to with the words "subscribe ietf-provreg" in the body of the message. There is a web site for the list archives at http://www.cafax.se/ietf-provreg. Hollenbeck Expires April 2, 2002 [Page 3] Internet-Draft EPP Host Mapping October 2, 2001 2. Object Attributes An EPP host object has attributes and associated values that may be viewed and modified by the sponsoring client or the server. This section describes each attribute type in detail. 2.1 Host Names The syntax for host names described in this document MUST conform to [RFC952] as updated by [RFC1123]. These conformance requirements MAY change as a result of progressing work in developing standards for internationalized host names. 2.2 Client Identifiers All EPP clients are identified by a server-unique identifier. Client identifiers conform to the "clIDType" syntax described in [EPP]. 2.3 Status Values A host object MUST always have at least one associated status value. Status values MAY be set only by the client that sponsors a host object and by the server on which the object resides. A client MAY change the status of a host object using the EPP command. Each status value MAY be accompanied by a string of human-readable text that describes the rationale for the status applied to the object. A client MUST NOT alter status values set by the server. A server MAY alter or override status values set by a client subject to local server policies. Status values that may be added or removed by a client are prefixed with "client". Corresponding status values that may be added or removed by a server are prefixed with "server". Status values that do not begin with either "client" or "server" are server-managed. Status Value Descriptions: clientDeleteProhibited, serverDeleteProhibited Requests to delete the object MUST be rejected. clientUpdateProhibited, serverUpdateProhibited Requests to update the object (other than to remove this status) MUST be rejected. Hollenbeck Expires April 2, 2002 [Page 4] Internet-Draft EPP Host Mapping October 2, 2001 linked The host object has at least one active association with another object, such as a domain object. Servers SHOULD provide services to determine existing object associations. ok This is the nominal status value for an object that has no pending operations or prohibitions. pendingDelete A delete request has been received for the object, but the object has not yet been purged from the server database. pendingTransfer A transfer request has been received for the host object's superordinate domain object, and completion of the request is pending. "ok" status MAY only be combined with "linked" status. "linked" status MAY be combined with any status. "pendingDelete" status MUST NOT be combined with either "clientDeleteProhibited" or "serverDeleteProhibited" status. All other status value combinations are valid. 2.4 Dates and Times Date and time attribute values MUST be represented in Universal Coordinated Time (UTC) using the Gregorian calendar. The extended date-time form defined in [ISO8601] MUST be used to represent date- time values as XML Schema does not support truncated date-time forms. 2.5 IP Addresses The syntax for IPv4 addresses described in this document MUST conform to [RFC791]. The syntax for IPv6 addresses described in this document MUST conform to [RFC1884]. Practical considerations for publishing IPv6 address information in zone files is documented in [RFC1886] and [RFC2874]. A server MAY reject IP addresses that have not been allocated for public use by IANA. Hollenbeck Expires April 2, 2002 [Page 5] Internet-Draft EPP Host Mapping October 2, 2001 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 Internet host names via EPP. 3.1 EPP Query Commands EPP provides two commands to retrieve host information: to determine if a host object is available for provisioning, and to retrieve detailed information associated with a host object. 3.1.1 EPP Command The EPP command is used to determine if an object may be provisioned within a repository. It provides a hint that allows a client to anticipate the success or failure of provisioning an object using the command. Object availability and provisioning conditions are a matter of server policy. In addition to the standard EPP command elements, the command MUST contain a element that identifies the host namespace and the location of the host schema. The element contains the following child elements: - One or more elements that contain the fully qualified names of the host objects to be queried. Hollenbeck Expires April 2, 2002 [Page 6] Internet-Draft EPP Host Mapping October 2, 2001 Example command: C: C: C: C: C: C: ns1.example.com C: ns2.example.com C: ns3.example.com C: C: C: ABC-12345 C: C: When a command has been processed successfully, the EPP element MUST contain a child element that identifies the host namespace and the location of the host schema. The element contains one or more elements that contain the following child elements: - A element that contains the fully qualified name of the queried host object. This element MUST contain an "avail" attribute whose value indicates object availability at the moment the command was completed. A value of "1" or "true" means that the object is available. A value of "0" or "false" means that the object is not available. - An OPTIONAL element that MAY be provided when an object is not available for provisioning. If present, this element contains server-specific text to help explain why the object is unavailable. 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 a default value of "en" (English). Hollenbeck Expires April 2, 2002 [Page 7] Internet-Draft EPP Host Mapping October 2, 2001 Example response: S: S: S: S: S: Command completed successfully S: S: S: S: S: ns1.example.com S: S: S: ns2.example2.com S: In use S: S: S: ns3.example3.com S: S: S: S: S: ABC-12345 S: 54322-XYZ S: S: S: An EPP error response MUST be returned if a command can not be processed for any reason. 3.1.2 EPP Command The EPP command is used to retrieve information associated with a host object. In addition to the standard EPP command elements, the command MUST contain a element that identifies the host namespace and the location of the host schema. The element contains the following child elements: - A element that contains the fully qualified name of the Hollenbeck Expires April 2, 2002 [Page 8] Internet-Draft EPP Host Mapping October 2, 2001 host object for which information is requested. Example command: C: C: C: C: C: C: ns1.example.com C: C: C: ABC-12345 C: C: When an command has been processed successfully, the EPP element MUST contain a child element that identifies the host namespace and the location of the host schema. The element contains the following child elements: - A element that contains the fully qualified name of the host object to be queried. - A element that contains the Repository Object IDentifier assigned to the host object when the object was created. - One or more elements that describe the status of the host object. - Zero or more elements that contain the IP addresses associated with the host object. - A element that contains the identifier of the sponsoring client. - A element that contains the identifier of the client that created the host object. - A element that contains the date and time of host object creation. Hollenbeck Expires April 2, 2002 [Page 9] Internet-Draft EPP Host Mapping October 2, 2001 - A element that contains the identifier of the client that last updated the host object. This element MUST NOT be present if the host object has never been modified. - A element that contains the date and time of the most recent host object modification. This element MUST NOT be present if the host object has never been modified. - A element that contains the date and time of the most recent successful host object transfer. This element MUST NOT be provided if the host object has never been transferred. Note that host objects MUST NOT be transferred directly; host objects MUST be transferred implicitly when the host object's superordinate domain object is transferred. Host objects that are subject to transfer when transferring a domain object are listed in the response to an EPP command performed on the domain object. Hollenbeck Expires April 2, 2002 [Page 10] Internet-Draft EPP Host Mapping October 2, 2001 Example response: S: S: S: S: S: Command completed successfully S: S: S: S: ns1.example.com S: NS1EXAMPLE1-VRSN S: S: S: 192.1.2.3 S: 1080:0:0:0:8:800:200C:417A S: ClientY S: ClientX S: 1999-04-03T22:00:00.0Z S: ClientX S: 1999-12-03T09:00:00.0Z S: 2000-04-08T09:00:00.0Z 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 Transfer semantics do not directly apply to host objects, so there is no mapping defined for the EPP query command. 3.2 EPP Transform Commands Hollenbeck Expires April 2, 2002 [Page 11] Internet-Draft EPP Host Mapping October 2, 2001 EPP provides three commands to transform host objects: to create an instance of a host object, to delete an instance of a host object, and to change information associated with a host object. This document does not define host object mappings for the EPP and commands. 3.2.1 EPP Command The EPP command provides a transform operation that allows a client to create a host object. In addition to the standard EPP command elements, the command MUST contain a element that identifies the host namespace and the location of the host schema. The element contains the following child elements: - A element that contains the fully qualified name of the host object to be created. - Zero or more elements that contain the IP addresses to be associated with the host. Each element MAY contain an "ip" attribute to identify the IP address format. Attribute value "v4" is used to note IPv4 address format. Attribute value "v6" is used to note IPv6 address format. If the "ip" attribute is not specified, "v4" is the default attribute value. Hosts may be provisioned for use as name servers in the Domain Name System (DNS), described in [RFC1034] and [RFC1035]. Hosts provisioned as name servers MAY be subject to server operator policies that require or prohibit specification of IP addresses depending on the name of the host and the name space in which the server will be used as a name server. When provisioned for use as a name server, IP addresses are REQUIRED only as needed to produce DNS glue records. For example, if the server is authoritative for the ".com" name space and the name of the server is "ns1.example.com.au", the server is not required to produce DNS glue records for the name server and IP addresses for the server are not required by the DNS. If the host name exists in a name space for which the server is authoritative, then the superordinate domain of the host MUST be known to the server before the host object can be created. Hollenbeck Expires April 2, 2002 [Page 12] Internet-Draft EPP Host Mapping October 2, 2001 Example command: C: C: C: C: C: C: ns1.example.com C: 192.1.2.3 C: 198.1.2.3 C: 1080:0:0:0:8:800:200C:417A C: ::FFFF:129.144.52.38 C: C: C: ABC-12345 C: C: When a command has been processed successfully, the EPP element MUST contain a child element that identifies the host namespace and the location of the host schema. The element contains the following child elements: - A element that contains the fully qualified name of the host object. - A element that contains the date and time of host object creation. Hollenbeck Expires April 2, 2002 [Page 13] Internet-Draft EPP Host Mapping October 2, 2001 Example response: S: S: S: S: S: Command completed successfully S: S: S: S: ns1.example.com S: 1999-04-03T22:00:00.0Z S: S: S: S: ABC-12345 S: 54322-XYZ S: S: S: An EPP error response MUST be returned if a command can not be processed for any reason. 3.2.2 EPP Command The EPP command provides a transform operation that allows a client to delete a host object. In addition to the standard EPP command elements, the command MUST contain a element that identifies the host namespace and the location of the host schema. The element contains the following child elements: - A element that contains the fully qualified name of the host object to be deleted. A host name object MUST NOT be deleted if the host object is associated with any other object. For example, if the host object is associated with a domain object, the host object MUST NOT be deleted until the existing association has been broken. Hollenbeck Expires April 2, 2002 [Page 14] Internet-Draft EPP Host Mapping October 2, 2001 Example command: C: C: C: C: C: C: ns1.example.com C: C: C: ABC-12345 C: C: When a command has been processed successfully, a server MUST respond with an EPP response with no element. Example response: S: S: S: S: S: Command completed successfully S: S: S: ABC-12345 S: 54321-XYZ S: S: S: An EPP error response MUST be returned if a command can not be processed for any reason. 3.2.3 EPP Command Renewal semantics do not apply to host objects, so there is no mapping Hollenbeck Expires April 2, 2002 [Page 15] Internet-Draft EPP Host Mapping October 2, 2001 defined for the EPP command. 3.2.4 EPP Command Transfer semantics do not directly apply to host objects, so there is no mapping defined for the EPP command. Host objects are subordinate to an existing superordinate domain object, and as such they are subject to transfer when a domain object is transferred. 3.2.5 EPP Command The EPP command provides a transform operation that allows a client to modify the attributes of a host object. In addition to the standard EPP command elements, the command MUST contain a element that identifies the host namespace and the location of the host schema. The element contains the following child elements: - A element that contains the fully qualified name of the host object to be updated. - An OPTIONAL element that contains attribute values to be added to the object. - An OPTIONAL element that contains attribute values to be removed from the object. - An OPTIONAL element that contains object attribute values to be changed. At least one , , or element MUST be provided. The and elements contain the following child elements: - One or more elements that contain IP addresses to be associated with or removed from the host object. IP address restrictions explained in the command mapping apply here as well. - One or more elements that contain status values to be associated with or removed from the object. When specifying a value to be removed, only the attribute value is significant; element text is not required to match a value for removal. A element contains the following child elements: - A element that contains a new fully qualified host name by which the host object will be known. Hollenbeck Expires April 2, 2002 [Page 16] Internet-Draft EPP Host Mapping October 2, 2001 Host name changes MAY require the addition or removal of IP addresses to be accepted by the server. IP address association MAY be subject to server policies for provisioning hosts as name servers. Host name changes MAY have an impact on associated objects that refer to the host object. A host name change SHOULD not require additional updates of associated objects to preserve existing associations. Example command: C: C: C: C: C: C: ns1.example.com C: C: 192.1.2.3 C: C: C: C: 1080:0:0:0:8:800:200C:417A C: C: C: ns2.example.com C: C: C: C: ABC-12345 C: C: When an command has been processed successfully, a server MUST respond with an EPP response with no element. Hollenbeck Expires April 2, 2002 [Page 17] Internet-Draft EPP Host Mapping October 2, 2001 Example response: S: S: S: S: S: Command completed successfully S: S: S: ABC-12345 S: 54321-XYZ S: S: S: An EPP error response MUST be returned if an command could not be processed for any reason. Hollenbeck Expires April 2, 2002 [Page 18] Internet-Draft EPP Host Mapping October 2, 2001 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 BEIGN 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 host provisioning schema. Hollenbeck Expires April 2, 2002 [Page 19] Internet-Draft EPP Host Mapping October 2, 2001 Hollenbeck Expires April 2, 2002 [Page 20] Internet-Draft EPP Host Mapping October 2, 2001 Hollenbeck Expires April 2, 2002 [Page 21] Internet-Draft EPP Host Mapping October 2, 2001 Hollenbeck Expires April 2, 2002 [Page 22] Internet-Draft EPP Host Mapping October 2, 2001 END Hollenbeck Expires April 2, 2002 [Page 23] Internet-Draft EPP Host Mapping October 2, 2001 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 declaration, EPP use with character sets other than UTF-8 is NOT RECOMMENDED. All date-time values presented via EPP MUST be expressed in Universal Coordinated Time using the Gregorian calendar. XML Schema allows use of time zone identifiers to indicate offsets from the zero meridian, but this option MUST NOT be used with EPP. The extended date-time form defined in [ISO8601] MUST be used to represent date-time values as XML Schema does not support truncated date-time forms. This document requires host name syntax as specified in [RFC952] as updated by [RFC1123]. These conformance requirements MAY change as a result of progressing work in developing standards for internationalized host names. 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 host namespace: URI: urn:ietf:params:xml:ns:host-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 host XML schema: URI: urn:ietf:params:xml:schema:host-1.0 Registrant Contact: See the "Author's Address" section of this document. XML: See the "Formal Syntax" section of this document. 7. Security Considerations Hollenbeck Expires April 2, 2002 [Page 24] Internet-Draft EPP Host Mapping October 2, 2001 The object mapping described in this document does not provide any security services or introduce any additional considerations beyond those described by [EPP] and protocol layers used by EPP. Hollenbeck Expires April 2, 2002 [Page 25] Internet-Draft EPP Host Mapping October 2, 2001 8. Acknowledgements This document was originally written as an individual submission Internet-Draft. The provreg working group later adopted it as a working group document and provided many invaluable comments and suggested improvements. Specific suggestions that have been incorporated into this document were provided by Chris Bason, Jordyn Buchanan, Dave Crocker, Anthony Eden, Sheer El-Showk, Klaus Malorny, Dan Manley, Michael Mealling, Patrick Mevzek, and Rick Wesson. Hollenbeck Expires April 2, 2002 [Page 26] Internet-Draft EPP Host Mapping October 2, 2001 9. References [EPP] S. Hollenbeck: "Extensible Provisioning Protocol", work in progress. [IETF-XML] M. Mealling: "The IETF XML Registry", work in progress. [ISO8601] ISO 8601:1988 (E): "Data elements and interchange formats - Information interchange - Representation of dates and times - The International Organization for Standardization". [RFC791] J. Postel: "Internet Protocol", RFC 791, September 1981. [RFC952] K. Harrenstien et al.: "DOD Internet Host Table Specification", RFC 952, October 1985. [RFC1034] P. Mockapetris: "DOMAIN NAMES - CONCEPTS AND FACILITIES", RFC 1034, STD 13, November 1987. [RFC1035] P. Mockapetris: "DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION", RFC 1035, STD 13, November 1987. [RFC1123] R. Braden: "Requirements for Internet Hosts -- Application and Support", RFC 1123, October 1989. [RFC1884] R. Hinden, S. Deering: "IP Version 6 Addressing Architecture", RFC 1884, December 1995. [RFC1886] S. Thomson, C. Huitema: "DNS Extensions to support IP version 6", RFC 1886, December 1995. [RFC2119] S. Bradner: "Key Words for Use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [RFC2874] M. Crawford, C. Huitema: "DNS Extensions to Support IPv6 Address Aggregation and Renumbering", RFC 2874, July 2000. [XML] Editor 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. Hollenbeck Expires April 2, 2002 [Page 27] Internet-Draft EPP Host Mapping October 2, 2001 10. Author's Address Scott Hollenbeck VeriSign Global Registry Services 21345 Ridgetop Circle Dulles, VA 20166-6503 USA shollenbeck@verisign.com Hollenbeck Expires April 2, 2002 [Page 28] Internet-Draft EPP Host Mapping October 2, 2001 A. Revisions From Previous Version -02 to -03: Modified date-time descriptions to note required use of extended representation. Modified command description and response elements. Added text to section 3.2.1 to note that this host mapping is not limited to describing name servers, and that provisioning of hosts for use as name servers may be subject to server operator policies that require or prohibit IP addresses in certain situations. Added element to response. Changed "TLD" to "name space" where used to describe server authority. Changed minOccurs of updateType choice to zero from one so that extension updates can be done without requiring an add, remove, or change element for the base object. Changed namespace and schema URIs to conform to the most recent Mealling XML registration procedures I-D. Also changed the "IANA Considerations" section to adhere to the registration procedures described in the draft. Added contributor names to the Acknowledgements section. Sorry if I missed anyone. Hollenbeck Expires April 2, 2002 [Page 29] Internet-Draft EPP Host Mapping October 2, 2001 B. Full Copyright Statement Copyright (C) The Internet Society 2001. 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 April 2, 2002 [Page 30]