Internet-Draft JSContact June 2023
Stepanek & Loffredo Expires 4 December 2023 [Page]
Workgroup:
Calendaring Extensions
Internet-Draft:
draft-ietf-calext-jscontact-11
Published:
Intended Status:
Standards Track
Expires:
Authors:
R. Stepanek
Fastmail
M. Loffredo
IIT-CNR

JSContact: A JSON representation of contact data

Abstract

This specification defines a data model and JSON representation of contact card 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 to the JSON-based jCard format, it is not a direct mapping from the vCard data model and expands semantics where appropriate.

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 4 December 2023.

▲

Table of Contents

1. Introduction

This document defines a data model for contact card data normally used in address book or directory applications and services. It aims to be an alternative to the vCard data format [RFC6350].

The key design considerations for this data model are as follows:

The representation of this data model is defined in the I-JSON format [RFC7493], which is a strict subset of the JavaScript Object Notation (JSON) Data Interchange Format [RFC8259]. Using JSON is mostly a pragmatic choice: its widespread use makes JSContact easier to adopt, and the availability of production-ready JSON implementations eliminates a whole category of parser-related interoperability issues.

1.1. Motivation and Relation to vCard, jCard and xCard

The vCard data format [RFC6350] is an interchange format for contacts data between address book service providers and vendors. However, this format has gone through multiple specifications iterations with only a subset of its deprecated version 3 [RFC2426] being widely in use. As a consequence, products and services internally use a richer contact data model than they expose when serializing that information to vCard. In addition, service providers often use a proprietary JSON representation of contact data in their APIs.

JSContact provides a standard JSON-based data model and representation of contact data as an alternative to proprietary formats.

While writing this document, several features missing in vCard were brought to the attention of the authors, such as social media contacts, gender pronouns and others. This highlights how vCard is not perceived as an evolving format and consequently hasn't been updated since close to ten years. JSContact addresses these unmet demands and defines new vCard properties and parameters to allow interchanging them in both formats.

The xCard [RFC6351] and jCard [RFC7095] specifications define alternative representations for vCard data, in XML and JSON format respectively. Both explicitly aim to not change the underlying data model. Accordingly, they are regarded as equal to vCard in the context of this document.

1.2. Notational Conventions

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 either are defined in [RFC5234] (such as the ABNF for CRLF, WSP, DQUOTE, VCHAR, ALPHA, and DIGIT) or [RFC6350].

1.3. Data Type Notations

This section introduces the notations and terminology used to define data types in JSContact.

The underlying format for JSContact is JSON and so also its data types build on JSON values. The terms "object" and "array" as well as the four primitive types ("strings", "numbers", "booleans", and "null") are to be interpreted as described in Section 1 of [RFC8259]. All JSContact data MUST be valid according to the constraints given in I-JSON [RFC7493]. Unless otherwise noted, all member names in JSON objects are case sensitive. Within context of JSON objects, the term "key" is synonymous with "member name" as defined in Section 1 of [RFC8259].

1.3.1. Objects and Properties

JSContact defines data types for contact information such as addresses or names. This information typically consists of multiple related elements, for example a personal name and surname together form a name. These related elements are organized in JSContact objects. A JSContact object is a JSON object which:

  1. Has a unique type name registered in the IANA JSContact Types Registry (Section 4.6).
  2. Has one or more object members for which the name and allowed value types are specified. Such members are called "properties".
  3. Has one property named @type with a string value that matches the type name of this JSContact object. In general, this property does not need to be set explicitly as outlined in Section 1.3.4.

The following sections specify how to define JSContact object types. Section 1.7 and Section 1.8 then define the exact requirements for property names.

The next paragraph illustrates how a JSContact object is defined:

A Foo object has the following properties:

  • qux: Number (mandatory). Defines the qux-ishness of this contact. The value MUST be an integer greater than 0 and less than 10.

Here, a JSContact object type named Foo is defined. In addition to its @type property it has a property named qux for which values MUST be valid according to the definition of the Number type. The property has one attribute, mandatory, which specifies that the property MUST be present for an instance of this JSContact object to be valid. Finally, a free-text description describes the semantics and further restrictions.

1.3.2. Type Signatures

Type signatures are given for all JSON values and JSContact definitions in this document. The following conventions are used:

  • String - The JSON string type.
  • Number - The JSON number type.
  • Boolean - The JSON boolean type.
  • A[B] - A JSON object where the keys are all of the type A, and the values are all of the type B.
  • A[] - A JSON array of values of type A.
  • A|B - The value is either of type A or of type B.
  • * - The type is undefined (the value could be any type, although permitted values may be constrained by the context of this value).

Section 1.4 defines common data types, including signed or unsigned integers and dates.

1.3.3. Property Attributes

Object properties may also have a set of attributes defined along with the type signature. These have the following meanings:

  • mandatory: The property MUST be set for an instance of this object to be valid.
  • optional: The property can but not need be set for an instance of this object to be valid.
  • default: This is followed by a JSON value. That value will be used for this property if it is omitted.
  • defaultType: This is followed by the name of a JSContact object type. A property value of JSContact object type is expected to be of this named type, in case it omits the @type property.

1.3.4. The @type Property

This property is defined as:

  • @type: String. Specifies the type of this object. This MUST match the type name of the JSContact object of which this JSON object is an instance of.

The purpose of this property is to help implementations identify which JSContact object type a given JSON object represents. Implementations MUST validate that JSON objects with this property conform to the specification of the JSContact object type of that name.

In many cases the @type property value is implied by where its object occurs in JSContact data. Assuming that both A and B are JSContact object types:

  • An object that is set as the value for a property with type signature A MAY have the @type property set. If the @type property is not set, its value is implied to be A by the property definition.
  • An object that is set as the value for a property with type signature A|B (defaultType: A) MAY have the @type property set if it is an instance of A. It MUST have the @type property set if it is an instance of B. If instead the defaultType attribute is not defined then the @type property MUST also be set for A.
  • An object that is not the value of a property, such at the root of JSON data (directly or as member of an array), MUST have the @type property set.

1.4. Common Data Types

In addition to the standard JSON data types, a couple of additional data types are common to the definitions of JSContact objects and properties.

1.4.1. Id

Where Id is given as a data type, it means a String of at least 1 and a maximum of 255 octets in size, and it MUST only contain characters from the URL and Filename Safe base64url alphabet, as defined in Section 5 of [RFC4648], excluding the pad character (=). This means the allowed characters are the ASCII alphanumeric characters (A-Za-z0-9), hyphen (-), and underscore (_).

In many places in JSContact a JSON map is used where the map keys are of type Id and the map values are all the same type of object. This construction represents an unordered set of objects, with the added advantage that each entry has a name (the corresponding map key). This allows for more concise patching of objects, and, when applicable, for the objects in question to be referenced from other objects within the JSContact object. The map keys MUST be preserved across multiple versions of the JSContact object.

Unless otherwise specified for a particular property, there are no uniqueness constraints on an Id value (other than, of course, the requirement that you cannot have two values with the same key within a single JSON map). For example, two Card (Section 2) objects might use the same Ids in their respective photos properties. Or within the same Card the same Id could appear in the emails and phones properties. These situations do not imply any semantic connections among the objects.

1.4.2. Int and UnsignedInt

Where Int is given as a data type, it means an integer in the range -253+1 <= value <= 253-1, the safe range for integers stored in a floating-point double, represented as a JSON Number.

Where UnsignedInt is given as a data type, it means an integer in the range 0 <= value <= 253-1, represented as a JSON Number.

1.4.3. PatchObject

A PatchObject is of type String[*], and represents an unordered set of patches on a JSON object. Each key is a path represented in a subset of JSON pointer format [RFC6901]. The paths have an implicit leading /, so each key is prefixed with / before applying the JSON pointer evaluation algorithm.

A patch within a PatchObject is only valid if all the following conditions apply:

  1. The pointer MUST NOT reference inside an array (i.e., you MUST NOT insert/delete from an array; the array MUST be replaced in its entirety instead).
  2. All parts prior to the last (i.e., the value after the final slash) MUST already exist on the object being patched.
  3. There MUST NOT be two patches in the PatchObject where the pointer of one is the prefix of the pointer of the other, e.g., addresses/1/city and addresses.
  4. The value for the patch MUST be valid for the property being set (of the correct type and obeying any other applicable restrictions), or if null the property MUST be optional.

The value associated with each pointer determines how to apply that patch:

  • If null, remove the property from the patched object. If the key is not present in the parent, this a no-op.
  • If non-null, set the value given as the value for this property (this may be a replacement or addition to the object being patched).

A PatchObject does not define its own @type (Section 1.3.4) property. Instead, a @type property in a patch MUST be handled as any other patched property value.

Implementations MUST reject in its entirety a PatchObject if any of its patches are invalid. Implementations MUST NOT apply partial patches.

1.4.4. Resource

This data type defines a resource associated with the entity represented by this Card, identified by a URI [RFC3986]. Several property definitions later in this document refer to the Resource data type as the basis for their property-specific value types. The Resource data type defines the properties that are common to all of them. Property definitions making use of Resource MAY define additional properties for their value types.

The @type property value MUST NOT be Resource, instead it MUST be the name of a concrete resource type (see Section 2.6). A Resource object has the following properties.

  • @type: String. Specifies the type of this resource object. The allowed value is defined in later sections of this document for each concrete resource type (Section 2.6).

  • kind: String (optional). The kind of the resource. The allowed values are defined in the property definition that makes use of the Resource type.

  • uri: String (mandatory). The resource value. This MUST be a URI as defined in Section 3 of [RFC3986] and updates.
  • mediaType: String (optional). Used for URI resource values. Provides the media type [RFC2046] of the resource identified by the URI.
  • contexts: String[Boolean] (optional). The contexts in which to use this resource. Also see Section 1.5.1.
  • pref: UnsignedInt (optional). The preference of this resource in relation to other resources. Also see Section 1.5.3.
  • label: String (optional). A custom label for the value, see Section 1.5.2.

1.4.5. UTCDateTime

This is a string in [RFC3339] date-time format, with the further restrictions that any letters MUST be in uppercase, and the time offset MUST be the character Z. Fractional second values MUST NOT be included unless non-zero and MUST NOT have trailing zeros, to ensure there is only a single representation for each date-time.

For example, 2010-10-10T10:10:10.003Z is conformant, but 2010-10-10T10:10:10.000Z is invalid and is correctly encoded as 2010-10-10T10:10:10Z.

1.5. Common Properties

Most of the properties in this document are specific to a single JSContact object type. Such properties are defined along with the respective object type. The properties in this section are common to multiple data types and are defined here to avoid repetition. Note that these properties MUST only be set for a JSContact object if they are explicitly mentioned to be allowed for this object type.

1.5.1. The contexts Property

Type: String[Boolean]

This property associates contact information with one or more contexts in which it should be used. For example, someone might have distinct phone numbers for work and private contexts, and may set the desired context on the respective phone number in the phones (Section 2.3.4) property.

This section defines common contexts. Additional contexts may be defined in the properties or data types that make use of this property. The enumerated (Section 1.7.3) common context values are:

  • private: The contact information may be used to contact in a private context.
  • work: The contact information may be used to contact in a professional context.

