Internet Engineering Task Force S. Hollenbeck Internet-Draft VeriSign, Inc. June 14, 2001 Expires: December 14, 2001 Extensible Provisioning Protocol 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 application layer client-server protocol for the provisioning and management of objects stored in a shared central repository. Specified in XML, the protocol defines generic object management operations and an extensible framework that maps protocol operations to objects. This document includes a protocol specification, an object mapping template, and an XML media type registration. 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 December 14, 2001 [Page 1] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Table of Contents 1. Introduction ................................................. 3 2. Protocol Description ......................................... 4 2.1 Protocol Identification ..................................... 5 2.2 Hello Format ................................................ 5 2.3 Greeting Format ............................................. 5 2.4 Command Format .............................................. 7 2.5 Response Format ............................................. 9 2.6 Protocol Extension Framework ................................ 14 2.7 Server-Defined Extensions ................................... 14 2.8 Object Identification ....................................... 15 2.9 Protocol Commands ........................................... 16 2.9.1 Session Management Commands ............................... 16 2.9.1.1 EPP Command ..................................... 16 2.9.1.2 EPP Command .................................... 19 2.9.2 Object Query Commands ..................................... 20 2.9.2.1 EPP Command ..................................... 20 2.9.2.2 EPP Command ...................................... 22 2.9.2.3 EPP Command ...................................... 24 2.9.2.4 EPP Query Command ............................ 27 2.9.3 Object Transform Commands ................................. 29 2.9.3.1 EPP Command .................................... 29 2.9.3.2 EPP Command .................................... 31 2.9.3.3 EPP Command ..................................... 32 2.9.3.4 EPP Command .................................. 34 2.9.3.5 EPP Command .................................... 37 3. Result Codes ................................................. 39 4. Formal Syntax ................................................ 44 4.1 Base Schema ................................................. 44 4.2 Shared Structure Schema ..................................... 52 5. Internationalization Considerations .......................... 54 6. IANA Considerations .......................................... 55 7. Security Considerations ...................................... 56 8. References ................................................... 57 9. Author's Address ............................................. 58 A. Revisions From Previous Version .............................. 59 B. Full Copyright Statement ..................................... 60 C: Object Mapping Template ...................................... 61 D: Media Type Registration: application/epp+xml ................. 63 Hollenbeck Expires December 14, 2001 [Page 2] Internet-Draft Extensible Provisioning Protocol June 14, 2001 1. Introduction This document describes specifications for the Extensible Provisioning Protocol (EPP) version 1.0, an XML text protocol that permits multiple service providers to perform object provisioning operations using a shared central object repository. EPP 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 meets and exceeds the requirements for a generic registry registrar protocol as described in [GRRP]. EPP is intended for use in diverse operating environments where transport and security requirements vary greatly. It is unlikely that a single transport or security specification will meet the needs of all anticipated operators, so EPP was designed for use in a layered protocol environment. This document only describes the EPP application layer protocol. This original motivation for this protocol was to provide a standard Internet domain name registration protocol for use between domain name registrars and domain name registries. This protocol provides a means of interaction between a registrar's applications and registry applications. It is expected that this protocol will have additional uses beyond domain name registration. 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 December 14, 2001 [Page 3] Internet-Draft Extensible Provisioning Protocol June 14, 2001 2. Protocol Description EPP is an XML protocol that can be layered over multiple transport protocols. Protected using lower-layer security protocols, clients exchange identification, authentication, and option information, and then engage in a series of client-initiated command-response exchanges. All EPP commands are atomic and idempotent. EPP provides four basic service elements: service discovery, commands, responses, and an extension framework that supports definition of managed objects and the relationship of protocol requests and responses to those objects. A connection-oriented EPP server MUST respond to connection creation by returning a greeting to a client. A connection-less EPP server MUST be prompted to provide a greeting to a client. In both cases, a client SHOULD wait for the greeting before sending an EPP command to the server. The server MUST respond to each EPP command with a coordinated response that describes the results of processing the command. EPP commands fall into three categories: session management commands, query commands, and data transform commands. Session management commands are used to establish and end persistent sessions with an EPP server. Query commands are used to perform read-only object information retrieval operations. Transform commands are used to perform read-write object management operations. EPP uses XML namespaces to provide an extensible object management framework and to identify schemas required for XML instance parsing and validation. These namespaces and schema definitions are used to identify both the base protocol schema and the schemas for managed objects. All XML instances SHOULD begin with an declaration to identify the version of XML that is being used, optionally identify use of the UTF-8 character set defined in [RFC2279], and optionally to provide a hint to an XML parser that an external schema file is needed to validate the XML instance. EPP use with character sets other than UTF-8 is not described in this document. Conformant XML parsers are required to understand UTF-8, thus the "encoding" attribute is OPTIONAL. Hollenbeck Expires December 14, 2001 [Page 4] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example XML declarations: 2.1 Protocol Identification All EPP XML instances MUST begin with an element. This element identifies the start of an EPP protocol element, the namespace used within the protocol, and the location of the protocol schema. This start element and the associated ending element MUST be applied to all structures sent by both clients and servers. Example "start" and "end" EPP elements: 2.2 Hello Format EPP MAY be carried over both connection-oriented and connection-less transport protocols. An EPP client MAY request a from an EPP server at any time by sending a to a server. Use of this element is essential in a connection-less environment where a server can not return a in response to a client-initiated connection. An EPP MUST be an empty element with no child elements. Example : C: C: C: C: 2.3 Greeting Format An EPP server responds to a successful connection and element Hollenbeck Expires December 14, 2001 [Page 5] Internet-Draft Extensible Provisioning Protocol June 14, 2001 by returning a element to the client. An EPP greeting contains the following elements: - An element that contains the name of the server. - An element that contains the server's current date and time in UTC. - An element that identifies the services supported by the server, including: - One or more elements that identify the protocol versions supported by the server. - One or more elements that contain the identifiers of the text response languages known by the server. Language identifiers MUST be structured as documented in [RFC3066]. Only language identifiers listed in [ISO639] MAY be used. - One or more object-specific elements that identify the objects that the server is capable of managing. - An OPTIONAL (unspecified) element that contains one or more object-specific elements that identify custom object extensions supported by the server. A server MAY limit object management privileges on a per-client basis. Hollenbeck Expires December 14, 2001 [Page 6] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example greeting: S: S: S: S: Example Company EPP server epp.example.com S: 2000-06-08T22:00:00.0Z S: S: 1.0 S: en S: fr S: S: S: S: S: S: S: S: S: 2.4 Command Format An EPP client interacts with an EPP server by sending commands to the server and receiving responses from the server. Commands and responses need not be exchanged serially. In addition to the standard EPP elements, an EPP command contains the following elements: - A (client identity credentials) element that provides client identity information. Use of this element MAY be OPTIONAL or REQUIRED depending on how the client wishes to manage sessions with the server. A element contains the following elements: - A element that contains the client identifier assigned to the client by the server. - A element that contains the client's plain text password. The value of this element is case sensitive. - An OPTIONAL element that contains a new plain text password to be assigned to the client for use with subsequent Hollenbeck Expires December 14, 2001 [Page 7] Internet-Draft Extensible Provisioning Protocol June 14, 2001 elements. The value of this element is case sensitive. - An element that contains the following child elements: - A element that contains the protocol version to be used for the command or ongoing server session. - A element that contains the text response language to be used for the command or ongoing server session commands. The values of the and elements MUST exactly match one of the values presented in the EPP greeting. - A command element whose tag corresponds to one of the valid EPP commands described in this document. The command element MAY contain either protocol-specified or object-specified child elements. - An OPTIONAL (unspecified) element that MAY be used for server-defined command extensions. - An OPTIONAL (client transaction identifier) element that uniquely identifies the command to the client. EPP supports both session-less and session-oriented operating modes, though the two operating modes MAY NOT be mixed. An ongoing server session that preserves client identity and authorization information MAY be created and ended using the and commands. Commands MAY also be executed outside of an established session through use of the element within the command. Session-less operation implies that object service availability and client identity MUST be checked on a per-command basis. Significant improvements in server processing performance MAY be realized using the protocol's session-oriented operating mode. Hollenbeck Expires December 14, 2001 [Page 8] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example command without credentials: C: C: C: C: C: C: example C: C: C: C: ABC-12345 C: C: Example command with credentials: C: C: C: C: C: ClientX C: foo-BAR2 C: bar-FOO2 C: C: 1.0 C: en C: C: C: C: C: example C: C: C: C: ABC-12345 C: C: 2.5 Response Format Hollenbeck Expires December 14, 2001 [Page 9] Internet-Draft Extensible Provisioning Protocol June 14, 2001 An EPP server responds to a client command by returning a response to the client. EPP commands are atomic, so a command must either succeed completely or fail completely. Success and failure results MUST NOT be mixed. In addition to the standard EPP elements, an EPP response contains the following elements: - One or more elements that document the success or failure of command execution. If the command was processed successfully, only one element MUST be returned. If the command was not processed successfully, multiple elements MAY be returned to document failure conditions. Each element contains the following attribute and child elements: - An OPTIONAL element containing a "count" attribute that identifies the number of service messages queued for client retrieval. If there are no queued messages, this element MAY be missing or empty, and the value of the "count" attribute MUST be zero. The default value for the "count" attribute MUST be zero if unspecified. - A "code" attribute whose value is a four-digit, decimal number that describes the success or failure of the command. - A element containing a human-readable description of the response code. The language of the response is identified via an OPTIONAL "lang" attribute. If not specified, the default attribute value MUST be "en" (English). An OPTIONAL "id" attribute MAY be present when responding to an EPP command. See the description of the command for more information describing the server message queue. - Zero or more OPTIONAL elements that echo client-provided values that caused server error conditions. - An OPTIONAL (response data) element that contains child elements specific to the command and associated object. - An OPTIONAL (unspecified) element that MAY be used for server-defined response extensions. - A element that contains the Repository Object IDentifier associated with an object transform command. This element is REQUIRED when responding to a , , or command, and MUST be absent otherwise. - A (transaction identifier) element containing the transaction identifier assigned by the server to the command for which the response is being returned. The transaction identifier is formed using the associated with the command if supplied by the Hollenbeck Expires December 14, 2001 [Page 10] Internet-Draft Extensible Provisioning Protocol June 14, 2001 client and a (server transaction identifier) that is assigned by and unique to the server. Transaction identifiers provide command-response synchronization integrity. They SHOULD be logged, retained, and protected to ensure that both the client and the server have consistent temporal and state management records. Example response without or : S: S: S: S: S: Command completed successfully S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: Hollenbeck Expires December 14, 2001 [Page 11] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example response with : S: S: S: S: S: Command completed successfully S: S: S: S: example S: S: S: S: EXAMPLE-VRSN S: S: ABC-12345 S: 54321-XYZ S: S: S: Hollenbeck Expires December 14, 2001 [Page 12] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example response with error : S: S: S: S: S: Parameter value range error S: 2525 S: S: S: Parameter value syntax error S: ex(ample S: abc.ex(ample S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: Example response with notice of waiting server messages: S: S: S: S: S: Command completed successfully S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: Command success or failure MUST NOT be assumed if no response is returned or if a returned response is malformed. Protocol idempotency ensures the safety of retrying a command in cases of response delivery Hollenbeck Expires December 14, 2001 [Page 13] Internet-Draft Extensible Provisioning Protocol June 14, 2001 failure. 2.6 Protocol Extension Framework EPP provides an extensible object management framework that defines the syntax and semantics of protocol operations applied to a managed object. This framework pushes the definition of each protocol operation into the context of a specific object, providing the ability to add mappings for new objects without having to modify the base protocol. Protocol elements that contain data specific to objects are identified using XML namespace notation with a reference to an XML schema that defines the namespace. The schema for EPP supports use of dynamic object schemas on a per-command and per-response basis. For example, the start of an object-specific command element would be described in generic terms as follows: C: C: C: C: C: An object-specific response element would be described similarly: S: S: S: S: S: This document does not define mappings for specific objects. The mapping of EPP to an object MUST be described in separate documents that specifically address each command and response in the context of the object. A suggested object mapping outline is included as an appendix to this document. 2.7 Server-Defined Extensions EPP provides a facility for unspecified protocol command and response extensions. Protocol commands and responses MAY be extended by an element that contains additional elements whose syntax and semantics are not explicitly defined by EPP or an EPP object mapping. This element is OPTIONAL and MAY be empty. These extensions are typically defined by agreement between client and server and MAY be Hollenbeck Expires December 14, 2001 [Page 14] Internet-Draft Extensible Provisioning Protocol June 14, 2001 used to extend EPP for unique operational needs. A server-extended command element would be described in generic terms as follows: C: C: C: C: C: C: C: C: An server-extended response element would be described similarly: S: S: S: Command completed successfully S: S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: This document does not define any specific server extensions. The mapping of server extensions to EPP MUST be described in separate documents that specifically address extended commands and responses in the server's operational context. 2.8 Object Identification Some objects, such as name servers and contacts, MAY have utility in multiple repositories. However, maintaining disjoint copies of object information in multiple repositories can lead to inconsistencies that have adverse consequences for the Internet. For example, changing a name server name in one repository, but not in a second repository that refers to the server for domain name delegation, can produce unexpected DNS query results. Globally unique identifiers can help facilitate object information sharing between repositories. A globally unique identifier MUST be assigned to every object when the object is created, and the identifier MUST be returned within the response for the command that created the object. Specific identifier values are a matter of Hollenbeck Expires December 14, 2001 [Page 15] Internet-Draft Extensible Provisioning Protocol June 14, 2001 repository policy, but they SHOULD be constructed according to the following algorithm: a) Divide the provisioning repository world into a number of object repository classes. b) Each repository within a class is assigned an identifier that is maintained by IANA. (c) Each repository is responsible for assigning a unique local identifier for each object within the repository. (d) The globally unique identifier is a concatenation of the local identifier, followed by a hyphen ("-"), followed by the repository identifier. 2.9 Protocol Commands EPP provides commands to manage sessions, retrieve object information, and perform transformation operations on objects. All EPP commands are atomic and idempotent, either succeeding completely or failing completely and producing predictable results in case of repeated execution. This section describes each EPP command, including examples with representative server responses. 2.9.1 Session Management Commands EPP provides two commands for session management: to establish a session with a server, and to end a session with a server. The command establishes an ongoing server session that preserves client identity and authorization information during the duration of the session. Alternatively, identity credentials MAY be provided with an EPP command to facilitate session-less operation. Session-oriented and session-less operating modes MUST NOT be mixed. Commands other than the command MUST NOT include identity credentials when submitted after successfully processing a command. 2.9.1.1 EPP Command The EPP command is used to establish a session with an EPP server in response to a greeting issued by the server. A command MUST be sent to a server before any other EPP command. A client identifier and initial password MUST be created on the server before a client can successfully complete a command. The client identifier and initial password MUST be delivered to the client Hollenbeck Expires December 14, 2001 [Page 16] Internet-Draft Extensible Provisioning Protocol June 14, 2001 using an out-of-band method that protects the identifier and password from inadvertent disclosure. A element MUST be provided with the command. Once a session has been established with the command, subsequent commands MUST NOT include a element. In addition to the standard EPP command elements, the command contains the following child elements: - A element that contains one or more object elements that identify the objects and unspecified extensions to be managed during the session. The element MAY contain an OPTIONAL (unspecified) element that contains one or more object- specific elements that identify custom object extensions supported by the server. The PLAIN SASL mechanism presented in [RFC2595] describes a format for providing a user identifier, an authorization identifier, and a password as part of a single plain text string. The EPP authentication mechanism is similar, though EPP does not require a session-level authorization identifier and the user identifier and password are separated into distinct XML elements. Additional identification and authorization schemes MUST be provided at other protocol layers to provide more robust security services. Hollenbeck Expires December 14, 2001 [Page 17] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example command: C: C: C: C: C: ClientX C: foo-BAR2 C: bar-FOO2 C: C: 1.0 C: en C: C: C: C: C: C: C: C: C: C: C: 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. If successful, the server will respond by creating and maintaining a new session that SHOULD be terminated by a future command. Hollenbeck Expires December 14, 2001 [Page 18] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example response: S: S: S: S: S: Command completed successfully S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: The EPP command is used to establish a session with an EPP server. A command MUST be rejected if received within the bounds of an existing session. This action MUST be open to all authorized clients. 2.9.1.2 EPP Command The EPP command is used to end a session with an EPP server. The command MUST be represented as an empty element with no child elements. A server MAY also end a session asynchronously due to client inactivity or excessive client session longevity. The parameters for determining excessive client inactivity or session longevity are a matter of server policy and are not specified by this protocol. Example command: C: C: C: C: C: C: ABC-12345 C: C: Hollenbeck Expires December 14, 2001 [Page 19] Internet-Draft Extensible Provisioning Protocol June 14, 2001 When a command has been processed successfully, a server MUST respond with an EPP response with no element. If successful, the server MUST also end the current session. Example response: S: S: S: S: S: Command completed successfully; ending session S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: The EPP command is used to end a session with an EPP server. A command MUST be rejected if the command has not been preceded by a successful command. This action MUST be open to all authorized clients. 2.9.2 Object Query Commands EPP provides four commands to retrieve object information: to determine if an object is known to the server, to retrieve detailed information associated with a known object, to receive service notifications from the server, and to retrieve object transfer status information. 2.9.2.1 EPP Command The EPP command is used to determine if an object exists in the server repository. The elements needed to identify an object are object-specific, so the child elements of the command are specified using the EPP extension framework. In addition to the standard EPP command elements, the command contains the following child elements: - An object-specific element that identify the objects to be queried. Multiple objects of the same type MAY be queried within a single command. Hollenbeck Expires December 14, 2001 [Page 20] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example command: C: C: C: C: C: C: example1 C: example2 C: example3 C: C: C: C: ABC-12346 C: C: When a command has been processed successfully, a server MUST respond with an EPP element that MUST contain a child element that identifies the object namespace and the location of the object schema. The child elements of the element are object-specific, though the EPP element MUST contain a child element that contains the following child elements and attributes: - One or more (check data) elements that echo the object identifiers provided in the command and contain an "x" attribute whose value identifies the object as either "+" for a known object or "-" for an unknown object. Hollenbeck Expires December 14, 2001 [Page 21] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example response: S: S: S: S: S: Command completed successfully S: S: S: S: example1 S: example2 S: example3 S: S: S: S: S: ABC-12346 S: 54322-XYZ S: S: S: The EPP command is used to determine if an object exists in the server repository. This action MUST be open to all authorized clients. 2.9.2.2 EPP Command The EPP command is used to retrieve information associated with an existing object. The elements needed to identify an object and the type of information associated with an object are both object- specific, so the child elements of the command are specified using the EPP extension framework. In addition to the standard EPP command elements, the command contains the following child elements: - An object-specific element that identifies the object to be queried. Hollenbeck Expires December 14, 2001 [Page 22] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example command: C: C: C: C: C: C: C: C: C: C: When an command has been processed successfully, a server MUST respond with an EPP element that MUST contain a child element that identifies the object namespace and the location of the object schema and the Repository Object Identifier (ROID) that was assigned to the object when the object was created. The child elements of the element are object-specific. Example response: S: S: S: S: S: Command completed successfully S: S: S: S: S: S: S: S: EXAMPLE1-VRSN S: S: ABC-12346 S: 54322-XYZ S: S: S: Hollenbeck Expires December 14, 2001 [Page 23] Internet-Draft Extensible Provisioning Protocol June 14, 2001 The EPP command is used to retrieve information associated with an existing object. This action SHOULD be limited to authorized clients; restricting this action to the sponsoring client is RECOMMENDED. 2.9.2.3 EPP Command The EPP command is used to discover and retrieve client service messages from a server. Information that MAY be made available to a client using service messages includes notification of object transfer requests and anticipated server outages; other messages types MAY be defined as a matter of server policy. Service messages are queued by the server for client retrieval. A command MUST return the first message from the message queue. Each message returned from the server includes a server-unique message identifier that MUST be provided to acknowledge receipt of the message, and a counter that indicates the number of messages in the queue. As a message is received by the client, the client MUST respond to the message with an explicit acknowledgement to confirm that the message has been received. A server MUST dequeue a message and decrement the queue counter after receiving acknowledgement from the client, making the next message in the queue (if any) available for retrieval. Some of the information returned in response to a command MAY be object-specific, so some child elements of the response MAY be specified using the EPP extension framework. The command MUST be represented as an empty element with no child elements. An "op" attribute with value "req" is REQUIRED to retrieve the first message from the server message queue. An "op" attribute (with value "ack") and a "msgID" attribute (whose value corresponds to the value of the "id" attribute copied from the element in the message being acknowledged) are REQUIRED to acknowledge receipt of a message. Example request command: C: C: C: C: C: C: ABC-12345 C: C: Hollenbeck Expires December 14, 2001 [Page 24] Internet-Draft Extensible Provisioning Protocol June 14, 2001 The returned result code identifies responses with message information returned in response to a command. Example response with object-specific information: S: S: S: S: S: Transfer request pending. S: S: S: S: S: example S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: A client MUST acknowledge each response to dequeue the message and make subsequent messages available for retrieval. Example acknowledgement command: C: C: C: C: C: C: ABC-12346 C: C: A acknowledgement response notes the ID of the message that has been acknowledged and the number of messages remaining in the queue. Hollenbeck Expires December 14, 2001 [Page 25] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example acknowledgement response: S: S: S: S: S: Command completed successfully S: S: S: S: S: ABC-12346 S: 54322-XYZ S: S: S: Service messages MAY also be returned without object information. Example response without object-specific information: S: S: S: S: S: Credit balance low. S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: The returned result code and message is used to note an empty server message queue. Hollenbeck Expires December 14, 2001 [Page 26] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example response to note an empty message queue: S: S: S: S: S: Command completed successfully; no messages S: S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: The EPP command is used to discover and retrieve client service messages from a server. This action SHOULD be limited to authorized clients; queuing service messages and limiting queue access on a per- client basis is RECOMMENDED. 2.9.2.4 EPP Query Command The EPP command provides a query operation that allows a client to determine real-time status of pending and completed transfer requests. The elements needed to identify an object that is the subject of a transfer request are object-specific, so the child elements of the query command are specified using the EPP extension framework. In addition to the standard EPP command elements, the command contains an "op" attribute with value "query", and the following child elements: - An object-specific element that identifies the object whose transfer status is requested. Hollenbeck Expires December 14, 2001 [Page 27] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example query command: C: C: C: C: C: C: C: C: C: C: ABC-12346 C: C: When an query command has been processed successfully, a server MUST respond with an EPP element that MUST contain a child element that identifies the object namespace and the location of the object schema. The child elements of the element are object-specific. Example query response: S: S: S: S: S: Command completed successfully S: S: S: S: S: S: S: S: S: ABC-12346 S: 54322-XYZ S: S: S: Hollenbeck Expires December 14, 2001 [Page 28] Internet-Draft Extensible Provisioning Protocol June 14, 2001 The EPP command provides a query operation that allows a client to determine real-time status of pending and completed transfer requests. This action SHOULD be limited to authorized clients; restricting queries to the requesting and responding clients is RECOMMENDED. Object transfer MAY be unavailable or limited by object-specific policies. 2.9.3 Object Transform Commands EPP provides five commands to transform objects: to create an instance of an object with a server, to remove an instance of an object from a server, to extend the validity period of an object, to change information associated with an object, and to manage changes in client sponsorship of an object. 2.9.3.1 EPP Command The EPP command is used to create an instance of an object. An object may be created for an indefinite period of time, or an object may be created for a specific validity period. The EPP mapping for an object MUST describe the status of an object with respect to time, to include expected client and server behavior if a validity period is used. The elements needed to identify an object and associated attributes are object-specific, so the child elements of the command are specified using the EPP extension framework. In addition to the standard EPP command elements, the command contains the following child elements: - An object-specific element that identifies the object to be created and the elements that are required to create the object. Hollenbeck Expires December 14, 2001 [Page 29] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example command: C: C: C: C: C: C: C: C: C: C: ABC-12345 C: C: When a command has been processed successfully, a server MUST respond with an EPP element that MUST contain a child element that identifies the object namespace and the location of the object schema and the Repository Object Identifier (ROID) that has been assigned to the object. The child elements of the element are object-specific. A ROID is an identifier that uniquely identifies an object across repositories. ROIDs are formed by combining a server-assigned unique identifier with a registered value that identifies the repository. Hollenbeck Expires December 14, 2001 [Page 30] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example response: S: S: S: S: S: Command completed successfully S: S: S: S: S: S: S: S: EXAMPLE1-VRSN S: S: ABC-12345 S: 54321-XYZ S: S: S: The EPP command is used to create an instance of an object. This action SHOULD be limited to authorized clients and MAY be restricted on a per-client basis. 2.9.3.2 EPP Command The EPP command is used to remove an instance of an existing object. The elements needed to identify an object are object- specific, so the child elements of the command are specified using the EPP extension framework. In addition to the standard EPP command elements, the command contains the following child elements: - An object-specific element that identifies the object to be deleted. Hollenbeck Expires December 14, 2001 [Page 31] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example command: C: C: C: C: C: C: C: C: C: C: ABC-12346 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: S: ABC-12346 S: 54322-XYZ S: S: S: The EPP command is used to remove an instance of an existing object. This action SHOULD be limited to authorized clients; restricting this action to the sponsoring client is RECOMMENDED. 2.9.3.3 EPP Command The EPP command is used to extend the validity period of an existing object. The elements needed to identify and extend the Hollenbeck Expires December 14, 2001 [Page 32] Internet-Draft Extensible Provisioning Protocol June 14, 2001 validity period of an object are object-specific, so the child elements of the command are specified using the EPP extension framework. In addition to the standard EPP command elements, the command contains the following child elements: - An object-specific element that identifies the object to be renewed and the elements that are required to extend the validity period of the object. Example command: C: C: C: C: C: C: C: C: C: C: ABC-12346 C: C: When a command has been processed successfully, a server MUST respond with an EPP element that MUST contain a child element that identifies the object namespace and the location of the object schema. The child elements of the element are object-specific. Hollenbeck Expires December 14, 2001 [Page 33] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example response: S: S: S: S: S: Command completed successfully S: S: S: S: S: S: S: S: S: ABC-12346 S: 54322-XYZ S: S: S: The EPP command is used to extend the validity period of an existing object. This action SHOULD be limited to authorized clients; restricting this action to the sponsoring client is RECOMMENDED. Object renewal MAY be unavailable or limited by object-specific policies. 2.9.3.4 EPP Command The EPP command is used to manage changes in client sponsorship of an existing object. Clients may initiate a transfer request, cancel a transfer request, approve a transfer request, and reject a transfer request using the "op" command attribute. A client who wishes to assume sponsorship of a known object from another client uses the command with the value of the "op" attribute set to "request". Once a transfer has been requested, the same client may cancel the request using a command with the value of the "op" attribute set to "cancel". A request to cancel the transfer MUST be sent to the server before the current sponsoring client either approves or rejects the transfer request and before the server automatically processes the request due to responding client inactivity. Hollenbeck Expires December 14, 2001 [Page 34] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Once a transfer request has been received by the server, the server MUST notify the current sponsoring client of the requested transfer by queuing a service message for retrieval via the command. The current status of a pending command for any object MAY be found using the query command; the service message MUST include appropriate object information to perform a query. The current sponsoring client MAY explicitly approve or reject the transfer request. The client may approve the request using a command with the value of the "op" attribute set to "approve". The client may reject the request using a command with the value of the "op" attribute set to "reject". A server MAY automatically approve or reject all transfer requests that are not explicitly approved or rejected by the current sponsoring client within a fixed amount of time. The amount of time to wait for explicit action and the default server behavior are local matters not specified by EPP, but they SHOULD be documented in a server-specific profile document that describes default server behavior for client information. Objects MAY have associated authorization information that MUST be provided to complete a command. The type of authorization information required is object-specific; passwords or more complex mechanisms based on public key cryptography are typical. The elements needed to identify and complete the transfer of an object are object-specific, so the child elements of the command are specified using the EPP extension framework. In addition to the standard EPP command elements, the command contains the following child elements: - An object-specific element that identifies the object to be transferred and the elements that are required to process the transfer command. Hollenbeck Expires December 14, 2001 [Page 35] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example request command: C: C: C: C: C: C: C: C: C: C: ABC-12346 C: C: When a command has been processed successfully, a server MUST respond with an EPP response with no element. Example request response: S: S: S: S: S: Command completed successfully S: S: S: S: ABC-12346 S: 54322-XYZ S: S: S: The EPP command is used to manage changes in client sponsorship of an existing object. This action SHOULD be limited to authorized clients; restricting requests to a client other than the current sponsoring client, approval requests to the current sponsoring client, and cancellation requests to the original requesting client is RECOMMENDED. Object transfer MAY be unavailable or limited by object-specific policies. Hollenbeck Expires December 14, 2001 [Page 36] Internet-Draft Extensible Provisioning Protocol June 14, 2001 2.9.3.5 EPP Command The EPP command is used to change information associated with an existing object. The elements needed to identify and modify an object are object-specific, so the child elements of the command are specified using the EPP extension framework. In addition to the standard EPP command elements, the command contains the following child elements: - An object-specific element that identifies the object to be renewed and the elements that are required to modify the object. Object-specific elements MUST identify values to be added, values to be removed, or values to be changed. Example command: C: C: C: C: C: C: C: C: C: C: ABC-12346 C: C: When an command has been processed successfully, a server MUST respond with an EPP response with no element. Hollenbeck Expires December 14, 2001 [Page 37] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Example request response: S: S: S: S: S: Command completed successfully S: S: S: S: ABC-12346 S: 54322-XYZ S: S: S: The EPP command is used to change information associated with an existing object. This action SHOULD be limited to authorized clients; restricting this action to the sponsoring client is RECOMMENDED. Hollenbeck Expires December 14, 2001 [Page 38] Internet-Draft Extensible Provisioning Protocol June 14, 2001 3. Result Codes EPP result codes are based on the Theory of Reply Codes described in Appendix E of [RFC821]. EPP uses four decimal digits to describe the success or failure of each EPP command. Each of the digits of the reply have special significance. The first digit denotes command success or failure. The second digit denotes the response category, such as command syntax or security. The third and fourth digits provide explicit response detail within each response category. There are two values for the first digit of the reply code: 1yzz Positive completion reply. The command has been accepted and processed by the system without error. 2yzz Negative completion reply. The command was not accepted and the requested action did not occur. The second digit groups responses into one of six specific categories: x0zz Protocol Syntax x1zz Implementation-specific Rules x2zz Security x3zz Data Management x4zz Server System x5zz Connection Management The third and fourth digits provide response detail within the categories defined by the first and second digits. Specific result codes are listed in the table below. Every EPP response MUST include a result code and a human-readable description of the result code. The language used to represent the description MAY be identified using an instance of the "lang" attribute within the element. If not specified, the default language is English, identified as "en". A description of the structure of valid values for the "lang" attribute is described in [RFC3066]. A list of valid values for the "lang" attribute is available in [ISO639]. Response text MAY be translated into other languages, though the translation MUST preserve the meaning of the code as described here. Response code values MUST NOT be changed when translating text. Response text in the table below is enclosed in quotes to clearly mark the beginning and ending of each response string. Quotes MUST NOT be Hollenbeck Expires December 14, 2001 [Page 39] Internet-Draft Extensible Provisioning Protocol June 14, 2001 used to delimit these strings when returning response text via the protocol. Successful command completion responses: Code Response text in US English ___________________________________ 1000 "Command completed successfully" This is the nominal response code for a successfully completed command. This response code MUST be returned in responses for all commands other than for the situations relating to the , , and commands as described here. 1300 "Command completed successfully; no messages" This response code MUST be returned when responding to a request command and the server message queue is empty. 1301 This response code MUST be returned when returning a service message to a client. Message text for this response code is a matter of server policy and is not specified by this protocol. 1500 "Command completed successfully; ending session" This response code MUST be returned when responding to a successful command. Command error responses: Code Response text in US English ___________________________________ 2000 "Unknown command" This response code MUST be returned when a server receives a command element that is not defined by EPP. 2001 "Command syntax error" This response code MUST be returned when a server receives an improperly formed command element. 2002 "Command use error" This response code MUST be returned when a server receives a properly formed command element, but the command can not be executed due to a sequencing or context error. For example, a command can not be executed without having first completed a command. 2003 "Required parameter missing" This response code MUST be returned when a server receives a command Hollenbeck Expires December 14, 2001 [Page 40] Internet-Draft Extensible Provisioning Protocol June 14, 2001 for which a required parameter value has not been provided. 2004 "Parameter value range error" This response code MUST be returned when a server receives a command parameter whose value is outside the range of values specified by the protocol. The error value SHOULD be returned via a element in the EPP response. 2005 "Parameter value syntax error" This response code MUST be returned when a server receives a command containing a parameter whose value is improperly formed. The error value SHOULD be returned via a element in the EPP response. 2100 "Unimplemented protocol version" This response code MUST be returned when a server receives a command element specifying a protocol version that is not implemented by the server. 2101 "Unimplemented command" This response code MUST be returned when a server receives a valid EPP command element that is not implemented by the server. For example, a command MAY be unimplemented for certain object types. 2102 "Unimplemented option" This response code MUST be returned when a server receives a valid EPP command element that contains a protocol option that is not implemented by the server. For example, a server MAY not implement the protocol's session-less operating mode. 2103 "Unimplemented extension" This response code MUST be returned when a server receives a valid EPP command element that contains a protocol command extension that is not implemented by the server. 2104 "Billing failure" This response code MUST be returned when a server attempts to execute a billable operation and the command can not be completed due to a client billing failure. 2105 "Object is not eligible for renewal" This response code MUST be returned when a client attempts to an object that is not eligible for renewal in accordance with server policy. 2106 "Object is not eligible for transfer" This response code MUST be returned when a client attempts to an object that is not eligible for transfer in accordance Hollenbeck Expires December 14, 2001 [Page 41] Internet-Draft Extensible Provisioning Protocol June 14, 2001 with server policy. 2200 "Authentication error" This response code MUST be returned when a server notes an error when validating client credentials. 2201 "Authorization error" This response code MUST be returned when a server notes a client authorization error when executing a command. This error is used to note that a client lacks privileges to execute the requested command. 2202 "Invalid authorization identifier" This response code MUST be returned when a server receives an invalid command authorization identifier required to confirm authorization to execute a command. This error is used to note that a client has the privileges required to execute the requested command, but the authorization identifier provided by the client does not match the authorization identifier archived by the server. 2300 "Object pending transfer" This response code MUST be returned when a server receives a command to transfer an object that is pending transfer due to an earlier transfer request. 2301 "Object not pending transfer" This response code MUST be returned when a server receives a command to confirm, reject, or cancel the transfer an object when no command has been made to transfer the object. 2302 "Object exists" This response code MUST be returned when a server receives a command to create an object that already exists in the repository. 2303 "Object does not exist" This response code MUST be returned when a server receives a command to transform an object that does not exist in the repository. 2304 "Object status prohibits operation" This response code MUST be returned when a server receives a command to transform an object that can not be completed due to server policy or business practices. For example, a server MAY disallow commands under terms and conditions that are matters of local policy, or the server may have received a command for an object whose status prohibits deletion. 2305 "Object association prohibits operation" This response code MUST be returned when a server receives a command to transform an object that can not be completed due to dependencies Hollenbeck Expires December 14, 2001 [Page 42] Internet-Draft Extensible Provisioning Protocol June 14, 2001 on other objects that are associated with the target object. For example, a server MAY disallow commands while an object has active associations with other objects. 2306 "Parameter value policy error" This response code MUST be returned when a server receives a command containing a parameter value that is syntactically valid, but semantically invalid due to local policy. For example, the server MAY support a subset of a range of valid protocol parameter values. The error value SHOULD be returned via a element in the EPP response. 2307 "Unimplemented object service" This response code MUST be returned when a server receives a command to operate on an object service that is not supported by the server. 2308 "Data management policy violation" This response code MUST be returned when a server receives a command whose execution results in a violation of server data management policies. For example, removing all attribute values or object associations from an object MAY be a violation of a server's data management policies. 2400 "Command failed" This response code MUST be returned when a server is unable to execute a command due to an internal server error that is not related to the protocol. The failure MAY be transient. The server MUST keep any ongoing session active. 2500 "Command failed; server ending session" This response code MUST be returned when a server receives a command that can not be completed due to an internal server error that is not related to the protocol. The failure is not transient, and will cause other commands to fail as well. The server MUST end any ongoing active session. 2501 "Timeout; server ending session" This response code MUST be returned when a server receives a command that can not be completed due to a session-oriented timeout. 2502 "Session limit exceeded; server closing connection" This response code MUST be returned when a server receives a command, and the command can not be completed because the client has exceeded a system-defined limit on the number of sessions that the client can establish. It may be possible to establish a session by ending existing unused sessions. Hollenbeck Expires December 14, 2001 [Page 43] Internet-Draft Extensible Provisioning Protocol June 14, 2001 4. Formal Syntax EPP is specified in XML Schema notation. The formal syntax presented here is a complete schema representation of EPP suitable for automated validation of EPP XML instances. Two schemas are presented here. The first schema is the base EPP schema. The second schema defines elements and structures that MAY be used by both the base EPP schema and object mapping schemas. 4.1 Base Schema Extensible Provisioning Protocol v1.0 schema. Hollenbeck Expires December 14, 2001 [Page 44] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Hollenbeck Expires December 14, 2001 [Page 45] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Hollenbeck Expires December 14, 2001 [Page 46] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Hollenbeck Expires December 14, 2001 [Page 47] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Hollenbeck Expires December 14, 2001 [Page 48] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Hollenbeck Expires December 14, 2001 [Page 49] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Hollenbeck Expires December 14, 2001 [Page 50] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Hollenbeck Expires December 14, 2001 [Page 51] Internet-Draft Extensible Provisioning Protocol June 14, 2001 4.2 Shared Structure Schema Extensible Provisioning Protocol v1.0 shared structures schema. Hollenbeck Expires December 14, 2001 [Page 52] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Hollenbeck Expires December 14, 2001 [Page 53] Internet-Draft Extensible Provisioning Protocol June 14, 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. EPP includes a provision for returning a human-readable message with every result code. This document describes result codes in English, but the actual text returned with a result MAY be provided in a language negotiated when a session is established. Languages other than English MUST be noted through specification of a "lang" attribute for each message. Valid values for the "lang" attribute and "lang" negotiation elements are described in [RFC3066] and [ISO639]. 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. Both extended and truncated date and time forms defined in [ISO8601] MAY be used, though a server SHOULD use one form or the other consistently. Hollenbeck Expires December 14, 2001 [Page 54] Internet-Draft Extensible Provisioning Protocol June 14, 2001 6. IANA Considerations XML schemas require a URI for unique identification. Schemas MUST be registered to ensure URI uniqueness, but the IETF does not currently have a recommended repository for the registration of XML schemas. This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism described in [IANA-XML]. IANA SHOULD maintain a registry of XML namespace and schema URI assignments. URI assignment requests SHOULD be reviewed by a designated expert, and values SHOULD be assigned only as a result of standards action taken by the IESG. This document requests assignment of the following URIs: urn:iana:xml:ns:epp: The XML namespace URI for EPP. urn:iana:xml:xmlschema:epp: The XML Schema URI for EPP. urn:iana:xml:ns:eppcom: The XML namespace URI for EPP shared structures. urn:iana:xml:xmlschema:eppcom: The XML Schema URI for EPP shared structures. Hollenbeck Expires December 14, 2001 [Page 55] Internet-Draft Extensible Provisioning Protocol June 14, 2001 7. Security Considerations EPP provides only simple client authentication services. A passive attack is sufficient to recover client identifiers and passwords, allowing trivial command forgery. Protection against most common attacks and more robust security services MUST be provided by other protocol layers. EPP uses a variant of the PLAIN SASL mechanism described in [RFC2595] to provide a simple application-layer authentication service. Where the PLAIN SASL mechanism specifies provision of an authorization identifier, authentication identifier, and password as a single string separated by ASCII NUL characters, EPP specifies use of a combined authorization and authentication identifier and a password provided as distinct XML elements. Repeated password guessing attempts can be discouraged by limiting the number of attempts that can be attempted on an open connection. A server SHOULD close an open connection if three attempts are made with either an invalid client identifier, an invalid password, or both an invalid client identifier and an invalid password. EPP uses authentication information associated with objects to confirm object transfer authority. Authentication information exchanged between EPP clients and third party entities MUST be exchanged using a facility that provides privacy and integrity services to protect against unintended disclosure and modification while in transit. Hollenbeck Expires December 14, 2001 [Page 56] Internet-Draft Extensible Provisioning Protocol June 14, 2001 8. References [GRRP] S. Hollenbeck: "Generic Registry-Registrar Protocol Requirements", work in progress. [IANA-XML] M. Mealling: "The IANA XML Registry", work in progress. [ISO639] ISO 639:1988 (E/F): "Code for the representation of names of languages - The International Organization for Standardization". [ISO8601] ISO 8601:1988 (E): "Data elements and interchange formats - Information interchange - Representation of dates and times - The International Organization for Standardization". [RFC821] J. Postel: "Simple Mail Transfer Protocol", RFC 821, August 1982. [RFC2119] S. Bradner: "Key Words for Use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [RFC2279] F. Yergeau: "UTF-8, a transformation format of ISO 10646", RFC 2279, January 1998. [RFC2595] C. Newman: "Using TLS with IMAP, POP3 and ACAP", RFC 2595, June 1999. [RFC3023] M. Murata et al.: "XML Media Types", RFC 3023, January 2001. [RFC3066] H. Alvestrand: "Tags for the Identification of Languages", BCP 47, RFC 3066, January 2001. [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. Hollenbeck Expires December 14, 2001 [Page 57] Internet-Draft Extensible Provisioning Protocol June 14, 2001 9. Author's Address Scott Hollenbeck VeriSign Global Registry Services 21345 Ridgetop Circle Dulles, VA 20166-6503 USA shollenbeck@verisign.com Hollenbeck Expires December 14, 2001 [Page 58] Internet-Draft Extensible Provisioning Protocol June 14, 2001 A. Revisions From Previous Version -02 to -03: Modified the abstract to note the major sections of the document. Combined the "XML is case sensitive" words from the "Conventions" and Introduction sections into a single paragraph in the Introduction. Added a "motivation" paragraph to the Introduction section. Changed instances of "SHALL contain" to "contains" to avoid requirement ambiguity. Changed other instances of SHALL to MUST (which are equivalent according to RFC 2119) to use one term consistently. Noted that a ROID MUST also be returned in the response to a command in addition to and responses. Removed response code 1302. Schema changes introduced in the -01 version of this document eliminated the possibility of an empty command, so this error code became unnecessary. Changed "raw Unicode character sets" to "UTF-16" in the Internationalization Considerations section. Modified up multiple error message descriptions to make them easier to understand. Added an appendix to register the application/epp+xml media type. Hollenbeck Expires December 14, 2001 [Page 59] Internet-Draft Extensible Provisioning Protocol June 14, 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 December 14, 2001 [Page 60] Internet-Draft Extensible Provisioning Protocol June 14, 2001 C: Object Mapping Template This appendix describes a recommended outline for documenting the EPP mapping of an object. Documents that describe EPP object mappings SHOULD describe the mapping in a format similar to the one used here. Additional sections are required if the object mapping is written in Internet-Draft or RFC format. 1. Introduction Provide an introduction that describes the object and an overview of the mapping to EPP. 2. Object Attributes Describe the attributes associated with the object, including references to syntax specifications as appropriate. Examples of object attributes include a name or identifier and dates associated with modification events. 3. EPP Command Mapping 3.1 EPP Query Commands 3.1.1 EPP Command Describe the object-specific mappings required to implement the EPP command. Include both sample commands and sample responses. 3.1.2 EPP Command Describe the object-specific mappings required to implement the EPP command. Include both sample commands and sample responses. 3.1.3 EPP Command Describe the object-specific mappings required to implement the EPP command. Include both sample commands and sample responses. 3.1.4 EPP Command Describe the object-specific mappings required to implement the EPP query command. Include both sample commands and sample responses. 3.2 EPP Transform Commands 3.2.1 EPP Command Hollenbeck Expires December 14, 2001 [Page 61] Internet-Draft Extensible Provisioning Protocol June 14, 2001 Describe the object-specific mappings required to implement the EPP command. Include both sample commands and sample responses. Describe the status of the object with respect to time, including expected client and server behavior if a validity period is used. 3.2.2 EPP Command Describe the object-specific mappings required to implement the EPP command. Include both sample commands and sample responses. 3.2.3 EPP Command Describe the object-specific mappings required to implement the EPP command. Include both sample commands and sample responses. 3.2.4 EPP Command Describe the object-specific mappings required to implement the EPP command. Include both sample commands and sample responses. 3.2.5 EPP Command Describe the object-specific mappings required to implement the EPP command. Include both sample commands and sample responses. 4. Formal Syntax Provide the XML schema for the object mapping. An XML DTD MUST NOT be used as DTDs do not provide sufficient support for XML namespaces and strong data typing. Hollenbeck Expires December 14, 2001 [Page 62] Internet-Draft Extensible Provisioning Protocol June 14, 2001 D: Media Type Registration: application/epp+xml MIME media type name: application MIME subtype name: epp+xml Mandatory parameters: none Optional parameters: Same as the charset parameter of application/xml as specified in [RFC3023]. Encoding considerations: Same as the encoding considerations of application/xml as specified in [RFC3023]. Security considerations: This type has all of the security considerations described in [RFC3023] plus the considerations specified in the Security Considerations section of this document. Interoperability considerations: XML has proven to be interoperable across WebDAV clients and servers, and for import and export from multiple XML authoring tools. For maximum interoperability, validating processors are recommended. Although non-validating processors may be more efficient, they are not required to handle all features of XML. For further information, see sub-section 2.9 "Standalone Document Declaration" and section 5 "Conformance" of [XML]. Published specification: This document. Applications which use this media type: EPP is device-, platform-, and vendor-neutral and is supported by multiple service providers. Additional information: If used, magic numbers, fragment identifiers, base URIs, and use of the BOM should be as specified in [RFC3023]. Magic number(s): None. File extension(s): .xml Macintosh File Type Code(s): "TEXT" Person and email address for further information: See the "Author's Address" section of this document. Intended usage: COMMON Author/Change controller: IETF Hollenbeck Expires December 14, 2001 [Page 63]