


VeriSign Inc. Proprietary Information                           J. Gould
                                                                 M. Jain
                                                          VeriSign, Inc.
                                                        January 10, 2014


Premium Domain Extension for the Extensible Provisioning Protocol (EPP)

Abstract

   This document describes an Extensible Provisioning Protocol (EPP)
   extension mapping for the management of premium domain names.

Legal Disclaimer

   COPYRIGHT NOTIFICATION

   Copyright 2014 VeriSign, Inc. All rights reserved.  VERISIGN; the
   Verisign logo; and other trademarks, service marks and Verisign
   designs are registered or unregistered trademarks of VeriSign Inc.
   and its subsidiaries in the United States and foreign countries.
   Copyright laws and international treaties protect this document, and
   any Verisign product to which it relates.

   VERISIGN PROPRIETARY INFORMATION

   This document is the property of VeriSign, Inc. and its subsidiaries
   (together "Verisign") It may be used by recipient only for the
   purpose for which it was transmitted and must be returned upon
   request or when no longer needed by recipient.  It may not be copied
   or communicated without the prior written consent of Verisign.

   NOTICE AND CAUTION

   Concerning U.S. Patent or Trademark Rights

   Verisign and other trademarks, service marks and logos are registered
   or unregistered trademarks of Verisign and its subsidiaries in the
   United States and in foreign countries.  The inclusion in this
   document, the associated on-line file or the associated software of
   any information covered by any other patent, trademark or service
   mark rights does not constitute nor imply a grant of or authority to
   exercise, any right or privilege protected by such patent, trademark
   or service mark.  All such rights and privileges are vested in the
   patent, trademark or service mark owner and no other person may
   exercise such rights without express permission, authority or license
   secured from the patent, trademark or service mark owner.




Gould & Jain                                                    [Page 1]

                             premium-domain                 January 2014


Table of Contents

   1.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  3
     1.1.  Conventions Used in This Document  . . . . . . . . . . . .  3
   2.  Object Attributes  . . . . . . . . . . . . . . . . . . . . . .  3
   3.  EPP Command Mapping  . . . . . . . . . . . . . . . . . . . . .  3
     3.1.  EPP Query Commands . . . . . . . . . . . . . . . . . . . .  3
       3.1.1.  EPP <check> Command  . . . . . . . . . . . . . . . . .  4
       3.1.2.  EPP <info> Command . . . . . . . . . . . . . . . . . .  8
       3.1.3.  EPP <transfer> Command . . . . . . . . . . . . . . . .  8
     3.2.  EPP Transform Commands . . . . . . . . . . . . . . . . . .  8
       3.2.1.  EPP <create> Command . . . . . . . . . . . . . . . . .  8
       3.2.2.  EPP <delete> Command . . . . . . . . . . . . . . . . .  8
       3.2.3.  EPP <renew> Command  . . . . . . . . . . . . . . . . .  8
       3.2.4.  EPP <transfer> Command . . . . . . . . . . . . . . . .  9
       3.2.5.  EPP <update> Command . . . . . . . . . . . . . . . . .  9
   4.  Formal Syntax  . . . . . . . . . . . . . . . . . . . . . . . . 10
     4.1.  Premium Domain Extension Schema  . . . . . . . . . . . . . 10
   5.  Change History . . . . . . . . . . . . . . . . . . . . . . . . 12
     5.1.  Version 00 . . . . . . . . . . . . . . . . . . . . . . . . 12
   6.  Security Considerations  . . . . . . . . . . . . . . . . . . . 12
   7.  Normative References . . . . . . . . . . . . . . . . . . . . . 13
   Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 13




























Gould & Jain                                                    [Page 2]

                             premium-domain                 January 2014


1.  Introduction

   This document describes an extension mapping for version 1.0 of the
   Extensible Provisioning Protocol (EPP) [RFC5730].  This EPP extension
   enables a client to manage premium domain names as an extension of
   the EPP domain name mapping [RFC5731].