1.5.2. The label Property

Type: String

This property allows associating contact data with user-defined labels. Such labels may be set for phone numbers, email addresses and resources. Typically, these labels are displayed along with their associated contact data in graphical user interfaces. Such labels best be succinct to properly display on small graphical interfaces and screens.

1.5.3. The pref Property

Type: UnsignedInt

This property allows defining a preference order for contact information. For example, a person may have two email addresses and prefer to be contacted with one of them.

Its value MUST be in the range 1 and 100. Lower values correspond to a higher level of preference, with 1 being most preferred. If no preference is set, then the contact information MUST be interpreted as being least preferred.

Note that the preference only is defined in relation to contact information of the same type. For example, the preference orders within emails and phone numbers are independent of each other.

1.6. Versioning

Every instance of a JSContact Card (Section 2) indicates which JSContact version its IANA-registered properties and values are based on. The version is indicated both in the @version (Section 2.1.2) property within the Card and in the version (Section 4.1) parameter of the JSContact MIME content type. All IANA-registered elements indicate the version at which they got introduced or obsoleted.

1.6.1. Version Format and Requirements

A JSContact version consists of a numeric major and minor version, separated by the FULL STOP character (U+002E). Later versions are numerically higher than former versions, with the major version being more significant than the minor version. A version value is produced by the ABNF

jsversion = 1*DIGIT "." 1*DIGIT

Differing major version values indicate substantial differences in JSContact semantics and format. Implementations MUST be prepared that property definitions and other JSContact elements differ in a backwards-incompatible manner.

Differing minor version values indicate additions that enrich JSContact data, but do not introduce backwards-incompatible changes. Typically, these are new property enum values or properties with narrow semantic scope. A new minor version MUST NOT require implementations to change their processing of JSContact data. Changing the major version number resets the minor version number to zero.

1.6.2. Current Version

This specification registers JSContact version value 1.0 (Table 1).

1.7. Validating JSContact

This specification distinguishes between three kinds of properties regarding validation: IANA-registered properties and unknown properties are defined in this section, while vendor-specific properties are defined in Section 1.8.1. A JSContact object is invalid if any of its properties are invalid.

This document defines for each property if it is mandatory or optional. A mandatory property MUST be present for a JSContact object to be valid. An optional property does not need to be present. The values of both required and optional properties MUST adhere to the data type and definition of that property.

1.7.1. IANA-registered Properties

An IANA-registered property is any property that has been registered according to the IANA property registry rules as outlined in Section 4. All properties defined in this specification, including their object value types and enumerated values, are registered at IANA.

Implementations MUST validate IANA-registered properties in JSContact data, unless they are unknown to the implementation (see Section 1.7.2). They MUST reject invalid IANA-registered properties. A property is invalid if its name matches the name of an IANA-registered property but the value violates its definition according to the JSContact specification version defined in the Card @version property (Section 2.1.2).

IANA-registered property names MUST NOT contain US-ASCII control characters (U+0000 to U+001F, U+007F), the COLON (U+003A) or QUOTATION MARK (U+0022) characters. They MUST only contain US-ASCII alphanumeric characters that match the ALPHA and DIGIT rules defined in Appendix B.1 of [RFC5234]) or the COMMERCIAL AT (U+0040) character. IANA-registered property names MUST be notated in lower camel case.

1.7.2. Unknown Properties

Implementations may encounter JSContact data where a property name is unknown to that implementation, but the name adheres to the syntactic restrictions of IANA-registered property names. Implementations MUST NOT treat such properties as invalid. Instead, they MUST preserve them in the JSContact object. Implementations that create or update JSContact data MUST only set IANA-registered properties or vendor-specific properties. Preserving properties that are unknown to the implementation, is to allow applications and services to interoperate without data loss, even if not all of them implement the same set of JSContact extensions.

1.7.3. Enumerated Values

Several properties in this document restrict their allowed values to be from a list of String values. If not noted otherwise for a specific property, the initial list of values for such properties is registered at IANA in the JSContact Enum Values Registry (Section 4.7). Implementations MUST only set IANA-registered or vendor-specific (Section 1.8.2) values for such properties.

1.8. Vendor-Specific Extensions

Vendors may extend properties and values for experimentation or to store contacts data that only is useful for a single service or application. Such extensions are not meant for interoperation. If instead interoperation is desired, vendors are strongly encouraged to define and register new properties, types and values at IANA. Section 4 defines how to register new properties, types or values at IANA. Section 1.7.1 defines the naming conventions for IANA-registered elements.

1.8.1. Vendor-specific Properties

Vendor-specific property names MUST start with a vendor-specific prefix followed by a name, as produced by the v-extension ABNF below. The vendor-specific prefix MUST be a domain name under control of the service or application that sets the property, but it need not resolve in the Domain Name System [RFC1034] and [RFC1035]. The prefix ietf.org and its subdomain names are reserved for IETF specifications. The name MUST NOT contain the TILDE (U+007E) and SOLIDUS (U+002F) characters, as these require special-escaping when encoding a JSON Pointer [RFC6901] for that property.

Vendor-specific properties MAY be set in any JSContact object. Implementations MUST preserve vendor-specific properties in JSContact data, irrespective if they know their use. They MUST NOT reject the property value as invalid, unless they are in control of the vendor-specific property as outlined in the above paragraph.

The ABNF rule v-extension formally defines valid vendor-specific property names. Note that the vendor prefix allows for more values than are allowed as Internationalized Domain Names (IDN) [RFC8499]. This is to allow JSContact implementations simply validate property names without implementing the full set of rules that apply to domain names.

v-extension = v-prefix ":" v-name

v-prefix = v-label *("." v-label)

v-label = alnum-int / alnum-int *(alnum-int / "-") alnum-int

alnum-int = ALPHA / DIGIT / NON-ASCII
  ; see RFC 6350 Section 3.3

v-name = 1*(WSP / "!" / %x23-2e / %x30-7d / NON-ASCII)
  ; any characters except CTLs, DQUOTE, SOLIDUS and TILDE
Figure 1: ABNF rules for vendor-specific property names

The value of vendor-specific properties can be any valid JSON value, and naming restrictions do not apply to such values. Specifically, if the property value is a JSON object then the keys of such objects need not be named as vendor-specific properties. The example in Figure 2 illustrates this:

"example.com:foo": "bar",
"example.com:foo2": {
  "bar": "baz"
}
Figure 2: Examples of vendor-specific properties

1.8.2. Vendor-specific Values

Some JSContact IANA-registered properties allow their values to be vendor-specific. One such example is the kind property Section 2.1.4, which enumerates its standard values but also allows for arbitrary vendor-specific values. Such vendor-specific values MUST be valid v-extension values as defined in Section 1.8.1. The example in Figure 3 illustrates this:

"kind": "example.com:baz"
Figure 3: Example of a vendor-specific value

Vendors are strongly encouraged to specify a new standard value once a vendor-specific one turns out to be useful also for other systems.

1.9. Reserved Property Names

This specification reserves the property name extra at IANA. Its sole purpose is to provide implementors with an internal variable name which is certain to never occur as a property name in a JSContact object. Implementations might want to map unknown or vendor-specific properties to a variable with this name, but this is implementation-specific. Any JSContact object including a property with this name is invalid.

2. Card

This section defines the JSContact object type Card. A Card stores contact information, typically that of a person, organization or company.

Its media type is defined in Section 4.1.

Figure 4 basic Card for the person "John Doe". As the object is the topmost object in the JSON data it has the @type property set according to the rules defined Section 1.3.4.

{
  "@type": "Card",
  "@version": "1.0",
  "uid": "22B2C7DF-9120-4969-8460-05956FE6B065",
  "kind": "individual",
  "name": {
    "components": [{
      "kind": "given",
      "value": "John"
    }, {
      "kind": "surname",
      "value": "Doe"
    }]
  }
}
Figure 4: Example of a basic Card

2.1. Metadata Properties

This section defines properties about this particular instance of a Card, such as its unique identifier, its creation date, how it relates to other Cards and other metadata information.

2.1.1. @type

Type: String (mandatory).

This MUST be Card, if set.

2.1.2. @version

Type: String (mandatory).

Specifies the JSContact version used to define this Card. The value MUST be one of the IANA-registered JSContact Enum Values for the @version property. Also see Section 1.6.2.

"@version": "1.0"
Figure 5: @version example

2.1.3. created

Type: UTCDateTime (optional).

The date and time when this Card was created.

"created": "2022-09-30T14:35:10Z",
Figure 6: created example

2.1.4. kind

Type: String (optional). The kind of the entity the Card represents.

The enumerated (Section 1.7.3) values are:

  • individual: a single person
  • group: a group person of persons or entities
  • org: an organization
  • location: a named location
  • device: a device, such as appliances, computers, or network elements
  • application: a software application 
"kind": "individual",
Figure 7: kind example

2.1.5. language

Type: String (optional).

This is the language tag, as defined in [RFC5646], that best describes the language used for text in the Card. Note that such values MAY be localized in the localizations property Section 2.7.1.

"language": "de-AT",
Figure 8: language example

2.1.6. members

Type: String[Boolean] (optional).

This identifies the set of Cards that are members of this group Card. Each key in the set is the uid property value of the member, each boolean value MUST be true. If this property is set, then the value of the kind property MUST be group.

The opposite is not true. A group Card will usually contain the members property to specify the members of the group, but it is not required to. A group Card without the members property can be considered an abstract grouping, or one whose members are known empirically (e.g. "IETF Participants").

"kind": "group",
"fullName": "The Doe family",
"uid": "urn:uuid:ab4310aa-fa43-11e9-8f0b-362b9e155667",
"members": {
  "urn:uuid:03a0e51f-d1aa-4385-8a53-e29025acd8af": true,
  "urn:uuid:b8767877-b4a1-4c70-9acc-505d3819e519": true
}
Figure 9: members example

2.1.7. prodId

Type: String (optional).

The identifier for the product that created the Card. If set, the value MUST be at least one character long.

"prodId": "ACME Contacts App version 1.23.5"
Figure 10: prodId example

2.1.8. relatedTo

Type: String[Relation] (optional).

Relates the object to other Cards. This is represented as a map, where each key is the uid of the related Card and the value defines the relation. The Relation object has the following properties:

  • @type: String. This MUST be Relation, if set.
  • relation: String[Boolean] (optional, default: empty Object) Describes how the linked object is related to the linking object. The relation is defined as a set of relation types. If empty, the relationship between the two objects is unspecified. The keys in the set MUST be IANA-registered TYPE parameter values for the vCard RELATED property in the vCard Parameter Values [IANAvCard] registry, or a vendor-specific value (Section 1.8.1). The value for each key in the set MUST be true. 
"relatedTo": {
  "urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6": {
    "relation": {
      "friend": true
    }
  },
  "8cacdfb7d1ffdb59@example.com": {
    "relation": {}
  }
}
Figure 11: relatedTo example

2.1.9. uid

Type: String (mandatory).

