RDAP Extensions

Background The Registration Data Access Protocol (RDAP) defines a uniform protocol for accessing data from Internet operations registries, specifically Domain Name Registries (DNRs), Regional Internet Registries (RIRs), and other registries serving Internet Number Resources (INRs). RDAP queries are defined in and RDAP responses are defined in . RDAP contains a means to define extensions for queries not found in and responses not found in . RDAP extensions are also described in . This document describes the requirements for RDAP extension definition and use, clarifying ambiguities and defining additional semantics and options that were previously implicit or under-specified, and places some constraints on the definition of RDAP extensions to prevent collisions with various extension mechanisms.

Summary of Updates This document updates , , and for the purposes of constraining how extensions are defined. This document does not update any core RDAP requests or responses nor does it update or obsolete any existing RDAP extensions. The updates in this document should require no changes to either client or server implementations. This document describes the following methods for extending RDAP by registered extensions:

JSON Names - The most common extension point for RDAP is the definition of new JSON Names. Guidance is provided here in regard to and .
Query Paths - New lookups and searches are defined using URL paths. This document clarifies the practice as described in .
Query Parameters - Many queries use URL query parameters to scope and/or enhance RDAP results. This document clarifies the practice as described in .
HTTP Headers - Some extensions may use HTTP headers not explicitly enumerated by .
Object Classes - Extensions may define new types of objects to be queried. This document clarifies this method as described in and .

This document does not describe the usage of URL matrix parameters. There are no known RDAP extensions that use matrix parameters, and matrix parameters MUST NOT be used in RDAP extensions because they are not widely implemented in the broader web architecture and have the potential to interfere with query parameters and query paths. Additionally, this document updates the IANA registry practices for RDAP. See .

Document Terms The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here.

Identifiers

Purpose describes the identifier used to signify RDAP extensions and the IANA registry into which RDAP extensions are to be registered. When in use in RDAP, extension identifiers are prepended to URL path segments, URL query parameters, and JSON object member names. They are also included in the "rdapConformance" array member of each response that relies on the extension, so that clients can determine the extensions being used by the server for that response. The "/help" response returns an "rdapConformance" member containing the identifiers for all extensions used by the server. The main purpose of the extension identifier is to act as a namespace, preventing collisions between elements from different extensions. Additionally, implementers and operators can use the extension identifiers to find extension definitions via an IANA registry.

Profile Extensions While the RDAP extension mechanism was created to extend RDAP queries and/or responses, extensions can also be used to signal server policy (for example, specifying the conditions of use for existing response structures). Extensions that are primarily about signaling server policy are often called "profiles". Profile extensions are often used by a class of RDAP server operators, such as the used by gTLD registries and registrars and the used by RIRs. Profile extensions often do the following:

Mark some specific extensions (and versions thereof) as required.
Mark some specific optional queries, object classes, or JSON structures as required.
Limit or restrict the values of specific JSON structures.

