idnits 2.17.1 draft-ietf-jmap-smime-sender-extensions-01.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (8 November 2021) is 890 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- == Unused Reference: 'RFC8550' is defined on line 218, but no explicit reference was found in the text == Unused Reference: 'RFC8551' is defined on line 223, but no explicit reference was found in the text == Unused Reference: 'RFC8620' is defined on line 228, but no explicit reference was found in the text Summary: 0 errors (**), 0 flaws (~~), 4 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group A. Melnikov 3 Internet-Draft Isode Ltd 4 Intended status: Informational 8 November 2021 5 Expires: 12 May 2022 7 JMAP extension for S/MIME signing and encryption 8 draft-ietf-jmap-smime-sender-extensions-01 10 Abstract 12 This document specifies an extension to JMAP for sending S/MIME 13 signed and S/MIME encrypted messages. 15 Status of This Memo 17 This Internet-Draft is submitted in full conformance with the 18 provisions of BCP 78 and BCP 79. 20 Internet-Drafts are working documents of the Internet Engineering 21 Task Force (IETF). Note that other groups may also distribute 22 working documents as Internet-Drafts. The list of current Internet- 23 Drafts is at https://datatracker.ietf.org/drafts/current/. 25 Internet-Drafts are draft documents valid for a maximum of six months 26 and may be updated, replaced, or obsoleted by other documents at any 27 time. It is inappropriate to use Internet-Drafts as reference 28 material or to cite them other than as "work in progress." 30 This Internet-Draft will expire on 12 May 2022. 32 Copyright Notice 34 Copyright (c) 2021 IETF Trust and the persons identified as the 35 document authors. All rights reserved. 37 This document is subject to BCP 78 and the IETF Trust's Legal 38 Provisions Relating to IETF Documents (https://trustee.ietf.org/ 39 license-info) in effect on the date of publication of this document. 40 Please review these documents carefully, as they describe your rights 41 and restrictions with respect to this document. Code Components 42 extracted from this document must include Simplified BSD License text 43 as described in Section 4.e of the Trust Legal Provisions and are 44 provided without warranty as described in the Simplified BSD License. 46 Table of Contents 48 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 49 2. Conventions Used in This Document . . . . . . . . . . . . . . 2 50 3. Addition to the capabilities object . . . . . . . . . . . . . 2 51 4. Extension to Email/set for S/MIME signing and/or 52 encryption . . . . . . . . . . . . . . . . . . . . . . . 2 53 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 5 54 5.1. JMAP capability registration for "smime-advanced" . . . . 5 55 6. Security Considerations . . . . . . . . . . . . . . . . . . . 5 56 7. Normative References . . . . . . . . . . . . . . . . . . . . 5 57 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 6 59 1. Introduction 61 [RFC8621] is a JSON based application protocol for synchronising 62 email data between a client and a server. 64 This document describes an extension to JMAP for sending S/MIME 65 signed and encrypted messages . It allows JMAP server to sign/ 66 encrypt messages on user's behalf. 68 2. Conventions Used in This Document 70 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 71 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 72 document are to be interpreted as described in [RFC2119]. 74 3. Addition to the capabilities object 76 The capabilities object is returned as part of the standard JMAP 77 Session object; see the JMAP spec. Servers supporting _this_ 78 specification MUST add a property called "urn:ietf:params:jmap:smime- 79 advanced" to the capabilities object. 81 The value of this property is an empty object in both the JMAP 82 session _capabilities_ property and an account's 83 _accountCapabilities_ property. 85 4. Extension to Email/set for S/MIME signing and/or encryption 87 [RFC8621] defines Email/set method for creating new email messages. 88 This document defines the following additional request arguments that 89 can be used to create S/MIME signed and/or encrypted messages: 91 * smimeSign: "Boolean" (default: false). If included and has the 92 value "true", this requests the JMAP server to create an S/MIME 93 signed message from the message constructed according to other 94 specified arguments (the "original message"). This is done by 95 encapsulating the original message either inside application/ 96 pkcs7-mime or multipart/signed container. The signature's private 97 key/certificate is associated with the email address in the Sender 98 header field, if present; otherwise, it is associated with the 99 email address in the From header field, if present. 101 If multiple addresses are present in one of these header fields, 102 or there is more than one Sender/From header field, the server 103 SHOULD reject the Email/set as invalid; otherwise, it MUST take 104 the first address in the last Sender/From header field. 106 * smimeEncrypt: "Boolean" (default: false). If included and has the 107 value "true", this requests the JMAP server to create an S/MIME 108 encrypted message from the constructed message. This is done by 109 encapsulating the message inside application/pkcs7-mime media 110 type. The message MUST be encrypted to the sender and all To/Cc/ 111 Bcc recipients. This extension assumes that there is some kind of 112 per user or organizational addressbook, that can be used to lookup 113 public keys of recipients. If lookup of a particular public key 114 fails, or results in an expired or revoked certificate, the Email/ 115 set operation MUST fail. 117 If both "smimeSign" and "smimeEncrypt" are set to true, the message 118 is first signed and then the signed version is encrypted (in that 119 order). 121 (Note that this extension doesn't allow management of private keys/ 122 certificates. How private keys are managed or configured for a 123 particular user is out of scope for this document.) 125 [[How to control header protection?]] 127 [[ "Email/set", { 128 "accountId": "ue150411c", 129 "create": { 130 "k192": { 131 "mailboxIds": { 132 "2ea1ca41b38e": true 133 }, 134 "keywords": { 135 "$seen": true, 136 "$draft": true 137 }, 138 "from": [{ 139 "name": "Joe Bloggs", 140 "email": "joe@example.com" 141 }], 142 "subject": "World domination", 143 "receivedAt": "2021-07-07T01:03:11Z", 144 "sentAt": "2021-07-10T11:03:11+10:00", 145 "smimeSign": true, 146 "smimeEncrypt": true, 147 "bodyStructure": { 148 "type": "text/plain", 149 "partId": "bd48", 150 "header:Content-Language": "en" 151 }, 152 "bodyValues": { 153 "bd48": { 154 "value": "I have the most brilliant plan. Let me tell 155 you all about it.", 156 "isTruncated": false 157 } 158 } 159 } 160 } 161 }, "0" ]] 163 This will result in the following response: 165 [[ "Email/set", { 166 "accountId": "ue150411c", 167 "oldState": "780823", 168 "newState": "780839", 169 "created": { 170 "k192": { 171 "id": "Mf40b5f831efa7233b9eb1c7f", 172 "blobId": "Gf40b5f831efa7233b9eb1c7f8f97d84eeeee64f7", 173 "threadId": "Td957e72e89f516dc", 174 "size": 5096 175 } 176 }, 177 ... 178 }, "0" ]] 180 Figure 1: Example 1: 182 5. IANA Considerations 184 5.1. JMAP capability registration for "smime-advanced" 186 IANA is requested to register the "smime" JMAP Capability as follows: 188 Capability Name: "urn:ietf:params:jmap:smime-advanced" 190 Specification document: this document 192 Intended use: common 194 Change Controller: IETF 196 Security and privacy considerations: this document, Section 6 198 6. Security Considerations 200 This JMAP extension assumes trust between the user and the JMAP 201 server for purposes of signing and encrypting messages on user's 202 behalf. 204 This JMAP extension also relies on access to user's (or 205 organization's) addressbook which contain up-to-date certificates for 206 recipients. 208 This JMAP extension doesn't support management of user's private keys 209 and corresponding certificates. 211 7. Normative References 213 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 214 Requirement Levels", BCP 14, RFC 2119, 215 DOI 10.17487/RFC2119, March 1997, 216 . 218 [RFC8550] Schaad, J., Ramsdell, B., and S. Turner, "Secure/ 219 Multipurpose Internet Mail Extensions (S/MIME) Version 4.0 220 Certificate Handling", RFC 8550, DOI 10.17487/RFC8550, 221 April 2019, . 223 [RFC8551] Schaad, J., Ramsdell, B., and S. Turner, "Secure/ 224 Multipurpose Internet Mail Extensions (S/MIME) Version 4.0 225 Message Specification", RFC 8551, DOI 10.17487/RFC8551, 226 April 2019, . 228 [RFC8620] Jenkins, N. and C. Newman, "The JSON Meta Application 229 Protocol (JMAP)", RFC 8620, DOI 10.17487/RFC8620, July 230 2019, . 232 [RFC8621] Jenkins, N. and C. Newman, "The JSON Meta Application 233 Protocol (JMAP) for Mail", RFC 8621, DOI 10.17487/RFC8621, 234 August 2019, . 236 Author's Address 238 Alexey Melnikov 239 Isode Ltd 240 14 Castle Mews 241 Hampton 242 TW12 2NP 243 United Kingdom 245 Email: Alexey.Melnikov@isode.com