Using JSContact in Registration Data Access Protocol (RDAP) JSON Responses

Status of This Memo

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 8 December 2023.¶

Copyright Notice

Copyright (c) 2023 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 Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶

Table of Contents

2. JSContact

The JSContact specification defines a data model and JSON representation of contact information that can be used for data storage and exchange in address book or directory applications. It aims to be an alternative to the vCard data format [RFC6350] and to be unambiguous, extendable and simple to process. In contrast with jCard, it is not a direct mapping from the vCard data model and expands semantics where appropriate.¶

JSCard differs from jCard in that it:¶

• follows an object-oriented rather than array-oriented approach;¶

• is simple to process;¶

• requires no extra work in serialization/deserialization from/to a data model;¶

• includes no "jagged" arrays;¶

• prefers maps rather than arrays to implement collections.¶

[I-D.ietf-calext-jscontact-vcard] provides informational guidance on the conversion of jCard into JSCard, and vice versa. Appendix A shows JSContact counterparts for the most commonly used jCard properties in an RDAP response.¶

3. Using JSContact objects in RDAP Responses

Entity objects in RDAP responses MAY include a "jscard" property whose value is a JSCard object instead of the "vCardArray" property defined in [RFC9083].¶

Servers returning the "jscard" property in their response MUST include "jscard" in the "rdapConformance" array.¶

Since most of the JSCard collections are represented as maps, map keys must be defined. A JSContact map key MUST comply with the definition of the Id type. To aid interoperability, RDAP providers MUST use the following Id values related to string values and labels defined in [RFC5733]:¶

• "org" in the "organizations" map when there is a single <contact:org> element. If both internationalised and localized forms exist, the key MUST be used for the internationalised form;¶

• "addr" in the "addresses" map when there is a single <contact:addr> element. If both internationalised and localized forms exist, the key MUST be used for the internationalised form;¶

• "email" in the "emails" map when there is a single <contact:email> element;¶

• "voice" in the "phones" map for the <contact:voice> element;¶

• "fax" in the "phones" map for the <contact:fax> element.¶

The information needed to register the JSContact Id values in the "RDAP JSON Values" registry [RFC9083] is described in Section 6.2.¶

If present, the localized versions of name, organization and postal address MUST be added to the "localizations" map. With reference to the defintion of localization in [I-D.ietf-calext-jscontact], an RDAP response with JSContact content MUST expand all localizations (i.e. a patch key using the syntax "{key1}/{key2}/.../{keyN}" is not allowed). The following is an elided example of an RDAP entity lookup response including a JSCard object that presents a localized postal address (See PDF for non-ASCII character string).¶

...
"jscard": {
  "@type" : "Card",
  "@version" : "1.0",
  "uid" : "7812cafe-336e-5969-988b-ad68f78ae90f",
  "language" : "en",
  "fullName" : "Vasya Pupkin",
  "organizations" : {
    "org" : {
      "name" : "My Company"
    }
  },
  "addresses" : {
    "addr" : {
      "street" : [ {
        "kind" : "name",
        "value" : "1 Street"
      }, {
        "kind" : "postOfficeBox",
        "value" : "01001"
      } ],
      "locality" : "Kyiv",
      "countryCode" : "UA"
    }
  },
  "localizations" : {
    "ua" : {
      "addresses": {
        "addr" : {
          "street" : [ {
            "kind" : "name",
            "value" : "1, Улица"
          }, {
            "kind" : "postOfficeBox",
            "value" : "01001"
          } ],
          "locality" : "Киев",
          "countryCode" : "UA"
        }
      },
      "fullName" : "Вася Пупкин",
      "organizations": {
        "org" : {
          "name" : "Моя Компания"
        }
      }
    }
  }
}
...

Implementers MAY use different mapping schemes to define keys for additional entries of the aforementioned maps or others. For example, a mapping scheme may consist in using a trivial sequential number (e.g. "url-1", "url-2", etc.)¶