An identifier, used to associate the object as the same across different systems, address books and views. The value SHOULD be a URN [RFC8141] but for compatibility with [RFC6350] it MAY also be a URI [RFC3986] or free-text value. The value of the URN SHOULD be in the uuid namespace [RFC4122]. As of this writing, a revision [I-D.ietf-uuidrev-rfc4122bis] of the UUID standard document is being worked on and is likely to introduce new UUID versions and best practices to generate global unique identifiers. Implementors SHOULD follow any recommendations described there. Until then, implementations SHOULD generate identifiers using the random or pseudo-random UUID version described in Section 4.4 of [RFC4122].

"uid": "urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
Figure 12: uid example

2.1.10. updated

Type: UTCDateTime (optional).

The date and time when the data in this Card was last modified.

"updated": "2021-10-31T22:27:10Z"
Figure 13: updated example

2.2. Name and Organization Properties

This section defines properties that name the entity represented by this Card, its related organizations and roles, as well as how to refer the entity represented by this Card in spoken or written language.

2.2.1. fullName

Type: String (optional).

This is the full name of the entity represented by this Card. The purpose of this property is to define a name even if the individual name components are not known. If the name property is set, the fullName property SHOULD NOT be set.

"fullName": "Mr. John Q. Public, Esq."
Figure 14: fullName example

2.2.2. name

Type: Name (optional).

The name of the entity represented by this Card. This can be any type of name, e.g. it can but need not be the legal name of a person. The definition of the fullName (Section 2.2.1) property describes how the name and fullName properties relate.

A Name object has the following properties

  • @type: String. This MUST be Name, if set.

  • components: NameComponent[] (mandatory). The components making up the name. The component list MUST have at least one entry.

    Name components SHOULD be ordered such that their values joined as a String produce a valid full name of this entity. The defaultSeparator property and name components of kind separator give guidance what characters to insert between components, but implementations are free to choose any others. In lack of a separator, inserting a single Space character in between name component values is a good choice.

  • defaultSeparator: String (optional). The default separator to insert between name component values when concatenating all name component values to a single String. Also see the definition of the separator kind for the NameComponent object.

  • sortAs: String[String] (optional).

    This defines how this name lexicographically sorts in relation to other names when compared by a name component type. The key in the map defines the name component type. The value for that key defines the verbatim string to compare when sorting by this name component type. Absence of a key indicates that this name component type should not be considered during sort. Sorting by that missing name component type or if the sortAs property is not set is implementation-specific.

    Each key in the map MUST be a valid name component type value as defined for the kind property of the NameComponent object (see below). For each key in the map there MUST exist at least one NameComponent object having that type in the components property of this name.

    Figure 15 illustrates the use of sortAs. The property value indicates that the middle name followed by both surnames should be used when sorting this name by surname. The absence of the middle indicates that the middle name on its own should be disregarded during sort. Even though the name only contains one name component for the given name, the sortAs property still explicitly defines how to sort by given name as otherwise sorting by it would be undefined.

    "name": {
  "components": [
    {
      "kind": "given",
      "value": "Robert"
    },
    {
      "kind": "middle",
      "value": "Pau"
    },
    {
      "kind": "surname",
      "value": "Shou"
    },
    {
      "kind": "surname",
      "value": "Chang"
    }
  ],
  "sortAs": {
    "surname": "Pau Shou Chang",
    "given": "Robert"
  }
}
    Figure 15: name example

A NameComponent object has the following properties:

  • @type: String. This MUST be NameComponent, if set.
  • value: String (mandatory). The value of this name component.

  • kind: String (mandatory). The kind of this name component. The enumerated (Section 1.7.3) values are:

    • prefix. The value is an honorific title(s), e.g. "Mr", "Ms", "Dr".
    • given. The value is a given name, also known as "first name", "personal name".
    • surname. The value is a surname, also known as "last name", "family name".
    • middle. The value is a middle name, also known as "additional name".
    • suffix. The value is an honorific suffix, e.g. "B.A.", "Esq.".
    • separator. A formatting separator for two name components. The value property of the component includes the verbatim separator, for example a hyphen character or even an empty string. This value has higher precedence than the defaultSeparator property of the Name.

  • rank: UnsignedInt (optional, default: 1). Defines the rank of this name component to other name components of the same type. If set, the property value MUST be higher than or equal to 1.

    For example, two name components of type surname may have their rank property value set to 1 and 2, respectively. In this case, the first name component defines the surname, and the second name component the secondary surname.

    Note that this property value does not indicate the order in which to print name components of the same type. Some cultures print the secondary surname before the first surname, others the first before the second. Implementations MAY inspect the language property of the Card to determine the appropriate formatting. They MAY print name components in order of appearance in the components property of the Name object.

2.2.3. nickNames

Type: Id[NickName] (optional).

The nicknames of the entity represented by this Card. A NickName object has the following properties:

  • @type: String. This MUST be NickName, if set.
  • name: String (mandatory). The nickname.
  • contexts: String[Boolean] (optional) The contexts in which to use this nickname. Also see Section 1.5.1.
  • pref: UnsignedInt (optional). The preference of this nickname in relation to other nicknames. Also see Section 1.5.3. 
"nickNames": {
  "k391": {
    "name": "Johnny"
  }
}
Figure 16: nickNames example

2.2.4. organizations

Type: Id[Organization] (optional).

The companies or organization names and units associated with this Card. An Organization object has the following properties, of which at least one of the name and units properties MUST be set:

  • @type: String. This MUST be Organization, if set.
  • name: String (optional). The name of this organization.
  • units: OrgUnit[] (optional). A list of organizational units, ordered descending by hierarchy (e.g. a geographic or functional division sorts before a department within that division). If set, the list MUST contain at least one entry.
  • sortAs: String (optional). This defines how this organization name lexicographically sorts in relation to other organizations when compared by name. The value defines the verbatim string value to compare. In absence of this property, the name property value MAY be used for comparison.
  • contexts: String[Boolean] (optional). The contexts in which association with this organization apply. For example, membership in a choir may only apply in a private context. Also see Section 1.5.1.

A OrgUnit object has the following properties:

  • @type: String. This MUST be OrgUnit, if set.
  • name: String (mandatory). The name of this organizational unit.
  • sortAs: String (optional). This defines how this organization unit name lexicographically sorts in relation to other organizational units of the same level when compared by name. The level is defined by the array index of this organizational unit in the units property of the Organization object. The property value defines the verbatim string value to compare. In absence of this property, the name property value MAY be used for comparison. 
"organizations": {
  "o1": {
    "name": "ABC, Inc.",
    "units": [
      {
        "name": "North American Division"
      },
      {
        "name": "Marketing"
      }
    ],
    "sortAs": "ABC"
  }
}
Figure 17: organizations example

2.2.5. speakToAs

Type: SpeakToAs (optional).

Provides information how to address, speak to or refer to the entity that is represented by this Card. A SpeakToAs object has the following properties, of which at least one of the grammaticalGender and pronouns properties MUST be set:

  • @type: String. This MUST be SpeakToAs, if set.

  • grammaticalGender: String (optional). Defines which grammatical gender to use in salutations and other grammatical constructs. For example, the German language distinguishes by grammatical gender in salutations such as "Sehr geehrte" (feminine) and "Sehr geehrter" (masculine). The enumerated (Section 1.7.3) values are:

    • animate
    • common
    • feminine
    • inanimate
    • masculine
    • neuter

    Note that the grammatical gender does not allow inferring the gender identities or assigned sex of the contact.

  • pronouns: Id[Pronouns] (optional). Defines the pronouns that the contact chooses to use for themselves.

A Pronouns object has the following properties:

  • @type: String. This MUST be Pronouns, if set.
  • pronouns: String (mandatory). Defines the pronouns. Any value or form is allowed. Examples in English include she/her and they/them/theirs. The value MAY be overridden in the localizations property (Section 2.7.1).
  • contexts: String[Boolean] (optional). The contexts in which to use these pronouns. Also see Section 1.5.1.
  • pref: UnsignedInt (optional). The preference of these pronouns in relation to other pronouns in the same context. Also see Section 1.5.3. 
"speakToAs": {
  "grammaticalGender": "neuter",
  "pronouns": {
    "k19": {
      "pronouns": "they/them",
      "pref": 2
    },
    "k32": {
      "pronouns": "xe/xir",
      "pref": 1
    }
  }
}
Figure 18: speakToAs example

2.2.6. titles

Type : Id[Title] (optional).

The job titles or functional positions of the entity represented by this Card. A Title object has the following properties:

  • @type: String. This MUST be Title, if set.
  • name: String (mandatory). The title or role name of the entity represented by this Card.

  • kind: String (optional, default title). Describes the organizational or situational kind of this title. Some organizations and individuals distinguish between titles as organizational positions and roles as more temporary assignments, such as in project management.

    The enumerated (Section 1.7.3) values are:

  • organization: Id (optional). The identifier of the organization in which this title is held. 
"titles": {
  "le9": {
    "kind": "title",
    "name": "Research Scientist"
  },
  "k2": {
    "kind": "role",
    "name": "Project Leader",
    "organization": "o2"
  }
},
"organizations": {
  "o2": {
    "name": "ABC, Inc."
  }
}
Figure 19: titles example

2.3. Contact Properties

This section defines properties how to contact the entity represented by this Card.

2.3.1. contactBy

Type : String[ContactBy[]] (optional).

Defines which contact channel the entity represented by this Card prefers to be contacted with. The enumerated (Section 1.7.3) keys are:

The values in the object are a (possibly empty) list of preferences for this contact channel. A valid ContactBy object MUST have at least one of its properties other than the @type property set.

A ContactBy object has the following properties:

  • @type: String. This MUST be ContactBy, if set.
  • contexts: String[Boolean] (optional). Defines the contexts in which to use this contact channel. Also see Section 1.5.1.
  • pref: UnsignedInt (optional). Defines the preference of this contact channel in relation to other contact channels with the same contexts. Also see Section 1.5.3. 
"contactBy": {
  "emails": [
    {
      "pref": 1
    }
  ],
  "phones": [
    {
      "pref": 2
    }
  ]
}
Figure 20: contactBy example

2.3.2. emails

Type: Id[EmailAddress] (optional).

The email addresses to contact the entity represented by this Card. An EmailAddress object has the following properties:

  • @type: String. This MUST be EmailAddress, if set.
  • address: String (mandatory). The email address. This MUST be an addr-spec value as defined in Section 3.4.1 of [RFC5322].
  • contexts: String[Boolean] (optional). The contexts in which to use this email address. Also see Section 1.5.1.
  • pref: UnsignedInt (optional). The preference of this email address in relation to other email addresses. Also see Section 1.5.3.
  • label: String (optional). A custom label for the value, see Section 1.5.2. 
"emails": {
  "e1": {
    "contexts": {
      "work": true
    },
    "address": "jqpublic@xyz.example.com"
  },
  "e2": {
    "address": "jane_doe@example.com",
    "pref": 1
  }
}
Figure 21: emails example

2.3.3. onlineServices

Type: Id[OnlineService] (optional).

