An RDAP Extension for Geofeed Data

Introduction and (obsoletes ) detail the IP geolocation feed (in short, geofeed) concept. This document specifies how the geofeed data can be accessed through RDAP. It defines a new RDAP extension "geofeed1" for including a geofeed file URL in an IP Network object.

Requirements Language The keywords "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.

Specification

Extension A new RDAP extension "geofeed1" is defined for accessing the geofeed data through RDAP. It updates the IP Network object class definition () to include a new link object for the geofeed file URL in its "links" array (). An RDAP server conforming to this specification MUST include the "geofeed1" extension string in the "rdapConformance" array for the IP Network lookup and search responses, as well as in the help response.

Geofeed Link The IP Network object class () MAY include a link object for the geofeed file URL (also referred to as a Geofeed link object) in its "links" array, with the following REQUIRED JSON members:

"value" -- The "value" JSON value is the context URI ().
"rel" -- The "rel" JSON value is the link relation type and set to the "geo" string. The "geo" link relation type is new and will be registered in the IANA Link Relations Registry (see the "Link Relations Registry" section).
"href" -- The "href" JSON value is the target URI and set to the HTTPS URL of the geofeed file for the IP network.

Per the definition of a web link (), a Geofeed link object may have additional JSON members. Specifically:

"type" -- The "type" JSON value is the media type for the target URI. Given that the geofeed data is mostly intended for use by automated/scripted processes, it is RECOMMENDED that server operators set a media type in Geofeed link objects. See the "Media Type for a Geofeed Link" section for acceptable "type" values.
"hreflang" -- The "hreflang" JSON value is an attribute for the target URI and could be used to indicate the languages the geofeed data is available in. It is OPTIONAL.

There MAY be zero or more Geofeed link objects in the "links" array of an IP Network object. In other words, the Geofeed link objects are OPTIONAL.

Media Type for a Geofeed Link requires a geofeed file to be a UTF-8 CSV file, with a series of "#" comments at the end for the optional RPKI signature. At first glance, the "text/csv" media type () seems like a good candidate to represent a geofeed file, but it does not support the "#" comments needed to include the RPKI signature. To enable including "#" comments for an RPKI signature, a new media type "application/geofeed+csv" will be registered in the IANA Media Types Registry (see the "Media Types Registry" section), and a new suffix "+csv" in the IANA Structured Syntax Suffixes Registry (see the "Structured Syntax Suffixes Registry" section). The "type" JSON value in a Geofeed link object SHOULD be set to the "application/geofeed+csv" media type. If alternative geofeed formats are defined in the future, they could be included in future versions of this specification.

Example The following is an elided example of an IP Network object with a Geofeed link object:

Redaction Since the Geofeed link objects in the "links" array of an IP Network object are optional, the Redaction by Removal method MUST be used when redacting them. The following is an elided example of an IP Network object with redacted Geofeed link objects:

Privacy Considerations When including a geofeed file URL in an IP Network object, an RDAP server operator SHOULD follow the guidance from to not accidentally expose the location of an individual.

Security Considerations requires an HTTPS URL for a geofeed file, and optionally RPKI-signing the data within. Besides that, this document does not introduce any new security considerations past those already discussed in the RDAP protocol specifications.

IANA Considerations

RDAP Extensions Registry IANA is requested to register the following value in the RDAP Extensions Registry:

Extension identifier: geofeed1
Registry operator: Any
Published specification: This document.
Contact: IETF iesg@ietf.org
Intended usage: This extension describes version 1 of a method to access the IP geolocation feed data through RDAP.

Link Relations Registry IANA is requested to register the following value in the Link Relations Registry:

Relation Name: geo
Description: Indicates that the link context has a resource with geographic information at the link target.
Reference: This document.

Media Types Registry

Type name: application
Subtype name: geofeed+csv
Required parameters: N/A
Optional parameters: N/A
Encoding considerations: See .
Security considerations: See the "Security Considerations" section of this document.
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) Extension for Geofeed Data.
Additional information: This media type is a product of the IETF REGEXT Working Group. The REGEXT charter, information on the REGEXT mailing list, and other documents produced by the REGEXT Working Group can be found at https://datatracker.ietf.org/wg/regext/.
Person & email address to contact for further information: IESG <iesg&ietf.org>
Intended usage: COMMON
Restrictions on usage: None
Authors: Tom Harrison, Jasdip Singh
Change controller: IETF
Provisional Registration: No

Structured Syntax Suffixes Registry

Name: Comma-Separated Values (CSV)
+suffix: +csv
References: ,
Encoding Considerations: Same as "text/csv".
Interoperability Considerations: Same as "text/csv".
Fragment Identifier Considerations: The syntax and semantics of fragment identifiers specified for +csv SHOULD be as specified for "text/csv". The syntax and semantics for fragment identifiers for a specific "xxx/yyy+csv" SHOULD be processed as follows: For cases defined in +csv, where the fragment identifier resolves per the +csv rules, then as specified in +csv. For cases defined in +csv, where the fragment identifier does not resolve per the +csv rules, then as specified in "xxx/yyy+csv". For cases not defined in +csv, then as specified in "xxx/yyy+csv".
Security Considerations: Same as "text/csv".
Contact: IETF iesg@ietf.org

Acknowledgements Gavin Brown suggested using a web link instead of a simple URI string to specify a geofeed file URL.

Change History

Changes from 00 to 01

Now using a web link instead of a simple URI string to specify a geofeed file URL.
Renamed the extension as "geofeed1" instead of "geofeedv1".
Introduced the new "geo" link relation type.
Introduced the new "application/geofeed+csv" media type.