| Network Working Group | M. Blanchet |
| Internet-Draft | Viagenie |
| Intended status: Standards Track | October 13, 2014 |
| Expires: April 16, 2015 |
Finding the Authoritative Registration Data (RDAP) Service
draft-ietf-weirds-bootstrap-08.txt
This document specifies a method to find which Registration Data Access Protocol (RDAP) server is authoritative to answer queries for a requested scope, such as domain names, IP addresses or Autonomous System numbers.
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."
This Internet-Draft will expire on April 16, 2015.
Copyright (c) 2014 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
Querying and retrieving registration data from registries are defined in the Registration Data Access Protocol (RDAP) [I-D.ietf-weirds-rdap-query][I-D.ietf-weirds-using-http][I-D.ietf-weirds-json-response]. These documents do not specify where to send the queries. This document specifies a method to find which server is authoritative to answer queries for the requested scope.
TLDs, AS numbers, and network blocks are delegated by IANA to registrars that then issue further delegations and maintain information about them. Thus, obviously the bootstrap information needed by RDAP clients is best generated from data and processes already maintained by IANA, whose registries already exist at [ipv4reg], [ipv6reg], [asreg], and [domainreg].
The required new functionality in support of RDAP could be accomplished by augmenting these registries to contain new fields, or creating second parallel registries containing the extra fields whose entries mirror the existing ones. Either approach will satisfy the needs of this document. This document requests IANA to make these registries available for the specific purpose of RDAP use, herein named RDAP Bootstrap Service Registries. An RDAP client fetches the RDAP Bootstrap Service Registries, extracts the data and then does a match with the query data to find the authoritative registration data server and appropriate query base URL.
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 [RFC2119].
The RDAP Bootstrap Service Registries, as specified in Section 12, will be made available as JSON [RFC7159] objects, to be retrieved via HTTP from a location as specified by IANA. The JSON object for each registry will start with a series of members that contain metadata about the registry such as a version identifier, a timestamp of the publication date of the registry and a description. Following that is a "services" member which contains the registry items themselves, as an array. Each item of the array contains a second-level array, with two elements, each of them being a third-level array.
{
"version": "1.0",
"publication": "YYYY-MM-DDTHH:MM:SSZ",
"description": "Some text",
"services": [
[
["entry1", "entry2", "entry3"],
[
"https://registry.example.com/myrdap/",
"http://registry.example.com/myrdap/"
]
],
[
["entry4"],
[
"http://example.org/"
]
]
]
}
There is no assumption of sorting except that the two arrays found in each second-level array MUST appear in the correct order: The entries array are followed by the service URL array. An example structure of the JSON output of a RDAP Bootstrap Service Registry is illustrated:
The formal syntax is described in Section 10.
The "version" corresponds to the format version of the registry. This specification defines "1.0".
The syntax of "publication" value conforms to the Internet date/time format [RFC3339].
The optional "description" string can contain a comment regarding the content of the bootstrap object.
Per [RFC7258], in each array of base RDAP URLs, the secure versions of the transport protocol SHOULD be preferred and tried first. For example, if the base RDAP URLs array contain both https and http URLs, the bootstrap client SHOULD try the https version first.
Base RDAP URLs MUST have a trailing "/" character because they are concatenated to the various segments defined in [I-D.ietf-weirds-rdap-query].
JSON names MUST follow the format recommendations of [I-D.ietf-weirds-using-http]. Any unknown or unspecified JSON object properties or values should be ignored by implementers.
Internationalized Domain Names labels used as entries or base RDAP URLs in the registries defined in this document MUST be only represented using their A-Label form as defined in [RFC5890].
All Domain Names labels used as entries or base RDAP URLs in the registries defined in this document MUST be only represented in lowercase.
{
"version": "1.0",
"publication": "YYYY-MM-DDTHH:MM:SSZ",
"description": "Some text",
"services": [
[
["net", "com"],
[
"https://registry.example.com/myrdap/"
]
],
[
["org", "mytld"],
[
"http://example.org/"
]
],
[
["xn--zckzah"],
[
"https://example.net/rdapxn--zckzah/",
"http://example.net/rdapxn--zckzah/"
]
]
]
}
The JSON output of this registry contains domain labels entries attached to the root, grouped by base RDAP URLs, as shown in this example.
The domain names authoritative registration data service is found by doing the label-wise longest match of the target domain name with the domain values in the arrays in the IANA Domain Name RDAP Bootstrap Service Registry. The values contained in the second element of the array are the valid base RDAP URLs as described in [I-D.ietf-weirds-rdap-query].
For example, a domain RDAP query for a.b.example.com matches the com entry in one of the arrays of the registry. The base RDAP URL for this query is then taken from the second element of the array, which is an array of base RDAP URLs valid for this entry. The client chooses one of the base URLs from this array; in this example it chooses the only one available, "https://registry.example.com/myrdap/". The segment specified in [I-D.ietf-weirds-rdap-query] is then appended to the base URL to complete the query. The complete query is then "https://registry.example.com/myrdap/domain/a.b.example.com".
If a domain RDAP query for a.b.example.com matches both com and example.com entries in the registry, then the longest match applies and the example.com entry is used by the client.
This section discusses IPv4 and IPv6 address space and autonomous system numbers.
For IP address space, the authoritative registration data service is found by doing a longest match of the target address with the values of the arrays in the corresponding Address Space RDAP Bootstrap Service registry. The longest match is done the same way as for routing: the addresses are converted in binary form and then the binary strings are compared to find the longest match up to the specified prefix length. The values contained in the second element of the array are the base RDAP URLs as described in [I-D.ietf-weirds-rdap-query]. The longest match method enables covering prefixes of a larger address space pointing to one base RDAP URL while more specific prefixes within the covering prefix being served by another base RDAP URL.
{
"version": "1.0",
"publication": "2024-01-07T10:11:12Z",
"description": "RDAP Bootstrap file for example registries.",
"services": [
[
["1.0.0.0/8", "192.0.0.0/8"],
[
"https://rir1.example.com/myrdap/"
]
],
[
["28.2.0.0/16", "192.0.2.0/24"],
[
"http://example.org/"
]
],
[
["28.3.0.0/16"],
[
"https://example.net/rdaprir2/",
"http://example.net/rdaprir2/"
]
]
]
}
The JSON output of this registry contains IPv4 prefix entries, specified in CIDR format and grouped by RDAP URLs, as shown in this example.
For example, a query for "192.0.2.1/25" matches the "192.0.0.0/8" entry and the "192.0.2.0/24" entry in the example registry above. The latter is chosen by the client given the longest match. The base RDAP URL for this query is then taken from the second element of the array, which is an array of base RDAP URLs valid for this entry. The client chooses one of the base URLs from this array; in this example it chooses the only one available, "http://example.org/". The {resource} specified in [I-D.ietf-weirds-rdap-query] is then appended to the base URL to complete the query. The complete query is then "https://example.org/ip/192.0.2.1/25".
{
"version": "1.0",
"publication": "2024-01-07T10:11:12Z",
"description": "RDAP Bootstrap file for example registries.",
"services": [
[
["2001:0200::/23", "2001:db8::/32"],
[
"https://rir2.example.com/myrdap/"
]
],
[
["2600::/16", "2100:ffff::/32"],
[
"http://example.org/"
]
],
[
["2001:0200:1000::/28"],
[
"https://example.net/rdaprir2/",
"http://example.net/rdaprir2/"
]
]
]
}
The JSON output of this registry contains IPv6 prefix entries, using [RFC4291] text representation of address prefixes format, grouped by base RDAP URLs, as shown in this example.
For example, a query for "2001:0200:1000::/48" matches the "2001:0200::/23" entry and the "2001:0200:1000::/28" entry in the example registry above. The latter is chosen by the client given the longest match. The base RDAP URL for this query is then taken from the second element of the array, which is an array of base RDAP URLs valid for this entry. The client chooses one of the base URLs from this array; in this example it chooses "https://example.net/rdaprir2/" because it's the secure version of the protocol. The segment specified in [I-D.ietf-weirds-rdap-query] is then appended to the base URL to complete the query. The complete query is therefore "https://example.net/rdaprir2/ip/2001:0200:1000::/48". If the server does not answer, the client can then use another URL prefix from the array.
{
"version": "1.0",
"publication": "2024-01-07T10:11:12Z",
"description": "RDAP Bootstrap file for example registries.",
"services": [
[
["2045-2045"],
[
"https://rir3.example.com/myrdap/"
]
],
[
["10000-12000", "300000-400000"],
[
"http://example.org/"
]
],
[
["64512-65534"],
[
"http://example.net/rdaprir2/",
"https://example.net/rdaprir2/"
]
]
]
}
The JSON output of this contains Autonomous Systems Number Ranges entries, grouped by base RDAP URLs, as shown in this example. The first element of each second-level array is an array containing the list of AS number ranges served by the base RDAP URLs found in the second element. The array always contains two AS numbers which represents the range of AS Numbers between the two elements of the array. When the two AS numbers are identical, then it only refers to that single AS number.
For example, a query for AS 65411 matches the 64512-65534 entry in the example registry above. The base RDAP URL for this query is then taken from the second element of the array, which is an array of base RDAP URLs valid for this entry. The client chooses one of the base URLs from this array; in this example it chooses "https://example.net/rdaprir2/". The segment specified in [I-D.ietf-weirds-rdap-query] is then appended to the base URL to complete the query. The complete query is therefore "https://example.net/rdaprir2/autnum/65411". If the server does not answer, the client can then use another URL prefix from the array.
Since there is no global namespace for entities, this document does not describe how to find the authoritative RDAP server for entities. It is possible however that, if the entity identifier was received from a previous query, the same RDAP server could be queried for that entity or the entity identifier itself is a fully referenced URL that can be queried.
The registries may not contain the requested value or the base RDAP URL value may be empty. In these cases, there is no known RDAP server for that requested value and the client SHOULD provide an appropriate error message to the user.
This method relies on the fact that RDAP clients are fetching the IANA registries to then find the servers locally. Clients SHOULD NOT fetch the registry on every RDAP request. Clients SHOULD cache the registry, but use underlying protocol signalling, such as the HTTP Expires header field [RFC7234], to identify when it is time to refresh the cached registry.
If the query data does not match any entry in the client cached registry, then the client may implement various methods, such as the following:
Some authorities of registration data may work together on sharing their information for a common service, including mutual redirection [I-D.ietf-weirds-redirects].
When a new object is allocated, such as a new AS range, a new TLD or a new IP address range, there is no guarantee that this new object will have an entry in the corresponding bootstrap RDAP registry, since the setup of the RDAP server for this new entry may become live and registered later. Therefore, the clients should expect that even if an object, such as TLD, IP address range or AS range is allocated, the existence of the entry in the corresponding bootstrap registry is not guaranteed.
This method does not provide a direct way to find authoritative RDAP servers for any other objects than the ones described in this document. In particular, the following objects are not bootstrapped with the method described in this document:
This section is the formal definition of the registries. The structure of JSON objects and arrays using a set of primitive elements is defined in [RFC7159]. Those elements are used to describe the JSON structure of the registries.
Using the above terms for the JSON structures, the syntax of a registry is defined as follows:
By providing a bootstrap method to find RDAP servers, this document helps to ensure that the end-users will get the RDAP data from an authoritative source, instead of from rogue sources. The method has the same security properties as the RDAP protocols themselves. The transport used to access the registries could be more secure by using TLS [RFC5246] if IANA supports it.
IANA is requested to make the RDAP Bootstrap Services Registries described below available as JSON objects, the syntax of which are described by section 10. The process for adding or updating entries into these registries does not correspond to the registration policies described in [RFC5226]; as stated earlier, these registries are generated from the data, processes, and policies maintained by IANA in their allocation registries ([ipv4reg], [ipv6reg], [asreg], and [domainreg]). IANA is expected to generate the RDAP Bootstrap Services Registries data from these above mentioned registries, according to their own registration policies. This document does not extend or otherwise change those policies.
Each of the RDAP Bootstrap Services Registries needs to be made available for general public on-demand download in the JSON format at a location determined by IANA.
IANA is also advised that the download demand for the RDAP Bootstrap Services Registries may be unusually high compared to other registries that exist already. The technical infrastructure by which registries are published may need to be reviewed.
Multiple entries pointing to the same set of URLs are grouped together in an array. Since multiple entries of non contiguous space may be grouped together, the registry may not be sortable by entries, therefore it is not required or expected that the entries be sorted in a registry.
Entries in this registry contain at least the following:
Entries in this registry contain at least the following:
Entries in this registry contain at least the following:
Entries in this registry contain at least the following:
The HTTP Content-Type returned to clients accessing the JSON output of the registries MUST be "application/json" as defined in [RFC7159].
The WEIRDS working group had multiple discussions on this topic, including a session during IETF 84, where various methods such as in-DNS and others were debated. The idea of using IANA registries was discovered by the editor during discussions with his colleagues as well as by a comment from Andy Newton. All the people involved in these discussions are herein acknowledged. Linlin Zhou, Jean-Philippe Dionne, John Levine, Kim Davies, Ernie Dainow, Scott Hollenbeck, Arturo Servin, Andy Newton, Murray Kucherawy, Tom Harrison, Naoki Kambe, Alexander Mayrhofer, Edward Lewis, Pete Resnick have provided input and suggestions to this document. Guillaume Leclanche was a co-editor of this document for some revisions; his support is therein acknowledged and greatly appreciated. The section on formal definition was inspired by section 6.2 of [RFC7071].
| [RFC2119] | Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. |
| [RFC3339] | Klyne, G. and C. Newman, "Date and Time on the Internet: Timestamps", RFC 3339, July 2002. |
| [RFC4291] | Hinden, R. and S. Deering, "IP Version 6 Addressing Architecture", RFC 4291, February 2006. |
| [RFC5890] | Klensin, J., "Internationalized Domain Names for Applications (IDNA): Definitions and Document Framework", RFC 5890, August 2010. |
| [RFC7159] | Bray, T., "The JavaScript Object Notation (JSON) Data Interchange Format", RFC 7159, March 2014. |