1.1.  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 RFC 2119 [RFC2119].

   XML is case sensitive.  Unless stated otherwise, XML specifications
   and examples provided in this document MUST be interpreted in the
   character case presented in order to develop a conforming
   implementation.

   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 are provided only to illustrate element
   relationships and are not a REQUIRED feature of this protocol.

   "premiumdomain-1.0" is used as an abbreviation for
   "http://www.verisign.com/epp/premiumdomain-1.0".  The XML namespace
   prefix "premiumdomain" is used, but implementations MUST NOT depend
   on it and instead employ a proper namespace-aware XML parser and
   serializer to interpret and output the XML documents.


2.  Object Attributes

   This extension adds additional elements to the EPP domain name
   mapping [RFC5731].  Only those new elements are described here.


3.  EPP Command Mapping

   A detailed description of the EPP syntax and semantics can be found
   in the EPP core protocol specification [RFC5730].

3.1.  EPP Query Commands

   EPP provides three commands to retrieve object information: <check>
   to determine if an object is known to the server, <info> to retrieve
   detailed information associated with an object, and <transfer> to
   retrieve object transfer status information.




Gould & Jain                                                    [Page 3]

                             premium-domain                 January 2014


3.1.1.  EPP <check> Command

   This extension defines additional elements to extend the EPP <check>
   command described in EPP domain name mapping [RFC5731].

   The EPP <check> command is used to determine if an object can be
   provisioned within a repository.  In addition to the EPP command
   elements described in [RFC5731], the command MUST contain an
   <extension> element.  The <extension> element MUST contain a child
   <premiumdomain:check> element that contains the following child
   element:

   <premiumdomain:flag>  element that MUST contain a boolean value of
       "1" or "true" to indicate that additional premium information is
       desired in the response or a value of "0" or "false" to indicate
       that no additional premium information is desired in the
       response.

   Example single domain <check> command with the premium domain
   extension:

   C:<?xml version="1.0" encoding="UTF-8"?>
   C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
   C:  <command>
   C:    <check>
   C:      <domain:check
   C:        xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
   C:        <domain:name>EXAMPLE1.TLD</domain:name>
   C:      </domain:check>
   C:    </check>
   C:    <extension>
   C:    <premiumdomain:check
   C:      xmlns:premiumdomain=
   C:        "http://www.verisign.com/epp/premiumdomain-1.0">
   C:      <premiumdomain:flag>1</premiumdomain:flag>
   C:    </premiumdomain:check>
   C:    </extension>
   C:    <clTRID>ABC-12345</clTRID>
   C:  </command>
   C:</epp>











Gould & Jain                                                    [Page 4]

                             premium-domain                 January 2014


   Example multiple domain <check> command with the premium domain
   extension:

   C:<?xml version="1.0" encoding="UTF-8"?>
   C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
   C:  <command>
   C:    <check>
   C:      <domain:check
   C:        xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
   C:        <domain:name>EXAMPLE1.TLD</domain:name>
   C:        <domain:name>EXAMPLE2.TLD</domain:name>
   C:        <domain:name>EXAMPLE3.TLD</domain:name>
   C:      </domain:check>
   C:    </check>
   C:    <extension>
   C:    <premiumdomain:check
   C:      xmlns:premiumdomain=
   C:        "http://www.verisign.com/epp/premiumdomain-1.0">
   C:      <premiumdomain:flag>1</premiumdomain:flag>
   C:    </premiumdomain:check>
   C:    </extension>
   C:    <clTRID>ABC-12345</clTRID>
   C:  </command>
   C:</epp>

   When a <check> command has been processed successfully, the EPP
   <chkData> element MUST contain child elements as described in
   [RFC5731].  In addition to the EPP response element described in
   [RFC5731], the response MUST contain an <extension> element with a
   <premiumdomain:chkData> child element if the <premiumdomain:check>
   command extension was included with a <premiumdomain:flag> value of
   "1" or "true".  The <premiumdomain:chkData> element contains one or
   more >premiumdomain:cd> elements that contain the following child
   elements:

   <premiumdomain:name>  element that contains the fully qualified name
       of the queried domain object.  This element MUST contain a
       "premium" attribute whose value indicates if an object is premium
       at the moment the <check> command was completed.  A value of "1"
       or "true" means that the object is premium object.  A value of
       "0" or "false" means that the object is not a premium object.
   <premiumdomain:price>  OPTIONAL element that contains the premium
       price associated with this object.  This element MUST contain a
       "unit" attribute whose value indicates the unit of price.  The
       default price unit is "USD" (US Dollar).  The <premiumdomain:
       price> element is included only if the client is authorized based
       on server policy, the object is a premium object, and the object
       is available for provisioning at the moment the <check> command



