| Internet-Draft | Redacted Fields in RDAP | November 2021 |
| Gould, et al. | Expires 22 May 2022 | [Page] |
This document describes an RDAP extension for explicitly identifying redacted RDAP response fields, using JSONPath as the default expression language.¶
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 https://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 22 May 2022.¶
Copyright (c) 2021 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 (https://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.¶
This document describes an RDAP extension for explicitly identifying redacted RDAP response fields, using JSONPath as the default expression language. A redacted RDAP field is one that has data removed from the RDAP response due to the lack of client privilege to receive the field. This extension can be used to identify redacted RDAP fields in any RDAP object class, as defined in [RFC7483], or RDAP fields defined in RDAP extensions. Because an RDAP response may exclude a field due to either the lack of data or based on the lack of RDAP client privileges, this extension is used to explicitly specify which RDAP fields are not included in the RDAP response due to redaction. It thereby provides a capability for disambiguation between redaction and possible other reasons for data or field absence.¶
In [RFC7482] RDAP supports both lookup and search queries, where a lookup query responds with a single object and a search query responds with a list of objects. This document applies to redaction of a single object of a lookup response and in each of the objects of a search response.¶
JSONPath, as defined in [I-D.ietf-jsonpath-base], is used as the default expression language to reference RDAP fields that have been redacted. The redacted JSON fields will either be removed or have empty values in the RDAP response. JSON is defined by [RFC8259].¶
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 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
The JSON examples include extra line breaks and whitespace. For instance, the JSONPath expressions are broken out into multiple lines when required for illustration.¶
Redaction in RDAP can be handled in multiple ways. The use of placeholder text for the values of the RDAP fields, such as the placeholder text "XXXX", MUST NOT be used for redaction. A placeholder text value will not match the format requirements of each of the RDAP fields and provides an inconsistent and unreliable redaction signal. This section covers the redaction methods that can be used with the redaction signaling defined in Section 4.2.¶
RDAP responses, as defined in [RFC7483], include a mix of JSON objects and JSON arrays, where JSON arrays are heavily used for entity objects with jCard [RFC7095]. jCard [RFC7095] is a JSON representation of vCard [RFC6350] that inherits its dependency on arrays. An example is the vCard [RFC6350] "ADR" property / jCard [RFC7095] "adr" property that defines a sequence of address components. According to [RFC6350], when an "ADR" property component value is missing, the associated component separator MUST still be specified. jCard [RFC7095] extends the use of arrays with each individual vCard property being represented by an array of three fixed elements, followed by one or more additional elements. The mix of JSON objects and JSON arrays impacts the methods used for redaction in RDAP.¶
The redaction of RDAP fields fall into the two categories of Redaction by Removal Method (Section 3.1) and Redaction by Empty Value Method (Section 3.2), defined in the following sub-sections.¶
The Redaction by Removal Method is when the RDAP field is removed from the RDAP response, which is the preferred method. The Redaction by Removal Method can be done for all RDAP response fields other than response fields using the position in an array to signal the redacted field (e.g., the JSON arrays used with jCard [RFC7095]). RDAP extensions such as JSContact in Registration Data Access Protocol (RDAP) JSON Responses [I-D.ietf-regext-rdap-jscontact] do not have a dependency on the use of positional JSON arrays and are therefore suited for the Redaction by Removal Method.¶
When an RDAP object is redacted by removal, all of the RDAP object's child fields are also removed. Only the redacted RDAP object needs to be referenced in the list of redacted fields, as defined in Section 4.2. An example of redacting an RDAP object is removing the administrative contact from the RDAP response and including the following "redacted" member:¶
"redacted": [
{
"name": {
"type": "Administrative Contact"
},
"path": "$.entities[?(@.roles[0]=='administrative')]",
"method": "removal"
}
]
¶
The Redaction by Removal Method MUST NOT be used to remove a field using the position in a fixed length array to signal the redacted field. For example, removal of an individual data field in jCard [RFC7095] will result in a non-conformant jCard [RFC7095] array definition.¶
The Redaction by Empty Value Method is when a redacted field is not removed, but its value is set to an empty value, such as "" for a jCard [RFC7095] Text ("text") property or null for non-Text ("text") properties. The empty jCard [RFC7095] values ("" or null) are referenced in the "redacted" member in place of the jCard [RFC7095] property name, such as referencing the "fn" jCard property value at position 3 instead of referencing the "fn" jCard property name at position 0. The Redaction by Empty Value Method SHOULD be used only when redacting JSON response fields that use the position in an array to signal the redacted field (e.g., jCard [RFC7095] arrays). Optional jCard [RFC7095] properties SHOULD use the Redaction by Removal Method (Section 3.1) to redact the entire property. The required jCard [RFC7095] "fn" property, defined in section 6.2.1 of vCard [RFC6350], MUST use the Redaction by Empty Value Method to redact the property value. Removing the "fn" property would violate vCard [RFC6350] and removing the property value would violate the fixed array positions defined in jCard [RFC7095].¶
An example of the redacted field "fn" jCard property using the Redaction by Empty Value Method:¶
[
"fn",
{},
"text",
""
]
¶
An example of the "redacted" member for the redacted "fn" jCard property value, which is array position 3:¶
"redacted": [
{
"name": {
"type": "Registrant Name"
},
"path": "$.entities[?(@.roles[0]=='registrant')].
vcardArray[1][?(@[0]=='fn')][3]",
"pathLang": "jsonpath",
"method": "emptyValue",
"reason": {
"type": "Server policy"
}
}
]
¶
RDAP responses that contain values described in this document MUST indicate conformance with this specification by including an rdapConformance ([RFC7483]) value of "redacted_0.1". The information needed to register this value in the RDAP Extensions Registry is described in Section 6.1.¶
Example rdapConformance member with the redacted extension:¶
"rdapConformance": [ "rdap_level_0", "redacted_0" ]¶
The "redacted" member MUST be added to the RDAP response when there are redacted fields. The "redacted" member is included as a member of the object class in a lookup response, such as the object classes defined in [RFC9083], and as a member of the object instances in a search response, such as the object instances defined in [RFC9083]. The "redacted" member contains an array of redacted objects with the following child members:¶
Example unredacted version of an RDAP lookup response:¶
{
"rdapConformance": [
"rdap_level_0"
],
"objectClassName": "domain",
"handle": "ABC123",
"ldhName": "example.com",
"secureDNS": {
"delegationSigned": false
},
"nameservers": [
{
"objectClassName": "nameserver",
"ldhName": "ns1.example.com"
},
{
"objectClassName": "nameserver",
"ldhName": "ns2.example.com"
}
],
"entities": [
{
"objectClassName": "entity",
"handle": "123",
"roles": [
"registrar"
],
"publicIds": [
{
"type": "IANA Registrar ID",
"identifier": "1"
}
],
"vcardArray": [
"vcard",
[
[
"version",
{},
"text",
"4.0"
],
[
"fn",
{},
"text",
"Example Registrar Inc."
],
[
"adr",
{},
"text",
[
"",
"Suite 100",
"123 Example Dr.",
"Dulles",
"VA",
"20166-6503",
"US"
]
],
[
"email",
{},
"text",
"contact@organization.example"
],
[
"tel",
{
"type": "voice"
},
"uri",
"tel:+1.7035555555;ext=1234"
],
[
"tel",
{
"type": "fax"
},
"uri",
"tel:+1.7035555556"
]
]
],
"entities": [
{
"objectClassName": "entity",
"roles": [
"abuse"
],
"vcardArray": [
"vcard",
[
[
"version",
{},
"text",
"4.0"
],
[
"fn",
{},
"text",
"Abuse Contact"
],
[
"email",
{},
"text",
"abuse@organization.example"
],
[
"tel",
{
"type": "voice"
},
"uri",
"tel:+1.7035555555;ext=1234"
]
]
]
}
]
},
{
"roles": [
"registrant"
],
"vcardArray": [
"vcard",
[
[
"version",
{},
"text",
"4.0"
],
[
"fn",
{},
"text",
"Registrant User"
],
[
"org",
{},
"text",
"Example Inc."
],
[
"adr",
{},
"text",
[
"",
"Suite 1235",
"4321 Rue Somewhere",
"Quebec",
"QC",
"G1V 2M2",
"Canada"
]
],
[
"email",
{},
"text",
"registrant.user@example.com"
],
[
"tel",
{
"type": "voice"
},
"uri",
"tel:+1-555-555-1235;ext=123"
],
[
"tel",
{
"type": "fax"
},
"uri",
"tel:+1-555-555-5321"
]
]
]
},
{
"roles": [
"technical"
],
"vcardArray": [
"vcard",
[
[
"version",
{},
"text",
"4.0"
],
[
"fn",
{},
"text",
"Technical User"
],
[
"org",
{},
"text",
"Example Inc."
],
[
"adr",
{},
"text",
[
"",
"Suite 1234",
"4321 Rue Somewhere",
"Quebec",
"QC",
"G1V 2M2",
"Canada"
]
],
[
"email",
{},
"text",
"technical.user@example.com"
],
[
"tel",
{
"type": "voice"
},
"uri",
"tel:+1-555-555-1234;ext=321"
],
[
"tel",
{
"type": "fax"
},
"uri",
"tel:+1-555-555-4321"
]
]
]
},
{
"roles": [
"administrative"
],
"vcardArray": [
"vcard",
[
[
"version",
{},
"text",
"4.0"
],
[
"fn",
{},
"text",
"Administrative User"
],
[
"org",
{},
"text",
"Example Inc."
],
[
"adr",
{},
"text",
[
"",
"Suite 1236",
"4321 Rue Somewhere",
"Quebec",
"QC",
"G1V 2M2",
"Canada"
]
],
[
"email",
{},
"text",
"administrative.user@example.com"
],
[
"tel",
{
"type": "voice"
},
"uri",
"tel:+1-555-555-1236;ext=789"
],
[
"tel",
{
"type": "fax"
},
"uri",
"tel:+1-555-555-6321"
]
]
]
}
],
"events": [
{
"eventAction": "registration",
"eventDate": "1997-06-03T00:00:00Z"
},
{
"eventAction": "last changed",
"eventDate": "2020-05-28T01:35:00Z"
},
{
"eventAction": "expiration",
"eventDate": "2021-06-03T04:00:00Z"
}
],
"status": [
"server delete prohibited",
"server update prohibited",
"server transfer prohibited",
"client transfer prohibited"
]
}
¶
Example redacted version of an RDAP lookup response:¶
{
"rdapConformance": [
"rdap_level_0",
"redacted_0"
],
"objectClassName": "domain",
"ldhName": "example.com",
"secureDNS": {
"delegationSigned": false
},
"nameservers": [
{
"objectClassName": "nameserver",
"ldhName": "ns1.example.com"
},
{
"objectClassName": "nameserver",
"ldhName": "ns2.example.com"
}
],
"entities": [
{
"objectClassName": "entity",
"handle": "123",
"roles": [
"registrar"
],
"publicIds": [
{
"type": "IANA Registrar ID",
"identifier": "1"
}
],
"vcardArray": [
"vcard",
[
[
"version",
{},
"text",
"4.0"
],
[
"fn",
{},
"text",
"Example Registrar Inc."
],
[
"adr",
{},
"text",
[
"",
"Suite 100",
"123 Example Dr.",
"Dulles",
"VA",
"20166-6503",
"US"
]
],
[
"email",
{},
"text",
"contact@organization.example"
],
[
"tel",
{
"type": "voice"
},
"uri",
"tel:+1.7035555555"
],
[
"tel",
{
"type": "fax"
},
"uri",
"tel:+1.7035555556"
]
]
],
"entities": [
{
"objectClassName": "entity",
"roles": [
"abuse"
],
"vcardArray": [
"vcard",
[
[
"version",
{},
"text",
"4.0"
],
[
"fn",
{},
"text",
"Abuse Contact"
],
[
"email",
{},
"text",
"abuse@organization.example"
],
[
"tel",
{
"type": "voice"
},
"uri",
"tel:+1.7035555555"
]
]
]
}
]
},
{
"roles": [
"registrant"
],
"vcardArray": [
"vcard",
[
[
"version",
{},
"text",
"4.0"
],
[
"fn",
{},
"text",
""
],
[
"adr",
{},
"text",
[
"",
"",
"",
"",
"QC",
"",
"Canada"
]
]
]
]
},
{
"roles": [
"technical"
],
"vcardArray": [
"vcard",
[
[
"version",
{},
"text",
"4.0"
],
[
"fn",
{},
"text",
""
],
[
"org",
{},
"text",
"Example Inc."
],
[
"adr",
{},
"text",
[
"",
"Suite 1234",
"4321 Rue Somewhere",
"Quebec",
"QC",
"G1V 2M2",
"Canada"
]
]
]
]
}
],
"events": [
{
"eventAction": "registration",
"eventDate": "1997-06-03T00:00:00Z"
},
{
"eventAction": "last changed",
"eventDate": "2020-05-28T01:35:00Z"
},
{
"eventAction": "expiration",
"eventDate": "2021-06-03T04:00:00Z"
}
],
"status": [
"server delete prohibited",
"server update prohibited",
"server transfer prohibited",
"client transfer prohibited"
],
"redacted": [
{
"name": {
"type": "Registry Domain ID"
},
"path": "$.handle",
"pathLang": "jsonpath",
"method": "removal",
"reason": {
"type": "Server policy"
}
},
{
"name": {
"type": "Registrant Name"
},
"path": "$.entities[?(@.roles[0]=='registrant')].
vcardArray[1][?(@[0]=='fn')][3]",
"pathLang": "jsonpath",
"method": "emptyValue",
"reason": {
"type": "Server policy"
}
},
{
"name": {
"type": "Registrant Organization"
},
"path": "$.entities[?(@.roles[0]=='registrant')].
vcardArray[1][?(@[0]=='org')]",
"pathLang": "jsonpath",
"method": "removal",
"reason": {
"type": "Server policy"
}
},
{
"name": {
"type": "Registrant Street"
},
"path": "$.entities[?(@.roles[0]=='registrant')].
vcardArray[1][?(@[0]=='adr')][3][:3]",
"pathLang": "jsonpath",
"method": "emptyValue",
"reason": {
"type": "Server policy"
}
},
{
"name": {
"type": "Registrant City"
},
"path": "$.entities[?(@.roles[0]=='registrant')].
vcardArray[1][?(@[0]=='adr')][3][3]",
"pathLang": "jsonpath",
"method": "emptyValue",
"reason": {
"type": "Server policy"
}
},
{
"name": {
"type": "Registrant Postal Code"
},
"path": "$.entities[?(@.roles[0]=='registrant')].
vcardArray[1][?(@[0]=='adr')][3][5]",
"pathLang": "jsonpath",
"method": "emptyValue",
"reason": {
"type": "Server policy"
}
},
{
"name": {
"type": "Registrant Email"
},
"path": "$.entities[?(@.roles[0]=='registrant')].
vcardArray[1][?(@[0]=='email')]",
"method": "removal",
"reason": {
"type": "Server policy"
}
},
{
"name": {
"type": "Registrant Phone"
},
"path": "$.entities[?(@.roles[0]=='registrant')].
vcardArray[1][?(@[1].type=='voice')]",
"method": "removal",
"reason": {
"type": "Server policy"
}
},
{
"name": {
"type": "Technical Name"
},
"path": "$.entities[?(@.roles[0]=='technical')].
vcardArray[1][?(@[0]=='fn')][3]",
"method": "emptyValue",
"reason": {
"type": "Server policy"
}
},
{
"name": {
"type": "Technical Email"
},
"path": "$.entities[?(@.roles[0]=='technical')].
vcardArray[1][?(@[0]=='email')]",
"method": "removal",
"reason": {
"type": "Server policy"
}
},
{
"name": {
"type": "Technical Phone"
},
"path": "$.entities[?(@.roles[0]=='technical')].
vcardArray[1][?(@[1].type=='voice')]",
"method": "removal",
"reason": {
"type": "Server policy"
}
},
{
"name": {
"description": "Technical Fax"
},
"path": "$.entities[?(@.roles[0]=='technical')].
vcardArray[1][?(@[1].type=='fax')]",
"reason": {
"type": "Client request",
"description": "Client requested the field redacted"
}
},
{
"name": {
"type": "Administrative Contact"
},
"path": "$.entities[?(@.roles[0]=='administrative')]",
"method": "removal",
"reason": {
"description": "Refer to the technical contact"
}
}
]
}
¶
Example unredacted version of an RDAP search response:¶
{
"rdapConformance": [
"rdap_level_0"
],
"domainSearchResults":[
{
"objectClassName": "domain",
"handle": "ABC121",
"ldhName": "example1.com",
"links":[
{
"value":"https://example.com/rdap/domain/example1.com",
"rel":"self",
"href":"https://example.com/rdap/domain/example1.com",
"type":"application/rdap+json"
},
{
"value":"https://example.com/rdap/domain/example1.com",
"rel":"related",
"href":"https://example.com/rdap/domain/example1.com",
"type":"application/rdap+json"
}
]
},
{
"objectClassName": "domain",
"handle": "ABC122",
"ldhName": "example2.com",
"links":[
{
"value":"https://example.com/rdap/domain/example2.com",
"rel":"self",
"href":"https://example.com/rdap/domain/example2.com",
"type":"application/rdap+json"
},
{
"value":"https://example.com/rdap/domain/example2.com",
"rel":"related",
"href":"https://example.com/rdap/domain/example2.com",
"type":"application/rdap+json"
}
]
}
]
}
¶
Example redacted version of an RDAP search response:¶
{
"rdapConformance": [
"rdap_level_0",
"redacted_0"
],
"domainSearchResults":[
{
"objectClassName": "domain",
"ldhName": "example1.com",
"links":[
{
"value":"https://example.com/rdap/domain/example1.com",
"rel":"self",
"href":"https://example.com/rdap/domain/example1.com",
"type":"application/rdap+json"
},
{
"value":"https://example.com/rdap/domain/example1.com",
"rel":"related",
"href":"https://example.com/rdap/domain/example1.com",
"type":"application/rdap+json"
}
],
"redacted": [
{
"name": {
"type": "Registry Domain ID"
},
"path": "$.domainSearchResults[0].handle",
"pathLang": "jsonpath",
"method": "removal",
"reason": {
"type": "Server policy"
}
}
]
},
{
"objectClassName": "domain",
"ldhName": "example2.com",
"links":[
{
"value":"https://example.com/rdap/domain/example2.com",
"rel":"self",
"href":"https://example.com/rdap/domain/example2.com",
"type":"application/rdap+json"
},
{
"value":"https://example.com/rdap/domain/example2.com",
"rel":"related",
"href":"https://example.com/rdap/domain/example2.com",
"type":"application/rdap+json"
}
],
"redacted": [
{
"name": {
"type": "Registry Domain ID"
},
"path": "$.domainSearchResults[1].handle",
"pathLang": "jsonpath",
"method": "removal",
"reason": {
"type": "Server policy"
}
}
]
}
]
}
¶
JSONPath [I-D.ietf-jsonpath-base] is the default JSON path expression language. This section covers considerations for servers using [I-D.ietf-jsonpath-base] to identify redacted RDAP fields with the "path" member of redacted objects in the "redacted" member. The list of JSONPath considerations include:¶
IANA is requested to register the following value in the RDAP Extensions Registry:¶
Section 10.2 of [RFC9083] defines the JSON Values Registry with pre-defined Type field values and the use of the "Expert Review" policy defined in [RFC8126]. Two new JSON Values Registry Type field values are used to register pre-defined redacted name and reason values:¶
The server including a redacted signal provides an unauthorized client additional information related to the existence of data. Servers MAY exclude the redacted members for RDAP fields that are considered a privacy issue in providing a data existence signal.¶
The authors wish to thank the following persons for their feedback and suggestions: Marc Blanchet, Scott Hollenbeck, Mario Loffredo, Gustavo Lozano, and Rick Wilhelm.¶
Updates based on the Gustavo Lozano feedback:¶
Updates based on the Marc Blanchet feedback:¶
Updates based on the Mario Loffredo feedback:¶
Updates to add support for RDAP search responses:¶