]> IIT-CNR/Registro.it

Via Moruzzi,1 Pisa Italy 56124 mario.loffredo@iit.cnr.it http://www.iit.cnr.it

IIT-CNR/Registro.it

Via Moruzzi,1 Pisa Italy 56124 maurizio.martinelli@iit.cnr.it http://www.iit.cnr.it

art regext RDAP Reverse search The Registration Data Access Protocol (RDAP) does not include query capabilities for finding the list of domains related to a set of entities matching a given search pattern. Considering that an RDAP entity can be associated with any defined object class and other relationships between RDAP object classes exist, a reverse search can be applied to other use cases besides the classic domain-entity scenario. This document describes an RDAP extension that allows servers to provide a reverse search feature based on the relationship defined in RDAP between an object class for search and any related object class. The reverse search based on the domain-entity relationship is treated as a particular case.

Introduction The protocol described in this specification aims to extend the RDAP query capabilities and response to enable reverse search based on the relationships defined in RDAP between an object class for search and a related object class. The reverse search based on the domain-entity relationship is treated as a particular case of such a generic model. RDAP providers willing to implement this specification should carefully consider its implications on the efficiency (see ), the security (see ), and the compliance with privacy regulations (see ) of their RDAP service.

Background Reverse WHOIS is a service provided by many web applications that allows users to find domain names owned by an individual or a company starting from the owner's details, such as name and email. Even if it has been considered useful for some legal purposes (e.g., uncovering trademark infringements and detecting cybercrimes), its availability as a standardized WHOIS capability has been objected to for two main reasons, which now don't seem to conflict with an RDAP implementation. The first objection concerns the potential risks of privacy violation. However, the domain name community is considering a new generation of Registration Directory Services that provide access to sensitive data under some permissible purposes and in accordance with appropriate policies for requestor accreditation, authentication, and authorization. RDAP's reliance on HTTP means that it can make use of common HTTP-based approaches to authentication and authorization, making it more useful than WHOIS in the context of such directory services. Since RDAP consequently permits a reverse search implementation complying with privacy protection principles, this first objection is not well-founded. The second objection to the implementation of a reverse search capability has been connected with its impact on server processing. However, the core RDAP specifications already define search queries, with similar processing requirements, so the basis of this objection is not clear. Reverse searches, such as finding the list of domain names associated with contacts or nameservers, may be useful to registrars as well. Usually, registries adopt out-of-band solutions to provide results to registrars asking for reverse searches on their domains. Possible reasons for such requests are:

• the loss of synchronization between the registrar database and the registry database and
• the need for such data to perform bulk Extensible Provisioning Protocol (EPP) updates (e.g., changing the contacts of a set of domains, etc.).

Currently, RDAP does not provide any means for a client to search for the collection of domains associated with an entity . A query (lookup or search) on domains can return the array of entities related to a domain with different roles (registrant, registrar, administrative, technical, reseller, etc.), but the reverse operation is not allowed. Only reverse searches to find the collection of domains related to a nameserver (ldhName or ip) can be requested. Since an entity can be in relationship with any RDAP object , the availability of a reverse search as largely intended can be common to all the object classes allowed for search. Through a further step of generalization, the meaning of reverse search in the RDAP context can be extended to include any query for retrieving all the objects that relates to another query matching a given search pattern.

Conventions Used in This Document 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.

Reverse Search Path Segment Specification A generic reverse search path is described by the syntax: {searchable-resource-type}/reverse_search/{related-resource-type}?<search-condition> The path segments are defined as follows:

"searchable-resource-type":

It MUST be one of the resource types for search defined in (i.e., "domains", "nameservers", and "entities") or a resource type extension.

"related-resource-type":

It MUST be one of the resource types for lookup defined in (i.e., "domain", "nameserver", "entity", "ip", and "autnum") or a resource type extension.

"search-condition":

A sequence of "property=search pattern" predicates separated by the ampersand character ('&', US-ASCII value 0x0026).

While related-resource-type is defined as having one of a number of different values, the only reverse searches defined in this document are for a related-resource-type of "entity". Reverse searches for the other resource types specified in and resource type extensions may be defined by future documents.