Gould & Jain                                                    [Page 5]

                             premium-domain                 January 2014


       was completed.
   <premiumdomain:renewalPrice>  OPTIONAL element that contains the
       premium renewal price associated with this object.  This element
       MUST contain a "unit" attribute whose value indicates the unit of
       price.  The default price unit is "USD" (US Dollar).  The
       <premiumdomain:renewalPrice> element is included only if the
       client is authorized based on server policy, the object is a
       premium object, and the object is available for provisioning at
       the moment the <check> command was completed.

   Example single domain <check> response with the premium domain
   extension:

   S:<?xml version="1.0" encoding="UTF-8"?>
   S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
   S:  <response>
   S:    <result code="1000">
   S:      <msg>Command completed successfully</msg>
   S:    </result>
   S:    <resData>
   S:      <domain:chkData
   S:        xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
   S:        <domain:cd>
   S:          <domain:name avail="1">EXAMPLE.TLD</domain:name>
   S:        </domain:cd>
   S:      </domain:chkData>
   S:    </resData>
   S:    <extension>
   S:      <premiumdomain:chkData
   S:        xmlns:premiumdomain=
   S:          "http://www.verisign.com/epp/premiumdomain-1.0">
   S:        <premiumdomain:cd>
   S:          <premiumdomain:name premium="1">EXAMPLE.TLD
   S:          </premiumdomain:name>
   S:          <premiumdomain:price unit="USD">125.00
   S:          </premiumdomain:price>
   S:          <premiumdomain:renewalPrice unit="USD">75.00
   S:          </premiumdomain:renewalPrice>
   S:        </premiumdomain:cd>
   S:      </premiumdomain:chkData>
   S:    </extension>
   S:    <trID>
   S:      <clTRID>ABC-12345</clTRID>
   S:      <svTRID>54321-XYZ</svTRID>
   S:    </trID>
   S:  </response>
   S:</epp>




Gould & Jain                                                    [Page 6]

                             premium-domain                 January 2014


   Example multiple domain <check> response with the premium domain
   extension:

   S:<?xml version="1.0" encoding="UTF-8"?>
   S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
   S:  <response>
   S:    <result code="1000">
   S:      <msg>Command completed successfully</msg>
   S:    </result>
   S:    <resData>
   S:      <domain:chkData
   S:        xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
   S:        <domain:cd>
   S:          <domain:name avail="1">EXAMPLE1.TLD</domain:name>
   S:        </domain:cd>
   S:        <domain:cd>
   S:          <domain:name avail="0">EXAMPLE2.TLD</domain:name>
   S:        </domain:cd>
   S:        <domain:cd>
   S:          <domain:name avail="1">EXAMPLE3.TLD</domain:name>
   S:        </domain:cd>
   S:      </domain:chkData>
   S:    </resData>
   S:    <extension>
   S:    <premiumdomain:chkData
   S:      xmlns:premiumdomain=
   S:        "http://www.verisign.com/epp/premiumdomain-1.0">
   S:      <premiumdomain:cd>
   S:        <premiumdomain:name premium="1">EXAMPLE1.TLD
   S:        </premiumdomain:name>
   S:        <premiumdomain:price unit="USD">125.00
   S:        </premiumdomain:price>
   S:        <premiumdomain:renewalPrice unit="USD">75.00
   S:        </premiumdomain:renewalPrice>
   S:      </premiumdomain:cd>
   S:      <premiumdomain:cd>
   S:        <premiumdomain:name premium="1">EXAMPLE2.TLD
   S:        </premiumdomain:name>
   S:      </premiumdomain:cd>
   S:      <premiumdomain:cd>
   S:        <premiumdomain:name premium="1">EXAMPLE3.TLD
   S:        </premiumdomain:name>
   S:        <premiumdomain:price unit="USD">125.00
   S:        </premiumdomain:price>
   S:        <premiumdomain:renewalPrice unit="USD">75.00
   S:        </premiumdomain:renewalPrice>
   S:      </premiumdomain:cd>
   S:    </premiumdomain:chkData>



