.au Registry Chris Wright .au Extensions Version 1.1 Anthony Harris Obsoletes: .au Extensions Version 1.0 AusRegistry Pty Ltd Category: .au Registry Service Extensions June 4th, 2007 .au Extensions to the Extensible Provisioning Protocol Status of This Document This document specifies an extension to the EPP protocol for use with the .au 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 .au Registry. Specified in XML, the protocol defines specific object management operations and an extensible framework that maps the protocol extensions to the relevant objects. This document includes a protocol specification, an object mapping template, and an XML media type registration. This document obsoletes the .au Extensions version 1.0. AusRegistry .au Registry Service Extensions [Page 1] .au Extensions 1.1 EPP June 4th, 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. au Extensions . . . . . . . . . . . 16 7.1. au Extensions Command . . . . . . 16 7.2. au Extensions Response . . . . . 18 8. XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . 20 8.1 XML Schema [urn:X-au:params:xml:ns:auext-1.1] . . . . . . . . 20 8.2 XML Schema [urn:X-au:params:xml:ns:audomain-1.0] . . . . . . 25 AusRegistry .au Registry Service Extensions [Page 2] .au Extensions 1.1 EPP June 4th, 2007 1. General This document contains explanations of the relevant commands from the EPP RFCs that are affected by the inclusion of the au 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 .au Registry Service Extensions [Page 3] .au Extensions 1.1 EPP June 4th, 2007 2. EPP All standard EPP elements apply plus: - A element that contains a element that includes the namespace URI representing the .au EPP extensions. Example with .au extensions specified: S: S: S: S: AusRegistry 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-au:params:xml:ns:auext-1.1 S: S: urn:X-au:params:xml:ns:audomain-1.0 S: S: S: S: S: S: S: S: S: S: S: S: S: AusRegistry .au Registry Service Extensions [Page 4] .au Extensions 1.1 EPP June 4th, 2007 3. EPP The login command is not "extended" however the au 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 .au EPP extensions Example EPP Login command with .au extensions specified: C: C: C: C: C: REGISTRAR C: p4ssw0rd! 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-au:params:xml:ns:auext-1.1 C: C: urn:X-au:params:xml:ns:audomain-1.0 C: C: C: C: C: C: 3.2. EPP Response No modifications are required. AusRegistry .au Registry Service Extensions [Page 5] .au Extensions 1.1 EPP June 4th, 2007 4. EPP Extensions are provided to support the ability to view the current .au 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 extensions information specific to the domain. - An element which contains the .au 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. - 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 Registrants name. - An OPTIONAL element that represents the identifier for the eligibility name. AusRegistry .au Registry Service Extensions [Page 6] .au Extensions 1.1 EPP June 4th, 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. Example response for an authorized client: S: S: S: S: S: Command completed successfully S: S: S: S: example.com.au S: D0000003-AR S: S: EXAMPLE S: EXAMPLE S: S: ns1.example.com.au S: ns2.example.com.au S: S: ns1.example.com.au S: ns2.exmaple.com.au 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: RegistrantName Pty. Ltd. S: S: S: 123456789 S: S: Other S: S: Registrant Eligibility S: S: S: 987654321 S: S: 2 S: S: S: S: S: ABC-12345 S: 805 S: S: S: This .au Extension information is only returned to the sponsoring Registrar, all others will receive the response as below: Example response for an unauthorized client: S: S: S: S: S: Command completed successfully S: S: S: S: example.com.au S: D0000003-AR S: Registrar AusRegistry .au Registry Service Extensions [Page 8] .au Extensions 1.1 EPP June 4th, 2007 S: S: S: S: ABC-12345 S: 805 S: S: S: AusRegistry .au Registry Service Extensions [Page 9] .au Extensions 1.1 EPP June 4th, 2007 5. EPP The EPP domain create command is extended to enable the client to supply the required .au 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 .au 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 .au Registry Service Extensions [Page 10] .au Extensions 1.1 EPP June 4th, 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.com.au C: Registrant C: Tech2 C: C: 0192pqow C: C: C: C: C: C: C: C: RegistrantName Pty. Ltd. C: C: C: 123456789 C: C: Other C: C: Registrant Eligibility C: C: C: 987654321 C: C: 2 C: C: C: C: ABC-12345 AusRegistry .au Registry Service Extensions [Page 11] .au Extensions 1.1 EPP June 4th, 2007 C: C: 5.2. EPP Response No modifications neccessary AusRegistry .au Registry Service Extensions [Page 12] .au Extensions 1.1 EPP June 4th, 2007 6. EPP Extensions are provided to enable a client to make "corrections" to domain name .au 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 .au extension information supplied I.E. the entire .au extension unit is one atomic unit. - A element which contains a number of elements that hold the information which is specific to the .au 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 .au Registry Service Extensions [Page 13] .au Extensions 1.1 EPP June 4th, 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.com.au C: C: Tech2 C: C: C: C: C: C: C: New Name C: C: 123456789 C: C: Other C: C: Registrant Eligibility AusRegistry .au Registry Service Extensions [Page 14] .au Extensions 1.1 EPP June 4th, 2007 C: C: 987654321 C: C: 2 C: C: C: Registrant made spelling mistake during registration. C: C: C: C: ABC-12345 C: C: 6.2. EPP Response No modifications necessary AusRegistry .au Registry Service Extensions [Page 15] .au Extensions 1.1 EPP June 4th, 2007 7. au Extensions With this version of the .au extensions an additional command is added to allow a client to request a "transfer of domain registrant". 7.1. au 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 .au Registry Service Extensions [Page 16] .au Extensions 1.1 EPP June 4th, 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.com.au AusRegistry .au Registry Service Extensions [Page 17] .au Extensions 1.1 EPP June 4th, 2007 C: 2000-04-03 C: 2 C: C: C: New Name C: C: C: 123456789 C: C: C: Other C: C: C: Registrant Eligibility C: C: C: 987654321 C; C: 2 C: C: C: Previous registrant has sold the business C: C: C: C: ABC-12345 C: C: C: 7.2. au Extensions Response The following response will be returned from the au 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. - A element that contains the new expiry date of the domain after the registrant transfer. AusRegistry .au Registry Service Extensions [Page 18] .au Extensions 1.1 EPP June 4th, 2007 Example response: S: S: S: S: S: S: Command completed successfully S: S: S: S: domain.com.au S: S: 2005-04-03T22:00:00.0Z S: S: S: S: S: ABC-12345 S: 2389742981742 S: S: S: S: AusRegistry .au Registry Service Extensions [Page 19] .au Extensions 1.1 EPP June 4th, 2007 8. XML Schema 8.1 XML Schema [urn:X-au:params:xml:ns:auext-1.1] Formal Syntax: BEGIN .au Extensions to the Extensible Provisioning Protocol v1.1 schema. AusRegistry .au Registry Service Extensions [Page 20] .au Extensions 1.1 EPP June 4th, 2007 AusRegistry .au Registry Service Extensions [Page 21] .au Extensions 1.1 EPP June 4th, 2007 AusRegistry .au Registry Service Extensions [Page 23] .au Extensions 1.1 EPP June 4th, 2007 AusRegistry .au Registry Service Extensions [Page 24] .au Extensions 1.1 EPP June 4th, 2007 END 8.2 XML Schema [urn:X-au:params:xml:ns:audomain-1.0] Formal Syntax: BEGIN .au Domain Extensions to the Extensible Provisioning Protocol v1.0. schema. AusRegistry .au Registry Service Extensions [Page 26] END AusRegistry .au Registry Service Extensions [Page 27]