]> IIT-CNR/Registro.it

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

CentralNic Group plc

Saddlers House, 44 Gutter Lane London England EC2V 6BR GB +44 20 33 88 0600 gavin.brown@centralnic.com https://www.centralnic.com

Applications and Real-Time Registration Protocols Extensions RDAP jCard JSContact This document describes an RDAP extension which represents entity contact information in JSON responses using JSContact.

This document specifies an extension to the Registration Data Access Protocol (RDAP) that allows RDAP servers to use JSContact to represent the contact information associated with entities in RDAP responses, instead of jCard . It also describes the process by which an RDAP server can transition from jCard to JSContact. RDAP query and response extensions are defined to facilitate the transition process.

According to the feedback from RDAP Pilot Working Group , a group of RDAP server implementers representing registries and registrars of generic TLDs, the most commonly raised implementation concern, for both servers and client implementers, related to the use of jCard to represent the contact information associated with entities. Working Group members reported jCard to be unintuitive, complicated to implement for both clients and servers, and incompatible with best practices for RESTful APIs. JSContact provides a simpler and more efficient representation for contact information with regard to time and effort saved in processing it. In addition, similarly to jCard, it provides a means to represent internationalised and unstructured contact information. Support for internationalised contact information has been recognised being necessary to facilitate the future internationalisation of registration data directory services.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here. The JSContact specification declares the object type "Card" which represents a single contact card. To avoid confusion, in the following of this document, the term "JSCard" is used to refer to "JSContact Card".

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 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. provides informational guidance on the conversion of jCard into JSCard, and vice versa. shows JSContact counterparts for the most commonly used jCard properties in an RDAP response.

Entity objects in RDAP responses MAY include a "jscard" property whose value is a JSCard object instead of the "vCardArray" property defined in . Servers returning the "jscard" property in their response MUST include "jscard" in the "rdapConformance" array.

The JSContact version to be used in RDAP MUST be "1.0".

The JSContact "kind" property value MUST be "individual" (default) or "org" to represent an individual or an organization, respectively.

The JSContact "language" property SHOULD be set when localizations are specified (i.e. the "localizations" property is not null).

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 : "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. Additional keys of the "links" map that MUST be used to represent contact links which result from converting jCard "uri" and "contact-uri" properties are: "url" used for the unique or preferred contact url (e.g. a web site). The "kind" property of the JSContact "Link" object MUST NOT be set; "contact-uri" used for the contact uri as defined in . The "kind" property of the JSContact "Link" object MUST be set to "contact". The information needed to register the JSContact Id values in the "RDAP JSON Values" registry is described in . An unregistered Id value used for the aforementioned maps or others SHOULD comply with the following scheme: "<map name>-<sequential number>" (e.g. "addresses-1", "addresses-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 , 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", "name": { "full": "Vasya Pupkin" }, "organizations": { "org": { "name": "My Company" } }, "addresses": { "addr": { "components": [ { "kind": "name", "value": "1 Street" }, { "kind": "postOfficeBox", "value": "01001" }, { "kind": "locality", "value": "Kyiv" } ], "countryCode": "UA" } }, "localizations": { "ua": { "addresses": { "addr": { "components": [ { "kind": "name", "value": "1, Улица" }, { "kind": "postOfficeBox", "value": "01001" }, { "kind": "locality", "value": "Киев" } ], "countryCode": "UA" } }, "name": { "full": "Вася Пупкин" }, "organizations": { "org": { "name": "Моя Компания" } } } } } ...

The following is an example of an RDAP entity including a JSCard object.