The following is an example of an RDAP entity including a JSCard object that has been converted from the example in section 5.1 of [RFC9083].¶

   {
      "rdapConformance": [
         "rdap_level_0",
         "jscard"
      ],
      "objectClassName" : "entity",
      "handle":"XXXX",
      "jscard":{
        "@type": "Card",
        "@version": "1.0",
        "uid": "74b64df3-2d60-56b4-9df3-8594886f4456",
        "language" : "en",
        "fullName": "Joe User" ,
        "name": {
          "components": [
            {
              "type": "surname",
              "value": "User"
            },
            {
              "type": "given",
              "value": "Joe"
            },
            {
              "type": "suffix",
              "value": "ing. jr"
            },
            {
              "type": "suffix",
              "value": "M.Sc."
            }
          ]
        },
        "kind": "individual",
        "preferredLanguages": {
          "fr": {
            "pref": 1
          },
          "en": {
            "pref": 2
          }
        },
        "organizations": {
          "org": {
            "name": "Example"
          }
        },
        "titles": {
          "title": {
            "kind": "title",
            "name": "Research Scientist"
          },
          "role": {
            "kind": "role",
            "name": "Project Lead"
          }
        },
        "addresses": {
          "addr": {
            "contexts": {
              "work": true
            },
            "street": [
              {
                "kind": "name",
                "value": "4321 Rue Somewhere"
              },
              {
                "kind": "extension",
                "value": "Suite 1234"
              }
            ],
            "locality": "Quebec",
            "region": "QC",
            "postcode": "G1V 2M2",
            "country": "Canada",
            "countryCode": "CA",
            "coordinates": "geo:46.772673,-71.282945",
            "timeZone": "Etc/GMT+5"
          },
          "home": {
            "contexts": {
              "private": true
            },
            "fullAddress": "123 Maple Ave\nVancouver\nBC\n1239\n"
          }
        },
        "phones": {
          "voice" : {
            "contexts": {
              "work": true
            },
            "features": {
               "voice": true,
               "mobile": true,
               "video": true,
               "text": true
            },
            "pref": 1,
            "number": "tel:+1-555-555-1234;ext=102"
          }
        },
        "emails": {
          "email": {
            "contexts": {
              "work": true
            },
            "address": "joe.user@example.com"
          }
        },
        "cryptoKeys": {
          "contexts": {
            "work": true
          },
          "uri": "https://www.example.com/joe.user/joe.asc"
        },
        "links": {
          "contexts": {
            "private": true
          },
          "uri": "https://example.org"
        }
      },
      "roles":[ "registrar" ],
      "publicIds":[
        {
          "type":"IANA Registrar ID",
          "identifier":"1"
        }
      ],
      "remarks":[
        {
          "description":[
            "She sells sea shells down by the sea shore.",
            "Originally written by Terry Sullivan."
          ]
        }
      ],
      "links":[
        {
          "value":"https://example.com/entity/XXXX",
          "rel":"self",
          "href":"https://example.com/entity/XXXX",
          "type" : "application/rdap+json"
        }
      ],
      "events":[
        {
          "eventAction":"registration",
          "eventDate":"1990-12-31T23:59:59Z"
        }
      ],
      "asEventActor":[
        {
          "eventAction":"last changed",
          "eventDate":"1991-12-31T23:59:59Z"
        }
      ]
   }

The use of JSContact updates the mappings of two reverse search properties, namely "fn" and "email", defined in [I-D.ietf-regext-rdap-reverse-search]. Such new mappings are registered in the Reverse Search Mapping registry as described in Section 6.3.¶

4. Transition Considerations

"notices": [
  {
    "title": "jCard sunset end",
    "description": ["2022-12-31T23:59:59Z"],
    "links": [{
        "value": "https://example.net/entity/XXXX",
        "rel": "related",
        "type": "text/html",
        "href": "https://www.example.com/jcard_deprecation.html"
      },
      {
        "value": "https://example.net/entity/XXXX",
        "rel": "alternate",
        "type": "application/rdap+json",
        "href": " https://example.net/entity/XXXX?jscard=1"
      }
    ]
  }
]

5. Implementation Status

NOTE: Please remove this section and the reference to RFC 7942 prior to publication as an RFC.¶

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 RFC 7942 [RFC7942]. 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.¶

According to RFC 7942, "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".¶

6. IANA Considerations

7. Security Considerations

Unlike what happens for the "fn" property in jCard, the only mandatory property in JSContact, namely "uid", is not a sensitive information. Nevertheless, RDAP operators can redact it to prevent results from being correlated. Hence, with reference to what is described in [I-D.ietf-regext-rdap-redacted], a redaction method must be selected based on the "uid" format.¶

If "uid" is represented as a URN in the uuid namespace, the most appropriate choice is using the "Replacement Value" method along with the nil UUID as replacing value. If it is provided in the free-text format, the "Empty Value" method should be preferred. Otherwise, an URI value can be redacted by using any of the two methods above. For example, the URL of the RDAP entity corresponding to the contact (e.g. "https://example.com/rdap/entity/XYZ12345") can be redacted by replacing the entity handle with a fixed literal (e.g "https://example.com/rdap/entity/XXXXX").¶

8. Acknowledgements

The authors would like to acknowledge the following individuals for their contributions to this document: Jasdip Singh, Andrew Newton, Marc Blanchet, Rick Wilhelm and Francesco Donini.¶

Appendix A. jCard-JSContact Mapping

Provided that the keys defined in Section 3 are used for the JSContact maps, the mapping between the most commonly used jCard properties in an RDAP response and their JSContact counterparts is shown in the following. The mapping is done through the use of JSONPath expressions [I-D.ietf-jsonpath-base].¶

jCard property:

fn¶

