<?xml version="1.0"encoding="utf-8"?> <!-- name="GENERATOR" content="github.com/mmarkdown/mmark Mmark Markdown Processor - mmark.miek.nl" -->encoding="UTF-8"?> <!DOCTYPE rfc [ <!ENTITY nbsp " "> <!ENTITY zwsp "​"> <!ENTITY nbhy "‑"> <!ENTITY wj "⁠"> ]> <rfc version="3" ipr="trust200902" docName="draft-ietf-jmap-blob-18" number="9404" submissionType="IETF" category="std" consensus="true" xml:lang="en" xmlns:xi="http://www.w3.org/2001/XInclude" updates="8620"indexInclude="true" consensus="true">obsoletes="" symRefs="true" sortRefs="true" tocInclude="true"> <front> <title abbrev="JMAPBlob">JMAPBlob">JSON Meta Application Protocol (JMAP) Blobmanagement extension</title><seriesInfo value="draft-ietf-jmap-blob-18" stream="IETF" status="standard" name="Internet-Draft"></seriesInfo>Management Extension</title> <seriesInfo name="RFC" value="9404"/> <author role="editor" initials="B." surname="Gondwana" fullname="BronGondwana"><organization>Fastmail</organization><address><postal><street>LevelGondwana"> <organization>Fastmail</organization> <address> <postal> <street>Level 2, 114 William St</street> <city>Melbourne</city><code>VIC 3000</code><region>VIC</region> <code>3000</code> <country>Australia</country></postal><email>brong@fastmailteam.com</email></postal> <email>brong@fastmailteam.com</email> <uri>https://www.fastmail.com</uri></address></author><date</address></author> <date year="2023"month="January" day="4"></date> <area>Applications</area> <workgroup>JMAP</workgroup>month="August"></date> <area>art</area> <workgroup>jmap</workgroup> <keyword>jmap</keyword> <abstract> <t>TheJMAPJSON Meta Application Protocol (JMAP) base protocol(RFC8620)(RFC 8620) provides the ability to upload and download arbitrary binary data via HTTP POST and GET on a defined endpoint. This binary data is called a"blob".</t>"blob".</t> <t>This extension adds additional ways to create and accessblobs,blobs by making inline method calls within a standard JMAP request.</t> <t>This extension also adds a reverse lookup mechanism to discover where blobs are referenced within other data types.</t> </abstract> </front> <middle> <section anchor="introduction"><name>Introduction</name> <t>Sometimes JMAP(<xref target="RFC8620"></xref>)<xref target="RFC8620"></xref> interactions require creating a blob and then referencing it. In the same way that IMAPLiteralsliterals were extended by <xref target="RFC7888"></xref>, embedding small blobs directly into the JMAP method calls array can be an option for reducingroundtrips.</t>round trips.</t> <t>Likewise, when fetching an object, it can be useful to also fetch the raw content of that object without a separateroundtrip.</t>round trip.</t> <t>Since raw blobs may contain arbitrary binary data, this document defines a use of the base64 coding specified in <xref target="RFC4648"></xref> for both creating and fetching blob data.</t><t>Where<t>When JMAP isbeingproxied through a systemwhichthat applies additional access restrictions, it can be useful to know which objects reference any particularblob, andblob; this document defines a way to discover those references.</t> </section> <section anchor="conventions-used-in-this-document"><name>Conventions UsedInin This Document</name><t>The<t> The key words"MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY","<bcp14>MUST</bcp14>", "<bcp14>MUST NOT</bcp14>", "<bcp14>REQUIRED</bcp14>", "<bcp14>SHALL</bcp14>", "<bcp14>SHALL NOT</bcp14>", "<bcp14>SHOULD</bcp14>", "<bcp14>SHOULD NOT</bcp14>", "<bcp14>RECOMMENDED</bcp14>", "<bcp14>NOT RECOMMENDED</bcp14>", "<bcp14>MAY</bcp14>", and"OPTIONAL""<bcp14>OPTIONAL</bcp14>" in this document are to be interpreted as described inBCP 14BCP 14 <xreftarget="RFC2119"></xref>target="RFC2119"/> <xreftarget="RFC8174"></xref>target="RFC8174"/> when, and only when, they appear in all capitals, as shownhere.</t>here. </t> <t>The definitions of JSON keys and datatypes in the document follow the conventions described inthe core JMAP specification<xref target="RFC8620"></xref>.</t> </section> <section anchor="addition-to-the-capabilities-object"><name>Addition to the Capabilities Object</name> <t>The capabilities object is returned as part of the JMAP Session object; see <xreftarget="RFC8620"></xref>, Section 2.</t>target="RFC8620" sectionFormat="comma" section="2"></xref>.</t> <t>This document defines an additional capability URI.</t> <section anchor="urn-ietf-params-jmap-blob"><name>urn:ietf:params:jmap:blob</name> <t>The presence of the capability <tt>urn:ietf:params:jmap:blob</tt>being presentin the"accountCapabilities"accountCapabilities property of an account represents support for additional API methods on the Blob datatype. Servers that include the capability in one or more"accountCapabilities"accountCapabilities propertiesMUST<bcp14>MUST</bcp14> also include the property in the"capabilities"capabilities property.</t> <t>The value of this property in the JMAPsession "capabilities"Session capabilities propertyMUST<bcp14>MUST</bcp14> be an empty object.</t> <t>The value of this property in an account's"accountCapabilities"accountCapabilities property is an object thatMUST<bcp14>MUST</bcp14> contain the following information on server capabilities and permissions for that account:</t> <ul> <li><t>maxSizeBlobSet:<tt>UnsignedInt|null</tt></t> <t>This is the"UnsignedInt|null"</t> <t>The maximum size of the blob (in octets) that the server will allow to be created (including blobs created by concatenating multiple data sources together).</t> <t>ClientsMUST NOT<bcp14>MUST NOT</bcp14> attempt to create blobs larger than this size.</t> <t>If this value is <tt>null</tt>, then clients are not required to limit the size of the blob they try to create, though servers can always reject creation of blobs regardless ofsize; e.g.size, e.g., due to lack of diskspace,space or per-user ratelimits.</t> </li>limits.</t></li> <li><t>maxDataSources:<tt>UnsignedInt</tt></t>"UnsignedInt"</t> <t>The maximum number of DataSourceObjects allowed per creation in a Blob/upload.</t> <t>ServersMUST<bcp14>MUST</bcp14> allow at least 64 DataSourceObjects percreation.</t> </li>creation.</t></li> <li><t>supportedTypeNames:<tt>String[]</tt></t>"String[]"</t> <t>An array of data type names that are supported for <tt>Blob/lookup</tt>. If the server does not supportlookupslookups, then this will be the empty list.</t><t>NOTE,<t>Note that the supportedTypeNames list may include private typeswhichthat are not in theJMAP Types Registry"JMAP Data Types" registry defined by this document. ClientsMUST<bcp14>MUST</bcp14> ignore type names they do notrecognise.</t> </li>recognise.</t></li> <li><t>supportedDigestAlgorithms:<tt>String[]</tt></t>"String[]"</t> <t>An array of supported digest algorithms that are supported for <tt>Blob/get</tt>. If the server does not support calculating blob digests, then this will be the empty list. Algorithms in this listMUST<bcp14>MUST</bcp14> be present in theHTTP"HTTP DigestAlgorithmsAlgorithm Values" registry defined by <xreftarget="RFC3230"></xref>, and are always lowercased.</t>target="RFC3230"></xref>; however, in JMAP, they must be lowercased, e.g., "md5" rather than "MD5".</t> <t>ClientsSHOULD<bcp14>SHOULD</bcp14> prefer algorithms listed earlier in thislist.</t> </li>list.</t></li> </ul> <section anchor="capability-example"><name>Capability Example</name><artwork>{ "capabilities":<sourcecode type="json"><![CDATA[{ "capabilities": { ...,"urn:ietf:params:jmap:blob":"urn:ietf:params:jmap:blob": {} },"accounts":"accounts": {"A13842":"A13842": { ..."accountCapabilities":"accountCapabilities": {"urn:ietf:params:jmap:blob":"urn:ietf:params:jmap:blob": {"maxSizeBlobSet":"maxSizeBlobSet": 50000000,"maxDataSources":"maxDataSources": 100,"supportedTypeNames""supportedTypeNames" : ["Mailbox", "Thread", "Email""Mailbox", "Thread", "Email" ],"supportedDigestAlgorithms""supportedDigestAlgorithms" : ["sha", "sha-256""sha", "sha-256" ] } } } }} </artwork>}]]></sourcecode> </section> </section> </section> <section anchor="blob-methods"><name>Blob Methods</name> <t>A blob is a sequence of zero or more octets.</t><t>The JMAP base spec<t>JMAP <xreftarget="RFC8620"></xref>target="RFC8620" format="default"/> defines the <tt>Blob/copy</tt> method, which is unchanged by thisspecification,specification and is selected by the <tt>urn:ietf:params:jmap:core</tt> capability.</t> <t>The following JMAPMethodsmethods are selected by the <tt>urn:ietf:params:jmap:blob</tt> capability.</t> <section anchor="blob-upload"><name>Blob/upload</name> <t>This is similar to a Foo/setfromin <xref target="RFC8620"></xref> in someways, howeverways. However, blobscan notcannot be updated or deleted, so only <tt>create</tt> is allowed in the methodcall, andcall. Also, blobs do not have state, so there is no <tt>state</tt> field present in the method response.</t> <t><strong>Parameters</strong></t> <ul> <li><t>accountId:<tt>Id</tt></t>"Id"</t> <t>The id of the account in which the blobs will becreated.</t> </li>created.</t></li> <li><t>create:<tt>Id[UploadObject]</tt></t>"Id[UploadObject]"</t> <t>A map of creation id toUploadObjects.</t> </li>UploadObjects.</t></li> </ul> <t><strong>Result</strong></t> <t>The result is the same as for Foo/set inRFC8620,<xref target="RFC8620" format="default"/>, with <tt>created</tt> and <tt>notCreated</tt> objects mapping from thecreationId.</t>creation id.</t> <t>The <tt>created</tt> objects contain:</t> <ul> <li><t>id:<tt>Id</tt></t> <t>the"Id"</t> <t>The blobIdwhichthat wascreated</t> </li>created.</t></li> <li><t>type:<tt>String|null</tt></t> <t>the"String|null"</t> <t>The media type as given in the creation (ifany); or detected fromany). If not provided, the server <bcp14>MAY</bcp14> perform contentbyanalysis and return one of theserver;following: the calculated value, "application/octet-string", ornull</t> </li>null.</t></li> <li><t>size:<tt>UnsignedInt</tt></t> <t>as"UnsignedInt"</t> <t>As perRFC8620 -<xref target="RFC8620" format="default"/>, the size of the created blob inoctets</t> </li>octets.</t></li> </ul><t>It<t>The created objects will also contain any other properties identical to those that would be returned in the JSON response of theRFC8620upload endpoint(whichdescribed in <xref target="RFC8620" format="default"/>. This may be extended in thefuture -future; in thisdocument anticipatesdocument, it is anticipated that implementations will extend both the upload endpoint and the Blob/upload responses in the sameway)</t> <t>Or ifway.</t> <t>If there is a problem with a creation, then the server will return a <tt>notCreated</tt> response with a map from the failedcreationIdcreation id to a <tt>SetError</tt> object.</t> <t>For each successful upload, serversMUST<bcp14>MUST</bcp14> add an entry to the<tt>creationIds</tt><tt>createdIds</tt> map (<xref target="RFC8620" sectionFormat="comma" section="3.3"/>) for therequest.request; even if the caller did not explicitly pass a createdIds, the value must be available to later methods defined in the same Request Object. This allows theblob idblobId to be used via back-reference in subsequent method calls.</t> <t>The created blob will have the same lifetime and same expiry semantics as any other binary object created via the mechanism specified in[!@RFC8620] section 6.</t><xref target="RFC8620" sectionFormat="comma" section="6"/>.</t> <t>Uploads usingwiththis mechanism will be restricted by the maxUploadSize limit for JMAP requests specified by the server, and clientsSHOULD<bcp14>SHOULD</bcp14> consider using the upload mechanism defined by[!@RFC8620]<xref target="RFC8620" format="default"/> for blobs larger than a megabyte.</t> <t><strong>UploadObject</strong></t> <ul> <li><t>data:<tt>DataSourceObject[]</tt></t> <t>an"DataSourceObject[]"</t> <t>An array of zero or more octet sources in order (zero to create an empty blob). The result of each of these sources is concatenatedtogetherin order to create theblob.</t> </li>blob.</t></li> <li><t>type:<tt>String|null</tt>"String|null" (default: null)</t><t>hint<t>A hint for media type of thedata</t> </li>data.</t></li> </ul> <t><strong>DataSourceObject</strong></t> <t>Exactly one of:</t><ul><ul spacing="normal"> <li><t>data:asText:<tt>String|null</tt>"String|null" (raw octets, must be UTF-8)</t> </li> <li><t>data:asBase64:<tt>String|null</tt>"String|null" (base64 representation of octets)</t> </li> </ul> <t>or a blobId source:</t><ul><ul spacing="normal"> <li><t>blobId:<tt>Id</tt></t>"Id"</t> </li> <li><t>offset:<tt>UnsignedInt|null</tt> (MAY"UnsignedInt|null" (<bcp14>MAY</bcp14> be zero)</t> </li> <li><t>length:<tt>UnsignedInt|null</tt> (MAY"UnsignedInt|null" (<bcp14>MAY</bcp14> be zero)</t> </li> </ul> <t>If<tt>null</tt><tt>null</tt>, then offset is assumed to be zero.</t> <t>If<tt>null</tt><tt>null</tt>, then length is the remaining octets in the blob.</t> <t>If the rangecan notcannot be fully satisfied(i.e.(i.e., it begins or extends past the end of the data in theblob)blob), then the DataSourceObject is invalid and results in a notCreated response for this creation id.</t> <t>If the data properties have any invalid references or invalid data contained in them, the serverMUST NOT<bcp14>MUST NOT</bcp14> guessas tothe user'sintent,intent andMUST<bcp14>MUST</bcp14> reject the creation and return a notCreated response for that creation id.</t> <t>Likewise, invalid characters in the base64 ofdata:asBase64,data:asBase64 or invalid UTF-8 in data:asTextMUST<bcp14>MUST</bcp14> result in anonCreatednotCreated response.</t> <t>It is envisaged that the definition for DataSourceObject might be extended in the future, forexampleexample, to fetch external content.</t> <t>A serverMUST<bcp14>MUST</bcp14> accept at least 64 DataSourceObjects per create, as described inSection 3.1<xref target="urn-ietf-params-jmap-blob" format="default"/> of this document.</t> <section anchor="blob-upload-simple-example"><name>Blob/uploadsimple example</name>Simple Example</name> <t>The data:asBase64 field is set over multiple lines for ease of publicationhere, however allhere; however, the entire data:asBase64 field would be sent as a continuous string with nowhitespacewrapping on the wire.</t><artwork>Method Call:<t>Method Call:</t> <sourcecode type="json"><![CDATA[ ["Blob/upload","Blob/upload", {"accountId": "account1", "create":"accountId": "account1", "create": {"1":"1": {"data""data" : [ {"data:asBase64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKA"data:asBase64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKA AAAA1BMVEX/AAAZ4gk3AAAAAXRSTlN/gFy0ywAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII=",FUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII=" } ],"type": "image/png" }, },"type": "image/png" } } },"R1" ] Response: [ "Blob/upload","R1" ]]]></sourcecode> <t>Response:</t> <sourcecode type="json"><![CDATA[[ "Blob/upload", {"accountId""accountId" :"account1", "created""account1", "created" : {"1":"1": {"id""id" :"G4c6751edf9dd6903ff54b792e432fba781271beb", "type""G4c6751edf9dd6903ff54b792e432fba781271beb", "type" :"image/png", "size""image/png", "size" : 95 } } },}, }, "R1" ] </artwork>"R1" ]]]></sourcecode> </section> <section anchor="blob-upload-complex-example"><name>Blob/uploadcomplex example</name> <artwork>Method Calls:Complex Example</name> <t>Method Calls:</t> <sourcecode type="json"><![CDATA[ [ ["Blob/upload","Blob/upload", {"create":"create": {"b4":"b4": {"data":"data": [ {"data:asText": "The"data:asText": "The quick brown fox jumped over the lazydog."dog." } ] } } },"S4""S4" ], ["Blob/upload","Blob/upload", {"create":"create": {"cat":"cat": {"data":"data": [ {"data:asText": "How""data:asText": "How" }, {"blobId": "#b4", "length":"blobId": "#b4", "length": 7,"offset":"offset": 3 }, {"data:asText": "was t""data:asText": "was t" }, {"blobId": "#b4", "length":"blobId": "#b4", "length": 1,"offset":"offset": 1 }, {"data:asBase64": "YXQ/""data:asBase64": "YXQ/" } ] } } },"CAT""CAT" ], ["Blob/get","Blob/get", {"properties":"properties": ["data:asText", "size""data:asText", "size" ],"ids":"ids": ["#cat""#cat" ] },"G4" ]"G4" ]Responses: []]]></sourcecode> <t>Responses:</t> <sourcecode type="json"><![CDATA[[ ["Blob/upload","Blob/upload", {"oldState":"oldState": null,"created":"created": {"b4":"b4": {"id": "Gc0854fb9fb03c41cce3802cb0d220529e6eef94e", "size":"id": "Gc0854fb9fb03c41cce3802cb0d220529e6eef94e", "size": 45,"type": "application/octet-stream""type": "application/octet-stream" } },"notCreated":"notCreated": null,"accountId": "account1""accountId": "account1" },"S4""S4" ], ["Blob/upload","Blob/upload", {"oldState":"oldState": null,"created":"created": {"cat":"cat": {"id": "Gcc60576f036321ae6e8037ffc56bdee589bd3e23", "size":"id": "Gcc60576f036321ae6e8037ffc56bdee589bd3e23", "size": 19,"type": "application/octet-stream""type": "application/octet-stream" } },"notCreated":"notCreated": null,"accountId": "account1""accountId": "account1" },"CAT""CAT" ], ["Blob/get","Blob/get", {"list":"list": [ {"id": "Gcc60576f036321ae6e8037ffc56bdee589bd3e23", "data:asText": "How"id": "Gcc60576f036321ae6e8037ffc56bdee589bd3e23", "data:asText": "How quick wasthat?", "size":that?", "size": 19 } ],"notFound":"notFound": [],"accountId": "account1""accountId": "account1" },"G4""G4" ]] </artwork>]]]></sourcecode> </section> </section> <section anchor="blob-get"><name>Blob/get</name> <t>A standard JMAP get, with two additional optional parameters:</t> <ul> <li><t>offset:<tt>UnsignedInt|null</tt></t> <t>start"UnsignedInt|null"</t> <t>Start this many octets into the blob data. If null or unspecified, this defaults tozero.</t> </li>zero.</t></li> <li><t>length:<tt>UnsignedInt|null</tt></t> <t>return"UnsignedInt|null"</t> <t>Return at most this many octets of the blob data. If null or unspecified, then all remaining octets in the blob are returned. This can be considered equivalent to an infinitely large length value, except that the isTruncated warning is not given unless the start offset is past the end of theblob.</t> </li>blob.</t></li> </ul> <t><strong>Request Properties:</strong></t> <t>Anyof</t>of:</t> <ulspacing="compact">spacing="normal"> <li>data:asText</li> <li>data:asBase64</li> <li>data (returns data:asText if the selected octets are validUTF-8,UTF-8 or data:asBase64)</li> <li>digest:<algorithm> (where <algorithm> is one of the named algorithms in the <tt>supportedDigestAlgorithms</tt> capability)</li> <li>size</li> </ul> <t>If not given, the propertiesdefaultsdefault to <tt>data</tt> and <tt>size</tt>.</t> <t><strong>Result Properties:</strong></t> <ul> <li><t>data:asText:<tt>String|null</tt></t> <t>the"String|null"</t> <t>The raw octets of the selected range if they are validUTF-8, otherwise null</t> </li>UTF-8; otherwise, null.</t></li> <li><t>data:asBase64:<tt>String</tt></t> <t>the"String"</t> <t>The base64 encoding of the octets in the selectedrange</t> </li> <li><t>digest:<algorithm> <tt>String</tt></t> <t>therange.</t></li> <li><t>digest:<algorithm>: "String"</t> <t>The base64 encoding of the digest of the octets in the selected range, calculated using the namedalgorithm</t> </li>algorithm.</t></li> <li><t>isEncodingProblem:<tt>Boolean</tt>"Boolean" (default:false)</t> </li>false)</t></li> <li><t>isTruncated:<tt>Boolean</tt>"Boolean" (default:false)</t> </li>false)</t></li> <li><t>size:<tt>UnsignedInt</tt></t> <t>the"UnsignedInt"</t> <t>The number of octets in the entireblob</t> </li>blob.</t></li> </ul> <t>The size valueMUST<bcp14>MUST</bcp14> always be the number of octets in the underlying blob, regardless of offset and length.</t> <t>The data fields contain a representation of the octets within the selected range that are present in the blob. If the octets selected are not valid UTF-8 (including truncating in the middle of a multi-octet sequence) and <tt>data</tt> or <tt>data:asText</tt> was requested, then the key <tt>isEncodingProblem</tt>MUST<bcp14>MUST</bcp14> be set to<tt>true</tt><tt>true</tt>, and the <tt>data:asText</tt> response valueMUST<bcp14>MUST</bcp14> be <tt>null</tt>. In the case where <tt>data</tt> was requested and the data is not valid UTF-8, then <tt>data:asBase64</tt>MUST<bcp14>MUST</bcp14> be returned.</t> <t>If the selected range requests data outside the blob(i.e.(i.e., the offset+length is larger than theblob)blob), then the result is either just the octets from the offset to the end of theblob,blob or an empty string if the offset is past the end of the blob. Either way, the<tt>isTruncated</tt>isTruncated property in the resultMUST<bcp14>MUST</bcp14> be set to <tt>true</tt> to tell the client that the requested range could not be fully satisfied. If digest was requested, any <tt>digest</tt> is calculated on the octets that would be returned for a <tt>data</tt> field.</t> <t>ServersSHOULD<bcp14>SHOULD</bcp14> store the size for blobs in a formatwhichthat is efficient to read, and clientsSHOULD<bcp14>SHOULD</bcp14> limit their request to just the size parameter if that is all they need, as fetching blob content could be significantly more expensive and slower for the server.</t> <section anchor="blob-get-simple-example"><name>Blob/getsimple example</name> <t>WhereSimple Example</name> <t>In this example, a blob containing the string"The"The quick brown fox jumped over the lazydog."dog." has blobId <tt>Gc0854fb9fb03c41cce3802cb0d220529e6eef94e</tt>.</t> <t>The first method call requests just the size for multiple blobs, and the second requests both the size and a short range of the data for one of the blobs.</t><artwork>Method Calls:<t>Method Calls:</t> <sourcecode type="json"><![CDATA[[ [[ "Blob/get","Blob/get", {"accountId""accountId" :"account1", "ids""account1", "ids" : ["Gc0854fb9fb03c41cce3802cb0d220529e6eef94e", "not-a-blob""Gc0854fb9fb03c41cce3802cb0d220529e6eef94e", "not-a-blob" ],"properties""properties" : ["data:asText", "digest:sha", "size""data:asText", "digest:sha", "size" ] },"R1""R1" ], ["Blob/get","Blob/get", {"accountId""accountId" :"account1", "ids""account1", "ids" : ["Gc0854fb9fb03c41cce3802cb0d220529e6eef94e""Gc0854fb9fb03c41cce3802cb0d220529e6eef94e" ],"properties""properties" : ["data:asText", "digest:sha", "digest:sha-256", "size""data:asText", "digest:sha", "digest:sha-256", "size" ],"offset""offset" : 4,"length""length" : 9 },"R2" ]"R2" ]Responses:]]]></sourcecode> <t>Responses:</t> <sourcecode type="json"><![CDATA[ [ ["Blob/get","Blob/get", {"accountId": "account1", "list":"accountId": "account1", "list": [ {"id": "Gc0854fb9fb03c41cce3802cb0d220529e6eef94e", "data:asText": "The"id": "Gc0854fb9fb03c41cce3802cb0d220529e6eef94e", "data:asText": "The quick brown fox jumped over the lazydog.", "digest:sha": "wIVPufsDxBzOOALLDSIFKebu+U4=", "size":dog.", "digest:sha": "wIVPufsDxBzOOALLDSIFKebu+U4=", "size": 45 } ],"notFound":"notFound": ["not-a-blob""not-a-blob" ] },"R1""R1" ], ["Blob/get","Blob/get", {"accountId": "account1", "list": [ { "id": "Gc0854fb9fb03c41cce3802cb0d220529e6eef94e", "data:asText": "quick bro", "digest:sha": "QiRAPtfyX8K6tm1iOAtZ87Xj3Ww=", "digest:sha-256": "gdg9INW7lwHK6OQ9u0dwDz2ZY/gubi0En0xlFpKt0OA=", "size":"accountId": "account1", "list": [ { "id": "Gc0854fb9fb03c41cce3802cb0d220529e6eef94e", "data:asText": "quick bro", "digest:sha": "QiRAPtfyX8K6tm1iOAtZ87Xj3Ww=", "digest:sha-256": "gdg9INW7lwHK6OQ9u0dwDz2ZY/gubi0En0xlFpKt0OA=", "size": 45 } ] },"R2" ]"R2" ]</artwork>]]]></sourcecode> </section> <section anchor="blob-get-example-with-range-and-encoding-errors"><name>Blob/getexampleExample withrangeRange andencoding errors</name>Encoding Errors</name> <t>The <tt>b1</tt> value is thetext: "Thetext "The quick brown fox jumped over the \x81\x81fox"dog.", which contains an invalidutf8UTF-8 sequence.</t> <t>The results have the followinginterestingproperties:</t> <ul> <li><t>G1:defaultsDefaults to <tt>data</tt> and<tt>size</tt> -<tt>size</tt>, so b1 returns <tt>isEncodingProblem</tt> and a base64 value.</t> </li> <li><t>G2:sinceSince <tt>data:asText</tt> was explicitly selected, does not attempt to return a value for the data, just <tt>isEncodingProblem</tt> for b1.</t> </li> <li><t>G3:sinceSince only <tt>data:asBase64</tt> was requested, there is no encodingproblemproblem, and both values are returned.</t> </li> <li><t>G4:sinceSince the requested range could be satisfied as text, both blobs are returned as<tt>data:asText</tt><tt>data:asText</tt>, and there is no encoding problem.</t> </li> <li><t>G5:bothBoth blobs cannot satisfy the requested range, so isTruncated is true for both.</t> </li> </ul><t>Note: some<aside><t>Note: Some values have been wrapped for linelength - therelength. There would be nowhitespacewrapping in the <tt>data:asBase64</tt> values on thewire</t> <artwork>Method calls:wire.</t></aside> <t>Method Calls:</t> <sourcecode type="json"><![CDATA[[ [[ "Blob/upload","Blob/upload", {"create":"create": {"b1":"b1": {"data":"data": [ {"data:asBase64": "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZW Qgb3ZlciB0aGUggYEgZG9nLg==""data:asBase64": "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZW Qgb3ZlciB0aGUggYEgZG9nLg==" } ] },"b2":"b2": {"data":"data": [ {"data:asText": "hello world""data:asText": "hello world" } ],"type""type" :"text/plain""text/plain" } } },"S1""S1" ], ["Blob/get","Blob/get", {"ids":"ids": ["#b1", "#b2""#b1", "#b2" ] },"G1""G1" ], ["Blob/get","Blob/get", {"ids":"ids": ["#b1", "#b2""#b1", "#b2" ],"properties":"properties": ["data:asText", "size""data:asText", "size" ] },"G2""G2" ], ["Blob/get","Blob/get", {"ids":"ids": ["#b1", "#b2""#b1", "#b2" ],"properties":"properties": ["data:asBase64", "size""data:asBase64", "size" ] },"G3""G3" ], ["Blob/get","Blob/get", {"offset":"offset": 0,"length":"length": 5,"ids":"ids": ["#b1", "#b2""#b1", "#b2" ] },"G4""G4" ], ["Blob/get","Blob/get", {"offset":"offset": 20,"length":"length": 100,"ids":"ids": ["#b1", "#b2""#b1", "#b2" ] },"G5" ]"G5" ]Responses:]]]></sourcecode> <t>Responses:</t> <sourcecode type="json"><![CDATA[[ [[ "Blob/upload","Blob/upload", {"oldState":"oldState": null,"created":"created": {"b2":"b2": {"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed", "size":"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed", "size": 11,"type": "application/octet-stream""type": "application/octet-stream" },"b1":"b1": {"id": "G72cfa4804194563685d9a4b695f7ba20e7739576", "size":"id": "G72cfa4804194563685d9a4b695f7ba20e7739576", "size": 43,"type": "text/plain""type": "text/plain" } },"updated":"updated": null,"destroyed":"destroyed": null,"notCreated":"notCreated": null,"notUpdated":"notUpdated": null,"notDestroyed":"notDestroyed": null,"accountId": "account1""accountId": "account1" },"S1""S1" ], ["Blob/get","Blob/get", {"list":"list": [ {"id": "G72cfa4804194563685d9a4b695f7ba20e7739576", "isEncodingProblem":"id": "G72cfa4804194563685d9a4b695f7ba20e7739576", "isEncodingProblem": true,"data:asBase64": "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZW Qgb3ZlciB0aGUggYEgZG9nLg==", "size":"data:asBase64": "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZW Qgb3ZlciB0aGUggYEgZG9nLg==", "size": 43 }, {"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed", "data:asText": "hello world", "size":"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed", "data:asText": "hello world", "size": 11 } ],"notFound":"notFound": [],"accountId": "account1""accountId": "account1" },"G1""G1" ], ["Blob/get","Blob/get", {"list":"list": [ {"id": "G72cfa4804194563685d9a4b695f7ba20e7739576", "isEncodingProblem":"id": "G72cfa4804194563685d9a4b695f7ba20e7739576", "isEncodingProblem": true,"size":"size": 43 }, {"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed", "data:asText": "hello world", "size":"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed", "data:asText": "hello world", "size": 11 } ],"notFound":"notFound": [],"accountId": "account1""accountId": "account1" },"G2""G2" ], ["Blob/get","Blob/get", {"list":"list": [ {"id": "G72cfa4804194563685d9a4b695f7ba20e7739576", "data:asBase64": "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZW Qgb3ZlciB0aGUggYEgZG9nLg==", "size":"id": "G72cfa4804194563685d9a4b695f7ba20e7739576", "data:asBase64": "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZW Qgb3ZlciB0aGUggYEgZG9nLg==", "size": 43 }, {"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed", "data:asBase64": "aGVsbG8gd29ybGQ=", "size":"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed", "data:asBase64": "aGVsbG8gd29ybGQ=", "size": 11 } ],"notFound":"notFound": [],"accountId": "account1""accountId": "account1" },"G3""G3" ], ["Blob/get","Blob/get", {"list":"list": [ {"id": "G72cfa4804194563685d9a4b695f7ba20e7739576", "data:asText": "The q", "size":"id": "G72cfa4804194563685d9a4b695f7ba20e7739576", "data:asText": "The q", "size": 43 }, {"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed", "data:asText": "hello", "size":"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed", "data:asText": "hello", "size": 11 } ],"notFound":"notFound": [],"accountId": "account1""accountId": "account1" },"G4""G4" ], ["Blob/get","Blob/get", {"list":"list": [ {"id": "G72cfa4804194563685d9a4b695f7ba20e7739576", "isTruncated":"id": "G72cfa4804194563685d9a4b695f7ba20e7739576", "isTruncated": true,"isEncodingProblem":"isEncodingProblem": true,"data:asBase64": "anVtcGVkIG92ZXIgdGhlIIGBIGRvZy4=", "size":"data:asBase64": "anVtcGVkIG92ZXIgdGhlIIGBIGRvZy4=", "size": 43 }, {"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed", "isTruncated":"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed", "isTruncated": true,"data:asText": "", "size":"data:asText": "", "size": 11 } ],"notFound":"notFound": [],"accountId": "account1""accountId": "account1" },"G5" ]"G5" ]</artwork>]]]></sourcecode> </section> </section> <section anchor="blob-lookup"><name>Blob/lookup</name> <t>Given a list of blobIds, this method does a reverse lookup in each of the provided type names to find the list of Ids within that data typewhichthat reference the provided blob.</t> <t>Since different datatypes will have different semantics of"contains","contains", the definition ofreference"reference" is somewhatloosely defined,loose but roughly means"you"you could discover this blobId by looking at this object or at other objects recursively contained within thisobject".</t>object".</t> <t>Forexampleexample, withan [RFC8621] server,a server that supports <xref target="RFC8621" format="default"/>, ifchecking whethera Mailbox references ablob, thenblob and if any Emails within that Mailbox reference the blobId, then the Mailbox references that blobId. For any Threadwhichthat references an Email that references a blobId, it can be said that the Thread references the blobId.</t><t>But<t>However, this does not mean that if an Email references a Mailbox in its mailboxIds property, then any blobId referenced by other Emails in that Mailbox are also referenced by the initial Email.</t> <t><strong>Parameters</strong></t> <ul> <li><t>accountId:<tt>Id</tt></t>"Id"</t> <t>The id of the account used for the call.</t> </li> <li><t>typeNames:<tt>String[]</tt></t>"String[]"</t> <t>A list of names from the"JMAP"JMAP DataTypes" registry,Types" registry or defined by private extensionswhichthat the client has requested. Only names for which"Can"Can referenceblobs"blobs" is true may be specified, and the capabilitywhichthat defines each type must also be used by the overall JMAP request in which this method is called.</t> <t>If a type name is not known by the server, or the associated capability has not been requested, then the server returns an"unknownDataType""unknownDataType" error.</t> </li> <li><t>ids:<tt>Id[]</tt></t>"Id[]"</t> <t>A list of blobId values to be looked for.</t> </li> </ul> <t><strong>Response</strong></t> <ul> <li><t>list:<tt>BlobInfo[]</tt></t>"BlobInfo[]"</t> <t>A list of BlobInfo objects.</t> </li> </ul> <t><strong>BlobInfo Object</strong></t> <ul> <li><t>id:<tt>Id</tt></t>"Id"</t> <t>TheBlob Identifier.</t>blobId.</t> </li> <li><t>matchedIds:<tt>String[Id[]]</tt></t>"String[Id[]]"</t> <t>A map from type name to a list of Ids of that data type(e.g.(e.g., the name"Email""Email" maps to a list ofemailIds)</t>emailIds).</t> </li> </ul> <t>If a blob is not visible to auser,user or does not exist on the server at all, then the serverMUST<bcp14>MUST</bcp14> still return an empty array for each type as this doesn't leak any information about whether the blob is on the server but not visible to the requesting user.</t> <section anchor="blob-lookup-example"><name>Blob/lookupexample</name> <artwork>Method call: [ "Blob/lookup",Example</name> <t>Method Call:</t> <sourcecode type="json"><![CDATA[[ "Blob/lookup", {"typeNames":"typeNames": ["Mailbox", "Thread", "Email""Mailbox", "Thread", "Email" ],"ids":"ids": ["Gd2f81008cf07d2425418f7f02a3ca63a8bc82003", "not-a-blob""Gd2f81008cf07d2425418f7f02a3ca63a8bc82003", "not-a-blob" ] },"R1" ] Response: [ "Blob/lookup","R1" ]]]></sourcecode> <t>Response:</t> <sourcecode type="json"><![CDATA[[ "Blob/lookup", {"list":"list": [ {"id": "Gd2f81008cf07d2425418f7f02a3ca63a8bc82003", "matchedIds":"id": "Gd2f81008cf07d2425418f7f02a3ca63a8bc82003", "matchedIds": {"Mailbox":"Mailbox": ["M54e97373", "Mcbe6b662""M54e97373", "Mcbe6b662" ],"Thread":"Thread": ["T1530616e""T1530616e" ],"Email":"Email": ["E16e70a73eb4", "E84b0930cf16""E16e70a73eb4", "E84b0930cf16" ] } } ],"notFound":"notFound": ["not-a-blob""not-a-blob" ] },"R1" ] </artwork>"R1" ]]]></sourcecode> </section> </section> </section> <section anchor="security-considerations"><name>Securityconsiderations</name>Considerations</name> <t>All security considerationsoffor JMAP <xref target="RFC8620"></xref> apply to this specification. Additional considerations specific to the data types and functionality introduced by this document are described here.</t> <t>JSON parsers are not all consistent in handling non-UTF-8 data. JMAP requires that all JSON data be UTF-8 encoded, so serversMUST<bcp14>MUST</bcp14> only return a null value if <tt>data:asText</tt> is requested for a range of octetswhichthat is not validUTF-8,UTF-8 and set <tt>isEncodingProblem: true</tt>.</t> <t>ServersMUST<bcp14>MUST</bcp14> apply any access controls, such that if the authenticated user would be unable to discover the blobId by making queries, then this factcan notcannot be discovered via a Blob/lookup. For example, if an Email exists in a Mailboxwhichthat the authenticated user does not have access to see, then that emailIdMUST NOT<bcp14>MUST NOT</bcp14> be returned in a lookup for a blobwhichthat is referenced by that email.</t> <t>The serverMUST NOT<bcp14>MUST NOT</bcp14> trust that the data given to a Blob/upload is awell formedwell-formed instance of the specified mediatype, andtype. Also, if the server attempts to parse the given blob, only hardened parsers designed to deal with arbitrary untrusted data should be used. The serverSHOULD NOT<bcp14>SHOULD NOT</bcp14> reject data on the grounds that it is not a valid specimen of the stated type.</t><t>Blob/upload with<t>With carefully chosen datasourcessources, Blob/upload can be used to recreate dangerous content on the far side of security scanners (anti-virus or exfiltrationscannersscanners, for example)whichthat may be watching the upload endpoint. Server implementationsSHOULD<bcp14>SHOULD</bcp14> provide a hook to allow security scanners to check the resulting blob after concatenating the data sources in the same way that they do for the upload endpoint.</t> <t>Digest algorithms can be expensive for servers to calculate. Serverswhichthat share resources between multiple users should track resource usage byclients,clients and rate-limit expensive operations to avoid resource starvation.</t> </section> <section anchor="iana-considerations"><name>IANAconsiderations</name>Considerations</name> <section anchor="jmap-capability-registration-for-blob"><name>JMAP CapabilityregistrationRegistration for"blob"</name>"blob"</name> <t>IANAis requested to registerhas registered the"blob""blob" JMAPCapabilitycapability as follows:</t><t>Capability Name: urn:ietf:params:jmap:blob</t> <t>Specification document: this document</t> <t>Intended use: common</t> <t>Change Controller: IETF</t> <t>Security<dl newline="false" spacing="compact"> <dt>Capability Name:</dt> <dd>urn:ietf:params:jmap:blob</dd> <dt>Specification document:</dt> <dd>RFC 9404</dd> <dt>Intended use:</dt> <dd>common</dd> <dt>Change Controller:</dt> <dd>IETF</dd> <dt>Security and privacyconsiderations: this document, Section XXX</t>considerations:</dt> <dd>RFC 9404, <xref target="security-considerations" format="default"/></dd> </dl> </section> <section anchor="jmap-error-codes-registration-for-unknowndatatype"><name>JMAP Error Codes Registration for"unknownDataType"</name>"unknownDataType"</name> <t>IANAis requested to registerhas registered the"unknownDataType""unknownDataType" JMAPError Codeerror code as follows:</t><t>JMAP<dl newline="false" spacing="compact"> <dt>JMAP ErrorCode: unknownDataType</t> <t>Intended use: common</t> <t>Change Controller: IETF</t> <t>Reference: this document</t> <t>Description: TheCode:</dt> <dd>unknownDataType</dd> <dt>Intended use:</dt> <dd>common</dd> <dt>Change Controller:</dt> <dd>IETF</dd> <dt>Reference:</dt> <dd>RFC 9404</dd> <dt>Description:</dt> <dd>The server does not recognise this data type, or the capability to enable itwasis notpresent.</t>present in the current Request Object.</dd> </dl> </section> <section anchor="creation-of-jmap-data-types-registry"><name>Creation of"JMAP"JMAP DataTypes"Types" Registry</name> <t>IANAis requested to createhas created a new registry"JMAPcalled "JMAP DataTypes" withTypes". <xref target="ianatable" format="default"/> shows the initialcontent:</t> <table>contents of this new registry.</t> <table anchor="ianatable"> <thead> <tr> <th>Type Name</th> <th>Canreference blobs</th>Ref Blobs</th> <th>CanuseUse forstate change</th>State Change</th> <th>Capability</th> <th>Reference</th> </tr> </thead> <tbody> <tr> <td>Core</td> <td>No</td> <td>No</td> <td>urn:ietf:params:jmap:core</td> <td><xref target="RFC8620"></xref></td> </tr> <tr> <td>PushSubscription</td> <td>No</td> <td>No</td> <td>urn:ietf:params:jmap:core</td> <td><xref target="RFC8620"></xref></td> </tr> <tr> <td>Mailbox</td> <td>Yes</td> <td>Yes</td> <td>urn:ietf:params:jmap:mail</td> <td><xref target="RFC8621"></xref></td> </tr> <tr> <td>Thread</td> <td>Yes</td> <td>Yes</td> <td>urn:ietf:params:jmap:mail</td> <td><xref target="RFC8621"></xref></td> </tr> <tr> <td>Email</td> <td>Yes</td> <td>Yes</td> <td>urn:ietf:params:jmap:mail</td> <td><xref target="RFC8621"></xref></td> </tr> <tr> <td>EmailDelivery</td> <td>No</td> <td>Yes</td> <td>urn:ietf:params:jmap:mail</td> <td><xref target="RFC8621"></xref></td> </tr> <tr> <td>SearchSnippet</td> <td>No</td> <td>No</td> <td>urn:ietf:params:jmap:mail</td> <td><xref target="RFC8621"></xref></td> </tr> <tr> <td>Identity</td> <td>No</td> <td>Yes</td><td>urn:ietf:params:jmap:submission</td><td>urn:ietf:params:jmap:&zwsp;submission</td> <td><xref target="RFC8621"></xref></td> </tr> <tr> <td>EmailSubmission</td> <td>No</td> <td>Yes</td><td>urn:ietf:params:jmap:submission</td><td>urn:ietf:params:jmap:&zwsp;submission</td> <td><xref target="RFC8621"></xref></td> </tr> <tr> <td>VacationResponse</td> <td>No</td> <td>Yes</td><td>urn:ietf:params:jmap:vacationresponse</td><td>urn:ietf:params:jmap:&zwsp;vacationresponse</td> <td><xref target="RFC8621"></xref></td> </tr> <tr> <td>MDN</td> <td>No</td> <td>No</td> <td>urn:ietf:params:jmap:mdn</td><td>[RFC9007]</td><td><xref target="RFC9007"></xref></td> </tr> </tbody></table><t>This</table> <t>The registration policy for this registry is"Specification required", either"Specification Required" <xref target="RFC8126"></xref>. Either an RFC or a similarly stable reference documentwhichdefines a JMAP Data Type and associated capability.</t> <t>IANAis asked towill appoint designated experts to review requests for additions to this registry, with guidance to allow any registrationwhichthat provides a stable document describing thecapability,capability and control over the URI namespacewhereto which the capability URI points.</t> </section> </section><section anchor="changes"><name>Changes</name> <t>EDITOR: please remove this section before publication.</t> <t>The source of this document exists on github at: <eref target="https://github.com/brong/draft-gondwana-jmap-blob/">https://github.com/brong/draft-gondwana-jmap-blob/</eref></t> <t><strong>draft-ietf-jmap-blob-18</strong></t> <ul spacing="compact"> <li>add security considerations for Digest algorithm performance (was supposed to be in -13 but I had a commit that never got pushed)</li> <li><t>artart review:</t> <ul spacing="compact"> <li>clarify that created blobs behave identically to RFC8620 section 6 binary objects.</li> <li>clearer text about "references a blob"</li> <li>remove contractions</li> </ul></li> <li><t>Roman Danyliw DISCUSS</t> <ul spacing="compact"> <li>corrected example text - missing comma and extra data:asBase64.</li> <li>simplify Blob/lookup to not have multiple ways of saying "not found" for a blob and then need a security considerations around it.</li> <li>said that clients SHOULD prefer algorithms earlier in the list.</li> <li>clarified that supportedTypeNames could include private extensions.</li> <li>editorial/spelling fixes</li> </ul></li> <li><t>genart review</t> <ul spacing="compact"> <li>editorial/spelling fixes</li> </ul></li> <li><t>Robert Winton review</t> <ul spacing="compact"> <li>added a suggestion to use the regular upload mechanism for blobs over a megabyte in size.</li> </ul></li> </ul> <t><strong>draft-ietf-jmap-blob-17</strong></t> <ul spacing="compact"> <li>AD review, one more wording nit</li> </ul> <t><strong>draft-ietf-jmap-blob-16</strong></t> <ul spacing="compact"> <li>secdir last-call review changes - nit fixes and security considerations</li> </ul> <t><strong>draft-ietf-jmap-blob-15</strong></t> <ul spacing="compact"> <li>changed capabilities object to MUST contain all specified keys, to align with all other published JMAP extensions.</li> </ul> <t><strong>draft-ietf-jmap-blob-14</strong></t> <ul spacing="compact"> <li>AD review - fixed MUST usage</li> <li>AD review - added instructions regarding expert review for IANA</li> </ul> <t><strong>draft-ietf-jmap-blob-13</strong></t> <ul spacing="compact"> <li>added examples of digest responses</li> </ul> <t><strong>draft-ietf-jmap-blob-12</strong></t> <ul spacing="compact"> <li><t>updates based on Neil Jenkins' feedback:</t> <ul spacing="compact"> <li>fixed [] positions for type specs</li> <li>documented delta between /upload and /set better</li> <li>allowed zero-length blobId sources</li> <li>fixed examples with /set leftovers</li> <li>documented datatypes registry policy</li> </ul></li> <li>added optional "digest" support</li> </ul> <t><strong>draft-ietf-jmap-blob-11</strong>:</t> <ul spacing="compact"> <li><t>updates based on IETF113 feedback:</t> <ul spacing="compact"> <li>added wording to suggest the a Blob/get of just size might be faster</li> <li>added an example with just the size field being selected</li> </ul></li> </ul> <t><strong>draft-ietf-jmap-blob-10</strong>:</t> <ul spacing="compact"> <li>removed remaining references to <tt>catenate</tt>.</li> </ul> <t><strong>draft-ietf-jmap-blob-09</strong>:</t> <ul spacing="compact"> <li>tidied up introduction text</li> <li>replaced Blob/set with Blob/upload</li> <li>made all upload creates take an array of sources to normalise behaviour at the cost of a slightly more complex default case.</li> </ul> <t><strong>draft-ietf-jmap-blob-08</strong>:</t> <ul spacing="compact"> <li>Fixed spelling of Neil's name in acknowledgements</li> <li><t>Last call review (thanks Jim Fenton)</t> <ul spacing="compact"> <li>fixed mmark sillyness causing RFC8620 to be non-normative in the references</li> <li>clarified the capability object and accountCapability object requirements</li> <li>made capability keys much more tightly defined, with mandatory minimum catenate limit and default values.</li> <li>increased use of normative language generally</li> <li>lowercased 'blob' anywhere it wasn't explicitly the object</li> <li>lowercased titles of the columns in the registry</li> </ul></li> </ul> <t><strong>draft-ietf-jmap-blob-07</strong>:</t> <ul spacing="compact"> <li>more examples to cover the interactions of offset, length and encoding checks.</li> </ul> <t><strong>draft-ietf-jmap-blob-06</strong>:</t> <ul spacing="compact"> <li>removed asHex - we only need base64 and text</li> <li>added reference to where base64 is defined</li> <li>made 'destroy' not be allowed</li> <li>expanded JSON examples for readability</li> <li>removed 'expires' from examples</li> </ul> <t><strong>draft-ietf-jmap-blob-05</strong>:</t> <ul spacing="compact"> <li>discovered I hadn't actually included <tt>typeNames</tt> and <tt>matchedIds</tt> anywhere except the updates section, oops!</li> <li>added a catenate example</li> <li>tightened up some text</li> </ul> <t><strong>draft-ieft-jmap-blob-04</strong>:</t> <ul spacing="compact"> <li>added security considerations for scanning <tt>catenate</tt> results</li> </ul> <t><strong>draft-ieft-jmap-blob-03</strong>:</t> <ul spacing="compact"> <li>added capabilities object</li> <li>renamed types to typeNames and matchedIds</li> <li>added details of how to handle non-UTF8 data and truncation in Blob/get</li> <li>added isTruncated and isEncodingProblem to Blob/get to tell the client if the request wasn't entirely satisfied.</li> </ul> <t><strong>draft-ieft-jmap-blob-02</strong>:</t> <ul spacing="compact"> <li>fixed incorrect RFC number in reference and HTTP PUT -> POST, thanks Ken.</li> <li>added acknowledgements section</li> <li>removed all 'datatype' text and changed to 'data type' or 'type name' as appropriate (issue #1 proposal)</li> <li>expanded security considerations section and moved optional Blob/lookup empty case into Blob/lookup section</li> </ul> <t><strong>draft-ieft-jmap-blob-01</strong>:</t> <ul spacing="compact"> <li>renamed 'datatypes' to 'types' to align with PushSubscription from RFC8620.</li> <li>added example for Blob/get</li> <li>specified offset and length precisely</li> </ul> <t><strong>draft-ieft-jmap-blob-00</strong>:</t> <ul spacing="compact"> <li>initial adoption as an IETF document, otherwise identical to draft-gondwana-jmap-blob-02</li> </ul> <t><strong>draft-gondwana-jmap-blob-02</strong></t> <ul spacing="compact"> <li>renamed 'objects' to 'datatypes'</li> <li>specified Blob/lookup</li> <li>added IANA registry for datatypes</li> </ul> <t><strong>draft-gondwana-jmap-blob-01</strong></t> <ul spacing="compact"> <li>added an example</li> </ul> <t><strong>draft-gondwana-jmap-blob-00</strong></t> <ul spacing="compact"> <li>initial proposal</li> </ul> </section> <section anchor="acknowledgements"><name>Acknowledgements</name> <t>Joris Baum, Jim Fenton, Neil Jenkins, Alexey Melnikov, Ken Murchison, Robert Stepanek and the JMAP working group at the IETF.</t> </section></middle> <back> <references><name>References</name> <references><name>Normative References</name> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.3230.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.4648.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8174.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8620.xml"/> </references> <references><name>Informative References</name> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.7888.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8621.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.9007.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8126.xml"/> </references> </references> <section anchor="acknowledgements" numbered="false" toc="default"> <name>Acknowledgements</name> <t><contact fullname="Joris Baum"/>, <contact fullname="Jim Fenton"/>, <contact fullname="Neil Jenkins"/>, <contact fullname="Alexey Melnikov"/>, <contact fullname="Ken Murchison"/>, <contact fullname="Robert Stepanek"/>, and the JMAP Working Group in the IETF.</t> </section> </back> </rfc>