Internet-Draft | JMAP Sharing | August 2023 |
Jenkins | Expires 1 March 2024 | [Page] |
This document specifies a data model for sharing data between users using JMAP. Specifications for other data types can reference this document to support a consistent model of sharing.¶
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 1 March 2024.¶
Copyright (c) 2023 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
JMAP ([RFC8620] JSON Meta Application Protocol) is a generic protocol for synchronizing data, such as mail, calendars or contacts, between a client and a server. It is optimized for mobile and web environments, and aims to provide a consistent interface to different data types.¶
This specification defines a data model to represent entities in a collaborative environment, and a framework for sharing data between them that can be used to provide a consistent sharing model for different data types. It does not define what may be shared, or the granularity of permissions, as this will depend on the data in question.¶
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.¶
Type signatures, examples, and property descriptions in this document follow the conventions established in Section 1.1 of [RFC8620]. Data types defined in the core specification are also used in this document.¶
The same terminology is used in this document as in the core JMAP specification, see [RFC8620], Section 1.6.¶
The terms Principal, and ShareNotification (with these specific capitalizations) are used to refer to the data types defined in this document and instances of those data types.¶
A Principal (see Section 2) represents an individual, team, or resource (e.g., a room or projector). The object contains information about the entity being represented, such as a name, description, and time zone. It may also hold domain-specific information. A Principal may be associated with zero or more Accounts (see [RFC8620], Section 1.6.2) containing data belonging to the principal. Managing the set of principals within a system is out of scope for this specification, as it is highly domain specific. It is likely to map directly from a directory service or other user management system.¶
Data types may allow users to share data with others by assigning permissions to principals. When a user's permissions are changed, a ShareNotification object is created for them so a client can inform the user of the changes.¶
Permissions determine whether a user may access data, but not whether they want to. Some shared data is of equal importance as the user's own, while other data is just there should the user wish to explicitly go find it. Clients will often want to differentiate the two; for example, a company may share mailing list archives for all departments with all employees, but a user may only generally be interested in the few they belong to. They would have permission to access many mailboxes, but can subscribe to just the ones they care about. The client would provide separate interfaces for reading mail in subscribed mailboxes and browsing all mailboxes they have permission to access in order to manage their subscriptions.¶
The JMAP Session object (see [RFC8620], Section 2) typically includes an object in the accounts
property for every account that the user has access to. Collaborative systems may share data between a very large number of Principals, most of which the user does not care about day-to-day. The Session object MUST only include Accounts where either the user is subscribed to at least one record (see [RFC8620], Section 1.6.3) in the account, or the account belongs to the user. StateChange events for changes to data SHOULD only be sent for data the user has subscribed to and MUST NOT be sent for any account where the user is not subscribed to any records in the account, except where that account belongs to the user.¶
The server MAY reject the user's attempt to subscribe to some resources even if they have permission to access them, e.g., a calendar representing a location.¶
A user may query the set of Principals they have access to with "Principal/query" (see Section 2.4). The Principal object may then provide Account objects if the user has permission to access data for that principal, even if they are not yet subscribed.¶
The capabilities object is returned as part of the JMAP Session object; see [RFC8620], Section 2. This document defines two additional capability URIs.¶
Represents support for the Principal and ShareNotification data types and associated API methods.¶
The value of this property in the JMAP Session capabilities property is an empty object.¶
The value of this property in an account’s accountCapabilities property is an object that MUST contain the following information on server capabilities and permissions for that account:¶
This URI is solely used as a key in an account’s accountCapabilities property; it does not appear in the JMAP Session capabilities. Support is implied by the urn:ietf:params:jmap:principals
session capability.¶
If present, the account (and data therein) is owned by a principal. Some accounts may not be owned by a principal (e.g., the account that contains the data for the principals themselves), in which case this property is omitted.¶
The value of this property is an object with the following properties:¶
A Principal represents an individual, group, location (e.g., a room), resource (e.g., a projector) or other entity in a collaborative environment. Sharing in JMAP is generally configured by assigning rights to certain data within an account to other principals, for example a user may assign permission to read their calendar to a principal representing another user, or their team.¶
In a shared environment such as a workplace, a user may have access to a large number of principals.¶
In most systems the user will have access to a single Account containing Principal objects, but they may have access to multiple if, for example, aggregating data from different places.¶
A Principal object has the following properties:¶
id: Id
(immutable; server-set)¶
The id of the principal.¶
type: String
¶
This MUST be one of the following values:¶
name: String
¶
The name of the principal, e.g., "Jane Doe", or "Room 4B".¶
description: String|null
¶
A longer description of the principal, for example details about the facilities of a resource, or null if no description available.¶
email: String|null
¶
An email address for the principal, or null if no email is available.¶
timeZone: String|null
¶
The time zone for this principal, if known. If not null, the value MUST be a time zone id from the IANA Time Zone Database TZDB.¶
capabilities: String[Object]
¶
A map of JMAP capability URIs to domain specific information about the principal in relation to that capability, as defined in the document that registered the capability.¶
accounts: Id[Account]|null
¶
A map of account id to Account object for each JMAP Account containing data for this principal that the user has access to, or null if none.¶
This is a standard "/get" method as described in [RFC8620], Section 5.1.¶
This is a standard "/changes" method as described in [RFC8620], Section 5.2. Note, implementations backed by an external directory may be unable to calculate changes, in which they will always return a "cannotCalculateChanges" error, as described in the core JMAP specification.¶
This is a standard "/set" method as described in [RFC8620], Section 5.3.¶
Users SHOULD be allowed to update the "name", "description" and "timeZone" properties of the Principal with the same id as the "currentUserPrincipalId" in the Account capabilities.¶
However, the server may reject this change, and probably will reject any other change, with a forbidden
SetError. Managing principals is likely tied to a directory service or some other vendor-specific solution, and may occur out-of-band, or via an additional capability defined elsewhere.¶
This is a standard "/query" method as described in [RFC8620], Section 5.5¶
A FilterCondition object has the following properties:¶
accountIds: String[]
¶
A list of account ids. The Principal matches if any of the ids in this list are keys in the Principal's "accounts" property (i.e., if any of the account ids belong to the principal).¶
email: String
¶
Looks for the text in the email property.¶
name: String
¶
Looks for the text in the name property.¶
text String
¶
Looks for the text in the name, email, and description properties.¶
type: String
¶
The type must be exactly as given to match the condition.¶
timeZone: String
¶
The timeZone must be exactly as given to match the condition.¶
All conditions in the FilterCondition object must match for the Principal to match.¶
This is a standard "/queryChanges" method as described in [RFC8620], Section 5.6. Note, implementations backed by an external directory may be unable to calculate changes, in which they will always return a "cannotCalculateChanges" error, as described in the core JMAP specification.¶
All security considerations of JMAP [RFC8620] apply to this specification. Additional considerations are detailed below.¶
Allowing users to edit their own Principal's name (and, to a lesser extent, description) could allow a user to change their name to that of another user in the system, potentially tricking others into sharing private data with them. Servers may choose to forbid this, and SHOULD keep logs of such changes to provide an audit trail.¶
Sharing data with another user allows someone to turn a transitory account compromise (e.g., brief access to an unlocked, logged in client) into a persistant compromise (by setting up sharing with a user controlled by the attacker). This can be mitigated by requiring further authorisation for configuring sharing, or sending notifications to the sharer via another channel whenever a new sharee is added.¶
IANA will register the "principals" JMAP Capability as follows:¶
Capability Name: urn:ietf:params:jmap:principals
¶
Specification document: this document¶
Intended use: common¶
Change Controller: IETF¶
Security and privacy considerations: this document, Section 5¶
IANA will register the "principals:owner" JMAP Capability as follows:¶
Capability Name: urn:ietf:params:jmap:principals:owner
¶
Specification document: this document¶
Intended use: common¶
Change Controller: IETF¶
Security and privacy considerations: this document, Section 5¶