Gould & Jain                                                    [Page 7]

                             premium-domain                 January 2014


   S:    </extension>
   S:    <trID>
   S:      <clTRID>ABC-12345</clTRID>
   S:      <svTRID>54321-XYZ</svTRID>
   S:    </trID>
   S:  </response>
   S:</epp>

3.1.2.  EPP <info> Command

   This extension does not add any elements to the EPP <info> command or
   <info> response described in the EPP domain name mapping [RFC5731].

3.1.3.  EPP <transfer> Command

   This extension does not add any elements to the EPP <transfer>
   command or <transfer> response described in the EPP domain name
   mapping [RFC5731].

3.2.  EPP Transform Commands

   EPP provides five commands to transform objects: <create> to create
   an instance of an object, <delete> to delete an instance of an
   object, <renew> to extend the validity period of an object,
   <transfer> to manage object sponsorship changes, and <update> to
   change information associated with an object.

3.2.1.  EPP <create> Command

   This extension does not add any elements to the EPP <create> command
   or <create> response described in the EPP domain name mapping
   [RFC5731].

3.2.2.  EPP <delete> Command

   This extension does not add any elements to the EPP <delete> command
   or <delete> response described in the EPP domain name mapping
   [RFC5731].

3.2.3.  EPP <renew> Command

   This extension does not add any elements to the EPP <renew> command
   or <renew> response described in the EPP domain name mapping
   [RFC5731].







Gould & Jain                                                    [Page 8]

                             premium-domain                 January 2014


3.2.4.  EPP <transfer> Command

   This extension does not add any elements to the EPP <transfer>
   command or <transfer> response described in the EPP domain name
   mapping [RFC5731].

3.2.5.  EPP <update> Command

   This extension defines additional elements to extend the EPP <update>
   command described in EPP domain name mapping [RFC5731].

   The EPP <update> command is used to update information associated
   with a domain object.  In addition to the EPP command elements
   described in [RFC5731], the command MUST contain an <extension>
   element.  The <extension> element MUST contain a child
   <premiumdomain:reassign> element that contains the following child
   element

   <premiumdomain:shortName>  element that MUST contain a shortname of a
       registrar to whom the current domain name needs to be reassigned.

   Example <update> command:

   C:<?xml version="1.0" encoding="UTF-8"?>
   C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
   C:  <command>
   C:    <update>
   C:      <domain:update
   C:        xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
   C:        <domain:name>EXAMPLE1.TLD/domain:name>
   C:      </domain:update>
   C:    </update>
   C:    <extension>
   C:      <premiumdomain:reassign
   C:        xmlns:premiumdomain=
   C:          "http://www.verisign.com/epp/premiumdomain-1.0">
   C:        <premiumdomain:shortName>testregistrar
   C:        </premiumdomain:shortName>
   C:      </premiumdomain:reassign>
   C:    </extension>
   C:    <clTRID>ABC-12345-XYZ</clTRID>
   C:  </command>
   C:</epp>

   When an <update> command has been processed successfully, the
   response contains the standard EPP update response elements.





Gould & Jain                                                    [Page 9]

                             premium-domain                 January 2014


   Example <update> response:

   S:<?xml version="1.0" encoding="UTF-8"?>
   S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
   S:  <response>
   S:    <result code="1000">
   S:      <msg>Command completed successfully</msg>
   S:    </result>
   S:    <trID>
   S:      <clTRID>ABC-12345-XYZ</clTRID>
   S:      <svTRID>54321-XYZ</svTRID>
   S:    </trID>
   S:  </response>
   S:</epp>


4.  Formal Syntax

   One schema is presented here that is the Premium Domain Extension
   schema.

   The formal syntax presented here is a complete schema representation
   of the object mapping suitable for automated validation of EPP XML
   instances.  The BEGIN and END tags are not part of the schema; they
   are used to note the beginning and ending of the schema for URI
   registration purposes.