The online services that are associated with the entity represented by this Card. This can be messaging services, social media profiles, and other. An OnlineService object has the following properties, of which at least the uri or user property MUST be set:

  • @type: String. This MUST be OnlineService, if set.
  • service: String (optional). The name of the online service or protocol. The name MAY be capitalized the same as on the service's website, app or publishing material, but names MUST be considered equal is they match case-insensitively. Examples are GitHub, kakao, Mastodon.
  • uri: String (optional). This identifies the entity represented by this card at the online service. This MUST be a URI as defined in Section 3 of [RFC3986] and updates.
  • user: String (optional). This names the entity represented by this Card at the online service. Any free-text value is allowed. The service property SHOULD be set.
  • contexts: String[Boolean] (optional). The contexts in which to use this service. Also see Section 1.5.1.
  • pref: UnsignedInt (optional). The preference of this service in relation to other services. Also see Section 1.5.3.
  • label: String (optional). A custom label for the value, see Section 1.5.2. 
"onlineServices": {
  "x1": {
    "uri": "xmpp:alice@example.com",
  },
  "x2": {
    "service": "Mastodon",
    "user": "@alice@example2.com",
    "uri": "https://example2.com/@alice",
  }
}
Figure 22: onlineServices example

2.3.4. phones

Type: Id[Phone] (optional).

The phone numbers to contact the entity represented by this Card. A Phone object has the following properties:

  • @type: String. This MUST be Phone, if set.
  • number: String (mandatory). The phone number, as either a URI or free-text. Typical URI schemes are the [RFC3966] tel or [RFC3261] sip schemes, but any URI scheme is allowed.

  • features: String[Boolean] (optional). The set of contact features that this phone number may be used for. The set is represented as an object, with each key being a method type. The boolean value MUST be true. The enumerated (Section 1.7.3) method type values are:

    • voice The number is for calling by voice.
    • fax The number is for sending faxes.
    • pager The number is for a pager or beeper.
    • text The number supports text messages (SMS).
    • mobile The number is for a mobile phone.
    • textphone The number is for a device for people with hearing or speech difficulties.
    • video The number supports video conferencing.
    • main-number This number is the main phone number, such as the number of the front-desk at a company, as opposed to a direct-dial number of an individual employee.
  • contexts: String[Boolean] (optional). The contexts in which to use this number. Also see Section 1.5.1.
  • pref: UnsignedInt (optional). The preference of this number in relation to other numbers. Also see Section 1.5.3.
  • label: String (optional). A custom label for the value, see Section 1.5.2. 
"phones": {
  "tel0": {
    "contexts": {
      "private": true
    },
    "features": {
      "voice": true
    },
    "number": "tel:+1-555-555-5555;ext=5555",
    "pref": 1
  },
  "tel3": {
    "contexts": {
      "work": true
    },
    "number": "tel:+1-201-555-0123",
  }
}
Figure 23: phones example

2.3.5. preferredLanguages

Type : String[LanguagePref[]] (optional).

Defines the preferred languages for contacting the entity associated with this Card. The keys in the object MUST be [RFC5646] language tags. The values are a (possibly empty) list of contact language preferences for this language. A valid LanguagePref object MUST have at least one of its properties other than the @type property set.

A LanguagePref object has the following properties:

  • @type: String. This MUST be LanguagePref, if set.
  • contexts: String[Boolean] (optional). Defines the contexts in which to use this language. Also see Section 1.5.1.
  • pref: UnsignedInt (optional). Defines the preference of this language in relation to other languages of the same contexts. Also see Section 1.5.3. 
"preferredLanguages": {
  "en": [
    {
      "contexts": {
        "work": true
      },
      "pref": 1
    }
  ],
  "fr": [
    {
      "contexts": {
        "work": true
      },
      "pref": 2
    },
    {
      "contexts": {
        "private": true
      }
    }
  ]
}
Figure 24: preferredLanguages example

2.4. Calendaring and Scheduling Properties

This section defines properties how to schedule calendar events with the entity represented by this Card.

2.4.1. calendars

Type: Id[CalendarResource] (optional).

These are resources for calendaring, such as calendars to lookup free-busy information for the entity represented by this Card. A CalendarResource object has all properties of the Resource (Section 1.4.4) data type, with the following additional definitions:

  • The @type property value MUST be CalendarResource, if set.

The enumerated (Section 1.7.3) values are:

  • calendar The resource is a calendar that contains entries such as calendar events or tasks.
  • freeBusy The resource allows for free-busy lookups, for example to schedule group events. 
"calendars": {
  "calA": {
    "kind": "calendar",
    "uri": "webcal://calendar.example.com/calA.ics"
  },
  "project-a": {
    "kind": "freeBusy",
    "uri": "https://calendar.example.com/busy/project-a"
  }
}
Figure 25: calendars example

2.4.2. schedulingAddresses

Type: Id[SchedulingAddress] (optional).

The scheduling addresses by which the entity may receive calendar scheduling invitations. A SchedulingAddress object has the following properties:

  • @type: String. This MUST be SchedulingAddress, if set.

  • uri: String (mandatory). The address to use for calendar scheduling with this contact. This MUST be a URI as defined in Section 3 of [RFC3986] and updates.
  • contexts: String[Boolean] (optional). The contexts in which to use this scheduling address. Also see Section 1.5.1.
  • pref: UnsignedInt (optional). The preference of this scheduling address in relation to other scheduling address. Also see Section 1.5.3.
  • label: String (optional). A custom label for the scheduling address, see Section 1.5.2. 
"schedulingAddresses": {
  "sched1": {
    "uri": "mailto:janedoe@example.com"
  }
}
Figure 26: schedulingAddresses example

2.5. Address and Location Properties

This section defines properties for postal addresses and geographical locations associated with the entity represented by this Card.

2.5.1. addresses

Type: Id[Address] (optional).

A map of address identifiers to Address objects, containing physical locations. An Address object has the following properties:

  • @type: String. This MUST be Address, if set.

  • street: StreetComponent[] (optional). The street address. The concatenation of the component values SHOULD result in a valid street address for the address locale. What characters to insert between street components is specific to the locale. The defaultSeparator property and the separator StreetComponent kind give guidance what characters to insert, but implementations are free to choose any others. The definition of the fullAddress property describes how the street and fullAddress properties relate.

  • locality: String (optional). The municipality, city, town, village, post-town, or other locality within which the street address may be found.
  • region: String (optional). The administrative area, such as province, state, prefecture, county, canton, within which the locality may be found.
  • country: String (optional). The country name.
  • postcode: String (optional). The postal code, post code, ZIP code or other short code associated with the address by the relevant country's postal system.
  • countryCode: String (optional). The Alpha-2 or Alpha-3 ISO-3166-1 country code [ISO.3166-1.2006].
  • coordinates: String (optional). A [RFC5870] "geo:" URI for the address.
  • timeZone: String (optional). Identifies the time zone this address is located in. This MUST be a time zone name registered in the IANA Time Zone Database [IANATZ]

  • contexts: String[Boolean] (optional). The contexts of the address information. The boolean value MUST be true. In addition to the common contexts (Section 1.5.1), allowed key values are:

    • billing An address to be used for billing.
    • delivery An address to be used for delivering physical items.
  • fullAddress: String (optional). This is the full address, including street, region or country. The purpose of this property is to define an address, even if the individual address components are not known. If the street property is set, the fullAddress property SHOULD NOT be set.
  • defaultSeparator: String (optional). The default separator to insert between street component values when concatenating all street component values to a single String. Also see the definition of the separator kind for the StreetComponent object.
  • pref: UnsignedInt (optional). The preference of this address in relation to other addresses. Also see Section 1.5.3.

A StreetComponent object has the following properties:

  • @type: String. This MUST be StreetComponent, if set.

  • kind: String (mandatory). The kind of this street component. The enumerated (Section 1.7.3) values are:

    • district. The district name this street is located in.
    • block. The block name and number or subdistrict this street is located in.
    • name. The street name.
    • direction. The Cardinal direction, e.g. "North".
    • number. The street number, including a number range, prefix and suffix.
    • building. The building, tower, or condominium this address is located in.
    • floor. The floor or level this address is located on.
    • apartment. The apartment house or unit number or identifier.
    • room. The room or suite number or identifier.
    • extension. The extension designation or box number.
    • postOfficeBox. The post office box number or identifier.
    • landmark. The publicly known prominent feature that can substitute the street name and number, e.g. White House, Taj Mahal.
    • separator. A separator for two street components. The value property of the component includes the verbatim separator, for example a newline character or even an empty string. This value has higher precedence than the defaultSeparator property of the Address.
  • value: String (mandatory). The value of this street component. 
"addresses": {
  "k23": {
    "contexts": {
      "work": true
    },
    "fullAddress": "54321 Oak St\nReston\nVA\n20190",
    "street": [
      {
        "kind": "number",
        "value": "54321"
      },
      {
        "kind": "name",
        "value": "Oak St"
      }
    ],
    "locality": "Reston",
    "region": "VA",
    "country": "USA",
    "postcode": "20190",
    "countryCode": "US"
  }
}
Figure 27: Example of an address in the United States of America 
"addresses": {
  "k24": {
    "contexts": {
      "private": true
    },
    "fullAddress": "Irgendwostrasse 27/4/8\n1010\nVienna\nAustria"
    "street": [
      {
        "kind": "name",
        "value": "Irgendwostrasse"
      },
      {
        "kind": "number",
        "value": "27"
      },
      {
        "kind": "separator",
        "value": "/"
      },
      {
        "kind": "building",
        "value": "4"
      }
      {
        "kind": "separator",
        "value": "/"
      },
      {
        "kind": "apartment",
        "value": "8"
      }
    ],
    "locality": "Vienna",
    "country": "Austria",
    "postcode": "1010",
    "countryCode": "AT"
  }
}
Figure 28: Example of an address in Austria 
"addresses": {
  "fullAddress": "46, 1 Sukhumvit 51 Alley, Khlong Tan Nuea, Watthana, Bangkok 10110, Thailand"
  "k25": {
    "street": [
      {
        "kind": "number",
         "value": "46"
      },
      {
        "kind": "name",
        "value": "1 Sukhumvit 51 Alley"
      },
      {
        "kind": "block",
        "value": "Khlong Tan Nuea"
      },
      {
        "kind": "district",
        "value": " Watthana"
      }
    ],
    "locality": "Bangkok",
    "country": "Thailand",
    "postcode": "10110",
    "defaultSeparator": ", "
  }
}
Figure 29: Example of an address in Thailand 
"addresses": {
  "fullAddress": "3 Chome-7-1 Nishishinjuku, Shinjuku City, Tokyo, Japan",
  "k26": {
    "street": [
      {
        "kind": "apartment",
        "value": "3"
      },
      {
        "kind": "separator",
        "value": " "
      },
      {
        "kind": "block",
        "value": "Chome-7-1 Nishishinjuku"
      },
      {
        "kind": "district",
        "value": "Shinjuku City"
      }
    ],
    "locality": "Tokyo",
    "country": "Japan",
    "defaultSeparator": ", "
  }
}
Figure 30: Example of an address in Japan

2.6. Resource Properties

This section defines properties for digital resources associated with the entity represented by this Card.

2.6.1. cryptoKeys

Type: Id[CryptoResource] (optional).

