署名と配布

プラグインには 4 種類の入手元があり、それぞれ信頼レベルが異なります。

入手元	場所	署名	有効にする方法
組み込み	AB に同梱	AB と一緒にリリース	既定で利用可能
署名付きカタログ	`config/plugins/<id>/<バージョン>/`	ed25519 署名。AB が検証	インストール API を呼ぶ。インストールすると有効になります
ローカルディレクトリ	`config/plugins/local/<id>/`	なし	「未署名プラグインを許可」をオンにしてから有効化
pip パッケージ	entry point `autobangumi.plugins`	なし	同上

同じ id のプラグインがある場合の優先順位は、組み込み > 署名付きカタログ > ローカル > pip です。未署名プラグインは、ユーザーが設定 → プラグインで先に「未署名プラグインを許可」をオンにしてから有効にします。オフの間、AB は未署名プラグインのコードを一切実行しません。

署名付きカタログ

AB は GitHub release plugins から catalog.json をダウンロードします。カタログの内容は次のとおりです。

json

{
  "schema": 2,
  "plugins": [
    {
      "id": "ntfy-notifier",
      "name": "ntfy 通知",
      "version": "0.1.0",
      "kind": "plugin",
      "extension_points": ["notifier"],
      "sdk": ">=0.5,<1",
      "min_ab_version": "4.0.0-beta.1",
      "description": "…",
      "authors": ["…"],
      "repo": "owner/ntfy-notifier",
      "commit": "…",
      "permissions": ["network"],
      "has_web": false,
      "readme": "…",
      "asset": "ntfy-notifier-0.1.0.zip",
      "sha256": "…"
    }
  ]
}

エントリのフィールド：

フィールド	説明
`authors`	作者のリスト。`plugin.toml` から取得
`repo`	ソースがある GitHub リポジトリ
`commit`	パックに使った 40 文字の完全な SHA
`permissions`	マニフェストが宣言する権限。表示のみ
`has_web`	プラグインにフロントエンドがあるか
`readme`	README のテキスト。最大 16 KB

catalog.json と各 zip には、同名の .sig ファイルが付きます。ファイル全体のバイト列に対する ed25519 署名を base64 で符号化したものです。公開鍵は AB イメージに含まれます。カタログは専用のプラグイン署名鍵を使います。オンライン更新の鍵とは別の鍵です。4.0.0-beta.2 以降の AB はこのプラグイン鍵を信頼します。4.0.0-beta.1 は新しいカタログからインストールできません。

インストール時、AB は次の順に検査します。

catalog.json の署名。
zip の sha256 と署名。未署名のパッケージと署名が不正なパッケージは拒否します。
展開時の zip-slip 対策。展開先の外に出るパスは拒否します。
マニフェストは ab-plugin validate と同じ検査に通る必要があります。マニフェストの id と version はカタログのエントリと一致しなければなりません。sdk の範囲に現在の SDK が含まれ、AB のバージョンが min_ab_version 以上である必要があります。
id は予約 id（core、local）であってはならず、組み込みプラグインと同名であってもいけません。

検査に通ると、AB はプラグインを config/plugins/<id>/<バージョン>/ に展開し、そのバージョンを指す installed.json を書き込み、プラグインを読み込んで有効にします。アンインストールで削除されるのは installed.json のあるディレクトリだけです。ユーザーのローカルプラグインは削除されません。

カタログのプラグインが依存できるのは、標準ライブラリと AB に既にあるパッケージだけです。AB は pip を実行しません。サードパーティの純 Python ライブラリは vendor/ に入れてください。

WebUI からインストールする

設定 → プラグインの「Plugin catalog」（プラグインカタログ）で「Browse catalog」を選ぶと、カタログのプラグインをインストール・更新できます。カタログからインストールしたプラグインのカードには「Uninstall」ボタンがあります。組み込み、ローカル、pip のプラグインにはありません。

API：

リクエスト	説明
`GET /api/v1/plugins/catalog`	カタログのエントリと、この環境にインストール済みのバージョン。カタログに到達できないと 502
`POST /api/v1/plugins/{id}/install`	インストールして有効化
`DELETE /api/v1/plugins/{id}`	アンインストール

予約パス

/plugins/{id}/install と /plugins/catalog はホストが使います。プラグイン自身の api_router では、install、catalog、web をルートのパスに使えません。

プラグインを公開する

作者は EstrellaXD/Auto_Bangumi に PR を作り、プラグインのソースのリポジトリと commit を登録します。CI が検査し、メンテナーが確認してマージします。マージ後、CI がカタログを再構築し、プラグイン署名鍵で署名して、release plugins にアップロードします。秘密鍵は CI の secret にだけ存在します。作者も PR の CI も、秘密鍵には触れられません。

詳しい手順はプラグインを掲載するを参照してください。

SDK の公開

SDK の wheel とプラグイン開発 skill は CI がビルドし、4.0 の各 beta / 正式版の GitHub Release に添付します。メンテナーが手動で公開する必要はありません。ダウンロードとインストールは SDK の入手を参照してください。

署名と配布 ​

署名付きカタログ ​

プラグインを公開する ​

SDK の公開 ​

署名と配布

署名付きカタログ

プラグインを公開する

SDK の公開