# 機能設計書 58-実行権限確認

## 概要

本ドキュメントは、Nushellにおける実行権限確認機能の設計仕様を記載する。この機能は、is-adminコマンドを通じてNushellプロセスが管理者（root/Administrator）権限で実行されているかを確認する。

### 本機能の処理概要

実行権限確認機能は、現在のNushellセッションが昇格された権限で実行されているかを判定し、権限に応じた処理分岐を可能にする。

**業務上の目的・背景**：システム管理タスクの多くは管理者権限を必要とする。スクリプト実行前に権限を確認することで、権限不足によるエラーを事前に防ぎ、適切なガイダンスを提供できる。

**機能の利用シーン**：
- 管理者権限が必要なコマンド実行前のチェック
- 権限に応じた処理の分岐
- セキュリティ監査スクリプトでの権限確認
- セットアップスクリプトでの事前確認

**主要な処理内容**：
1. OS固有のAPIを使用した権限チェック
2. 真偽値の返却

**関連システム・外部連携**：
- Unix: nix::unistd::Uid（UID 0の確認）
- Windows: GetTokenInformation API（TOKEN_ELEVATION）

**権限による制御**：本コマンド自体は権限不要

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | CLI専用コマンド |

## 機能種別

権限確認

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| (なし) | - | - | 入力パラメータなし | - |

### 入力データソース

なし（OSから直接取得）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (出力) | Bool | 管理者権限で実行中の場合true |

### 出力先

パイプライン出力

## 処理フロー

### 処理シーケンス

```
1. プラットフォーム判定
   └─ Unix/Windows/WASMを判定
2. 権限チェック実行
   ├─ Unix: nix::unistd::Uid::current().is_root()
   ├─ Windows: GetTokenInformation(TokenElevation)
   └─ WASM: 常にfalse
3. 結果返却
   └─ Bool値として返却
```

### フローチャート

```mermaid
flowchart TD
    A[is-admin実行] --> B{プラットフォーム}
    B -->|Unix| C[Uid::current().is_root()]
    B -->|Windows| D[GetTokenInformation]
    B -->|WASM| E[false固定]
    C --> F[Bool返却]
    D --> G{TokenIsElevated != 0?}
    G -->|Yes| H[true]
    G -->|No| I[false]
    E --> F
    H --> F
    I --> F
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | Unix判定 | UID 0はroot | Unix/Linux/macOS |
| BR-02 | Windows判定 | TOKEN_ELEVATIONで昇格確認 | Windows |
| BR-03 | WASM判定 | 常にfalse（ユーザーシステムなし） | WebAssembly |

### 計算ロジック

特になし

## データベース操作仕様

該当なし

## エラー処理

### エラーケース一覧

本コマンドはエラーを発生させない設計。APIエラー時はfalseを返却。

### リトライ仕様

該当なし

## トランザクション仕様

該当なし

## パフォーマンス要件

特になし（即座に完了）

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

- 本コマンドは情報取得のみで、権限昇格は行わない
- 権限チェック結果を信頼してセキュリティ判断を行う場合は注意が必要

## 備考

- experimentalカテゴリだがCoreカテゴリとして登録
- 検索キーワード: root, administrator, superuser, supervisor

---

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

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

### 推奨読解順序

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

単純なBool値を返すため、特別なデータ構造はない。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | is_admin.rs | `crates/nu-command/src/experimental/is_admin.rs` | シグネチャの確認 |

**読解のコツ**:
- **15-19行目**: シグネチャでNothing → Boolの入出力型を定義
- **22-24行目**: search_termsにroot, administrator等を設定

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | is_admin.rs | `crates/nu-command/src/experimental/is_admin.rs` | run()メソッド |

**主要処理フロー**:
- **26-34行目**: run()でis_root()を呼び出しBool値を返却

#### Step 3: プラットフォーム別実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | is_admin.rs | `crates/nu-command/src/experimental/is_admin.rs` | 各OS用の実装 |

**Unix実装（50-53行目）**:
- nix::unistd::Uid::current().is_root()でUID 0を確認

**Windows実装（55-103行目）**:
- **70-73行目**: OpenProcessToken()でアクセストークン取得
- **80-92行目**: GetTokenInformation(TokenElevation)で昇格状態確認
- **92行目**: TokenIsElevated != 0 で昇格判定
- **96-99行目**: ハンドルのクリーンアップ

**WASM実装（105-109行目）**:
- 常にfalseを返却（ユーザーシステムなし）

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

```
is-admin コマンド
    │
    └─ run()
           │
           └─ is_root()
                  │
                  ├─ [Unix] is_root_impl()
                  │         └─ nix::unistd::Uid::current().is_root()
                  │
                  ├─ [Windows] is_root_impl()
                  │         ├─ OpenProcessToken()
                  │         ├─ GetTokenInformation()
                  │         └─ CloseHandle()
                  │
                  └─ [WASM] is_root_impl()
                            └─ false固定
```

### データフロー図

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

(なし) ─────────────────▶ is_root() ────────────────────▶ Bool (true/false)
                         プラットフォーム別チェック
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| is_admin.rs | `crates/nu-command/src/experimental/is_admin.rs` | ソース | is-adminコマンドの実装 |
