# 通知設計書 22-PLUGIN_TRUST_LOAD

## 概要

本ドキュメントは、Lua Language Serverにおけるプラグイン信頼確認通知（PLUGIN_TRUST_LOAD）の設計について記述する。

### 本通知の処理概要

この通知は、プラグインの読み込み前にユーザーに対して信頼確認を求めるダイアログを表示する機能を提供する。セキュリティ上の理由から、外部プラグインの実行前にユーザーの明示的な許可を得るために使用される。

**業務上の目的・背景**：Lua Language Serverのプラグイン機構では、ユーザーが設定したプラグインコードが言語サーバープロセス内で実行される。悪意のあるプラグインはコンピュータに害を与える可能性があるため、プラグインの読み込み前にユーザーの明示的な同意を得ることがセキュリティ上重要である。

**通知の送信タイミング**：プラグイン初期化時（initPlugin関数内）、プラグインファイルのロード後かつ実行前に、そのプラグインが信頼済みリストに含まれていない場合に送信される。ただし、TRUST_ALL_PLUGINSフラグが設定されている場合、またはクライアントがtrustByClientオプションを持つ場合はスキップされる。

**通知の受信者**：エディタを使用しているユーザー（開発者）。LSPクライアント経由でwindow/showMessageRequest通知として受信する。

**通知内容の概要**：読み込もうとしているプラグインのファイルパスと、悪意のあるプラグインのリスクについての警告メッセージが表示される。ユーザーは「信頼して読み込む」または「読み込まない」を選択できる。

**期待されるアクション**：ユーザーはプラグインの出所を確認し、信頼できる場合は「PLUGIN_TRUST_YES」を、信頼できない場合は「PLUGIN_TRUST_NO」を選択することが期待される。

## 通知種別

LSP window/showMessageRequest通知（ユーザー選択を伴うダイアログ）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（LSP request/response） |
| 優先度 | 高（Warning） |
| リトライ | なし |

### 送信先決定ロジック

LSPクライアント（エディタ）に対してwindow/showMessageRequest通知を送信する。受信者はエディタを操作しているユーザー。

## 通知テンプレート

### LSP通知の場合

| 項目 | 内容 |
|-----|------|
| 通知タイプ | window/showMessageRequest |
| メッセージタイプ | Warning（2） |
| アクション | PLUGIN_TRUST_YES, PLUGIN_TRUST_NO |

### 本文テンプレート

英語版:
```
The current settings try to load the plugin at this location:{pluginPath}

Note that malicious plugin may harm your computer
```

