.ae Registry Chris Wright .ae Extensions Version 1.0 Anthony Harris AusRegistry Pty Ltd Category: .ae Registry Service Extensions October 1st, 2007 .ae Extensions to the Extensible Provisioning Protocol Status of This Document This document specifies an extension to the EPP protocol for use with the .ae ccTLD Domain Name Registry EPP service. Discussion and suggestions for improvements are welcome. Please refer to AusRegistry for more information on the status of this document. Distribution of this document and use of the protocol extensions defined within is unrestricted and unlimited. Copyright Notice Copyright (C) AusRegistry Pty Ltd (2007). Abstract This document describes application layer client-server protocol extensions for the Extensible Provisioning Protocol as needed for the management of domain objects stored in the .ae Registry. Specified in XML, the protocol defines specific object management operations and an extensible framework that maps the protocol extensions to the relevant objects. AusRegistry International .ae Registry Service Extensions [Page 1] .ae Extensions 1.0 EPP October 1st, 2007 Table of Contents 1. General . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2. EPP . . . . . . . . . . . . . . . . . . . . . . . . 4 3. EPP . . . . . . . . . . . . . . . . . . . . . . . . . 5 3.1. EPP Command . . . . . . . . . . . . . . . . . . . . 5 3.2. EPP Response . . . . . . . . . . . . . . . . . . . . 5 4. EPP . . . . . . . . . . . . . . . . . . . . . . 6 4.1. EPP Command . . . . . . . . . . . . . . . . . 6 4.2. EPP Response . . . . . . . . . . . . . . . . . 6 5. EPP . . . . . . . . . . . . . . . . . . . . . 10 5.1. EPP Command . . . . . . . . . . . . . . . . 10 5.2. EPP Response . . . . . . . . . . . . . . . . 12 6. EPP . . . . . . . . . . . . . . . . . . . . . 13 6.1. EPP Command . . . . . . . . . . . . . . . . 13 6.2. EPP Response . . . . . . . . . . . . . . . . 15 7. ae Extensions . . . . . . . . . . . 16 7.1. ae Extensions Command . . . . . . 16 7.2. ae Extensions Response . . . . . 18 8. XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . 20 8.1 XML Schema [urn:X-ae:params:xml:ns:aeext-1.0] . . . . . . . . 20 8.2 XML Schema [urn:X-ae:params:xml:ns:aedomain-1.0] . . . . . . 25 AusRegistry International .ae Registry Service Extensions [Page 2] .ae Extensions 1.0 EPP October 1st, 2007 1. General This document contains explanations of the relevant commands from the EPP RFCs that are affected by the inclusion of the ae extensions. The use of these extensions by the client/server will be identified in the following commands as explained in the relevant sections below: - - EPP's command response extension framework [EPP RFC4930 2.7.3] is used to extend the following commands: - - And the following responses: - The following additional Protocol Extensions (object/operation extension) [EPP RFC4930 2.7.1] are defined: - AusRegistry International .ae Registry Service Extensions [Page 3] .ae Extensions 1.0 EPP October 1st, 2007 2. EPP All standard EPP elements apply plus: - A element that contains a element that includes the namespace URI representing the .ae EPP extensions. Example with .ae extensions specified: S: S: S: S: AusRegistry International EPP Server S: 2006-02-09T15:42:29.0Z S: S: 1.0 S: en S: urn:ietf:params:xml:ns:domain-1.0 S: urn:ietf:params:xml:ns:contact-1.0 S: urn:ietf:params:xml:ns:host-1.0 S: S: urn:X-ae:params:xml:ns:aeext-1.0 S: urn:X-ae:params:xml:ns:aedomain-1.0 S: S: S: S: S: S: S: S: S: S: S: S: AusRegistry International .ae Registry Service Extensions [Page 4] .ae Extensions 1.0 EPP October 1st, 2007 3. EPP The login command is not "extended" however the ae extensions uri must be specified at time of login. 3.1. EPP Command In addition to the standard EPP elements, an EPP command must also include: - A element that contains a element that includes the namespace URI representing the .ae EPP extensions Example EPP Login command with .ae extensions specified: C: C: C: C: C: REGISTRAR C: p4S5w@Rd! C: C: 1.0 C: en C: C: C: urn:ietf:params:xml:ns:contact-1.0 C: urn:ietf:params:xml:ns:domain-1.0 C: urn:ietf:params:xml:ns:host-1.0 C: C: urn:X-ae:params:xml:ns:aeext-1.0 C: urn:X-ae:params:xml:ns:aedomain-1.0 C: C: C: C: C: 3.2. EPP Response No modifications are required. AusRegistry International .ae Registry Service Extensions [Page 5] .ae Extensions 1.0 EPP October 1st, 2007 4. EPP Extensions are provided to support the ability to view the current .ae information associated with a particular domain stored within the registry system. 4.1. EPP Command No modifications required 4.2. EPP Response In addition to the standard EPP elements found in a response a response should also conform to the following using an element that contains the extension information specific to the domain. - An element which contains the .ae extension information. - An element which contains the following elements: - An element MUST be provided. This element MUST contain an English readable or UTF-8 string for the Registrant's name. - An OPTIONAL element that represents the identifier for the Registrant. This MUST be specified if the eligibilityType element contains the value "Trademark". - The element MUST have a "type" attribute which is the enumeration of valid Registrant ID values specified in this document. The type attribute identifies the type of the Registrant ID specified for the element. - An element MUST be provided. This element MUST be one of the valid eligibility type values specified by this document. - An OPTIONAL element which is only used if different from the Registrant's name. - An OPTIONAL element that represents the identifier for the eligibility name. AusRegistry International .ae Registry Service Extensions [Page 6] .ae Extensions 1.0 EPP October 1st, 2007 - The element MUST have a "type" attribute which is the enumeration of valid eligibility ID values specified in this document. The type attribute identifies the type of the eligibility ID specified for the element. - A element MUST be provided. This element MUST be one of the valid policy reasons specified by this document. Example response for an authorized client: S: S: S: S: S: Command completed successfully S: S: S: S: example.co.ae S: D0000003-AR S: S: EXAMPLE S: EXAMPLE S: S: ns1.example.co.ae S: ns2.example.co.ae S: S: ns1.example.co.ae S: ns2.exmaple.co.ae S: Registrar S: Registrar S: 2006-02-09T15:44:58.0Z S: 2008-02-10T00:00:00.0Z S: S: 0192pqow S: S: S: S: S: S: S: Not Related Ltd S: S: 123456789 S: AusRegistry International .ae Registry Service Extensions [Page 7] .ae Extensions 1.0 EPP October 1st, 2007 S: Trademark (IT) S: Examples Are Us S: 987654321 S: 1 S: S: S: S: S: ABC-12345 S: 805 S: S: S: Limited .ae Extension information is returned to non-sponsoring Registrars: Example response for an unauthorized client: S: S: S: S: S: Command completed successfully S: S: S: S: example.co.ae S: D0000003-AR S: Registrar S: S: S: S: S: S: Example Co Ltd S: S: 123456789 S: S: Trademark (IT) S: Examples Are Us S: 987654321 S: S: S: S: S: ABC-12345 AusRegistry International .ae Registry Service Extensions [Page 8] .ae Extensions 1.0 EPP October 1st, 2007 S: 805 S: S: S: AusRegistry International .ae Registry Service Extensions [Page 9] .ae Extensions 1.0 EPP October 1st, 2007 5. EPP The EPP domain create command is extended to enable the client to supply the required .ae information at time of registration. 5.1. EPP Command In addition to the standard EPP elements found in a command a command should also conform to the following using the element that contains the extension information specific to the domain being created. - A element which contains a number of elements that hold the information which is specific to the .ae name space. - A element which contains the following child elements: - A element MUST be provided. This element MUST contain an english readable string for the Registrants name. - An OPTIONAL element that represents the identifier for the Registrant. - Every element MUST have a "type" attribute which is the enumeration of valid Registrant ID values specified in this document. The type attribute identifies the type of the Registrant ID specified for the element. - An element MUST be provided. This element MUST be one of the valid eligibility type values specified by this document. - An OPTIONAL element which is only used if different from the Registrant's name. - An OPTIONAL element that represents the identifier for the eligibility name. - Every element MUST have a "type" attribute which is the enumeration of valid eligibility ID values specified in this document. The type attribute identifies the type of the eligibility ID specified for the element. AusRegistry International .ae Registry Service Extensions [Page 10] .ae Extensions 1.0 EPP October 1st, 2007 - A element MUST be provided. This element MUST be one of the valid policy reasons specified by this document. Example command: C: C: C: C: C: C: example.co.ae C: Registrant C: Tech2 C: C: 0192pqow C: C: C: C: C: C: C: Unrelated Co Ltd. C: C: 123456789 C: C: Trademark (IT) C: Example Things C: 987654321 C: 1 C: C: C: C: ABC-12345 C: C: AusRegistry International .ae Registry Service Extensions [Page 11] .ae Extensions 1.0 EPP October 1st, 2007 5.2. EPP Response No modifications neccessary AusRegistry International .ae Registry Service Extensions [Page 12] .ae Extensions 1.0 EPP October 1st, 2007 6. EPP Extensions are provided to enable a client to make "corrections" to domain name .ae information as required. 6.1. EPP Command In addition to the standard EPP elements found in a command a command can also conform to the following using the element that contains the extension information to be updated specific to the domain being updated. Note: these elements are equivilent to an EPP "chg" element, meaning that all information will be replaced with the new .ae extension information supplied I.E. the entire .ae extension unit is one atomic unit. - A element which contains a number of elements that hold the information which is specific to the .ae name space: - A element which contains the following child elements: - A element MUST be provided. This element MUST contain an english readable string for the Registrant's name. - An OPTIONAL element that represents the identifier for the Registrant. - Every element MUST have a "type" attribute which is the enumeration of valid Registrant ID values specified in this document. The type attribute identifies the type of the Registrant ID specified for the element. - An element MUST be provided. This element MUST be one of the valid eligibility type values specified by this document. - An OPTIONAL element which is only used if different from the Registrant's name. - An OPTIONAL element that represents the identifier for the eligibility name. AusRegistry International .ae Registry Service Extensions [Page 13] .ae Extensions 1.0 EPP October 1st, 2007 - Every element MUST have a "type" attribute which is the enumeration of valid eligibility ID values specified in this document. The type attribute identifies the type of the eligibility ID specified for the element. - A element MUST be provided. This element MUST be one of the valid policy reasons specified by this document. - A element MUST be provided. This element must contain an explanation as to the prupose of the update. For example a correction of a spelling mistake. It should be noted that these explanations are reviewed by the regulator and this update mechanism is NOT provided to facilitate transfer of registrant. Example command: C: C: C: C: C: C: example.co.ae C: C: Tech2 C: C: C: C: C: C: C: New Name C: C: 123456789 C: C: Trademark (IT) C: Good Example C: 987654321 C: 1 C: C: C: Registrant made spelling mistake during registration. C: C: C: AusRegistry International .ae Registry Service Extensions [Page 14] .ae Extensions 1.0 EPP October 1st, 2007 C: ABC-12345 C: C: 6.2. EPP Response No modifications necessary AusRegistry International .ae Registry Service Extensions [Page 15] .ae Extensions 1.0 EPP October 1st, 2007 7. ae Extensions With this version of the .ae extensions an additional command is added to allow a client to request a "transfer of domain registrant". 7.1. ae Extensions Command This command is used to initiate a transfer of registrant of a domain name. A transfer of domain name from one registrant to another also results in a new license period for the domain name. An command is defined as follows: - An element which contains the following child elements: - An element which contains the following child elements: - An element which contains the following child elements: - An element MUST be provided which specifies the fully qualifed name of the domain of which the registrant should be transfered. - An element MUST be provided which specifies the current expiry date of the domain. - An element that specifies the period for which the new registrant wants the name to be registered - A element that contains the following child elements: - A element MUST be provided. This element MUST contain an english readable string for the Registrant's name. - An OPTIONAL element that represents the identifier for the Registrant. - Every element MUST have a "type" attribute which is the enumeration of valid Registrant ID values specified in this document. The type attribute identifies the type of the Registrant ID specified for the element. AusRegistry International .ae Registry Service Extensions [Page 16] .ae Extensions 1.0 EPP October 1st, 2007 - An element MUST be provided This element MUST be one of the valid eligibility type values specified by this document. - An OPTIONAL element which is only used if different from the Registrant's name. - An OPTIONAL element that represents the identifier for the eligibility name. - Every element MUST have a type" attribute which is the enumeration of valid eligibility ID values specified in this document. The type attribute identifies the type of the eligibility ID specified for the element. - A element MUST be provided. This element MUST be one of the valid policy reasons specified by this document. - A element MUST be provided. This element must contain an explanation as to the purpose of the update For example a correction of a spelling mistake. It should be noted that these explanations are reviewed by the regulator and this update mechanism is NOT provided to facilitate transfer of registrant. - An OPTIONAL element which contains the client supplied identifier for the transaction. Example command: C: C: C: C: C: C: C: domain.co.ae C: 2000-04-03 C: 2 C: C: New Name AusRegistry International .ae Registry Service Extensions [Page 17] .ae Extensions 1.0 EPP October 1st, 2007 C: C: 123456789 C: C: Trademark (IT) C: Registrant Elig C: C: 987654321 C: C: 2 C: C: Previous registrant has sold the business C: C: C: C: ABC-12345 C: C: C: 7.2. ae Extensions Response The following response will be returned from the ae extensions command: - An element that contains the same child elements as the epp:response type does (see EPP RFC). The resData section of this response contains the following: - An element that contains the following child elements: - A element that contains the fully qualified name of the domain which the registrant transfer was applied. - An OPTIONAL element that contains the new expiry date of the domain after the registrant transfer. AusRegistry International .ae Registry Service Extensions [Page 18] .ae Extensions 1.0 EPP October 1st, 2007 Example response: S: S: S: S: S: S: Command completed successfully S: S: S: S: domain.co.ae S: 2005-04-03T22:00:00.0Z S: S: S: S: ABC-12345 S: 2389742981742 S: S: S: S: AusRegistry International .ae Registry Service Extensions [Page 19] .ae Extensions 1.0 EPP October 1st, 2007 8. XML Schema 8.1 XML Schema [urn:X-ae:params:xml:ns:aeext-1.0] Formal Syntax: BEGIN .ae Extensions to the Extensible Provisioning Protocol v1.0 schema. AusRegistry International .ae Registry Service Extensions [Page 20] .ae Extensions 1.0 EPP October 1st, 2007 AusRegistry International .ae Registry Service Extensions [Page 21] .ae Extensions 1.0 EPP October 1st, 2007 AusRegistry International .ae Registry Service Extensions [Page 23] .ae Extensions 1.0 EPP October 1st, 2007 AusRegistry International .ae Registry Service Extensions [Page 24] .ae Extensions 1.0 EPP October 1st, 2007 END 8.2 XML Schema [urn:X-ae:params:xml:ns:aedomain-1.0] Formal Syntax: BEGIN AusRegistry International .ae Registry Service Extensions [Page 25] .ae Extensions 1.0 EPP October 1st, 2007 .ae Domain Extensions to the Extensible Provisioning Protocol v1.0. schema. AusRegistry International .ae Registry Service Extensions [Page 26] .ae Extensions 1.0 EPP October 1st, 2007 END AusRegistry International .ae Registry Service Extensions [Page 27]