Reverse Search Definition Based on the content of , defining a reverse search means to define the triple <searchable resource type, related resource type, property> and the mapping with the corresponding RDAP object member. The mapping is done through the use of a JSONPath expression . Reverse searches are registered in the "RDAP Reverse Search" registry (see ), whereas reverse search mappings are registered in the "RDAP Reverse Search Mapping" registry (see ). The reason for having two registries is that it may be possible for a single type of reverse search to rely on different members, depending on the server's configuration (see ). All of the reverse searches defined by this document (see ) have property names that are the same as the name of the RDAP object member that is the subject of the search. For example, the reverse search with the property name "fn" relies on the value of the "fn" member inside the jCard of an entity object. However, it is not necessary that these two names be the same. In particular, remapping of searches as part of the deprecation of an existing member (see ) will typically lead to a member with a different name being used for the search. Servers MUST NOT provide or implement reverse searches or reverse search mappings that are not registered with IANA.

Reverse Search Properties Discovery Servers complying with this specification MUST extend the help response with the "reverse_search_properties" member that contains an array of objects with the following mandatory child members:

"searchableResourceType":

the searchable resource type of the reverse search query, as defined in

"relatedResourceType":

the related resource type of the reverse search query, as defined in

"property":

the reverse search property used in the predicate of the reverse search query, as defined in

An example of the help response including the "reverse_search_properties" member is shown in

Reverse Search Properties Mapping To permit clients to determine the member used by the server for a reverse search, servers MUST detail the mapping that is occurring by adding the "reverse_search_properties_mapping" member to the topmost object of a reverse search response. This data structure is included in the search response, rather than in the help response, because it may differ depending on the query that is sent to the server. Documents that deprecate or restructure RDAP responses such that a registered reverse search is no longer able to be used MUST either note that the relevant reverse search is no longer available (in the case of deprecation) or describe how to continue supporting the relevant search by adding another mapping for the reverse search property (in the case of restructuring). The "reverse_search_properties_mapping" member contains an array of objects with the following mandatory child members:

"property":

the reverse search property used in the predicate of the current query, as defined in

"propertyPath":

the JSONPath expression of the object member (or members) corresponding to the reverse search property

The searchable and the related resource types are derived from the query, so there is no need to include them in addition to the property in this member. This member MUST be included for all properties used in the search, regardless of whether that property has multiple registered mappings as at the time of the search, because new mappings may be registered at any time. When applied to an object, the JSONPath expression MUST produce a list of values, each of which is a JSON number or string. An example of a reverse search response including the "reverse_search_properties_mapping" member is shown in .

Reverse Search Response Specification Reverse search responses use the formats defined in , which correspond to the searchable resource types defined in .

Reverse Search Query Processing To process a reverse search, the server returns the objects from its data store that are of type searchable-resource-type and that match each of the predicates from the search conditions. To determine whether an object matches a predicate, the server:

• applies the mapping it uses for the reverse search property to the object in order to generate a list of values, each of which MUST be a JSON number or string and
• checks whether the search pattern matches one or more of those values.

A search pattern matches a value where it equals the string representation of the value or where it is a match for the value in accordance with the partial string matching behavior defined in . Objects are only included in the search results if they satisfy all included predicates. This includes predicates that are for the same property; in such a case, it is necessary for the related object to match against each of those predicates. Servers MUST return an HTTP 501 (Not Implemented) response to inform clients of unsupported reverse searches. Based on their policy, servers MAY restrict how predicates are used to make a valid search condition by returning a 400 (Bad Request) response when a problematic request is received. A given reverse search or reverse search mapping MAY define additional or alternative search behavior past that set out in this section.

Reverse Searches Based on Entity Details Since an entity can be associated with any other object class in RDAP, the most common kind of reverse search is one based on an entity's details. Such reverse searches arise from the query model by setting the related resource type to "entity". By selecting a specific searchable resource type, the resulting reverse search aims at retrieving all the objects (e.g., all the domains) that are related to any entity object matching the search conditions. This section defines the reverse search properties servers SHOULD support for the domain, nameserver, entity-searchable resource types, and entity-related resource type:

Reverse search property:

role

RDAP member path:

$.entities[*].roles

Reference:

Reverse search property:

handle

RDAP member path:

$.entities[*].handle

Reference:

Reverse search property:

fn

RDAP member path:

$.entities[*].vcardArray[1][?(@[0]=='fn')][3]

Reference:

Reverse search property:

email

RDAP member path:

$.entities[*].vcardArray[1][?(@[0]=='email')][3]

Reference:

The presence of a predicate on the reverse search property "role" means that the RDAP response property "roles" MUST contain at least the specified role. The last two properties are related to jCard elements , but the field references are to vCard , since jCard is the JSON format for vCard. Examples of reverse search paths based on the domain-entity relationship are presented in .

Examples of Reverse Search Queries

An example of the help response including the supported reverse search properties is shown in .

An Example of the Help Response including the "reverse_search_properties" Member