Reference:

Section 6.2.1 of [RFC6350]¶

Path:

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

JSContact property:

fullName¶

Reference:

Section 2.2.1 of [I-D.ietf-calext-jscontact]¶

Path:

$..jscard.[fullName,localizations.*.fullName]¶

jCard property:

org¶

Reference:

Section 6.6.4 of [RFC6350]¶

Path:

$..vcardArray[1][?(@[0]=='org')][3]¶

JSContact property:

Organization.name¶

Reference:

Section 2.2.4 of [I-D.ietf-calext-jscontact]¶

Path:

$..jscard.[organizations.org.name,localizations.*.organizations.org.name]¶

jCard property:

tel with type="voice"¶

Reference:

Section 6.4.1 of [RFC6350]¶

Path:

$..vcardArray[1][?(@[1].type=='voice')][3]¶

JSContact property:

Phone.number¶

Reference:

Section 2.3.3 of [I-D.ietf-calext-jscontact]¶

Path:

$..jscard.phones.voice.number¶

jCard property:

tel with type="fax"¶

Reference:

Section 6.4.1 of [RFC6350]¶

Path:

$..vcardArray[1][?(@[1].type=='fax')][3]¶

JSContact property:

Phone.number¶

Reference:

Section 2.3.3 of [I-D.ietf-calext-jscontact]¶

Path:

$..jscard.phones.fax.number¶

jCard property:

email¶

Reference:

Section 6.4.2 of [RFC6350]¶

Path:

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

JSContact property:

Email.address¶

Reference:

Section 2.3.1 of [I-D.ietf-calext-jscontact]¶

Path:

$..jscard.[emails.email.address,localizations.*.emails.email.address]¶

jCard property:

"post office box" component of adr¶

Reference:

Section 6.3.1 of [RFC6350]¶

Path:

$..vcardArray[1][?(@[0]=='adr')][3][1]¶

JSContact property:

"postOfficeBox" StreetComponent of Address.street¶

Reference:

Section 2.5.1 of [I-D.ietf-calext-jscontact]¶

Path:

$..jscard.[addresses.addr.street[?(@.type=='postOfficeBox')].value,localizations.*.addresses.addr.street[?(@.type=='postOfficeBox')].value]¶

jCard property:

"street address" component of adr¶

Reference:

Section 6.3.1 of [RFC6350]¶

Path:

$..vcardArray[1][?(@[0]=='adr')][3][2]¶

JSContact property:

"name" StreetComponent of Address.street¶

Reference:

Section 2.5.1 of [I-D.ietf-calext-jscontact]¶

Path:

$..jscard.[addresses.addr.street[?(@.type=='name')].value,localizations.*.addresses.addr.street[?(@.type=='name')].value]¶

jCard property:

"locality" component of adr¶

Reference:

Section 6.3.1 of [RFC6350]¶

Path:

$..vcardArray[1][?(@[0]=='adr')][3][3]¶

JSContact property:

Address.locality¶

Reference:

Section 2.5.1 of [I-D.ietf-calext-jscontact]¶

Path:

$..jscard.[addresses.addr.locality,localizations.*.addresses.addr.locality]¶

jCard property:

"region" component of adr¶

Reference:

Section 6.3.1 of [RFC6350]¶

Path:

$..vcardArray[1][?(@[0]=='adr')][3][4]¶

JSContact property:

Address.region¶

Reference:

Section 2.5.1 of [I-D.ietf-calext-jscontact]¶

Path:

$..jscard.[addresses.addr.region,localizations.*.addresses.addr.region]¶

jCard property:

"postal code" component of adr¶

Reference:

Section 6.3.1 of [RFC6350]¶

Path:

$..vcardArray[1][?(@[0]=='adr')][3][5]¶

JSContact property:

Address.postcode¶

Reference:

Section 2.5.1 of [I-D.ietf-calext-jscontact]¶

Path:

$..jscard.[addresses.addr.postcode,localizations.*.addresses.addr.postcode]¶

jCard property:

"country name" component of adr¶

Reference:

Section 6.3.1 of [RFC6350]¶

Path:

$..vcardArray[1][?(@[0]=='adr')][3][6]¶

JSContact property:

Address.country¶

Reference:

Section 2.5.1 of [I-D.ietf-calext-jscontact]¶

Path:

$..jscard.[addresses.addr.country,localizations.*.addresses.addr.country]¶

jCard property:

"cc" parameter of adr¶

Reference:

Section 3.1 of [RFC8605]¶

Path:

$..vcardArray[1][?(@[0]=='adr')][1].cc¶

JSContact property:

Address.countryCode¶

Reference:

Section 2.5.1 of [I-D.ietf-calext-jscontact]¶

Path:

$..jscard.[addresses.addr.countryCode,localizations.*.addresses.addr.countryCode]¶

Authors' Addresses