These are cryptographic resources such as public keys and certificates associated with the entity represented by this Card. A CryptoResource object has all properties of the Resource (Section 1.4.4) data type, with the following additional definitions:

  • The @type property value MUST be CryptoResource, if set.

The following example shows how refer to an external cryptographic resource.

"cryptoKeys": {
  "mykey1": {
    "uri": "https://www.example.com/keys/jdoe.cer"
  }
}
Figure 31: cryptoKeys example with external data

The following example shows how to embed key data in the CryptoResource. The key data is depicted in multiple lines only for demonstration purposes.

"cryptoKeys": {
  "mykey2": {
    "uri": "data:,-----BEGIN RSA PUBLIC KEY-----\n
MIIBCgKCAQEA+xGZ/wcz9ugFpP07Nspo6U17l0YhFiFpxxU4pTk3Lifz9R3zsIsu\n
ERwta7+fWIfxOo208ett/jhskiVodSEt3QBGh4XBipyWopKwZ93HHaDVZAALi/2A\n
+xTBtWdEo7XGUujKDvC2/aZKukfjpOiUI8AhLAfjmlcD/UZ1QPh0mHsglRNCmpCw\n
mwSXA9VNmhz+PiB+Dml4WWnKW/VHo2ujTXxq7+efMU4H2fny3Se3KYOsFPFGZ1TN\n
QSYlFuShWrHPtiLmUdPoP6CV2mML1tk+l7DIIqXrQhLUKDACeM5roMx0kLhUWB8P\n
+0uj1CNlNN4JRZlC7xFfqiMbFRU9Z4N6YwIDAQAB\n
-----END RSA PUBLIC KEY-----"
  }
}
Figure 32: cryptoKeys example with embedded data

2.6.2. directories

Type: Id[DirectoryResource] (optional).

These are directory service resources, such as entries in a directory or organizational directories for lookup. A DirectoryResource object has all properties of the Resource (Section 1.4.4) data type, with the following additional definitions:

  • The @type property value MUST be DirectoryResource, if set.

The enumerated (Section 1.7.3) values of the kind property are:

  • directory The resource is a directory service where the entity represented by this Card is part of. This typically is an organizational directory that also contains associated entities, e.g. co-workers and management in a company directory.
  • entry The resource is a directory entry of the entity represented by this Card. In contrast to the directory type, this is the specific URI for the entity within a directory.

In addition, the DirectoryResource object has the following property:

  • listAs: UnsignedInt (optional). This defines the position of this directory resource in the list of all DirectoryResource objects having the same kind in this Card. If set, the listAs value MUST be higher than zero. Multiple directory resources MAY have the same listAs property value, or none at all. Sorting such entries is implementation-specific. 
