| Network Working Group | A.L. Newton |
| Internet-Draft | ARIN |
| Intended status: Standards Track | S. Hollenbeck |
| Expires: March 21, 2013 | Verisign Labs |
| September 19, 2012 |
JSON Responses for the Registy Data Access Protocol (RDAP)
draft-ietf-weirds-json-response-00
This document describes responses in the JSON format to the Registry Data Access Protocol (RDAP) queries described in draft-ietf-weirds-rdap-query.
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at http:/⁠/⁠datatracker.ietf.org/⁠drafts/⁠current/⁠.
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."
This Internet-Draft will expire on March 21, 2013.
Copyright (c) 2012 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http:/⁠/⁠trustee.ietf.org/⁠license-⁠info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
This document describes responses in the JSON [RFC4627] format for the RESTful web queries as defined by UNIFIED-RDAP-QUERY [I-D.ietf-weirds-rdap-query]. The signalling for JSON, JSON naming scheme, JSON namespace and extension mechanism and normalized references to other specifications are documented in RDAP-HTTP [I-D.ietf-weirds-using-http].
The data model for the responses consists of two major categories: responses returned by Regional Internet Registries (RIRs) for registrations data related to IP addresses, reverse DNS names, and Autonomous System numbers; and responses returned by Domain Name Registries (DNRs) for registration data related to forward DNS names. Where overlap exists between RIR and DNR reponse object classes, the RIR object classes are a proper subset of the DNR object classes. The current division between RIR and DNR object classes is given to illustrate an expectation of what data may be expected from an RIR vs a DNR. However, implementers should be aware that RIRs are not limited to the data in the RIR object classes (as an example, some RIRs have a notion of "status" for entities as defined in the DNR entity object class and may at some point start publishing that data).
Object classes defined in this document do not represent the full range of data that any registry may wish to publish. RDAP-HTTP [I-D.ietf-weirds-using-http] defines a JSON extension mechanism that maybe used by registries to insert registry specific data values.
The following list describes terminology and definitions used throughout this document:
JSON [RFC4627] defines the data types of a number, character string, boolean, array, object and null. This section describes the semantics and/or syntax reference for data types used in this document derived from the JSON character string.
The entity object class appears throughout this document and is an appropriate response for the /entity/XXXX query defined in UNIFIED-RDAP-QUERY [I-D.ietf-weirds-rdap-query]. This object class represents the information of organizations, corporations, governments, non-profits, clubs, individual persons, and informal groups of people. All of these representations are so similar that it is best to represent them in JSON [RFC4627] with one construct, the entity object class, to aid in the re-use of code by implementers.
Many of the members of the entity object class are repeated in other object classes described later in this document.
The following is an example of an RIR entity:
{
"handle" : "XXXX",
"names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ],
"roles" : [ "registrant" ],
"postalAddress" :
[
"123 Maple Ave",
"Suite 90001",
"Vancouver",
"BC",
"12393"
],
"emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" :
{
"office" : [ "999-999-999-99", "111-111-111-11" ],
"fax" : [ "222-222-222-22" ],
"mobile" : [ "333-333-333-33" ]
},
"remarks" :
[
"she sells seas shells",
"down by the seashore"
],
"uris" :
[
{
"type" : "source",
"uri" : "http://whois-rws.net/contact/xxxx"
},
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
}
],
"registrationDate" : "1990-12-31T23:59:60Z",
"lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "joe@bob.com"
}
This object as the following members.
The DNR entity object class is a superset of the RIR entity object class [rir_entity_object_class]. It has the following additional members:
The following is an example of a DNR entity:
{
"handle" : "XXXX",
"names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ],
"status" : [ "validated", "locked" ],
"postalAddress" :
[
"123 Maple Ave",
"Suite 90001",
"Vancouver",
"BC",
"12393"
],
"emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" :
{
"office" : [ "999-999-999-99", "111-111-111-11" ],
"fax" : [ "222-222-222-22" ],
"mobile" : [ "333-333-333-33" ]
},
"remarks" :
[
"she sells seas shells",
"down by the seashore"
],
"uris" :
[
{
"type" : "source",
"uri" : "http://whois-rws.net/entity/xxxx"
},
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
}
],
"port43" : "whois.example.net",
"registrationDate" : "1990-12-31T23:59:60Z",
"registrationBy" : "ABC123",
"lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "ABC123",
"sponsoredBy" : "SponsorXYZ",
"resoldBy" : "ResellerPDQ"
}
The nameserver object class is used by both RIRs and DNRs. Unlike other object classes used by both registries where the RIR object class is a subset of the DNR object class, a clear delineation is not made with the nameserver object class because some DNRs have the same or a similar registration model as the RIRs. RIRs and some DNRs register or expose nameserver information as an attribute of a domain name, while other DNRs model nameservers as "first class objects".
The nameserver object class accomodates both models and degrees of variation in between.
The following is an example of a nameserver object.
{
"handle" : "XXXX",
"name" : "ns1.example.com",
"status" : "active",
"ipAddresses" : [ "192.0.2.0", "192.0.2.1" ],
"remarks" :
[
"she sells seas shells",
"down by the seashore"
],
"uris" :
[
{
"type" : "source",
"uri" : "http://example.net/nameserver/xxxx"
}
],
"port43" : "whois.example.net",
"registrationDate" : "1990-12-31T23:59:60Z",
"registrationBy" : "ABC123",
"lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "ABC123",
"sponsoredBy" : "SponsorXYZ",
"resoldBy" : "ResellerPDQ"
}
Figure 1
Figure 1 is an example of a nameserver object with all values given. Registries using a first-class nameserver data model would embed this in domain objects as well as allowing references to it with the /nameserver query type (all depending on the registry operators policy). Other registries may pare back the information as needed. Figure 2 is an example of a nameserver object as would be found in RIRs and some DNRs, while Figure 3 is an example of a nameserver object as would be found in other DNRs.
The following is an example of the simplest nameserver object.
{
"name" : "ns1.example.com"
}
Figure 2
The following is an example of a simple nameserver object that might be commonly used by DNRs.
{
"name" : "ns1.example.com",
"ipAddresses" : [ "192.0.2.0", "192.0.2.1" ]
}
Figure 3
The nameserver object class has the following members: entity object [entity_object_class].
The members "status", "remarks", "uris", "port43", "sponsoredBy", "resoldBy", "registrationBy", "registrationDate", "lastChangedDate", and "lastChangedBy" take the same form of the members of the same name of the
The domain object class represents a DNS name and point of delegation. For RIRs these delegation points are in the reverse DNS tree, whereas for DNRs these delegation points are in the forward DNS tree. The RIR domain object class is a subset of the DNR object class.
In both cases, the high level structure of the domain object class consists of information about the domain registration, nameserver information related to the domain name, and entities related to the domain name (e.g. registrant information, contacts, etc...).
The following is an elided example of the domain object showing the high level structure.
{
"handle" : "XXX",
"name" : "blah.example.com",
...
"nameServers" :
[
...
],
...
"entities" :
[
...
]
}
The following is an example of a JSON object representing a reverse DNS delegation point or the RIR domain object class.
{
"handle" : "XXXX",
"name" : "192.in-addr.arpa",
"nameServers" :
[
{ "name" : "ns1.rir.net" },
{ "name" : "ns2.rir.net" }
],
"delegationKeys" :
[
{
"algorithm": 7,
"digest" : "E68C017BD813B9AE2F4DD28E61AD014F859ED44C",
"digestType" : 1,
"keyTag" : 53814
}
],
"remarks" :
[
"she sells seas shells",
"down by the seashore"
],
"uris" :
[
{
"type" : "source",
"uri" : "http://whois-rws.net/network/xxxx"
},
{
"type" : "parent",
"uri" : "http://whois-rws.net/network/yyyy"
},
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
}
],
"registrationDate" : "1990-12-31T23:59:60Z",
"lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "joe@bob.com",
"entities" :
[
{
"handle" : "XXXX",
"names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ],
"roles" : [ "registrant" ],
"postalAddress" :
[
"123 Maple Ave",
"Suite 90001",
"Vancouver",
"BC",
"12393"
],
"emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" :
{
"office" : [ "999-999-999-99", "111-111-111-11" ],
"fax" : [ "222-222-222-22" ],
"mobile" : [ "333-333-333-33" ]
},
"remarks" :
[
"she sells seas shells",
"down by the seashore"
],
"uris" :
[
{
"type" : "source",
"uri" : "http://whois-rws.net/entity/xxxx"
},
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
}
],
"registrationDate" : "1990-12-31T23:59:60Z",
"lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "joe@bob.com"
}
]
}
The following is a description of the members of this object: entity object [entity_object_class].
The members "remarks", "uris", "registrationDate", "lastChangedDate", and "lastChangedBy" take the same form of the members of the same name of the
The DNR domain object class is a superset of the RIR domain object class [rir_domain_object_class] and has the following additional members.
The following is an example of a JSON object representing a forward DNS delegation point or the DNR domain object class.
{
"handle" : "XXXX",
"name" : "blah.example.com",
"variants" : [ "blah2.example.com", "blah3.example.com" ],
"status" : [ "locked", "transferProhibited" ],
"nameServers" :
[
{
"handle" : "XXXX",
"name" : "ns1.example.com",
"status" : "active",
"ipAddresses" : [ "192.0.2.0", "192.0.2.1" ],
"remarks" :
[
"she sells seas shells",
"down by the seashore"
],
"uris" :
[
{
"type" : "source",
"uri" : "http://example.net/nameserver/xxxx"
}
],
"registrationDate" : "1990-12-31T23:59:60Z",
"registrationBy" : "ABC123",
"lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "ABC123",
"sponsoredBy" : "SponsorXYZ",
"resoldBy" : "ResellerPDQ"
},
{
"handle" : "XXXX",
"name" : "ns2.example.com",
"status" : "active",
"ipAddresses" : [ "192.0.2.2", "192.0.2.3" ],
"remarks" :
[
"she sells seas shells",
"down by the seashore"
],
"uris" :
[
{
"type" : "source",
"uri" : "http://example.net/nameserver/xxxx"
}
],
"registrationDate" : "1990-12-31T23:59:60Z",
"registrationBy" : "ABC123",
"lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "ABC123",
"sponsoredBy" : "SponsorXYZ",
"resoldBy" : "ResellerPDQ"
}
]
"delegationKeys" :
[
{
"algorithm": 7,
"digest" : "E68C017BD813B9AE2F4DD28E61AD014F859ED44C",
"digestType" : 1,
"keyTag" : 53814
}
],
"remarks" :
[
"she sells seas shells",
"down by the seashore"
],
"uris" :
[
{
"type" : "source",
"uri" : "http://example.net/domain/xxxx"
},
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
}
],
"port43" : "whois.example.net",
"registrationDate" : "1990-12-31T23:59:60Z",
"registrationBy" : "ABC123",
"lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "ABC123",
"sponsoredBy" : "SponsorXYZ",
"resoldBy" : "ResellerPDQ",
"expirationDate" : "2016-12-31T23:59:60Z",
"transferDate" : "1990-12-31T23:59:60Z",
"entities" :
[
{
"handle" : "XXXX",
"names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ],
"status" : [ "validated", "locked" ],
"postalAddress" :
[
"123 Maple Ave",
"Suite 90001",
"Vancouver",
"BC",
"12393"
],
"emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" :
{
"office" : [ "999-999-999-99", "111-111-111-11" ],
"fax" : [ "222-222-222-22" ],
"mobile" : [ "333-333-333-33" ]
},
"remarks" :
[
"she sells seas shells",
"down by the seashore"
],
"uris" :
[
{
"type" : "source",
"uri" : "http://whois-rws.net/entity/xxxx"
},
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
}
],
"registrationDate" : "1990-12-31T23:59:60Z",
"registrationBy" : "ABC123",
"lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "ABC123",
"sponsoredBy" : "SponsorXYZ",
"resoldBy" : "ResellerPDQ"
}
]
}
The IP Network object class models IP network registrations found in RIRs and is the expected response for the /ip query as defined by [I-D.ietf-weirds-rdap-query]. There is no equivalent object class for DNRs. The high level structure of the IP network object class consists of information about the network registration and entities related to the IP network (e.g. registrant information, contacts, etc...).
The following is an elided example of the IP network object type showing the high level structure.
{
"handle" : "XXX",
...
"entities" :
[
...
]
}
The following is an example of the JSON object for the network registration information
{
"handle" : "XXXX-RIR",
"startAddress" : "10.0.0.0",
"endAddress" : "10.0.0.255",
"ipVersion" : 4,
"name": "NET-RTR-1",
"description" : [ "A network used for routing" ],
"type" : "DIRECT ALLOCATION",
"country" : "AU",
"parentHandle" : "YYYY-RIR",
"remarks" :
[
"she sells seas shells",
"down by the seashore"
],
"uris" :
[
{
"type" : "source",
"uri" : "http://whois-rws.net/network/xxxx"
},
{
"type" : "parent",
"uri" : "http://whois-rws.net/network/yyyy"
},
],
"registrationDate" : "20110509",
"lastChangedDate" : "20110509",
"lastChangedBy" : "joe@bob.com",
"entities" :
[
{
"handle" : "XXXX",
"names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ],
"roles" : [ "registrant" ],
"postalAddress" :
[
"123 Maple Ave",
"Suite 90001",
"Vancouver",
"BC",
"12393"
],
"emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" :
{
"office" : [ "999-999-999-99", "111-111-111-11" ],
"fax" : [ "222-222-222-22" ],
"mobile" : [ "333-333-333-33" ]
},
"remarks" :
[
"she sells seas shells",
"down by the seashore"
],
"uris" :
[
{
"type" : "source",
"uri" : "http://whois-rws.net/contact/xxxx"
},
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
}
],
"registrationDate" : "1990-12-31T23:59:60Z",
"lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "joe@bob.com"
}
]
}
The following is a description of the members of this object: entity object [rir_entity_object_class].
The members "remarks", "uris", "registrationDate", "lastChangedDate", and "lastChangedBy" take the same form of the members of the same name of the
The Autonomous System Number (autnum) object class models Autonomous System Number registrations found in RIRs and represents the expected response to an /autnum query as defined by [I-D.ietf-weirds-rdap-query]. There is no equivalent object class for DNRs. The high level structure of the autnum object class consists of information about the network registration and entities related to the autnum registration (e.g. registrant information, contacts, etc...), and is similar to the IP Network entity object class.
The following is an example of a JSON object representing an autnum.
{
"handle" : "XXXX-RIR",
"startAutnum" : "10",
"endAutnum" : "15",
"name": "AS-RTR-1",
"description" : [ "AS for Exchange" ],
"type" : "DIRECT ALLOCATION",
"country": "AU",
"remarks" :
[
"she sells seas shells",
"down by the seashore"
],
"uris" :
[
{
"type" : "source",
"uri" : "http://whois-rws.net/autnum/xxxx"
},
{
"type" : "parent",
"uri" : "http://whois-rws.net/autnum/yyyy"
},
{
"type" : "held",
"uri" : "http://example.net/location/xxxx"
}
],
"registrationDate" : "20110509",
"lastChangedDate" : "20110509",
"lastChangedBy" : "joe@bob.com",
"entities" :
[
{
"handle" : "XXXX",
"names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ],
"roles" : [ "registrant" ],
"postalAddress" :
[
"123 Maple Ave",
"Suite 90001",
"Vancouver",
"BC",
"12393"
],
"emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" :
{
"office" : [ "999-999-999-99", "111-111-111-11" ],
"fax" : [ "222-222-222-22" ],
"mobile" : [ "333-333-333-33" ]
},
"remarks" :
[
"she sells seas shells",
"down by the seashore"
],
"uris" :
[
{
"type" : "source",
"uri" : "http://whois-rws.net/autnum/xxxx"
}
],
"registrationDate" : "1990-12-31T23:59:60Z",
"lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "joe@bob.com"
}
]
}
The following is a description of the members of this object: entity object [rir_entity_object_class].
The members "remarks", "uris", "registrationDate", "lastChangedDate", and "lastChangedBy" take the same form of the members of the same name of the
This document is derived from original work on RIR response in JSON by Byron J. Ellacott of APNIC, Arturo L. Servin of LACNIC, Kaveh Ranjbar of the RIPE NCC, and Andrew L. Newton of ARIN. Additionally, this document incorporates word on DNR responses in JSON by Ning Kong, Linlin Zhou, Jiagui Xie, and Sean Shen of CNNIC.
The components of the DNR object classes are derived from a categorization of WHOIS response formats created by Ning Kong, Linlin Zhou, and Guangqing Deng of CNNIC, Steve Sheng and Francisco Arias of ICANN, Ray Bellis of Nominet, and Frederico Neves of NIC.BR.
| [RFC3912] | Daigle, L., "WHOIS Protocol Specification", RFC 3912, September 2004. |
Due to the wide variation between the hundreds of registry operators and the on-going policy refinement by registry communities, values of some data cannot be formally standardized. This section lists suggested values for such data but is not nor will ever be a complete list of values and their meanings.
Many of the object classes have a member named 'status'. This member is an array of strings, with each string denoting a status associated with the containing object. The following is a list of suggested values to use in the 'status' array:
Entity object classes have a member named 'roles'. This member is an array of strings, with each string indicating the role or relationship the entity object instance has with a containing object, such as a domain name or IP network. An entity object instance can have more than one type of relationship with a containing object. The following is a list of suggested values to use in the 'roles' array:
Many of the object classes have a member named 'uris', which is an array of objects with each object containing a 'type' string and a 'uri' string. These URIs represent a location to find information about the containing object. The following is a list of suggested values to use as a 'type' string for an associated URI.
This document does not provide specific object classes for registrants and contacts. Instead the entity object class may be used to represent a registrant or contact. When the entity object is embedded inside a containing object such as a domain name or IP network, the 'roles' string array can be used to signify the relationship. It is recommended that the values from Appendix Appendix A.2 be used.
The following is an example of an elided containing object with an embedded entity that is both a registrant and admin contact:
{
...
"entities" :
[
{
"handle" : "XXXX",
"names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ],
"roles" : [ "registrant", "admin" ],
"postalAddress" :
[
"123 Maple Ave",
"Suite 90001",
"Vancouver",
"BC",
"12393"
],
"emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" :
{
"office" : [ "999-999-999-99", "111-111-111-11" ],
"fax" : [ "222-222-222-22" ],
"mobile" : [ "333-333-333-33" ]
},
"remarks" :
[
"she sells seas shells",
"down by the seashore"
],
"registrationDate" : "1990-12-31T23:59:60Z",
"lastChangedDate" : "1990-12-31T23:59:60Z",
"lastChangedBy" : "joe@bob.com"
}
]
}
This document does not provide a specific object class for registrars, but like registrants and contacts (see Appendix Appendix B.1) the 'roles' string array maybe used. Additionally, a URI type can signify the registrars point of service (see Appendix Appendix A.3).
The following is an example of an elided containing object with an embedded entity that is a registrar:
{
...
"entities" :
[
{
"handle" : "XXXX",
"names": [ "RegistrarsRUS" ],
"roles" : [ "registrar" ],
"postalAddress" :
[
"1212 Tulip Ave",
"Suite 1",
"Marina Del Rey",
"CA",
"12393-2193"
],
"emails" : [ "joe@bob.com", "bob@joe.com" ],
"phones" :
{
"office" : [ "999-999-999-99", "111-111-111-11" ],
"fax" : [ "222-222-222-22" ],
"mobile" : [ "333-333-333-33" ]
},
"remarks" :
[
"we registrar for less!"
],
"uris" :
[
{
"type" : "rdap",
"uri" : "http://rdap.exmaple.com"
},
{
"type" : "web",
"uri" : "http://www.example.com"
}
]
}
]
}
Internationalized Domain Names (IDNs) differ from other types of domain names because multiple domain names as would be represented by a name in Master File format (see [RFC4343]) may be registered by a single IDN. IDNs are based on Unicode, and Unicode can have multiple means for encoding the same word depending on the character set and language being used. And the rules for determining which IDN encoding maps to a "wire-format" domain name vary from DNR to DNR.
When an IDN maps to multiple domain names, the various mappings are called variants. The DNR Domain object class [dnr_domain_object_class] represents the variants using a string array.
The following is an example of an elided DNR domain object with variants.
{
"handle" : "XXXX",
"name" : "blah.example.com",
"variants" : [ "blah2.example.com", "blah3.example.com" ],
...
}
Because IDNs can have multiple targets in a mapping and due to the variance in DNR mapping rules, it is up to the client to reduce an IDN to a domain name in Master File format so as to narrow the lookup of the domain name to the proper subset. A query of a DNR using the IDN itself might map across multiple registrations depending on the mapping rules of the DNR.
The postal address data listed in the entity object class [entity_object_class] does not necessarily represent location. The intent of this information is to provide a means to send postal mail to an entity. While in some cases it may also be the location of the entity, there is no gaurantee that the two are the same. Accurate representation of location is topic unto itself, and registries wishing to show location of object instances should use the 'geo' or 'held' URI types as meantioned in Appendix Appendix A.3.
Additionally, the postal address data represented in this document does not follow any specific standard for postal addresses because many registries do not keep postal address data in an internationalized standard form. Publication of such data in a format that suggests an internationalized standard form when such data is not known to be well-formed for that purpose would be misleading.