draft-ietf-weirds-json-response-09.txt   draft-ietf-weirds-json-response-10.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: March 27, 2015 Verisign Labs Expires: April 11, 2015 Verisign Labs
September 23, 2014 October 8, 2014
JSON Responses for the Registration Data Access Protocol (RDAP) JSON Responses for the Registration Data Access Protocol (RDAP)
draft-ietf-weirds-json-response-09 draft-ietf-weirds-json-response-10
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 March 27, 2015. This Internet-Draft will expire on April 11, 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
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
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 1.1. Terminology and Definitions . . . . . . . . . . . . . . . 3
3. Use of JSON . . . . . . . . . . . . . . . . . . . . . . . . . 5 1.2. Data Model . . . . . . . . . . . . . . . . . . . . . . . 4
3.1. Signaling . . . . . . . . . . . . . . . . . . . . . . . . 5 2. Use of JSON . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.2. Naming . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.1. Naming . . . . . . . . . . . . . . . . . . . . . . . . . 5
4. Common Data Types . . . . . . . . . . . . . . . . . . . . . . 7 3. Common Data Types . . . . . . . . . . . . . . . . . . . . . . 7
5. Common Data Structures . . . . . . . . . . . . . . . . . . . 9 4. Common Data Structures . . . . . . . . . . . . . . . . . . . 9
5.1. RDAP Conformance . . . . . . . . . . . . . . . . . . . . 9 4.1. RDAP Conformance . . . . . . . . . . . . . . . . . . . . 9
5.2. Links . . . . . . . . . . . . . . . . . . . . . . . . . . 9 4.2. Links . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.3. Notices And Remarks . . . . . . . . . . . . . . . . . . . 10 4.3. Notices And Remarks . . . . . . . . . . . . . . . . . . . 10
5.4. Language Identifier . . . . . . . . . . . . . . . . . . . 12 4.4. Language Identifier . . . . . . . . . . . . . . . . . . . 12
5.5. Events . . . . . . . . . . . . . . . . . . . . . . . . . 13 4.5. Events . . . . . . . . . . . . . . . . . . . . . . . . . 13
5.6. Status . . . . . . . . . . . . . . . . . . . . . . . . . 14 4.6. Status . . . . . . . . . . . . . . . . . . . . . . . . . 14
5.7. Port 43 WHOIS Server . . . . . . . . . . . . . . . . . . 14 4.7. Port 43 WHOIS Server . . . . . . . . . . . . . . . . . . 14
5.8. Public IDs . . . . . . . . . . . . . . . . . . . . . . . 14 4.8. Public IDs . . . . . . . . . . . . . . . . . . . . . . . 14
5.9. Object Class Name . . . . . . . . . . . . . . . . . . . . 14 4.9. Object Class Name . . . . . . . . . . . . . . . . . . . . 14
5.10. An Example . . . . . . . . . . . . . . . . . . . . . . . 15 4.10. An Example . . . . . . . . . . . . . . . . . . . . . . . 15
6. Object Classes . . . . . . . . . . . . . . . . . . . . . . . 17 5. Object Classes . . . . . . . . . . . . . . . . . . . . . . . 17
6.1. The Entity Object Class . . . . . . . . . . . . . . . . . 17 5.1. The Entity Object Class . . . . . . . . . . . . . . . . . 17
6.2. The Nameserver Object Class . . . . . . . . . . . . . . . 24 5.2. The Nameserver Object Class . . . . . . . . . . . . . . . 24
6.3. The Domain Object Class . . . . . . . . . . . . . . . . . 28 5.3. The Domain Object Class . . . . . . . . . . . . . . . . . 28
6.4. The IP Network Object Class . . . . . . . . . . . . . . . 40 5.4. The IP Network Object Class . . . . . . . . . . . . . . . 40
6.5. Autonomous System Number Entity Object Class . . . . . . 44 5.5. Autonomous System Number Entity Object Class . . . . . . 44
7. Error Response Body . . . . . . . . . . . . . . . . . . . . . 47 6. Error Response Body . . . . . . . . . . . . . . . . . . . . . 47
8. Responding to Help Queries . . . . . . . . . . . . . . . . . 49 7. Responding to Help Queries . . . . . . . . . . . . . . . . . 49
9. Responding To Searches . . . . . . . . . . . . . . . . . . . 50 8. Responding To Searches . . . . . . . . . . . . . . . . . . . 50
10. Indicating Truncated Responses . . . . . . . . . . . . . . . 51 9. Indicating Truncated Responses . . . . . . . . . . . . . . . 51
11. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 54 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 54
11.1. RDAP JSON Media Type Registration . . . . . . . . . . . 54 10.1. RDAP JSON Media Type Registration . . . . . . . . . . . 54
11.2. JSON Values Registry . . . . . . . . . . . . . . . . . . 55 10.2. JSON Values Registry . . . . . . . . . . . . . . . . . . 55
11.2.1. Notice and Remark Types . . . . . . . . . . . . . . 56 10.2.1. Notice and Remark Types . . . . . . . . . . . . . . 56
11.2.2. Status . . . . . . . . . . . . . . . . . . . . . . . 58 10.2.2. Status . . . . . . . . . . . . . . . . . . . . . . . 58
11.2.3. Event Actions . . . . . . . . . . . . . . . . . . . 63 10.2.3. Event Actions . . . . . . . . . . . . . . . . . . . 63
11.2.4. Roles . . . . . . . . . . . . . . . . . . . . . . . 66 10.2.4. Roles . . . . . . . . . . . . . . . . . . . . . . . 66
11.2.5. Variant Relations . . . . . . . . . . . . . . . . . 69 10.2.5. Variant Relations . . . . . . . . . . . . . . . . . 69
12. Security Considerations . . . . . . . . . . . . . . . . . . . 70 11. Security Considerations . . . . . . . . . . . . . . . . . . . 70
13. Internationalization Considerations . . . . . . . . . . . . . 71 12. Internationalization Considerations . . . . . . . . . . . . . 71
13.1. Character Encoding . . . . . . . . . . . . . . . . . . . 71 12.1. Character Encoding . . . . . . . . . . . . . . . . . . . 71
13.2. URIs and IRIs . . . . . . . . . . . . . . . . . . . . . 71 12.2. URIs and IRIs . . . . . . . . . . . . . . . . . . . . . 71
13.3. Language Tags . . . . . . . . . . . . . . . . . . . . . 71 12.3. Language Tags . . . . . . . . . . . . . . . . . . . . . 71
13.4. Internationalized Domain Names . . . . . . . . . . . . . 71 12.4. Internationalized Domain Names . . . . . . . . . . . . . 71
14. Privacy Considerations . . . . . . . . . . . . . . . . . . . 71 13. Privacy Considerations . . . . . . . . . . . . . . . . . . . 71
15. Contributing Authors and Acknowledgements . . . . . . . . . . 71 14. Contributing Authors and Acknowledgements . . . . . . . . . . 71
16. References . . . . . . . . . . . . . . . . . . . . . . . . . 72 15. References . . . . . . . . . . . . . . . . . . . . . . . . . 72
16.1. Normative References . . . . . . . . . . . . . . . . . . 72 15.1. Normative References . . . . . . . . . . . . . . . . . . 72
16.2. Informative References . . . . . . . . . . . . . . . . . 73 15.2. Informative References . . . . . . . . . . . . . . . . . 73
Appendix A. Suggested Data Modeling with the Entity Object Class 74 Appendix A. Suggested Data Modeling with the Entity Object Class 74
A.1. Registrants and Contacts . . . . . . . . . . . . . . . . 74 A.1. Registrants and Contacts . . . . . . . . . . . . . . . . 74
A.2. Registrars . . . . . . . . . . . . . . . . . . . . . . . 76 A.2. Registrars . . . . . . . . . . . . . . . . . . . . . . . 76
Appendix B. Modeling Events . . . . . . . . . . . . . . . . . . 78 Appendix B. Modeling Events . . . . . . . . . . . . . . . . . . 78
Appendix C. Structured vs Unstructured Addresses . . . . . . . . 80 Appendix C. Structured vs Unstructured Addresses . . . . . . . . 80
Appendix D. Secure DNS . . . . . . . . . . . . . . . . . . . . . 83 Appendix D. Secure DNS . . . . . . . . . . . . . . . . . . . . . 83
Appendix E. Motivations for Using JSON . . . . . . . . . . . . . 83 Appendix E. Motivations for Using JSON . . . . . . . . . . . . . 83
Appendix F. Changelog . . . . . . . . . . . . . . . . . . . . . 84 Appendix F. Changelog . . . . . . . . . . . . . . . . . . . . . 84
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 90 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 queries as defined by the Registration Data Access Protocol the queries as defined by the Registration Data Access Protocol
Lookup Format [I-D.ietf-weirds-rdap-query]. Lookup Format [I-D.ietf-weirds-rdap-query].
[I-D.ietf-weirds-using-http] describes a communication protocol for
exchanging queries and responses.
1.1. 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
throughout this document:
DNR: Domain Name Registry
LDH: Letters, Digits, Hyphen
member: data found within an object 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
objects described in this document.
object instance: an instantiation or specific instance of an object
class.
RDAP: Registration Data Access Protocol
RIR: Regional Internet Registry
1.2. Data Model
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 16 skipping to change at page 4, line 48
for both classes of service. for both classes of service.
In addition to the object classes listed above, RIRs also serve the In addition to the object classes listed above, RIRs also serve the
following object classes: following object classes:
1. IP networks 1. IP networks
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 needs to understand to function
however some deployments may want to include additional object correctly, however some deployments may want to include additional
classes to suit individual needs. Anticipating this need for object classes to suit individual needs. Anticipating this need for
extension, Section 3.2 of this document defines a mechanism for extension, Section 2.1 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 yields a 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 that 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. Use of JSON
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
throughout this document:
DNR: Domain Name Registry
LDH: Letters, Digits, Hyphen
member: data found within an object 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
objects described in this document.
object instance: an instantiation or specific instance of an object
class.
RDAP: Registration Data Access Protocol
RIR: Regional Internet Registry
3. Use of JSON
3.1. Signaling
Media type signaling for the JSON data described in this document is
specified in [I-D.ietf-weirds-using-http].
3.2. Naming 2.1. Naming
Clients processing JSON [RFC7159] responses are under no obligation Clients of these JSON responses SHOULD ignore unrecognized JSON
to process unrecognized JSON attributes but SHOULD NOT treat them as attributes in responses. Servers can insert values into the JSON
an error, because servers MAY insert values signified by names into responses which are not specified in this document, but that does not
the JSON responses which are not specified in this document. constitute an error in the response. Servers which insert such
Insertion of unspecified values into JSON responses SHOULD have names unspecified values into JSON responses SHOULD have names prefixed
prefixed with a short identifier followed by an underscore followed with a short identifier followed by an underscore followed by a
by a meaningful name. These short identifiers aid software meaningful name. These short identifiers aid software implementers
implementers with identifying the specification of the JSON name, and with identifying the specification of the JSON name, and failure to
failure to use one could cause an implementer to assume the server is use one could cause an implementer to assume the server is
erroneously serving a name from this specification. This allowance erroneously using a name from this specification. This allowance
does not apply to jCard ([RFC7095]) objects. The full JSON name (the does not apply to jCard ([RFC7095]) objects. The full JSON name (the
prefix plus the underscore plus the meaningful name) SHOULD adhere to prefix plus the underscore plus the meaningful name) SHOULD adhere to
the character and name limitations of the prefix registry described the character and name limitations of the prefix registry described
in [I-D.ietf-weirds-using-http]. Failure to use these limitations in [I-D.ietf-weirds-using-http]. Failure to use these limitations
could result in slower adoption as these limitations have been given could result in slower adoption as these limitations have been given
to aid some client programming models. 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.
skipping to change at page 7, line 33 skipping to change at page 7, line 33
"In space,", "In space,",
"nobody can hear you scream." "nobody can hear you scream."
] ]
} }
Figure 2 Figure 2
Insertion of unrecognized names ignored by clients may also be used Insertion of unrecognized names ignored by clients may also be used
for future revisions to this specification. for future revisions to this specification.
Clients processing JSON responses MUST be prepared for values Clients processing JSON responses need to be prepared for values
specified in this document to be absent from a response as no JSON specified in this document to be absent from a response, as no JSON
value listed is required to appear in a response. In other words, value listed is required to appear in a response. In other words,
servers MAY remove values as is needed by the policies of the server servers are free to not included values based on their own policies.
operator.
Finally, all JSON names specified in this document are case Finally, all JSON names specified in this document are case
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 3. 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 are 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. An
in [RFC1166]. An example of this textual example of this textual representation is
representation is '192.0.2.0'. '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 two-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
skipping to change at page 9, line 5 skipping to change at page 9, line 5
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 jCards (JSON vCards) as Contact information is defined using jCards (JSON vCards) as
described in [RFC7095] described in [RFC7095]
5. Common Data Structures 4. Common Data Structures
This section defines common data structures used in responses and This section defines common data structures used in responses and
object classes. object classes.
5.1. RDAP Conformance 4.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 MUST use a string prefixed
prefixed with the appropriate identifier from the IANA RDAP with the appropriate identifier from the IANA RDAP Extensions
Extensions registry specified in [I-D.ietf-weirds-using-http]. For registry specified in [I-D.ietf-weirds-using-http]. For example, if
example, if the fictional Registry of the Moon wants to signify that the fictional Registry of the Moon wants to signify that their JSON
their JSON responses are conformant with their registered extensions, responses are conformant with their registered extensions, the string
the string used might be "lunarNIC_level_0". These prefixes aid the used might be "lunarNIC_level_0". These prefixes aid the
identification of specifications for software implementers, and identification of specifications for software implementers, and
failure to use them could result in slower adoption of extensions. 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
5.2. Links 4.2. Links
The "links" array is found in data structures to signify links to The "links" array is found in data structures to signify links to
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",
skipping to change at page 10, line 22 skipping to change at page 10, line 22
"title" : "title", "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 "href" JSON value MUST be specified. All other JSON values are
JSON values are optional. OPTIONAL.
This is an example of the "links" array as it might be found in an This is an example of the "links" array as it might be found in an
object class: object class:
"links" : "links" :
[ [
{ {
"value" : "http://example.com/ip/2001:db8::123", "value" : "http://example.com/ip/2001:db8::123",
"rel" : "self", "rel" : "self",
"href" : "http://example.com/ip/2001:db8::123", "href" : "http://example.com/ip/2001:db8::123",
skipping to change at page 10, line 45 skipping to change at page 10, line 45
}, },
{ {
"value" : "http://example.com/ip/2001:db8::123", "value" : "http://example.com/ip/2001:db8::123",
"rel" : "up", "rel" : "up",
"href" : "http://example.com/ip/2001:db8::/48", "href" : "http://example.com/ip/2001:db8::/48",
"type" : "application/rdap+json" "type" : "application/rdap+json"
} }
] ]
5.3. Notices And Remarks 4.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 that contains it (see Section 6 regarding object classes). class that contains it (see Section 5 regarding object classes).
Both are arrays of objects. Each object contains an optional "title" Both are arrays of objects. Each object contains an optional "title"
string representing the title of the object, an optional "type" string representing the title of the object, an optional "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 10.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 4.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",
"description" : "description" :
[ [
"Service subject to The Registry of the Moon's TOS.", "Service subject to The Registry of the Moon's TOS.",
skipping to change at page 12, 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 programmatic use. be registered with IANA (see Section 10.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 12, line 47 skipping to change at page 12, line 47
] ]
} }
] ]
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 4.4. Language Identifier
This data structure consists solely of a name/value pair, where the This data structure consists solely of a name/value pair, where the
name is "lang" and the value is a string containing a language name is "lang" and the value is a string containing a language
identifier as described in [RFC5646]. 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 except for in jCard objects. structure except for in jCard objects.
5.5. Events 4.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 5 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:59Z" "eventDate" : "1990-12-31T23:59:59Z"
}, },
skipping to change at page 13, line 46 skipping to change at page 13, line 46
members: members:
o 'eventAction' -- a string denoting the reason for the event o 'eventAction' -- a string denoting the reason for the event
o 'eventActor' -- an optional identifier denoting the actor o 'eventActor' -- an optional identifier denoting the actor
responsible for the event responsible for the event
o 'eventDate' -- a string containing the time and date the event o 'eventDate' -- a string containing the time and date the event
occurred. occurred.
o 'links' -- see Section 5.2. o 'links' -- see Section 4.2.
Events can be future dated. One use case for future dating of events Events can be future dated. One use case for future dating of events
is to denote when an object expires from a registry. is to denote when an object expires from a registry.
The 'links' array in this data structure is provided for references The 'links' array in this data structure is provided for references
to the event actor. If the event actor being referenced is an RDAP to the event actor. In order to reference an RDAP entity, a "rel" of
entity, the link reference SHOULD be made with "rel" of "related" and "related" and a "type" of "application/rdap+json" is used in the link
"type" of "application/rdap+json". reference.
See Section 11.2.3 for a list of values for the 'eventAction' string. See Section 10.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 4.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 10.2.2 for a
list of values). list of values).
5.7. Port 43 WHOIS Server 4.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 or IP address of the WHOIS [RFC3912] the fully-qualified host name or IP address of the WHOIS [RFC3912]
server where the containing object instance may be found. Note that server where the containing object instance may be found. Note that
this is not a URI, as there is no WHOIS URI scheme. this is not a URI, as there is no WHOIS URI scheme.
5.8. Public IDs 4.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'
The following is an example of a 'publicIds' structure. The following is an example of a 'publicIds' structure.
skipping to change at page 14, line 45 skipping to change at page 14, line 45
"publicIds": "publicIds":
[ [
{ {
"type":"IANA Registrar ID", "type":"IANA Registrar ID",
"identifier":"1" "identifier":"1"
} }
] ]
Figure 11 Figure 11
5.9. Object Class Name 4.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 identifies the type of
identifying the type of object being processed. Servers MUST NOT object being processed. An objectClassName is REQUIRED in all RDAP
omit this string so that clients can more easily identify the type of response objects so that the type of the object can be interpreted.
object.
5.10. An Example 4.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" :
[ [
"rdap_level_0" "rdap_level_0"
], ],
"notices" : "notices" :
skipping to change at page 17, line 5 skipping to change at page 17, line 5
[ [
"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."
] ]
} }
] ]
} }
Figure 12 Figure 12
6. Object Classes 5. Object Classes
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 4.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
described 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 5.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 can 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. Failure to provide any "self" link by a server may object instance. Failure to provide any "self" link by a server may
result in clients being unable to cache object class instances. result in clients being unable to cache object class instances.
Self links SHOULD contain a "type" element containing the Self links MUST contain a "type" element containing the "application/
"application/rdap+json" media type when referencing RDAP object rdap+json" media type when referencing RDAP object instances as
instances as defined by this document. Clients SHOULD NOT assume
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:
"links" : "links" :
[ [
{ {
"value" : "http://example.com/ip/2001:db8::123", "value" : "http://example.com/ip/2001:db8::123",
"rel" : "self", "rel" : "self",
"href" : "http://example.com/ip/2001:db8::123", "href" : "http://example.com/ip/2001:db8::123",
"type" : "application/rdap+json" "type" : "application/rdap+json"
} }
] ]
In addition to the "links" array with a self link, servers SHOULD In addition to the "links" array with a self link, servers SHOULD
provide an "objectClassName" (see Section 5.9) string in each object. provide an "objectClassName" (see Section 4.9) string in each object.
6.1. The Entity Object Class 5.1. The Entity Object Class
The entity object class appears throughout this document and is an The entity object class appears throughout this document and is an
appropriate response for the /entity/XXXX query defined in appropriate response for the /entity/XXXX query defined in
Registration Data Access Protocol Lookup Format Registration Data Access Protocol Lookup Format
[I-D.ietf-weirds-rdap-query]. This object class represents the [I-D.ietf-weirds-rdap-query]. This object class represents the
information of organizations, corporations, governments, non-profits, information of organizations, corporations, governments, non-profits,
clubs, individual persons, and informal groups of people. All of clubs, individual persons, and informal groups of people. All of
these representations are so similar that it is best to represent these representations are so similar that it is best to represent
them in JSON [RFC7159] with one construct, the entity object class, them in JSON [RFC7159] with one construct, the entity object class,
to aid in the re-use of code by implementers. to aid in the re-use of code by implementers.
The entity object is served by both RIRs and DNRs. The following is The entity object is served by both RIRs and DNRs. The following is
an example of an entity that might be served by an RIR. For an example of an entity that might be served by an RIR.
illustrative purposes, it does not include rdapConformance or notices
data structures.
{ {
"objectClassName" : "entity", "objectClassName" : "entity",
"handle":"XXXX", "handle":"XXXX",
"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 20, line 39 skipping to change at page 20, line 36
} }
], ],
"asEventActor":[ "asEventActor":[
{ {
"eventAction":"last changed", "eventAction":"last changed",
"eventDate":"1991-12-31T23:59:59Z" "eventDate":"1991-12-31T23:59:59Z"
} }
] ]
} }
This object has the following members:
o objectClassName -- the string "entity"
o handle -- a string representing an registry unique identifier of
the entity
o vcardArray -- a jCard with the entity's contact information
o roles -- an array of strings, each signifying the relationship an
object would have with its closest containing object (see
Section 10.2.4 for a list of values)
o publicIds - see Section 4.8
o entities - an array of entity objects as defined by this section.
o remarks -- see Section 4.3
o links -- see Section 4.2
o events -- see Section 4.5
o asEventActor -- this data structure takes the same form as the
'events' data structure (see Section 4.5), but each object in the
array MUST NOT have an 'eventActor' member. These objects denote
that the entity is an event actor for the given events. See
Appendix B regarding the various ways events can be modeled.
o status -- see Section 4.6
o port43 -- see Section 4.7
o networks -- an array of IP network objects as defined in
Section 5.4
o autnums -- an array of autnum objects as defined in Section 5.5
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.
{ {
"objectClassName" : "entity", "objectClassName" : "entity",
"handle" : "ANENTITY", "handle" : "ANENTITY",
skipping to change at page 21, line 28 skipping to change at page 22, line 28
"roles" : [ "technical" ], "roles" : [ "technical" ],
... ...
}, },
... ...
], ],
... ...
} }
Figure 13 Figure 13
This object has the following members:
o objectClassName -- the string "entity"
o handle -- a string representing an registry unique identifier of
the entity
o vcardArray -- a JSON vCard with the entity's contact information
o roles -- an array of strings, each signifying the relationship an
object would have with its closest containing object (see
Section 11.2.4 for a list of values)
o publicIds - see Section 5.8
o entities - an array of entity objects as defined by this section.
o remarks -- see Section 5.3
o links -- see Section 5.2
o events -- see Section 5.5
o asEventActor -- this data structure takes the same form as the
'events' data structure (see Section 5.5), but each object in the
array MUST NOT have an 'eventActor' member. These objects denote
that the entity is an event actor for the given events. See
Appendix B regarding the various ways events can be modeled.
o status -- see Section 5.6
o port43 -- see Section 5.7
o networks -- an array of IP network objects as defined in
Section 6.4
o autnums -- an array of autnum objects as defined in Section 6.5
The following is an example of a entity that might be served by a The following is an example of a entity that might be served by a
DNR. For illustrative purposes, it does not include rdapConformance DNR.
or notices data structures.
{ {
"objectClassName" : "entity", "objectClassName" : "entity",
"handle":"XXXX", "handle":"XXXX",
"vcardArray":[ "vcardArray":[
"vcard", "vcard",
[ [
["version", {}, "text", "4.0"], ["version", {}, "text", "4.0"],
["fn", {}, "text", "Joe User"], ["fn", {}, "text", "Joe User"],
["kind", {}, "text", "individual"], ["kind", {}, "text", "individual"],
skipping to change at page 23, line 16 skipping to change at page 23, line 26
"Canada" "Canada"
] ]
], ],
["tel", ["tel",
{ "type":["work", "voice"], "pref":"1" }, { "type":["work", "voice"], "pref":"1" },
"uri", "tel:+1-555-555-1234;ext=102" "uri", "tel:+1-555-555-1234;ext=102"
], ],
["email", ["email",
{ "type":"work" }, { "type":"work" },
"text", "joe.user@example.com" "text", "joe.user@example.com"
], ]
] ]
], ],
"status":[ "validated", "locked" ], "status":[ "validated", "locked" ],
"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 24, line 4 skipping to change at page 24, line 10
"eventAction":"registration", "eventAction":"registration",
"eventDate":"1990-12-31T23:59:59Z" "eventDate":"1990-12-31T23:59:59Z"
}, },
{ {
"eventAction":"last changed", "eventAction":"last changed",
"eventDate":"1991-12-31T23:59:59Z", "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 5.2. The Nameserver Object Class
The nameserver object class represents information regarding DNS name The nameserver object class represents information regarding DNS name
servers used in both forward and reverse DNS. RIRs and some DNRs servers used in both forward and reverse DNS. RIRs and some DNRs
register or expose nameserver information as an attribute of a domain register or expose nameserver information as an attribute of a domain
name, while other DNRs model nameservers as "first class objects". name, while other DNRs model nameservers as "first class objects".
The nameserver object class accommodates both models and degrees of The nameserver object class accommodates both models and degrees of
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.
purposes, it does not include rdapConformance or notices data
structures.
{ {
"objectClassName" : "nameserver", "objectClassName" : "nameserver",
"handle" : "XXXX", "handle" : "XXXX",
"ldhName" : "ns1.xn--fo-5ja.example", "ldhName" : "ns1.xn--fo-5ja.example",
"unicodeName" : "ns1.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" ],
skipping to change at page 26, line 35 skipping to change at page 26, line 35
{ {
"objectClassName" : "nameserver", "objectClassName" : "nameserver",
"ldhName" : "ns1.example.com", "ldhName" : "ns1.example.com",
"ipAddresses" : { "v6" : [ "2001:db8::123", "2001:db8::124" ] } "ipAddresses" : { "v6" : [ "2001:db8::123", "2001:db8::124" ] }
} }
Figure 16 Figure 16
As nameservers can be modeled by some registries to be first-class As nameservers can be modeled by some registries to be first-class
objects, they may also have an array of entities (Section 6.1) objects, they may also have an array of entities (Section 5.1)
embedded to signify parties responsible for the maintenance, embedded to signify parties responsible for the maintenance,
registrations, etc. of the nameservers. registrations, etc. of the nameservers.
The following is an elided example of a nameserver with embedded The following is an elided example of a nameserver with embedded
entities. entities.
{ {
"objectClassName", "nameserver", "objectClassName", "nameserver",
"handle" : "XXXX", "handle" : "XXXX",
"ldhName" : "ns1.xn--fo-5ja.example", "ldhName" : "ns1.xn--fo-5ja.example",
skipping to change at page 27, line 30 skipping to change at page 27, line 30
Figure 17 Figure 17
The nameserver object class has the following members: The nameserver object class has the following members:
o objectClassName - 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 3)
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 3)
o ipAddresses -- an object containing the following members: o ipAddresses -- an object containing the following members:
* v6 -- an array of strings containing IPv6 addresses of the * v6 -- an array of strings containing IPv6 addresses of the
nameserver nameserver
* v4 -- an array of strings containing IPv4 addresses of the * v4 -- an array of strings containing IPv4 addresses of the
nameserver nameserver
o entities -- an array of entity objects as defined by Section 6.1. o entities -- an array of entity objects as defined by Section 5.1.
o status - see Section 5.6 o status - see Section 4.6
o remarks - see Section 5.3 o remarks - see Section 4.3
o links - see Section 5.2 o links - see Section 4.2
o port43 - see Section 5.7 o port43 - see Section 4.7
o events - see Section 5.5 o events - see Section 4.5
6.3. The Domain Object Class 5.3. The Domain Object Class
The domain object class represents a DNS name and point of The domain object class represents a DNS name and point of
delegation. For RIRs these delegation points are in the reverse DNS delegation. For RIRs these delegation points are in the reverse DNS
tree, whereas for DNRs these delegation points are in the forward DNS tree, whereas for DNRs these delegation points are in the forward DNS
tree. tree.
In both cases, the high level structure of the domain object class In both cases, the high level structure of the domain object class
consists of information about the domain registration, nameserver consists of information about the domain registration, nameserver
information related to the domain name, and entities related to the information related to the domain name, and entities related to the
domain name (e.g. registrant information, contacts, etc.). domain name (e.g. registrant information, contacts, etc.).
skipping to change at page 28, line 47 skipping to change at page 28, line 47
} }
The following is a description of the members of this object: The following is a description of the members of this object:
o objectClassName -- 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 3
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 3
o variants -- an array of objects, each containing the following o variants -- an array of objects, each containing the following
values: values:
* relation -- an array of strings, with each string denoting the * relation -- an array of strings, with each string denoting the
relationship between the variants and the containing domain relationship between the variants and the containing domain
object (see Section 11.2.5 for a list of suggested variant object (see Section 10.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 3).
o nameservers -- an array of nameserver objects as defined by o nameservers -- an array of nameserver objects as defined by
Section 6.2 Section 5.2
o secureDNS -- an object with the following members: o secureDNS -- an object with the following members:
* zoneSigned -- 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
skipping to change at page 30, line 9 skipping to change at page 30, line 9
of a DNS DS record as described 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 4.5
+ links - see Section 5.2 + links - see Section 4.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 4.5
+ links - see Section 5.2 + links - see Section 4.2
See Appendix D for background information on these objects. See Appendix D for background information on these objects.
o entities -- an array of entity objects as defined by Section 6.1. o entities -- an array of entity objects as defined by Section 5.1.
o status - see Section 5.6 o status - see Section 4.6
o publicIds - see Section 5.8 o publicIds - see Section 4.8
o remarks - see Section 5.3 o remarks - see Section 4.3
o links - see Section 5.2 o links - see Section 4.2
o port43 - see Section 5.7 o port43 - see Section 4.7
o events - see Section 5.5 o events - see Section 4.5
o network - represents the IP network for which a reverse DNS domain o network - represents the IP network for which a reverse DNS domain
is referenced. See Section 6.4 is referenced. See Section 5.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.
illustrative purposes, it does not include rdapConformance or notices
data structures.
{ {
"objectClassName" : "domain", "objectClassName" : "domain",
"handle" : "XXXX", "handle" : "XXXX",
"ldhName" : "0.2.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"
skipping to change at page 33, line 4 skipping to change at page 32, line 49
{ "type":"work" }, { "type":"work" },
"text", "text",
[ [
"", "",
"Suite 1234", "Suite 1234",
"4321 Rue Somewhere", "4321 Rue Somewhere",
"Quebec", "Quebec",
"QC", "QC",
"G1V 2M2", "G1V 2M2",
"Canada" "Canada"
] ]
], ],
["tel", ["tel",
{ "type":["work", "voice"], "pref":"1" }, { "type":["work", "voice"], "pref":"1" },
"uri", "tel:+1-555-555-1234;ext=102" "uri", "tel:+1-555-555-1234;ext=102"
], ],
["email", ["email",
{ "type":"work" }, { "type":"work" },
"text", "joe.user@example.com" "text", "joe.user@example.com"
], ]
] ]
], ],
"roles" : [ "registrant" ], "roles" : [ "registrant" ],
"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 34, line 18 skipping to change at page 34, line 14
"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" : [ "active" ] "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.
illustrative purposes, it does not include rdapConformance or notices
data structures.
{ {
"objectClassName" : "domain", "objectClassName" : "domain",
"handle" : "XXXX", "handle" : "XXXX",
"ldhName" : "xn--fo-5ja.example", "ldhName" : "xn--fo-5ja.example",
"unicodeName" : "foo.example", "unicodeName" : "foo.example",
"variants" : "variants" :
[ [
{ {
"relation" : [ "registered", "conjoined" ], "relation" : [ "registered", "conjoined" ],
skipping to change at page 39, line 15 skipping to change at page 39, line 9
"Canada" "Canada"
] ]
], ],
["tel", ["tel",
{ "type":["work", "voice"], "pref":"1" }, { "type":["work", "voice"], "pref":"1" },
"uri", "tel:+1-555-555-1234;ext=102" "uri", "tel:+1-555-555-1234;ext=102"
], ],
["email", ["email",
{ "type":"work" }, { "type":"work" },
"text", "joe.user@example.com" "text", "joe.user@example.com"
], ]
] ]
], ],
"status" : [ "validated", "locked" ], "status" : [ "validated", "locked" ],
"roles" : [ "registrant" ], "roles" : [ "registrant" ],
"remarks" : "remarks" :
[ [
{ {
"description" : "description" :
[ [
"She sells sea shells down by the sea shore.", "She sells sea shells down by the sea shore.",
skipping to change at page 40, line 4 skipping to change at page 39, line 46
"eventAction" : "registration", "eventAction" : "registration",
"eventDate" : "1990-12-31T23:59:59Z" "eventDate" : "1990-12-31T23:59:59Z"
}, },
{ {
"eventAction" : "last changed", "eventAction" : "last changed",
"eventDate" : "1991-12-31T23:59:59Z" "eventDate" : "1991-12-31T23:59:59Z"
} }
] ]
} }
] ]
} }
6.4. The IP Network Object Class 5.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
RIRs and is the expected response for the "/ip" query as defined by RIRs and is the expected response for the "/ip" query as defined by
[I-D.ietf-weirds-rdap-query]. There is no equivalent object class [I-D.ietf-weirds-rdap-query]. There is no equivalent object class
for DNRs. The high level structure of the IP network object class for DNRs. The high level structure of the IP network object class
consists of information about the network registration and entities consists of information about the network registration and entities
related to the IP network (e.g. registrant information, contacts, related to the IP network (e.g. registrant information, contacts,
etc...). etc...).
The following is an elided example of the IP network object type The following is an elided example of the IP network object type
skipping to change at page 40, line 31 skipping to change at page 40, line 29
"objectClassName" : "ip network", "objectClassName" : "ip network",
"handle" : "XXX", "handle" : "XXX",
... ...
"entities" : "entities" :
[ [
... ...
] ]
} }
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.
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",
skipping to change at page 42, line 31 skipping to change at page 42, line 27
"Canada" "Canada"
] ]
], ],
["tel", ["tel",
{ "type":["work", "voice"], "pref":"1" }, { "type":["work", "voice"], "pref":"1" },
"uri", "tel:+1-555-555-1234;ext=102" "uri", "tel:+1-555-555-1234;ext=102"
], ],
["email", ["email",
{ "type":"work" }, { "type":"work" },
"text", "joe.user@example.com" "text", "joe.user@example.com"
], ]
] ]
], ],
"roles" : [ "registrant" ], "roles" : [ "registrant" ],
"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 43, line 44 skipping to change at page 43, line 39
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 two-character o country -- a string containing the two-character country code of
country code of the network 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 5.1.
o remarks - see Section 5.3
o links - see Section 5.2 o remarks - see Section 4.3
o links - see Section 4.2
o port43 - see Section 5.7 o port43 - see Section 4.7
o events - see Section 5.5 o events - see Section 4.5
6.5. Autonomous System Number Entity Object Class 5.5. Autonomous System Number Entity Object Class
The Autonomous System Number (autnum) object class models Autonomous The Autonomous System Number (autnum) object class models Autonomous
System Number registrations found in RIRs and represents the expected System Number registrations found in RIRs and represents the expected
response to an "/autnum" query as defined by response to an "/autnum" query as defined by
[I-D.ietf-weirds-rdap-query]. There is no equivalent object class [I-D.ietf-weirds-rdap-query]. There is no equivalent object class
for DNRs. The high level structure of the autnum object class for DNRs. The high level structure of the autnum object class
consists of information about the network registration and entities consists of information about the network registration and entities
related to the autnum registration (e.g. registrant information, related to the autnum registration (e.g. registrant information,
contacts, etc.), and is similar to the IP Network entity object contacts, etc.), and is similar to the IP Network entity object
class. class.
The following is an example of a JSON object representing an autnum. The following is an example of a JSON object representing an autnum.
For illustrative purposes, it does not include rdapConformance or
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" : [ "active" ], "status" : [ "active" ],
"country": "AU", "country": "AU",
skipping to change at page 46, line 16 skipping to change at page 46, line 10
"Canada" "Canada"
] ]
], ],
["tel", ["tel",
{ "type":["work", "voice"], "pref":"1" }, { "type":["work", "voice"], "pref":"1" },
"uri", "tel:+1-555-555-1234;ext=102" "uri", "tel:+1-555-555-1234;ext=102"
], ],
["email", ["email",
{ "type":"work" }, { "type":"work" },
"text", "joe.user@example.com" "text", "joe.user@example.com"
], ]
] ]
], ],
"roles" : [ "registrant" ], "roles" : [ "registrant" ],
"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 47, line 31 skipping to change at page 47, line 24
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
autnum autnum
o status -- an array of strings indicating the state of the autnum o status -- an array of strings indicating the state of the autnum
o country -- a string containing the name of the 2 character country o country -- a string containing the name of the 2 character country
code of the autnum code of the autnum
o entities -- an array of entity objects as defined by Section 6.1. o entities -- an array of entity objects as defined by Section 5.1.
o remarks - see Section 5.3 o remarks - see Section 4.3
o links - see Section 5.2 o links - see Section 4.2
o port43 - see Section 5.7 o port43 - see Section 4.7
o events - see Section 5.5 o events - see Section 4.5
7. Error Response Body 6. 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" and 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.
purposes, it does not include rdapConformance or notices data
structures.
{ {
"errorCode": 418, "errorCode": 418,
"title": "Your beverage choice is not available", "title": "Your beverage choice is not available",
"description": "description":
[ [
"I know coffee has more ummppphhh.", "I know coffee has more ummppphhh.",
"Sorry, dude!" "Sorry, dude!"
] ]
} }
Figure 18 Figure 18
A client MAY simply use the HTTP response code as the server is not
required to include error data in the response body. However, if a
client wishes to parse the error data, it SHOULD first check that the
Content-Type header contains the appropriate media type.
This is an example of the common response body with and This is an example of the common response body with and
rdapConformance and notices data structures: rdapConformance and notices data structures:
{ {
"rdapConformance" : "rdapConformance" :
[ [
"rdap_level_0" "rdap_level_0"
], ],
"notices" : "notices" :
[ [
skipping to change at page 49, line 44 skipping to change at page 49, line 44
"title": "Your beverage choice is not available", "title": "Your beverage choice is not available",
"description": "description":
[ [
"I know coffee has more ummppphhh.", "I know coffee has more ummppphhh.",
"Sorry, dude!" "Sorry, dude!"
] ]
} }
Figure 19 Figure 19
8. Responding to Help Queries 7. Responding to Help Queries
The appropriate response to /help queries as defined by The appropriate response to /help queries as defined by
[I-D.ietf-weirds-rdap-query] is to use the notices structure as [I-D.ietf-weirds-rdap-query] is to use the notices structure as
defined in Section 5.3. defined in Section 4.3.
This is an example of a response to a /help query including the This is an example of a response to a /help query including the
rdapConformance data structure. rdapConformance data structure.
{ {
"rdapConformance" : "rdapConformance" :
[ [
"rdap_level_0" "rdap_level_0"
], ],
"notices" : "notices" :
skipping to change at page 50, line 36 skipping to change at page 50, line 36
"type" : "text/html", "type" : "text/html",
"href" : "http://www.example.com/auth_policy.html" "href" : "http://www.example.com/auth_policy.html"
} }
] ]
} }
] ]
} }
Figure 20 Figure 20
9. Responding To Searches 8. Responding To Searches
[I-D.ietf-weirds-rdap-query] specifies three types of searches: [I-D.ietf-weirds-rdap-query] specifies three types of searches:
domains, nameservers, and entities. Responses to these searches take domains, nameservers, and entities. Responses to these searches take
the form of an array of object instances where each instance is an the form of an array of object instances where each instance is an
appropriate object class for the search (i.e. a search for /domains appropriate object class for the search (i.e. a search for /domains
yields an array of domain object instances). These arrays are yields an array of domain object instances). These arrays are
contained within the response object. contained within the response object.
The names of the arrays are as follows: The names of the arrays are as follows:
skipping to change at page 51, line 30 skipping to change at page 51, line 30
{ {
"handle" : "2-XXXX", "handle" : "2-XXXX",
"ldhName" : "2.example.com", "ldhName" : "2.example.com",
... ...
} }
] ]
} }
search_response_example search_response_example
10. Indicating Truncated Responses 9. Indicating Truncated Responses
In cases where the data of a response has been truncated (i.e. not In cases where the data of a response has been truncated (i.e. not
all of it has been included in the response), a server may indicate all of it has been included in the response), a server may indicate
this by including a typed notice in the response object. this by including a typed notice in the response object.
The following is an elided example of a search response that has been The following is an elided example of a search response that has been
truncated. truncated.
{ {
"rdapConformance" : "rdapConformance" :
skipping to change at page 54, line 5 skipping to change at page 54, line 5
"type" : "text/html", "type" : "text/html",
"href" : "http://www.example.com/data_policy.html" "href" : "http://www.example.com/data_policy.html"
} }
] ]
} }
] ]
} }
Figure 21 Figure 21
11. IANA Considerations 10. IANA Considerations
11.1. RDAP JSON Media Type Registration 10.1. RDAP JSON Media Type Registration
This specification registers the "application/rdap+json" media type. This specification registers the "application/rdap+json" media type.
Type name: application Type name: application
Subtype name: rdap+json Subtype name: rdap+json
Required parameters: n/a Required parameters: n/a
Encoding considerations: See section 3.1 of [RFC6839]. Encoding considerations: See section 3.1 of [RFC6839].
skipping to change at page 54, line 37 skipping to change at page 54, line 37
Applications that use this media type: Implementations of the Applications that use this media type: Implementations of the
Registration Data Access Protocol (RDAP) Registration Data Access Protocol (RDAP)
Additional information: This media type is a product of the IETF Additional information: This media type is a product of the IETF
WEIRDS working group. The WEIRDS charter, information on the WEIRDS working group. The WEIRDS charter, information on the
WEIRDS mailing list, and other documents produced by the WEIRDS WEIRDS mailing list, and other documents produced by the WEIRDS
working group can be found at https://datatracker.ietf.org/wg/ working group can be found at https://datatracker.ietf.org/wg/
weirds/ weirds/
Person & email address to contact for further information: Andy Person & email address to contact for further information: IESG
Newton <andy@hxr.us> <iesg@ietf.org>
Intended usage: COMMON Intended usage: COMMON
Restrictions on usage: none Restrictions on usage: none
Author: Andy Newton Author: Andy Newton
Change controller: IETF Change controller: IETF
Provisional Registration: No (upon publication of this RFC) Provisional Registration: No (upon publication of this RFC)
11.2. JSON Values Registry 10.2. JSON Values Registry
This section requests that the IANA establish an RDAP JSON Values This section requests that the IANA establish an RDAP JSON Values
Registry for use in the notices and remarks (Section 5.3), status Registry for use in the notices and remarks (Section 4.3), status
(Section 5.6), role (Section 6.1), event action (Section 5.5), and (Section 4.6), role (Section 5.1), event action (Section 4.5), and
domain variant relation (Section 6.3) fields specified in RDAP. domain variant relation (Section 5.3) fields specified in RDAP.
Each entry in the registry should contain the following fields: Each entry in the registry should contain the following fields:
1. Value - the string value being registered. 1. Value - the string value being registered.
2. Type - the type of value being registered. It should be one of 2. Type - the type of value being registered. It should be one of
the following: the following:
* 'notice or remark type' - denotes a type of notice or remark * 'notice or remark type' - denotes a type of notice or remark
* 'status' - denotes a value for the 'status' object member as * 'status' - denotes a value for the 'status' object member as
defined by Section 5.6. defined by Section 4.6.
* 'role' - denotes a value for the 'role' array as defined in * 'role' - denotes a value for the 'role' array as defined in
Section 6.1. Section 5.1.
* 'event action' - denotes a value for an event action as * 'event action' - denotes a value for an event action as
defined in Section 5.5. defined in Section 4.5.
* 'domain variant relation' - denotes a relationship between a * 'domain variant relation' - denotes a relationship between a
domain and a domain variant as defined in Section 6.3. domain and a domain variant as defined in Section 5.3.
3. Description - a one or two sentence description regarding the 3. Description - a one or two sentence description regarding the
meaning of the value, how it might be used, and/or how it should meaning of the value, how it might be used, and/or how it should
be interpreted by clients. be interpreted by clients.
4. Registrant Name - the name of the person registering the value. 4. Registrant Name - the name of the person registering the value.
5. Registrant Contact Information - an email address, postal 5. Registrant Contact Information - an email address, postal
address, or some other information to be used to contact the address, or some other information to be used to contact the
registrant. registrant.
This registry should be governed by a designated expert or multiple This registry is to be operated under the "Expert Review" policy
designated experts. Registration of values into this registry should defined in [RFC5226].
be accomplished by providing the information above to the designated
expert(s).
Review of registrations into this registry by the designated Review of registrations into this registry by the designated
expert(s) should be narrowly judged on the following criteria: expert(s) should be narrowly judged on the following criteria:
1. Values in need of being placed into multiple types must be 1. Values in need of being placed into multiple types must be
assigned a separate registration for each type. assigned a separate registration for each type.
2. Values must be strings. They should be multiple words separated 2. Values must be strings. They should be multiple words separated
by single space characters. Every character should be by single space characters. Every character should be
lowercased. If possible, every word should be given in English lowercased. If possible, every word should be given in English
skipping to change at page 56, line 25 skipping to change at page 56, line 25
denote a holder of a domain name or Internet number resource. In denote a holder of a domain name or Internet number resource. In
cases where it may be reasonably argued that machine cases where it may be reasonably argued that machine
interpretation of two similar values may alter the operation of interpretation of two similar values may alter the operation of
client software, designated experts should not judge the values client software, designated experts should not judge the values
to be of significant similarity. to be of significant similarity.
4. Registrations should be relevant to the common usages of RDAP. 4. Registrations should be relevant to the common usages of RDAP.
Designated experts may rely upon the serving of the value by a Designated experts may rely upon the serving of the value by a
DNR or RIR to make this determination. DNR or RIR to make this determination.
11.2.1. Notice and Remark Types The following sections provide initial registrations into this
registry.
10.2.1. Notice and Remark Types
This section registers the following values into the RDAP JSON Values This section registers the following values into the RDAP JSON Values
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 yield a longer result clients that proper authorization will yield a longer result
set. set.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
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
yield a longer result set. yield a longer result set.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
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
* Description: The list of results does not contain all results * Description: The list of results does not contain all results
for an unexplainable reason. This may indicate to some for an unexplainable reason. This may indicate to some
clients that requerying for any reason will not yield a longer clients that requerying for any reason will not yield a longer
result set. result set.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
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. of authorization.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
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 yield 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: IESG
* Registrant Contact Information: andy@hxr.us
* Registrant Contact Information: iesg@ietf.org
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. unexplainable reason.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
11.2.2. Status 10.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:
1. 1.
* Value: validated * Value: validated
* Type: status * Type: status
* Description: Signifies that the data of the object instance * Description: Signifies that the data of the object instance
has been found to be accurate. This type of status is has been found to be accurate. This type of status is
usually found on entity object instances to note the validity usually found on entity object instances to note the validity
of identifying contact information. of identifying contact information.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
2. 2.
* Value: renew prohibited * Value: renew prohibited
* Type: status * Type: status
* Description: Renewal or reregistration of the object instance * Description: Renewal or reregistration of the object instance
is forbidden. is forbidden.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: iesg@ietf.org
* Registrant Contact Information: andy@hxr.us
3. 3.
* Value: update prohibited * Value: update prohibited
* Type: status * Type: status
* Description: Updates to the object instance are forbidden. * Description: Updates to the object instance are forbidden.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
4. 4.
* Value: transfer prohibited * Value: transfer prohibited
* Type: status * Type: status
* Description: Transfers of the registration from one registrar * Description: Transfers of the registration from one registrar
to another are forbidden. This type of status normally to another are forbidden. This type of status normally
applies to DNR domain names. applies to DNR domain names.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
5. 5.
* Value: delete prohibited * Value: delete prohibited
* Type: status * Type: status
* Description: Deletion of the registration of the object * Description: Deletion of the registration of the object
instance is forbidden. This type of status normally applies instance is forbidden. This type of status normally applies
to DNR domain names. to DNR domain names.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
6. 6.
* Value: proxy * Value: proxy
* Type: status * Type: status
* Description: The registration of the object instance has been * Description: The registration of the object instance has been
performed by a third party. This is most commonly applied to performed by a third party. This is most commonly applied to
entities. entities.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
7. 7.
* Value: private * Value: private
* Type: status * Type: status
* Description: The information of the object instance is not * Description: The information of the object instance is not
designated for public consumption. This is most commonly designated for public consumption. This is most commonly
applied to entities. applied to entities.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
8. 8.
* Value: redacted * Value: redacted
* Type: status * Type: status
* Description: Some of the information of the object instance * Description: Some of the information of the object instance
has not been made available. This is most commonly applied has not been made available. This is most commonly applied
to entities. to entities.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
9. 9.
* Value: obscured * Value: obscured
* Type: status * Type: status
* Description: Some of the information of the object instance * Description: Some of the information of the object instance
has been altered for the purposes of not readily revealing has been altered for the purposes of not readily revealing
the actual information of the object instance. This is most the actual information of the object instance. This is most
commonly applied to entities. commonly applied to entities.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
10. 10.
* Value: associated * Value: associated
* Type: status * Type: status
* Description: The object instance is associated with other * Description: The object instance is associated with other
object instances in the registry. This is most commonly used object instances in the registry. This is most commonly used
to signify that a nameserver is associated with a domain or to signify that a nameserver is associated with a domain or
that an entity is associated with a network resource or that an entity is associated with a network resource or
domain. domain.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
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 Extensible Provisioning Protocol (EPP) This maps to the Extensible Provisioning Protocol (EPP)
[RFC5730] 'OK' status. [RFC5730] 'OK' status.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
12. 12.
* Value: inactive * Value: inactive
* Type: status * Type: status
* Description: The object instance is not in use. See * Description: The object instance is not in use. See
'active'. 'active'.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
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 association of other object instances. including the association of other object instances.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
14. 14.
* Value: pending create * Value: pending create
* Type: status * Type: status
* Description: A request has been received for the creation of * Description: A request has been received for the creation of
the object instance but this action is not yet complete. the object instance but this action is not yet complete.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
15. 15.
* Value: pending renew * Value: pending renew
* Type: status * Type: status
* Description: A request has been received for the renewal of * Description: A request has been received for the renewal of
the object instance but this action is not yet complete. the object instance but this action is not yet complete.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
16. 16.
* Value: pending transfer * Value: pending transfer
* Type: status * Type: status
* Description: A request has been received for the transfer of * Description: A request has been received for the transfer of
the object instance but this action is not yet complete. the object instance but this action is not yet complete.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
17. 17.
* Value: pending update * Value: pending update
* Type: status * Type: status
* Description: A request has been received for the update or * Description: A request has been received for the update or
modification of the object instance but this action is not modification of the object instance but this action is not
yet complete. yet complete.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
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 is 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: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
11.2.3. Event Actions 10.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
Registry: Registry:
1. 1.
* Value: registration * Value: registration
* Type: event action * Type: event action
* Description: The object instance was initially registered. * Description: The object instance was initially registered.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
2. 2.
* Value: reregistration * Value: reregistration
* Type: event action * Type: event action
* Description: The object instance was registered subsequently * Description: The object instance was registered subsequently
to initial registration. to initial registration.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
3. 3.
* Value: last changed * Value: last changed
* Type: event action * Type: event action
* Description: An action noting when the information in the * Description: An action noting when the information in the
object instance was last changed. object instance was last changed.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
4. 4.
* Value: expiration * Value: expiration
* Type: event action * Type: event action
* Description: The object instance has been removed or will be * Description: The object instance has been removed or will be
removed at a pre-determined date and time from the registry. removed at a pre-determined date and time from the registry.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
5. 5.
* Value: deletion * Value: deletion
* Type: event action * Type: event action
* Description: The object instance was removed from the registry * Description: The object instance was removed from the registry
at a point in time that was not pre-determined. at a point in time that was not pre-determined.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
6. 6.
* Value: reinstantiation * Value: reinstantiation
* Type: event action * Type: event action
* Description: The object instance was reregistered after having * Description: The object instance was reregistered after having
been removed from the registry. been removed from the registry.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
7. 7.
* Value: transfer * Value: transfer
* Type: event action * Type: event action
* Description: The object instance was transferred from one * Description: The object instance was transferred from one
registrant to another. registrant to another.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
8. 8.
* Value: locked * Value: locked
* Type: event action * Type: event action
* Description: The object instance was locked (see the 'locked' * Description: The object instance was locked (see the 'locked'
status). status).
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
9. 9.
* Value: unlocked * Value: unlocked
* Type: event action * Type: event action
* Description: The object instance was unlocked (see the * Description: The object instance was unlocked (see the
'locked' status). 'locked' status).
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
11.2.4. Roles 10.2.4. Roles
This section registers the following values into the RDAP JSON Values This section registers the following values into the RDAP JSON Values
Registry: Registry:
1. 1.
* Value: registrant * Value: registrant
* Type: role * Type: role
* Description: The entity object instance is the registrant of * Description: The entity object instance is the registrant of
the registration. In some registries, this is known as a the registration. In some registries, this is known as a
maintainer. maintainer.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
2. 2.
* Value: technical * Value: technical
* Type: role * Type: role
* Description: The entity object instance is a technical * Description: The entity object instance is a technical
contact for the registration. contact for the registration.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
3. 3.
* Value: administrative * Value: administrative
* Type: role * Type: role
* Description: The entity object instance is an administrative * Description: The entity object instance is an administrative
contact for the registration. contact for the registration.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
4. 4.
* Value: abuse * Value: abuse
* Type: role * Type: role
* Description: The entity object instance handles network abuse * Description: The entity object instance handles network abuse
issues on behalf of the registrant of the registration. issues on behalf of the registrant of the registration.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
5. 5.
* Value: billing * Value: billing
* Type: role * Type: role
* Description: The entity object instance handles payment and * Description: The entity object instance handles payment and
billing issues on behalf of the registrant of the billing issues on behalf of the registrant of the
registration. registration.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
6. 6.
* Value: registrar * Value: registrar
* Type: role * Type: role
* Description: The entity object instance represents the * Description: The entity object instance represents the
authority responsible for the registration in the registry. authority responsible for the registration in the registry.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
7. 7.
* Value: reseller * Value: reseller
* Type: role * Type: role
* Description: The entity object instance represents a third * Description: The entity object instance represents a third
party through which the registration was conducted (i.e. not party through which the registration was conducted (i.e. not
the registry or registrar). the registry or registrar).
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
8. 8.
* Value: sponsor * Value: sponsor
* Type: role * Type: role
* Description: The entity object instance represents a domain * Description: The entity object instance represents a domain
policy sponsor, such as an ICANN approved sponsor. policy sponsor, such as an ICANN approved sponsor.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
9. 9.
* Value: proxy * Value: proxy
* Type: role * Type: role
* Description: The entity object instance represents a proxy * Description: The entity object instance represents a proxy
for another entity object, such as a registrant. for another entity object, such as a registrant.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
10. 10.
* Value: notifications * Value: notifications
* Type: role * Type: role
* Description: An entity object instance designated to receive * Description: An entity object instance designated to receive
notifications about association object instances. notifications about association object instances.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
11. 11.
* Value: noc * Value: noc
* Type: role * Type: role
* Description: The entity object instance handles * Description: The entity object instance handles
communications related to a network operations center (NOC). communications related to a network operations center (NOC).
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
11.2.5. Variant Relations 10.2.5. Variant Relations
This section registers the following values into the RDAP JSON Values This section registers the following values into the RDAP JSON Values
Registry: Registry:
1. 1.
* Value: registered * Value: registered
* Type: domain variant relation * Type: domain variant relation
* Description: The variant names are registered in the registry. * Description: The variant names are registered in the registry.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
2. 2.
* Value: unregistered * Value: unregistered
* Type: domain variant relation * Type: domain variant relation
* Description: The variant names are not found in the registry. * Description: The variant names are not found in the registry.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
3. 3.
* Value: registration restricted * Value: registration restricted
* Type: domain variant relation * Type: domain variant relation
* Description: Registration of the variant names is restricted * Description: Registration of the variant names is restricted
to certain parties or within certain rules. to certain parties or within certain rules.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
4. 4.
* Value: open registration * Value: open registration
* Type: domain variant relation * Type: domain variant relation
* Description: Registration of the variant names is available to * Description: Registration of the variant names is available to
generally qualified registrants. generally qualified registrants.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
5. 5.
* Value: conjoined * Value: conjoined
* Type: domain variant relation * Type: domain variant relation
* Description: Registration of the variant names occurs * Description: Registration of the variant names occurs
automatically with the registration of the containing domain automatically with the registration of the containing domain
registration. registration.
* Registrant Name: Andrew Newton * Registrant Name: IESG
* Registrant Contact Information: andy@hxr.us * Registrant Contact Information: iesg@ietf.org
12. Security Considerations 11. 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 Though not specific to JSON, RDAP implementers should be aware of the
security considerations specified in [I-D.ietf-weirds-using-http] and security considerations specified in [I-D.ietf-weirds-using-http] and
the security requirements and considerations in the security requirements and considerations in
[I-D.ietf-weirds-rdap-sec]. [I-D.ietf-weirds-rdap-sec].
13. Internationalization Considerations 12. Internationalization Considerations
13.1. Character Encoding 12.1. Character Encoding
The default text encoding for JSON 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.
and clients MAY optionally support other character encodings.
13.2. URIs and IRIs 12.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 12.3. Language Tags
Section 5.4 defines the use of language tags in the JSON responses Section 4.4 defines the use of language tags in the JSON responses
defined in this document. defined in this document.
13.4. Internationalized Domain Names 12.4. Internationalized Domain Names
Internationalized Domain Names (IDNs) are denoted in this Internationalized Domain Names (IDNs) are denoted in this
specification by the separation of DNS names in LDH form and Unicode specification by the separation of DNS names in LDH form and Unicode
form (see Section 4). Representation of IDNs in registries is form (see Section 3). Representation of IDNs in registries is
described by the "variants" object in Section 6.3 and the suggested described by the "variants" object in Section 5.3 and the suggested
values listed in Section 11.2.5. values listed in Section 10.2.5.
14. Privacy Considerations 13. Privacy Considerations
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 10.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 14. 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 work 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
skipping to change at page 72, line 17 skipping to change at page 72, line 14
provided text regarding the processing of unknown JSON attributes and provided text regarding the processing of unknown JSON attributes and
identified issues leading to the remodeling of events. Ernie Dainow identified issues leading to the remodeling of events. Ernie Dainow
and Francisco Obispo provided concrete suggestions that led to a and Francisco Obispo provided concrete suggestions that led to a
better variant model for 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 jCard (JSON vCard) was performed
Perreault. by Simon Perreault.
Olaf Kolkman and Murray Kucherawy chaired the IETF's WEIRDS working Olaf Kolkman and Murray Kucherawy chaired the IETF's WEIRDS working
group from which this document as been created. group from which this document as been created.
16. References 15. References
16.1. Normative References
[RFC1166] Kirkpatrick, S., Stahl, M., and M. Recker, "Internet 15.1. Normative References
numbers", RFC 1166, July 1990.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997. 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.
[RFC4034] Arends, R., Austein, R., Larson, M., Massey, D., and S. [RFC4034] Arends, R., Austein, R., Larson, M., Massey, D., and S.
Rose, "Resource Records for the DNS Security Extensions", Rose, "Resource Records for the DNS Security Extensions",
RFC 4034, March 2005. RFC 4034, March 2005.
[RFC5226] Narten, T. and H. Alvestrand, "Guidelines for Writing an
IANA Considerations Section in RFCs", BCP 26, RFC 5226,
May 2008.
[RFC5396] Huston, G. and G. Michaelson, "Textual Representation of [RFC5396] Huston, G. and G. Michaelson, "Textual Representation of
Autonomous System (AS) Numbers", RFC 5396, December 2008. Autonomous System (AS) Numbers", RFC 5396, December 2008.
[RFC5646] Phillips, A. and M. Davis, "Tags for Identifying [RFC5646] Phillips, A. and M. Davis, "Tags for Identifying
Languages", BCP 47, RFC 5646, September 2009. Languages", BCP 47, RFC 5646, September 2009.
[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.
skipping to change at page 73, line 23 skipping to change at page 73, line 23
[RFC7095] Kewisch, P., "jCard: The JSON Format for vCard", RFC 7095, [RFC7095] Kewisch, P., "jCard: The JSON Format for vCard", RFC 7095,
January 2014. 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-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-11 (work in progress), September 2014. weirds-using-http-12 (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-13 Protocol Query Format", draft-ietf-weirds-rdap-query-14
(work in progress), August 2014. (work in progress), September 2014.
[I-D.ietf-weirds-rdap-sec] [I-D.ietf-weirds-rdap-sec]
Hollenbeck, S. and N. Kong, "Security Services for the Hollenbeck, S. and N. Kong, "Security Services for the
Registration Data Access Protocol", draft-ietf-weirds- Registration Data Access Protocol", draft-ietf-weirds-
rdap-sec-08 (work in progress), August 2014. rdap-sec-09 (work in progress), September 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 15.2. Informative References
[RFC3912] Daigle, L., "WHOIS Protocol Specification", RFC 3912, [RFC3912] Daigle, L., "WHOIS Protocol Specification", RFC 3912,
September 2004. September 2004.
[RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)",
STD 69, RFC 5730, August 2009. STD 69, RFC 5730, August 2009.
[RFC5910] Gould, J. and S. Hollenbeck, "Domain Name System (DNS) [RFC5910] Gould, J. and S. Hollenbeck, "Domain Name System (DNS)
Security Extensions Mapping for the Extensible Security Extensions Mapping for the Extensible
Provisioning Protocol (EPP)", RFC 5910, May 2010. Provisioning Protocol (EPP)", RFC 5910, May 2010.
skipping to change at page 74, line 34 skipping to change at page 74, line 34
Appendix A. Suggested Data Modeling with the Entity Object Class Appendix A. Suggested Data Modeling with the Entity Object Class
A.1. Registrants and Contacts A.1. Registrants and Contacts
This document does not provide specific object classes for This document does not provide specific object classes for
registrants and contacts. Instead the entity object class may be registrants and contacts. Instead the entity object class may be
used to represent a registrant or contact. When the entity object is used to represent a registrant or contact. When the entity object is
embedded inside a containing object such as a domain name or IP embedded inside a containing object such as a domain name or IP
network, the 'roles' string array can be used to signify the network, the 'roles' string array can be used to signify the
relationship. It is recommended that the values from Section 11.2.4 relationship. It is recommended that the values from Section 10.2.4
be used. be used.
The following is an example of an elided containing object with an The following is an example of an elided containing object with an
embedded entity that is both a registrant and administrative contact: embedded entity that is both a registrant and administrative contact:
{ {
... ...
"entities" : "entities" :
[ [
{ {
skipping to change at page 75, line 37 skipping to change at page 75, line 37
"Canada" "Canada"
] ]
], ],
["tel", ["tel",
{ "type":["work", "voice"], "pref":"1" }, { "type":["work", "voice"], "pref":"1" },
"uri", "tel:+1-555-555-1234;ext=102" "uri", "tel:+1-555-555-1234;ext=102"
], ],
["email", ["email",
{ "type":"work" }, { "type":"work" },
"text", "joe.user@example.com" "text", "joe.user@example.com"
], ]
] ]
], ],
"roles" : [ "registrant", "administrative" ], "roles" : [ "registrant", "administrative" ],
"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 76, line 20 skipping to change at page 76, line 20
"eventDate" : "1991-12-31T23:59:59Z" "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 10.2.2).
The following is an elided example of a registrant with information The following is an elided example of a registrant with information
changed to reflect that of a third party. changed to reflect that of a third party.
{ {
... ...
"entities" : "entities" :
[ [
{ {
"objectClassName" : "entity", "objectClassName" : "entity",
skipping to change at page 76, line 45 skipping to change at page 76, line 45
} }
] ]
} }
A.2. Registrars A.2. Registrars
This document does not provide a specific object class for This document does not provide a specific object class for
registrars, but like registrants and contacts (see Appendix A.1) the registrars, but like registrants and contacts (see Appendix A.1) the
'roles' string array maybe used. Additionally, many registrars have 'roles' string array maybe used. Additionally, many registrars have
publicly assigned identifiers. The 'publicIds' structure publicly assigned identifiers. The 'publicIds' structure
(Section 5.8) represents that information. (Section 4.8) represents that information.
The following is an example of an elided containing object with an The following is an example of an elided containing object with an
embedded entity that is a registrar: embedded entity that is a registrar:
{ {
... ...
"entities":[ "entities":[
{ {
"objectClassName" : "entity", "objectClassName" : "entity",
"handle":"XXXX", "handle":"XXXX",
skipping to change at page 77, line 49 skipping to change at page 77, line 49
["tel", ["tel",
{ {
"type":["work", "voice"], "type":["work", "voice"],
"pref":"1" "pref":"1"
}, },
"uri", "tel:+1-555-555-1234;ext=102" "uri", "tel:+1-555-555-1234;ext=102"
], ],
["email", ["email",
{ "type":"work" }, { "type":"work" },
"text", "joes_fish_chips_and_domains@example.com" "text", "joes_fish_chips_and_domains@example.com"
], ]
] ]
], ],
"roles":[ "registrar" ], "roles":[ "registrar" ],
"publicIds":[ "publicIds":[
{ {
"type":"IANA Registrar ID", "type":"IANA Registrar ID",
"identifier":"1" "identifier":"1"
} }
], ],
"remarks":[ "remarks":[
skipping to change at page 78, line 46 skipping to change at page 78, line 46
not captured. not captured.
Events can be modeled in three ways: Events can be modeled in three ways:
1. events with no designated actor 1. events with no designated actor
2. events where the actor is only designated by an identifier 2. events where the actor is only designated by an identifier
3. events where the actor can be modeled as an entity 3. events where the actor can be modeled as an entity
For the first use case, the 'events' data structure (Section 5.5) is For the first use case, the 'events' data structure (Section 4.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:59Z" "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 4.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:59Z" "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 5.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.
The following is an elided example of a domain object with an entity The following is an elided example of a domain object with an entity
as an event actor. as an event actor.
{ {
"objectClassName" : "domain", "objectClassName" : "domain",
"handle" : "XXXX", "handle" : "XXXX",
"ldhName" : "foo.example", "ldhName" : "foo.example",
skipping to change at page 80, line 32 skipping to change at page 80, line 32
"eventAction" : "last changed", "eventAction" : "last changed",
"eventDate" : "1990-12-31T23:59:59Z" "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 [RFC7095] to The entity (Section 5.1) object class uses jCard [RFC7095] to
represent contact information, including postal addresses. jCard has represent contact information, including postal addresses. jCard has
the ability to represent multiple language preferences, multiple the ability to represent multiple language preferences, multiple
email address and phone numbers, and multiple postal addresses in email address and phone numbers, and multiple postal addresses in
both a structured and unstructured format. This section describes both a structured and unstructured format. This section describes
the use of jCard for representing structured and unstructured the use of jCard for representing structured and unstructured
addresses. addresses.
The following is an example of a jCard. The following is an example of a jCard.
{ {
skipping to change at page 83, line 12 skipping to change at page 83, line 12
7. country name (full name) - Canada 7. country name (full name) - Canada
The second example is an unstructured address. It uses the label The second example is an unstructured address. It uses the label
attribute, which is a string containing a newline (\n) character to attribute, which is a string containing a newline (\n) character to
separate address components in an unordered, unspecified manner. separate address components in an unordered, unspecified manner.
Note that in this example the structured address array is still given Note that in this example the structured address array is still given
but that each string is an empty string. but that each string is an empty string.
Appendix D. Secure DNS Appendix D. Secure DNS
Section 6.3 defines the "secureDNS" member to represent secure DNS Section 5.3 defines the "secureDNS" member to represent secure DNS
information about domain names. information about domain names.
DNSSEC provides data integrity for DNS through digital signing of DNSSEC provides data integrity for DNS through digital signing of
resource records. To enable DNSSEC, the zone is signed by one or resource records. To enable DNSSEC, the zone is signed by one or
more private keys and the signatures stored as RRSIG records. To more private keys and the signatures stored as RRSIG records. To
complete the chain of trust in the DNS zone hierarchy, a digest of complete the chain of trust in the DNS zone hierarchy, a digest of
each DNSKEY record (which contains the public key) must be loaded each DNSKEY record (which contains the public key) must be loaded
into the parent zone, stored as Delegation Signer (DS) records and into the parent zone, stored as Delegation Signer (DS) records and
signed by the parent's private key (RRSIG DS record), "Resource signed by the parent's private key (RRSIG DS record), "Resource
Records for the DNS Security Extensions" [RFC4034]. Creating the DS Records for the DNS Security Extensions" [RFC4034]. Creating the DS
records in the parent zone can be done by the registration authority, records in the parent zone can be done by the registration authority,
"Domain Name System (DNS) Security Extensions Mapping for the "Domain Name System (DNS) Security Extensions Mapping for the
Extensible Provisioning Protocol (EPP)" [RFC5910]. Extensible Provisioning Protocol (EPP)" [RFC5910].
Only DS related information is provided by RDAP, since other Only DS related information is provided by RDAP, since other
information is not generally stored in the registration database. information is not generally stored in the registration database.
Other DNSSEC related information can be retrieved with other DNS Other DNSSEC related information can be retrieved with other DNS
tools such as dig. tools such as dig.
The domain object class (Section 6.3) can represent this information The domain object class (Section 5.3) can represent this information
using either the 'dsData' or 'keyData' object arrays. Client using either the 'dsData' or 'keyData' object arrays. Client
implementers should be aware that some registries do not collect or implementers should be aware that some registries do not collect or
do not publish all of the secure DNS meta-information. do not publish all of the secure DNS meta-information.
Appendix E. Motivations for Using JSON Appendix E. Motivations for Using JSON
This section addresses a common question regarding the use of JSON This section addresses a common question regarding the use of JSON
over other data formats, most notably XML. over other data formats, most notably XML.
It is often pointed out that many DNRs and one RIR support the EPP It is often pointed out that many DNRs and one RIR support the EPP
skipping to change at page 90, line 5 skipping to change at page 89, line 52
"port43" can now be either an domain name or IP address. "port43" can now be either an domain name or IP address.
"objectClassName" is now required. "objectClassName" is now required.
Numerous changes in prose for better readability. Numerous changes in prose for better readability.
Updated the security considerations section to point to using- Updated the security considerations section to point to using-
http and rdap-sec. http and rdap-sec.
-10
Addressing many AD comments.
Changed IANA registrations to IESG.
'href' is now the only MUST in the a link.
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
 End of changes. 247 change blocks. 
428 lines changed or deleted 409 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/