{ "rdapConformance": [ "rdap_level_0", "jscard" ], "objectClassName": "entity", "handle":"XXXX", "jscard":{ "@type": "Card", "@version": "1.0", "uid": "74b64df3-2d60-56b4-9df3-8594886f4456", "language": "en", "name": { "full": "Joe User", "components": [ { "kind": "surname", "value": "User" }, { "kind": "given", "value": "Joe" } ] }, "organizations": { "org": { "name": "Example" } }, "addresses": { "addr": { "components": [ { "kind": "name", "value": "4321 Rue Somewhere" }, { "kind": "extension", "value": "Suite 1234" }, { "kind": "locality", "value": "Quebec" }, { "kind": "region", "value": "QC" }, { "kind": "postcode", "value": "G1V 2M2" }, { "kind": "country", "value": "Canada" } ], "countryCode": "CA", "coordinates": "geo:46.772673,-71.282945" }, "addresses-1": { "full": "123 Maple Ave Vancouver BC 1239" "contexts": { "private": true } } }, "phones": { "voice": { "features": { "voice": true }, "number": "tel:+1-555-555-1234" }, "fax": { "features": { "fax": true }, "number": "tel:+1-555-555-4321" } }, "emails": { "email": { "address": "joe.user@example.com" } }, "links": { "url": { "uri": "https://www.example.com" }, "contact-uri": { "kind": "contact", "uri": "mailto:contact@example.com" } } }, "roles":[ "registrar" ], "publicIds":[ { "type":"IANA Registrar ID", "identifier":"1" } ], "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" } ] }

One new query parameter is defined for the purpose of this document. The parameter is an OPTIONAL extension of queries defined in as well as any RDAP query described by a future document whose response includes contact information. It is as follows: "jscard": a boolean value that allows a client to request the "jscard" property in the RDAP response; This parameter is further explained in .

The use of JSContact updates the mappings of two reverse search properties, namely "fn" and "email", defined in . Such new mappings are registered in the Reverse Search Mapping registry as described in .

RDAP allows servers to communicate service information to clients through notices. According to Section 4.3 of , an RDAP response may contain one or more notice objects. Each notice may include a set of link objects, which can be used to provide clients with references and documentation. These link objects may have a "rel" property which defines the relationship type, as described in , Section 4. The transition process outlined in this document uses two link relation types, namely "related" and "alternate", described in .

The information about the specifications used in the construction of the response is also described by the strings which appear in the "rdapConformance" property of the RDAP response.

The principles of the procedure for jCard to JSCard transition are based on the best practices in . The procedure consists of three contiguous stages. During the procedure, the presence of "jscard" tag in the rdapConformance array indicates that JSCard is returned instead of jCard. The date and time format used to notify clients about the stages of this procedure is defined in .

The procedure described in this document aims to achieve the following goals: only one contact representation would be included in the response; the response would always be compliant to because: being the "jscard" property a response extension, its presence would be signaled by the "jscard" conformance tag; being "vcardArray" property optional in a response, its absence would be allowed; clients would be informed about the transition timeline; the backward compatibility would be guaranteed throughout the transition; servers and clients could execute their transitions independently.

This stage corresponds to providing jCard as the default contact card . The RDAP server is not able to provide an alternate format for the contact card. The rdapConformance array MUST NOT contain the "jscard" tag.

During this stage, the server uses jCard by default, but the RDAP server will return JSCard if the client sets the query parameter "jscard" to 1/true/yes. The rdapConformance array MUST contain the "jscard" tag if JSCard is returned. From this stage on, the RDAP server MUST include the "jscard" tag in the rdapConformance array of the help response to signal clients that JSCard can be returned instead of jCard. If JSCard is not requested, the RDAP server SHOULD include a notice titled "jCard sunset end". Such a notice includes a description reporting the jCard sunset end date and time and two OPTIONAL links: "related": a link to a URI-identified resource documenting the transition procedure; "alternate": a link to an alternate result view identified by the current query string plus the parameter "jscard" set to 1/true/yes ().

"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" } ] } ]

This stage corresponds to providing JSCard as default contact card. The rdapConformance array always contains "jscard" tag. The RDAP server doesn't include any notice about the jCard deprecation process. The "jscard" query parameter MUST be ignored. FOR DISCUSSION: should server signal the end of the transition by including the "jcard_deprecated" value in the rdapConformance array ? Would its usage be compliant with the rdapConformance definition in RFC 9083 ?

