# 通知設計書 16-errRstSandboxedDirective

## 概要

本ドキュメントは、Nimコンパイラのドキュメント生成機能（docgen）およびRST/Markdownパーサーにおける無効化ディレクティブエラー通知「errRstSandboxedDirective」の設計について記述する。

### 本通知の処理概要

errRstSandboxedDirectiveは、セキュリティ上の理由からサンドボックスモードで無効化されているディレクティブが使用された場合に発生するエラー通知である。

**業務上の目的・背景**：RSTドキュメントには、外部ファイルの読み込み（include）やシステムコマンドの実行（raw）など、セキュリティリスクを伴うディレクティブが存在する。Webアプリケーションや信頼できないソースからのドキュメント処理において、これらのディレクティブを無効化することでXSS攻撃やファイルシステムへの不正アクセスを防止する。

**通知の送信タイミング**：以下の状況で発生する：
1. roSandboxDisabledオプションが無効（サンドボックスモード有効）の状態で、許可リスト（SandboxDirAllowlist）に含まれないディレクティブが使用された場合
2. code-blockディレクティブでfileオプションが使用された場合（roSandboxDisabled無効時）

**通知の受信者**：Nimコンパイラを使用してドキュメント生成（nim doc）を実行している開発者、またはRSTパーサーを使用するアプリケーション開発者。

**通知内容の概要**：エラーが発生したファイル名、行番号、列番号、および無効化されたディレクティブ名を含むエラーメッセージ。

**期待されるアクション**：開発者はセキュリティ要件を確認し、必要であればroSandboxDisabledオプションを有効化するか、許可されたディレクティブで代替する。

## 通知種別

コンパイラ標準エラー出力（stderr）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 高（エラー） |
| リトライ | なし |

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

コンパイラのエラー出力設定（`ConfigRef.m.errorOutputs`）に基づいて、標準エラー出力またはフックされたハンドラに送信される。

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| 送信元 | Nimコンパイラ（docgen/rst） |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Error: disabled directive: '{ディレクティブ名}'
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 無効化されたディレクティブ名 | パーサーが検出したディレクティブ文字列 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ドキュメント生成 | ディレクティブ解析 | 許可リスト外のディレクティブ | selectDir関数でのサンドボックスチェック |
| ドキュメント生成 | code-blockディレクティブ | fileオプション使用 | dirCodeBlock関数でのファイル読み込みチェック |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| roSandboxDisabled有効 | サンドボックスモードが無効化されている場合、エラーは発生しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[RST/Markdownパース開始] --> B[ディレクティブ検出]
    B --> C{roSandboxDisabled?}
    C -->|Yes| D[通常処理]
    C -->|No| E{SandboxDirAllowlist内?}
    E -->|Yes| D
    E -->|No| F[meSandboxedDirective発行]
    F --> G[docgen.compilerMsgHandler]
    G --> H[errRstSandboxedDirectiveに変換]
    H --> I[globalErrorとして出力]
    D --> J[終了]
    I --> J
```

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

### 参照テーブル一覧

該当なし（ファイルベース処理）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 許可リスト外ディレクティブ | include, raw等のセキュリティリスクのあるディレクティブ | roSandboxDisabledを有効化、または許可ディレクティブで代替 |
| fileオプション使用 | code-blockでfileオプション | roSandboxDisabledを有効化、またはファイル内容を直接埋め込み |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | なし |
| 1日あたり上限 | なし |

### 配信時間帯

制限なし（コンパイル実行時に即時出力）

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

- **サンドボックスモード**：デフォルトで有効であり、以下のディレクティブのみ許可：
  - image, code, code-block, admonition, attention, caution, container, contents, danger, default-role, error, figure, hint, important, index, note, role, tip, title, warning
- **セキュリティリスクのあるディレクティブ**：include, raw, importdoc等は、ファイルシステムアクセスやXSS攻撃のリスクがあるためデフォルトで無効
- roSandboxDisabledオプションは信頼できるソースのドキュメント処理時のみ有効化すべき

## 備考

- SandboxDirAllowlistはrst.nimの139-142行目で定義されている
- Webアプリケーションでユーザー入力をRST/Markdownとして処理する場合は、このサンドボックス機能を活用すべき

---

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

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

### 推奨読解順序

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

サンドボックス関連の定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | rst.nim | `lib/packages/docutils/rst.nim` | MsgKind列挙型のmeSandboxedDirective定義（79行目） |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型のerrRstSandboxedDirective定義（45行目） |
| 1-3 | rst.nim | `lib/packages/docutils/rst.nim` | SandboxDirAllowlist定義（139-142行目） |
| 1-4 | rst.nim | `lib/packages/docutils/rst.nim` | RstParseOption列挙型のroSandboxDisabled定義（44-49行目） |

**読解のコツ**: SandboxDirAllowlistには許可されているディレクティブが配列として定義されている。roSandboxDisabledオプションでサンドボックスを無効化できる。

#### Step 2: エラー発行箇所を理解する

サンドボックスチェックとエラー発行の箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | rst.nim | `lib/packages/docutils/rst.nim` | selectDir関数（3473-3474行目） |
| 2-2 | rst.nim | `lib/packages/docutils/rst.nim` | dirCodeBlock関数でのfileオプションチェック（1567-1570行目） |

**主要処理フロー**:
1. **3472-3474行目**: selectDir関数でroSandboxDisabled未設定かつSandboxDirAllowlist外の場合にmeSandboxedDirective発行
2. **1567-1570行目**: code-blockディレクティブでfileオプション使用時のチェック

#### Step 3: メッセージ変換レイヤーを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | docgen.nim | `compiler/docgen.nim` | compilerMsgHandler関数（258行目）でメッセージ変換 |

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

```
nim doc (ドキュメント生成コマンド)
    │
    ├─ docgen.nim::generateDoc
    │      │
    │      └─ rst.nim::rstParse
    │             │
    │             ├─ parseDotDot
    │             │      │
    │             │      └─ selectDir (3469-3503行目)
    │             │             │
    │             │             ├─ roSandboxDisabledチェック (3472行目)
    │             │             │
    │             │             └─ d notin SandboxDirAllowlist (3473行目)
    │             │                    └─ rstMessage(meSandboxedDirective)
    │             │
    │             └─ dirCodeBlock
    │                    │
    │                    └─ fileオプションチェック (1567-1570行目)
    │                           └─ rstMessage(meSandboxedDirective, "file")
    │
    └─ docgen.nim::compilerMsgHandler (258行目)
           │
           └─ msgs.nim::globalError (errRstSandboxedDirective)
```

### データフロー図

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

RST/Markdownファイル ───▶ rst.nim::selectDir ───▶ ディレクティブ名抽出
(".. include::")               │
                               ▼
                         roSandboxDisabledチェック
                               │
                               ▼ [未設定]
                         SandboxDirAllowlistチェック
                               │
                               ▼ [許可リスト外]
                         rstMessage(meSandboxedDirective)
                               │
                               ▼
                         docgen.nim::compilerMsgHandler
                               │
                               ▼
                         TMsgKind(errRstSandboxedDirective)
                               │
                               ▼
                         stderr / 構造化エラーフック
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| rst.nim | `lib/packages/docutils/rst.nim` | ソース | RST/Markdownパーサー、サンドボックス処理 |
| docgen.nim | `compiler/docgen.nim` | ソース | ドキュメント生成器、メッセージハンドラ |
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind列挙型定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | コンパイラメッセージシステム |