Some profile extensions exist to denote the usage of values placed into an IANA registry, such as the IANA RDAP registries, or the usage of extensions for specifications used in RDAP responses, such as extended vCard/jCard properties. For example, an extension may be used to signal desired processing of a "rel" attribute in a "links" array, where the "rel" value is registered in the Link Relations Registry (https://www.iana.org/assignments/link-relations/link-relations.xhtml): When defining the usage of link relations, extensions MUST specify the media types expected to be used with those link relations. Profile extensions may also leverage the appearance of their identifier in the "rdapConformance" array (i.e. clients are signaled that a profile is in use). Profile extensions that mandate the implementation of some other extension MUST require that the implementor include the extension identifier for that other extension in the "rdapConformance" array. mandates the implementation of HTTPS but does not mandate its use. Some profile extensions, especially those used by classes of server operators, specify the required use of HTTPS and disallow the use of unencrypted HTTP. Similarly, some profile extensions specify the availability of service over IPv6. As described above, these characteristics are not exclusive to profile extensions and may be found in extensions defining new queries, JSON, and other RDAP extension points (see ).

Multiple Identifiers in Single Extension Extension specifications MAY define more than one extension identifier. The servers MUST list all extension identifiers used to generate a response in the "rdapConformance" array. The server MUST list all supported extension identifiers in the "rdapConformance" array of response to a "/help" request.

Syntax In brief, RDAP extension identifiers start with an alphabetic character and may contain alphanumeric characters and "_" (underscore) characters. This formulation was explicitly chosen to allow compatibility with variable names in programming languages and transliteration with XML. RDAP extension identifiers have no explicit structure, and are opaque insofar as no inner-meaning can be "seen" in them. RDAP extensions MUST NOT define an extension identifier that may collide with an existing extension identifier. For example, if there were a pre-existing identifier of "foo_bar", another extension could not define the identifier "foo". Likewise, if there were a pre-existing identifier of "foo_bar", another extension could not define the identifier "foo_bar_buzz". However, an extension could define "foo" if there were a pre-existing definition of "foobar", and vice versa. For this reason, this document updates the guidance of regarding underscore characters: RDAP extensions MUST NOT use an underscore character in their RDAP extension identifier. Implementers should be aware that many existing extension identifiers do contain underscore characters. does not explicitly state that extension identifiers are case-sensitive. This document clarifies the formulation in to explicitly note that extension identifiers are case-sensitive, and extension identifiers MUST NOT be registered where a new identifier is a mixed-case version of an existing identifier (see ). For example, given "lunarNIC" is already registered as an identifier, then a new registration with "lunarNic" (note the lowercase "ic" in "Nic") would not be allowed.

Bare Extension Identifiers states the following when using the names of JSON members:

Clients of these JSON responses SHOULD ignore unrecognized JSON members in responses. Servers can insert members into the JSON responses, which are not specified in this document, but that does not constitute an error in the response. Servers that insert such unspecified members into JSON responses SHOULD have member names prefixed with a short identifier followed by an underscore followed by a meaningful name. It has been observed that these short identifiers aid software implementers with identifying the specification of the JSON member, and failure to use one could cause an implementer to assume the server is erroneously using a name from this specification. This allowance does not apply to jCard objects. The full JSON name (the prefix plus the underscore plus the meaningful name) SHOULD adhere to the character and name limitations of the prefix registry described in . Failure to use these limitations could result in slower adoption as these limitations have been observed to aid some client programming models.

Despite this, some RDAP extensions define only one JSON value and do not prefix it with their RDAP extension identifier, instead using the extension identifier as the JSON name for that JSON value. That is, the extension identifier is used "bare" and not appended with an underscore character and subsequent names. Consider the example in . Using the bare extension identifier pattern, that example could be written as: While is specific to JSON, the use of a bare extension identifier also applies to other identifiers of RDAP extensions, such as query parameters and object class names. Identifiers of an RDAP extension which need a prefix to avoid name collision with identifiers of other RDAP extensions or RDAP as specified in , , and are referred to as namespaced identifiers. BARE EXTENSIONS NOT ALLOWED Usage of a bare extension identifier conflicts with the guidance in . Previously, extension authors have used this pattern when only one query path, JSON name, and/or object class is being defined by the extension. Implementation experience has shown that an extension using a bare identifier can be interoperable though more difficult to process and parse in some instances. Furthermore, bare identifier's blur the line between what can be interpreted as an extension to RDAP vs core RDAP mechanisms. Henceforth, this pattern MUST NOT be used for any namespaced identifier. COMPROMISE: BARE EXTENSIONS ONLY ALLOWED UNDER CERTAIN CONDITIONS Usage of a bare extension identifier contravenes the guidance in . Implementation experience has shown that an extension using a bare identifier can be interoperable though more difficult to process and parse in some instances. Furthermore, bare identifier's blur the line between what can be interpreted as an extension to RDAP vs core RDAP mechanisms. This document updates to explicitly allow this pattern only in IETF defined RDAP extensions and only when a technical solution cannot otherwise be defined. This applies not only to JSON names but to other namespaced identifiers. BARE EXTENSIONS ALWAYS ALLOWED Usage of a bare extension identifier contravenes the guidance in . Implementation experience has shown that an extension using a bare identifier can be interoperable though more difficult to process and parse in some instances, therefore this document updates to explicitly allow this pattern when an extension defines only one namespaced identifier of a type (e.g. only one JSON name, only one query parameter, etc...). This applies not only to JSON names but to all namespaced identifiers.

Usage in Requests

Usage in Paths describes the use of extension identifiers in formulating URLs to query RDAP servers. The extension identifiers are to be prepended to the path segments they use. For example, if an extension uses the identifier "foobar", then the path segments used in that extension are prepended with "foobar_". If the "foobar" extension defines paths "fizz" and "fazz", the URLs for this extension would be like so: While describes the extension identifier as a prepended string to a path segment, it does not describe the usage of the extension identifier as a path segment. See with regard to the use of bare extension identifiers in RDAP URLs. Extensions defining new URL paths MUST explicitly define the expected responses for each new URL path. New URL paths may return existing object classes or search results as defined in , object classes or search results defined by the extension (see and below), or object classes or search results from other extensions. Additionally, RDAP extensions MUST NOT append a path segment to an existing path segment as this increases the likelihood of collisons between the queries defined by an extension.

Usage in Query Parameters Although describes the use of URL query strings, it does not define their use with extensions. instructs servers to ignore unknown query parameters. Therefore, the use of query parameters, whether prefixed with an extension identifier or not, is not supported by and . Despite this, there are several extensions that do specify query parameters. This document updates with regard to the use of RDAP extension identifiers in URL query parameters. When an RDAP extension defines query parameters to be used with a URL path that is not defined by that RDAP extension, those query parameter names MUST be constructed in the same manner as URL path segments (that is, extension identifier + '_' + parameter name). See with regard to the use of bare extension identifiers in query parameters. See and for other guidance on the use of query parameters, and see and regarding constraints on the usage of query parameters.

Usage in Responses

Basic Requirements describes the use of extension identifiers in the JSON returned by RDAP servers. Just as in URLs, the extension identifier is prepended to JSON names to create a namespace so that the JSON name from one extension will not collide with the JSON name from another extension. Just as with unknown query parameters in URLs, clients are to ignore unknown JSON names. The example given in is as follows: In this example, the extension identified by "lunarNIC" is prepended to the member names of both a JSON string and a JSON array. See with regard to the use of bare extension identifiers in JSON. As requires the use of the "rdapConformance" data structure, and the "objectClassName" string is required of all object class instances, the complete example from above would be:

Child JSON Values Prefixing of the extension identifier is not required for children of a prefixed JSON object defined by an RDAP extension. The following example shows this use with a JSON object: Here the JSON name "lunarNIC_author" will separate the JSON from other extensions that may have an "author" structure. But the JSON contained within "lunarNIC_author" need not be prepended, as collision is avoided by the use of "lunarNIC_author".

Object Classes in Extensions As described in and , an extension may define new paths in URLs. If the extension describes the behavior of an RDAP query using that path to return an instance of a new class of RDAP object, the JSON names are not required to be prepended with the extension identifier as described in . However, the extension MUST define the value for the "objectClassName" string which is used by clients to evaluate the type of the response. To avoid collisions with object classes defined in other extensions, the value for the "objectClassName" MUST be prepended with the extension identifier, in the same way as for URL paths, query parameters, and JSON names: See with regard to the use of bare extension identifiers in object class names. Extension authors are encouraged to use the "camel case" style described in . Though "objectClassName" is a string and does define one object class name with a space separator (i.e. "ip network"), this document disallows further use of a space character in object class names. Extensions MUST NOT define object class names using the space character or any other character that requires URL-encoding.

Search Results in Extensions As described in and , an extension may define new paths in URLs. If the extension describes the behavior of an RDAP query using the path to return an RDAP search result for a new object class, the JSON name of the search result MUST be prepended with the extension identifier (to avoid collision with search results defined in other extensions). If the search result contains object class instances defined by the extension, each instance MUST have an "objectClassName" string as defined in . For example:

rdapConformance Population offers the following guidance on including extension identifiers in the "rdapConformance" member of an RDAP response: A strict interpretation of this wording where "construction of the response" refers to the JSON structure only would rule out the use of extension identifiers, which are in common use in RDAP. This document clarifies the guidance. For responses to queries other than "/help", a response MUST include in the "rdapConformance" array only those extension identifiers necessary for a client to deserialize the JSON and understand the semantic meaning of the content within the JSON, and each extension identifier MUST be free from conflict with the other identifiers with respect to their syntax and semantics. Note that this document does not update the guidance from regarding "/help" responses and the "rdapConformance" array.

Camel Casing The styling convention used in for JSON names is often called "camel casing", in reference to the hump of a camel. In this style, the first letter of every word, except the first word, composing a name is capitalized. This convention was adopted to visually separate the namespace from the name, with an underscore between them. Extension authors are encouraged to use camel casing for JSON names defined in extensions.

Usage with HTTP Extensions MUST NOT redefine the meaning of HTTP status codes or other HTTP semantics. Extensions MAY require the use of specific HTTP headers but MUST NOT redefine their meanings. Extensions defining new HTTP headers MUST have IETF consensus.

Extension Implementer Considerations

Redirects describes the use of redirects in RDAP. Redirects are prominent in the discovery of authoritative RIR servers, as the process outlined in , which uses IANA allocations, does not account for transfers of resources between RIRs. instructs servers to ignore unknown query parameters (where "unknown" generally means no defined implementation behavior). As it relates to issuing URLs for redirects, servers MUST NOT blindly copy query parameters from a request to a redirect URL as query parameters may contain sensitive information, such as security credentials, not relevant to the target server of the URL. Following the advice in , servers MUST only place query parameters in redirect URLs when it is known by the origin server (the server issuing the redirect) that the target server (the server referenced by the redirect) can process the query parameter and is a proper target for the contents of the query parameter.

Extension Author Considerations

Redirects As it is unlikely that every server in a cross-authority, redirect scenario will be upgraded to process every new extension, extensions should not rely on query parameters alone to convey information about a resource, as query parameters are not guaranteed to survive a redirect. This does not mean extensions are prohibited from using query parameters, but rather that the use of query parameters must be applied for the scenarios appropriate for the use of the extension. Therefore, extensions MUST NOT rely on query parameters when the extension is to be used in scenarios requiring clients to find authoritative servers, or other scenarios using redirects among servers of differing authorities. Extensions MAY use query parameters in scenarios where the client has a priori knowledge of the authoritative server to which queries are to be sent, and will be sending queries to that server directly. Searches () are an example scenario where a client will be operating in this way. In general, extension authors should be mindful of situations requiring clients to directly handle redirects at the RDAP layer. Some clients may not be utilizing HTTP libraries that provide such an option, and some HTTP client libraries that do provide the option do not provide it as a default behavior. Additionally, requiring clients to handle redirects at the RDAP layer adds complexity to the client in that additional logic must be implemented to handle redirect loops, parameter deconfliction, and URL encoding. The guidance given in exists to simplify clients, especially those constructed with shell scripts and HTTP command-line utilities.

Referrals It is common in the RDAP ecosystem to link from one RDAP resource to another, such as can be found in domain registrations in gTLD DNRs. These are typically conveyed in the link structure defined in and use the "application/rdap+json" media type. For example: Extensions MUST explicitly define any required behavioral changes to the processing of referrals. If an extension does not make any provision in this respect, clients MUST assume the information provided by referrals requires no additional processing or modification to use in the dereferencing of the referral. Extensions MAY define referral processing behaviors of referrals defined in other extensions or in . Servers MUST NOT use multiple extensions in a response with processing requirements over the same referrals where clients would not be able to process the referrals in a deterministic way.

Extension Versioning As stated in , RDAP extension identifiers and RDAP conformance strings are opaque, and they possess no explicit version despite the fact that some extension identifiers include trailing numbers. That is, RDAP extensions without an explicitly-defined versioning scheme are opaquely versioned. For example, "fizzbuzz_1" may be the successor to "fizzbuzz_0", but it may also be an extension for a completely separate purpose. Only consultation of the definition of "fizzbuzz_1" will determine its relationship with "fizzbuzz_0". Additionally, "fizzbuzz_99" may be the predecessor of "fizzbuzz_0". An RDAP extension definition MUST explicitly denote its compliance, or lack of, with any versioning scheme, such as .

Backwards-Compatible Changes If an RDAP extension author wants to publish a new version of an extension that is backwards-compatible with the previous version, then one option is for the new version of the extension to define a new identifier, as well as requiring that both the previous identifier and the new identifier be included in the "rdapConformance" array of responses. That way, clients relying on the previous version of the extension will continue to function as intended, while clients wanting to make use of the newer version of the extension can check for the new identifier in the response. This approach can be used for an arbitrary number of new backwards-compatible versions of a given extension. For an extension with a large number of backwards-compatible successor versions, this may lead to a large number of identifiers being included in responses. An extension author may consider excluding older identifiers from the set required by new successor versions, based on data about client use/support or similar. Where multiple versions of an extension are to be expected, extension authors should consider using formal versioning schemes such as those described and defined in .

Backwards-Incompatible Changes With the current extension model, an extension with a backwards-incompatible change is indistinguishable from a new, unrelated extension. Implementers of such changes should consider the following:

whether the new version of the extension can be provided alongside the old version of the extension, so that a service can simply support both during a transition period;
whether some sort of client signaling should be supported, so that clients can opt for the old or new version of the extension in responses that they receive (see for an example of how this might work); and
whether the extension itself should define how versioning is handled within the extension documentation.

Extension Specification Content The primary purpose of an RDAP extension specification is to aid in the implementation of RDAP clients. Extension authors should consider the following content guidelines:

Examples of RDAP JSON should be generously given, especially in areas of the specification which may be complex or difficult to describe with prose.
Normative references, i.e. references to materials that are required for the interoperability of the extension, should be stable and non-changing.
Extension specifications MUST NOT define requests and responses exchanges over an unencrypted HTTP connection. Extensions should also be compliant with the security considerations of .
Extension specifications MUST NOT forbid the use of RDAP services over IPv6.
The use of the various RDAP extension points, as described in , should be clearly delineated.

Extension Definitions Extensions must be documented in an RFC or in some other permanent, stable, and readily available reference, in sufficient detail that interoperability between independent implementations is possible. Though RDAP gives each extension its own namespace, the definition of an extension may reuse definitions found in the base RDAP specification or in any other registered extension. notes that the extension identifiers provide a "hint" to the client as to how to interpret the response. This wording does not intentionally restrict the extension to defining only JSON values within the extension's namespace. Therefore, an extension may define the use of its own JSON values together with the use of JSON values from other extensions or RDAP specifications. As with the and extensions, the extension may simply signal policy applied to previously-defined RDAP structures (see ).

Existing Extension Registrations The following extensions have been registered with IANA, but do not comply with the requirements set out in the base specifications, as clarified by this document:

Extension identifier: fred
- RDAP conformance value: fred_version_0
- Field/path prefix: fred
Extension identifier: artRecord
- RDAP conformance value: artRecord_level_0
- Field/path prefix: artRecord
Extension identifier: platformNS
- RDAP conformance value: platformNS_level_0
- Field/path prefix: platformNS
Extension identifier: regType
- RDAP conformance value: regType_level_0
- Field/path prefix: regType

Client authors should be aware that responses that make use of these extensions may require special handling on the part of the client. Also, while these extensions will be retained in the registry, future extensions that are similarly non-compliant will not be registered.

IANA Considerations

RDAP Extensions Registry defines the RDAP Extensions Registry (https://www.iana.org/assignments/rdap-extensions/rdap-extensions.xhtml). This document does not change the purpose of this registry but does update the structure and procedures to be used by its expert reviewers.

Deprecation Date IANA is instructed to add a new "Deprecation Date" field to each registration in the registry. This field is to remain empty unless IANA is given a date to place in the field. A registrant, as denoted by the contact field of the registry, may request of IANA to deprecate an RDAP extension. The IETF may request of the IANA to deprecate any RDAP extension in the registry. When deprecating an entry in this registry, the IANA is to record the date of the request in the "Deprecation Date" field. The "Deprecation Date" field should use the date format specified in .

Registratiion Procedures Extension authors are encouraged but not required to seek an informal review of their extension by sending a request for review to regext@ietf.org or its successor. The registration template of this registry is found in and is unchanged. It is requested of the IANA that all registrations be forwarded to regext@ietf.org or its successor.

Expert Review The RDAP Extensions Registry should have as a minimum three expert reviewers and ideally four or five. An expert reviewer assigned to the review of an RDAP extension registration must have another expert reviewer double-check any submitted registration. Expert reviewers are to use the following criteria for extensions defined in this document, , , and . The following is a summary checklist:

Does the extension define an extension identifier following the naming conventions described in and ?
If the extension defines new queries, does it clearly describe the expected results of each new query?
Does the extension follow the JSON naming requirements as described in ?
If the extension is a newer version of an older extension, does the extension specification clearly describe if it is backwards-compatible (see ) or backwards-incompatible (see )?
If the extension registers new values in an IANA registry used by RDAP, does it describe how a client is to use those values?
If the extension is a new registration, is it a case-variant of an existing registration (see )?

As noted in , any new registration that is a case-variant of an existing registration MUST be rejected. RDAP clients SHOULD match values in this registry using case-insensitive matching to handle server implementations incorrectly using the wrong case.

RDAP JSON Values Registry defines the RDAP JSON Values Registry in IANA. This registry contains values to be used in the JSON values of RDAP responses. Registrations into this registry may occur in IETF-defined RDAP extensions or via requests to the IANA. Authors of RDAP extensions not defined by the IETF MAY register values in this registry via requests to the IANA. The IANA is requested to send a copy of any request not originating from the IETF to regext@ietf.org or its successor. This document does not change the RDAP JSON Values Registry nor its purpose. However, this document does update the procedures for registrations and the processes to be used by its expert reviewers. In addition to the registration of values, RDAP extensions defined by the IETF and other IETF specifications MAY define additional value types (the "type" field). These specifications MUST describe the specific JSON field to be used for each new value type. defines the criteria for the values. Of these, criteria two states:

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.

All registrations SHOULD meet these requirements. However, there may be scenarios in which it is more appropriate for the values to follow other requirements, such as for values also used in other specifications or documents. In all cases, it should be understood that additional registrations of RDAP JSON values occurring after the specification of the value's type in the registry may not be recognized by clients, and therefore either ignored or passed on to users without processing. Designated experts MUST reject any registration that is a duplicate of an existing registration, and all registrations are to be considered case-insensitive. That is, any new registration that is a case-variant of an existing registration should be rejected. RDAP clients SHOULD match values in this registry using case-insensitive matching to handle server implementations incorrectly using the wrong case. Definitions of new types (see above) MAY additionally constrain the format of values for those new types beyond the specification of this document and . Designated experts MUST evaluate registrations with those criteria. The RDAP JSON Values Registry should have as a minimum three expert reviewers and ideally four or five. An expert reviewer assigned to the review of an RDAP JSON values registration must have another expert reviewer double-check any submitted registration. Expert reviewers are to use the criteria defined in .

Security Considerations describes the usage of query parameters and describes the restrictions extensions must follow to use them. instructs servers to ignore unknown query parameters. As it relates to issuing URLs for redirects, servers MUST NOT blindly copy query parameters from a request to a redirect URL as query parameters may contain sensitive information, such as security credentials or tracking information, not relevant to the target server of the URL. Following the advice in , servers MUST only place query parameters in redirect URLs when it is known by the origin server (the server issuing the redirect) that the target server (the server referenced by the redirect) can process the query parameter and the contents of the query parameter are appropriate to be received by the target.

Privacy Considerations describes the usage of query parameters and describes the restrictions extensions must follow to use them. As query parameters have been known to be used to subvert the privacy preferences of users in HTTP-based protocols, server MUST NOT blindly copy query parameters from a request to a redirect URL as described in and extensions MUST follow the constraints of query parameter usage as defined in .

Acknowledgments The following individuals have provided feedback and contributions to the content and direction of this document: James Gould, Scott Hollenbeck, Ties de Kock, Pawel Kowalik, Daniel Keathley, and Mario Loffredo.