The length of the jCard sunset period is not fixed by this specification. Best practices in REST API deprecation suggest that, depending on the deprecated API's reach, user base and service offering, a convenient time could be anywhere between 3 - 8 months. Anyway, RDAP providers are RECOMMENDED to monitor the server log to figure out whether the declared time need to be changed to meet client requirements.

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 . 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".

Responsible Organization: Institute of Informatics and Telematics of National Research Council (IIT-CNR)/Registro.it Location: https://rdap.pubtest.nic.it/ Description: This implementation includes support for RDAP queries using data from the public test environment of .it ccTLD. Level of Maturity: This is an "alpha" test implementation. Coverage: This implementation includes all of the features described in this specification. Contact Information: Mario Loffredo, mario.loffredo@iit.cnr.it

Responsible Organization: Institute of Informatics and Telematics of National Research Council (IIT-CNR)/Registro.it Location: https://web-rdap.pubtest.nic.it/ Description: This is a Javascript web-based RDAP client. RDAP responses are retrieved from RDAP servers by the browser, parsed into an HTML representation, and displayed in a format improving the user experience. RDAP responses containing JSCard objects are handled identically to those containing jCard objects. Raw versions of RDAP responses including either jCard or JSCard objects are provided. Level of Maturity: This is an "alpha" test implementation. Coverage: This implementation includes all of the features described in this specification. Contact Information: Francesco Donini, francesco.donini@iit.cnr.it

Location: https://client.rdap.org/ Description: This is a web-based "single page" RDAP client. RDAP responses are retrieved from RDAP servers by the browser, and parsed into an HTML representation. RDAP responses containing JSCard objects are handled identically to those containing jCard objects. Level of Maturity: This is an "alpha" test implementation. Coverage: This implementation implements client support for parsing JSCard objects in RDAP responses. Contact Information: Gavin Brown, feedback@rdap.org

Responsible Organization: CentralNic Group PLC Location: https://rdap.centralnic.com/{tld} Description: This server is the product RDAP service for all top-level domains on the CentralNic registry platform. Level of Maturity: Production quality. Coverage: This implementation includes all of the features described in this specification. Contact Information: support@centralnic.com

IANA is requested to register the following values in the RDAP Extensions Registry: Extension identifier: jscard Registry operator: Any Published specification: This document. Contact: IETF <iesg@ietf.org> Intended usage: This extension prefix identifier is used for the "jscard" member returned in the JSON response .

With regard to the fields of the "RDAP JSON Values" registry , the "JSContact Id Value" type SHALL be used to register the RDAP values for the JSContact Id type as defined in . IANA is requested to register the following values in the "RDAP JSON Values" registry: org JSContact Id Value The key in the JSContact "organizations" map identifiying the contact organization. IESG iesg@ietf.org This document addr JSContact Id Value The key in the JSContact "addresses" map identifiying the unique or preferred contact postal address. IESG iesg@ietf.org This document email JSContact Id Value The key in the JSContact "emails" map identifiying the unique or preferred contact email address. IESG iesg@ietf.org This document voice JSContact Id Value The key in the JSContact "phones" map identifiying the unique or preferred contact voice number. IESG iesg@ietf.org This document fax JSContact Id Value The key in the JSContact "phones" map identifiying the unique or preferred contact fax number. IESG iesg@ietf.org This document url JSContact Id Value The key in the JSContact "links" map identifiying the unique or preferred url. IESG iesg@ietf.org This document contact-uri JSContact Id Value The key in the JSContact "links" map identifiying the contact uri as defined in . IESG iesg@ietf.org This document

IANA is requested to register the following entries in the the "RDAP Reverse Search Mapping" registry : domains, nameservers, entities entity fn $.entities[*].jscard.[name.full,localizations.*.name.full] IESG iesg@ietf.org This document domains, nameservers, entities entity email $.entities[*].jscard.emails.email.address IESG iesg@ietf.org This document

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 , 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").

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.

