[要約] RFC 9404 は、JMAP Blob Management Extension で、JMAP リクエスト内でのインラインメソッド呼び出しによる blob の作成とアクセス方法を追加し、他のデータ型内での blob 参照の逆引き機構を提供することを目的としています。
Internet Engineering Task Force (IETF) B. Gondwana, Ed.
Request for Comments: 9404 Fastmail
Updates: 8620 August 2023
Category: Standards Track
ISSN: 2070-1721
The JSON Meta Application Protocol (JMAP) base protocol (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".
JSONメタアプリケーションプロトコル（JMAP）ベースプロトコル（RFC 8620）は、HTTP投稿を介して任意のバイナリデータをアップロードおよびダウンロードし、定義されたエンドポイントに到達する機能を提供します。このバイナリデータは「ブロブ」と呼ばれます。
This extension adds additional ways to create and access blobs by making inline method calls within a standard JMAP request.
この拡張機能は、標準のJMAP要求内でインラインメソッド呼び出しを作成することにより、ブロブを作成およびアクセスする方法を追加します。
This extension also adds a reverse lookup mechanism to discover where blobs are referenced within other data types.
また、この拡張機能は、逆ルックアップメカニズムを追加して、他のデータ型内でBLOBが参照される場所を発見します。
This is an Internet Standards Track document.
これは、インターネット標準トラックドキュメントです。
This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 7841.
このドキュメントは、インターネットエンジニアリングタスクフォース（IETF）の製品です。IETFコミュニティのコンセンサスを表しています。公開レビューを受けており、インターネットエンジニアリングステアリンググループ（IESG）からの出版が承認されています。インターネット標準の詳細については、RFC 7841のセクション2で入手できます。
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at https://www.rfc-editor.org/info/rfc9404.
このドキュメントの現在のステータス、任意のERRATA、およびそのフィードバックを提供する方法に関する情報は、https：//www.rfc-editor.org/info/rfc9404で取得できます。
Copyright (c) 2023 IETF Trust and the persons identified as the document authors. All rights reserved.
著作権（c）2023 IETF Trustおよび文書著者として特定された人。無断転載を禁じます。
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.
このドキュメントは、BCP 78およびIETFドキュメント（https://trustee.ietf.org/license-info）に関連するIETF Trustの法的規定の対象となります。この文書に関するあなたの権利と制限を説明するので、これらの文書を注意深く確認してください。このドキュメントから抽出されたコードコンポーネントには、セクション4.Eで説明されている法的規定のセクション4.Eで説明されており、改訂されたBSDライセンスで説明されている保証なしで提供されるように、改訂されたBSDライセンステキストを含める必要があります。
1. Introduction
2. Conventions Used in This Document
3. Addition to the Capabilities Object
3.1. urn:ietf:params:jmap:blob
3.1.1. Capability Example
4. Blob Methods
4.1. Blob/upload
4.1.1. Blob/upload Simple Example
4.1.2. Blob/upload Complex Example
4.2. Blob/get
4.2.1. Blob/get Simple Example
4.2.2. Blob/get Example with Range and Encoding Errors
4.3. Blob/lookup
4.3.1. Blob/lookup Example
5. Security Considerations
6. IANA Considerations
6.1. JMAP Capability Registration for "blob"
6.2. JMAP Error Codes Registration for "unknownDataType"
6.3. Creation of "JMAP Data Types" Registry
7. References
7.1. Normative References
7.2. Informative References
Acknowledgements
Author's Address
Sometimes JMAP [RFC8620] interactions require creating a blob and then referencing it. In the same way that IMAP literals were extended by [RFC7888], embedding small blobs directly into the JMAP method calls array can be an option for reducing round trips.
JMAP [RFC8620]相互作用がブロブを作成してから参照する必要がある場合があります。IMAPリテラルが[RFC7888]によって拡張されたのと同じように、小さなブロブをJMAPメソッドコールアレイに直接埋め込むことは、往復を減らすためのオプションになります。
Likewise, when fetching an object, it can be useful to also fetch the raw content of that object without a separate round trip.
同様に、オブジェクトを取得するときは、別の往復なしでそのオブジェクトの生のコンテンツを取得することも役立ちます。
Since raw blobs may contain arbitrary binary data, this document defines a use of the base64 coding specified in [RFC4648] for both creating and fetching blob data.
生のブロブには任意のバイナリデータが含まれている可能性があるため、このドキュメントでは、BLOBデータの作成とフェッチの両方のために[RFC4648]で指定されたBase64コーディングの使用を定義します。
When JMAP is proxied through a system that applies additional access restrictions, it can be useful to know which objects reference any particular blob; this document defines a way to discover those references.
追加のアクセス制限を適用するシステムを介してJMAPがプロキシ化されている場合、どのオブジェクトが特定のBLOBを参照するかを知ることが役立ちます。このドキュメントは、これらの参照を発見する方法を定義しています。
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.
この文書のキーワード "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", および "OPTIONAL" はBCP 14 [RFC2119] [RFC8174]で説明されているように、すべて大文字の場合にのみ解釈されます。
The definitions of JSON keys and datatypes in the document follow the conventions described in [RFC8620].
ドキュメント内のJSONキーとデータ型の定義は、[RFC8620]に記載されている規則に従います。
The capabilities object is returned as part of the JMAP Session object; see [RFC8620], Section 2.
機能オブジェクトは、JMAPセッションオブジェクトの一部として返されます。[RFC8620]、セクション2を参照してください。
This document defines an additional capability URI.
このドキュメントでは、追加の機能URIを定義します。
The presence of the capability urn:ietf:params:jmap:blob in the 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 properties MUST also include the property in the capabilities property.
機能urnの存在：ietf：params：jmap：blob accountcapability in property of and of blobデータ型の追加のAPIメソッドのサポートを表します。1つまたは複数のアカウントキャパニティプロパティの機能を含むサーバーには、機能プロパティにプロパティを含める必要があります。
The value of this property in the JMAP Session capabilities property MUST be an empty object.
JMAPセッション機能プロパティのこのプロパティの値は、空のオブジェクトでなければなりません。
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:
アカウントの勘定勘定プロパティ内のこのプロパティの値は、そのアカウントのサーバー機能と許可に関する次の情報を含める必要があるオブジェクトです。
* maxSizeBlobSet: "UnsignedInt|null"
* maxsizeblobset：「unsignedint | null」
* 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).
* サーバーが作成できるブロブ（オクテット内）の最大サイズ（複数のデータソースを一緒に連結することによって作成されたブロブを含む）。
* Clients MUST NOT attempt to create blobs larger than this size.
* クライアントは、このサイズよりも大きいブロブを作成しようとしてはなりません。
* If this value is null, 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 of size, e.g., due to lack of disk space or per-user rate limits.
* この値がnullの場合、クライアントは作成しようとするブロブのサイズを制限する必要はありませんが、サイズはサイズに関係なく常にブロブの作成を拒否することができます。
* maxDataSources: "UnsignedInt"
* maxdatasources：「unsignedint」
* The maximum number of DataSourceObjects allowed per creation in a Blob/upload.
* ブロブ/アップロードで作成ごとに許可されるデータソースオブジェクトの最大数。
* Servers MUST allow at least 64 DataSourceObjects per creation.
* サーバーは、作成ごとに少なくとも64個のDataSourceObjectsを許可する必要があります。
* supportedTypeNames: "String[]"
* supportedtypenames： "string []"
* An array of data type names that are supported for Blob/lookup. If the server does not support lookups, then this will be the empty list.
* Blob/Lookupにサポートされているデータ型名の配列。サーバーがルックアップをサポートしていない場合、これは空のリストになります。
* Note that the supportedTypeNames list may include private types that are not in the "JMAP Data Types" registry defined by this document. Clients MUST ignore type names they do not recognise.
* supportedtypenamesリストには、このドキュメントで定義された「JMAPデータ型」レジストリにないプライベートタイプが含まれる場合があることに注意してください。クライアントは、認識していないタイプ名を無視する必要があります。
* supportedDigestAlgorithms: "String[]"
* supporteddigestalgorithms： "string []"
* An array of supported digest algorithms that are supported for Blob/get. If the server does not support calculating blob digests, then this will be the empty list. Algorithms in this list MUST be present in the "HTTP Digest Algorithm Values" registry defined by [RFC3230]; however, in JMAP, they must be lowercased, e.g., "md5" rather than "MD5".
* BLOB/GETにサポートされているサポートされているダイジェストアルゴリズムの配列。サーバーが計算BLOBダイジェストをサポートしていない場合、これは空のリストになります。このリストのアルゴリズムは、[RFC3230]で定義された「HTTP Digestアルゴリズム値」レジストリに存在する必要があります。ただし、JMAPでは、「MD5」ではなく「MD5」など、低caseでなければなりません。
* Clients SHOULD prefer algorithms listed earlier in this list.
* クライアントは、このリストの前にリストされているアルゴリズムを希望する必要があります。
{
"capabilities": {
...,
"urn:ietf:params:jmap:blob": {}
},
"accounts": {
"A13842": {
...
"accountCapabilities": {
"urn:ietf:params:jmap:blob": {
"maxSizeBlobSet": 50000000,
"maxDataSources": 100,
"supportedTypeNames" : [
"Mailbox",
"Thread",
"Email"
],
"supportedDigestAlgorithms" : [
"sha",
"sha-256"
]
}
}
}
}
}
A blob is a sequence of zero or more octets.
ブロブは、ゼロ以上のオクテットのシーケンスです。
JMAP [RFC8620] defines the Blob/copy method, which is unchanged by this specification and is selected by the urn:ietf:params:jmap:core capability.
JMAP [RFC8620] BLOB/コピーメソッドを定義します。これは、この仕様で変更されておらず、urn：ietf：params：jmap：core capabilityで選択されます。
The following JMAP methods are selected by the urn:ietf:params:jmap:blob capability.
次のJMAPメソッドは、urnによって選択されます：ietf：params：jmap：blob機能。
This is similar to a Foo/set in [RFC8620] in some ways. However, blobs cannot be updated or deleted, so only create is allowed in the method call. Also, blobs do not have state, so there is no state field present in the method response.
これは、いくつかの点で[RFC8620]のFOO/セットに似ています。ただし、ブロブを更新または削除することはできないため、メソッドコールでは作成のみが許可されます。また、ブロブには状態がないため、メソッド応答には状態フィールドが存在しません。
*Parameters*
*パラメーター*
* accountId: "Id"
* AccountID：「ID」
* The id of the account in which the blobs will be created.
* ブロブが作成されるアカウントのID。
* create: "Id[UploadObject]"
* 作成：「ID [uploadObject]」
* A map of creation id to UploadObjects.
* アップロードするための作成IDのマップ。
*Result*
*結果*
The result is the same as for Foo/set in [RFC8620], with created and notCreated objects mapping from the creation id.
結果は、[RFC8620]のFOO/セットの場合と同じであり、作成されたオブジェクトが作成され、作成されていないオブジェクトが作成IDからマッピングされます。
The created objects contain:
作成されたオブジェクトには次のものが含まれています。
* id: "Id"
* やった"
* The blobId that was created.
* 作成されたブロビド。
* type: "String|null"
* タイプ：「string | null」
* The media type as given in the creation (if any). If not provided, the server MAY perform content analysis and return one of the following: the calculated value, "application/octet-string", or null.
* 作成に記載されているメディアタイプ（ある場合）。提供されていない場合、サーバーはコンテンツ分析を実行し、次のいずれかを返すことができます：計算値「アプリケーション/オクテットストリング」、またはnull。
* size: "UnsignedInt"
* サイズ：「Unsigned Int」
* As per [RFC8620], the size of the created blob in octets.
* [RFC8620]によると、オクテットの作成されたブロブのサイズ。
The created objects will also contain any other properties identical to those that would be returned in the JSON response of the upload endpoint described in [RFC8620]. This may be extended in the future; in this document, it is anticipated that implementations will extend both the upload endpoint and the Blob/upload responses in the same way.
作成されたオブジェクトには、[RFC8620]で説明されているアップロードエンドポイントのJSON応答で返されるものと同一のプロパティが含まれます。これは将来拡張される可能性があります。このドキュメントでは、実装がアップロードエンドポイントとBLOB/アップロード応答の両方を同じ方法で拡張することが予想されます。
If there is a problem with a creation, then the server will return a notCreated response with a map from the failed creation id to a SetError object.
作成に問題がある場合、サーバーは、故障した作成IDからSetErrorオブジェクトにマップを使用して作成されていない応答を返します。
For each successful upload, servers MUST add an entry to the createdIds map ([RFC8620], Section 3.3) for the 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 the blobId to be used via back-reference in subsequent method calls.
アップロードが成功するたびに、サーバーはリクエストのためにcreatedIdsマップ（[RFC8620]、セクション3.3）にエントリを追加する必要があります。発信者がcreatedIdsを明示的に渡さなかった場合でも、同じ要求オブジェクトで定義された後のメソッドで値を使用できる必要があります。これにより、後続のメソッド呼び出しでの後方参照を介してブロビッドを使用できます。
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.
作成されたBLOBは、[RFC8620]、セクション6で指定されたメカニズムを介して作成された他のバイナリオブジェクトと同じ寿命と同じ有効期限セマンティクスを持ちます。
Uploads using this mechanism will be restricted by the maxUploadSize limit for JMAP requests specified by the server, and clients SHOULD consider using the upload mechanism defined by [RFC8620] for blobs larger than a megabyte.
このメカニズムを使用したアップロードは、サーバーによって指定されたJMAP要求のMaxuploAdsize制限によって制限され、クライアントはメガバイトよりも大きいブロブに対して[RFC8620]で定義されたアップロードメカニズムの使用を検討する必要があります。
*UploadObject*
*uploadObject*
* data: "DataSourceObject[]"
* データ：「DataSourceオブジェクト[]」
* An array of zero or more octet sources in order (zero to create an empty blob). The result of each of these sources is concatenated in order to create the blob.
* ゼロ以上のオクテットソースの配列（空のブロブを作成するゼロ）。これらの各ソースの結果は、BLOBを作成するために連結されています。
* type: "String|null" (default: null)
* タイプ：「string | null」（デフォルト：null）
* A hint for media type of the data.
* メディアタイプのデータのヒント。
*DataSourceObject*
*DataSourceObject*
Exactly one of:
ちょうど1つ：
* data:asText: "String|null" (raw octets, must be UTF-8)
* データ：astext： "string | null"（rawオクテット、UTF-8でなければなりません）
* data:asBase64: "String|null" (base64 representation of octets)
* データ：asbase64： "string | null"（base64オクテットの表現）
or a blobId source:
またはブロビッドソース：
* blobId: "Id"
* ブロビッド：「id」
* offset: "UnsignedInt|null" (MAY be zero)
* オフセット：「unsignedint | null」（ゼロになる可能性があります）
* length: "UnsignedInt|null" (MAY be zero)
* 長さ：「unsignedint | null」（ゼロになる可能性があります）
If null, then offset is assumed to be zero.
nullの場合、オフセットはゼロであると想定されます。
If null, then length is the remaining octets in the blob.
nullの場合、長さはブロブの残りのオクテットです。
If the range cannot be fully satisfied (i.e., it begins or extends past the end of the data in the blob), then the DataSourceObject is invalid and results in a notCreated response for this creation id.
範囲を完全に満たすことができない場合（つまり、BLOBのデータの端を過ぎて開始または拡張します）、DataSourceObjectは無効であり、この作成IDに対して作成されていない応答をもたらします。
If the data properties have any invalid references or invalid data contained in them, the server MUST NOT guess the user's intent and MUST reject the creation and return a notCreated response for that creation id.
データプロパティに無効な参照またはそれらに含まれるデータが含まれている場合、サーバーはユーザーの意図を推測してはならず、作成を拒否し、その作成IDに対して作成されていない応答を返す必要があります。
Likewise, invalid characters in the base64 of data:asBase64 or invalid UTF-8 in data:asText MUST result in a notCreated response.
同様に、データのbase64の無効な文字：asbase64または無効なutf-8 in data：astextは、作成されていない応答になる必要があります。
It is envisaged that the definition for DataSourceObject might be extended in the future, for example, to fetch external content.
DataSourceObjectの定義は、たとえば外部コンテンツを取得するために、将来拡張される可能性があることが想定されています。
A server MUST accept at least 64 DataSourceObjects per create, as described in Section 3.1 of this document.
このドキュメントのセクション3.1で説明されているように、サーバーは、作成ごとに少なくとも64のDataSourceObjectsを受け入れる必要があります。
The data:asBase64 field is set over multiple lines for ease of publication here; however, the entire data:asBase64 field would be sent as a continuous string with no wrapping on the wire.
データ：ASBase64フィールドは、ここで公開されやすくするために複数の行に設定されています。ただし、データ全体：asbase64フィールドは、ワイヤーにラッピングなしで連続文字列として送信されます。
Method Call:
メソッドコール：
[
"Blob/upload",
{
"accountId": "account1",
"create": {
"1": {
"data" : [
{
"data:asBase64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKA
AAAA1BMVEX/AAAZ4gk3AAAAAXRSTlN/gFy0ywAAAApJRE
FUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII="
}
],
"type": "image/png"
}
}
},
"R1"
]
Response:
応答：
[
"Blob/upload",
{
"accountId" : "account1",
"created" : {
"1": {
"id" : "G4c6751edf9dd6903ff54b792e432fba781271beb",
"type" : "image/png",
"size" : 95
}
}
},
"R1"
]
Method Calls:
メソッド呼び出し：
[
[
"Blob/upload",
{
"create": {
"b4": {
"data": [
{
"data:asText": "The quick brown fox jumped over the lazy dog."
}
]
}
}
},
"S4"
],
[
"Blob/upload",
{
"create": {
"cat": {
"data": [
{
"data:asText": "How"
},
{
"blobId": "#b4",
"length": 7,
"offset": 3
},
{
"data:asText": "was t"
},
{
"blobId": "#b4",
"length": 1,
"offset": 1
},
{
"data:asBase64": "YXQ/"
}
]
}
}
},
"CAT"
],
[
"Blob/get",
{
"properties": [
"data:asText",
"size"
],
"ids": [
"#cat"
]
},
"G4"
]
]
Responses:
反応：
[
[
"Blob/upload",
{
"oldState": null,
"created": {
"b4": {
"id": "Gc0854fb9fb03c41cce3802cb0d220529e6eef94e",
"size": 45,
"type": "application/octet-stream"
}
},
"notCreated": null,
"accountId": "account1"
},
"S4"
],
[
"Blob/upload",
{
"oldState": null,
"created": {
"cat": {
"id": "Gcc60576f036321ae6e8037ffc56bdee589bd3e23",
"size": 19,
"type": "application/octet-stream"
}
},
"notCreated": null,
"accountId": "account1"
},
"CAT"
],
[
"Blob/get",
{
"list": [
{
"id": "Gcc60576f036321ae6e8037ffc56bdee589bd3e23",
"data:asText": "How quick was that?",
"size": 19
}
],
"notFound": [],
"accountId": "account1"
},
"G4"
]
]
A standard JMAP get, with two additional optional parameters:
2つの追加のオプションパラメーターを備えた標準のJMAP GET：
* offset: "UnsignedInt|null"
* オフセット：「unsignedint | null」
* Start this many octets into the blob data. If null or unspecified, this defaults to zero.
* この多くのオクテットをBLOBデータに開始します。nullまたは不特定の場合、これはデフォルトでゼロになります。
* length: "UnsignedInt|null"
* 長さ：「unsignedint | null」
* 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 the blob.
* BLOBデータのこの多くのオクテットをせいぜい返してください。nullまたは不特定の場合、Blob内のすべての残りのオクテットが返されます。これは、開始オフセットがBLOBの終わりを過ぎない限り、イストランス化された警告が与えられないことを除いて、無限に大きな長さの値に相当すると見なすことができます。
*Request Properties:*
*プロパティのリクエスト：*
Any of:
のいずれか：
* data:asText
* データ：ASTEXT
* data:asBase64
* データ：asbase64
* data (returns data:asText if the selected octets are valid UTF-8 or data:asBase64)
* データ（データを返すデータ：選択したオクテットが有効なUTF-8またはデータ：asbase64の場合ASTEXT）
* digest:<algorithm> (where <algorithm> is one of the named algorithms in the supportedDigestAlgorithms capability)
* ダイジェスト：<algorithm>（ここで<algorithm>は、supportdigestalgorithms機能の指名されたアルゴリズムの1つです）
* size
* サイズ寸法大小判値大きさ
If not given, the properties default to data and size.
指定されていない場合、プロパティはデータとサイズのデフォルトです。
*Result Properties:*
*結果プロパティ：*
* data:asText: "String|null"
* データ：ASTEXT：「String | Null」
* The raw octets of the selected range if they are valid UTF-8; otherwise, null.
* 有効なUTF-8の場合、選択した範囲の生のオクテット。それ以外の場合、null。
* data:asBase64: "String"
* データ：asbase64： "string"
* The base64 encoding of the octets in the selected range.
* 選択した範囲のオクテットのbase64エンコード。
* digest:<algorithm>: "String"
* ダイジェスト：<Algorithm>： "String"
* The base64 encoding of the digest of the octets in the selected range, calculated using the named algorithm.
* 名前付きアルゴリズムを使用して計算された、選択した範囲のオクテットのダイジェストのbase64エンコード。
* isEncodingProblem: "Boolean" (default: false)
* IsencodingProblem：「boolean」（デフォルト：false）
* isTruncated: "Boolean" (default: false)
* ISTRUNCATED：「BOOLEAN」（デフォルト：FALSE）
* size: "UnsignedInt"
* サイズ：「Unsigned Int」
* The number of octets in the entire blob.
* ブロブ全体のオクテットの数。
The size value MUST always be the number of octets in the underlying blob, regardless of offset and length.
サイズ値は、オフセットと長さに関係なく、常に基礎となるブロブのオクテットの数でなければなりません。
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 data or data:asText was requested, then the key isEncodingProblem MUST be set to true, and the data:asText response value MUST be null. In the case where data was requested and the data is not valid UTF-8, then data:asBase64 MUST be returned.
データフィールドには、BLOBに存在する選択した範囲内のオクテットの表現が含まれています。選択されたオクテットが有効なUTF-8（マルチオクセットシーケンスの途中での切り捨てを含む）およびデータまたはデータ：ASTEXTが要求された場合、重要なISENCODING PROMBを真に設定する必要があり、データは次のとおりです。nullになります。データが要求され、データが有効でない場合は、utf-8を有効にしていない場合、データ：asbase64を返す必要があります。
If the selected range requests data outside the blob (i.e., the offset+length is larger than the blob), then the result is either just the octets from the offset to the end of the blob or an empty string if the offset is past the end of the blob. Either way, the isTruncated property in the result MUST be set to true to tell the client that the requested range could not be fully satisfied. If digest was requested, any digest is calculated on the octets that would be returned for a data field.
選択した範囲がブロブの外側のデータを要求する場合（つまり、オフセット長がブロブよりも大きい）、結果は、オフセットからBLOBの端までのオクテット、またはオフセットが終了を過ぎている場合の空の文字列のいずれかです。塊の。いずれにせよ、結果のイスプランスプロパティは、要求された範囲が完全に満たされないことをクライアントに伝えるために真に設定する必要があります。ダイジェストが要求された場合、データフィールドに対して返されるオクテットでダイジェストが計算されます。
Servers SHOULD store the size for blobs in a format that is efficient to read, and clients SHOULD 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.
サーバーは、ブロブのサイズを読み取りに効率的な形式で保存する必要があります。クライアントは、必要なのが必要な場合、要求をサイズパラメーターに制限する必要があります。
In this example, a blob containing the string "The quick brown fox jumped over the lazy dog." has blobId Gc0854fb9fb03c41cce3802cb0d220529e6eef94e.
この例では、「クイックブラウンフォックスが怠zyな犬を飛び越えた」弦を含むブロブ。ブロビッドGC0854FB9FB03C41CCE3802CB0D220529E6EEF94Eを持っています。
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.
最初のメソッドは、複数のブロブのサイズのみを要求し、2番目のメソッドはブロブの1つのデータのサイズと短範囲の両方を要求します。
Method Calls:
メソッド呼び出し：
[
[
"Blob/get",
{
"accountId" : "account1",
"ids" : [
"Gc0854fb9fb03c41cce3802cb0d220529e6eef94e",
"not-a-blob"
],
"properties" : [
"data:asText",
"digest:sha",
"size"
]
},
"R1"
],
[
"Blob/get",
{
"accountId" : "account1",
"ids" : [
"Gc0854fb9fb03c41cce3802cb0d220529e6eef94e"
],
"properties" : [
"data:asText",
"digest:sha",
"digest:sha-256",
"size"
],
"offset" : 4,
"length" : 9
},
"R2"
]
]
Responses:
反応：
[
[
"Blob/get",
{
"accountId": "account1",
"list": [
{
"id": "Gc0854fb9fb03c41cce3802cb0d220529e6eef94e",
"data:asText": "The quick brown fox jumped over the lazy dog.",
"digest:sha": "wIVPufsDxBzOOALLDSIFKebu+U4=",
"size": 45
}
],
"notFound": [
"not-a-blob"
]
},
"R1"
],
[
"Blob/get",
{
"accountId": "account1",
"list": [
{
"id": "Gc0854fb9fb03c41cce3802cb0d220529e6eef94e",
"data:asText": "quick bro",
"digest:sha": "QiRAPtfyX8K6tm1iOAtZ87Xj3Ww=",
"digest:sha-256": "gdg9INW7lwHK6OQ9u0dwDz2ZY/gubi0En0xlFpKt0OA=",
"size": 45
}
]
},
"R2"
]
]
The b1 value is the text "The quick brown fox jumped over the \x81\x81 dog.", which contains an invalid UTF-8 sequence.
B1値は、「クイックブラウンフォックスが\ x81 \ x81 Dogを飛び越えた」というテキストです。これには、無効なUTF-8シーケンスが含まれています。
The results have the following properties:
結果には次の特性があります。
* G1: Defaults to data and size, so b1 returns isEncodingProblem and a base64 value.
* G1：デフォルトはデータとサイズであるため、B1はIsencodingProblemとBase64値を返します。
* G2: Since data:asText was explicitly selected, does not attempt to return a value for the data, just isEncodingProblem for b1.
* G2：データ：ASTEXTが明示的に選択されたため、データの値を返しようとせず、B1の問題が発生します。
* G3: Since only data:asBase64 was requested, there is no encoding problem, and both values are returned.
* G3：データのみ：asbase64が要求されたため、エンコードの問題はなく、両方の値が返されます。
* G4: Since the requested range could be satisfied as text, both blobs are returned as data:asText, and there is no encoding problem.
* G4：要求された範囲はテキストとして満たされる可能性があるため、両方のブロブはデータとして返されます：ASTEXT、およびエンコードの問題はありません。
* G5: Both blobs cannot satisfy the requested range, so isTruncated is true for both.
* G5：両方のブロブが要求された範囲を満たすことができないため、両方にイストランス化されます。
Note: Some values have been wrapped for line length. There would be no wrapping in the data:asBase64 values on the wire.
注：いくつかの値は、ラインの長さでラップされています。データにラッピングはありません：asbase64値はワイヤに値。
Method Calls:
メソッド呼び出し：
[
[
"Blob/upload",
{
"create": {
"b1": {
"data": [
{
"data:asBase64": "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZW
Qgb3ZlciB0aGUggYEgZG9nLg=="
}
]
},
"b2": {
"data": [
{
"data:asText": "hello world"
}
],
"type" : "text/plain"
}
}
},
"S1"
],
[
"Blob/get",
{
"ids": [
"#b1",
"#b2"
]
},
"G1"
],
[
"Blob/get",
{
"ids": [
"#b1",
"#b2"
],
"properties": [
"data:asText",
"size"
]
},
"G2"
],
[
"Blob/get",
{
"ids": [
"#b1",
"#b2"
],
"properties": [
"data:asBase64",
"size"
]
},
"G3"
],
[
"Blob/get",
{
"offset": 0,
"length": 5,
"ids": [
"#b1",
"#b2"
]
},
"G4"
],
[
"Blob/get",
{
"offset": 20,
"length": 100,
"ids": [
"#b1",
"#b2"
]
},
"G5"
]
]
Responses:
反応：
[
[
"Blob/upload",
{
"oldState": null,
"created": {
"b2": {
"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed",
"size": 11,
"type": "application/octet-stream"
},
"b1": {
"id": "G72cfa4804194563685d9a4b695f7ba20e7739576",
"size": 43,
"type": "text/plain"
}
},
"updated": null,
"destroyed": null,
"notCreated": null,
"notUpdated": null,
"notDestroyed": null,
"accountId": "account1"
},
"S1"
],
[
"Blob/get",
{
"list": [
{
"id": "G72cfa4804194563685d9a4b695f7ba20e7739576",
"isEncodingProblem": true,
"data:asBase64": "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZW
Qgb3ZlciB0aGUggYEgZG9nLg==",
"size": 43
},
{
"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed",
"data:asText": "hello world",
"size": 11
}
],
"notFound": [],
"accountId": "account1"
},
"G1"
],
[
"Blob/get",
{
"list": [
{
"id": "G72cfa4804194563685d9a4b695f7ba20e7739576",
"isEncodingProblem": true,
"size": 43
},
{
"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed",
"data:asText": "hello world",
"size": 11
}
],
"notFound": [],
"accountId": "account1"
},
"G2"
],
[
"Blob/get",
{
"list": [
{
"id": "G72cfa4804194563685d9a4b695f7ba20e7739576",
"data:asBase64": "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZW
Qgb3ZlciB0aGUggYEgZG9nLg==",
"size": 43
},
{
"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed",
"data:asBase64": "aGVsbG8gd29ybGQ=",
"size": 11
}
],
"notFound": [],
"accountId": "account1"
},
"G3"
],
[
"Blob/get",
{
"list": [
{
"id": "G72cfa4804194563685d9a4b695f7ba20e7739576",
"data:asText": "The q",
"size": 43
},
{
"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed",
"data:asText": "hello",
"size": 11
}
],
"notFound": [],
"accountId": "account1"
},
"G4"
],
[
"Blob/get",
{
"list": [
{
"id": "G72cfa4804194563685d9a4b695f7ba20e7739576",
"isTruncated": true,
"isEncodingProblem": true,
"data:asBase64": "anVtcGVkIG92ZXIgdGhlIIGBIGRvZy4=",
"size": 43
},
{
"id": "G2aae6c35c94fcfb415dbe95f408b9ce91ee846ed",
"isTruncated": true,
"data:asText": "",
"size": 11
}
],
"notFound": [],
"accountId": "account1"
},
"G5"
]
]
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 type that reference the provided blob.
ブロビドのリストが与えられた場合、この方法は、提供された各タイプ名を逆検索して、そのデータ型内のIDのリストを見つけて、提供されたBLOBを参照します。
Since different datatypes will have different semantics of "contains", the definition of "reference" is somewhat loose but roughly means "you could discover this blobId by looking at this object or at other objects recursively contained within this object".
異なるデータ型には「含まれる」というセマンティクスが異なるため、「参照」の定義はやや緩んでいますが、「このオブジェクトまたはこのオブジェクトに再帰的に含まれる他のオブジェクトを見て、この塊を発見することができます」ということを意味します。
For example, with a server that supports [RFC8621], if a Mailbox references a blob and if any Emails within that Mailbox reference the blobId, then the Mailbox references that blobId. For any Thread that references an Email that references a blobId, it can be said that the Thread references the blobId.
たとえば、[RFC8621]をサポートするサーバーでは、メールボックスがBLOBを参照し、そのメールボックス内の電子メールがブロビッドを参照する場合、メールボックスはそのブロビッドを参照します。ブロビッドを参照する電子メールを参照するスレッドの場合、スレッドはブロビッドを参照すると言えます。
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.
ただし、これは、電子メールがMailboxIdsプロパティのメールボックスを参照している場合、そのメールボックス内の他のメールで参照されるブロビッドも最初の電子メールで参照されることを意味しません。
*Parameters*
*パラメーター*
* accountId: "Id"
* AccountID：「ID」
* The id of the account used for the call.
* アカウントのIDは、呼び出しに使用されました。
* typeNames: "String[]"
* Typenames：「String []」
* A list of names from the "JMAP Data Types" registry or defined by private extensions that the client has requested. Only names for which "Can reference blobs" is true may be specified, and the capability that defines each type must also be used by the overall JMAP request in which this method is called.
* 「JMAPデータ型」レジストリの名前のリスト、またはクライアントが要求したプライベートエクステンションによって定義されています。「Blobsを参照できる」が真である名前のみが指定され、各タイプを定義する機能は、このメソッドが呼び出されるJMAP要求全体でも使用する必要があります。
* If a type name is not known by the server, or the associated capability has not been requested, then the server returns an "unknownDataType" error.
* サーバーによってタイプ名が知られていない場合、または関連する機能が要求されていない場合、サーバーは「不明なdatatype」エラーを返します。
* ids: "Id[]"
* IDS：「ID []」
* A list of blobId values to be looked for.
* 探すべきブロビッド値のリスト。
*Response*
*応答*
* list: "BlobInfo[]"
* リスト：「Blobinfo []」
* A list of BlobInfo objects.
* Blobinfoオブジェクトのリスト。
*BlobInfo Object*
*blobinfoオブジェクト*
* id: "Id"
* やった"
* The blobId.
* ブロビッド。
* matchedIds: "String[Id[]]"
* Matchedids：「String [id []]」
* A map from type name to a list of Ids of that data type (e.g., the name "Email" maps to a list of emailIds).
* タイプ名からそのデータ型のIDのリストまでのマップ（たとえば、「電子メール」という名前のマップに電子メールのリストにマップされます）。
If a blob is not visible to a user or does not exist on the server at all, then the server MUST 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.
ブロブがユーザーに表示されないか、サーバーにまったく存在しない場合、サーバーは各タイプの空の配列を返す必要があります。リクエストユーザーに。
Method Call:
メソッドコール：
[
"Blob/lookup",
{
"typeNames": [
"Mailbox",
"Thread",
"Email"
],
"ids": [
"Gd2f81008cf07d2425418f7f02a3ca63a8bc82003",
"not-a-blob"
]
},
"R1"
]
Response:
応答：
[
"Blob/lookup",
{
"list": [
{
"id": "Gd2f81008cf07d2425418f7f02a3ca63a8bc82003",
"matchedIds": {
"Mailbox": [
"M54e97373",
"Mcbe6b662"
],
"Thread": [
"T1530616e"
],
"Email": [
"E16e70a73eb4",
"E84b0930cf16"
]
}
}
],
"notFound": [
"not-a-blob"
]
},
"R1"
]
All security considerations for JMAP [RFC8620] apply to this specification. Additional considerations specific to the data types and functionality introduced by this document are described here.
JMAP [RFC8620]のすべてのセキュリティ上の考慮事項は、この仕様に適用されます。このドキュメントで導入されたデータ型と機能に固有の追加の考慮事項については、ここで説明します。
JSON parsers are not all consistent in handling non-UTF-8 data. JMAP requires that all JSON data be UTF-8 encoded, so servers MUST only return a null value if data:asText is requested for a range of octets that is not valid UTF-8 and set isEncodingProblem: true.
JSONパーサーは、非UTF-8データの処理においてすべて一貫しているわけではありません。JMAPでは、すべてのJSONデータをUTF-8エンコードする必要があるため、サーバーはデータ：ASTEXTが有効であり、ISENCODING PROBLEM：trueを設定していない範囲のオクテットを要求する場合にのみnull値を返す必要があります。
Servers MUST apply any access controls, such that if the authenticated user would be unable to discover the blobId by making queries, then this fact cannot be discovered via a Blob/lookup. For example, if an Email exists in a Mailbox that the authenticated user does not have access to see, then that emailId MUST NOT be returned in a lookup for a blob that is referenced by that email.
サーバーは、アクセス制御を適用する必要があります。そのため、認証されたユーザーがクエリを作成してブロビッドを発見できない場合、この事実はBLOB/ルックアップで発見できません。たとえば、認証されたユーザーが表示できるようにアクセスできないメールボックスに電子メールが存在する場合、そのメールで参照されているBLOBの検索でそのemailidを返す必要はありません。
The server MUST NOT trust that the data given to a Blob/upload is a well-formed instance of the specified media type. Also, if the server attempts to parse the given blob, only hardened parsers designed to deal with arbitrary untrusted data should be used. The server SHOULD NOT reject data on the grounds that it is not a valid specimen of the stated type.
サーバーは、BLOB/アップロードに与えられたデータが指定されたメディアタイプの適切に形成されたインスタンスであることを信頼してはなりません。また、サーバーが指定されたBLOBを解析しようとする場合、任意の信頼されていないデータを処理するように設計された硬化したパーサーのみを使用する必要があります。サーバーは、指定されたタイプの有効な標本ではないという理由でデータを拒否してはなりません。
With carefully chosen data sources, Blob/upload can be used to recreate dangerous content on the far side of security scanners (anti-virus or exfiltration scanners, for example) that may be watching the upload endpoint. Server implementations SHOULD 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.
慎重に選択されたデータソースを使用すると、BLOB/アップロードを使用して、アップロードエンドポイントを監視している可能性のあるセキュリティスキャナー（たとえば、アンチウイルスまたはXFILTRATIONスキャナーなど）の危険なコンテンツを再現できます。サーバーの実装は、アップロードエンドポイントに対して行うのと同じ方法でデータソースを連結した後、セキュリティスキャナーが結果のブロブを確認できるようにするためのフックを提供する必要があります。
Digest algorithms can be expensive for servers to calculate. Servers that share resources between multiple users should track resource usage by clients and rate-limit expensive operations to avoid resource starvation.
ダイジェストアルゴリズムは、サーバーが計算するのに費用がかかる場合があります。複数のユーザー間でリソースを共有するサーバーは、クライアントによるリソースの使用量を追跡し、リソースの飢vを回避するためにレート制限高価な操作を追跡する必要があります。
IANA has registered the "blob" JMAP capability as follows:
IANAは次のように「BLOB」JMAP機能を登録しています。
Capability Name:
機能名：
urn:ietf:params:jmap:blob
urn：ietf：params：jmap：blob
Specification document:
仕様文書：
RFC 9404
RFC 9404
Intended use:
使用目的：
common
一般コモン通常同じ慣用頻出平凡卑近並並み尋常通俗一介月並み凡常尋常一様唯直よくあるありふれた一般的在り来たり庶民的当たり前の有りがち
Change Controller:
Change Controller：
IETF
IETF
Security and privacy considerations:
セキュリティとプライバシーの考慮事項：
RFC 9404, Section 5
RFC 9404、セクション5
IANA has registered the "unknownDataType" JMAP error code as follows:
IANAは、次のように「不明なdatatype」jmapエラーコードを登録しています。
JMAP Error Code:
JMAPエラーコード：
unknownDataType
不明datype
Intended use:
使用目的：
common
一般コモン通常同じ慣用頻出平凡卑近並並み尋常通俗一介月並み凡常尋常一様唯直よくあるありふれた一般的在り来たり庶民的当たり前の有りがち
Change Controller:
Change Controller：
IETF
IETF
Reference:
参照：
RFC 9404
RFC 9404
Description:
説明：
The server does not recognise this data type, or the capability to enable it is not present in the current Request Object.
サーバーは、このデータ型を認識していません。また、現在のリクエストオブジェクトに存在しないことを有効にする機能は認識されません。
IANA has created a new registry called "JMAP Data Types". Table 1 shows the initial contents of this new registry.
IANAは、「JMAPデータ型」と呼ばれる新しいレジストリを作成しました。表1は、この新しいレジストリの初期内容を示しています。
+================+=====+=======+=========================+=========+
|Type Name |Can |Can Use|Capability |Reference|
| |Ref |for | | |
| |Blobs|State | | |
| | |Change | | |
+================+=====+=======+=========================+=========+
|Core |No |No |urn:ietf:params:jmap:core|[RFC8620]|
+----------------+-----+-------+-------------------------+---------+
|PushSubscription|No |No |urn:ietf:params:jmap:core|[RFC8620]|
+----------------+-----+-------+-------------------------+---------+
|Mailbox |Yes |Yes |urn:ietf:params:jmap:mail|[RFC8621]|
+----------------+-----+-------+-------------------------+---------+
|Thread |Yes |Yes |urn:ietf:params:jmap:mail|[RFC8621]|
+----------------+-----+-------+-------------------------+---------+
|Email |Yes |Yes |urn:ietf:params:jmap:mail|[RFC8621]|
+----------------+-----+-------+-------------------------+---------+
|EmailDelivery |No |Yes |urn:ietf:params:jmap:mail|[RFC8621]|
+----------------+-----+-------+-------------------------+---------+
|SearchSnippet |No |No |urn:ietf:params:jmap:mail|[RFC8621]|
+----------------+-----+-------+-------------------------+---------+
|Identity |No |Yes |urn:ietf:params:jmap: |[RFC8621]|
| | | |submission | |
+----------------+-----+-------+-------------------------+---------+
|EmailSubmission |No |Yes |urn:ietf:params:jmap: |[RFC8621]|
| | | |submission | |
+----------------+-----+-------+-------------------------+---------+
|VacationResponse|No |Yes |urn:ietf:params:jmap: |[RFC8621]|
| | | |vacationresponse | |
+----------------+-----+-------+-------------------------+---------+
|MDN |No |No |urn:ietf:params:jmap:mdn |[RFC9007]|
+----------------+-----+-------+-------------------------+---------+
Table 1
The registration policy for this registry is "Specification Required" [RFC8126]. Either an RFC or a similarly stable reference document defines a JMAP Data Type and associated capability.
このレジストリの登録ポリシーは「必要な仕様」です[RFC8126]。RFCまたは同様に安定した参照ドキュメントのいずれかが、JMAPデータ型と関連する機能を定義します。
IANA will appoint designated experts to review requests for additions to this registry, with guidance to allow any registration that provides a stable document describing the capability and control over the URI namespace to which the capability URI points.
IANAは、指定された専門家を任命して、このレジストリへの追加のリクエストを確認し、URIの能力がURIを指しているURIネームスペースの機能と制御を記述する安定したドキュメントを提供する登録を許可するガイダンスを提供します。
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC3230] Mogul, J. and A. Van Hoff, "Instance Digests in HTTP",
RFC 3230, DOI 10.17487/RFC3230, January 2002,
<https://www.rfc-editor.org/info/rfc3230>.
[RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data
Encodings", RFC 4648, DOI 10.17487/RFC4648, October 2006,
<https://www.rfc-editor.org/info/rfc4648>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8620] Jenkins, N. and C. Newman, "The JSON Meta Application
Protocol (JMAP)", RFC 8620, DOI 10.17487/RFC8620, July
2019, <https://www.rfc-editor.org/info/rfc8620>.
[RFC7888] Melnikov, A., Ed., "IMAP4 Non-synchronizing Literals",
RFC 7888, DOI 10.17487/RFC7888, May 2016,
<https://www.rfc-editor.org/info/rfc7888>.
[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, June 2017,
<https://www.rfc-editor.org/info/rfc8126>.
[RFC8621] Jenkins, N. and C. Newman, "The JSON Meta Application
Protocol (JMAP) for Mail", RFC 8621, DOI 10.17487/RFC8621,
August 2019, <https://www.rfc-editor.org/info/rfc8621>.
[RFC9007] Ouazana, R., Ed., "Handling Message Disposition
Notification with the JSON Meta Application Protocol
(JMAP)", RFC 9007, DOI 10.17487/RFC9007, March 2021,
<https://www.rfc-editor.org/info/rfc9007>.
Joris Baum, Jim Fenton, Neil Jenkins, Alexey Melnikov, Ken Murchison, Robert Stepanek, and the JMAP Working Group in the IETF.
Joris Baum、Jim Fenton、Neil Jenkins、Alexey Melnikov、Ken Murchison、Robert Stepanek、およびIETFのJMAPワーキンググループ。
Bron Gondwana (editor)
Fastmail
Level 2, 114 William St
Melbourne VIC 3000
Australia
Email: brong@fastmailteam.com
URI: https://www.fastmail.com