# 機能設計書 365-Get-DbaFirewallRule

## 概要

本ドキュメントは、SQL ServerコンポーネントのWindowsファイアウォールルールを取得するための dbatools コマンド `Get-DbaFirewallRule` の機能設計を記述する。

### 本機能の処理概要

`Get-DbaFirewallRule` は、ターゲットコンピュータからSQL Server関連のWindowsファイアウォールルール（エンジン、ブラウザ、DAC、データベースミラーリング）を取得するコマンドである。

**業務上の目的・背景**：SQL Server接続問題のトラブルシューティングにおいて、ファイアウォール設定の確認は重要な診断ステップである。手動でのファイアウォール設定確認は時間がかかり、特に複数サーバーの監査時には非効率である。また、セキュリティ監査において、SQL Serverに関連するポート開放状況を文書化する必要がある。

**機能の利用シーン**：
- SQL Server接続問題のネットワークトラブルシューティング
- セキュリティ監査でのファイアウォール設定の文書化
- 新規SQL Serverインストール後のファイアウォール設定確認
- New-DbaFirewallRuleで作成されたルールの確認

**主要な処理内容**：
1. ターゲットコンピュータへのInvoke-Command2実行
2. Get-NetFirewallRuleで'SQL Server'グループのルールを取得
3. Get-NetFirewallPortFilterでプロトコル・ポート情報取得
4. Get-NetFirewallApplicationFilterでプログラムパス取得
5. ルール名からType（Engine/Browser/DAC/DatabaseMirroring）を判定
6. 指定されたTypeに基づくフィルタリングと出力

**関連システム・外部連携**：NetSecurity PowerShellモジュール（Get-NetFirewallRule）

**権限による制御**：ターゲットコンピュータでのリモートPowerShell実行権限が必要

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | CLIツール | 主機能 | PowerShellコンソールから実行 |

## 機能種別

情報取得 / ネットワーク構成確認

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | ターゲットSQL Serverインスタンス | パイプライン対応 |
| Credential | PSCredential | No | 接続資格情報 | - |
| Type | string[] | No | 取得するルール種別 | ValidateSet: Engine, Browser, DAC, DatabaseMirroring, AllInstance |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

- Windows Firewall（NetSecurity PowerShellモジュール経由）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | コンピュータ名 |
| InstanceName | String | SQL Serverインスタンス名（Browserはnull） |
| SqlInstance | String | 完全インスタンス名（Browserはnull） |
| DisplayName | String | ファイアウォールルールの表示名 |
| Type | String | ルール種別（Engine/Browser/DAC/DatabaseMirroring） |
| Protocol | String | プロトコル（TCP/UDP/Any） |
| LocalPort | String | ポート番号 |
| Program | String | 許可プログラムパス |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. Begin ブロック
   └─ リモート実行用ScriptBlockの定義
       └─ Get-NetFirewallRule -Group 'SQL Server'
       └─ Get-NetFirewallPortFilter でポート情報取得
       └─ Get-NetFirewallApplicationFilter でプログラム情報取得