&I-D.ietf-calext-jscontact; &I-D.ietf-calext-jscontact-vcard; &I-D.ietf-regext-rdap-reverse-search; &RFC2119; &RFC3339; &RFC5733; &RFC6350; &RFC7095; &RFC9082; &RFC9083; &RFC7942; &RFC8174; &RFC8288; &I-D.ietf-jsonpath-base; &I-D.ietf-regext-rdap-redacted; &RFC8605; ICANN RDAP Pilot WG

Provided that the keys defined in 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 . fn Section 6.2.1 of $..vcardArray[1][?(@[0]=='fn')][3] Name.full Section 2.2.1 of $..jscard.[name.full,localizations.*.name.full] "family name" component of n Section 6.2.2 of $..vcardArray[1][?(@[0]=='n')][3][0] "postOfficeBox" NameComponent of Name.components Section 2.5.1 of $..jscard.[name.components[?(@.kind=='surname')].value,localizations.*.name.components[?(@.kind=='surname')].value] "given name" component of n Section 6.2.2 of $..vcardArray[1][?(@[0]=='n')][3][1] "given" NameComponent of Name.components Section 2.5.1 of $..jscard.[name.components[?(@.kind=='given')].value,localizations.*.name.components[?(@.kind=='given')].value] n Section 6.3.1 of $..vcardArray[1][?(@[0]=='n')] Name Section 2.5.1 of $..jscard.[name,localizations.*.name] org Section 6.6.4 of $..vcardArray[1][?(@[0]=='org')][3] Organization.name Section 2.2.2 of $..jscard.[organizations.org.name,localizations.*.organizations.org.name] tel with type="voice" Section 6.4.1 of $..vcardArray[1][?(@[1].type=='voice')][3] Phone.number Section 2.3.3 of $..jscard.phones.voice.number tel with type="fax" Section 6.4.1 of $..vcardArray[1][?(@[1].type=='fax')][3] Phone.number Section 2.3.3 of $..jscard.phones.fax.number email Section 6.4.2 of $..vcardArray[1][?(@[0]=='email')][3] Email.address Section 2.3.1 of $..jscard.[emails.email.address,localizations.*.emails.email.address] "label" parameter of adr Section 6.3.1 of $..vcardArray[1][?(@[0]=='adr')][1].label Address.full Section 2.5.1 of $..jscard.[addresses.adr.full,localizations.*.addresses.adr.full] "post office box" component of adr Section 6.3.1 of $..vcardArray[1][?(@[0]=='adr')][3][1] "postOfficeBox" AddressComponent of Address.components Section 2.5.1 of $..jscard.[addresses.addr.components[?(@.kind=='postOfficeBox')].value,localizations.*.addresses.addr.components[?(@.kind=='postOfficeBox')].value] "street address" component of adr Section 6.3.1 of $..vcardArray[1][?(@[0]=='adr')][3][2] "name" AddressComponent of Address.components Section 2.5.1 of $..jscard.[addresses.addr.components[?(@.kind=='name')].value,localizations.*.addresses.addr.components[?(@.kind=='name')].value] "locality" component of adr Section 6.3.1 of $..vcardArray[1][?(@[0]=='adr')][3][3] "locality" AddressComponent of Address.components Section 2.5.1 of $..jscard.[addresses.addr.components[?(@.kind=='locality')].value,localizations.*.addresses.addr.components[?(@.kind=='locality')].value] "region" component of adr Section 6.3.1 of $..vcardArray[1][?(@[0]=='adr')][3][4] "region" AddressComponent of Address.components Section 2.5.1 of $..jscard.[addresses.addr.components[?(@.kind=='region')].value,localizations.*.addresses.addr.components[?(@.kind=='region')].value] "postal code" component of adr Section 6.3.1 of $..vcardArray[1][?(@[0]=='adr')][3][5] "postcode" AddressComponent of Address.components Section 2.5.1 of $..jscard.[addresses.addr.components[?(@.kind=='postcode')].value,localizations.*.addresses.addr.components[?(@.kind=='postcode')].value] "country name" component of adr Section 6.3.1 of $..vcardArray[1][?(@[0]=='adr')][3][6] "country" AddressComponent of Address.components Section 2.5.1 of $..jscard.[addresses.addr.components[?(@.kind=='country')].value,localizations.*.addresses.addr.components[?(@.kind=='country')].value] "cc" parameter of adr Section 3.1 of $..vcardArray[1][?(@[0]=='adr')][1].cc Address.countryCode Section 2.5.1 of $..jscard.[addresses.addr.countryCode,localizations.*.addresses.addr.countryCode] adr Section 6.3.1 of $..vcardArray[1][?(@[0]=='adr')] Address Section 2.5.1 of $..jscard.[addresses.addr,localizations.*.addresses.addr] contact-uri Section 2.1 of $..vcardArray[1][?(@[0]=='contact-uri')] Link.uri Section 2.6.3 of $..jscard.links.contact-uri.uri url Section 6.7.8 of $..vcardArray[1][?(@[0]=='url')] Link.uri Section 2.6.3 of $..jscard.links.url.uri