4.1.  Premium Domain Extension Schema

   BEGIN
   <?xml version="1.0" encoding="UTF-8"?>

   <schema targetNamespace=
     "http://www.verisign.com/epp/premiumdomain-1.0"
     xmlns:premiumdomain="http://www.verisign.com/epp/premiumdomain-1.0"
     xmlns:eppcom="urn:ietf:params:xml:ns:eppcom-1.0"
     xmlns="http://www.w3.org/2001/XMLSchema"
     elementFormDefault="qualified">

   <!-- Import common element types. -->
   <import namespace="urn:ietf:params:xml:ns:eppcom-1.0"/>

   <annotation>
     <documentation>
       Extensible Provisioning Protocol v1.0
       Extension schema for Premium Domain
     </documentation>
   </annotation>



Gould & Jain                                                   [Page 10]

                             premium-domain                 January 2014


   <!-- Premium Domain check command extension root element -->
   <element name="check"
     type="premiumdomain:chkType"/>

   <!-- Premium Domain check response extension root element -->
   <element name="chkData"
     type="premiumdomain:chkDataType"/>

   <!-- Premium Domain reassign command extension root element -->
   <element name="reassign"
     type="premiumdomain:reassignType"/>

   <!-- <premiumdomain:check> command extension -->
   <complexType name="chkType">
     <sequence>
       <element name="flag"
         type="boolean" minOccurs="1" maxOccurs="1" />
     </sequence>
   </complexType>

   <!-- <premiumdomain:chkData> response extension -->
   <complexType name="chkDataType">
     <sequence>
       <element name="cd"
         type="premiumdomain:checkType" maxOccurs="unbounded"/>
     </sequence>
   </complexType>

   <!-- <premiumdomain:reassign> command extension -->
   <complexType name="reassignType">
     <sequence>
         <element name="shortName"
           type="eppcom:labelType" minOccurs="1" maxOccurs="1" />
     </sequence>
   </complexType>

   <complexType name="checkType">
     <sequence>
       <element name="name"
         type="premiumdomain:checkNameType"/>
       <element name="price" type="premiumdomain:priceType"
         minOccurs="0" maxOccurs="1" />
       <element name="renewalPrice" type="premiumdomain:priceType"
         minOccurs="0" maxOccurs="1" />
     </sequence>
   </complexType>

   <complexType name="checkNameType">



Gould & Jain                                                   [Page 11]

                             premium-domain                 January 2014


     <simpleContent>
       <extension base="eppcom:labelType">
         <attribute name="premium"
           type="boolean" use="required"/>
       </extension>
     </simpleContent>
   </complexType>

   <complexType name="priceType">
     <simpleContent>
       <extension base="premiumdomain:priceFormatType">
         <attribute name="unit"
           type="premiumdomain:priceUnitType" use="required"/>
       </extension>
     </simpleContent>
   </complexType>

   <!-- Price type restricted to include two decimal places -->
   <simpleType name="priceFormatType">
     <restriction base="decimal">
       <fractionDigits value="2"/>
       <minInclusive value="0.00"/>
     </restriction>
   </simpleType>

   <!-- Price unit type -->
   <simpleType name="priceUnitType">
     <restriction base="token">
       <enumeration value="USD"/>
     </restriction>
   </simpleType>

   </schema>
   END


5.  Change History

5.1.  Version 00

   1.  Initial version of Internet-Draft format of the Premium Domain
       Extension, version 2.1.


6.  Security Considerations

   The mapping extensions described in this document do not provide any
   security services beyond those described by EPP [RFC5730] and



Gould & Jain                                                   [Page 12]

                             premium-domain                 January 2014


   protocol layers used by EPP.  The security considerations described
   in these other specifications apply to this specification as well.


7.  Normative References

   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
              Requirement Levels", BCP 14, RFC 2119, March 1997.

   [RFC5730]  Hollenbeck, S., "Extensible Provisioning Protocol (EPP)",
              STD 69, RFC 5730, August 2009.

   [RFC5731]  Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
              Domain Name Mapping", STD 69, RFC 5731, August 2009.


Authors' Addresses

   James Gould
   VeriSign, Inc.
   12061 Bluemont Way
   Reston, VA  20190
   US

   Email: jgould@verisign.com
   URI:   http://www.verisigninc.com


   Mahendra Jain
   VeriSign, Inc.
   12061 Bluemont Way
   Reston, VA  20190
   US

   Email: majain@verisign.com
   URI:   http://www.verisigninc.com















Gould & Jain                                                   [Page 13]

