FEP-9091: アクターエクスポートサービスエンドポイントの定義

概要

本FEPでは、「アクターエクスポート」操作を開始するためのAPIエンドポイントを規定します。エクスポート操作の出力形式や意味論については対象外範囲とし、後続のFEPで別途定めるものとします。このエンドポイントが指定するのは操作の開始方法のみであり、さらに言えば、特定のアクターサーバーがこの機能をサポートしているかどうかを判定する方法についても定義しています。

データモデル: エクスポートサービスエンドポイント

準拠するActivityPubアクタープロファイルは、service記述子プロパティを使用してエクスポートAPIエンドポイントを明示的に指定しなければなりません（DID Core Servicesセクションに準拠し、他のFEP［例えばFEP-e3e9: アクター相対URL］でも使用されている形式を採用します）。

service記述子オブジェクトの展開されたtype属性は、必ずhttps://w3id.org/fep/9091#Exportでなければなりません（以下に具体例を示します）。
serviceプロパティには、#Exportタイプを持つノードを複数含めてはなりません。
- クライアントが#Exportで終わる複数のサービス記述オブジェクトを検出した場合、最初のエントリのみを使用する必要があります。

エクスポートサービスエンドポイントを含むアクタープロファイルの例

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://www.w3.org/ns/did/v1"
  ],
  "id": "https://alice-personal-site.example/actor",
  "type": "Person",
  "name": "Alice",
  "service": [{
    "id": "https://alice-personal-site.example/actor#export",
    "type": "https://w3id.org/fep/9091#Export",
    "serviceEndpoint": "https://alice-personal-site.example/actor/accountExport"
  }]
}

プロトコル: アクターエクスポート操作の開始手順

本FEPに準拠するクライアントが「アクターエクスポート」プロセスを開始する場合（例えばアクタープロファイル、秘密鍵マテリアル、およびこのアクターに関連するすべてのコンテンツのバックアップを作成するため）、以下の手順を実行する必要があります：

アクタープロファイルオブジェクトを取得する。
type属性が展開されてhttps://w3id.org/fep/9091#Exportと等しいservice記述子オブジェクトを特定する。
その記述子オブジェクト内に対応するserviceEndpoint URLを見つける。
- そのようなサービス記述項目が存在しない場合、これはアクタープロファイルをホストするサーバーがこの操作をサポートしていないことを示します。
クライアントはserviceEndpointに記載されたURLに対してHTTP POSTリクエストを送信し、エクスポート操作を開始します。
- クライアントは、この操作を実行する権限を有すること（アカウントエクスポートという極めて機密性の高い結果を受け取る権限があること）を示す適切な認証情報を必ず含めなければなりません。これらの認証情報の具体的な形式については、本FEPの対象外範囲とします。

サンプルリクエストとレスポンス

同期型リクエスト（ボディが空の場合）と応答例：

POST /actor/accountExport HTTP/1.1
Host: alice-personal-site.example
Authorization: Bearer ....
Accept: application/x-tar
Content-Length: 0

HTTP/1.1 200 OK
Content-type: application/x-tar
Transfer-Encoding: chunked

<エクスポート結果の.tarファイルのバイナリデータ>

参考文献

FEP-e3e9: アクター相対URL
Christine Lemmer Webber, Jessica Tallon, ActivityPub, 2018年
S. Bradner, 「RFCで要件レベルを示すためのキーワード」, 1997年
Manu Sporny, Dave Longley, Markus Sabadell, Drummond Reed, Orie Steele, Christopher Allen, 分散型識別子（DIDs）v1.0, 2022年

著作権

CC0 1.0 Universal（パブリックドメイン献呈）

法律で認められる範囲内において、本Fediverse拡張提案の著者らは、この著作物に関するすべての著作権および関連する権利を放棄しています。