Changed category from "Best Current Practice" to "Standards Track" Replaced the example of Changed the title of the "Migration from JCard to JSCard" section to "Transition Considerations" Added Updated Updated Rearranged the description of stage 1 in Changed the names of the transition stages 1 and 2 Corrected examples Changed the rdapConformance tag "jscard_level_0" to "jscard" Removed the "Best Practices for deprecating a REST API features" section,but added a useful reference.

Removed the sentence "which cannot be represented using jCard" in .

Updated section "Conventions Used in This Document". Updated the contact in "IANA Considerations" section. Changed the reference draft-loffredo-calext-jscontact-vcard to draft-ietf-calext-jscontact-vcard. Added reference to RFC8174. Other minor edits.

Updated the reference draft-dalal-deprecation-header to draft-ietf-httpapi-deprecation-header.

Ported from draft-loffredo-regext-rdap-jcard-deprecation-04 renamed to draft-ietf-regext-rdap-jscontact-00.

Updated and .

Updated and .

Replaced references to obsolete RFC7482 and RFC7483 with RFC9082 and RFC9083. Updated and .

Changed the references to Internet Drafts. Added an example showing how localizations are treated in JSContact. Changed the position of section "Goals" in . Added three more implementations to . Changed the rdapConformance tag "jscard" to "jscard_0" Added clarifications addressing the feedback provided by Jasdip Singh about version -03. Added . Other minor edits.

Updated to make it compliant with draft-ietf-jmap-jscontact-09.

Reviewed the notices presented in stages.

Corrected the JSON Pointer expressions in . Other minor edits.

Corrected a nit in . Removed the reference to draft-ietf-httpapi-deprecation-header. Replaced the "deprecation" link relation type with "related". Moved the references to JSContact drafts to the "Normative References" section.

Updated the references to JSContact drafts due to the transfer from JMAP to CalExt.

Updated to make it compliant with draft-ietf-calext-jscontact-02.

Added Appendix "jCard-JSContact Mapping".

Renamed the "jscard" property to "jscard_0". Corrected JSONPath expressions in .

Reverted the names of response extension, the rdapConformance tag and extension identifier from "jscard_0" to "jscard". Corrected by removing initial '/' character from JSONPath notations related to localizations.

Corrected by replacing "online" property with "cryptoKeys" and "links" properties.

Corrected , and to make them compliant with draft-ietf-calext-jscontact-06. Removed mention of JSContact CardGroup object. Renamed and changed . Added .

Corrected , and to make them compliant with draft-ietf-calext-jscontact-06. Removed mention of JSContact CardGroup object. Renamed and changed . Added .

Replaced JSContact "type" with "kind" in figures. Removed "jCard deprecation" stage and "jcard" query parameter. Renamed "jCard deprecated" stage into "jCard deprecation". Rephrased . Corrected JSContact examples based on draft-ietf-calext-jscontact-11. Fixed nits.

Fixed , , and to make them compliant with draft-ietf-calext-jscontact-16 and purge them of the JSContact properties which are hardly used in RDAP. Rearranged . Added other mapping correspondences to .