"directories": {
  "dir1": {
    "kind": "entry",
    "uri": "https://dir.example.com/addrbook/jdoe/Jean%20Dupont.vcf"
  },
  "dir2": {
    "kind": "directory",
    "uri": "ldap://ldap.example/o=Example%20Tech,ou=Engineering",
    "pref": 1
  }
Figure 33: directories example

2.6.4. media

Type: Id[MediaResource] (optional).

These are media resources such as photographs, avatars, or sounds associated with the entity represented by this Card. A MediaResource object has all properties of the Resource (Section 1.4.4) data type, with the following additional definitions:

  • The @type property value MUST be MediaResource, if set.

The enumerated (Section 1.7.3) values are:

  • photo The resource is a photograph or avatar.
  • sound The resource is audio media, e.g. to specify the proper pronunciation of the name property contents.
  • logo The resource is a graphic image or logo associated with the entity represented by this Card. 
"media": {
  "res45": {
    "kind": "sound",
    "uri": "CID:JOHNQ.part8.19960229T080000.xyzMail@example.com"
  },
  "res47": {
    "kind": "logo",
    "uri": "https://www.example.com/pub/logos/abccorp.jpg"
  },
  "res1": {
    "kind": "photo",
    "uri": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4..."
  }
}
Figure 35: media example

2.7. Multilingual Properties

This section defines properties how to localize the content of this Card in human languages.

2.7.1. localizations

Type: String[PatchObject] (optional).

This localizes property values in this Card to languages other than the main language. Localizations provide language-specific alternatives for existing property values and SHOULD NOT add new properties.

The keys in the localizations property object are language tags [RFC5646]. The values are patch objects which localize the Card in the respective language tag. The paths in the PatchObject are relative to the Card that includes the localizations property. A patch MUST NOT target the localizations property.

Conceptually, a Card is localized as follows:

  • Determine the language tag in which this Card should be localized in.
  • If the localizations property includes a key for that language, obtain the PatchObject value. If there is no such key, stop.
  • Create a copy of the Card, but do not copy the localizations property.
  • Apply all patches in the PatchObject to the copy of the Card.
  • Optionally, set the language property in the copy of the Card.
  • Use the patched copy of the Card as the localized variant of the original Card.

A patch in the PatchObject may patch a simple-typed property value, or a complex type.

Figure 36 shows how a single String property value is localized in the jp language.

"language": "en",
"addresses": {
  "addr1": {
    "locality": "Tokyo"
  }
},
"localizations": {
  "jp": {
    "addresses/addr1/locality": "東京"
  }
}
Figure 36: Example of localizing a String value

Figure 37 shows how a complete object property value is localized in the en language.

"language": "ru",
"name": {
  "components": [
    {
      "kind": "given",
      "value": "Фёдор"
    },
    {
      "kind": "surname",
      "value": "Михайлович"
    },
    {
      "kind": "surname",
      "value": "Достоевский"
    }
  ]
},
"localizations": {
  "en": {
    "name": {
      "components": [
        {
          "kind": "given",
          "value": "Fyodor"
        },
        {
          "kind": "surname",
          "value": "Mikhailovich"
        },
        {
          "kind": "surname",
          "value": "Dostoevsky"
        }
      ]
    }
  }
}
Figure 37: Example of localizing an object value

2.8. Additional Properties

This section defines properties for which none of the previous sections is appropriate.

2.8.1. anniversaries

Type : Id[Anniversary] (optional).

These are memorable dates and events for the entity represented by this Card. An Anniversary object has the following properties:

  • @type: String. This MUST be Anniversary, if set.

  • kind: String (mandatory). Specifies the kind of the anniversary. The enumerated (Section 1.7.3) values are:

    • birth: a birthday anniversary
    • death: a deathday anniversary
    • wedding: a wedding day anniversary

  • date: PartialDate|Timestamp (mandatory, defaultType: PartialDate).

    The date of this anniversary in the Gregorian calendar. This MUST either be a whole or partial calendar date or a complete UTC timestamp (see the definition of the Timestamp and PartialDate object types below).

  • place: Address (optional). An address associated with this anniversary, e.g. the place of birth or death.

A PartialDate object represents a complete or partial calendar date in the Gregorian calendar. It represents either a complete date, or a year, or a month in a year, or a day in a month. It has the following properties, of which at least year or month and day MUST be set:

  • @type: String. This MUST be PartialDate, if set.
  • year: UnsignedInt (optional). This is the calendar year.
  • month: UnsignedInt (optional). This is the calendar month, represented as the integers 1 <= month <= 12. If this property is set then either year or day MUST be set.
  • day: UnsignedInt (optional). This is the calendar month day, represented as the integers 1 <= day <= 31, depending on the validity within the month and year. If this property is set then month MUST be set.
  • calendarScale: String (optional). This is the calendar system in which this date occurs, in lowercase. This MUST be either a CLDR-registered calendar system name [RFC7529] or a vendor-specific value. The year, month and day still MUST be represented in the Gregorian calendar. Note that the year property might be required to convert the date between the Gregorian calendar and the respective calendar system.

A Timestamp object has the following properties:

  • @type: String. This MUST be Timestamp, if set.
  • utc: UTCDateTime (mandatory). Specifies the point in time in UTC time.

Figure 38 illustrates anniversaries with partial dates and timestamp. Note how the @type property is set for the Timestamp object value according to the rules defined Section 1.3.4.

"anniversaries": {
  "k8": {
    "kind": "birth",
    "date": {
      "year": 1953,
      "month": 4,
      "day": 15
    }
  },
  "k9": {
    "kind": "death",
    "date": {
      "@type": "Timestamp",
      "utc": "2019-10-15T23:10:00Z"
    },
    "place": {
      "fullAddress": "4445 Tree Street\nNew England, ND 58647\nUSA"
    }
  }
}
Figure 38: anniversaries example

2.8.2. keywords

Type: String[Boolean] (optional). A set of free-text keywords, also known as tags. The set is represented as an object, with each key being a keyword. The boolean value MUST be true.

"keywords": {
  "internet": true,
  "IETF": true
}
Figure 39: keywords example

2.8.3. notes

Type: Id[Note] (optional).

Free-text notes associated with this Card. A Note object has the following properties:

  • @type: String. This MUST be Note, if set.

  • note: String (mandatory). The free text value of this note.

  • created: UTCDateTime (optional). The date and time when this note was created.

  • author: Author (optional). The author of this note.

An Author object has the following properties, of which at least one other than @type MUST be set:

  • @type: String. This MUST be Author, if set.

  • name: String (optional). The name of this author.

  • uri: String (optional). A URI value that identifies the author.

"notes": {
  "n1": {
    "note": "Open office hours are 1600 to 1715 EST, Mon-Fri",
    "created": "2022-11-23T15:01:32Z",
    "author": {
      "name": "John"
    }
  }
}
Figure 40: notes example

2.8.4. personalInfo

Type: Id[PersonalInfo] (optional).

Defines personal information about the entity represented by this Card. A PersonalInfo object has the following properties:

  • @type: String. This MUST be PersonalInfo, if set.

  • kind: String (mandatory). Specifies the kind of this personal information. The enumerated (Section 1.7.3) values are:

    • expertise: a field of expertise or credential
    • hobby: a hobby
    • interest: an interest
  • value: String (mandatory). The actual information.

  • level: String (optional). Indicates the level of expertise, or engagement in hobby or interest. The enumerated (Section 1.7.3) values are:

  • listAs: UnsignedInt (optional). This defines the position of this personal information in the list of all PersonalInfo objects having the same kind in this Card. If set, the listAs value MUST be higher than zero. Multiple personal information entries MAY have the same listAs property value, or none at all. Sorting such entries is implementation-specific.
  • label: String (optional). A custom label. See Section 1.5.2. 
"personalInfo": {
  "pi2": {
    "kind": "expertise",
    "value": "chemistry",
    "level": "high"
  },
  "pi1": {
    "kind": "hobby",
    "value": "reading",
    "level": "high"
  },
  "pi6": {
    "kind": "interest",
    "value": "r&b music",
    "level": "medium"
  }
}
Figure 41: personalInfo example

3. Implementation Status

NOTE: Please remove this section and the reference to [RFC7942] prior to publication as an RFC. This section records the status of known implementations of the format defined by this specification at the time of posting of this Internet-Draft, and is based on a proposal described in [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 [RFC7942], "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".

3.1. IIT-CNR/Registro.it

  • 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. The RDAP server returns responses including JSContact Card in place of jCard when queries contain the parameter jscard=1.
  • 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

3.2. Cyrus IMAP

4. IANA Considerations

4.1. Media Type Registration

[I-D.ietf-calext-jscontact] defines a media type for use with JSContact data formatted in JSON.

Type name:
application
Subtype name:
jscontact+json
Required parameters:

None

Optional parameters:
type

This parameter conveys the type of the JSContact data in the body part. It MUST NOT occur more than once. This RFC specifies a single allowed parameter value, but future RFC documents MAY extend this list:

card:
The body part MUST consist of exactly one JSContact Card (Section 2) object.
version
This parameter conveys the version of the JSContact data in the body part. It MUST NOT occur more than once. If this parameter is set, then the values of all JSContact @version (Table 2) properties in the body part MUST match the parameter value.
Encoding considerations:
This is the same as the encoding considerations of application/json, as specified in Section 11 of [RFC8259].
Security considerations:
See Section 5 of [I-D.ietf-calext-jscontact].
Interoperability considerations:
While JSContact is designed to avoid ambiguities as much as possible, when converting objects from other contact formats to/from JSContact, it is possible that differing representations for the same logical data or ambiguities in interpretation might arise. The semantic equivalence of two JSContact objects may be determined differently by different applications, for example, where URL values differ in case between the two objects.
Published specification:
TBD
Applications that use this media type:
Applications that currently make use of the text/vcard media type can use this as an alternative.
Fragment identifier considerations:
A JSON Pointer fragment identifier may be used, as defined in [RFC6901], Section 6.
Additional information:
Magic number(s):
N/A
File extensions(s):
N/A
Macintosh file type code(s):
N/A
Person & email address to contact for further information:
calsify@ietf.org
Intended usage:
COMMON
Restrictions on usage:
N/A
Author:
See the "Author's Address" section of [I-D.ietf-calext-jscontact].
Change controller:
IETF

4.2. Creation of the "JSContact" Registry Group

IANA is asked to create the "JSContact" registry group. The new registry definitions in the following sections all belong to that group.

4.3. Registry Policy and Change Procedures

Registry assignments generally require the JSContact version to change, but ultimately this is up to the decision of the Designated Expert. The registry policy for assignments that require the JSContact major version to change is Standards Action ([RFC8126], Section 4.9). The registry policy for other assignments is Specification Required ([RFC8126], Section 4.6), where for very simple changes, it can be enough to describe the new assignment in the Description item of the respective registry.

The Designated Expert decides if a major or minor version change is required and assigns the new version to the Version Registry (Section 4.4). Version numbers increment by one, and a major version change resets the minor version to zero. An assignment may apply multiple changes and to more than one registry at once, in which case a single version change is sufficient.

A registration MUST have an intended usage of common, reserved, or obsolete.

  • A common usage denotes an item with shared semantics and syntax across systems. Up-to-date systems MUST expect such items to occur in JSContact data.
  • A reserved usage reserves an item in the registry without assigning semantics to avoid name collisions with future extensions or protocol use.
  • An obsolete usage denotes an item that is no longer expected to be added by up-to-date systems. A new assignment has probably been defined covering the obsolete item's semantics.

The registration procedure is not a formal standards process but rather an administrative procedure intended to allow community comment and check whether it is coherent without excessive time delay. It is designed to encourage vendors to document and register new items they add for use cases not covered by the original specification, leading to increased interoperability.

4.3.1. Preliminary Community Review

Notice of a potential new registration MUST be sent to the Calext mailing list <calsify@ietf.org> for review. This mailing list is appropriate to solicit community feedback on a proposed registry assignment.

The intent of the public posting to this list is to solicit comments and feedback on the choice of the item name or value, the unambiguity of its description, and a review of any interoperability or security considerations. The submitter may submit a revised registration proposal or abandon the registration completely at any time.

4.3.2. Submit Request to IANA

Registration requests can be sent to <iana@iana.org>.

4.3.3. Designated Expert Review

The primary concern of the designated expert (DE) is preventing name collisions and encouraging the submitter to document security and privacy considerations. For a common-use registration, the DE is expected to confirm that suitable documentation is available to ensure interoperability. The DE should also verify that the new assignment does not conflict with work that is active or already published within the IETF.

The DE will either approve or deny the registration request and publish a notice of the decision to the Calext WG mailing list or its successor, as well as inform IANA. A denial notice must be justified by an explanation, and, in the cases where it is possible, concrete suggestions on how the request can be modified so as to become acceptable should be provided.

4.3.4. Change Procedures

Once a JSContact registry group item has been published by IANA, the change controller may request a change to its definition. The same procedure that would be appropriate for the original registration request is used to process a change request.

JSContact registrations dot not get deleted; instead, items that are no longer believed appropriate for use are declared obsolete by a change to their "intended usage" field; such items will be clearly marked in the IANA registry.

Significant changes to a JSContact registry item's definition should be requested only when there are serious omissions or errors in the published specification, as such changes may cause interoperability issues. When review is required, a change request may be denied if it renders entities that were valid under the previous definition invalid under the new definition.

4.4. Creation of the "JSContact Version" Registry

IANA is asked to create the "JSContact Version" registry. The purpose of this new registry is to define the allowed value range of JSContact major and minor version numbers.

The registry entries sort numerically ascending by the "Major Version" column.

The registry process is outlined in Section 4.3.

4.4.1. "JSContact Version" Registry Template

Major Version:
This is the numeric value of a JSContact major version number. It MUST be a positive integer.
Highest Minor Version:
This is the maximum numeric value of a JSContact minor version for the given major version. It MUST be zero or a positive integer. All numbers less than or equal this value are valid minor version values for the given major version.

4.4.2. Initial Contents for the "JSContact Version" Registry

The following table lists the initial valid major and minor version number ranges.

Table 1: JSContact Versions
Major Version Highest Minor Version
1 0

4.5. Creation of the "JSContact Properties" Registry

IANA is asked to create the "JSContact Properties" registry. The purpose of this new registry is to allow interoperability of extensions to JSContact objects

The registry entries sort alphabetically ascending by the "Property Name" column first, "Property Context" second, "Since Version" third. Equal entries sort in any order.

The registry process for a new property is outlined in Section 4.3.

4.5.1. "JSContact Properties" Registry Template

Property Name:
This is the name of the property. The property name MUST NOT already be registered for any of the object types listed in the "Property Context" field of this registration. Other object types MAY already have registered a different property with the same name; however, the same name MUST only be used when the semantics are analogous.
Property Type:
This is the type of this property, using type signatures, as specified in Section 1.3.2. The property type MUST be registered in the "JSContact Types" registry.
Property Context:
This is a comma-separated list of JSContact object types (Section 4.6.2) that contain this property.
Reference or Description:
This is a brief description or RFC number and section reference where the property is specified (omitted for "reserved" property names). This must include references to all RFC documents where this property is introduced or updated.
Intended Usage:
This may be "common", "reserved", or "obsolete".
Since Version:
This defines the JSContact version on which this property definition is based on. The version MUST be one of the allowed values of the @version property in the JSContact Enum Value registry (see Table 1).
Until Version:
This defines the JSContact version after which this property got obsoleted and MUST NOT be used in later versions. The Until Version value either MUST NOT be set, or be one of the allowed values of the @version property in the JSContact Enum Value registry (see Table 1).
Change Controller:
This is who may request a change to this entry's definition (IETF for RFCs from the IETF stream).

4.5.2. Initial Contents for the "JSContact Properties" Registry

The following table lists the initial common usage entries of the "JSContact Properties" registry. The Since Version for all properties is 1.0. The Until Version for all properties is not set. All RFC section references are for [I-D.ietf-calext-jscontact]. The change controller for all these properties is IETF.

Table 2: JSContact Properties with "common" usage
Property Name Property Type Property Context Reference or Description
@type String Address, Anniversary, Author, Card, CalendarResource, ContactBy, CryptoResource, DirectoryResource, EmailAddress, LanguagePref, LinkResource, MediaResource, Name, NameComponent, NickName, Note, OnlineService, Organization, OrgUnit, PartialDate,PersonalInfo, Phone, Pronouns, Relation, Resource, SchedulingAddress, SpeakToAs, StreetComponent, Timestamp, Title Section 2.5.1, Section 2.8.1, Section 2.1.1, Section 2.4.1, Section 2.3.1, Section 2.6.1, Section 2.6.2, Section 2.3.2, Section 2.3.5, Section 2.6.3, Section 2.6.4, Section 2.2.2, Section 2.2.3, Section 2.8.3, Section 2.3.3, Section 2.2.4, Section 2.8.4, Section 2.3.4, Section 2.2.5, Section 2.1.8, Section 2.4.2, Section 2.2.6
@version String Card Section 2.1.2
address String EmailAddress Section 2.3.2
addresses Id[Address] Card Section 2.5.1
anniversaries Id[Anniversary] Card Section 2.8.1
author Author Note Section 2.8.3
calendars Id[CalendarResource] Card Section 2.4.1
calendarScale String PartialDate Section 2.8.1
components NameComponent[] Name Section 2.2.2
contexts String[Boolean] Address, CalendarResource, ContactBy, CryptoResource, DirectoryResource, EmailAddress, LanguagePref, LinkResource, MediaResource, NickName, OnlineService, Organization, Phone, Pronouns, SchedulingAddress Section 1.5.1, Section 2.5.1, Section 2.4.1, Section 2.3.1, Section 2.6.1, Section 2.6.2, Section 2.3.2, Section 2.3.5, Section 2.6.3, Section 2.6.4, Section 2.2.3, Section 2.3.3, Section 2.2.4, Section 2.3.4, Section 2.2.5, Section 2.4.2 Section 1.4.4
coordinates String Address Section 2.5.1
country String Address Section 2.5.1
countryCode String Address Section 2.5.1
created UTCDateTime Card, Note Section 2.1.3, Section 2.8.3
date PartialDate|Timestamp Anniversary Section 2.8.1
day UnsignedInt PartialDate Section 2.8.1
defaultSeparator String Address Section 2.5.1
directories Id[DirectoryResource] Card Section 2.6.2
emails Id[EmailAddress] Card Section 2.3.2
features String[Boolean] Phone Section 2.3.4
fullAddress String Address Section 2.5.1
fullName String Card Section 2.2.1
grammaticalGender String SpeakToAs Section 2.2.5
keywords String[Boolean] Card Section 2.8.2
kind String Card Section 2.1.4
kind String Anniversary, CalendarResource, Card, CryptoResource, DirectoryResource, LinkResource, MediaResource, NameComponent, PersonalInfo, StreetComponent, Title Section 2.8.1, Section 2.4.1, Section 2.1.4, Section 2.6.1, Section 2.6.2, Section 2.6.3, Section 2.6.4, Section 2.2.2, Section 2.8.4, Section 2.5.1, Section 2.2.6, Section 1.4.4
label String CalendarResource, CryptoResource, DirectoryResource, EmailAddress, LinkResource, MediaResource, OnlineService, PersonalInfo, Phone, SchedulingAddress Section 1.5.2, Section 2.4.1, Section 2.6.1, Section 2.6.2, Section 2.3.2, Section 2.6.3, Section 2.6.4, Section 2.3.3, Section 2.8.4, Section 2.3.4, Section 2.4.2, Section 1.4.4
language String Card Section 2.1.5
level String PersonalInfo Section 2.8.4
links Id[LinkResource] Card Section 2.6.3
listAs UnsignedInt DirectoryResource, PersonalInfo Section 2.6.2, Section 2.8.4
locality String Address Section 2.5.1
localizations String[PatchObject] Card Section 2.7.1
media Id[MediaResource] Card Section 2.6.4
mediaType String CalendarResource, CryptoResource, DirectoryResource, LinkResource, MediaResource Section 1.4.4, Section 2.4.1, Section 2.6.1, Section 2.6.2, Section 2.6.3, Section 2.6.4
members String[Boolean] Card Section 2.1.6
month UnsignedInt PartialDate Section 2.8.1
name Name Card Section 2.2.2
name String Author, NickName, Organization, OrgUnit, Title Section 2.8.3, Section 2.2.3, Section 2.2.4, Section 2.2.6
nickNames Id[NickName] Card Section 2.2.3
note String Note Section 2.8.3
notes Id[Note] Card Section 2.8.3
number String Phone Section 2.3.4
onlineServices Id[OnlineService] Card Section 2.3.3
organization String Title Section 2.2.6
organizations Id[Organization] Card Section 2.2.4
personalInfo Id[PersonalInfo] Card Section 2.8.4
phones Id[Phone] Card Section 2.3.4
place Address Anniversary Section 2.8.1
postcode String Address Section 2.5.1
pref UnsignedInt Address, CalendarResource, ContactBy, CryptoResource, DirectoryResource, EmailAddress, LanguagePref, LinkResource, MediaResource, NickName, OnlineService, Phone, Pronouns, SchedulingAddress Section 1.5.3, Section 2.5.1, Section 2.4.1, Section 2.3.1, Section 2.6.1, Section 2.6.2, Section 2.3.2, Section 2.3.5, Section 2.6.3, Section 2.6.4, Section 2.2.3, Section 2.3.3, Section 2.3.4, Section 2.2.5, Section 2.4.2, Section 1.4.4
contactBy String[ContactBy[]] Card Section 2.3.1
preferredLanguages String[LanguagePref[]] Card Section 2.3.5
prodId String Card Section 2.1.7
pronouns Id[Pronouns] SpeakToAs Section 2.2.5
pronouns String Pronouns Section 2.2.5
rank UnsignedInt NameComponent Section 2.2.2
region String Address Section 2.5.1
relatedTo String[Relation] Card Section 2.1.8
relation String[Boolean] Relation Section 2.1.8
schedulingAddresses Id[SchedulingAddress] Card Section 2.4.2
service String OnlineService Section 2.3.3
sortAs String[String] Name Section 2.2.2
sortAs String Organization, OrgUnit Section 2.2.4
speakToAs SpeakToAs Card Section 2.2.5
street StreetComponent[] Address Section 2.5.1
timeZone String Address Section 2.5.1
titles Id[Title] Card Section 2.2.6
uid String Card Section 2.1.9
units OrgUnit[] Organization Section 2.2.4
updated UTCDateTime Card Section 2.1.10
uri String Author, CalendarResource, CryptoResource, DirectoryResource, LinkResource, MediaResource, OnlineService, SchedulingAddress Section 2.8.3, Section 1.4.4, Section 2.4.1, Section 2.6.1, Section 2.6.2, Section 2.6.3, Section 2.6.4, Section 2.3.3, Section 2.4.2
user String OnlineService Section 2.3.3
utc UTCDateTime Timestamp Section 2.8.1
value String NameComponent, PersonalInfo, StreetComponent Section 2.2.2, Section 2.8.4, Section 2.5.1
year UnsignedInt PartialDate Section 2.8.1

The following table lists the initial reserved usage entries of the "JSContact Properties" registry. All RFC section references are for [I-D.ietf-calext-jscontact]. The change controller for all these properties is IETF.

Table 3: JSContact Properties with "reserved" usage
Property Name Property Type Property Context Reference or Description Intended Usage
extra not applicable not applicable Section 1.9 reserved

4.6. Creation of the "JSContact Types" Registry

IANA is asked to create the "JSContact Types" registry. The purpose of this new registry is to avoid name collisions for JSContact type names and provide a complete reference for all data types used for JSContact property values.

The registry entries sort alphabetically ascending by the "Type Name" column. Equal entries sort in any order.

The registry process for a new type is outlined in Section 4.3.

4.6.1. "JSContact Types" Registry Template

Type Name:
the name of the type
Reference or Description:
a brief description or RFC number and section reference where the Type is specified (may be omitted for "reserved" type names)
Intended Usage:
common, reserved, or obsolete
Since Version:
This defines the JSContact version on which this type definition is based on. The version MUST be one of the allowed values of the @version property in the JSContact Enum Value registry (see Table 1).
Until Version:
This defines the JSContact version after which this type definition got obsoleted and MUST NOT be used in later versions. The Until Version value either MUST be not set, or one of the allowed values of the @version property in the JSContact Enum Value registry (see Table 1).
Change Controller:
This is who may request a change to this entry's definition (IETF for RFCs from the IETF stream).

4.6.2. Initial Contents for the "JSContact Types" Registry

The following table lists the initial common usage entries of the JSContact Types registry. The Since Version for all types is 1.0. The Until Version for all types is not set. All RFC section references are for [I-D.ietf-calext-jscontact]. The change controller for all these properties is IETF.

Table 4: JSContact Types with "common" usage
Type Name Reference or Description
Address Section 2.5.1
Anniversary Section 2.8.1
Author Section 2.8.3
Boolean Section 1.3.2
CalendarResource Section 2.4.1
Card Section 2
ContactBy Section 2.3.1
CryptoResource Section 2.6.1
DirectoryResource Section 2.6.2
EmailAddress Section 2.3.2
Id Section 1.4.1
Int Section 1.4.2
LanguagePref Section 2.3.5
LinkResource Section 2.6.3
MediaResource Section 2.6.4
Name Section 2.2.2
NameComponent Section 2.2.2
NickName Section 2.2.3
Note Section 2.8.3
Number Section 1.3.2
OnlineService Section 2.3.3
Organization Section 2.2.4
OrgUnit Section 2.2.4
PartialDate Section 2.8.1
PatchObject Section 1.4.3
PersonalInfo Section 2.8.4
Phone Section 2.3.4
Pronouns Section 2.2.5
Relation Section 2.1.8
SchedulingAddress Section 2.4.2
SpeakToAs Section 2.2.5
StreetComponent Section 2.5.1
String Section 1.3.2
Timestamp Section 2.8.1
Title Section 2.2.6
UnsignedInt Section 1.4.2
UTCDateTime Section 1.4.5

The following table lists the initial reserved usage entries of the JSContact Types registry. All types are for version 1.0. All RFC section references are for [I-D.ietf-calext-jscontact]. The change controller for all these properties is IETF.

Table 5: JSContact Types with "reserved" usage
Type Name Reference or Description
Resource Section 1.4.4

4.7. Creation of the "JSContact Enum Values" Registry

IANA is asked to create the "JSContact Enum Values" registry. The purpose of the new registry is to allow interoperable extension of semantics for JSContact properties with enumerable values. Each such property will have a subregistry of allowed values.

The registry entries sort alphabetically ascending by the "Property Name" column first, "Property Context" second, "Since Version" third. The enum values sort alphabetically ascending. Equal entries sort in any order.

The registry process for a new enum value or adding a new enumerable property is outlined in Section 4.3.

4.7.1. "JSContact Enum Values" Registry Property Template

This template is for adding a subregistry for a new enumerable property to the "JSContact Enum" registry.

Property Name:
These are the name(s) of the property or properties where these values may be used. This MUST be registered in the "JSContact Properties" registry.
Context:
This is the list of allowed object types where the property or properties may appear, as registered in the "JSContact Properties" registry. This disambiguates where there may be two distinct properties with the same name in different contexts.
Since Version:
This defines the JSContact version on which this enum value definition is based on. The version MUST be one of the allowed values of the @version property in the JSContact Enum Value registry (see Table 1).
Until Version:
This defines the JSContact version after which this enum value definition got obsoleted and MUST NOT be used in later versions. The Until Version value either MUST be not set, or one of the allowed values of the @version property in the JSContact Enum Value registry (see Table 1).
Change Controller:
This is who may request a change to this entry's definition (IETF for RFCs from the IETF stream).
Initial Contents:
This is the initial list of defined values for this enum, using the template defined in Section 4.7.2. A subregistry will be created with these values for this property name/context tuple.

4.7.2. "JSContact Enum Values" Registry Value Template

This template is for adding a new enum value to a subregistry in the JSContact Enum registry.

Enum Value:
The verbatim value of the enum
Reference or Description:
A brief description or RFC number and section reference for the semantics of this value
Since Version:
The JSContact version on which the enum value definition is based on. The version MUST be one of the allowed values of the @version property in the JSContact Enum Value registry (see Table 1).
Until Version:
The JSContact version after which this enum value got obsoleted and MUST NOT be used in later versions. The Until Version value either MUST be not set, or one of the allowed values of the @version property in the JSContact Enum Value registry (see Table 1).

4.7.3. Initial Contents for the "JSContact Enum Values" Registry

For each subregistry created in this section, all RFC section references are for [I-D.ietf-calext-jscontact]. For all entries, the Since Version is 1.0, the Until Version is not set, the Change Controller is IETF.

Property Name:
contactBy
Context:
Card
Initial Contents:
Table 6: JSContact Enum Values for contactBy (Context: Card)
Enum Value Reference or Description
addresses Section 2.3.1
emails Section 2.3.1
onlineServices Section 2.3.1
phones Section 2.3.1
Property Name:
contexts
Context:
Address
Initial Contents:
Property Name:
contexts
Context:
CalendarResource, ContactBy, CryptoResource, DirectoryResource, EmailAddress, LanguagePref, LinkResource, MediaResource, NickName, OnlineService, Phone, Pronouns, SchedulingAddress
Initial Contents:
Property Name:
features
Context:
Phone
Initial Contents:
Property Name:
grammaticalGender
Context:
SpeakToAs
Initial Contents:
Table 10: JSContact Enum Values for kind (Context: SpeakToAs)
Enum Value Reference or Description
animate Section 2.2.5
common Section 2.2.5
feminine Section 2.2.5
inanimate Section 2.2.5
masculine Section 2.2.5
neuter Section 2.2.5
Property Name:
kind
Context:
Anniversary
Initial Contents:
Property Name:
kind
Context:
CalendarResource
Initial Contents:
Property Name:
kind
Context:
Card
Initial Contents:
Table 13: JSContact Enum Values for kind (Context: Card)
Enum Value Reference or Description
application Section 2.1.4
device Section 2.1.4
group Section 2.1.4
individual Section 2.1.4
location Section 2.1.4
org Section 2.1.4
Property Name:
kind
Context:
DirectoryResource
Initial Contents:
Property Name:
kind
Context:
LinkResource
Initial Contents:
Property Name:
kind
Context:
MediaResource
Initial Contents:
Property Name:
kind
Context:
NameComponent
Initial Contents:
Property Name:
kind
Context:
PersonalInfo
Initial Contents:
Table 18: JSContact Enum Values for kind (Context: PersonalInfo)
Enum Value Reference or Description
expertise Section 2.8.4
hobby Section 2.8.4
interest Section 2.8.4
Property Name:
kind
Context:
StreetComponent
Initial Contents:
Table 19: JSContact Enum Values for kind (Context: StreetComponent)
Enum Value Reference or Description
apartment Section 2.5.1
block Section 2.5.1
building Section 2.5.1
direction Section 2.5.1
district Section 2.5.1
extension Section 2.5.1
floor Section 2.5.1
landmark Section 2.5.1
name Section 2.5.1
number Section 2.5.1
postOfficeBox Section 2.5.1
room Section 2.5.1
separator Section 2.5.1
Property Name:
kind
Context:
Title
Initial Contents:

5. Security Considerations

Contact information is very privacy-sensitive. It can reveal the identity, location and credentials information, employment status, interests and hobbies, and social network of a user. Its transmission and storage must be done carefully to protect it from possible threats, such as eavesdropping, replay, message insertion, deletion, modification, and on-path attacks.

The data being stored and transmitted may be used in systems with real-world consequences. For example, a malicious actor might provide JSContact data that uses the name of another person but insert their contact details to impersonate the unknown victim. Such systems must be careful to authenticate all data they receive to prevent them from being subverted and ensure the change comes from an authorized entity.

This document only defines the data format; such considerations are primarily the concern of the API or method of storage and transmission of such files.

5.1. JSON Parsing

The security considerations of [RFC8259] apply to the use of JSON as the data interchange format.

As for any serialization format, parsers need to thoroughly check the syntax of the supplied data. JSON uses opening and closing brackets for several types and structures, and it is possible that the end of the supplied data will be reached when scanning for a matching closing bracket; this is an error condition, and implementations need to stop scanning at the end of the supplied data.

JSON also uses a string encoding with some escape sequences to encode special characters within a string. Care is needed when processing these escape sequences to ensure that they are fully formed before the special processing is triggered, with special care taken when the escape sequences appear adjacent to other (non-escaped) special characters or adjacent to the end of data (as in the previous paragraph).

If parsing JSON into a non-textual structured data format, implementations may need to allocate storage to hold JSON string elements. Since JSON does not use explicit string lengths, the risk of denial of service due to resource exhaustion is small, but implementations may still wish to place limits on the size of allocations they are willing to make in any given context, to avoid untrusted data causing excessive memory allocation.

5.2. URI Values

Several JSContact properties contain URIs as values, and processing these properties requires extra care. Section 7 of [RFC3986] discusses security risks related to URIs.

Fetching remote resources carries inherent risks. Connections must only be allowed on well-known ports, using allowed protocols (generally, just HTTP/HTTPS on their default ports). The URL must be resolved externally and not allowed to access internal resources. Connecting to an external source reveals IP (and therefore often location) information.

A maliciously constructed JSContact object may contain a very large number of URIs. In the case of published address books with a large number of subscribers, such objects could be widely distributed. Implementations should be careful to limit the automatic fetching of linked resources to reduce the risk of this being an amplification vector for a denial-of-service attack.

6. References

6.1. Normative References

[IANATZ]
"IANA Time Zone Database", <https://www.iana.org/time-zones>.
[IANAvCard]
"IANA vCard Elements", <https://www.iana.org/assignments/vcard-elements/vcard-elements.xhtml>.
[ISO.3166-1.2006]
International Organization for Standardization, "Codes for the representation of names of countries, 3rd edition", ISO Standard 3166-1, .
[RFC1034]
Mockapetris, P., "Domain names - concepts and facilities", STD 13, RFC 1034, DOI 10.17487/RFC1034, , <https://www.rfc-editor.org/info/rfc1034>.
[RFC1035]
Mockapetris, P., "Domain names - implementation and specification", STD 13, RFC 1035, DOI 10.17487/RFC1035, , <https://www.rfc-editor.org/info/rfc1035>.
[RFC2046]
Freed, N. and N. Borenstein, "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types", RFC 2046, DOI 10.17487/RFC2046, , <https://www.rfc-editor.org/info/rfc2046>.
[RFC2119]
Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, , <https://www.rfc-editor.org/info/rfc2119>.
[RFC2426]
Dawson, F. and T. Howes, "vCard MIME Directory Profile", RFC 2426, DOI 10.17487/RFC2426, , <https://www.rfc-editor.org/info/rfc2426>.
[RFC3339]
Klyne, G. and C. Newman, "Date and Time on the Internet: Timestamps", RFC 3339, DOI 10.17487/RFC3339, , <https://www.rfc-editor.org/info/rfc3339>.
[RFC4122]
Leach, P., Mealling, M., and R. Salz, "A Universally Unique IDentifier (UUID) URN Namespace", RFC 4122, DOI 10.17487/RFC4122, , <https://www.rfc-editor.org/info/rfc4122>.
[RFC4648]
Josefsson, S., "The Base16, Base32, and Base64 Data Encodings", RFC 4648, DOI 10.17487/RFC4648, , <https://www.rfc-editor.org/info/rfc4648>.
[RFC5234]
Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax Specifications: ABNF", STD 68, RFC 5234, DOI 10.17487/RFC5234, , <https://www.rfc-editor.org/info/rfc5234>.
[RFC5322]
Resnick, P., Ed., "Internet Message Format", RFC 5322, DOI 10.17487/RFC5322, , <https://www.rfc-editor.org/info/rfc5322>.
[RFC5646]
Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, , <https://www.rfc-editor.org/info/rfc5646>.
[RFC5870]
Mayrhofer, A. and C. Spanring, "A Uniform Resource Identifier for Geographic Locations ('geo' URI)", RFC 5870, DOI 10.17487/RFC5870, , <https://www.rfc-editor.org/info/rfc5870>.
[RFC6350]
Perreault, S., "vCard Format Specification", RFC 6350, DOI 10.17487/RFC6350, , <https://www.rfc-editor.org/info/rfc6350>.
[RFC6901]
Bryan, P., Ed., Zyp, K., and M. Nottingham, Ed., "JavaScript Object Notation (JSON) Pointer", RFC 6901, DOI 10.17487/RFC6901, , <https://www.rfc-editor.org/info/rfc6901>.
[RFC7493]
Bray, T., Ed., "The I-JSON Message Format", RFC 7493, DOI 10.17487/RFC7493, , <https://www.rfc-editor.org/info/rfc7493>.
[RFC7529]
Daboo, C. and G. Yakushev, "Non-Gregorian Recurrence Rules in the Internet Calendaring and Scheduling Core Object Specification (iCalendar)", RFC 7529, DOI 10.17487/RFC7529, , <https://www.rfc-editor.org/info/rfc7529>.
[RFC7942]
Sheffer, Y. and A. Farrel, "Improving Awareness of Running Code: The Implementation Status Section", BCP 205, RFC 7942, DOI 10.17487/RFC7942, , <https://www.rfc-editor.org/info/rfc7942>.
[RFC8126]
Cotton, M., Leiba, B., and T. Narten, "Guidelines for Writing an IANA Considerations Section in RFCs", BCP 26, RFC 8126, DOI 10.17487/RFC8126, , <https://www.rfc-editor.org/info/rfc8126>.
[RFC8141]
Saint-Andre, P. and J. Klensin, "Uniform Resource Names (URNs)", RFC 8141, DOI 10.17487/RFC8141, , <https://www.rfc-editor.org/info/rfc8141>.
[RFC8174]
Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, , <https://www.rfc-editor.org/info/rfc8174>.
[RFC8259]
Bray, T., Ed., "The JavaScript Object Notation (JSON) Data Interchange Format", STD 90, RFC 8259, DOI 10.17487/RFC8259, , <https://www.rfc-editor.org/info/rfc8259>.

6.2. Informative References

[I-D.ietf-calext-jscontact]
Stepanek, R. and M. Loffredo, "JSContact: A JSON representation of contact data", Work in Progress, Internet-Draft, draft-ietf-calext-jscontact-10, , <https://datatracker.ietf.org/doc/html/draft-ietf-calext-jscontact-10>.
[I-D.ietf-uuidrev-rfc4122bis]
Leach, P. J., Mealling, M. H., Peabody, B., and K. R. Davis, "Universally Unique IDentifiers (UUID)", Work in Progress, Internet-Draft, draft-ietf-uuidrev-rfc4122bis-04, , <https://datatracker.ietf.org/doc/html/draft-ietf-uuidrev-rfc4122bis-04>.
[RFC3261]
Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, A., Peterson, J., Sparks, R., Handley, M., and E. Schooler, "SIP: Session Initiation Protocol", RFC 3261, DOI 10.17487/RFC3261, , <https://www.rfc-editor.org/info/rfc3261>.
[RFC3966]
Schulzrinne, H., "The tel URI for Telephone Numbers", RFC 3966, DOI 10.17487/RFC3966, , <https://www.rfc-editor.org/info/rfc3966>.
[RFC3986]
Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", STD 66, RFC 3986, DOI 10.17487/RFC3986, , <https://www.rfc-editor.org/info/rfc3986>.
[RFC6351]
Perreault, S., "xCard: vCard XML Representation", RFC 6351, DOI 10.17487/RFC6351, , <https://www.rfc-editor.org/info/rfc6351>.
[RFC6473]
Saint-Andre, P., "vCard KIND:application", RFC 6473, DOI 10.17487/RFC6473, , <https://www.rfc-editor.org/info/rfc6473>.
[RFC6474]
Li, K. and B. Leiba, "vCard Format Extensions: Place of Birth, Place and Date of Death", RFC 6474, DOI 10.17487/RFC6474, , <https://www.rfc-editor.org/info/rfc6474>.
[RFC6715]
Cauchie, D., Leiba, B., and K. Li, "vCard Format Extensions: Representing vCard Extensions Defined by the Open Mobile Alliance (OMA) Converged Address Book (CAB) Group", RFC 6715, DOI 10.17487/RFC6715, , <https://www.rfc-editor.org/info/rfc6715>.
[RFC6869]
Salgueiro, G., Clarke, J., and P. Saint-Andre, "vCard KIND:device", RFC 6869, DOI 10.17487/RFC6869, , <https://www.rfc-editor.org/info/rfc6869>.
[RFC7095]
Kewisch, P., "jCard: The JSON Format for vCard", RFC 7095, DOI 10.17487/RFC7095, , <https://www.rfc-editor.org/info/rfc7095>.
[RFC8499]
Hoffman, P., Sullivan, A., and K. Fujiwara, "DNS Terminology", BCP 219, RFC 8499, DOI 10.17487/RFC8499, , <https://www.rfc-editor.org/info/rfc8499>.
[RFC8605]
Hollenbeck, S. and R. Carney, "vCard Format Extensions: ICANN Extensions for the Registration Data Access Protocol (RDAP)", RFC 8605, DOI 10.17487/RFC8605, , <https://www.rfc-editor.org/info/rfc8605>.

Authors' Addresses

Robert Stepanek
Fastmail
PO Box 234, Collins St West
Melbourne VIC 8007
Australia
Mario Loffredo
IIT-CNR
Via Moruzzi,1
56124 Pisa
Italy