An example of a response including the mapping that is occurring for the first reverse search in is shown below.

An Example of an RDAP Response including the "reverse_search_properties_mapping" Member

RDAP Conformance Servers complying with this specification MUST include the value "reverse_search" in the rdapConformance property of the help response and any other response including the "reverse_search_properties_mapping" member. The information needed to register this value in the "RDAP Extensions" registry is described in .

Implementation Considerations To limit the impact of processing the search predicates, servers are RECOMMENDED to make use of techniques to speed up the data retrieval in their underlying data store, such as indexes or similar. In addition, risks with respect to performance degradation or result set generation can be mitigated by adopting practices used for standard searches, e.g., restricting the search functionality, limiting the rate of search requests according to the user's authorization, truncating and paging the results , and returning partial responses .

IANA Considerations

RDAP Extensions Registry IANA has registered the following value in the "RDAP Extensions" registry:

Extension Identifier:

reverse_search

Registry Operator:

Any

Specification:

RFC 9536

Contact:

IETF <iesg@ietf.org>

Intended Usage:

This extension identifier is used for both URI path segments and response extensions related to the reverse search in RDAP.

RDAP Reverse Search Registries

Creation of the RDAP Reverse Search Registries IANA has created the "RDAP Reverse Search" and "RDAP Reverse Search Mapping" registries within the "Registration Data Access Protocol (RDAP)" category in the protocol registries. These registries follow the Specification Required registration policy, as defined in . The designated expert should prevent collisions and confirm that suitable documentation, as described in , is available to ensure interoperability. Creators of either new RDAP reverse searches or new mappings for registered reverse searches SHOULD NOT replicate functionality already available by way of other documents referenced in these registries. Creators MAY register additional reverse search mappings for existing properties, but they SHOULD NOT map a registered reverse search property to a response field with a meaning other than that of the response fields referenced by the mappings already registered for that property. In other words, all the mappings for a reverse search property MUST point to response fields with the same meaning.

Submit Requests to IANA Registration requests can be sent to <iana@iana.org>.

RDAP Reverse Search Registry

Template

Property:

The name of the reverse search property.

Description:

A brief human-readable text describing the reverse search property.

Searchable Resource Type:

The searchable resource type of the reverse search query () including the reverse search property. Multiple reverse search properties differing only by this field can be grouped together by listing all the searchable resource types separated by comma (see ).

Related Resource Type:

The related resource type of the reverse search query () including the reverse search property.

Registrant:

The name of the person registering the reverse search property.

Contact Information:

An email address, postal address, or some other information to be used to contact the registrant.

Reference:

Document (e.g., the RFC number) and section reference where the reverse search property is specified.

The combination of Searchable Resource Type, Related Resource Type, and Property MUST be unique across the registry entries.

Initial Content IANA has registered the following entries in the "RDAP Reverse Search" registry. For all entries, the common values are shown in , whereas the specific values are shown in . Common Values for All Entries in the RDAP Reverse Search Registry

Registry Property	Value
Searchable Resource Type	domains, nameservers, entities
Related Resource Type	entity
Registrant	IETF
Contact Information	iesg@ietf.org
Reference	RFC 9536

Specific Values for Entries in the RDAP Reverse Search Registry

Property	Description
fn	The server supports the domain/nameserver/entity search based on the full name (a.k.a. formatted name) of an associated entity
handle	The server supports the domain/nameserver/entity search based on the handle of an associated entity
email	The server supports the domain/nameserver/entity search based on the email address of an associated entity
role	The server supports the domain/nameserver/entity search based on the role of an associated entity

RDAP Reverse Search Mapping Registry

Template

Property:

The same as defined in the "RDAP Reverse Search" registry.

Property Path:

The JSONPath of the RDAP property this reverse search property maps to.

Searchable Resource Type:

The same as defined in the "RDAP Reverse Search" registry.

Related Resource Type:

The same as defined in the "RDAP Reverse Search" registry.

Registrant:

The name of the person registering this reverse search property mapping.

Contact Information:

The same as defined in the "RDAP Reverse Search" registry.

Reference:

Document (e.g., the RFC number) and section reference where this reverse search property mapping is specified.

The combination of Searchable Resource Type, Related Resource Type, Property, and Property Path MUST be unique across the registry entries.

Initial Content IANA has registered the following entries in the "RDAP Reverse Search Mapping" registry. For all entries, the common values are the same as defined in the "RDAP Reverse Search" registry (see ), whereas the specific values are shown below (see ). Specific Values for Entries in the RDAP Reverse Search Mapping Registry

