# 機能設計書 241-Test-DbaConnectionAuthScheme

## 概要

本ドキュメントは、SQL Server接続の認証スキームとトランスポートプロトコルの詳細をテストおよびレポートする機能 `Test-DbaConnectionAuthScheme` の設計仕様を記載する。

### 本機能の処理概要

この機能は、SQL Serverの動的管理ビュー `sys.dm_exec_connections` をクエリして、現在のセッションの認証およびトランスポート詳細を取得する。デフォルトでは、ServerName、トランスポートプロトコル、AuthScheme（KerberosまたはNTLM）を含む主要な接続プロパティを返す。

**業務上の目的・背景**：Kerberos認証を期待しているにもかかわらずNTLM認証が使用されている場合の認証トラブルシューティングに特に有用である。SPN（サービスプリンシパル名）の登録とKerberos認証を正しく機能させるために、SQL Serverが報告するServerNameが接続名と一致している必要がある。

**機能の利用シーン**：
- SPN設定の問題診断
- 接続プロトコルのセキュリティ監査
- ドメイン認証が環境内で期待通りに動作しているかの検証
- 複数サーバーにわたる自動化チェックでの認証スキーム検証

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスに接続
2. `sys.dm_exec_connections` から現在のセッション情報を取得
3. 認証スキーム（Kerberos/NTLM）とトランスポートプロトコルを含む接続詳細を返却
4. オプションで特定の認証方式の確認結果を真偽値で返却

**関連システム・外部連携**：SQL Server 2005以上のインスタンスへの接続が必要。Active Directoryおよびドメイン認証環境での使用を想定。

**権限による制御**：接続に使用する資格情報によって取得できる情報が制限される場合がある。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 91 | 接続テスト | 補助機能 | 認証スキームのテスト |

## 機能種別

バリデーション / 診断処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | ターゲットSQL Serverインスタンス | SQL Server 2005以上 |
| SqlCredential | PSCredential | No | 代替資格情報 | 有効なPowerShell資格情報 |
| Kerberos | switch | No | Kerberos認証使用の確認 | - |
| Ntlm | switch | No | NTLM認証使用の確認 | - |
| EnableException | switch | No | 例外のスロー有効化 | - |

### 入力データソース

- PowerShellコマンドライン引数
- パイプライン入力（SqlInstance）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Transport | string | ネットワークトランスポートタイプ |
| AuthScheme | string | 使用されている認証スキーム |
| SessionId | int | 現在のセッションID |
| ConnectTime | DateTime | 接続が確立された日時 |
| Result | bool | 指定された認証方式が使用されているか（-Kerberos/-Ntlm使用時） |

### 出力先

- PowerShellパイプライン出力（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. beginブロックでSQLクエリを準備
   └─ sys.dm_exec_connectionsからの接続情報取得クエリ
2. 各SqlInstanceに対してループ処理
   └─ Connect-DbaInstanceで接続（MinimumVersion 9）
3. 接続情報クエリの実行
   └─ session_id = @@SPIDでフィルタリング
4. 結果の整形と出力
   └─ -Kerberos/-Ntlmスイッチに応じた出力形式の選択
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[SQLクエリ準備]
    B --> C{各インスタンスをループ}
    C --> D[Connect-DbaInstance]
    D --> E{接続成功?}
    E -->|No| F[Stop-Function]
    F --> C
    E -->|Yes| G[Query実行]
    G --> H{-Kerberos or -Ntlm?}
    H -->|Yes| I[真偽値結果を出力]
    H -->|No| J[完全な接続情報を出力]
    I --> C
    J --> C
    C -->|完了| K[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-241-1 | 認証スキーム判定 | AuthSchemeが指定された認証方式と一致するか判定 | -Kerberos or -Ntlm スイッチ指定時 |
| BR-241-2 | 最小バージョン要件 | SQL Server 2005以上（バージョン9以上）が必要 | 常時 |

### 計算ロジック

認証スキーム判定：
```powershell
$auth = if ($Ntlm) { 'NTLM' } else { 'Kerberos' }
$result = ($results.AuthScheme -eq $auth)
```

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

### 操作別データベース影響一覧

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 接続情報取得 | sys.dm_exec_connections | SELECT | 現在のセッションの接続情報を取得 |

### テーブル別操作詳細

#### sys.dm_exec_connections

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | session_id, net_transport, auth_scheme等 | WHERE session_id = @@SPID | 現在のセッションのみ |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | インスタンスへの接続失敗 | Stop-Functionで処理継続 |
| QueryError | クエリエラー | SQLクエリ実行失敗 | Stop-Functionで処理継続 |

### リトライ仕様

リトライ処理なし。各インスタンスに対してContinueでループを継続。

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

読み取り専用操作のため、トランザクション管理は不要。

## パフォーマンス要件

- 単一セッションの情報取得のため、即時応答が期待される
- 複数インスタンス指定時は順次処理

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

- SQL Server認証、Windows認証、Active Directory認証をサポート
- 資格情報はPSCredentialで安全に管理
- MFAサポートが必要な場合はConnect-DbaInstanceの事前使用を推奨

## 備考

- Kerberos認証が期待通り動作しているかの診断に主に使用される
- SPN設定の問題を特定する際に有用

---

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

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

### 推奨読解順序

#### Step 1: コマンド構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Test-DbaConnectionAuthScheme.ps1 | `public/Test-DbaConnectionAuthScheme.ps1` | コマンドの全体構造、パラメータ定義 |

**読解のコツ**: PowerShellの高度な関数構造（CmdletBinding、param、begin/process/end）を理解する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Test-DbaConnectionAuthScheme.ps1 | `public/Test-DbaConnectionAuthScheme.ps1` | processブロックでの各インスタンスへのループ処理 |

**主要処理フロー**:
1. **118-130行目**: beginブロックでSQLクエリを構築
2. **132-138行目**: インスタンスへの接続処理
3. **140-145行目**: クエリ実行
4. **148-162行目**: 結果の出力形式選択と出力

#### Step 3: 接続処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | SQL Server接続の確立方法 |

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

```
Test-DbaConnectionAuthScheme
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server SMO接続
    │
    ├─ $server.Query($sql)
    │      └─ sys.dm_exec_connections
    │
    └─ Select-DefaultView
           └─ 出力プロパティのフィルタリング
```

### データフロー図

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

SqlInstance    ───▶ Connect-DbaInstance ───▶ 接続オブジェクト
                           │
                           ▼
                    sys.dm_exec_connections ───▶ 接続情報
                           │
                           ▼
                    認証スキーム判定 ───▶ PSCustomObject
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Test-DbaConnectionAuthScheme.ps1 | `public/Test-DbaConnectionAuthScheme.ps1` | ソース | メイン機能実装 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続処理 |
