JSON Responses for the Registration Data Access Protocol (RDAP)
draft-ietf-weirds-json-response-11
The information below is for an old version of the document.
| Document | Type |
This is an older version of an Internet-Draft that was ultimately published as RFC 7483.
|
|
|---|---|---|---|
| Authors | Andy Newton , Scott Hollenbeck | ||
| Last updated | 2014-10-30 (Latest revision 2014-10-28) | ||
| Replaces | draft-newton-weirds-unified-json-response | ||
| RFC stream | Internet Engineering Task Force (IETF) | ||
| Formats | |||
| Reviews | |||
| Additional resources | Mailing list discussion | ||
| Stream | WG state | Submitted to IESG for Publication | |
| Document shepherd | Murray Kucherawy | ||
| Shepherd write-up | Show Last changed 2014-09-23 | ||
| IESG | IESG state | Became RFC 7483 (Proposed Standard) | |
| Consensus boilerplate | Yes | ||
| Telechat date |
(None)
Needs a YES. Needs 10 more YES or NO OBJECTION positions to pass. |
||
| Responsible AD | Pete Resnick | ||
| Send notices to | weirds-chairs@tools.ietf.org, draft-ietf-weirds-json-response@tools.ietf.org, weirds@ietf.org | ||
| IANA | IANA review state | IANA OK - Actions Needed |
draft-ietf-weirds-json-response-11
Newton & Hollenbeck Expires April 30, 2015 [Page 33] Internet-Draft RDAP JSON RESPONSES October 2014 "ipVersion" : "v6", "name": "NET-RTR-1", "type" : "DIRECT ALLOCATION", "country" : "AU", "parentHandle" : "YYYY-RIR", "status" : [ "active" ] } } The following is an example of a JSON domain object representing a forward DNS delegation point that might be served by a DNR. { "objectClassName" : "domain", "handle" : "XXXX", "ldhName" : "xn--fo-5ja.example", "unicodeName" : "foo.example", "variants" : [ { "relation" : [ "registered", "conjoined" ], "variantNames" : [ { "ldhName" : "xn--fo-cka.example", "unicodeName" : "foo.example" }, { "ldhName" : "xn--fo-fka.example", "unicodeName" : "foeo.example" } ] }, { "relation" : [ "unregistered", "registration restricted" ], "idnTable": ".EXAMPLE Swedish", "variantNames" : [ { "ldhName": "xn--fo-8ja.example", "unicodeName" : "foo.example" } ] } ], "status" : [ "locked", "transfer prohibited" ], Newton & Hollenbeck Expires April 30, 2015 [Page 34] Internet-Draft RDAP JSON RESPONSES October 2014 "publicIds":[ { "type":"ENS_Auth ID", "identifier":"1234567890" } ], "nameservers" : [ { "objectClassName" : "nameserver", "handle" : "XXXX", "ldhName" : "ns1.example.com", "status" : [ "active" ], "ipAddresses" : { "v6": [ "2001:db8::123", "2001:db8::124" ], "v4": [ "192.0.2.1", "192.0.2.2" ] }, "remarks" : [ { "description" : [ "She sells sea shells down by the sea shore.", "Originally written by Terry Sullivan." ] } ], "links" : [ { "value" : "http://example.net/nameserver/XXXX", "rel" : "self", "href" : "http://example.net/nameserver/XXXX", "type" : "application/rdap+json" } ], "events" : [ { "eventAction" : "registration", "eventDate" : "1990-12-31T23:59:59Z" }, { "eventAction" : "last changed", "eventDate" : "1991-12-31T23:59:59Z" } ] Newton & Hollenbeck Expires April 30, 2015 [Page 35] Internet-Draft RDAP JSON RESPONSES October 2014 }, { "objectClassName" : "nameserver", "handle" : "XXXX", "ldhName" : "ns2.example.com", "status" : [ "active" ], "ipAddresses" : { "v6" : [ "2001:db8::125", "2001:db8::126" ], "v4" : [ "192.0.2.3", "192.0.2.4" ] }, "remarks" : [ { "description" : [ "She sells sea shells down by the sea shore.", "Originally written by Terry Sullivan." ] } ], "links" : [ { "value" : "http://example.net/nameserver/XXXX", "rel" : "self", "href" : "http://example.net/nameserver/XXXX", "type" : "application/rdap+json" } ], "events" : [ { "eventAction" : "registration", "eventDate" : "1990-12-31T23:59:59Z" }, { "eventAction" : "last changed", "eventDate" : "1991-12-31T23:59:59Z" } ] } ], "secureDNS": { "zoneSigned": true, "delegationSigned": true, "maxSigLife": 604800, Newton & Hollenbeck Expires April 30, 2015 [Page 36] Internet-Draft RDAP JSON RESPONSES October 2014 "keyData": [ { "flags": 257, "protocol": 3, "algorithm": 1, "publicKey": "AQPJ////4Q==", "events": [ { "eventAction": "last changed", "eventDate": "2012-07-23T05:15:47Z" } ] } ] }, "remarks" : [ { "description" : [ "She sells sea shells down by the sea shore.", "Originally written by Terry Sullivan." ] } ], "links" : [ { "value": "http://example.net/domain/XXXX", "rel" : "self", "href" : "http://example.net/domain/XXXX", "type" : "application/rdap+json" } ], "port43" : "whois.example.net", "events" : [ { "eventAction" : "registration", "eventDate" : "1990-12-31T23:59:59Z" }, { "eventAction" : "last changed", "eventDate" : "1991-12-31T23:59:59Z", "eventActor" : "joe@example.com" }, Newton & Hollenbeck Expires April 30, 2015 [Page 37] Internet-Draft RDAP JSON RESPONSES October 2014 { "eventAction" : "transfer", "eventDate" : "1991-12-31T23:59:59Z", "eventActor" : "joe@example.com" }, { "eventAction" : "expiration", "eventDate" : "2016-12-31T23:59:59Z", "eventActor" : "joe@example.com" } ], "entities" : [ { "objectClassName" : "entity", "handle" : "XXXX", "vcardArray":[ "vcard", [ ["version", {}, "text", "4.0"], ["fn", {}, "text", "Joe User"], ["kind", {}, "text", "individual"], ["lang", { "pref":"1" }, "language-tag", "fr"], ["lang", { "pref":"2" }, "language-tag", "en"], ["org", { "type":"work" }, "text", "Example"], ["title", {}, "text", "Research Scientist"], ["role", {}, "text", "Project Lead"], ["adr", { "type":"work" }, "text", [ "", "Suite 1234", "4321 Rue Somewhere", "Quebec", "QC", "G1V 2M2", "Canada" ] ], ["tel", { "type":["work", "voice"], "pref":"1" }, Newton & Hollenbeck Expires April 30, 2015 [Page 38] Internet-Draft RDAP JSON RESPONSES October 2014 "uri", "tel:+1-555-555-1234;ext=102" ], ["email", { "type":"work" }, "text", "joe.user@example.com" ] ] ], "status" : [ "validated", "locked" ], "roles" : [ "registrant" ], "remarks" : [ { "description" : [ "She sells sea shells down by the sea shore.", "Originally written by Terry Sullivan." ] } ], "links" : [ { "value" : "http://example.net/entity/xxxx", "rel" : "self", "href" : "http://example.net/entity/xxxx", "type" : "application/rdap+json" } ], "events" : [ { "eventAction" : "registration", "eventDate" : "1990-12-31T23:59:59Z" }, { "eventAction" : "last changed", "eventDate" : "1991-12-31T23:59:59Z" } ] } ] } Newton & Hollenbeck Expires April 30, 2015 [Page 39] Internet-Draft RDAP JSON RESPONSES October 2014 5.4. The IP Network Object Class The IP Network object class models IP network registrations found in RIRs and is the expected response for the "/ip" query as defined by [I-D.ietf-weirds-rdap-query]. There is no equivalent object class for DNRs. The high level structure of the IP network object class consists of information about the network registration and entities related to the IP network (e.g. registrant information, contacts, etc...). The following is an elided example of the IP network object type showing the high level structure: { "objectClassName" : "ip network", "handle" : "XXX", ... "entities" : [ ... ] } The following is an example of the JSON object for the network registration information. { "objectClassName" : "ip network", "handle" : "XXXX-RIR", "startAddress" : "2001:db8::0", "endAddress" : "2001:db8:0:FFFF:FFFF:FFFF:FFFF:FFFF", "ipVersion" : "v6", "name": "NET-RTR-1", "type" : "DIRECT ALLOCATION", "country" : "AU", "parentHandle" : "YYYY-RIR", "status" : [ "active" ], "remarks" : [ { "description" : [ "She sells sea shells down by the sea shore.", "Originally written by Terry Sullivan." ] Newton & Hollenbeck Expires April 30, 2015 [Page 40] Internet-Draft RDAP JSON RESPONSES October 2014 } ], "links" : [ { "value" : "http://example.net/ip/2001:db8::/48", "rel" : "self", "href" : "http://example.net/ip/2001:db8::/48", "type" : "application/rdap+json" }, { "value" : "http://example.net/ip/2001:db8::/48", "rel" : "up", "href" : "http://example.net/ip/2001:C00::/23", "type" : "application/rdap+json" } ], "events" : [ { "eventAction" : "registration", "eventDate" : "1990-12-31T23:59:59Z" }, { "eventAction" : "last changed", "eventDate" : "1991-12-31T23:59:59Z" } ], "entities" : [ { "objectClassName" : "entity", "handle" : "XXXX", "vcardArray":[ "vcard", [ ["version", {}, "text", "4.0"], ["fn", {}, "text", "Joe User"], ["kind", {}, "text", "individual"], ["lang", { "pref":"1" }, "language-tag", "fr"], ["lang", { "pref":"2" }, "language-tag", "en"], ["org", { "type":"work" }, "text", "Example"], Newton & Hollenbeck Expires April 30, 2015 [Page 41] Internet-Draft RDAP JSON RESPONSES October 2014 ["title", {}, "text", "Research Scientist"], ["role", {}, "text", "Project Lead"], ["adr", { "type":"work" }, "text", [ "", "Suite 1234", "4321 Rue Somewhere", "Quebec", "QC", "G1V 2M2", "Canada" ] ], ["tel", { "type":["work", "voice"], "pref":"1" }, "uri", "tel:+1-555-555-1234;ext=102" ], ["email", { "type":"work" }, "text", "joe.user@example.com" ] ] ], "roles" : [ "registrant" ], "remarks" : [ { "description" : [ "She sells sea shells down by the sea shore.", "Originally written by Terry Sullivan." ] } ], "links" : [ { "value" : "http://example.net/entity/xxxx", "rel" : "self", "href" : "http://example.net/entity/xxxx", "type" : "application/rdap+json" } ], "events" : [ { Newton & Hollenbeck Expires April 30, 2015 [Page 42] Internet-Draft RDAP JSON RESPONSES October 2014 "eventAction" : "registration", "eventDate" : "1990-12-31T23:59:59Z" }, { "eventAction" : "last changed", "eventDate" : "1991-12-31T23:59:59Z" } ] } ] } The following is a description of the members of this object: o objectClassName -- the string "ip network" o handle -- a string representing an RIR unique identifier of the network registration o startAddress -- the starting IP address of the network, either IPv4 or IPv6 o endAddress -- the ending IP address of the network, either IPv4 or IPv6 o ipVersion -- a string signifying the IP protocol version of the network: "v4" signifying an IPv4 network, "v6" signifying an IPv6 network o name -- an identifier assigned to the network registration by the registration holder o type -- a string containing an RIR-specific classification of the network o country -- a string containing the two-character country code of the network o parentHandle -- a string containing an RIR-unique identifier of the parent network of this network registration o status -- an array of strings indicating the state of the IP network o entities -- an array of entity objects as defined by Section 5.1. o remarks - see Section 4.3 Newton & Hollenbeck Expires April 30, 2015 [Page 43] Internet-Draft RDAP JSON RESPONSES October 2014 o links - see Section 4.2 o port43 - see Section 4.7 o events - see Section 4.5 5.5. Autonomous System Number Entity Object Class The Autonomous System Number (autnum) object class models Autonomous System Number registrations found in RIRs and represents the expected response to an "/autnum" query as defined by [I-D.ietf-weirds-rdap-query]. There is no equivalent object class for DNRs. The high level structure of the autnum object class consists of information about the network registration and entities related to the autnum registration (e.g. registrant information, contacts, etc.), and is similar to the IP Network entity object class. The following is an example of a JSON object representing an autnum. { "objectClassName" : "autnum", "handle" : "XXXX-RIR", "startAutnum" : 10, "endAutnum" : 15, "name": "AS-RTR-1", "type" : "DIRECT ALLOCATION", "status" : [ "active" ], "country": "AU", "remarks" : [ { "description" : [ "She sells sea shells down by the sea shore.", "Originally written by Terry Sullivan." ] } ], "links" : [ { "value" : "http://example.net/autnum/xxxx", "rel" : "self", "href" : "http://example.net/autnum/xxxx", "type" : "application/rdap+json" } Newton & Hollenbeck Expires April 30, 2015 [Page 44] Internet-Draft RDAP JSON RESPONSES October 2014 ], "events" : [ { "eventAction" : "registration", "eventDate" : "1990-12-31T23:59:59Z" }, { "eventAction" : "last changed", "eventDate" : "1991-12-31T23:59:59Z" } ], "entities" : [ { "objectClassName" : "entity", "handle" : "XXXX", "vcardArray":[ "vcard", [ ["version", {}, "text", "4.0"], ["fn", {}, "text", "Joe User"], ["kind", {}, "text", "individual"], ["lang", { "pref":"1" }, "language-tag", "fr"], ["lang", { "pref":"2" }, "language-tag", "en"], ["org", { "type":"work" }, "text", "Example"], ["title", {}, "text", "Research Scientist"], ["role", {}, "text", "Project Lead"], ["adr", { "type":"work" }, "text", [ "", "Suite 1234", "4321 Rue Somewhere", "Quebec", "QC", "G1V 2M2", "Canada" ] ], ["tel", Newton & Hollenbeck Expires April 30, 2015 [Page 45] Internet-Draft RDAP JSON RESPONSES October 2014 { "type":["work", "voice"], "pref":"1" }, "uri", "tel:+1-555-555-1234;ext=102" ], ["email", { "type":"work" }, "text", "joe.user@example.com" ] ] ], "roles" : [ "registrant" ], "remarks" : [ { "description" : [ "She sells sea shells down by the sea shore.", "Originally written by Terry Sullivan." ] } ], "links" : [ { "value" : "http://example.net/entity/XXXX", "rel" : "self", "href" : "http://example.net/entity/XXXX", "type" : "application/rdap+json" } ], "events" : [ { "eventAction" : "registration", "eventDate" : "1990-12-31T23:59:59Z" }, { "eventAction" : "last changed", "eventDate" : "1991-12-31T23:59:59Z" } ] } ] } The following is a description of the members of this object: o objectClassName -- the string "autnum" Newton & Hollenbeck Expires April 30, 2015 [Page 46] Internet-Draft RDAP JSON RESPONSES October 2014 o handle -- a string representing an RIR-unique identifier of the autnum registration o startAutnum -- a number representing the starting number [RFC5396] in the block of autonomous system numbers o endAutnum -- a number representing the ending number [RFC5396] in the block of autonomous system numbers o name -- an identifier assigned to the autnum registration by the registration holder o type -- a string containing an RIR-specific classification 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 code of the autnum o entities -- an array of entity objects as defined by Section 5.1. o remarks - see Section 4.3 o links - see Section 4.2 o port43 - see Section 4.7 o events - see Section 4.5 6. Error Response Body Some non-answer responses may return entity bodies with information that could be more descriptive. The basic structure of that response is an object class containing an error code number (corresponding to the HTTP response code) followed by a string named "title" and an array of strings named "description". Newton & Hollenbeck Expires April 30, 2015 [Page 47] Internet-Draft RDAP JSON RESPONSES October 2014 This is an example of the common response body. { "errorCode": 418, "title": "Your beverage choice is not available", "description": [ "I know coffee has more ummppphhh.", "Sorry, dude!" ] } Figure 18 Newton & Hollenbeck Expires April 30, 2015 [Page 48] Internet-Draft RDAP JSON RESPONSES October 2014 This is an example of the common response body with and rdapConformance and notices data structures: { "rdapConformance" : [ "rdap_level_0" ], "notices" : [ { "title" : "Beverage policy", "description" : [ "Beverages with caffeine for keeping horses awake." ], "links" : [ { "value" : "http://example.net/ip/192.0.2.0/24", "rel" : "alternate", "type" : "text/html", "href" : "http://www.example.com/redaction_policy.html" } ] } ], "lang" : "en", "errorCode": 418, "title": "Your beverage choice is not available", "description": [ "I know coffee has more ummppphhh.", "Sorry, dude!" ] } Figure 19 7. Responding to Help Queries The appropriate response to /help queries as defined by [I-D.ietf-weirds-rdap-query] is to use the notices structure as defined in Section 4.3. Newton & Hollenbeck Expires April 30, 2015 [Page 49] Internet-Draft RDAP JSON RESPONSES October 2014 This is an example of a response to a /help query including the rdapConformance data structure. { "rdapConformance" : [ "rdap_level_0" ], "notices" : [ { "title" : "Authentication Policy", "description" : [ "Access to sensitive data for users with proper credentials." ], "links" : [ { "value" : "http://example.net/help", "rel" : "alternate", "type" : "text/html", "href" : "http://www.example.com/auth_policy.html" } ] } ] } Figure 20 8. Responding To Searches [I-D.ietf-weirds-rdap-query] specifies three types of searches: domains, nameservers, and entities. Responses to these searches take 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 yields an array of domain object instances). These arrays are contained within the response object. The names of the arrays are as follows: o for /domains searches, the array is "domainSearchResults" o for /nameservers searches, the array is "nameserverSearchResults" o for /entities searches, the array is "entitySearchResults" Newton & Hollenbeck Expires April 30, 2015 [Page 50] Internet-Draft RDAP JSON RESPONSES October 2014 The following is an elided example of a response to a /domains search. { "rdapConformance" : [ "rdap_level_0" ], ... "domainSearchResults" : [ { "objectClassName" : "domain", "handle" : "1-XXXX", "ldhName" : "1.example.com", ... }, { "objectClassName" : "domain", "handle" : "2-XXXX", "ldhName" : "2.example.com", ... } ] } search_response_example 9. Indicating Truncated Responses 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 this by including a typed notice in the response object. Newton & Hollenbeck Expires April 30, 2015 [Page 51] Internet-Draft RDAP JSON RESPONSES October 2014 The following is an elided example of a search response that has been truncated. { "rdapConformance" : [ "rdap_level_0" ], "notices" : [ { "title" : "Search Policy", "type" : "result set truncated due to authorization", "description" : [ "Search results are limited to 25 per day per querying IP." ], "links" : [ { "value" : "http://example.net/help", "rel" : "alternate", "type" : "text/html", "href" : "http://www.example.com/search_policy.html" } ] } ], "domainSearchResults" : [ ... ] } search_response_truncated_example A similar technique can be used with a typed remark where a single object has been returned and data in that object has been truncated. Such an example might be an entity object with only a partial set of the IP networks associated with it. Newton & Hollenbeck Expires April 30, 2015 [Page 52] Internet-Draft RDAP JSON RESPONSES October 2014 The following is an elided example of an entity truncated data. { "objectClassName" : "entity", "handle" : "ANENTITY", "roles" : [ "registrant" ], ... "entities" : [ { "objectClassName" : "entity", "handle": "ANEMBEDDEDENTITY", "roles" : [ "technical" ], ... }, ... ], "networks" : [ ... ], ... "remarks" : [ { "title" : "Data Policy", "type" : "object truncated due to unexplainable reason", "description" : [ "Some of the data in this object has been removed." ], "links" : [ { "value" : "http://example.net/help", "rel" : "alternate", "type" : "text/html", "href" : "http://www.example.com/data_policy.html" } ] } ] } Figure 21 Newton & Hollenbeck Expires April 30, 2015 [Page 53] Internet-Draft RDAP JSON RESPONSES October 2014 10. IANA Considerations 10.1. RDAP JSON Media Type Registration This specification registers the "application/rdap+json" media type. Type name: application Subtype name: rdap+json Required parameters: n/a Encoding considerations: See section 3.1 of [RFC6839]. Security considerations: The media represented by this identifier does not have security considerations beyond that found in section 6 of [RFC7159] Interoperability considerations: There are no known interoperability problems regarding this media format. Published specification: [[ this document ]] Applications that use this media type: Implementations of the Registration Data Access Protocol (RDAP) Additional information: This media type is a product of the IETF WEIRDS working group. The WEIRDS charter, information on the WEIRDS mailing list, and other documents produced by the WEIRDS working group can be found at https://datatracker.ietf.org/wg/ weirds/ Person & email address to contact for further information: IESG <iesg@ietf.org> Intended usage: COMMON Restrictions on usage: none Author: Andy Newton Change controller: IETF Provisional Registration: No (upon publication of this RFC) Newton & Hollenbeck Expires April 30, 2015 [Page 54] Internet-Draft RDAP JSON RESPONSES October 2014 10.2. JSON Values Registry This section requests that the IANA create a new category in the protocol registries labeled "Registration Data Access Protocol (RDAP)" (if it does not already exist), and within that category establish a URL referenceable, stand-alone registry labeled "RDAP JSON Values". This new registry is for use in the notices and remarks (Section 4.3), status (Section 4.6), role (Section 5.1), event action (Section 4.5), and domain variant relation (Section 5.3) fields specified in RDAP. Each entry in the registry should contain the following fields: 1. Value - the string value being registered. 2. Type - the type of value being registered. It should be one of the following: * 'notice or remark type' - denotes a type of notice or remark * 'status' - denotes a value for the 'status' object member as defined by Section 4.6. * 'role' - denotes a value for the 'role' array as defined in Section 5.1. * 'event action' - denotes a value for an event action as defined in Section 4.5. * 'domain variant relation' - denotes a relationship between a domain and a domain variant as defined in Section 5.3. 3. Description - a one or two sentence description regarding the meaning of the value, how it might be used, and/or how it should be interpreted by clients. 4. Registrant Name - the name of the person registering the value. 5. Registrant Contact Information - an email address, postal address, or some other information to be used to contact the registrant. This registry is to be operated under the "Expert Review" policy defined in [RFC5226]. Review of registrations into this registry by the designated expert(s) should be narrowly judged on the following criteria: Newton & Hollenbeck Expires April 30, 2015 [Page 55] Internet-Draft RDAP JSON RESPONSES October 2014 1. Values in need of being placed into multiple types must be assigned a separate registration for each type. 2. Values must be strings. They should be multiple words separated by single space characters. Every character should be lowercased. If possible, every word should be given in English and each character should be US ASCII. 3. Registrations should not duplicate the meaning of any existing registration. That is, if a request for a registration is significantly similar in nature to an existing registration, the request should be denied. For example, the terms 'maintainer' and 'registrant' are significantly similar in nature as they both denote a holder of a domain name or Internet number resource. In cases where it may be reasonably argued that machine interpretation of two similar values may alter the operation of client software, designated experts should not judge the values to be of significant similarity. 4. Registrations should be relevant to the common usages of RDAP. Designated experts may rely upon the serving of the value by a DNR or RIR to make this determination. 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 Registry: 1. * Value: result set truncated due to authorization * Type: notice and remark type * Description: The list of results does not contain all results due to lack of authorization. This may indicate to some clients that proper authorization will yield a longer result set. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 2. Newton & Hollenbeck Expires April 30, 2015 [Page 56] Internet-Draft RDAP JSON RESPONSES October 2014 * Value: result set truncated due to excessive load * Type: notice and remark type * Description: The list of results does not contain all results due to excessively heavy load on the server. This may indicate to some clients that requerying at a later time will yield a longer result set. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 3. * Value: result set truncated due to unexplainable reasons * Type: notice and remark type * Description: The list of results does not contain all results for an unexplainable reason. This may indicate to some clients that requerying for any reason will not yield a longer result set. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 4. * Value: object truncated due to authorization * Type: notice and remark type * Description: The object does not contain all data due to lack of authorization. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 5. * Value: object truncated due to excessive load * Type: notice and remark type Newton & Hollenbeck Expires April 30, 2015 [Page 57] Internet-Draft RDAP JSON RESPONSES October 2014 * Description: The object does not contain all data due to excessively heavy load on the server. This may indicate to some clients that requerying at a later time will yield all data of the object. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 6. * Value: object truncated due to unexplainable reasons * Type: notice and remark type * Description: The object does not contain all data for an unexplainable reason. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 10.2.2. Status This section registers the following values into the RDAP JSON Values Registry: 1. * Value: validated * Type: status * Description: Signifies that the data of the object instance has been found to be accurate. This type of status is usually found on entity object instances to note the validity of identifying contact information. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 2. * Value: renew prohibited * Type: status Newton & Hollenbeck Expires April 30, 2015 [Page 58] Internet-Draft RDAP JSON RESPONSES October 2014 * Description: Renewal or reregistration of the object instance is forbidden. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 3. * Value: update prohibited * Type: status * Description: Updates to the object instance are forbidden. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 4. * Value: transfer prohibited * Type: status * Description: Transfers of the registration from one registrar to another are forbidden. This type of status normally applies to DNR domain names. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 5. * Value: delete prohibited * Type: status * Description: Deletion of the registration of the object instance is forbidden. This type of status normally applies to DNR domain names. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 6. Newton & Hollenbeck Expires April 30, 2015 [Page 59] Internet-Draft RDAP JSON RESPONSES October 2014 * Value: proxy * Type: status * Description: The registration of the object instance has been performed by a third party. This is most commonly applied to entities. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 7. * Value: private * Type: status * Description: The information of the object instance is not designated for public consumption. This is most commonly applied to entities. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 8. * Value: redacted * Type: status * Description: Some of the information of the object instance has not been made available. This is most commonly applied to entities. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 9. * Value: obscured * Type: status * Description: Some of the information of the object instance has been altered for the purposes of not readily revealing Newton & Hollenbeck Expires April 30, 2015 [Page 60] Internet-Draft RDAP JSON RESPONSES October 2014 the actual information of the object instance. This is most commonly applied to entities. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 10. * Value: associated * Type: status * Description: The object instance is associated with other object instances in the registry. This is most commonly used to signify that a nameserver is associated with a domain or that an entity is associated with a network resource or domain. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 11. * Value: active * Type: status * Description: The object instance is in use. For domain names, it signifies that the domain name is published in DNS. For network and autnum registrations it signifies that they are allocated or assigned for use in operational networks. This maps to the Extensible Provisioning Protocol (EPP) [RFC5730] 'OK' status. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 12. * Value: inactive * Type: status * Description: The object instance is not in use. See 'active'. Newton & Hollenbeck Expires April 30, 2015 [Page 61] Internet-Draft RDAP JSON RESPONSES October 2014 * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 13. * Value: locked * Type: status * Description: Changes to the object instance cannot be made, including the association of other object instances. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 14. * Value: pending create * Type: status * Description: A request has been received for the creation of the object instance but this action is not yet complete. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 15. * Value: pending renew * Type: status * Description: A request has been received for the renewal of the object instance but this action is not yet complete. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 16. * Value: pending transfer * Type: status Newton & Hollenbeck Expires April 30, 2015 [Page 62] Internet-Draft RDAP JSON RESPONSES October 2014 * Description: A request has been received for the transfer of the object instance but this action is not yet complete. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 17. * Value: pending update * Type: status * Description: A request has been received for the update or modification of the object instance but this action is not yet complete. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 18. * Value: pending delete * Type: status * Description: A request has been received for the deletion or removal of the object instance but this action is not yet complete. For domains, this might mean that the name is no longer published in DNS but has not yet been purged from the registry database. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 10.2.3. Event Actions This section registers the following values into the RDAP JSON Values Registry: 1. * Value: registration * Type: event action Newton & Hollenbeck Expires April 30, 2015 [Page 63] Internet-Draft RDAP JSON RESPONSES October 2014 * Description: The object instance was initially registered. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 2. * Value: reregistration * Type: event action * Description: The object instance was registered subsequently to initial registration. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 3. * Value: last changed * Type: event action * Description: An action noting when the information in the object instance was last changed. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 4. * Value: expiration * Type: event action * Description: The object instance has been removed or will be removed at a pre-determined date and time from the registry. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 5. * Value: deletion Newton & Hollenbeck Expires April 30, 2015 [Page 64] Internet-Draft RDAP JSON RESPONSES October 2014 * Type: event action * Description: The object instance was removed from the registry at a point in time that was not pre-determined. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 6. * Value: reinstantiation * Type: event action * Description: The object instance was reregistered after having been removed from the registry. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 7. * Value: transfer * Type: event action * Description: The object instance was transferred from one registrant to another. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 8. * Value: locked * Type: event action * Description: The object instance was locked (see the 'locked' status). * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org Newton & Hollenbeck Expires April 30, 2015 [Page 65] Internet-Draft RDAP JSON RESPONSES October 2014 9. * Value: unlocked * Type: event action * Description: The object instance was unlocked (see the 'locked' status). * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 10.2.4. Roles This section registers the following values into the RDAP JSON Values Registry: 1. * Value: registrant * Type: role * Description: The entity object instance is the registrant of the registration. In some registries, this is known as a maintainer. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 2. * Value: technical * Type: role * Description: The entity object instance is a technical contact for the registration. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 3. * Value: administrative Newton & Hollenbeck Expires April 30, 2015 [Page 66] Internet-Draft RDAP JSON RESPONSES October 2014 * Type: role * Description: The entity object instance is an administrative contact for the registration. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 4. * Value: abuse * Type: role * Description: The entity object instance handles network abuse issues on behalf of the registrant of the registration. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 5. * Value: billing * Type: role * Description: The entity object instance handles payment and billing issues on behalf of the registrant of the registration. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 6. * Value: registrar * Type: role * Description: The entity object instance represents the authority responsible for the registration in the registry. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org Newton & Hollenbeck Expires April 30, 2015 [Page 67] Internet-Draft RDAP JSON RESPONSES October 2014 7. * Value: reseller * Type: role * Description: The entity object instance represents a third party through which the registration was conducted (i.e. not the registry or registrar). * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 8. * Value: sponsor * Type: role * Description: The entity object instance represents a domain policy sponsor, such as an ICANN approved sponsor. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 9. * Value: proxy * Type: role * Description: The entity object instance represents a proxy for another entity object, such as a registrant. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 10. * Value: notifications * Type: role * Description: An entity object instance designated to receive notifications about association object instances. Newton & Hollenbeck Expires April 30, 2015 [Page 68] Internet-Draft RDAP JSON RESPONSES October 2014 * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 11. * Value: noc * Type: role * Description: The entity object instance handles communications related to a network operations center (NOC). * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 10.2.5. Variant Relations This section registers the following values into the RDAP JSON Values Registry: 1. * Value: registered * Type: domain variant relation * Description: The variant names are registered in the registry. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 2. * Value: unregistered * Type: domain variant relation * Description: The variant names are not found in the registry. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 3. Newton & Hollenbeck Expires April 30, 2015 [Page 69] Internet-Draft RDAP JSON RESPONSES October 2014 * Value: registration restricted * Type: domain variant relation * Description: Registration of the variant names is restricted to certain parties or within certain rules. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 4. * Value: open registration * Type: domain variant relation * Description: Registration of the variant names is available to generally qualified registrants. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 5. * Value: conjoined * Type: domain variant relation * Description: Registration of the variant names occurs automatically with the registration of the containing domain registration. * Registrant Name: IESG * Registrant Contact Information: iesg@ietf.org 11. Security Considerations This specification models information serialized in JSON format. As JSON is a subset of Javascript, implementations are advised to follow the security considerations outlined in Section 6 of [RFC7159] to prevent code injection. Though not specific to JSON, RDAP implementers should be aware of the security considerations specified in [I-D.ietf-weirds-using-http] and Newton & Hollenbeck Expires April 30, 2015 [Page 70] Internet-Draft RDAP JSON RESPONSES October 2014 the security requirements and considerations in [I-D.ietf-weirds-rdap-sec]. Clients caching data, especially clients using RDAP specific caches (instead of HTTP layer caches), should have safeguards to prevent cache poisoning. See Section 5 for advice on using the "self" links for caching. Finally, service operators should be aware of the privacy mechanisms noted in Section 13. 12. Internationalization Considerations 12.1. Character Encoding The default text encoding for JSON responses in RDAP is UTF-8 [RFC3629], and all servers and clients MUST support UTF-8. 12.2. URIs and IRIs [I-D.ietf-weirds-using-http] defines the use of URIs and IRIs in RDAP. 12.3. Language Tags Section 4.4 defines the use of language tags in the JSON responses defined in this document. 12.4. Internationalized Domain Names Internationalized Domain Names (IDNs) are denoted in this specification by the separation of DNS names in LDH form and Unicode form (see Section 3). Representation of IDNs in registries is described by the "variants" object in Section 5.3 and the suggested values listed in Section 10.2.5. 13. Privacy Considerations This specification suggests status values to denote contact and registrant information that has been marked as private and/or has 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 contacts and registrants. Newton & Hollenbeck Expires April 30, 2015 [Page 71] Internet-Draft RDAP JSON RESPONSES October 2014 14. Contributing Authors and Acknowledgements This document is derived from original work on RIR responses in JSON by Byron J. Ellacott, Arturo L. Servin, Kaveh Ranjbar, and Andrew L. Newton. Additionally, this document incorporates work on DNR responses in JSON by Ning Kong, Linlin Zhou, Jiagui Xie, and Sean Shen. The components of the DNR object classes are derived from a categorization of WHOIS response formats created by Ning Kong, Linlin Zhou, and Guangqing Deng, Steve Sheng and Francisco Arias, Ray Bellis, and Frederico Neves. Tom Harrison, Murray Kucherawy, Ed Lewis, Audric Schiltknecht, Naoki Kambe, and Maarten Bosteels contributed significant review comments and provided clarifying text. James Mitchell provided text regarding the processing of unknown JSON attributes and identified issues leading to the remodeling of events. Ernie Dainow and Francisco Obispo provided concrete suggestions that led to a better variant model for domain names. Ernie Dainow provided the background information on the secure DNS attributes and objects for domains, informative text on DNSSEC, and many other attributes that appear throughout the object classes of this draft. The switch to and incorporation of jCard (JSON vCard) was performed by Simon Perreault. Olaf Kolkman and Murray Kucherawy chaired the IETF's WEIRDS working group from which this document as been created. 15. References 15.1. Normative References [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the Internet: Timestamps", RFC 3339, July 2002. [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 10646", STD 63, RFC 3629, November 2003. [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", STD 66, RFC 3986, January 2005. Newton & Hollenbeck Expires April 30, 2015 [Page 72] Internet-Draft RDAP JSON RESPONSES October 2014 [RFC4034] Arends, R., Austein, R., Larson, M., Massey, D., and S. Rose, "Resource Records for the DNS Security Extensions", 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 Autonomous System (AS) Numbers", RFC 5396, December 2008. [RFC5646] Phillips, A. and M. Davis, "Tags for Identifying Languages", BCP 47, RFC 5646, September 2009. [RFC5890] Klensin, J., "Internationalized Domain Names for Applications (IDNA): Definitions and Document Framework", RFC 5890, August 2010. [RFC5952] Kawamura, S. and M. Kawashima, "A Recommendation for IPv6 Address Text Representation", RFC 5952, August 2010. [RFC5988] Nottingham, M., "Web Linking", RFC 5988, October 2010. [RFC7095] Kewisch, P., "jCard: The JSON Format for vCard", RFC 7095, January 2014. [RFC7159] Bray, T., "The JavaScript Object Notation (JSON) Data Interchange Format", RFC 7159, March 2014. [I-D.ietf-weirds-using-http] Newton, A., Ellacott, B., and N. Kong, "HTTP usage in the Registration Data Access Protocol (RDAP)", draft-ietf- weirds-using-http-13 (work in progress), October 2014. [I-D.ietf-weirds-rdap-query] Newton, A. and S. Hollenbeck, "Registration Data Access Protocol Query Format", draft-ietf-weirds-rdap-query-15 (work in progress), October 2014. [I-D.ietf-weirds-rdap-sec] Hollenbeck, S. and N. Kong, "Security Services for the Registration Data Access Protocol", draft-ietf-weirds- rdap-sec-09 (work in progress), September 2014. [ISO.3166.1988] International Organization for Standardization, "Codes for the representation of names of countries, 3rd edition", ISO Standard 3166, August 1988. Newton & Hollenbeck Expires April 30, 2015 [Page 73] Internet-Draft RDAP JSON RESPONSES October 2014 15.2. Informative References [RFC3912] Daigle, L., "WHOIS Protocol Specification", RFC 3912, September 2004. [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", STD 69, RFC 5730, August 2009. [RFC5910] Gould, J. and S. Hollenbeck, "Domain Name System (DNS) Security Extensions Mapping for the Extensible Provisioning Protocol (EPP)", RFC 5910, May 2010. [RFC6350] Perreault, S., "vCard Format Specification", RFC 6350, August 2011. [RFC6839] Hansen, T. and A. Melnikov, "Additional Media Type Structured Syntax Suffixes", RFC 6839, January 2013. [JSON_acendancy] MacVittie, , "The Stealthy Ascendancy of JSON", 04 2011. [IANA_IDNTABLES] "IANA IDN Tables", <http://www.iana.org/domains/idn-tables>. [JSON_performance_study] Montana State University - Bozeman, Montana State University - Bozeman, Montana State University - Bozeman, and Montana State University - Bozeman, "Comparison of JSON and XML Data Interchange Formats: A Case Study", 2009. Appendix A. Suggested Data Modeling with the Entity Object Class A.1. Registrants and Contacts This document does not provide specific object classes for registrants and contacts. Instead the entity object class may be used to represent a registrant or contact. When the entity object is embedded inside a containing object such as a domain name or IP network, the 'roles' string array can be used to signify the relationship. It is recommended that the values from Section 10.2.4 be used. The following is an example of an elided containing object with an embedded entity that is both a registrant and administrative contact: Newton & Hollenbeck Expires April 30, 2015 [Page 74] Internet-Draft RDAP JSON RESPONSES October 2014 { ... "entities" : [ { "objectClassName" : "entity", "handle" : "XXXX", "vcardArray":[ "vcard", [ ["version", {}, "text", "4.0"], ["fn", {}, "text", "Joe User"], ["kind", {}, "text", "individual"], ["lang", { "pref":"1" }, "language-tag", "fr"], ["lang", { "pref":"2" }, "language-tag", "en"], ["org", { "type":"work" }, "text", "Example"], ["title", {}, "text", "Research Scientist"], ["role", {}, "text", "Project Lead"], ["adr", { "type":"work" }, "text", [ "", "Suite 1234", "4321 Rue Somewhere", "Quebec", "QC", "G1V 2M2", "Canada" ] ], ["tel", { "type":["work", "voice"], "pref":"1" }, "uri", "tel:+1-555-555-1234;ext=102" ], ["email", { "type":"work" }, "text", "joe.user@example.com" ] ] ], "roles" : [ "registrant", "administrative" ], Newton & Hollenbeck Expires April 30, 2015 [Page 75] Internet-Draft RDAP JSON RESPONSES October 2014 "remarks" : [ { "description" : [ "She sells sea shells down by the sea shore.", "Originally written by Terry Sullivan." ] } ], "events" : [ { "eventAction" : "registration", "eventDate" : "1990-12-31T23:59:59Z" }, { "eventAction" : "last changed", "eventDate" : "1991-12-31T23:59:59Z" } ] } ] } In many use cases, it is necessary to hide or obscure the information of a registrant or contact due to policy or other operational matters. Registries can denote these situations with 'status' values (see Section 10.2.2). Newton & Hollenbeck Expires April 30, 2015 [Page 76] Internet-Draft RDAP JSON RESPONSES October 2014 The following is an elided example of a registrant with information changed to reflect that of a third party. { ... "entities" : [ { "objectClassName" : "entity", "handle" : "XXXX", ... "roles" : [ "registrant", "administrative" ], "status" : [ "proxy", "private", "obscured" ] } ] } A.2. Registrars This document does not provide a specific object class for registrars, but like registrants and contacts (see Appendix A.1) the 'roles' string array maybe used. Additionally, many registrars have publicly assigned identifiers. The 'publicIds' structure (Section 4.8) represents that information. The following is an example of an elided containing object with an embedded entity that is a registrar: { ... "entities":[ { "objectClassName" : "entity", "handle":"XXXX", "vcardArray":[ "vcard", [ ["version", {}, "text", "4.0"], ["fn", {}, "text", "Joe's Fish, Chips and Domains"], ["kind", {}, "text", "org"], ["lang", { "pref":"1" }, "language-tag", "fr"], ["lang", { "pref":"2" Newton & Hollenbeck Expires April 30, 2015 [Page 77] Internet-Draft RDAP JSON RESPONSES October 2014 }, "language-tag", "en"], ["org", { "type":"work" }, "text", "Example"], ["adr", { "type":"work" }, "text", [ "", "Suite 1234", "4321 Rue Somewhere", "Quebec", "QC", "G1V 2M2", "Canada" ] ], ["tel", { "type":["work", "voice"], "pref":"1" }, "uri", "tel:+1-555-555-1234;ext=102" ], ["email", { "type":"work" }, "text", "joes_fish_chips_and_domains@example.com" ] ] ], "roles":[ "registrar" ], "publicIds":[ { "type":"IANA Registrar ID", "identifier":"1" } ], "remarks":[ { "description":[ "She sells sea shells down by the sea shore.", "Originally written by Terry Sullivan." ] } ], "links":[ { "value":"http://example.net/entity/XXXX", Newton & Hollenbeck Expires April 30, 2015 [Page 78] Internet-Draft RDAP JSON RESPONSES October 2014 "rel":"alternate", "type":"text/html", "href":"http://www.example.com" } ] } ] } Appendix B. Modeling Events Events represent actions that have taken place against a registered object at a certain date and time. Events have three properties: the action, the actor, and the date and time of the event (which is sometimes in the future). In some cases the identity of the actor is not captured. Events can be modeled in three ways: 1. events with no designated actor 2. events where the actor is only designated by an identifier 3. events where the actor can be modeled as an entity For the first use case, the 'events' data structure (Section 4.5) is used without the 'eventActor' object member. This is an example of an "events" array without the 'eventActor'. "events" : [ { "eventAction" : "registration", "eventDate" : "1990-12-31T23:59:59Z" } ] Figure 22 For the second use case, the 'events' data structure (Section 4.5) is used with the 'eventActor' object member. Newton & Hollenbeck Expires April 30, 2015 [Page 79] Internet-Draft RDAP JSON RESPONSES October 2014 This is an example of an "events" array with the 'eventActor'. "events" : [ { "eventAction" : "registration", "eventActor" : "XYZ-NIC", "eventDate" : "1990-12-31T23:59:59Z" } ] Figure 23 For the third use case, the 'asEventActor' array is used when an entity (Section 5.1) is embedded into another object class. The 'asEventActor' array follows the same structure as the 'events' array but does not have 'eventActor' attributes. The following is an elided example of a domain object with an entity as an event actor. { "objectClassName" : "domain", "handle" : "XXXX", "ldhName" : "foo.example", "status" : [ "locked", "transfer Prohibited" ], ... "entities" : [ { "handle" : "XXXX", ... "asEventActor" : [ { "eventAction" : "last changed", "eventDate" : "1990-12-31T23:59:59Z" } ] } ] } Newton & Hollenbeck Expires April 30, 2015 [Page 80] Internet-Draft RDAP JSON RESPONSES October 2014 Appendix C. Structured vs Unstructured Addresses The entity (Section 5.1) object class uses jCard [RFC7095] to represent contact information, including postal addresses. jCard has the ability to represent multiple language preferences, multiple email address and phone numbers, and multiple postal addresses in both a structured and unstructured format. This section describes the use of jCard for representing structured and unstructured addresses. The following is an example of a jCard. { "vcardArray":[ "vcard", [ ["version", {}, "text", "4.0"], ["fn", {}, "text", "Joe User"], ["n", {}, "text", ["User", "Joe", "", "", ["ing. jr", "M.Sc."]] ], ["bday", {}, "date-and-or-time", "--02-03"], ["anniversary", {}, "date-and-or-time", "2009-08-08T14:30:00-05:00" ], ["gender", {}, "text", "M"], ["kind", {}, "text", "individual"], ["lang", { "pref":"1" }, "language-tag", "fr"], ["lang", { "pref":"2" }, "language-tag", "en"], ["org", { "type":"work" }, "text", "Example"], ["title", {}, "text", "Research Scientist"], ["role", {}, "text", "Project Lead"], ["adr", { "type":"work" }, "text", [ "", "Suite 1234", "4321 Rue Somewhere", "Quebec", "QC", Newton & Hollenbeck Expires April 30, 2015 [Page 81] Internet-Draft RDAP JSON RESPONSES October 2014 "G1V 2M2", "Canada" ] ], ["adr", { "type":"home", "label":"123 Maple Ave\nSuite 90001\nVancouver\nBC\n1239\n" }, "text", [ "", "", "", "", "", "", "" ] ], ["tel", { "type":["work", "voice"], "pref":"1" }, "uri", "tel:+1-555-555-1234;ext=102" ], ["tel", { "type":["work", "cell", "voice", "video", "text"] }, "uri", "tel:+1-555-555-1234" ], ["email", { "type":"work" }, "text", "joe.user@example.com" ], ["geo", { "type":"work" }, "uri", "geo:46.772673,-71.282945"], ["key", { "type":"work" }, "uri", "http://www.example.com/joe.user/joe.asc" ], ["tz", {}, "utc-offset", "-05:00"], ["url", { "type":"home" }, "uri", "http://example.org"] ] ] } Figure 24 Newton & Hollenbeck Expires April 30, 2015 [Page 82] Internet-Draft RDAP JSON RESPONSES October 2014 The arrays in Figure 24 with the first member of "adr" represent postal addresses. In the first example, the postal address is given as a an array of strings and constitutes a structured address. For components of the structured address that are not applicable, an empty string is given. Each member of that array aligns with the positions of a vCard as given in [RFC6350]. In this example, the following data corresponds to the following positional meanings: 1. post office box - not applicable, empty string 2. extended address (e.g., apartment or suite number) - Suite 1234 3. street address - 4321 Rue Somewhere 4. locality (e.g., city) - Quebec 5. region (e.g., state or province) - QC 6. postal code - G1V 2M2 7. country name (full name) - Canada The second example is an unstructured address. It uses the label attribute, which is a string containing a newline (\n) character to separate address components in an unordered, unspecified manner. Note that in this example the structured address array is still given but that each string is an empty string. Appendix D. Secure DNS Section 5.3 defines the "secureDNS" member to represent secure DNS information about domain names. DNSSEC provides data integrity for DNS through digital signing of resource records. To enable DNSSEC, the zone is signed by one or more private keys and the signatures stored as RRSIG records. To complete the chain of trust in the DNS zone hierarchy, a digest of each DNSKEY record (which contains the public key) must be loaded into the parent zone, stored as Delegation Signer (DS) records and signed by the parent's private key (RRSIG DS record), "Resource Records for the DNS Security Extensions" [RFC4034]. Creating the DS records in the parent zone can be done by the registration authority, "Domain Name System (DNS) Security Extensions Mapping for the Extensible Provisioning Protocol (EPP)" [RFC5910]. Only DS related information is provided by RDAP, since other information is not generally stored in the registration database. Newton & Hollenbeck Expires April 30, 2015 [Page 83] Internet-Draft RDAP JSON RESPONSES October 2014 Other DNSSEC related information can be retrieved with other DNS tools such as dig. The domain object class (Section 5.3) can represent this information using either the 'dsData' or 'keyData' object arrays. Client implementers should be aware that some registries do not collect or do not publish all of the secure DNS meta-information. Appendix E. Motivations for Using JSON This section addresses a common question regarding the use of JSON over other data formats, most notably XML. It is often pointed out that many DNRs and one RIR support the EPP [RFC5730] standard, which is an XML serialized protocol. The logic is that since EPP is a common protocol in the industry it follows that XML would be a more natural choice. While EPP does influence this specification quite a bit, EPP serves a different purpose which is the provisioning of Internet resources between registries and accredited registrars and serves a much narrower audience than that envisioned for RDAP. By contrast, RDAP has a broader audience and is designed for public consumption of data. Experience from RIRs with first generation RESTful web services for WHOIS indicate a large percentage of clients operate within browsers and other platforms where full-blown XML stacks are not readily available and where JSON is a better fit. Additionally, while EPP is used in much of the DNR community it is not a universal constant in that industry. And finally, EPP's use of XML predates the specification of JSON. If EPP had been defined today, it may very well have used JSON instead of XML. Beyond the specific DNR and RIR communities, the trend in the broader Internet industry is also switching to JSON over XML, especially in the area of RESTful web services (see [JSON_acendancy]). Studies have also found that JSON is generally less bulky and consequently faster to parse (see [JSON_performance_study]). Appendix F. Changelog [RFC Editor: Please delete this section prior to publication.] Initial -00 Adopted as working group document 2012-September-18. -01 Newton & Hollenbeck Expires April 30, 2015 [Page 84] Internet-Draft RDAP JSON RESPONSES October 2014 Minor spelling corrections. Changed "Registry Data" to "Registration Data" for the sake of consistency. Transitioned to RFC 5988 links and relationship types from our own custom "uris" structure. Some examples had 'status' as a string. Those have been corrected as 'status' is always an array of strings. Domain variants can now have a multi-valued relationship with domain registrations. "names" in the entity object class was changed to "entityNames". Some IP address examples change to IPv6. Change phone number examples and added reference to E.164. Added section on motivations for using JSON. Added error response body section. Added JSON naming section. Added common data structures section. Added the IANA Considerations section and the media type registration. Added 'lang' name/value. Added internationalization considerations section. -02 Removed level from media type registration. Textual changes as given by Ed Lewis. Fixed object class linking example noted by Francisco Obispo Fixed a lot of other examples called out by Alex Sergeyev Added a note that JSON names are case sensitive Added 'status' to IP networks as suggested by Alex Sergeyev Newton & Hollenbeck Expires April 30, 2015 [Page 85] Internet-Draft RDAP JSON RESPONSES October 2014 -03 Added jCard verbiage and examples and deleted overlapping contact information and the appendix on postal addresses Removed the IANA considerations as they have been moved to another document Changed the remarks structure to be like notices Reordering and rewording some of the sections so they flow better Added note about object class "self" links Changed ipAddresses in nameserver object class to separate out v6 from v4 Changed IP network version identifier from integer to string to be more consistent with ipAddresses identifier in nameserver object classes Changed DNS names to LDH names and Unicode names Modified the definition of 'conjoined' variant relationship so it was circular Added 'proxy', 'private', 'redacted', and 'obscured' status values (most useful for entities). Added a privacy considerations section Added a security considerations section Added 'reseller' and 'sponsor' to the list of entity roles Added the 'events' common data structure Added 'asEventActor' to entities Added appendix on event modeling Removed the subclasses/superclassing between RIRs/DNRs for entity and domain object classes Change suggested status/relation/etc values to be case/spacing consistent Newton & Hollenbeck Expires April 30, 2015 [Page 86] Internet-Draft RDAP JSON RESPONSES October 2014 Normalized some of the definitions of object class members Modifying the JSON signaling section to reference the guidance in draft-ietf-weirds-using-http Changed the text regarding the process of unknown JSON attributes -04 'description' removed from IP network and autnum because it is redundant with the remarks structure. Added 'entities' array to nameservers. Added 'status' to autnum. Added 'publicIds' to entity and domain. Added embedded entities to the entity object class. Added 'idnTable' to variants objects in domain object class. Changed the numbers for startNum and endNum in autnum to numbers instead of strings. Added an example for error response with full rdapConformance and notices. Added a section discussing help. Changed entities to use vcardArray and changed the examples to be current with jCard. Added a section on structured vs unstructured addresses. Added associated to the list of status values. Added a secure DNS section changed the 'delegationKey' object into the 'secureDNS' object. Changed the suggested values to an IANA registry. Added 'proxy' to the list of entity roles. -05 Added IANA registration for RDAP JSON Media Type Newton & Hollenbeck Expires April 30, 2015 [Page 87] Internet-Draft RDAP JSON RESPONSES October 2014 Added 'associated' status type. This was done earlier but got dropped during a reorganization of the document. Added the following status types: active inactive locked pending create pending renew pending update pending transfer pending delete renew prohibited Added the following event actions: locked unlocked Added the following roles: notifications noc Changed the 'tech' role to 'technical' Many document reference changes. Many examples have been fixed. Added links to dsData and keyData. Changed flags and protocols to integers in keyData. Added 'entities' to the specified list for autnum. Newton & Hollenbeck Expires April 30, 2015 [Page 88] Internet-Draft RDAP JSON RESPONSES October 2014 Added SHOULD/SHOULD NOT language about using "type": "application/rdap+json" for self links. Added 'port43' to ip networks and autnum. -06 Fix search response example. Change the returned search arrays to 'domainSearchResults', 'entitySearchResults', and 'nameserverSearchResults'. -07 'nameservers' in domain object class was changed to 'nameServers' as in the example (note the camel case) fixed some example per email from James Mitchell fixed an example per email from Simon Perreault Added "network" to domain object class. Added networks and autnums to the entity object class. Created a section for "resultsTruncated". -08 Added typed remarks and notices, removed "resultTruncated" in favor of them. Added "objectClassName". Changed JSON reference to RFC 7159. Removed unused references to RFC 0791, RFC 2616, RFC 4343, RFC 5322. -09 Fixed numerous examples. Reference to jCard updated. Text regarding JSON vCards has been changed to jCards. JSON naming rules do not apply to jCards. Newton & Hollenbeck Expires April 30, 2015 [Page 89] Internet-Draft RDAP JSON RESPONSES October 2014 "nameserver" was made consistently all lower case. Links contained a "title" array, but it is now just a string per RFC 5988. Removed the term RESTful from the first section so it wouldn't have to be expanded. Added reference to RFC 2119 and noted that the uppercase form is what this document uses. Added text explaining why SHOULDs and SHOULD NOTs are to be followed. "port43" can now be either an domain name or IP address. "objectClassName" is now required. Numerous changes in prose for better readability. Updated the security considerations section to point to using- http and rdap-sec. -10 Addressing many AD comments. Changed IANA registrations to IESG. 'href' is now the only MUST in the a link. -11 Changes to address IETF Last Call comments. Authors' Addresses Andrew Lee Newton American Registry for Internet Numbers 3635 Concorde Parkway Chantilly, VA 20151 US Email: andy@arin.net URI: http://www.arin.net Newton & Hollenbeck Expires April 30, 2015 [Page 90] Internet-Draft RDAP JSON RESPONSES October 2014 Scott Hollenbeck Verisign Labs 12061 Bluemont Way Reston, VA 20190 US Email: shollenbeck@verisign.com URI: http://www.verisignlabs.com/ Newton & Hollenbeck Expires April 30, 2015 [Page 91]