Property	Property Path
fn	$.entities[*].vcardArray[1][?(@[0]=='fn')][3]
handle	$.entities[*].handle
email	$.entities[*].vcardArray[1][?(@[0]=='email')][3]
role	$.entities[*].roles

Privacy Considerations The search functionality defined in this document may affect the privacy of entities in the registry (and elsewhere) in various ways; see for a general treatment of privacy in protocol specifications. Registry operators should be aware of the trade-offs that result from implementing this functionality. Many jurisdictions have laws or regulations that restrict the use of "personal data", per the definition in . Given that, registry operators should ascertain whether the regulatory environment in which they operate permits implementation of the functionality defined in this document. In those cases where this functionality makes use of sensitive information, the information MUST only be accessible to authorized users under a lawful basis. Since reverse search requests and responses could contain Personally Identifiable Information (PII), reverse search functionality MUST be available over HTTPS only. Providing reverse search in RDAP carries the following threats as described in :

• Correlation
• Disclosure
• Misuse of data

Therefore, RDAP providers need to mitigate the risk of those threats by implementing appropriate measures supported by security services (see ).

Security Considerations Security services that are required to provide controlled access to the operations specified in this document are described in . A non-exhaustive list of access control paradigms an RDAP provider can implement is presented in . As an additional measure to enforce security by preventing reverse searches to be accessed from unauthorized users, the RDAP providers may consider physically separating the reverse search endpoints from the other ones by configuring a proxy routing the reverse searches to a dedicated backend server and leveraging further security services offered by other protocol layers, such as digital certificates and IP allow-listing. Finally, the specification of the relationship within the reverse search path allows the RDAP servers to implement different authorization policies on a per-relationship basis.

References Normative References Informative References ICANN ICANN

Paradigms to Enforce Access Control on Reverse Search in RDAP Access control can be implemented according to different paradigms introducing increasingly stringent rules. The paradigms listed below leverage the capabilities that are either built in or provided as extensions by the OpenID Connect :

Role-Based Access Control (RBAC):

Access rights are granted depending on roles. Generally, this is done by grouping users into fixed categories and assigning static grants to each category. A more dynamic approach can be implemented by using the OpenID Connect "scope" claim.

Purpose-Based Access Control (PBAC):

Access rules are based on the notion of purpose, being the intended use of some data by a user. It can be implemented by tagging a request with the usage purpose and making the RDAP server check the compliance between the given purpose and the control rules applied to the data to be returned.

Attribute-Based Access Control (ABAC):

Rules to manage access rights are evaluated and applied according to specific attributes describing the context within which data are requested. It can be implemented within an out-of-band process by setting additional OpenID Connect claims that describe the request context and make the RDAP server check for compliance between the given context and the control rules that are applied to the data to be returned.

Time-Based Access Control (TBAC):

Data access is allowed for a limited time only. It can be implemented by assigning users temporary credentials linked to access grants with limited scopes.

With regard to the privacy threats reported in , correlation and disclosure can be mitigated by minimizing both the request features and the response data based on user roles (i.e., RBAC). Misuse can be mitigated by checking for the purpose of the request (i.e., PBAC). It can be accomplished according to the following approaches:

Full Trust:

The registry trusts the fairness of an accredited user. The requestor is always legitimized to submit their requests under a lawful basis. Additionally, they can be required to specify the purpose as either a claim of their account or a query parameter. In the former case, the purpose is assumed to be the same for every request. In the latter case, the purpose must be one of those associated to the user.

Zero Trust:

The registry requires documents that assess whether the requestor is legitimized to submit a given request. It can be implemented by assigning the requestor a temporary OpenID account linked to the given request (i.e., TBAC) and describing the request through a set of claims (i.e., ABAC). The association between the temporary account and the claims about the request is made by an out-of-band application. In so doing, the RDAP server is able to check that the incoming request is consistent with the request claims linked to the temporary account.

The two approaches can be used together:

• The former is suitable for users carrying out a task in the public interest or exercising their official authority (e.g., an officer of a cybercrime agency). Similarly, registrars can submit reverse searches on their domains and contacts based on their contractual relationship with the domain holders. In this case, the query results can be restricted to those pertaining to a registrar by adding an implicit predicate to the search condition.
• The latter can be taken to allow domain name dispute resolution service providers to request information in defense of the legitimate interests of complainants.

Acknowledgements The authors would like to acknowledge the following individuals for their contributions to this document: , , , , , , , and . and provided relevant feedback and constant support to the implementation of this proposal. Their contributions have been greatly appreciated.