draft-ietf-weirds-json-response-08.txt   draft-ietf-weirds-json-response-09.txt 
Network Working Group A. Newton Network Working Group A. Newton
Internet-Draft ARIN Internet-Draft ARIN
Intended status: Standards Track S. Hollenbeck Intended status: Standards Track S. Hollenbeck
Expires: February 15, 2015 Verisign Labs Expires: March 27, 2015 Verisign Labs
August 14, 2014 September 23, 2014
JSON Responses for the Registration Data Access Protocol (RDAP) JSON Responses for the Registration Data Access Protocol (RDAP)
draft-ietf-weirds-json-response-08 draft-ietf-weirds-json-response-09
Abstract Abstract
This document describes JSON data structures representing This document describes JSON data structures representing
registration information maintained by Regional Internet Registries registration information maintained by Regional Internet Registries
(RIRs) and Domain Name Registries (DNRs). These data structures are (RIRs) and Domain Name Registries (DNRs). These data structures are
used to form Registration Data Access Protocol (RDAP) query used to form Registration Data Access Protocol (RDAP) query
responses. responses.
Status of This Memo Status of This Memo
skipping to change at page 1, line 35 skipping to change at page 1, line 35
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on February 15, 2015. This Internet-Draft will expire on March 27, 2015.
Copyright Notice Copyright Notice
Copyright (c) 2014 IETF Trust and the persons identified as the Copyright (c) 2014 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 14 skipping to change at page 2, line 14
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Terminology and Definitions . . . . . . . . . . . . . . . . . 4 2. Terminology and Definitions . . . . . . . . . . . . . . . . . 4
3. Use of JSON . . . . . . . . . . . . . . . . . . . . . . . . . 5 3. Use of JSON . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.1. Signaling . . . . . . . . . . . . . . . . . . . . . . . . 5 3.1. Signaling . . . . . . . . . . . . . . . . . . . . . . . . 5
3.2. Naming . . . . . . . . . . . . . . . . . . . . . . . . . 5 3.2. Naming . . . . . . . . . . . . . . . . . . . . . . . . . 5
4. Common Data Types . . . . . . . . . . . . . . . . . . . . . . 6 4. Common Data Types . . . . . . . . . . . . . . . . . . . . . . 7
5. Common Data Structures . . . . . . . . . . . . . . . . . . . 8 5. Common Data Structures . . . . . . . . . . . . . . . . . . . 9
5.1. RDAP Conformance . . . . . . . . . . . . . . . . . . . . 8 5.1. RDAP Conformance . . . . . . . . . . . . . . . . . . . . 9
5.2. Links . . . . . . . . . . . . . . . . . . . . . . . . . . 8 5.2. Links . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.3. Notices And Remarks . . . . . . . . . . . . . . . . . . . 9 5.3. Notices And Remarks . . . . . . . . . . . . . . . . . . . 10
5.4. Language Identifier . . . . . . . . . . . . . . . . . . . 11 5.4. Language Identifier . . . . . . . . . . . . . . . . . . . 12
5.5. Events . . . . . . . . . . . . . . . . . . . . . . . . . 12 5.5. Events . . . . . . . . . . . . . . . . . . . . . . . . . 13
5.6. Status . . . . . . . . . . . . . . . . . . . . . . . . . 13 5.6. Status . . . . . . . . . . . . . . . . . . . . . . . . . 14
5.7. Port 43 Whois Server . . . . . . . . . . . . . . . . . . 13 5.7. Port 43 WHOIS Server . . . . . . . . . . . . . . . . . . 14
5.8. Public IDs . . . . . . . . . . . . . . . . . . . . . . . 13 5.8. Public IDs . . . . . . . . . . . . . . . . . . . . . . . 14
5.9. Object Class Name . . . . . . . . . . . . . . . . . . . . 13 5.9. Object Class Name . . . . . . . . . . . . . . . . . . . . 14
5.10. An Example . . . . . . . . . . . . . . . . . . . . . . . 14 5.10. An Example . . . . . . . . . . . . . . . . . . . . . . . 15
6. Object Classes . . . . . . . . . . . . . . . . . . . . . . . 16 6. Object Classes . . . . . . . . . . . . . . . . . . . . . . . 17
6.1. The Entity Object Class . . . . . . . . . . . . . . . . . 16 6.1. The Entity Object Class . . . . . . . . . . . . . . . . . 17
6.2. The Nameserver Object Class . . . . . . . . . . . . . . . 23 6.2. The Nameserver Object Class . . . . . . . . . . . . . . . 24
6.3. The Domain Object Class . . . . . . . . . . . . . . . . . 27 6.3. The Domain Object Class . . . . . . . . . . . . . . . . . 28
6.4. The IP Network Object Class . . . . . . . . . . . . . . . 39 6.4. The IP Network Object Class . . . . . . . . . . . . . . . 40
6.5. Autonomous System Number Entity Object Class . . . . . . 43 6.5. Autonomous System Number Entity Object Class . . . . . . 44
7. Error Response Body . . . . . . . . . . . . . . . . . . . . . 46 7. Error Response Body . . . . . . . . . . . . . . . . . . . . . 47
8. Responding to Help Queries . . . . . . . . . . . . . . . . . 48 8. Responding to Help Queries . . . . . . . . . . . . . . . . . 49
9. Responding To Searches . . . . . . . . . . . . . . . . . . . 49 9. Responding To Searches . . . . . . . . . . . . . . . . . . . 50
10. Indicating Truncated Responses . . . . . . . . . . . . . . . 50 10. Indicating Truncated Responses . . . . . . . . . . . . . . . 51
11. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 53 11. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 54
11.1. RDAP JSON Media Type Registration . . . . . . . . . . . 53 11.1. RDAP JSON Media Type Registration . . . . . . . . . . . 54
11.2. JSON Values Registry . . . . . . . . . . . . . . . . . . 54 11.2. JSON Values Registry . . . . . . . . . . . . . . . . . . 55
11.2.1. Notice and Remark Types . . . . . . . . . . . . . . 55 11.2.1. Notice and Remark Types . . . . . . . . . . . . . . 56
11.2.2. Status . . . . . . . . . . . . . . . . . . . . . . . 57 11.2.2. Status . . . . . . . . . . . . . . . . . . . . . . . 58
11.2.3. Event Actions . . . . . . . . . . . . . . . . . . . 62 11.2.3. Event Actions . . . . . . . . . . . . . . . . . . . 63
11.2.4. Roles . . . . . . . . . . . . . . . . . . . . . . . 65 11.2.4. Roles . . . . . . . . . . . . . . . . . . . . . . . 66
11.2.5. Variant Relations . . . . . . . . . . . . . . . . . 68 11.2.5. Variant Relations . . . . . . . . . . . . . . . . . 69
12. Security Considerations . . . . . . . . . . . . . . . . . . . 69 12. Security Considerations . . . . . . . . . . . . . . . . . . . 70
13. Internationalization Considerations . . . . . . . . . . . . . 69 13. Internationalization Considerations . . . . . . . . . . . . . 71
13.1. Character Encoding . . . . . . . . . . . . . . . . . . . 69 13.1. Character Encoding . . . . . . . . . . . . . . . . . . . 71
13.2. URIs and IRIs . . . . . . . . . . . . . . . . . . . . . 70 13.2. URIs and IRIs . . . . . . . . . . . . . . . . . . . . . 71
13.3. Language Tags . . . . . . . . . . . . . . . . . . . . . 70 13.3. Language Tags . . . . . . . . . . . . . . . . . . . . . 71
13.4. Internationalized Domain Names . . . . . . . . . . . . . 70 13.4. Internationalized Domain Names . . . . . . . . . . . . . 71
14. Privacy Considerations . . . . . . . . . . . . . . . . . . . 70 14. Privacy Considerations . . . . . . . . . . . . . . . . . . . 71
15. Contributing Authors and Acknowledgements . . . . . . . . . . 70 15. Contributing Authors and Acknowledgements . . . . . . . . . . 71
16. References . . . . . . . . . . . . . . . . . . . . . . . . . 71 16. References . . . . . . . . . . . . . . . . . . . . . . . . . 72
16.1. Normative References . . . . . . . . . . . . . . . . . . 71 16.1. Normative References . . . . . . . . . . . . . . . . . . 72
16.2. Informative References . . . . . . . . . . . . . . . . . 72 16.2. Informative References . . . . . . . . . . . . . . . . . 73
Appendix A. Suggested Data Modeling with the Entity Object Class 73 Appendix A. Suggested Data Modeling with the Entity Object Class 74
A.1. Registrants and Contacts . . . . . . . . . . . . . . . . 73 A.1. Registrants and Contacts . . . . . . . . . . . . . . . . 74
A.2. Registrars . . . . . . . . . . . . . . . . . . . . . . . 75 A.2. Registrars . . . . . . . . . . . . . . . . . . . . . . . 76
Appendix B. Modeling Events . . . . . . . . . . . . . . . . . . 77 Appendix B. Modeling Events . . . . . . . . . . . . . . . . . . 78
Appendix C. Structured vs Unstructured Addresses . . . . . . . . 79 Appendix C. Structured vs Unstructured Addresses . . . . . . . . 80
Appendix D. Secure DNS . . . . . . . . . . . . . . . . . . . . . 81 Appendix D. Secure DNS . . . . . . . . . . . . . . . . . . . . . 83
Appendix E. Motivations for Using JSON . . . . . . . . . . . . . 82 Appendix E. Motivations for Using JSON . . . . . . . . . . . . . 83
Appendix F. Changelog . . . . . . . . . . . . . . . . . . . . . 82 Appendix F. Changelog . . . . . . . . . . . . . . . . . . . . . 84
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 87 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 90
1. Introduction 1. Introduction
This document describes responses in the JSON [RFC7159] format for This document describes responses in the JSON [RFC7159] format for
the RESTful web queries as defined by the Registration Data Access the queries as defined by the Registration Data Access Protocol
Protocol Lookup Format [I-D.ietf-weirds-rdap-query]. Lookup Format [I-D.ietf-weirds-rdap-query].
The data model for JSON responses is specified in four sections: The data model for JSON responses is specified in four sections:
1. simple data types conveyed in JSON strings 1. simple data types conveyed in JSON strings
2. data structures specified as JSON arrays or objects that are used 2. data structures specified as JSON arrays or objects that are used
repeatedly when building up larger objects repeatedly when building up larger objects
3. object classes representing structured data corresponding to a 3. object classes representing structured data corresponding to a
lookup of a single object lookup of a single object
skipping to change at page 4, line 23 skipping to change at page 4, line 23
2. Autonomous System numbers 2. Autonomous System numbers
Object classes defined in this document represent a minimal set of Object classes defined in this document represent a minimal set of
what a compliant client/server MUST understand to function correctly, what a compliant client/server MUST understand to function correctly,
however some deployments may want to include additional object however some deployments may want to include additional object
classes to suit individual needs. Anticipating this need for classes to suit individual needs. Anticipating this need for
extension, Section 3.2 of this document defines a mechanism for extension, Section 3.2 of this document defines a mechanism for
extending the JSON objects that are described in this document. extending the JSON objects that are described in this document.
Positive responses take two forms. A response to a lookup of a Positive responses take two forms. A response to a lookup of a
single object in the registration system yeilds an JSON object which single object in the registration system yields a JSON object which
is the subject of the lookup. A response to a search for multiple is the subject of the lookup. A response to a search for multiple
objects yields a JSON object which contains an array of JSON objects objects yields a JSON object that contains an array of JSON objects
that are the subject of the search. In each type of response, other that are the subject of the search. In each type of response, other
data structures are present within the topmost JSON object. data structures are present within the topmost JSON object.
2. Terminology and Definitions 2. Terminology and Definitions
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]
when specified in their uppercase forms.
The following list describes terminology and definitions used The following list describes terminology and definitions used
throughout this document: throughout this document:
DNR: "Domain Name Registry". DNR: Domain Name Registry
LDH: "Letters, Digits, Hyphen". LDH: Letters, Digits, Hyphen
member: data found with in an object as defined by JSON member: data found within an object as defined by JSON
[RFC7159]. [RFC7159].
object: a data structure as defined by JSON [RFC7159]. object: a data structure as defined by JSON [RFC7159].
object class: the definition of members that may be found in JSON object class: the definition of members that may be found in JSON
objects described in this document. objects described in this document.
object instance: an instantiation or specific instance of an object object instance: an instantiation or specific instance of an object
class. class.
RDAP: "Registration Data Access Protocol". RDAP: Registration Data Access Protocol
RIR: "Regional Internet Registry". RIR: Regional Internet Registry
3. Use of JSON 3. Use of JSON
3.1. Signaling 3.1. Signaling
Media type signaling for the JSON data specified in this document is Media type signaling for the JSON data described in this document is
specified in [I-D.ietf-weirds-using-http]. specified in [I-D.ietf-weirds-using-http].
3.2. Naming 3.2. Naming
Clients processing JSON [RFC7159] responses are under no obligation Clients processing JSON [RFC7159] responses are under no obligation
to process unrecognized JSON attributes but SHOULD NOT treat them as to process unrecognized JSON attributes but SHOULD NOT treat them as
an error. Servers MAY insert values signified by names into the JSON an error, because servers MAY insert values signified by names into
responses which are not specified in this document. Insertion of the JSON responses which are not specified in this document.
unspecified values into JSON responses SHOULD have names prefixed Insertion of unspecified values into JSON responses SHOULD have names
with a short identifier followed by an underscore followed by a prefixed with a short identifier followed by an underscore followed
meaningful name. The full JSON name (the prefix plus the underscore by a meaningful name. These short identifiers aid software
plus the meaningful name) SHOULD adhere to the character and name implementers with identifying the specification of the JSON name, and
limitations of the prefix registry described in failure to use one could cause an implementer to assume the server is
[I-D.ietf-weirds-using-http]. erroneously serving a name from this specification. This allowance
does not apply to jCard ([RFC7095]) objects. The full JSON name (the
prefix plus the underscore plus the meaningful name) SHOULD adhere to
the character and name limitations of the prefix registry described
in [I-D.ietf-weirds-using-http]. Failure to use these limitations
could result in slower adoption as these limitations have been given
to aid some client programming models.
Consider the following JSON response with JSON names, all of which Consider the following JSON response with JSON names, all of which
are specified in this document. are specified in this document.
{ {
"handle" : "ABC123", "handle" : "ABC123",
"remarks" : "remarks" :
[ [
{ {
"description" : "description" :
skipping to change at page 6, line 50 skipping to change at page 7, line 50
sensitive. Both servers and clients MUST transmit and process them sensitive. Both servers and clients MUST transmit and process them
using the specified character case. using the specified character case.
4. Common Data Types 4. Common Data Types
JSON [RFC7159] defines the data types of a number, character string, JSON [RFC7159] defines the data types of a number, character string,
boolean, array, object and null. This section describes the boolean, array, object and null. This section describes the
semantics and/or syntax reference for data types used in this semantics and/or syntax reference for data types used in this
document derived from the JSON character string. document derived from the JSON character string.
'handle': DNRs and RIRs have registry-unique identifiers that handle: DNRs and RIRs have registry-unique identifiers that
may be used to specifically reference an object may be used to specifically reference an object
instance. The semantics of this data type as found instance. The semantics of this data type as found
in this document is to be a registry-unique in this document are to be a registry-unique
reference to the closest enclosing object where the reference to the closest enclosing object where the
value is found. The data type names 'registryId', value is found. The data type names 'registryId',
'roid', 'nic-handle', 'registrationNo', etc. are 'roid', 'nic-handle', 'registrationNo', etc. are
terms often synonymous with this data type. In terms often synonymous with this data type. In
this document, the term 'handle' is used. The term this document, the term 'handle' is used. The term
exposed to users by clients is a presentation issue exposed to users by clients is a presentation issue
beyond the scope of this document. beyond the scope of this document.
IPv4 addresses: The representation of IPv4 addresses in this IPv4 addresses: The representation of IPv4 addresses in this
document uses the dotted-decimal notation described document uses the dotted-decimal notation described
in [RFC1166]. An example of this textual in [RFC1166]. An example of this textual
representation is '192.0.2.0'. representation is '192.0.2.0'.
IPv6 addresses: The representation of IPv6 addresses in this IPv6 addresses: The representation of IPv6 addresses in this
document follow the forms outlined in [RFC5952]. document follow the forms outlined in [RFC5952].
An example of this textual representation is An example of this textual representation is
'2001:db8::1:0:0:1'. '2001:db8::1:0:0:1'.
country codes: Where the identity of a geopolitical nation or country codes: Where the identity of a geopolitical nation or
country is needed, these identities are represented country is needed, these identities are represented
with the alpha-2 or 2 character country code with the alpha-2 or two-character country code
designation as defined in [ISO.3166.1988]. The designation as defined in [ISO.3166.1988]. The
alpha-2 representation is used because it is freely alpha-2 representation is used because it is freely
available whereas the alpha-3 and numeric-3 available whereas the alpha-3 and numeric-3
standards are not. standards are not.
LDH names: Textual representations of DNS names where the LDH names: Textual representations of DNS names where the
labels of the domain are all "letters, digits, labels of the domain are all "letters, digits,
hyphen" labels as described by [RFC5890]. Trailing hyphen" labels as described by [RFC5890]. Trailing
periods are optional. periods are optional.
Unicode names: Textual representations of DNS names where one or Unicode names: Textual representations of DNS names where one or
more of the labels are U-labels as described by more of the labels are U-labels as described by
[RFC5890]. Trailing periods are optional. [RFC5890]. Trailing periods are optional.
dates and times: The syntax for values denoting dates and times is dates and times: The syntax for values denoting dates and times is
defined in [RFC3339]. defined in [RFC3339].
URIs: The syntax for values denoting a Uniform Resource URIs: The syntax for values denoting a Uniform Resource
Identifier (URI) is defined by [RFC3986]. Identifier (URI) is defined by [RFC3986].
Contact information is defined using JSON vCards as described in Contact information is defined using jCards (JSON vCards) as
[I-D.ietf-jcardcal-jcard] described in [RFC7095]
5. Common Data Structures 5. Common Data Structures
This section defines common data structures used commonly in This section defines common data structures used in responses and
responses and object classes. object classes.
5.1. RDAP Conformance 5.1. RDAP Conformance
The first data structure is named "rdapConformance" and is simply an The first data structure is named "rdapConformance" and is simply an
array of strings, each providing a hint as to the specifications used array of strings, each providing a hint as to the specifications used
in the construction of the response. This data structure appears in the construction of the response. This data structure appears
only in the top most object of a response. only in the top most object of a response.
An example rdapConformance data structure: An example rdapConformance data structure:
"rdapConformance" : "rdapConformance" :
[ [
"rdap_level_0" "rdap_level_0"
] ]
Figure 3 Figure 3
The string literal "rdap_level_0" signifies conformance with this The string literal "rdap_level_0" signifies conformance with this
specification. When custom JSON values are inserted into responses, specification. When custom JSON values are inserted into responses,
conformance to those custom specifications should use a string conformance to those custom specifications SHOULD use a string
prefixed with the appropriate identifier from the IANA prefix prefixed with the appropriate identifier from the IANA RDAP
identifier registry specified in [I-D.ietf-weirds-using-http]. For Extensions registry specified in [I-D.ietf-weirds-using-http]. For
example, if the fictional Registry of the Moon wants to signify that example, if the fictional Registry of the Moon wants to signify that
their JSON responses are conformant with their registered extensions, their JSON responses are conformant with their registered extensions,
the string used might be "lunarNIC_level_0". the string used might be "lunarNIC_level_0". These prefixes aid the
identification of specifications for software implementers, and
failure to use them could result in slower adoption of extensions.
Example rdapConformance structure with custom extensions noted: Example rdapConformance structure with custom extensions noted:
"rdapConformance" : "rdapConformance" :
[ [
"rdap_level_0", "rdap_level_0",
"lunarNic_level_0" "lunarNic_level_0"
] ]
Figure 4 Figure 4
skipping to change at page 9, line 12 skipping to change at page 10, line 12
other resources on the Internet. The relationship of these links is other resources on the Internet. The relationship of these links is
defined by the IANA registry described by [RFC5988]. defined by the IANA registry described by [RFC5988].
The following is an example of the link structure: The following is an example of the link structure:
{ {
"value" : "http://example.com/context_uri", "value" : "http://example.com/context_uri",
"rel" : "self", "rel" : "self",
"href" : "http://example.com/target_uri", "href" : "http://example.com/target_uri",
"hreflang" : [ "en", "ch" ], "hreflang" : [ "en", "ch" ],
"title" : [ "title1", "title2" ], "title" : "title",
"media" : "screen", "media" : "screen",
"type" : "application/json" "type" : "application/json"
} }
Figure 5 Figure 5
The JSON name/values of "rel", "href", "hreflang", "title", "media", The JSON name/values of "rel", "href", "hreflang", "title", "media",
and "type" correspond to values found in Section 5 of [RFC5988]. The and "type" correspond to values found in Section 5 of [RFC5988]. The
"value" JSON value is the context URI as described by [RFC5988]. The "value" JSON value is the context URI as described by [RFC5988]. The
"value", "rel", and "href" JSON values MUST be specified. All other "value", "rel", and "href" JSON values MUST be specified. All other
skipping to change at page 9, line 51 skipping to change at page 10, line 51
} }
] ]
5.3. Notices And Remarks 5.3. Notices And Remarks
The "notices" and "remarks" data structures take the same form. The The "notices" and "remarks" data structures take the same form. The
"notices" structure denotes information about the service providing "notices" structure denotes information about the service providing
RDAP information and/or information about the entire response, RDAP information and/or information about the entire response,
whereas the "remarks" structure denotes information about the object whereas the "remarks" structure denotes information about the object
class it is contained within (see Section 6 regarding object class that contains it (see Section 6 regarding object classes).
classes).
Both are an array of objects. Each object contains an optional Both are arrays of objects. Each object contains an optional "title"
"title" string representing the title of the object, an optional string representing the title of the object, an optional "type"
"type" string denoting a registered type of remark or notice (see string denoting a registered type of remark or notice (see
Section 11.2.1), an array of strings named "description" for the Section 11.2.1), an array of strings named "description" for the
purposes of conveying any descriptive text, and an optional "links" purposes of conveying any descriptive text, and an optional "links"
array as described in Section 5.2. array as described in Section 5.2.
An example of the notices data structure: An example of the notices data structure:
"notices" : "notices" :
[ [
{ {
"title" : "Terms of Use", "title" : "Terms of Use",
skipping to change at page 10, line 39 skipping to change at page 11, line 39
"href" : "http://www.example.com/terms_of_use.html" "href" : "http://www.example.com/terms_of_use.html"
} }
] ]
} }
] ]
Figure 6 Figure 6
It is the job of the clients to determine line breaks, spacing and It is the job of the clients to determine line breaks, spacing and
display issues for sentences within the character strings of the display issues for sentences within the character strings of the
"description" array. Servers SHOULD NOT split sentences across "description" array. Each string in the "description" array contains
multiple strings of this array. Each string is to represent a a single complete division of human readable text indicating to
semantic division in the descriptive text. clients where there are semantic breaks.
An example of the remarks data structure: An example of the remarks data structure:
"remarks" : "remarks" :
[ [
{ {
"description" : "description" :
[ [
"She sells sea shells down by the sea shore.", "She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan." "Originally written by Terry Sullivan."
skipping to change at page 11, line 25 skipping to change at page 12, line 25
} }
] ]
Figure 7 Figure 7
Note that objects in the "remarks" array may also have a "links" Note that objects in the "remarks" array may also have a "links"
array. array.
While the "title" and "description" fields are intended primarily for While the "title" and "description" fields are intended primarily for
human consumption, the "type" string contains a well-known value to human consumption, the "type" string contains a well-known value to
be registered with IANA (see Section 11.2.1) for programattic use. be registered with IANA (see Section 11.2.1) for programmatic use.
An example of the remarks data structure: An example of the remarks data structure:
"remarks" : "remarks" :
[ [
{ {
"type" : "object truncated due to authorization", "type" : "object truncated due to authorization",
"description" : "description" :
[ [
"Some registration data may not have been given.", "Some registration data may not have been given.",
skipping to change at page 11, line 49 skipping to change at page 12, line 49
] ]
Figure 8 Figure 8
While the "remarks" array will appear in many object classes in a While the "remarks" array will appear in many object classes in a
response, the "notices" array appears only in the top most object of response, the "notices" array appears only in the top most object of
a response. a response.
5.4. Language Identifier 5.4. Language Identifier
This data structure is a simple JSON name/value of "lang" with a This data structure consists solely of a name/value pair, where the
string containing a language identifier as described by [RFC5646]. name is "lang" and the value is a string containing a language
identifier as described in [RFC5646].
"lang" : "mn-Cyrl-MN" "lang" : "mn-Cyrl-MN"
Figure 9 Figure 9
The 'lang' attribute may appear anywhere in an object class or data The 'lang' attribute may appear anywhere in an object class or data
structure. structure except for in jCard objects.
5.5. Events 5.5. Events
This data structure represents events that have occurred on an This data structure represents events that have occurred on an
instance of an object class (see Section 6 regarding object classes). instance of an object class (see Section 6 regarding object classes).
This is an example of an "events" array. This is an example of an "events" array.
"events" : "events" :
[ [
{ {
"eventAction" : "registration", "eventAction" : "registration",
"eventActor" : "SOMEID-LUNARNIC", "eventActor" : "SOMEID-LUNARNIC",
"eventDate" : "1990-12-31T23:59:60Z" "eventDate" : "1990-12-31T23:59:59Z"
}, },
{ {
"eventAction" : "last changed", "eventAction" : "last changed",
"eventActor" : "OTHERID-LUNARNIC", "eventActor" : "OTHERID-LUNARNIC",
"eventDate" : "1991-12-31T23:59:60Z" "eventDate" : "1991-12-31T23:59:59Z"
} }
] ]
Figure 10 Figure 10
The "events" array consists of objects, each with the following The "events" array consists of objects, each with the following
members: members:
o 'eventAction' -- a string denoting the reason for the event o 'eventAction' -- a string denoting the reason for the event
skipping to change at page 13, line 16 skipping to change at page 14, line 16
See Section 11.2.3 for a list of values for the 'eventAction' string. See Section 11.2.3 for a list of values for the 'eventAction' string.
See Appendix B regarding the various ways events can be modeled. See Appendix B regarding the various ways events can be modeled.
5.6. Status 5.6. Status
This data structure, named 'status', is an array of strings This data structure, named 'status', is an array of strings
indicating the state of a registered object (see Section 11.2.2 for a indicating the state of a registered object (see Section 11.2.2 for a
list of values). list of values).
5.7. Port 43 Whois Server 5.7. Port 43 WHOIS Server
This data structure, named 'port43', is a simple string containing This data structure, named 'port43', is a simple string containing
the fully-qualified host name of the WHOIS [RFC3912] server where the the fully-qualified host name or IP address of the WHOIS [RFC3912]
containing object instance may be found. Note that this is not a server where the containing object instance may be found. Note that
URI, as there is no WHOIS URI scheme. this is not a URI, as there is no WHOIS URI scheme.
5.8. Public IDs 5.8. Public IDs
This data structure maps a public identifier to an object class. It This data structure maps a public identifier to an object class. It
is named 'publicIds' and is an array of objects, with each object is named 'publicIds' and is an array of objects, with each object
containing the following members: containing the following members:
o type - a string denoting the type of public identifier o type - a string denoting the type of public identifier
o identifier - a public identifier of the type denoted by 'type' o identifier - a public identifier of the type denoted by 'type'
skipping to change at page 13, line 49 skipping to change at page 14, line 49
"identifier":"1" "identifier":"1"
} }
] ]
Figure 11 Figure 11
5.9. Object Class Name 5.9. Object Class Name
This data structure, named "objectClassName", gives the object class This data structure, named "objectClassName", gives the object class
name of a particular object as a string. This aids clients in name of a particular object as a string. This aids clients in
identifying the type of object being processed. Servers SHOULD NOT identifying the type of object being processed. Servers MUST NOT
omit this string so that clients can more easily identify the type of omit this string so that clients can more easily identify the type of
object. object.
5.10. An Example 5.10. An Example
This is an example response with both rdapConformance and notices This is an example response with both rdapConformance and notices
embedded: embedded:
{ {
"rdapConformance" : "rdapConformance" :
skipping to change at page 16, line 16 skipping to change at page 17, line 16
Object classes represent structures appropriate for a response from Object classes represent structures appropriate for a response from
the queries specified in [I-D.ietf-weirds-rdap-query]. the queries specified in [I-D.ietf-weirds-rdap-query].
Each object class contains a "links" array as specified in Each object class contains a "links" array as specified in
Section 5.2. For every object class instance in a response, whether Section 5.2. For every object class instance in a response, whether
the object class instance is directly representing the response to a the object class instance is directly representing the response to a
query or is embedded in other object class instances or is an item in query or is embedded in other object class instances or is an item in
a search result set, servers SHOULD provide a link representing a URI a search result set, servers SHOULD provide a link representing a URI
for that object class instance using the "self" relationship as for that object class instance using the "self" relationship as
specified in the IANA registry specified by [RFC5988]. As explained described in the IANA registry specified by [RFC5988]. As explained
in Section 6.2, this may be not always be possible for name server in Section 6.2, this may be not always be possible for name server
data. Clients MUST be able to process object instances without a data. Clients MUST be able to process object instances without a
"self" link. When present, clients MAY use the self link for caching "self" link. When present, clients MAY use the self link for caching
data. Servers MAY provide more than one "self" link for any given data. Servers MAY provide more than one "self" link for any given
object instance. object instance. Failure to provide any "self" link by a server may
result in clients being unable to cache object class instances.
Self links SHOULD contain a "type" element containing the Self links SHOULD contain a "type" element containing the
"application/rdap+json" media type when referencing RDAP object "application/rdap+json" media type when referencing RDAP object
instances as defined by this document. Clients SHOULD NOT assume instances as defined by this document. Clients SHOULD NOT assume
self links without this media type are represented as RDAP objects as self links without this media type are represented as RDAP objects as
defined by this document. defined by this document.
This is an example of the "links" array with a self link to an object This is an example of the "links" array with a self link to an object
class: class:
skipping to change at page 19, line 27 skipping to change at page 20, line 28
{ {
"value":"http://example.com/entity/XXXX", "value":"http://example.com/entity/XXXX",
"rel":"self", "rel":"self",
"href":"http://example.com/entity/XXXX", "href":"http://example.com/entity/XXXX",
"type" : "application/rdap+json" "type" : "application/rdap+json"
} }
], ],
"events":[ "events":[
{ {
"eventAction":"registration", "eventAction":"registration",
"eventDate":"1990-12-31T23:59:60Z" "eventDate":"1990-12-31T23:59:59Z"
} }
], ],
"asEventActor":[ "asEventActor":[
{ {
"eventAction":"last changed", "eventAction":"last changed",
"eventDate":"1991-12-31T23:59:60Z" "eventDate":"1991-12-31T23:59:59Z"
} }
] ]
} }
Entities may also have other entities embedded with them in an array. Entities may also have other entities embedded with them in an array.
This can be used to model an organization with specific individuals This can be used to model an organization with specific individuals
fulfilling designated roles of responsibility. fulfilling designated roles of responsibility.
The following is an elided example of an entity with embedded The following is an elided example of an entity with embedded
entities. entities.
skipping to change at page 20, line 30 skipping to change at page 21, line 30
}, },
... ...
], ],
... ...
} }
Figure 13 Figure 13
This object has the following members: This object has the following members:
o objectClassName -- which should be the string "entity" o objectClassName -- the string "entity"
o handle -- a string representing an registry unique identifier of o handle -- a string representing an registry unique identifier of
the entity the entity
o vcardArray -- a JSON vCard with the entity's contact information o vcardArray -- a JSON vCard with the entity's contact information
o roles -- an array of strings, each signifying the relationship an o roles -- an array of strings, each signifying the relationship an
object would have with its closest containing object (see object would have with its closest containing object (see
Section 11.2.4 for a list of values) Section 11.2.4 for a list of values)
skipping to change at page 22, line 40 skipping to change at page 23, line 40
"value":"http://example.com/entity/XXXX", "value":"http://example.com/entity/XXXX",
"rel":"self", "rel":"self",
"href":"http://example.com/entity/XXXX", "href":"http://example.com/entity/XXXX",
"type":"application/rdap+json" "type":"application/rdap+json"
} }
], ],
"port43":"whois.example.net", "port43":"whois.example.net",
"events":[ "events":[
{ {
"eventAction":"registration", "eventAction":"registration",
"eventDate":"1990-12-31T23:59:60Z" "eventDate":"1990-12-31T23:59:59Z"
}, },
{ {
"eventAction":"last changed", "eventAction":"last changed",
"eventDate":"1991-12-31T23:59:60Z", "eventDate":"1991-12-31T23:59:59Z",
"eventActor":"joe@example.com" "eventActor":"joe@example.com"
} }
] ]
} }
See Appendix A for use of the entity object class to model various See Appendix A for use of the entity object class to model various
types of entities found in both RIRs and DNRs. See Appendix C types of entities found in both RIRs and DNRs. See Appendix C
regarding structured vs. unstructured postal addresses in entities. regarding structured vs. unstructured postal addresses in entities.
6.2. The Nameserver Object Class 6.2. The Nameserver Object Class
skipping to change at page 24, line 9 skipping to change at page 25, line 9
variation in between. variation in between.
The following is an example of a nameserver object. For illustrative The following is an example of a nameserver object. For illustrative
purposes, it does not include rdapConformance or notices data purposes, it does not include rdapConformance or notices data
structures. structures.
{ {
"objectClassName" : "nameserver", "objectClassName" : "nameserver",
"handle" : "XXXX", "handle" : "XXXX",
"ldhName" : "ns1.xn--fo-5ja.example", "ldhName" : "ns1.xn--fo-5ja.example",
"unicodeName" : "foo.example", "unicodeName" : "ns1.foo.example",
"status" : [ "active" ], "status" : [ "active" ],
"ipAddresses" : "ipAddresses" :
{ {
"v4": [ "192.0.2.1", "192.0.2.2" ], "v4": [ "192.0.2.1", "192.0.2.2" ],
"v6": [ "2001:db8::123" ] "v6": [ "2001:db8::123" ]
}, },
"remarks" : "remarks" :
[ [
{ {
"description" : "description" :
skipping to change at page 24, line 40 skipping to change at page 25, line 40
"rel" : "self", "rel" : "self",
"href" : "http://example.net/nameserver/xxxx", "href" : "http://example.net/nameserver/xxxx",
"type" : "application/rdap+json" "type" : "application/rdap+json"
} }
], ],
"port43" : "whois.example.net", "port43" : "whois.example.net",
"events" : "events" :
[ [
{ {
"eventAction" : "registration", "eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z" "eventDate" : "1990-12-31T23:59:59Z"
}, },
{ {
"eventAction" : "last changed", "eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z", "eventDate" : "1991-12-31T23:59:59Z",
"eventActor" : "joe@example.com" "eventActor" : "joe@example.com"
} }
] ]
} }
Figure 14 Figure 14
Figure 14 is an example of a nameserver object with all values given. Figure 14 is an example of a nameserver object with all values given.
Registries using a first-class nameserver data model would embed this Registries using a first-class nameserver data model would embed this
in domain objects as well as allowing references to it with the in domain objects as well as allowing references to it with the
skipping to change at page 26, line 24 skipping to change at page 27, line 24
[ [
... ...
], ],
... ...
} }
Figure 17 Figure 17
The nameserver object class has the following members: The nameserver object class has the following members:
o objectClassName - should be the string "nameserver" o objectClassName - the string "nameserver"
o handle -- a string representing an registry unique identifier of o handle -- a string representing an registry unique identifier of
the nameserver the nameserver
o ldhName -- a string containing the LDH name of the nameserver (see o ldhName -- a string containing the LDH name of the nameserver (see
Section 4) Section 4)
o unicodeName -- a string containing a DNS Unicode name of the o unicodeName -- a string containing a DNS Unicode name of the
nameserver (see Section 4) nameserver (see Section 4)
skipping to change at page 27, line 28 skipping to change at page 28, line 28
domain name (e.g. registrant information, contacts, etc.). domain name (e.g. registrant information, contacts, etc.).
The following is an elided example of the domain object showing the The following is an elided example of the domain object showing the
high level structure: high level structure:
{ {
"objectClassName" : "domain", "objectClassName" : "domain",
"handle" : "XXX", "handle" : "XXX",
"ldhName" : "blah.example.com", "ldhName" : "blah.example.com",
... ...
"nameServers" : "nameservers" :
[ [
... ...
], ],
... ...
"entities" : "entities" :
[ [
... ...
] ]
} }
The following is a description of the members of this object: The following is a description of the members of this object:
o objectClassName -- should be the string "domain" o objectClassName -- the string "domain"
o handle -- a string representing a registry unique identifier of o handle -- a string representing a registry unique identifier of
the domain object instance the domain object instance
o ldhName -- a string describing a domain name in LDH form as o ldhName -- a string describing a domain name in LDH form as
described in Section 4 described in Section 4
o unicodeName -- a string containing a domain name with U-labels as o unicodeName -- a string containing a domain name with U-labels as
described in Section 4 described in Section 4
skipping to change at page 28, line 23 skipping to change at page 29, line 23
object (see Section 11.2.5 for a list of suggested variant object (see Section 11.2.5 for a list of suggested variant
relations). relations).
* idnTable -- the name of the IDN table of codepoints, such as * idnTable -- the name of the IDN table of codepoints, such as
one listed with the IANA (see IDN tables [IANA_IDNTABLES]). one listed with the IANA (see IDN tables [IANA_IDNTABLES]).
* variantNames -- an array of objects, with each object * variantNames -- an array of objects, with each object
containing an "ldhName" member and a "unicodeName" member (see containing an "ldhName" member and a "unicodeName" member (see
Section 4). Section 4).
o nameServers -- an array of nameserver objects as defined by o nameservers -- an array of nameserver objects as defined by
Section 6.2 Section 6.2
o secureDNS -- an object with the following members: o secureDNS -- an object with the following members:
* zoneSigned -- boolean true if the zone has been signed, false * zoneSigned -- true if the zone has been signed, false
otherwise. otherwise.
* delegationSigned -- boolean true if there are DS records in the * delegationSigned -- boolean true if there are DS records in the
parent, false otherwise. parent, false otherwise.
* maxSigLife -- an integer representing the signature life time * maxSigLife -- an integer representing the signature life time
in seconds to be used when creating the RRSIG DS record in the in seconds to be used when creating the RRSIG DS record in the
parent zone [RFC5910]. parent zone [RFC5910].
* dsData - an array of objects, each with the following members: * dsData - an array of objects, each with the following members:
+ keyTag -- an integer as specified by the key tag field of a + keyTag -- an integer as specified by the key tag field of a
DNS DS record as specified by RFC 4034 RFC 4034 [RFC4034] in DNS DS record as specified by RFC 4034 [RFC4034] in
presentation format presentation format
+ algorithm -- an integer as specified by the algorithm field + algorithm -- an integer as specified by the algorithm field
of a DNS DS record as specified by RFC 4034 in presentation of a DNS DS record as described by RFC 4034 in presentation
format format
+ digest -- a string as specified by the digest field of a DNS + digest -- a string as specified by the digest field of a DNS
DS record as specified by RFC 4034 in presentation format DS record as specified by RFC 4034 in presentation format
+ digestType -- an integer as specified by the digest type + digestType -- an integer as specified by the digest type
field of a DNS DS record as specified by RFC 4034 in field of a DNS DS record as specified by RFC 4034 in
presentation format presentation format
+ events - see Section 5.5 + events - see Section 5.5
+ links - see Section 5.2 + links - see Section 5.2
* keyData - an array of objects, each with the following members: * keyData - an array of objects, each with the following members:
+ flags -- an integer representing the flags field value in + flags -- an integer representing the flags field value in
the DNSKEY record [RFC4034] in presentation format. the DNSKEY record [RFC4034] in presentation format
+ protocol - an integer representation of the protocol field + protocol - an integer representation of the protocol field
value of the DNSKEY record [RFC4034] in presentation format. value of the DNSKEY record [RFC4034] in presentation format
+ publicKey - a string representation of the public key in the + publicKey - a string representation of the public key in the
DNSKEY record [RFC4034] in presentation format. DNSKEY record [RFC4034] in presentation format
+ algorithm -- an integer as specified by the algorithm field + algorithm -- an integer as specified by the algorithm field
of a DNSKEY record as specified by RFC 4034 [RFC4034] in of a DNSKEY record as specified by RFC 4034 [RFC4034] in
presentation format presentation format
+ events - see Section 5.5 + events - see Section 5.5
+ links - see Section 5.2 + links - see Section 5.2
See Appendix D for background information on these objects. See Appendix D for background information on these objects.
skipping to change at page 30, line 10 skipping to change at page 31, line 10
is referenced. See Section 6.4 is referenced. See Section 6.4
The following is an example of a JSON domain object representing a The following is an example of a JSON domain object representing a
reverse DNS delegation point that might be served by an RIR. For reverse DNS delegation point that might be served by an RIR. For
illustrative purposes, it does not include rdapConformance or notices illustrative purposes, it does not include rdapConformance or notices
data structures. data structures.
{ {
"objectClassName" : "domain", "objectClassName" : "domain",
"handle" : "XXXX", "handle" : "XXXX",
"ldhName" : "192.in-addr.arpa", "ldhName" : "0.2.192.in-addr.arpa",
"nameServers" : "nameservers" :
[ [
{ {
"objectClassName" : "nameserver", "objectClassName" : "nameserver",
"ldhName" : "ns1.rir.example" "ldhName" : "ns1.rir.example"
}, },
{ {
"objectClassName" : "nameserver", "objectClassName" : "nameserver",
"ldhName" : "ns2.rir.example" "ldhName" : "ns2.rir.example"
} }
], ],
skipping to change at page 31, line 11 skipping to change at page 32, line 11
"value": "http://example.net/domain/XXXX", "value": "http://example.net/domain/XXXX",
"rel" : "self", "rel" : "self",
"href" : "http://example.net/domain/XXXXX", "href" : "http://example.net/domain/XXXXX",
"type" : "application/rdap+json" "type" : "application/rdap+json"
} }
], ],
"events" : "events" :
[ [
{ {
"eventAction" : "registration", "eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z" "eventDate" : "1990-12-31T23:59:59Z"
}, },
{ {
"eventAction" : "last changed", "eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z", "eventDate" : "1991-12-31T23:59:59Z",
"eventActor" : "joe@example.com" "eventActor" : "joe@example.com"
} }
], ],
"entities" : "entities" :
[ [
{ {
"objectClassName" : "entity", "objectClassName" : "entity",
"handle" : "XXXX", "handle" : "XXXX",
"vcardArray":[ "vcardArray":[
"vcard", "vcard",
skipping to change at page 32, line 41 skipping to change at page 33, line 41
"value": "http://example.net/entity/xxxx", "value": "http://example.net/entity/xxxx",
"rel" : "self", "rel" : "self",
"href" : "http://example.net/entity/xxxx", "href" : "http://example.net/entity/xxxx",
"type" : "application/rdap+json" "type" : "application/rdap+json"
} }
], ],
"events" : "events" :
[ [
{ {
"eventAction" : "registration", "eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z" "eventDate" : "1990-12-31T23:59:59Z"
}, },
{ {
"eventAction" : "last changed", "eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z", "eventDate" : "1991-12-31T23:59:59Z",
"eventActor" : "joe@example.com" "eventActor" : "joe@example.com"
} }
] ]
} }
], ],
"network" : "network" :
{ {
"objectClassName" : "ip network", "objectClassName" : "ip network",
"handle" : "XXXX-RIR", "handle" : "XXXX-RIR",
"startAddress" : "2001:db8::0", "startAddress" : "192.0.2.0",
"endAddress" : "2001:db8::0:FFFF:FFFF:FFFF:FFFF:FFFF", "endAddress" : "192.0.2.255",
"ipVersion" : "v6", "ipVersion" : "v6",
"name": "NET-RTR-1", "name": "NET-RTR-1",
"type" : "DIRECT ALLOCATION", "type" : "DIRECT ALLOCATION",
"country" : "AU", "country" : "AU",
"parentHandle" : "YYYY-RIR", "parentHandle" : "YYYY-RIR",
"status" : [ "allocated" ] "status" : [ "active" ]
} }
} }
The following is an example of a JSON domain object representing a The following is an example of a JSON domain object representing a
forward DNS delegation point that might be served by a DNR. For forward DNS delegation point that might be served by a DNR. For
illustrative purposes, it does not include rdapConformance or notices illustrative purposes, it does not include rdapConformance or notices
data structures. data structures.
{ {
"objectClassName" : "domain", "objectClassName" : "domain",
skipping to change at page 33, line 44 skipping to change at page 34, line 44
"ldhName" : "xn--fo-cka.example", "ldhName" : "xn--fo-cka.example",
"unicodeName" : "foo.example" "unicodeName" : "foo.example"
}, },
{ {
"ldhName" : "xn--fo-fka.example", "ldhName" : "xn--fo-fka.example",
"unicodeName" : "foeo.example" "unicodeName" : "foeo.example"
} }
] ]
}, },
{ {
"relation" : [ "unregistered", "restricted registration" ], "relation" : [ "unregistered", "registration restricted" ],
"idnTable": ".EXAMPLE Swedish", "idnTable": ".EXAMPLE Swedish",
"variantNames" : "variantNames" :
[ [
{ {
"ldhName": "xn--fo-8ja.example", "ldhName": "xn--fo-8ja.example",
"unicodeName" : "foo.example" "unicodeName" : "foo.example"
} }
] ]
} }
], ],
"status" : [ "locked", "transfer prohibited" ], "status" : [ "locked", "transfer prohibited" ],
"publicIds":[ "publicIds":[
{ {
"type":"ENS_Auth ID", "type":"ENS_Auth ID",
"identifier":"1234567890" "identifier":"1234567890"
} }
], ],
"nameServers" : "nameservers" :
[ [
{ {
"objectClassName" : "nameserver", "objectClassName" : "nameserver",
"handle" : "XXXX", "handle" : "XXXX",
"ldhName" : "ns1.example.com", "ldhName" : "ns1.example.com",
"status" : [ "active" ], "status" : [ "active" ],
"ipAddresses" : "ipAddresses" :
{ {
"v6": [ "2001:db8::123", "2001:db8::124" ], "v6": [ "2001:db8::123", "2001:db8::124" ],
"v4": [ "192.0.2.1", "192.0.2.2" ] "v4": [ "192.0.2.1", "192.0.2.2" ]
skipping to change at page 34, line 51 skipping to change at page 35, line 51
"value" : "http://example.net/nameserver/XXXX", "value" : "http://example.net/nameserver/XXXX",
"rel" : "self", "rel" : "self",
"href" : "http://example.net/nameserver/XXXX", "href" : "http://example.net/nameserver/XXXX",
"type" : "application/rdap+json" "type" : "application/rdap+json"
} }
], ],
"events" : "events" :
[ [
{ {
"eventAction" : "registration", "eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z" "eventDate" : "1990-12-31T23:59:59Z"
}, },
{ {
"eventAction" : "last changed", "eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z" "eventDate" : "1991-12-31T23:59:59Z"
} }
] ]
}, },
{ {
"objectClassName" : "nameserver", "objectClassName" : "nameserver",
"handle" : "XXXX", "handle" : "XXXX",
"ldhName" : "ns2.example.com", "ldhName" : "ns2.example.com",
"status" : [ "active" ], "status" : [ "active" ],
"ipAddresses" : "ipAddresses" :
{ {
skipping to change at page 35, line 45 skipping to change at page 36, line 45
"value" : "http://example.net/nameserver/XXXX", "value" : "http://example.net/nameserver/XXXX",
"rel" : "self", "rel" : "self",
"href" : "http://example.net/nameserver/XXXX", "href" : "http://example.net/nameserver/XXXX",
"type" : "application/rdap+json" "type" : "application/rdap+json"
} }
], ],
"events" : "events" :
[ [
{ {
"eventAction" : "registration", "eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z" "eventDate" : "1990-12-31T23:59:59Z"
}, },
{ {
"eventAction" : "last changed", "eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z" "eventDate" : "1991-12-31T23:59:59Z"
} }
] ]
} }
], ],
"secureDNS": "secureDNS":
{ {
"zoneSigned": true, "zoneSigned": true,
"delegationSigned": true, "delegationSigned": true,
"maxSigLife": 604800, "maxSigLife": 604800,
skipping to change at page 36, line 52 skipping to change at page 37, line 52
"rel" : "self", "rel" : "self",
"href" : "http://example.net/domain/XXXX", "href" : "http://example.net/domain/XXXX",
"type" : "application/rdap+json" "type" : "application/rdap+json"
} }
], ],
"port43" : "whois.example.net", "port43" : "whois.example.net",
"events" : "events" :
[ [
{ {
"eventAction" : "registration", "eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z" "eventDate" : "1990-12-31T23:59:59Z"
}, },
{ {
"eventAction" : "last changed", "eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z", "eventDate" : "1991-12-31T23:59:59Z",
"eventActor" : "joe@example.com" "eventActor" : "joe@example.com"
}, },
{ {
"eventAction" : "transfer", "eventAction" : "transfer",
"eventDate" : "1991-12-31T23:59:60Z", "eventDate" : "1991-12-31T23:59:59Z",
"eventActor" : "joe@example.com" "eventActor" : "joe@example.com"
}, },
{ {
"eventAction" : "expiration", "eventAction" : "expiration",
"eventDate" : "2016-12-31T23:59:60Z", "eventDate" : "2016-12-31T23:59:59Z",
"eventActor" : "joe@example.com" "eventActor" : "joe@example.com"
} }
], ],
"entities" : "entities" :
[ [
{ {
"objectClassName" : "entity", "objectClassName" : "entity",
"handle" : "XXXX", "handle" : "XXXX",
"vcardArray":[ "vcardArray":[
"vcard", "vcard",
skipping to change at page 38, line 43 skipping to change at page 39, line 43
"value" : "http://example.net/entity/xxxx", "value" : "http://example.net/entity/xxxx",
"rel" : "self", "rel" : "self",
"href" : "http://example.net/entity/xxxx", "href" : "http://example.net/entity/xxxx",
"type" : "application/rdap+json" "type" : "application/rdap+json"
} }
], ],
"events" : "events" :
[ [
{ {
"eventAction" : "registration", "eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z" "eventDate" : "1990-12-31T23:59:59Z"
}, },
{ {
"eventAction" : "last changed", "eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z" "eventDate" : "1991-12-31T23:59:59Z"
} }
] ]
} }
] ]
} }
6.4. The IP Network Object Class 6.4. The IP Network Object Class
The IP Network object class models IP network registrations found in The IP Network object class models IP network registrations found in
skipping to change at page 39, line 38 skipping to change at page 40, line 38
} }
The following is an example of the JSON object for the network The following is an example of the JSON object for the network
registration information. For illustrative purposes, it does not registration information. For illustrative purposes, it does not
include rdapConformance or notices data structures. include rdapConformance or notices data structures.
{ {
"objectClassName" : "ip network", "objectClassName" : "ip network",
"handle" : "XXXX-RIR", "handle" : "XXXX-RIR",
"startAddress" : "2001:db8::0", "startAddress" : "2001:db8::0",
"endAddress" : "2001:db8::0:FFFF:FFFF:FFFF:FFFF:FFFF", "endAddress" : "2001:db8:0:FFFF:FFFF:FFFF:FFFF:FFFF",
"ipVersion" : "v6", "ipVersion" : "v6",
"name": "NET-RTR-1", "name": "NET-RTR-1",
"type" : "DIRECT ALLOCATION", "type" : "DIRECT ALLOCATION",
"country" : "AU", "country" : "AU",
"parentHandle" : "YYYY-RIR", "parentHandle" : "YYYY-RIR",
"status" : [ "allocated" ], "status" : [ "active" ],
"remarks" : "remarks" :
[ [
{ {
"description" : "description" :
[ [
"She sells sea shells down by the sea shore.", "She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan." "Originally written by Terry Sullivan."
] ]
} }
], ],
"links" : "links" :
[ [
{ {
"value" : "http://example.ent/ip/2001:db8::/48", "value" : "http://example.net/ip/2001:db8::/48",
"rel" : "self", "rel" : "self",
"href" : "http://example.net/ip/2001:db8::/48", "href" : "http://example.net/ip/2001:db8::/48",
"type" : "application/rdap+json" "type" : "application/rdap+json"
}, },
{ {
"value" : "http://example.net/ip/2001:db8::/48", "value" : "http://example.net/ip/2001:db8::/48",
"rel" : "up", "rel" : "up",
"href" : "http://example.net/ip/2001:C00::/23", "href" : "http://example.net/ip/2001:C00::/23",
"type" : "application/rdap+json" "type" : "application/rdap+json"
} }
], ],
"events" : "events" :
[ [
{ {
"eventAction" : "registration", "eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z" "eventDate" : "1990-12-31T23:59:59Z"
}, },
{ {
"eventAction" : "last changed", "eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z" "eventDate" : "1991-12-31T23:59:59Z"
} }
], ],
"entities" : "entities" :
[ [
{ {
"objectClassName" : "entity", "objectClassName" : "entity",
"handle" : "XXXX", "handle" : "XXXX",
"vcardArray":[ "vcardArray":[
"vcard", "vcard",
[ [
skipping to change at page 42, line 10 skipping to change at page 43, line 10
"rel" : "self", "rel" : "self",
"href" : "http://example.net/entity/xxxx", "href" : "http://example.net/entity/xxxx",
"type" : "application/rdap+json" "type" : "application/rdap+json"
} }
], ],
"events" : "events" :
[ [
{ {
"eventAction" : "registration", "eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z" "eventDate" : "1990-12-31T23:59:59Z"
}, },
{ {
"eventAction" : "last changed", "eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z" "eventDate" : "1991-12-31T23:59:59Z"
} }
] ]
} }
] ]
} }
The following is a description of the members of this object: The following is a description of the members of this object:
o objectClassName -- should be the string "ip network" o objectClassName -- the string "ip network"
o handle -- a string representing an RIR unique identifier of the o handle -- a string representing an RIR unique identifier of the
network registration network registration
o startAddress -- the starting IP address of the network, either o startAddress -- the starting IP address of the network, either
IPv4 or IPv6 IPv4 or IPv6
o endAddress -- the ending IP address of the network, either IPv4 or o endAddress -- the ending IP address of the network, either IPv4 or
IPv6 IPv6
o ipVersion -- a string signifying the IP protocol version of the o ipVersion -- a string signifying the IP protocol version of the
network: "v4" signifying an IPv4 network, "v6" signifying an IPv6 network: "v4" signifying an IPv4 network, "v6" signifying an IPv6
network network
o name -- an identifier assigned to the network registration by the o name -- an identifier assigned to the network registration by the
registration holder registration holder
o type -- a string containing an RIR-specific classification of the o type -- a string containing an RIR-specific classification of the
network network
o country -- a string containing the name of the 2 character country o country -- a string containing the name of the two-character
code of the network country code of the network
o parentHandle -- a string containing an RIR-unique identifier of o parentHandle -- a string containing an RIR-unique identifier of
the parent network of this network registration the parent network of this network registration
o status -- an array of strings indicating the state of the IP o status -- an array of strings indicating the state of the IP
network network
o entities -- an array of entity objects as defined by Section 6.1. o entities -- an array of entity objects as defined by Section 6.1.
o remarks - see Section 5.3 o remarks - see Section 5.3
skipping to change at page 43, line 38 skipping to change at page 44, line 38
For illustrative purposes, it does not include rdapConformance or For illustrative purposes, it does not include rdapConformance or
notices data structures. notices data structures.
{ {
"objectClassName" : "autnum", "objectClassName" : "autnum",
"handle" : "XXXX-RIR", "handle" : "XXXX-RIR",
"startAutnum" : 10, "startAutnum" : 10,
"endAutnum" : 15, "endAutnum" : 15,
"name": "AS-RTR-1", "name": "AS-RTR-1",
"type" : "DIRECT ALLOCATION", "type" : "DIRECT ALLOCATION",
"status" : [ "allocated" ], "status" : [ "active" ],
"country": "AU", "country": "AU",
"remarks" : "remarks" :
[ [
{ {
"description" : "description" :
[ [
"She sells sea shells down by the sea shore.", "She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan." "Originally written by Terry Sullivan."
] ]
} }
skipping to change at page 44, line 15 skipping to change at page 45, line 15
"value" : "http://example.net/autnum/xxxx", "value" : "http://example.net/autnum/xxxx",
"rel" : "self", "rel" : "self",
"href" : "http://example.net/autnum/xxxx", "href" : "http://example.net/autnum/xxxx",
"type" : "application/rdap+json" "type" : "application/rdap+json"
} }
], ],
"events" : "events" :
[ [
{ {
"eventAction" : "registration", "eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z" "eventDate" : "1990-12-31T23:59:59Z"
}, },
{ {
"eventAction" : "last changed", "eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z" "eventDate" : "1991-12-31T23:59:59Z"
} }
], ],
"entities" : "entities" :
[ [
{ {
"objectClassName" : "entity", "objectClassName" : "entity",
"handle" : "XXXX", "handle" : "XXXX",
"vcardArray":[ "vcardArray":[
"vcard", "vcard",
[ [
skipping to change at page 45, line 43 skipping to change at page 46, line 43
"value" : "http://example.net/entity/XXXX", "value" : "http://example.net/entity/XXXX",
"rel" : "self", "rel" : "self",
"href" : "http://example.net/entity/XXXX", "href" : "http://example.net/entity/XXXX",
"type" : "application/rdap+json" "type" : "application/rdap+json"
} }
], ],
"events" : "events" :
[ [
{ {
"eventAction" : "registration", "eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z" "eventDate" : "1990-12-31T23:59:59Z"
}, },
{ {
"eventAction" : "last changed", "eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z" "eventDate" : "1991-12-31T23:59:59Z"
} }
] ]
} }
] ]
} }
The following is a description of the members of this object: The following is a description of the members of this object:
o objectClassName -- should be the string "autnum" o objectClassName -- the string "autnum"
o handle -- a string representing an RIR-unique identifier of the o handle -- a string representing an RIR-unique identifier of the
autnum registration autnum registration
o startAutnum -- a number representing the starting number [RFC5396] o startAutnum -- a number representing the starting number [RFC5396]
in the block of autonomous system numbers in the block of autonomous system numbers
o endAutnum -- a number representing the ending number [RFC5396] in o endAutnum -- a number representing the ending number [RFC5396] in
the block of autonomous system numbers the block of autonomous system numbers
skipping to change at page 46, line 48 skipping to change at page 47, line 48
o events - see Section 5.5 o events - see Section 5.5
7. Error Response Body 7. Error Response Body
Some non-answer responses may return entity bodies with information Some non-answer responses may return entity bodies with information
that could be more descriptive. that could be more descriptive.
The basic structure of that response is an object class containing an The basic structure of that response is an object class containing an
error code number (corresponding to the HTTP response code) followed error code number (corresponding to the HTTP response code) followed
by a string named "title" followed by an array of strings named by a string named "title" and an array of strings named
"description". "description".
This is an example of the common response body. For illustrative This is an example of the common response body. For illustrative
purposes, it does not include rdapConformance or notices data purposes, it does not include rdapConformance or notices data
structures. structures.
{ {
"errorCode": 418, "errorCode": 418,
"title": "Your beverage choice is not available", "title": "Your beverage choice is not available",
"description": "description":
skipping to change at page 55, line 38 skipping to change at page 56, line 38
Registry: Registry:
1. 1.
* Value: result set truncated due to authorization * Value: result set truncated due to authorization
* Type: notice and remark type * Type: notice and remark type
* Description: The list of results does not contain all results * Description: The list of results does not contain all results
due to lack of authorization. This may indicate to some due to lack of authorization. This may indicate to some
clients that proper authorization will yeild a longer result clients that proper authorization will yield a longer result
set. set.
* Registrant Name: Andrew Newton * Registrant Name: Andrew Newton
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: andy@hxr.us
2. 2.
* Value: result set truncated due to excessive load * Value: result set truncated due to excessive load
* Type: notice and remark type * Type: notice and remark type
* Description: The list of results does not contain all results * Description: The list of results does not contain all results
due to excessively heavy load on the server. This may due to excessively heavy load on the server. This may
indicate to some clients that requerying at a later time will indicate to some clients that requerying at a later time will
yeild a longer result set. yield a longer result set.
* Registrant Name: Andrew Newton * Registrant Name: Andrew Newton
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: andy@hxr.us
3. 3.
* Value: result set truncated due to unexplainable reasons * Value: result set truncated due to unexplainable reasons
* Type: notice and remark type * Type: notice and remark type
skipping to change at page 56, line 33 skipping to change at page 57, line 33
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: andy@hxr.us
4. 4.
* Value: object truncated due to authorization * Value: object truncated due to authorization
* Type: notice and remark type * Type: notice and remark type
* Description: The object does not contain all data due to lack * Description: The object does not contain all data due to lack
of authorization. This may indicate to some clients that of authorization.
proper authorization will yeild all data of the object.
* Registrant Name: Andrew Newton * Registrant Name: Andrew Newton
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: andy@hxr.us
5. 5.
* Value: object truncated due to excessive load * Value: object truncated due to excessive load
* Type: notice and remark type * Type: notice and remark type
* Description: The object does not contain all data due to * Description: The object does not contain all data due to
excessively heavy load on the server. This may indicate to excessively heavy load on the server. This may indicate to
some clients that requerying at a later time will yeild all some clients that requerying at a later time will yield all
data of the object. data of the object.
* Registrant Name: Andrew Newton * Registrant Name: Andrew Newton
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: andy@hxr.us
6. 6.
* Value: object truncated due to unexplainable reasons * Value: object truncated due to unexplainable reasons
* Type: notice and remark type * Type: notice and remark type
* Description: The object does not contain all data for an * Description: The object does not contain all data for an
unexplainable reason. This may indicate to some clients that unexplainable reason.
requerying for any reason will not yield any more data.
* Registrant Name: Andrew Newton * Registrant Name: Andrew Newton
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: andy@hxr.us
11.2.2. Status 11.2.2. Status
This section registers the following values into the RDAP JSON Values This section registers the following values into the RDAP JSON Values
Registry: Registry:
skipping to change at page 60, line 32 skipping to change at page 61, line 32
11. 11.
* Value: active * Value: active
* Type: status * Type: status
* Description: The object instance is in use. For domain * Description: The object instance is in use. For domain
names, it signifies that the domain name is published in DNS. names, it signifies that the domain name is published in DNS.
For network and autnum registrations it signifies that they For network and autnum registrations it signifies that they
are allocated or assigned for use in operational networks. are allocated or assigned for use in operational networks.
This maps to the EPP 'OK' status. This maps to the Extensible Provisioning Protocol (EPP)
[RFC5730] 'OK' status.
* Registrant Name: Andrew Newton * Registrant Name: Andrew Newton
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: andy@hxr.us
12. 12.
* Value: inactive * Value: inactive
* Type: status * Type: status
skipping to change at page 61, line 10 skipping to change at page 62, line 12
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: andy@hxr.us
13. 13.
* Value: locked * Value: locked
* Type: status * Type: status
* Description: Changes to the object instance cannot be made, * Description: Changes to the object instance cannot be made,
including the assocation of other object instances. including the association of other object instances.
* Registrant Name: Andrew Newton * Registrant Name: Andrew Newton
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: andy@hxr.us
14. 14.
* Value: pending create * Value: pending create
* Type: status * Type: status
skipping to change at page 62, line 28 skipping to change at page 63, line 31
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: andy@hxr.us
18. 18.
* Value: pending delete * Value: pending delete
* Type: status * Type: status
* Description: A request has been received for the deletion or * Description: A request has been received for the deletion or
removal of the object instance but this action is not yet removal of the object instance but this action is not yet
complete. For domains, this might mean that the name in no complete. For domains, this might mean that the name is no
longer published in DNS but has not yet been purged from the longer published in DNS but has not yet been purged from the
registry database. registry database.
* Registrant Name: Andrew Newton * Registrant Name: Andrew Newton
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: andy@hxr.us
11.2.3. Event Actions 11.2.3. Event Actions
This section registers the following values into the RDAP JSON Values This section registers the following values into the RDAP JSON Values
skipping to change at page 69, line 45 skipping to change at page 70, line 47
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: andy@hxr.us
12. Security Considerations 12. Security Considerations
This specification models information serialized in JSON format. As This specification models information serialized in JSON format. As
JSON is a subset of Javascript, implementations are advised to follow JSON is a subset of Javascript, implementations are advised to follow
the security considerations outlined in Section 6 of [RFC7159] to the security considerations outlined in Section 6 of [RFC7159] to
prevent code injection. prevent code injection.
Though not specific to JSON, RDAP implementers should be aware of the
security considerations specified in [I-D.ietf-weirds-using-http] and
the security requirements and considerations in
[I-D.ietf-weirds-rdap-sec].
13. Internationalization Considerations 13. Internationalization Considerations
13.1. Character Encoding 13.1. Character Encoding
The default text encoding for JSON and XML responses in RDAP is UTF-8 The default text encoding for JSON responses in RDAP is UTF-8
[RFC3629], and all servers and clients MUST support UTF-8. Servers [RFC3629], and all servers and clients MUST support UTF-8. Servers
and clients MAY optionally support other character encodings. and clients MAY optionally support other character encodings.
13.2. URIs and IRIs 13.2. URIs and IRIs
[I-D.ietf-weirds-using-http] defines the use of URIs and IRIs in [I-D.ietf-weirds-using-http] defines the use of URIs and IRIs in
RDAP. RDAP.
13.3. Language Tags 13.3. Language Tags
skipping to change at page 70, line 35 skipping to change at page 71, line 43
This specification suggests status values to denote contact and This specification suggests status values to denote contact and
registrant information that has been marked as private and/or has registrant information that has been marked as private and/or has
been redacted or obscured. See Section 11.2.2 for the list of status been redacted or obscured. See Section 11.2.2 for the list of status
values. See Appendix A.1 on guidance to apply those values to values. See Appendix A.1 on guidance to apply those values to
contacts and registrants. contacts and registrants.
15. Contributing Authors and Acknowledgements 15. Contributing Authors and Acknowledgements
This document is derived from original work on RIR responses in JSON This document is derived from original work on RIR responses in JSON
by Byron J. Ellacott, Arturo L. Servin, Kaveh Ranjbar, and Andrew by Byron J. Ellacott, Arturo L. Servin, Kaveh Ranjbar, and Andrew
L. Newton. Additionally, this document incorporates word on DNR L. Newton. Additionally, this document incorporates work on DNR
responses in JSON by Ning Kong, Linlin Zhou, Jiagui Xie, and Sean responses in JSON by Ning Kong, Linlin Zhou, Jiagui Xie, and Sean
Shen. Shen.
The components of the DNR object classes are derived from a The components of the DNR object classes are derived from a
categorization of WHOIS response formats created by Ning Kong, Linlin categorization of WHOIS response formats created by Ning Kong, Linlin
Zhou, and Guangqing Deng, Steve Sheng and Francisco Arias, Ray Zhou, and Guangqing Deng, Steve Sheng and Francisco Arias, Ray
Bellis, and Frederico Neves. Bellis, and Frederico Neves.
Ed Lewis contributed significant review comments and provided Tom Harrison, Murray Kucherawy, Ed Lewis contributed significant
clarifying text. James Mitchell provided text regarding the review comments and provided clarifying text. James Mitchell
processing of unknown JSON attributes and identified issues leading provided text regarding the processing of unknown JSON attributes and
to the remodeling of events. Ernie Dainow and Francisco Obispo identified issues leading to the remodeling of events. Ernie Dainow
provided concrete suggestions that led to a better variant model for and Francisco Obispo provided concrete suggestions that led to a
domain names. better variant model for domain names.
Ernie Dainow provided the background information on the secure DNSSEC Ernie Dainow provided the background information on the secure DNSSEC
attributes and objects for domains, informative text on DNSSEC, and attributes and objects for domains, informative text on DNSSEC, and
many other attributes that appear throughout the object classes of many other attributes that appear throughout the object classes of
this draft. this draft.
The switch to and incorporation of JSON vCard was performed by Simon The switch to and incorporation of JSON vCard was performed by Simon
Perreault. Perreault.
Olaf Kolkman and Murray Kucherawy chaired the IETF's WEIRDS working
group from which this document as been created.
16. References 16. References
16.1. Normative References 16.1. Normative References
[RFC1166] Kirkpatrick, S., Stahl, M., and M. Recker, "Internet [RFC1166] Kirkpatrick, S., Stahl, M., and M. Recker, "Internet
numbers", RFC 1166, July 1990. numbers", RFC 1166, July 1990.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the [RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the
Internet: Timestamps", RFC 3339, July 2002. Internet: Timestamps", RFC 3339, July 2002.
[RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, RFC 3629, November 2003. 10646", STD 63, RFC 3629, November 2003.
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66, RFC Resource Identifier (URI): Generic Syntax", STD 66, RFC
3986, January 2005. 3986, January 2005.
skipping to change at page 71, line 46 skipping to change at page 73, line 14
[RFC5890] Klensin, J., "Internationalized Domain Names for [RFC5890] Klensin, J., "Internationalized Domain Names for
Applications (IDNA): Definitions and Document Framework", Applications (IDNA): Definitions and Document Framework",
RFC 5890, August 2010. RFC 5890, August 2010.
[RFC5952] Kawamura, S. and M. Kawashima, "A Recommendation for IPv6 [RFC5952] Kawamura, S. and M. Kawashima, "A Recommendation for IPv6
Address Text Representation", RFC 5952, August 2010. Address Text Representation", RFC 5952, August 2010.
[RFC5988] Nottingham, M., "Web Linking", RFC 5988, October 2010. [RFC5988] Nottingham, M., "Web Linking", RFC 5988, October 2010.
[RFC7095] Kewisch, P., "jCard: The JSON Format for vCard", RFC 7095,
January 2014.
[RFC7159] Bray, T., "The JavaScript Object Notation (JSON) Data [RFC7159] Bray, T., "The JavaScript Object Notation (JSON) Data
Interchange Format", RFC 7159, March 2014. Interchange Format", RFC 7159, March 2014.
[I-D.ietf-jcardcal-jcard]
Kewisch, P., "jCard: The JSON format for vCard", draft-
ietf-jcardcal-jcard-07 (work in progress), October 2013.
[I-D.ietf-weirds-using-http] [I-D.ietf-weirds-using-http]
Newton, A., Ellacott, B., and N. Kong, "HTTP usage in the Newton, A., Ellacott, B., and N. Kong, "HTTP usage in the
Registration Data Access Protocol (RDAP)", draft-ietf- Registration Data Access Protocol (RDAP)", draft-ietf-
weirds-using-http-09 (work in progress), August 2014. weirds-using-http-11 (work in progress), September 2014.
[I-D.ietf-weirds-rdap-query] [I-D.ietf-weirds-rdap-query]
Newton, A. and S. Hollenbeck, "Registration Data Access Newton, A. and S. Hollenbeck, "Registration Data Access
Protocol Query Format", draft-ietf-weirds-rdap-query-11 Protocol Query Format", draft-ietf-weirds-rdap-query-13
(work in progress), July 2014. (work in progress), August 2014.
[I-D.ietf-weirds-rdap-sec]
Hollenbeck, S. and N. Kong, "Security Services for the
Registration Data Access Protocol", draft-ietf-weirds-
rdap-sec-08 (work in progress), August 2014.
[ISO.3166.1988] [ISO.3166.1988]
International Organization for Standardization, "Codes for International Organization for Standardization, "Codes for
the representation of names of countries, 3rd edition", the representation of names of countries, 3rd edition",
ISO Standard 3166, August 1988. ISO Standard 3166, August 1988.
16.2. Informative References 16.2. Informative References
[RFC3912] Daigle, L., "WHOIS Protocol Specification", RFC 3912, [RFC3912] Daigle, L., "WHOIS Protocol Specification", RFC 3912,
September 2004. September 2004.
skipping to change at page 74, line 34 skipping to change at page 76, line 6
[ [
"She sells sea shells down by the sea shore.", "She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan." "Originally written by Terry Sullivan."
] ]
} }
], ],
"events" : "events" :
[ [
{ {
"eventAction" : "registration", "eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z" "eventDate" : "1990-12-31T23:59:59Z"
}, },
{ {
"eventAction" : "last changed", "eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:60Z" "eventDate" : "1991-12-31T23:59:59Z"
} }
] ]
} }
] ]
} }
In many use cases, it is necessary to hide or obscure the information In many use cases, it is necessary to hide or obscure the information
of a registrant or contact due to policy or other operational of a registrant or contact due to policy or other operational
matters. Registries can denote these situations with 'status' values matters. Registries can denote these situations with 'status' values
(see Section 11.2.2). (see Section 11.2.2).
skipping to change at page 77, line 38 skipping to change at page 79, line 11
For the first use case, the 'events' data structure (Section 5.5) is For the first use case, the 'events' data structure (Section 5.5) is
used without the 'eventActor' object member. used without the 'eventActor' object member.
This is an example of an "events" array without the 'eventActor'. This is an example of an "events" array without the 'eventActor'.
"events" : "events" :
[ [
{ {
"eventAction" : "registration", "eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:60Z" "eventDate" : "1990-12-31T23:59:59Z"
} }
] ]
Figure 22 Figure 22
For the second use case, the 'events' data structure (Section 5.5) is For the second use case, the 'events' data structure (Section 5.5) is
used with the 'eventActor' object member. used with the 'eventActor' object member.
This is an example of an "events" array with the 'eventActor'. This is an example of an "events" array with the 'eventActor'.
"events" : "events" :
[ [
{ {
"eventAction" : "registration", "eventAction" : "registration",
"eventActor" : "XYZ-NIC", "eventActor" : "XYZ-NIC",
"eventDate" : "1990-12-31T23:59:60Z" "eventDate" : "1990-12-31T23:59:59Z"
} }
] ]
Figure 23 Figure 23
For the third use case, the 'asEventActor' array is used when an For the third use case, the 'asEventActor' array is used when an
entity (Section 6.1) is embedded into another object class. The entity (Section 6.1) is embedded into another object class. The
'asEventActor' array follows the same structure as the 'events' array 'asEventActor' array follows the same structure as the 'events' array
but does not have 'eventActor' attributes. but does not have 'eventActor' attributes.
skipping to change at page 78, line 41 skipping to change at page 80, line 23
... ...
"entities" : "entities" :
[ [
{ {
"handle" : "XXXX", "handle" : "XXXX",
... ...
"asEventActor" : "asEventActor" :
[ [
{ {
"eventAction" : "last changed", "eventAction" : "last changed",
"eventDate" : "1990-12-31T23:59:60Z" "eventDate" : "1990-12-31T23:59:59Z"
} }
] ]
} }
] ]
} }
Appendix C. Structured vs Unstructured Addresses Appendix C. Structured vs Unstructured Addresses
The entity (Section 6.1) object class uses jCard The entity (Section 6.1) object class uses jCard [RFC7095] to
[I-D.ietf-jcardcal-jcard] to represent contact information, including represent contact information, including postal addresses. jCard has
postal addresses. jCard has the ability to represent multiple the ability to represent multiple language preferences, multiple
language preferences, multiple email address and phone numbers, and email address and phone numbers, and multiple postal addresses in
multiple postal addresses in both a structured and unstructured both a structured and unstructured format. This section describes
format. This section describes the use of jCard for representing the use of jCard for representing structured and unstructured
structured and unstructured addresses. addresses.
The following is an example of a jCard. The following is an example of a jCard.
{ {
"vcardArray":[ "vcardArray":[
"vcard", "vcard",
[ [
["version", {}, "text", "4.0"], ["version", {}, "text", "4.0"],
["fn", {}, "text", "Joe User"], ["fn", {}, "text", "Joe User"],
["n", {}, "text", ["n", {}, "text",
skipping to change at page 82, line 29 skipping to change at page 84, line 7
[RFC5730] standard, which is an XML serialized protocol. The logic [RFC5730] standard, which is an XML serialized protocol. The logic
is that since EPP is a common protocol in the industry it follows is that since EPP is a common protocol in the industry it follows
that XML would be a more natural choice. While EPP does influence that XML would be a more natural choice. While EPP does influence
this specification quite a bit, EPP serves a different purpose which this specification quite a bit, EPP serves a different purpose which
is the provisioning of Internet resources between registries and is the provisioning of Internet resources between registries and
accredited registrars and serves a much narrower audience than that accredited registrars and serves a much narrower audience than that
envisioned for RDAP. envisioned for RDAP.
By contrast, RDAP has a broader audience and is designed for public By contrast, RDAP has a broader audience and is designed for public
consumption of data. Experience from RIRs with first generation consumption of data. Experience from RIRs with first generation
RESTful web services for Whois indicate a large percentage of clients RESTful web services for WHOIS indicate a large percentage of clients
operate within browsers and other platforms where full-blown XML operate within browsers and other platforms where full-blown XML
stacks are not readily available and where JSON is a better fit. stacks are not readily available and where JSON is a better fit.
Additionally, while EPP is used in much of the DNR community it is Additionally, while EPP is used in much of the DNR community it is
not a universal constant in that industry. And finally, EPP's use of not a universal constant in that industry. And finally, EPP's use of
XML predates the specification of JSON. If EPP had been defined XML predates the specification of JSON. If EPP had been defined
today, it may very well have used JSON instead of XML. today, it may very well have used JSON instead of XML.
Beyond the specific DNR and RIR communities, the trend in the broader Beyond the specific DNR and RIR communities, the trend in the broader
Internet industry is also switching to JSON over XML, especially in Internet industry is also switching to JSON over XML, especially in
the area of RESTful web services (see [JSON_acendancy]). Studies the area of RESTful web services (see [JSON_acendancy]). Studies
have also found that JSON is generally less bulky and consequently have also found that JSON is generally less bulky and consequently
faster to parse (see [JSON_performance_study]). faster to parse (see [JSON_performance_study]).
Appendix F. Changelog Appendix F. Changelog
[RFC Editor: Please delete this section prior to publication.]
Initial -00 Adopted as working group document 2012-September-18. Initial -00 Adopted as working group document 2012-September-18.
-01 -01
Minor spelling corrections. Changed "Registry Data" to Minor spelling corrections. Changed "Registry Data" to
"Registration Data" for the sake of consistency. "Registration Data" for the sake of consistency.
Transitioned to RFC 5988 links and relationship types from our Transitioned to RFC 5988 links and relationship types from our
own custom "uris" structure. own custom "uris" structure.
skipping to change at page 87, line 22 skipping to change at page 88, line 46
Fix search response example. Fix search response example.
Change the returned search arrays to 'domainSearchResults', Change the returned search arrays to 'domainSearchResults',
'entitySearchResults', and 'nameserverSearchResults'. 'entitySearchResults', and 'nameserverSearchResults'.
-07 -07
'nameservers' in domain object class was changed to 'nameservers' in domain object class was changed to
'nameServers' as in the example (note the camel case) 'nameServers' as in the example (note the camel case)
fixed some example per email from James Mitchel fixed some example per email from James Mitchell
fixed an example per email from Simon Perreault fixed an example per email from Simon Perreault
Added "network" to domain object class. Added "network" to domain object class.
Added networks and autnums to the entity object class. Added networks and autnums to the entity object class.
Created a section for "resultsTruncated". Created a section for "resultsTruncated".
-08 -08
skipping to change at page 87, line 44 skipping to change at page 89, line 19
Added typed remarks and notices, removed "resultTruncated" in Added typed remarks and notices, removed "resultTruncated" in
favor of them. favor of them.
Added "objectClassName". Added "objectClassName".
Changed JSON reference to RFC 7159. Changed JSON reference to RFC 7159.
Removed unused references to RFC 0791, RFC 2616, RFC 4343, RFC Removed unused references to RFC 0791, RFC 2616, RFC 4343, RFC
5322. 5322.
-09
Fixed numerous examples.
Reference to jCard updated.
Text regarding JSON vCards has been changed to jCards.
JSON naming rules do not apply to jCards.
"nameserver" was made consistently all lower case.
Links contained a "title" array, but it is now just a string
per RFC 5988.
Removed the term RESTful from the first section so it wouldn't
have to be expanded.
Added reference to RFC 2119 and noted that the uppercase form
is what this document uses.
Added text explaining why SHOULDs and SHOULD NOTs are to be
followed.
"port43" can now be either an domain name or IP address.
"objectClassName" is now required.
Numerous changes in prose for better readability.
Updated the security considerations section to point to using-
http and rdap-sec.
Authors' Addresses Authors' Addresses
Andrew Lee Newton Andrew Lee Newton
American Registry for Internet Numbers American Registry for Internet Numbers
3635 Concorde Parkway 3635 Concorde Parkway
Chantilly, VA 20151 Chantilly, VA 20151
US US
Email: andy@arin.net Email: andy@arin.net
URI: http://www.arin.net URI: http://www.arin.net
Scott Hollenbeck Scott Hollenbeck
 End of changes. 118 change blocks. 
200 lines changed or deleted 264 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/