



                                                                J. Gould
                                                       S. Veeramachaneni
                                                          VeriSign, Inc.
                                                        January 10, 2014


  Whois Info Extension for the Extensible Provisioning Protocol (EPP)
                 verisign_epp-extension_whois-info_v01

Abstract

   This document describes an Extensible Provisioning Protocol (EPP)
   extension mapping for retrieving additional information for a domain
   name, as defined in the EPP domain name mapping, that has
   historically been available only in Whois.

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



Gould & Veeramachaneni    Expires July 14, 2014                 [Page 1]

                               whois-info                   January 2014


   exercise such rights without express permission, authority or license
   secured from the patent, trademark or service mark owner.

Table of Contents

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

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 retrieve additional information for a domain
   name, as defined in the EPP domain name mapping [RFC5731], that has
   historically been available only in Whois [RFC3912].

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



Gould & Veeramachaneni    Expires July 14, 2014                 [Page 2]

                               whois-info                   January 2014


   white space in examples are provided only to illustrate element
   relationships and are not a REQUIRED feature of this protocol.

   "whoisInf-1.0" is used as an abbreviation for
   "http://www.verisign.com/epp/whoisInf-1.0".  The XML namespace prefix
   "whoisInf" 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.

3.1.1.  EPP <check> Command

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

3.1.2.  EPP <info> Command

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

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

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



Gould & Veeramachaneni    Expires July 14, 2014                 [Page 3]

                               whois-info                   January 2014


   Example <info> command with the Whois Info extension:

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

   When an <info> command has been processed successfully, the EPP
   <infData> element MUST contain child elements as described in the EPP
   domain name mapping [RFC5731].  In addition to the EPP response
   element described described in EPP domain name mapping [RFC5731], the
   response MUST contain an <extension> element with a
   <whoisInf:whoisInfData> child element if the <whoisInf:whoisInf>
   command extension was included with a <whoisInf:flag> value of "1" or
   "true".  The <whoisInf:whoisInfData> element contains the following
   child elements:

   <whoisInf:registrar>  element that contains the full name of the
       sponsoring Registrar.
   <whoisInf:whoisServer>  OPTIONAL element element that contains the
       sponsoring Registrar's referral whois server name.
   <whoisInf:url>  OPTIONAL element element that contains the sponsoring
       Registrar's referral URL.
   <whoisInf:irisServer>  OPTIONAL element element that contains the
       sponsoring Registrar's referral IRIS server name.












Gould & Veeramachaneni    Expires July 14, 2014                 [Page 4]

                               whois-info                   January 2014


   Example <info> response with the Whois Info 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:infData
   S:        xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
   S:        <domain:name>example.com</domain:name>
   S:        <domain:roid>EXAMPLE1-VRSN</domain:roid>
   S:        <domain:status s="ok"/>
   S:        <domain:clID>ClientX</domain:clID>
   S:        <domain:crID>ClientY</domain:crID>
   S:        <domain:crDate>2005-11-11T18:09:52.0354Z
   S:        </domain:crDate>
   S:        <domain:authInfo>
   S:          <domain:pw>2fooBAR</domain:pw>
   S:        </domain:authInfo>
   S:      </domain:infData>
   S:    </resData>
   S:    <extension>
   S:      <whoisInf:whoisInfData
   S:        xmlns:whoisInf="http://www.verisign.com/epp/whoisInf-1.0">
   S:        <whoisInf:registrar>Example Registrar Inc.
   S:        </whoisInf:registrar>
   S:        <whoisInf:whoisServer>whois.example.com
   S:        </whoisInf:whoisServer>
   S:        <whoisInf:url>http://www.example.com
   S:        </whoisInf:url>
   S:        <whoisInf:irisServer>iris.example.com
   S:        </whoisInf:irisServer>
   S:      </whoisInf:whoisInfData>
   S:    </extension>
   S:    <trID>
   S:      <clTRID>ABC-12345</clTRID>
   S:      <svTRID>54321-XYZ</svTRID>
   S:    </trID>
   S:  </response>
   S:</epp>

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].



Gould & Veeramachaneni    Expires July 14, 2014                 [Page 5]

                               whois-info                   January 2014


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].

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 does not add any elements to the EPP <update> command
   or <update> response described in the EPP domain name mapping
   [RFC5731].

4.  Formal Syntax

   One schema is presented here that is the Whois Info 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.




Gould & Veeramachaneni    Expires July 14, 2014                 [Page 6]

                               whois-info                   January 2014


4.1.  Whois Info Extension Schema

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

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

     <import namespace="urn:ietf:params:xml:ns:eppcom-1.0"
       schemaLocation="eppcom-1.0.xsd"/>

     <annotation>
        <documentation>
          Extensible Provisioning Protocol v1.0
          extension schema for Whois Info
        </documentation>
     </annotation>

   <!--
   Possible Whois Info extension root elements
   -->
     <element name="whoisInf"
       type="whoisInf:whoisInfType"/>
     <element name="whoisInfData"
       type="whoisInf:whoisInfDataType"/>

   <!--
   Child elements for the <whoisInf> extension which
   is used as an extension to an info command.
   -->
     <complexType name="whoisInfType">
       <sequence>
         <element name="flag" type="boolean"/>
       </sequence>
     </complexType>

   <!--
   Child elements for the <whoisInfData> extension which
   is used as an extension to the info response.
   -->
     <complexType name="whoisInfDataType">
       <sequence>
         <element name="registrar" type="string"/>
         <element name="whoisServer" type="eppcom:labelType"



Gould & Veeramachaneni    Expires July 14, 2014                 [Page 7]

                               whois-info                   January 2014


           minOccurs="0"/>
         <element name="url" type="token"
           minOccurs="0"/>
         <element name="irisServer" type="eppcom:labelType"
           minOccurs="0"/>
       </sequence>
     </complexType>

   </schema>
   END

5.  Change History

5.1.  Version 01

   1.  Initial version of Internet-Draft format of the Whois Info
       Extension, version 1.0.

6.  Security Considerations

   The mapping extensions described in this document do not provide any
   security services beyond those described by EPP [RFC5730] and
   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.

   [RFC3912]  Daigle, L., "WHOIS Protocol Specification", RFC 3912,
              September 2004.

   [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











Gould & Veeramachaneni    Expires July 14, 2014                 [Page 8]

                               whois-info                   January 2014


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

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


   Srikanth Veeramachaneni
   VeriSign, Inc.
   12061 Bluemont Way
   Reston, VA  20190
   US

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

































Gould & Veeramachaneni    Expires July 14, 2014                 [Page 9]
