<?xml version='1.0'encoding='utf-8'?> <?xml-stylesheet type="text/xsl" href="rfc2629.xslt"?> <!DOCTYPE rfc SYSTEM "rfc2629-xhtml.ent" [encoding='UTF-8'?> <!--One method to get references fromFYI: We note that this XML file was submitted in "prepped" format. We have "unprepped" theonline citation libraries. There hasfile tobe one entity for each itemmake editing the document easier. Note that this does not impact the document text but does cause many changes tobe referenced. An alternate method (rfc include) is described inthereferences.XML code. --> <!DOCTYPE rfc [ <!ENTITYRFC2119 SYSTEM "https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml"> <!ENTITY RFC6350 SYSTEM "https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.6350.xml"> <!ENTITY RFC7095 SYSTEM "https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.7095.xml"> <!ENTITY RFC7942 SYSTEM "https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.7942.xml"> <!ENTITY RFC8126 SYSTEM "https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.8126.xml"> <!ENTITY RFC8174 SYSTEM "https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.8174.xml"> <!ENTITY RFC8259 SYSTEM "https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.8259.xml"> <!ENTITY RFC8605 SYSTEM "https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.8605.xml"> <!ENTITY RFC9082 SYSTEM "https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.9082.xml">nbsp " "> <!ENTITYRFC9083 SYSTEM "https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.9083.xml">zwsp "​"> <!ENTITYI-D.ietf-regext-rdap-jscontact PUBLIC '' 'https://xml2rfc.tools.ietf.org/public/rfc/bibxml3/reference.I-D.ietf-regext-rdap-jscontact.xml'>nbhy "‑"> <!ENTITYI-D.ietf-jsonpath-base PUBLIC '' 'https://xml2rfc.tools.ietf.org/public/rfc/bibxml3/reference.I-D.ietf-jsonpath-base.xml'>wj "⁠"> ]><?rfc toc="yes"?> <?rfc tocompact="yes"?> <?rfc tocdepth="4"?> <?rfc compact="yes"?> <?rfc subcompact="no"?> <?rfc sortrefs="yes"?> <?rfc symrefs="yes"?> <?rfc iprnotified="no"?><rfc xmlns:xi="http://www.w3.org/2001/XInclude" category="std" consensus="true" docName="draft-ietf-regext-rdap-redacted-16" number="9537" ipr="trust200902" obsoletes="" updates="" submissionType="IETF" xml:lang="en" tocInclude="true" tocDepth="4" sortRefs="true" symRefs="true" version="3"> <front> <title abbrev="Redacted Fields in RDAP">Redacted Fields in the Registration Data Access Protocol (RDAP) Response</title> <seriesInfoname="Internet-Draft" value="draft-ietf-regext-rdap-redacted-16"/>name="RFC" value="9537"/> <author fullname="James Gould"initials="J.G"initials="J." surname="Gould"> <organization>VeriSign, Inc.</organization> <address> <postal> <street>12061 Bluemont Way</street> <city>Reston</city> <region>VA</region> <code>20190</code><country>US</country><country>United States of America</country> </postal> <email>jgould@verisign.com</email> <uri>http://www.verisigninc.com</uri> </address> </author> <author fullname="David Smith"initials="D.S"initials="D." surname="Smith"> <organization>VeriSign, Inc.</organization> <address> <postal> <street>12061 Bluemont Way</street> <city>Reston</city> <region>VA</region> <code>20190</code><country>US</country><country>United States of America</country> </postal> <email>dsmith@verisign.com</email> <uri>http://www.verisigninc.com</uri> </address> </author> <author fullname="Jody Kolker"initials="J.K"initials="J." surname="Kolker"> <organization>GoDaddy Inc.</organization> <address> <postal> <street>14455 N. HaydenRd.Rd., #219</street> <city>Scottsdale</city> <region>AZ</region> <code>85260</code><country>US</country><country>United States of America</country> </postal> <email>jkolker@godaddy.com</email> <uri>http://www.godaddy.com</uri> </address> </author> <author fullname="Roger Carney"initials="R.C"initials="R." surname="Carney"> <organization>GoDaddy Inc.</organization> <address> <postal> <street>14455 N. HaydenRd.Rd., #219</street> <city>Scottsdale</city> <region>AZ</region> <code>85260</code><country>US</country><country>United States of America</country> </postal> <email>rcarney@godaddy.com</email> <uri>http://www.godaddy.com</uri> </address> </author> <date year="2024" month="March"/> <area>art</area> <workgroup>regext</workgroup> <keyword>Redacted</keyword> <keyword>Redaction</keyword> <keyword>Redacting</keyword> <keyword>JSONPath</keyword> <abstract> <t>This document describesan RDAPa Registration Data Access Protocol (RDAP) extension for specifying methods of redaction of RDAP responses and explicitly identifying redacted RDAP response fields, using JSONPath as the default expression language.</t> </abstract> </front> <middle><section numbered="true" toc="default"><section> <name>Introduction</name> <t>This document describes an RDAP extension for specifying methods of redaction of RDAP responses and explicitly identifying redacted RDAP response fields, using JSONPath as the default expression language. A redacted RDAP field is one that has data removed or replaced in the RDAP response due to server policy, such as 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 <xreftarget="RFC9083" format="default"/>,target="RFC9083"/>, or RDAP fields defined in RDAP extensions. Because an RDAP response may exclude a field due to either the lack of data orbased onthe 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 andpossibleother possible reasons for data or field absence.</t> <t>In <xreftarget="RFC9082" format="default"/>target="RFC9082"/>, 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.</t> <t>JSONPath, as defined in <xreftarget="I-D.ietf-jsonpath-base" format="default"/>,target="RFC9535"/>, is used as the default expression language to reference RDAP fields that have been redacted. The redacted JSON fields willeitherbe removed, have empty values, have partial values, or be replaced in the RDAP response. JSON is defined by <xreftarget="RFC8259" format="default"/>.</t>target="RFC8259"/>.</t> </section><section numbered="true" toc="default"><section> <name>Conventions Used in This Document</name><t>The<t> The key words"MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY","<bcp14>MUST</bcp14>", "<bcp14>MUST NOT</bcp14>", "<bcp14>REQUIRED</bcp14>", "<bcp14>SHALL</bcp14>", "<bcp14>SHALL NOT</bcp14>", "<bcp14>SHOULD</bcp14>", "<bcp14>SHOULD NOT</bcp14>", "<bcp14>RECOMMENDED</bcp14>", "<bcp14>NOT RECOMMENDED</bcp14>", "<bcp14>MAY</bcp14>", and"OPTIONAL""<bcp14>OPTIONAL</bcp14>" in this document are to be interpreted as described inBCP 14BCP 14 <xreftarget="RFC2119" format="default"/>target="RFC2119"/> <xreftarget="RFC8174" format="default"/>target="RFC8174"/> when, and only when, they appear in all capitals, as shownhere.</t>here. </t> <t>The JSON examples include extra line breaks and whitespace. For instance, the JSONPath expressions are broken out into multiple lines when required for illustration.</t><t>The<!--[rfced] To clarify the second half of the sentence below, may we update it as follows? Original: The JSONPath expressions in the examples are for illustration purposes with single-role entities and the exact expressions to use by the server isout-of-scope.</t>out-of-scope. Perhaps: The JSONPath expressions in the examples are for illustration purposes with single-role entities, and the exact expressions to be used by the server are out of scope. --> <t>The JSONPath expressions in the examples are for illustration purposes with single-role entities, and the exact expressions to use by the server is out of scope.</t> </section> <sectionanchor="redaction-methods" numbered="true" toc="default">anchor="redaction-methods"> <name>Redaction Methods</name> <t>Redaction in RDAP can be handled in multiple ways.Redaction in RDAP can be handled in multiple ways.The resulting redacted RDAP responseMUST<bcp14>MUST</bcp14> comply with the format defined in the RDAPRFCs with the RDAPRFCs, such as <xreftarget="RFC9083" format="default"/>target="RFC9083"/> and updates. The use of placeholder text for the values of the RDAP fields, such asthe placeholder text"XXXX",MUST NOT<bcp14>MUST NOT</bcp14> be used for redaction, since the placeholder text value may not match the format requirements of each of the RDAPfields and providesfields, which could provide an inconsistent and unreliable redaction signal. This section covers the redaction methods that can be used with the redaction signaling defined in <xreftarget="redacted-member" format="default"/>.</t>target="redacted-member"/>.</t> <t>RDAP responses, as defined in <xreftarget="RFC9083" format="default"/>,target="RFC9083"/>, include a mix of JSON objects and JSON arrays, where JSON arrays are heavily used for entity objects with <xreftarget="RFC7095" format="default">jCard</xref>.target="RFC7095">jCard</xref>. <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> is a JSON representation of <xreftarget="RFC6350" format="default">vCard</xref>target="RFC6350">vCard</xref> that inherits its dependency on arrays. <!--[rfced] May we reorder the references in this sentence for easier readability as shown below? Original: An example is the<xref target="RFC6350" format="default">vCard</xref>vCard [RFC6350] "ADR" property /<xref target="RFC7095" format="default">jCard</xref>jCard [RFC7095] "adr" property that defines a sequence of address components. Perhaps: An example is the vCard "ADR" property [RFC6350], or the jCard "adr" property [RFC7095], which defines a sequence of address components. --> An example is the <xref target="RFC6350">vCard</xref> "ADR" property / <xref target="RFC7095">jCard</xref> "adr" property, which defines a sequence of address components. According to <xreftarget="RFC6350" format="default"/>,target="RFC6350"/>, when an "ADR" property component value is missing, the associated component separatorMUST<bcp14>MUST</bcp14> still be specified. <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> 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.</t> <t>The redaction of RDAP fields fall into the four categories defined in the followingsub-sections.</t>subsections.</t> <sectionanchor="redaction-removal" numbered="true" toc="default">anchor="redaction-removal"> <name>Redaction by Removal Method</name> <t>The Redaction by Removal Method is when the RDAP field is removed from the RDAP response, which is the default method. The Redaction by Removal Method can be done for all RDAP response fieldsother thanexcept for response fields using the position in an array to signal the redacted field (e.g., the JSON arrays used with <xreftarget="RFC7095" format="default">jCard</xref>).target="RFC7095">jCard</xref>). RDAPextensionsextensions, such as the one described in <xreftarget="I-D.ietf-regext-rdap-jscontact" format="default">JSContacttarget="I-D.ietf-regext-rdap-jscontact">"Using JSContact in Registration Data Access Protocol (RDAP) JSONResponses</xref>Responses"</xref>, do not have a dependency on the use of positional JSON arrays and are therefore suited for the Redaction by Removal Method.</t> <t>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 <xreftarget="redacted-member" format="default"/>.</t>target="redacted-member"/>.</t> <t>An example of redacting an RDAP object is removing the administrative contact from the RDAP response and including the following "redacted" member:</t> <figureanchor="redacted-admin-contact" align="left" suppress-title="false" pn="figure-1">anchor="redacted-admin-contact"> <name>Redacted Administrative Contact</name> <sourcecodetype="json" markers="false">type="json"> "redacted": [ { "name": { "description": "Administrative Contact" }, "prePath": "$.entities[?(@.roles[0]=='administrative')]", "method": "removal" } ] </sourcecode> </figure> <t>The Redaction by Removal MethodMUST NOT<bcp14>MUST NOT</bcp14> be used to remove an element of an array where the position of the element in the array determines semantic meaning. <!--[rfced] Since "RFC 7095" is referenced for "jCard" in Section 3, is it necessary to reference "RFC 7095" each time "jCard" is used thereafter as it affects readability when there are multiple references within one sentence or in close proximity. Please let us know if "[RFC7095]" (from instances of "jCard [RFC7095]") may be removed after the first mention in Section 3. If that is not desired, may we update the sentences that contain multiple mentions to include only one mention as shown below? Please let us know your preference. Some examples: Original: The empty jCard [RFC7095] values ("" or null) are referenced in the "redacted" member in place of the jCard [RFC7095] property name in a array, such as referencing the "fn" jCard [RFC7095] property value at position 3 instead of referencing the "fn" jCard property name at position 0. Perhaps: The empty jCard [RFC7095] values ("" or null) are referenced in the "redacted" member in place of the jCard property name in an array, such as referencing the "fn" jCard property value at position 3 instead of referencing the "fn" jCard property name at position 0. ... Original: For example, removal of an individual data field in jCard [RFC7095] will result in a non-conformant jCard [RFC7095] array definition. Perhaps: For example, removal of an individual data field in jCard will result in a non-conformant jCard array definition [RFC7095]. ... Original: Reference index 0 of the jCard [RFC7095] property array, which is the jCard [RFC7095] "name" property, with a filter expression containing the name of the field, when redacting a jCard [RFC7095] field using the Redaction by Removal Method (Section 3.1). Perhaps: Reference index 0 of the jCard [RFC7095] property array, which is the jCard "name" property, with a filter expression containing the name of the field, when redacting a jCard field using the Redaction by Removal Method (Section 3.1). --> For example, removal of an individual data field in <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> will result in a non-conformant <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> array definition.</t> </section> <sectionanchor="redaction-empty-value" numbered="true" toc="default">anchor="redaction-empty-value"> <name>Redaction by Empty Value Method</name><t>The<!--[rfced] Per usage in RFC 7095 and throughout the document, may we make "Text" lowercase? Original: 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 a non-Text property. Perhaps: 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 a non-text property. --> <t>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 <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> Text ("text") property or null for a non-Text property. The empty <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> values ("" or null) are referenced in the "redacted" member in place of the <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> property name inaan array, such as referencing the "fn" <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> property value at position 3 instead of referencing the "fn" jCard property name at position 0. The Redaction by Empty Value MethodMUST<bcp14>MUST</bcp14> be used only when redacting JSON response fields that use the position in an array to signal the redacted field (e.g., <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> arrays). Optional <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> propertiesMUST<bcp14>MUST</bcp14> use the <xreftarget="redaction-removal" format="default">Redactiontarget="redaction-removal">Redaction by Removal Method</xref> to redact the entire property. The required <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> "fn" property, defined insection 6.2.1 of<xref target="RFC6350"format="default">vCard</xref>, MUSTsection="6.2.1" sectionFormat="of">vCard</xref>, <bcp14>MUST</bcp14> use the Redaction by Empty Value Method to redact the property value. Removing the "fn" property would violate <xreftarget="RFC6350" format="default">vCard</xref>target="RFC6350">vCard</xref>, and removing the property value would violate the fixed array positions defined in <xreftarget="RFC7095" format="default">jCard</xref>.</t>target="RFC7095">jCard</xref>.</t> <t>An example of the redacted "fn" jCard property using the Redaction by Empty Value Method:</t> <!--[rfced] We note that Figures 2, 6, 7, 8, 9, and 10 include introductory text that repeats the information stated in their titles. To avoid redundancy, may we remove the introductory text for the figures listed? --> <figureanchor="redacted-fn-empty-value" align="left" suppress-title="false" pn="figure-2">anchor="redacted-fn-empty-value"> <name>Redacted "fn" jCardproperty usingProperty Using the Redaction by Empty Value Method</name> <sourcecodetype="json" markers="false">type="json"> [ "fn", {}, "text", "" ] </sourcecode> </figure> <t>An example of the "redacted" member for the redacted "fn" jCard property value, which is array position 3:</t> <figureanchor="redacted-fn-array-pos" align="left" suppress-title="false" pn="figure-3">anchor="redacted-fn-array-pos"> <name>Redacted Registrant NameusingUsing an Array Position</name> <sourcecodetype="json" markers="false">type="json"> "redacted": [ { "name": { "description": "Registrant Name" }, "postPath": "$.entities[?(@.roles[0]=='registrant')]. vcardArray[1][?(@[0]=='fn')][3]", "pathLang": "jsonpath", "method": "emptyValue", "reason": { "description": "Server policy" } } ] </sourcecode> </figure> </section> <sectionanchor="redaction-partial-value" numbered="true" toc="default">anchor="redaction-partial-value"> <name>Redaction by Partial Value Method</name> <t>The Redaction by Partial Value Method is when a redacted field is notremoved,removed but its value has a portion of the data removed, such as for the "label" or "fn" <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> properties. The partial values are referenced in the "redacted" member in place of the property name inaan array, such as referencing the "fn" <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> property value at position 3 instead of referencing the "fn" jCard property name at position 0. The Redaction by Partial Value MethodSHOULD<bcp14>SHOULD</bcp14> be used only when redacting JSON response fields that use a formatted value, where a portion of the value is removed. </t> <!--[rfced] As RFC 7095 does not have its figures numbered, may we update "Figure 15" to be "Section 3.3.1.3" instead? Original: An example of the "label" jCard property in Figure 15 of [RFC7095] that redacts "123 Maple Ave\nSuite 901\n": ... An example of the "redacted" member for the redacted "label" jCard property value, based on Figure 15 of [RFC7095]: Perhaps: An example of the "label" jCard property in Section 3.3.1.3 of [RFC7095] that redacts "123 Maple Ave\nSuite 901\n": ... An example of the "redacted" member for the redacted "label" jCard property value, based on Section 3.3.1.3 of [RFC7095]: --> <t>An example of the "label" jCard property in Figure 15 of <xreftarget="RFC7095" format="default"/>target="RFC7095"/> that redacts "123 Maple Ave\nSuite 901\n":</t> <figureanchor="redacted-home-address-label-value" align="left" suppress-title="false" pn="figure-4">anchor="redacted-home-address-label-value"> <name>Redacted "label" jCardproperty</name>Property</name> <sourcecodetype="json" markers="false">type="json"> ["adr", { "type":"home", "label":"Vancouver\nBC\n1239\n" }, "text", [ "", "", "", "", "", "", "" ] ] </sourcecode> </figure> <t>An example of the "redacted" member for the redacted "label" jCard property value, based on Figure 15 of <xreftarget="RFC7095" format="default"/>:</t>target="RFC7095"/>:</t> <figureanchor="redacted-home-address-label" align="left" suppress-title="false" pn="figure-5">anchor="redacted-home-address-label"> <name>Redacted LabelusingUsing the Redaction by Partial Value Method</name> <sourcecodetype="json" markers="false">type="json"> "redacted": [ { "name": { "description": "Home Address Label" }, "postPath": "$.vcardArray[1][?(@[0]=='adr')][1].label", "pathLang": "jsonpath", "method": "partialValue", "reason": { "description": "Server policy" } } ] </sourcecode> </figure> </section> <sectionanchor="redaction-replacement-value" numbered="true" toc="default">anchor="redaction-replacement-value"> <name>Redaction by Replacement Value Method</name> <t>The Redaction by Replacement Value Method is when a redacted field is notremoved,removed but its value is replaced with a different value, such as protecting the "email" <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> property value with an anonymized email "text" value or the use of an alternative "uri" value to a web form. Replacing a property value is a form of redaction, since it protects the true property value for privacy reasons.</t> <t>An example of the redacted "email" jCard property using the Redaction by Replacement Value Method with an anonymized email:</t> <figureanchor="redacted-email-anonymized-value" align="left" suppress-title="false" pn="figure-6">anchor="redacted-email-anonymized-value"> <name>Redacted "email" jCardproperty usingProperty Using the Redaction by Replacement Value Method with ananonymized email</name>Anonymized Email</name> <sourcecodetype="json" markers="false">type="json"> [ "email", {}, "text", "anonymized123@example.com" ] </sourcecode> </figure> <t>An example of the "redacted" member for the redacted registrant "email" jCard property value with an anonymized "text"value.</t>value:</t> <figureanchor="redacted-email-replacement-anonymized" align="left" suppress-title="false" pn="figure-7">anchor="redacted-email-replacement-anonymized"> <name>Redacted EmailusingUsing a Replacement Value with ananonymizedAnonymized "text"value</name>Value</name> <sourcecodetype="json" markers="false">type="json"> "redacted": [ { "name": { "description": "Registrant Email" }, "postPath": "$.entities[?(@.roles[0]=='registrant')]. vcardArray[1][?(@[0]=='email')][3]", "pathLang": "jsonpath", "method": "replacementValue", } ] </sourcecode> </figure> <t>An example of the redacted "email" jCard property using the Redaction by Replacement Value Method with a<xref target="RFC8605" format="default"/>"contact-uri" <xref target="RFC8605"/> jCard property to a web form:</t> <figureanchor="redacted-email-links-related" align="left" suppress-title="false" pn="figure-8">anchor="redacted-email-links-related"> <name>Redacted "email" jCardproperty usingProperty Using the Redaction by Replacement Value Method with a "contact-uri" jCardpropertyProperty to aweb form</name>Web Form</name> <sourcecodetype="json" markers="false">type="json"> [ "contact-uri", {}, "uri", "https://email.example.com/123" ] </sourcecode> </figure> <t>An example of the "redacted" member for the redacted registrant "email" jCard property with a<xref target="RFC8605" format="default"/>"contact-uri" <xref target="RFC8605"/> jCard property to a web form:</t> <figureanchor="redacted-email-replacement-links-related" align="left" suppress-title="false" pn="figure-9">anchor="redacted-email-replacement-links-related"> <name>Redacted EmailusingUsing a Replacement Value with a "contact-uri" jCardpropertyProperty to aweb form</name>Web Form</name> <sourcecodetype="json" markers="false">type="json"> "redacted": [ { "name": { "description": "Registrant Email" }, "prePath": "$.entities[?(@.roles[0]=='registrant')]. vcardArray[1][?(@[0]=='email')]", "replacementPath": "$.entities[?(@.roles[0]=='registrant')]. vcardArray[1][?(@[0]=='contact-uri')]", "pathLang": "jsonpath", "method": "replacementValue", } ] </sourcecode> </figure> </section> </section> <sectionanchor="redacted-rdap-response" numbered="true" toc="default">anchor="redacted-rdap-response"> <name>Redacted RDAP Response</name> <sectionanchor="rdap-conformance" numbered="true" toc="default">anchor="rdap-conformance"> <name>RDAP Conformance</name> <t>RDAP responses that contain values described in this documentMUST<bcp14>MUST</bcp14> indicate conformance with this specification by including an"rdapConformance" (<xref target="RFC9083" format="default"/>)"rdapConformance" <xref target="RFC9083"/> value of"redacted"."redacted". The"redacted""redacted" extension identifier is described in <xreftarget="rdap-extensions-registry" format="default"/>.</t>target="rdap-extensions-registry"/>.</t> <t>Example"rdapConformance""rdapConformance" member with the redacted extension:</t> <figureanchor="rdapConformance-with-redacted" align="left" suppress-title="false" pn="figure-10"> <name>"rdapConformance"anchor="rdapConformance-with-redacted"> <name>"rdapConformance" with Redacted Extension</name> <sourcecodetype="json" markers="false">type="json"> "rdapConformance": [ "rdap_level_0", "redacted" ] </sourcecode> </figure> </section> <sectionanchor="redacted-member" numbered="true" toc="default"> <name>"redacted"anchor="redacted-member"> <name>"redacted" Member</name> <t>The"redacted""redacted" memberMUST<bcp14>MUST</bcp14> be added to the RDAP response when there is one or more redacted fields. The"redacted""redacted" member is included as a member of the object instance in a lookup response, such as the object classes defined in <xreftarget="RFC9083" format="default"/>,target="RFC9083"/>, and as a member of the object instances in a search response.</t> <t>Theserverserver, including a redactedsignalsignal, provides an unauthorized client additional information related to the existence of data andMAY<bcp14>MAY</bcp14> exclude the redacted members for RDAP fields that are considered a privacy issue in providing a data existence signal. The serverMAY<bcp14>MAY</bcp14> choose to publish a redaction policy describing how this extension is implemented for their constituency. The contents of such a policy are outside the scope of this specification.</t> <t>The"redacted""redacted" member contains an array of objects with the following child members:</t> <dlnewline="false" indent="4">indent="4" newline="false"> <dt>"name":</dt><dd>REQUIRED<dd><bcp14>REQUIRED</bcp14> logical name for the redacted field. The logical name used for the redacted field is up to server policy. The logical name is defined using an object with a "type" field denoting a registered redacted name (see <xreftarget="json-values-registry" format="default"/>)target="json-values-registry"/>) or a "description" field denoting an unregistered redacted name. The registered redacted names and the chosen unregistered names can meet the needs of different RDAP services or industries.</dd> <dt>"prePath":</dt><dd>OPTIONAL<dd><bcp14>OPTIONAL</bcp14> JSON path expression referencing a redacted JSON field in the pre-redacted response. The "prePath" memberMAY<bcp14>MAY</bcp14> be set when the redacted field does not exist in the redacted response for the <xref target="redaction-removal">RedactionByby Removal Method</xref> and the <xref target="redaction-replacement-value">Redaction by Replacement Value Method</xref>. The "prePath" memberMUST NOT<bcp14>MUST NOT</bcp14> be set when the "postPath" member is set. </dd> <dt>"postPath":</dt><dd>OPTIONAL<dd><bcp14>OPTIONAL</bcp14> JSON path expression referencing a redacted JSON field in the redacted (post-redacted) response. The "postPath" memberMUST<bcp14>MUST</bcp14> be set when the redacted field does exist in the redacted response for the <xref target="redaction-empty-value">Redaction by Empty Value Method</xref>, the <xref target="redaction-partial-value">Redaction by Partial Value Method</xref>, and the <xref target="redaction-replacement-value">Redaction by Replacement Value Method</xref>. The "postPath" memberMUST NOT<bcp14>MUST NOT</bcp14> be set when the "prePath" member is set. </dd> <dt>"replacementPath":</dt><dd>OPTIONAL<dd><bcp14>OPTIONAL</bcp14> JSON path expression of the replacement field of the redacted field with the <xref target="redaction-replacement-value">Redaction by Replacement Value Method</xref>, using the expression language defined by the "pathLang" member. </dd> <dt>"pathLang":</dt><dd>OPTIONAL<dd><bcp14>OPTIONAL</bcp14> JSON path expression language used, with the default value of "jsonpath" for JSONPath(<xref target="I-D.ietf-jsonpath-base" format="default"/>).<xref target="RFC9535"/>. Other JSON path expression languages registered with the "redacted expression language"RDAP JSON Values RegistryTypeMAYin the "RDAP JSON Values" registry <bcp14>MAY</bcp14> be used based on server policy.</dd> <dt>"method":</dt> <dd><t>OPTIONAL<t><bcp14>OPTIONAL</bcp14> redaction methodused;used, with one of the following values:</t> <ul> <li>"removal" indicating the <xref target="redaction-removal">RedactionByby Removal Method</xref>,</li> <li>"emptyValue" indicating the <xref target="redaction-empty-value">Redaction by Empty ValueMethod</xref>, or</li>Method</xref>,</li> <li>"partialValue" indicating the <xref target="redaction-partial-value">Redaction by Partial Value Method</xref>, or</li> <li>"replacementValue" indicating the <xref target="redaction-replacement-value">Redaction by Replacement ValueMethod.</xref></li>Method</xref>.</li> </ul> <t>The default value is "removal" when not provided.</t> </dd> <dt>"reason":</dt><dd>OPTIONAL human readable<dd><bcp14>OPTIONAL</bcp14> human-readable reason(s) for the redacted field in the language defined by the<xref target="RFC9083" format="default"/>"lang" <xref target="RFC9083"/> member. The default language is "en" if the<xref target="RFC9083" format="default"/>"lang" <xref target="RFC9083"/> member is not specified. The reason is defined using an object with anOPTIONAL<bcp14>OPTIONAL</bcp14> "type" field denoting a registered redacted reason (seesee<xreftarget="json-values-registry" format="default"/>)target="json-values-registry"/>) and anOPTIONAL<bcp14>OPTIONAL</bcp14> "description" field denoting an unregistered redacted reason. The "description" fieldMUST NOT<bcp14>MUST NOT</bcp14> be a client processing dependency.</dd> </dl> <t>Example of the unredacted version of an RDAP lookup response:</t> <figureanchor="unredacted-lookup-response" align="left" suppress-title="false" pn="figure-11">anchor="unredacted-lookup-response"> <name>Unredacted RDAP Lookup Response</name> <sourcecodetype="json" markers="false">type="json"> { "rdapConformance": [ "rdap_level_0" ], "objectClassName": "domain", "handle": "ABC123", "ldhName": "example.com", "secureDNS": { "delegationSigned": false }, "notices": [ { "title": "Terms of Use", "description": [ "Service subject to Terms of Use." ], "links": [ { "rel": "self", "href": "https://www.example.com/terms-of-use", "type": "text/html", "value": "https://www.example.com/terms-of-use" } ] } ], "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" ] ] ] } ] }, { "objectClassName": "entity", "handle": "XXXX", "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" ] ] ] }, { "objectClassName": "entity", "handle": "YYYY", "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" ] ] ] }, { "objectClassName": "entity", "handle": "ZZZZ", "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" ] ] ] }, { "objectClassName": "entity", "handle": "WWWW", "roles": [ "billing" ], "vcardArray": [ "vcard", [ [ "version", {}, "text", "4.0" ], [ "fn", {}, "text", "Billing User" ], [ "email", {}, "text", "billing.user@example.com" ] ] ] } ], "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" ] } </sourcecode> </figure> <t>Example of the redacted version of an RDAP lookup response:</t> <figureanchor="redacted-lookup-response" align="left" suppress-title="false" pn="figure-12">anchor="redacted-lookup-response"> <name>Redacted RDAP Lookup Response</name> <sourcecodetype="json" markers="false">type="json"> { "rdapConformance": [ "rdap_level_0", "redacted" ], "objectClassName": "domain", "ldhName": "example.com", "secureDNS": { "delegationSigned": false }, "notices": [ { "title": "Terms of Use", "description": [ "Service subject to Terms of Use." ], "links": [ { "rel": "self", "href": "https://www.example.com/terms-of-use", "type": "text/html", "value": "https://www.example.com/terms-of-use" } ] } ], "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" ] ] ] } ] }, { "objectClassName": "entity", "handle": "XXXX", "roles": [ "registrant" ], "vcardArray": [ "vcard", [ [ "version", {}, "text", "4.0" ], [ "fn", {}, "text", "" ], [ "adr", {}, "text", [ "", "", "", "", "QC", "", "Canada" ] ] ] ] }, { "objectClassName": "entity", "handle": "YYYY", "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": { "description": "Registry Domain ID" }, "prePath": "$.handle", "pathLang": "jsonpath", "method": "removal", "reason": { "description": "Server policy" } }, { "name": { "description": "Registrant Name" }, "postPath": "$.entities[?(@.roles[0]=='registrant')]. vcardArray[1][?(@[0]=='fn')][3]", "pathLang": "jsonpath", "method": "emptyValue", "reason": { "description": "Server policy" } }, { "name": { "description": "Registrant Organization" }, "prePath": "$.entities[?(@.roles[0]=='registrant')]. vcardArray[1][?(@[0]=='org')]", "pathLang": "jsonpath", "method": "removal", "reason": { "description": "Server policy" } }, { "name": { "description": "Registrant Street" }, "postPath": "$.entities[?(@.roles[0]=='registrant')]. vcardArray[1][?(@[0]=='adr')][3][:3]", "pathLang": "jsonpath", "method": "emptyValue", "reason": { "description": "Server policy" } }, { "name": { "description": "Registrant City" }, "postPath": "$.entities[?(@.roles[0]=='registrant')]. vcardArray[1][?(@[0]=='adr')][3][3]", "pathLang": "jsonpath", "method": "emptyValue", "reason": { "description": "Server policy" } }, { "name": { "description": "Registrant Postal Code" }, "postPath": "$.entities[?(@.roles[0]=='registrant')]. vcardArray[1][?(@[0]=='adr')][3][5]", "pathLang": "jsonpath", "method": "emptyValue", "reason": { "description": "Server policy" } }, { "name": { "description": "Registrant Email" }, "prePath": "$.entities[?(@.roles[0]=='registrant')]. vcardArray[1][?(@[0]=='email')]", "method": "removal", "reason": { "description": "Server policy" } }, { "name": { "description": "Registrant Phone" }, "prePath": "$.entities[?(@.roles[0]=='registrant')]. vcardArray[1][?(@[1].type=='voice')]", "method": "removal", "reason": { "description": "Server policy" } }, { "name": { "description": "Technical Name" }, "postPath": "$.entities[?(@.roles[0]=='technical')]. vcardArray[1][?(@[0]=='fn')][3]", "method": "emptyValue", "reason": { "description": "Server policy" } }, { "name": { "description": "Technical Email" }, "prePath": "$.entities[?(@.roles[0]=='technical')]. vcardArray[1][?(@[0]=='email')]", "method": "removal", "reason": { "description": "Server policy" } }, { "name": { "description": "Technical Phone" }, "prePath": "$.entities[?(@.roles[0]=='technical')]. vcardArray[1][?(@[1].type=='voice')]", "method": "removal", "reason": { "description": "Server policy" } }, { "name": { "description": "Technical Fax" }, "prePath": "$.entities[?(@.roles[0]=='technical')]. vcardArray[1][?(@[1].type=='fax')]", "reason": { "description": "Client request" } }, { "name": { "description": "Administrative Contact" }, "prePath": "$.entities[?(@.roles[0]=='administrative')]", "method": "removal", "reason": { "description": "Refer to the technical contact" } }, { "name": { "description": "Billing Contact" }, "prePath": "$.entities[?(@.roles[0]=='billing')]", "method": "removal", "reason": { "description": "Refer to the registrant contact" } } ] } </sourcecode> </figure> <t>Example of the unredacted version of an RDAP search response:</t> <figureanchor="unredacted-search-response" align="left" suppress-title="false" pn="figure-13">anchor="unredacted-search-response"> <name>Unredacted RDAP Search Response</name> <sourcecodetype="json" markers="false">type="json"> { "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" } ] } ] } </sourcecode> </figure> <t>Example of the redacted version of an RDAP search response:</t> <figureanchor="redacted-search-response" align="left" suppress-title="false" pn="figure-14">anchor="redacted-search-response"> <name>Redacted RDAP Search Response</name> <sourcecodetype="json" markers="false">type="json"> { "rdapConformance": [ "rdap_level_0", "redacted" ], "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" }, "prePath": "$.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": { "description": "Registry Domain ID" }, "prePath": "$.domainSearchResults[1].handle", "pathLang": "jsonpath", "method": "removal", "reason": { "description": "Server policy" } } ] } ] } </sourcecode> </figure> </section> </section> <sectionanchor="jsonpath-considerations" numbered="true" toc="default">anchor="jsonpath-considerations"> <name>JSONPath Considerations</name> <t><xreftarget="I-D.ietf-jsonpath-base" format="default">JSONPath</xref>target="RFC9535">JSONPath</xref> is the default JSON path expression language. This section includes JSONPath considerations for clients and servers.</t> <sectionanchor="jsonpath-client-considerations" numbered="true" toc="default">anchor="jsonpath-client-considerations"> <name>JSONPath Client Considerations</name> <t>This section covers considerations for clients that receive responses from servers using JSONPath <xreftarget="I-D.ietf-jsonpath-base" format="default"/>target="RFC9535"/> to identify redacted RDAP fields with the "prePath" or "postPath" member of redacted objects in the "redacted" member. The list of JSONPath client considerations include:</t> <olspacing="compact" type="1">spacing="compact"> <li>When the server is using the <xref target="redaction-removal">RedactionByby Removal Method</xref> or the <xref target="redaction-replacement-value">Redaction by Replacement Value Method</xref> with an alternative field value, the JSONPath expression of the "prePath" member will not resolve successfully with the redacted response. The client can key off the "name" member for display logic related to the redaction.</li> </ol> </section> <sectionanchor="jsonpath-server-considerations" numbered="true" toc="default">anchor="jsonpath-server-considerations"> <name>JSONPath Server Considerations</name> <t>This section covers considerations for servers using JSONPath <xreftarget="I-D.ietf-jsonpath-base" format="default"/>target="RFC9535"/> to identify redacted RDAP fields with the "prePath" or "postPath" member of redacted objects in the "redacted" member. The list of JSONPath considerations include:</t> <olspacing="compact" type="1">spacing="normal"> <li>Use absolute paths with the '$' JSONPath element. An example is "$.handle" for the "Registry Domain ID" in a lookup response or "$.domainSearchResults[0].handle" in a search response.</li> <li>Validate a JSONPath expression with the non-redacted RDAP response when using the "prePath" member, where evaluating the expression results in returning the redacted field.</li> <li>Reference the removed object field when redacting an entire object by the <xreftarget="redaction-removal" format="default">Redactiontarget="redaction-removal">Redaction by Removal Method</xref>, where all of the object's child fields are explicitly removed. An example is "$.entities[?(@.roles[0]=='administrative')]" for the entire "Administrative Contact".</li><li>It is possible for there to be<li>Use multiple bases for the redaction of certain content. For example, if server policy is such that all administrative-role entities are redacted and all technical-role entities are redacted, then an entity having both the administrative role and the technical role could be redacted for two different reasons. In this situation, a server is required to include at least one "redacted" entry, but it should consider including a separate "redacted" entry for each applicable basis forredaction, so asredaction to clearly document the server policies that are relevant to redaction in each instance.</li> <li>Reference the removed field when using the <xreftarget="redaction-removal" format="default">Redactiontarget="redaction-removal">Redaction by Removal Method</xref>. An example is "$.handle" for the "Registry Domain ID".</li> <li>Reference index 0 of the <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> property array, which is the <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> "name" property, with a filter expression containing the name of thefield,field when redacting a <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> field using the <xreftarget="redaction-removal" format="default">Redactiontarget="redaction-removal">Redaction by Removal Method</xref>. An example is "$.entities[?(@.roles[0]=='registrant')].vcardArray[1][?(@[0]=='email')]" for the "Registrant Email".</li> <li>Reference the <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> field value or values redacted by array index 3 andgreater,greater when redacting a <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> field using the <xreftarget="redaction-empty-value" format="default">Redactiontarget="redaction-empty-value">Redaction by Empty Value Method</xref>. The <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> property array index 3 and greater contain the property values, where the property values set with an empty value are referenced directly in place of the <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> property name. Servers can then systematically redact the <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> field value or values based on the JSONPathexpressionsexpressions, and clients will directly know which <xreftarget="RFC7095" format="default">jCard</xref>target="RFC7095">jCard</xref> property values have been redacted. An example is "$.entities[?(@.roles[0]=='registrant')].vcardArray[1][?(@[0]=='fn')][3]" for the "Registrant Name" or "$.entities[?(@.roles[0]=='registrant')].vcardArray[1][?(@[0]=='adr')][3][5]" for the "Registrant Postal Code".</li> <li>RDAP extensions should define any special JSONPath considerations required to identify redacted RDAP fields if these considerations are insufficient.</li> </ol> </section> </section> <sectionanchor="iana-considerations" numbered="true" toc="default">anchor="iana-considerations"> <name>IANA Considerations</name> <sectionanchor="rdap-extensions-registry" numbered="true" toc="default">anchor="rdap-extensions-registry"> <name>RDAP Extensions Registry</name> <t>IANAis requested to registerhas registered the following value in theRDAP Extensions Registry:</t>"RDAP Extensions" registry:</t> <!-- [rfced] We have included some specific questions about the IANA text below. In addition to responding to those questions, please review all of the IANA-related updates carefully and let us know if any further updates are needed. a) Section 6.1. In the "RDAP Extensions" registry under the "redacted" value, the Contact is listed as "IESG" in this document; however, it is listed as "IETF" in the IANA registry at "https://www.iana.org/assignments/rdap-extensions". For consistency, should this document be updated to reflect "IETF", or should the IANA registry be updated to reflect "IESG"? Current (Section 6.1): Contact: IESG <iesg@ietf.org> b) Section 6.2. In the "RDAP JSON Values" registry under the Description for "jsonpath", this document references "draft-ietf-jsonpath-base" ("RFC 9535") but IANA references this document (see "https://www.iana.org/assignments/ rdap-json-values/"). Please confirm which document should be listed, and we will update this specification or the IANA registry accordingly. Original (Section 6.2): Description: JSON path expression language, as defined in draft-ietf-jsonpath-base. --> <dlnewline="false" spacing="compact">spacing="normal"> <dt>Extensionidentifier:</dt>Identifier:</dt> <dd>redacted</dd> <dt>Registryoperator:</dt>Operator:</dt> <dd>Any</dd><dt>Published specification:</dt> <dd>This document.</dd><dt>Specification:</dt> <dd>RFC 9537</dd> <dt>Contact:</dt> <dd>IESG <iesg@ietf.org></dd> <dt>Intendedusage:</dt>Usage:</dt> <dd>This extension identifies the redacted fields in an RDAP response.</dd> </dl> </section> <sectionanchor="json-values-registry" numbered="true" toc="default">anchor="json-values-registry"> <name>RDAP JSON Values Registry</name><t>Section 10.2 of <xref<t><xref target="RFC9083"format="default"/>section="10.2" sectionFormat="of" /> defines theRDAP"RDAP JSONValues RegistryValues" registry withpre-definedpredefined Type field values andthe use of the "Expert Review"a registration policydefined inof Expert Review <xreftarget="RFC8126" format="default"/>.target="RFC8126"/>. This specification defines three newRDAP JSON Values RegistryType field values that can be used to registerpre-definedpredefined redacted name, reason, and expression language values. IANAis instructed to updatehas updated theRDAP"RDAP JSONValues RegistryValues" registry to accept these additionaltypeType field values as follows:</t> <dlnewline="false"indent="4"> <dt>"redacted name":</dt> <dd>Redacted name being registered. The registered redacted name is referenced using the "type" field of the redacted "name" field.</dd> <dt>"redacted reason":</dt> <dd>Redacted reason being registered. The registered redacted reason is referenced using the "type" field of the redacted "reason" field.</dd> <dt>"redacted expression language":</dt> <dd>Redacted expression language being registered. The registered redacted expression language is referenced using the "pathLang" field.</dd> </dl><t>The following values should be registered by the IANA in<t>IANA has also listed this document as a reference for theRDAP"RDAP JSONValues Registry described in <xref target="RFC9083"/>:</t>Values" registry and has registered the following value:</t> <dlnewline="false"indent="4"> <dt>Value:</dt> <dd>jsonpath</dd> <dt>Type:</dt> <dd>redacted expression language</dd> <dt>Description:</dt> <dd>JSON path expression language, as defined indraft-ietf-jsonpath-base.</dd> <dt>Registrant Name:</dt>RFC 9535.</dd> <dt>Registrant:</dt> <dd>IETF</dd><dt>Registrant Contact<dt>Contact Information:</dt> <dd>iesg@ietf.org</dd> <dt>Reference:</dt> <dd>RFC 9537</dd> </dl> </section> </section> <sectionanchor="Implementation" numbered="true" toc="default"> <name>Implementation Status</name> <t>Note to RFC Editor: Please remove this section and the reference to <xref target="RFC7942" format="default">RFC 7942</xref> before publication.</t> <t>This section records the status of known implementations of the protocol defined by this specification at the time of posting of this Internet-Draft, and is based on a proposal described in <xref target="RFC7942" format="default">RFC 7942</xref>. The description of implementations in this section is intended to assist the IETF in its decision processes in progressing drafts to RFCs. Please note that the listing of any individual implementation here does not imply endorsement by the IETF. Furthermore, no effort has been spent to verify the information presented here that was supplied by IETF contributors. This is not intended as, and must not be construed to be, a catalog of available implementations or their features. Readers are advised to note that other implementations may exist.</t> <t>According to <xref target="RFC7942" format="default">RFC 7942</xref>, "this will allow reviewers and working groups to assign due consideration to documents that have the benefit of running code, which may serve as evidence of valuable experimentation and feedback that have made the implemented protocols more mature. It is up to the individual working groups to use this information as they see fit".</t> <section anchor="iit-cnr-registro-it-rdap-server" numbered="true" toc="default"> <name>IIT-CNR/Registro.it RDAP Server</name> <t>Responsible Organization: Institute of Informatics and Telematics of National Research Council (IIT-CNR)/Registro.it</t> <t>Location: https://rdap.pubtest.nic.it/</t> <t>Description: This implementation includes support for RDAP queries using data from the public test environment of .it ccTLD. The "redacted" array can be returned in the response to the domain lookup that is the only available to anonymous users.</t> <t>Level of Maturity: This is an "alpha" test implementation.</t> <t>Coverage: This implementation includes all of the features described in this specification.</t> <t>Contact Information: Mario Loffredo, mario.loffredo@iit.cnr.it</t> </section> </section> <section anchor="security-considerations" numbered="true" toc="default">anchor="security-considerations"> <name>Security Considerations</name> <t>The extension described in this document does not provide any security services beyond those described by <xreftarget="RFC9083" format="default"/>.</t>target="RFC9083"/>.</t> </section> </middle> <back> <displayreference target="I-D.ietf-regext-rdap-jscontact" to="RDAP-JSCONTACT"/> <references> <name>References</name> <references> <name>Normative References</name> <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml"/> <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.6350.xml"/> <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.7095.xml"/> <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.8126.xml"/> <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.8174.xml"/> <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.8259.xml"/> <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.9082.xml"/> <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.9083.xml"/> <!-- [I-D.ietf-jsonpath-base] is now RFC 9535 --> <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.9535.xml"/> </references> <references> <name>Informative References</name> <!-- [I-D.ietf-regext-rdap-jscontact] IESG State I-D Exists as of 3/6/24--> <xi:include href="https://bib.ietf.org/public/rfc/bibxml3/reference.I-D.ietf-regext-rdap-jscontact.xml"/> <xi:include href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.8605.xml"/> </references> </references> <section anchor="Acknowledgements"numbered="true" toc="default">numbered="false"> <name>Acknowledgements</name> <t>The authors wish to thank the following persons for their feedback and suggestions: <contact fullname="Marc Blanchet"/>, <contact fullname="Tom Harrison"/>, <contact fullname="Scott Hollenbeck"/>, <contact fullname="Pawel Kowalik"/>, <contact fullname="Mario Loffredo"/>, <contact fullname="Gustavo Lozano"/>, <contact fullname="Andy Newton"/>, <contact fullname="Jasdip Singh"/>, and <contact fullname="Rick Wilhelm"/>. </t> </section></middle> <back> <references> <name>References</name> <references> <name>Informative References</name> &I-D.ietf-regext-rdap-jscontact; &RFC8605; </references> <references> <name>Normative References</name> &RFC2119; &RFC6350; &RFC7095; &RFC7942; &RFC8126; &RFC8174; &RFC8259; &RFC9082; &RFC9083; &I-D.ietf-jsonpath-base; </references> </references> <section numbered="true" toc="default"> <name>Change History</name> <section anchor="change-00-to-01" numbered="true" toc="default"> <name>Change from 00 to 01</name> <ol spacing="compact" type="1"> <li>Changed rdapConformance to use pointed "redacted_0.1" value to support structural changes of the extension up to the target of "redacted_1.0".</li> <li> <t>Updates based on the Gustavo Lozano feedback:</t> <ol spacing="compact" type="1"> <li>Updated the language to change the special treatment of jCard to be more generic for future RDAP extensions that leverage fixed length JSON arrays.</li> <li>Added "RDAP extensions should define any special JSONPath considerations required to identify redacted RDAP fields if the these considerations are insufficient." to the JSONPath Considerations section to generalize it.</li> </ol> </li> <li> <t>Updates based on the Marc Blanchet feedback:</t> <ol spacing="compact" type="1"> <li>Added a reference to draft-ietf-regext-rdap-jscontact as an example of an RDAP extension that is suited for the Redaction by Removal Method based on the lack of dependency on positional JSON arrays.</li> <li>Added support for registered and unregistered (free-form) redaction reasons by changing the "reason" property to be a JSON object with the "type" and "description" properties. The "type" property includes registration in the IANA JSON Values Registry.</li> <li>Added a "JSON Values Registry" section in the IANA Considersations section to define the "redaction reason" JSON Values Registry Type values to support the registration of redaction reasons.</li> </ol> </li> <li> <t>Updates based on the Mario Loffredo feedback:</t> <ol spacing="compact" type="1"> <li>Added support for registered and unregistered (free-form) redaction names by changing the "reason" property to be a JSON object with the "type" and "description" properties. The "type" property includes registration in the IANA JSON Values Registry.</li> <li>Added a "JSON Values Registry" section in the IANA Considersations section to define the "redaction name" JSON Values Registry Type values to support the registration of redaction names.</li> <li>Added a JSONPath Considerations item associated with handling entities with multiple roles.</li> <li>Added language to restrict the extension to responses.</li> </ol> </li> </ol> </section> <section anchor="change-01-to-02" numbered="true" toc="default"> <name>Change from 01 to 02</name> <ol spacing="compact" type="1"> <li> <t>Updates to add support for RDAP search responses:</t> <ol spacing="compact" type="1"> <li>Replaced "RDAP lookup response" with "RDAP response" throughout the draft to expand the scope to include search.</li> <li>Updated the description in the second paragraph of the Introduction to cover both a lookup response and a search response.</li> <li>Added an example of the use of an absoluate path for a search response to the "JSONPath Considerations" section.</li> <li>Added a description of the placement of the "redacted" member in a lookup response and a search response in the ""redacted" Member" section.</li> <li>Added an example of an unredacted search response and a redacted search response in the ""redacted" Member" section.</li> </ol> </li> </ol> </section> <section anchor="change-02-to-03" numbered="true" toc="default"> <name>Change from 02 to 03</name> <ol spacing="compact" type="1"> <li>Fixed mismatch of the extension identifier, which was updated to "redacted_0.1" throughout the draft based on feedback from Mario Loffredo.</li> <li>Added the JSONPath Considerations item associated with redacting fields for multiple entities with the same role based on implementation feedback from Mario Loffredo.</li> <li>Added the Implementation Status section that includes the server implementation by Mario Loffredo.</li> <li>Added use of numbered figures for easy reference for JSON Values Registry registrations.</li> <li>Updated the example unredacted and redacted lookup responses to include the "objectClassName" and "handle" members.</li> <li>Changed RFC7482 and RFC7483 references to RFC9082 and RFC9083, respectively.</li> </ol> </section> <section anchor="change-03-to-04" numbered="true" toc="default"> <name>Change from 03 to 04</name> <ol spacing="compact" type="1"> <li>Changed the extension identifier to be "redacted" instead of a versioned value, which will be leveraged for both the rdapConformance value and the JSON Values.</li> <li>Changed the RDAP Conformance to be "redacted_level_0.2", which leveraged the extension identifier as a prefix along with "_level_" and a pointed version number. The version number will become "1.0" once the draft passes WGLC.</li> <li>Added the Redaction by Replacement Value Method.</li> </ol> </section> <section anchor="change-04-to-05" numbered="true" toc="default"> <name>Change from 04 to 05</name> <ol spacing="compact" type="1"> <li>Update the RDAP Extensions Registry entries to include the identifier that is used for the RDAP conformance value and to include the "redacted" prefix indentifier to use for the JSON response member.</li> <li>Changed the RDAP Conformance to be "redacted_level_0_3", which is registered in the RDAP Extensions Registry. The RDAP Conformance value will become "redacted_level_1" once the draft passes WGLC.</li> </ol> </section> <section anchor="change-05-to-06" numbered="true" toc="default"> <name>Change from 05 to 06</name> <ol spacing="compact" type="1"> <li>Fixed a couple nits.</li> <li>Updated the Redaction by Replacement Value Method email web form examples to use the "contact-uri" jCard property of RFC 8605.</li> </ol> </section> <section anchor="change-06-to-07" numbered="true" toc="default"> <name>Change from 06 to 07</name> <ol spacing="compact" type="1"> <li>Added the optional replacementPath child member for use with the Redaction by Replacement Value Method.</li> </ol> </section> <section anchor="change-07-to-08" numbered="true" toc="default"> <name>Change from 07 to 08</name> <ol spacing="compact" type="1"> <li> <t>Updates based on the Rick Wilhelm feedback:</t> <ol spacing="compact" type="1"> <li>Updated the definition of a redacted RDAP field in the Introduction section.</li> <li>Updated the reference to three methods instead of two in the Redaction Methods section.</li> <li>Created a new paragraph for the example in the Redaction by Removal Method section.</li> <li>Explicitly specified one or more redacted fields for inclusion of the "redacted" member in the "redacted" Member section.</li> <li>Updated the description of the "method" member in the "redacted" Member section.</li> </ol> </li> </ol> </section> <section anchor="change-08-to-09" numbered="true" toc="default"> <name>Change from 08 to 09</name> <ol spacing="compact" type="1"> <li>Updated the RDAP extensions Registry registration and RDAP conformance to match the working group consensus that does not include a version with "redacted".</li> </ol> </section> <section anchor="change-09-to-10" numbered="true" toc="default"> <name>Change from 09 to 10</name> <ol spacing="compact" type="1"> <li> <t>Updates based on the Pawel Kowalik feedback:</t> <ol spacing="compact" type="1"> <li>Changed "placeholder text value will not match the format requirements" to "placeholder text value may not match the format requirements" in Section 3.</li> <li>Changed the "path" member OPTIONAL and added "The "path" member MUST be set when the redacted field does exist in the redacted response" to cover when it's required.</li> <li>Added the definition of the "redacted expression language" JSON Values Registry Type in the IANA Considerations and pre-registered the "jsonpath" "redacted expression language" value.</li> <li>In the definition of the "path" member, added clarification whether the "path" member expression refers to the pre-redacted response field or the redacted response field based on the redaction method.</li> <li>Replaced "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" with "The Redaction by Removal Method MUST NOT be used to remove an element of an array where the position of the element in the array determines semantic meaning" in Section 3.1.</li> <li>Added the "JSONPath Client Considerations" and "JSONPath Server Considerations" subsections to the "JSONPath Considerations" section.</li> </ol> </li> <li> <t>Updates based on the Mario Loffredo feedback:</t> <ol spacing="compact" type="1"> <li>Revised Figure 7 to reference the "email" property and the "contract-uri" property instead of the value elements of the properties.</li> <li>Rephrased the sentence in section 4.2 to 'The "redacted" member contains an array of objects with the following child members'.</li> <li>Added<!-- [rfced] Please review theRedaction by Partial Value Method for redaction of a"Inclusive Language" portion ofa formatted property, such as the jCard "fn" and "label" properties.</li> </ol> </li> </ol> </section> <section anchor="change-10-to-11" numbered="true" toc="default"> <name>Change from 10 to 11</name> <ol spacing="compact" type="1"> <li>Updated Abstract and first sentence of Introduction to "This document describes an RDAP extension for specifying methods of redaction of RDAP responses and explicitly identifying redacted RDAP response fields, using JSONPath as the default expression language.", based on feedback by Pawel Kowalik.</li> <li>Changed "path" member to a "prePath" and "postPath" member to indicate whether the path expression applies to the pre-redacted or post-redacted response, based on feedback by Pawel Kowalik.</li> </ol> </section> <section anchor="change-11-to-12" numbered="true" toc="default"> <name>Change from 11 to 12</name> <ol spacing="compact" type="1"> <li> <t>Updates based on the Andy Newton feedback:</t> <ol spacing="compact" type="1"> <li>Added section "The resulting redacted RDAP response MUST comply with the RDAP RFCs, such as [RFC9083]" as second sentence of Section 3.</li> </ol> </li> <li> <t>Updates based on the Tom Harrison feedback:</t> <ol spacing="compact" type="1"> <li>Added clarification in Section 2 "Conventions Used in This Document" that the JSONPath expressions intheexamples are for illustration purposes with single-role entities and the exact expressions to use by the server are out-of-scope.</li> <li>Replaced consideration #4 "When an entity has multiple roles..." in Section 5.2 "JSONPath Server Considerations" with the recommended language starting with "It is possible for there to be muliple bases for redaction..."</li> <li>Revised the sentence "The client can first key off the "name" member for display logic and utilize a template RDAP response overlaid with the redacted response to successfully resolve the JSONPath expression." in Section 5.1 "JSONPath Client Considers" to "The client can key off the "name" member for display logic related to the redaction.".</li> <li>Replaced "type" with "description" for the example redaction "name" and "reason" members, so not to infer that they are being registered for use.</li> <li>Changed "Two new JSON Values Registry Type field values are used to register pre-defined redacted nameonline Style Guide <https://www.rfc-editor.org/styleguide/part2/#inclusive_language> andreason values" in Section 6.2 "JSON Values Registry" to "Three new JSON Values Registry Type field valueslet us know if any changes areused to register pre-defined redacted name, reason, and expression language values".</li> </ol> </li> <li> <t>Updates based on validating each of the draft examples:</t> <ol spacing="compact" type="1"> <li>Added missing comma between the "Administrative Contact" and "Billing Contact" "redacted" members.</li> <li>Removed consideration #5 in Section 5.2 "JSONPath Server Considerations" since the use of the JSONPath expression "$.entities[?(@.roles[0]=='technical')][0]" is not valid and the exact JSONPath expression to use is out-of-scope.</li> </ol> </li> </ol> </section> <section anchor="change-12-to-13" numbered="true" toc="default"> <name>Change from 12 to 13</name> <ol spacing="compact" type="1"> <li> <t>Updates based on the Jasdip Singh feedback:</t> <ol spacing="compact" type="1"> <li>In Section 1, replaced the sentence "The redacted JSON fields will either be removed or have empty values in the RDAP response" with "The redacted JSON fields will either be removed, have empty values, have partial values, or be replaced in the RDAP response.".</li> <li>In Section 3, changed the reference of three categories to four categories.</li> <li>In Section 3.1, changed ", which is the preferred method" to ", which is the default method" to clarify the Removal Method as the default redaction method.</li> <li>In Section 4.2, updated the sentence to read "The "redacted" member is included as a member of the object instance in a lookup response, for the object classes defined in [RFC9083], and as a member of the array of object instances in a search response.".</li> <li>In Section 4.2, explicitly defined the "name" member as REQUIRED".</li> </ol> </li> </ol> </section> <section anchor="change-13-to-14" numbered="true" toc="default"> <name>Change from 13 to 14</name> <ol spacing="compact" type="1"> <li>Replaced RFC 7483 reference with RFC 9083 based on the Document Shepherd review by Andy Newton.</li> <li>Replaced the "Registrant Name" "IESG" value with "IETF" for the "RDAP JSON Values Registry" registrations.</li> <li> <t>Updates based on the Murray Kucherawy AD evaluation feedback:</t> <ol spacing="compact" type="1"> <li>Combined sentences on the use of placeholder text in Section 3 "Redaction Methods" for clarification.</li> <li>Changed the two SHOULDs to MUSTs in Section 3.2 "Redaction by Empty Value Method".</li> <li>Changed "alternate" to "alternative" in Section 3.4 "Redaction by Replacement Value Method".</li> <li>Changed "JSON expression" to "JSON path expression" in Section 4.2 "</li> <li>Changed references of "JSON Values Registry" to "RDAP JSON Values Registry" to match the IANA registry name.</li> </ol> </li> </ol> </section> <section anchor="change-14-to-15" numbered="true" toc="default"> <name>Change from 14 to 15</name> <ol spacing="compact" type="1"> <li>Based on feedback from Paul Wouters, moved the Security Considerations language to Section 4.2 ""redacted" Member", since exclusion of a "redacted" child member due to privacy is a feature. The Security Considerations section was made generic.</li> <li>Revised the RDAP JSON Values Registry IANA Considerations used to register pre-register the pre-defined redacted name, redacted reason, and redacted expression language values based on Scott Hollenbeck's expert review feedback.</li> </ol> </section> <section anchor="change-15-to-16" numbered="true" toc="default"> <name>Change from 15 to 16</name> <ol spacing="compact" type="1"> <li> <t>Updates based on feedback from Roman Danyliw:</t> <ol spacing="compact" type="1"> <li>Updated "Redaction in RDAP can be handled in multiple ways. The resulting redacted RDAP response MUST comply with the RDAP RFCs, such as [RFC9083]" to "Redaction in RDAP canneeded. For example, please consider whether "whitespace" should behandled in multiple ways. The resulting redacted RDAP response MUST comply with the format defined in the RDAP RFCs with the RDAP RFCs, such as [RFC9083] and updates"</li> <li>Add "The server MAY choose to publish a redaction policy describing how this extension is implemented for their constituency. The contents of such a policy are outside the scope of this specification." to Section 4.2 ""redacted" Member".</li> </ol> </li> </ol> </section> </section>updated. --> </back> </rfc>