2. Process ブロック - 各SqlInstanceに対して
   └─ Invoke-Command2 でリモートスクリプト実行
   └─ 結果の検証（Successful確認）
   └─ 各ルールにメタ情報を追加:
       ├─ ルール名からType判定（Engine/Browser/DAC/DatabaseMirroring）
       ├─ InstanceName抽出
       └─ SqlInstance構築
   └─ Typeパラメータに基づくフィルタリング:
       ├─ AllInstance: 全ルール出力
       ├─ null: Engine + DAC + (非1433時にBrowser)
       └─ 指定Type: 該当ルールのみ出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[各SqlInstanceループ]
    B --> C[Invoke-Command2実行]
    C --> D{成功?}
    D -->|No| E[エラー出力]
    E --> B
    D -->|Yes| F[各ルールにメタ情報追加]
    F --> G[Type判定]
    G --> H{-Type指定?}
    H -->|AllInstance| I[全ルール出力]
    H -->|null| J{ポート1433?}
    J -->|Yes| K[Engine+DAC出力]
    J -->|No| L[Engine+DAC+Browser出力]
    H -->|指定あり| M[指定Typeのみ出力]
    I --> B
    K --> B
    L --> B
    M --> B
    B --> N{次のInstance?}
    N -->|Yes| B
    N -->|No| O[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | SQLServerグループ | 'SQL Server'グループのルールのみ対象 | 常に |
| BR-02 | Type自動判定 | Type未指定時はEngine+DAC、非1433ならBrowser追加 | Type未指定 |
| BR-03 | ルール名規則 | 'SQL Server default instance'または'SQL Server instance XXX'形式 | New-DbaFirewallRule作成ルール |
| BR-04 | NetSecurity必須 | Get-NetFirewallRuleが必要（Windows機能） | 常に |

### 計算ロジック

ルール名からのType判定:
- `'SQL Server Browser'` → Browser
- `'SQL Server default instance (DAC)'` → DAC
- `'SQL Server default instance (DatabaseMirroring)'` → DatabaseMirroring
- `'SQL Server default instance'` → Engine
- `'SQL Server instance XXX (DAC)'` → DAC
- `'SQL Server instance XXX (DatabaseMirroring)'` → DatabaseMirroring
- `'SQL Server instance XXX'` → Engine

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | SQLデータベースへの操作なし |

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

SQLデータベースへの操作なし（Windowsファイアウォール照会のみ）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 実行エラー | Invoke-Command2失敗 | リモートPS接続確認 |
| - | モジュールエラー | NetSecurityモジュールなし | ターゲットのWindows機能確認 |
| - | ルールなし | SQL Serverルールが存在しない | New-DbaFirewallRuleで作成 |

### リトライ仕様

リトライ処理は実装されていない

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

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

## パフォーマンス要件

特に定義なし。リモートPowerShell実行のためネットワーク遅延に依存。

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

- リモートPowerShell実行権限が必要
- 資格情報はPSCredentialオブジェクトで安全に取り扱う
- ファイアウォール設定の露出に注意

## 備考

- New-DbaFirewallRuleで作成された標準形式のルールのみサポート
- 手動作成ルールや別グループのルールは取得されない
- 機能は限定的で拡張予定あり（将来のbreaking changesに注意）

---

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

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

### 推奨読解順序

#### Step 1: リモートスクリプトブロックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaFirewallRule.ps1 | `public/Get-DbaFirewallRule.ps1` | beginブロック（116-174行目）でリモート実行スクリプトを確認 |

**主要処理フロー**:
- **119行目**: Get-NetFirewallRuleコマンドの存在確認
- **124行目**: Get-NetFirewallRule -Group 'SQL Server'
- **145-154行目**: ルールごとにPortFilter/ApplicationFilterを取得

#### Step 2: ルールメタ情報追加を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaFirewallRule.ps1 | `public/Get-DbaFirewallRule.ps1` | processブロック（205-248行目）でType判定ロジックを確認 |

**主要処理フロー**:
- **206-234行目**: ルール名からType/InstanceName/SqlInstanceを判定
- **222行目**: 正規表現でインスタンス名抽出 `'SQL Server instance (.+) \(DAC\)'`

#### Step 3: 出力フィルタリングを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaFirewallRule.ps1 | `public/Get-DbaFirewallRule.ps1` | processブロック（250-285行目）でTypeフィルタリングを確認 |

**主要処理フロー**:
- **252-255行目**: AllInstance指定時は全出力
- **256-265行目**: Type未指定時の自動判定（Engine+DAC+Browser条件付き）
- **267-284行目**: Type指定時の個別フィルタリング

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

```
Get-DbaFirewallRule
    │
    └─ Invoke-Command2 (リモート実行)
           │
           ├─ Get-NetFirewallRule -Group 'SQL Server'
           │
           ├─ Get-NetFirewallPortFilter
           │
           └─ Get-NetFirewallApplicationFilter
```

### データフロー図

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

SqlInstance ────────────▶ Invoke-Command2
                                │
                                ▼
                         Get-NetFirewallRule
                                │
                                ▼
                         PortFilter/AppFilter追加
                                │
                                ▼
                         Type判定・フィルタリング ───▶ PSCustomObject
                                                      (Type, Protocol, LocalPort)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaFirewallRule.ps1 | `public/Get-DbaFirewallRule.ps1` | ソース | メインコマンド実装 |
| New-DbaFirewallRule.ps1 | `public/New-DbaFirewallRule.ps1` | ソース | ファイアウォールルール作成（関連コマンド） |
| Remove-DbaFirewallRule.ps1 | `public/Remove-DbaFirewallRule.ps1` | ソース | ファイアウォールルール削除（関連コマンド） |