日本語版:
```
現在の設定では、次の場所にあるプラグインを読み込もうとしています：
{pluginPath}

悪意のあるプラグインはコンピュータに害を与える可能性があることにご注意ください。
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| pluginPath | プラグインファイルのパス | scp:get('pluginPath') | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プラグイン初期化 | checkTrustLoad関数呼び出し | !TRUST_ALL_PLUGINS && !trustByClient && !trusted | プラグインが信頼リストにない場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| TRUST_ALL_PLUGINS == true | グローバル設定で全プラグインを信頼する場合 |
| client.getOption('trustByClient') == true | クライアント側で信頼管理を行う場合 |
| プラグインが既に信頼リストに含まれる | LOGPATH/trustedファイルに記録済みの場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[initPlugin呼び出し] --> B[プラグインファイル読み込み]
    B --> C{TRUST_ALL_PLUGINS?}
    C -->|Yes| D[信頼チェックスキップ]
    C -->|No| E{trustByClient?}
    E -->|Yes| D
    E -->|No| F[checkTrustLoad呼び出し]
    F --> G[trustedファイル読み込み]
    G --> H{信頼リストに存在?}
    H -->|Yes| D
    H -->|No| I[awaitRequestMessage送信]
    I --> J{ユーザー選択}
    J -->|PLUGIN_TRUST_YES| K[trustedファイルに追加]
    K --> L[プラグイン実行許可]
    J -->|PLUGIN_TRUST_NO| M[プラグイン読み込み中止]
    J -->|タイムアウト/キャンセル| M
    D --> L
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| trustedファイル | 信頼済みプラグインパスの一覧 | LOGPATH/trusted |

### テーブル別参照項目詳細

#### trustedファイル

| 参照項目 | 用途 | 取得条件 |
|---------|------|---------|
| 各行（プラグインパス） | 信頼済みかどうかの判定 | ファイル全体を読み込み、行単位で比較 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| trustedファイル | 追記 | ユーザーが信頼を選択した場合にプラグインパスを追加 |

#### trustedファイル更新

| 操作 | 項目 | 更新値 | 備考 |
|-----|------|-------|------|
| 追記 | 新しい行 | pluginPath | 改行区切りで追加 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| trustedファイル読み込み失敗 | ファイルが存在しない | 空のリストとして処理（初回起動時） |
| trustedファイル保存失敗 | ディスク書き込みエラー | ログに記録、信頼情報は今回のみ有効 |
| ユーザー応答なし | ダイアログがキャンセル/タイムアウト | false（読み込み拒否）として扱う |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | なし |
| リトライ対象エラー | なし |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | なし（プラグイン初期化時のみ発生） |

### 配信時間帯

制限なし（プラグイン初期化時に即座に表示）

## セキュリティ考慮事項

- この通知自体がセキュリティ機能の一部であり、悪意のあるプラグインからユーザーを保護する目的で設計されている
- 信頼済みリストはローカルファイルシステムに保存され、サーバー側でのみ管理される
- TRUST_ALL_PLUGINSフラグは開発/テスト用途を想定しており、本番環境での使用は推奨されない

## 備考

- PLUGIN_TRUST_YESとPLUGIN_TRUST_NOは本通知の選択肢として表示される
- 信頼済みリストはLOGPATH/trustedファイルに永続化される
- プラグインシステムの詳細については機能設計書「77-プラグインシステム」を参照

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

信頼管理の仕組みとファイル構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | plugin.lua | `script/plugin.lua` | checkTrustLoad関数の全体構造（65-91行目） |

**読解のコツ**: trustedファイルは単純なテキストファイルで、各行がプラグインパスを表す。

#### Step 2: エントリーポイントを理解する

信頼確認のトリガーとなる関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | plugin.lua | `script/plugin.lua` | initPlugin関数（94-167行目）からの呼び出し |
| 2-2 | plugin.lua | `script/plugin.lua` | checkTrustLoad関数（65-91行目）の実装 |

**主要処理フロー**:
1. **66-68行目**: TRUST_ALL_PLUGINSフラグのチェック
2. **70-80行目**: trustedファイルの読み込みと既存信頼のチェック
3. **81-84行目**: awaitRequestMessageによるユーザー確認ダイアログ表示
4. **85-87行目**: ユーザー応答なしの場合の処理
5. **88-90行目**: 信頼承認時のファイル保存

#### Step 3: クライアント通知層を理解する

LSPクライアントへのリクエスト送信処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | client.lua | `script/client.lua` | awaitRequestMessage関数（153-157行目） |
| 3-2 | client.lua | `script/client.lua` | requestMessage関数（119-145行目） |

**主要処理フロー**:
- **133行目**: window/showMessageRequest通知の送信
- **137-144行目**: コールバックでのユーザー選択処理

#### Step 4: ローカライズ層を理解する

メッセージテンプレートの定義を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | script.lua | `locale/en-us/script.lua` | PLUGIN_TRUST_LOAD定義（649-654行目） |
| 4-2 | script.lua | `locale/en-us/script.lua` | PLUGIN_TRUST_YES定義（655-658行目） |
| 4-3 | script.lua | `locale/en-us/script.lua` | PLUGIN_TRUST_NO定義（659-662行目） |

### プログラム呼び出し階層図

```
initPlugin (script/plugin.lua:94)
    │
    ├─ util.loadFile - プラグインファイル読み込み
    │
    ├─ load (Lua標準) - プラグインコードのロード
    │
    └─ checkTrustLoad (script/plugin.lua:65)
           │
           ├─ [TRUST_ALL_PLUGINS] → return true
           │
           ├─ util.loadFile - trustedファイル読み込み
           │
           ├─ util.eachLine - 信頼リストの走査
           │
           └─ client.awaitRequestMessage (script/client.lua:153)
                  │
                  └─ client.requestMessage (script/client.lua:119)
                         │
                         └─ proto.request('window/showMessageRequest')
                                │
                                └─ [ユーザー選択]
                                       │
                                       ├─ [PLUGIN_TRUST_YES] → util.saveFile
                                       │
                                       └─ [PLUGIN_TRUST_NO] → return false
```

### データフロー図

```
[入力]                    [処理]                         [出力]

プラグイン       ───▶  initPlugin              ───▶  プラグイン実行
設定                       │                              or
                           ▼                         読み込み中止
                    checkTrustLoad
                           │
                    ┌──────┴──────┐
                    ▼              ▼
              [信頼済み]     [未信頼]
                    │              │
                    │              ▼
                    │     awaitRequestMessage
                    │              │
                    │              ▼
                    │     window/showMessageRequest ──▶ LSPクライアント
                    │              │
                    │              ▼
                    │     [ユーザー選択]
                    │         │
                    │    ┌────┴────┐
                    │    ▼         ▼
                    │  [YES]     [NO]
                    │    │         │
                    │    ▼         │
                    │ trustedファイル更新
                    │    │         │
                    ▼    ▼         ▼
               return true    return false
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| plugin.lua | `script/plugin.lua` | ソース | プラグインシステムの中核、信頼確認処理 |
| client.lua | `script/client.lua` | ソース | LSPクライアント通信、requestMessage実装 |
| proto.lua | `script/proto/proto.lua` | ソース | LSPプロトコル通信基盤 |
| utility.lua | `script/utility.lua` | ソース | ファイル操作ユーティリティ |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージ定義 |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
| trusted | `{LOGPATH}/trusted` | データ | 信頼済みプラグインリスト |
