RFC draft-ietf-calext-jscontact-profiles-03 | JSContact Profiles | July 2025 |
Stepanek & Loffredo | Expires 26 January 2026 | [Page] |
This document defines JSContact profiles, a named subsets of JSContact elements that are supported in context of a contact data exchange protocol or other use case. It aims to facilitate using JSContact in contexts where supporting all of JSContact semantics is not appropriate.¶
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 26 January 2026.¶
Copyright (c) 2025 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.¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
The ABNF definitions in this document use the notations of [RFC5234]. ABNF rules not defined in this document are defined in either [RFC5234] (such as the ABNF for CRLF, WSP, DQUOTE, VCHAR, ALPHA, and DIGIT) or [RFC6350].¶
The JSContact [RFC9553] contact card data model and format is designed for use in address book applications and directory services. Intended as an alternative to the prevalent vCard [RFC6350] data format, it covers vCard core semantics and extensions, and provides a rich model for personal names, postal addresses and localization. All JSContact elements are relevant for some contact card use case and, similar to vCard, implementations are expected to support these elements when exchanging contact card information using protocols such as CardDAV [RFC6352] and JMAP for Contacts [RFC9610].¶
In contrast, other protocols and internet standards might require to exchange some contact card information, but not need all of what JSContact provides. Section 1.7.4 of [RFC9553] outlines how JSContact implementations may ignore unknown JSContact elements, but this only applies to future extensions of [RFC9553]; they are still expected to implement all elements of the core specification. Also, the extensibility of JSContact and the requirement to preserve arbitrary contact elements might not be adequate for some protocols.¶
To make use of JSContact under these circumstances, this document defines a new IANA registry for JSContact that allows to register named subsets of JSContact elements. These subsets are referred to as "JSContact profiles" and are meant to bring the following benefits:¶
This document is organized as follows: Section 3 defines JSContact profiles, Section 4 illustrates JSContact profiles by example, Section 5 summarizes the relevant information for IANA to establish the JSContact Profiles registry.¶
A JSContact profile is a named, versioned subset of JSContact properties, value types and values. These JSContact elements MUST be registered in the IANA JSContact registry. A JSContact extension MAY define both a new profile and new properties or other elements, as long as they are registered at the same time. A JSContact profile MUST be registered at IANA (see Section 5). Section 3.1 and Section 3.2 define how to name and version a JSContact profile, Section 3.3 defines how to define the properties supported by that profile.¶
A JSContact object conforms to a profile if all its properties are in the subset of properties defined by that profile and the property values comply with the profile restrictions for that property.¶
This names the profiles, each JSContact profile MUST have a unique name. The name MUST only contain ASCII lowercase alphabetic and numeric characters, optionally separated by a hyphen. Formally, it MUST be a valid "profile-name" defined in the appendix section in Figure 1.¶
This defines the current version of the profile. Each profile is versioned independently and versions numbers also are not related to values in the IANA JSContact Versions registry. The version identifier MUST be a valid "jsversion" value as defined in Section 1.9.1 of [RFC9553]. Any addition to the list of JSContact properties supported by that profile (Section 3.3) MUST update the current version.¶
As a note, if a semantic versioning scheme is not adequate for protocol designers making use of JSContact profiles, then an alternative approach is to register a new JSContact profile for each new version.¶
A profile defines a list of property entries to define the set of properties supported by that profile. Each entry consists of the following elements:¶
There MUST NOT an entry for the "@type" property, it always is supported for any JSContact object in any profile. Similarly, there MUST NOT be an entry for the "version" property of the Card object, it also is supported by any profile.¶
The set of supported JSContact properties is then determined by the property entries as follows:¶
A Card object is supported by the profile, if all its properties are part of the set of supported properties and all property values are valid according to the restrictions defined in the applicable property entries.¶
This section provides an example for a JSContact profile, as it would be registered in the IANA JSContact Profiles registry. See Section 5.1.1 and Section 5.1.2 for the exact meaning of each registry item. This profile is just for illustration, it is not registered at IANA.¶
Property Name | Property Context | Restricted to be Mandatory | Restricted Property Type | Restricted Enum Values | Restricted PatchObject Keys | Since Profile Version |
---|---|---|---|---|---|---|
addresses | Card | 1.0 | ||||
emails | Card | 1.0 | ||||
kind | Card | individual,org | 1.0 | |||
localizations | Card | Yes | 1.0 | |||
name | Card | 1.0 | ||||
full | Address | mandatory | 1.0 | |||
components | Name | 1.0 | ||||
full | Name | 1.0 | ||||
kind | NameComponent | 1.0 | ||||
value | NameComponent | 1.0 |
This profile describes contact cards that can only contain:¶
The following Card object conforms to that profile:¶
{ "@type": "Card", "version": "1.0", "name": { "components": [ { "kind": "given", "value": "Hayao" }, { "kind": "surname", "value": "Miyazaki" } ] }, "addresses": { "a1": { "full": "71 Cherry Court, Somewhere, 123SO, UK" } }, "emails": { "e1": { "address": "hayao@example.com" } }, "localizations": { "jp": { "name": { "components": [ { "kind": "surname", "value": "宮崎" }, { "kind": "given", "value": "駿" } ] } } } }¶
IANA will add the "JSContact Profile" registry to the "JSContact" registry group originally created in Section 3.2 of [RFC9553]. The purpose of this new registry is to describe protocol-specific profiles for JSContact data. The registry policy and change procedure of the "JSContact" registry group apply.¶
This template defines how to register a new JSContact profile. It consists of the following items:¶
Section 3.1 and Section 3.2 define the Profile Name and Profile Version item, respectively. For the Properties item, IANA will create a subregistry for each profile name (e.g. "Properties for xyz"), listing the properties supported by that profile. Each entry in that list is registered using the template defined in Section 5.1.2.¶
This template consists of the following items:¶
See Section 3.3 for the definitions of these items.¶
This document does define not any initial contents for the newly created registries.¶
This document does not provide new security considerations. The security considerations of Section 4 of [RFC9553] apply.¶
profile-name = LALPHA *[ ["-"] LALPHA ] LALPHA = %x61-7A | DIGIT ; a-z or 0-9