# 機能設計書 29-Backup-DbaDbMasterKey

## 概要

本ドキュメントは、SQL Serverデータベースマスターキーを暗号化バックアップファイルにエクスポートするBackup-DbaDbMasterKey機能の設計仕様を記述する。

### 本機能の処理概要

Backup-DbaDbMasterKeyは、SQL Serverデータベースに格納されたデータベースマスターキー（DMK）を暗号化された.keyファイルにエクスポートするPowerShellコマンドレットである。

**業務上の目的・背景**：データベースマスターキーは、TDE（透過的データ暗号化）、列レベル暗号化、およびその他のSQL Server暗号化機能の基盤である。DMKを失った場合、暗号化されたデータは永久にアクセス不能になる。本機能は、災害復旧計画およびコンプライアンス要件の一環として、DMKを安全にバックアップする手段を提供する。

**機能の利用シーン**：
- TDE有効化前のマスターキーバックアップ
- サーバー移行前のマスターキーエクスポート
- 災害復旧計画の一環としての定期バックアップ
- コンプライアンス要件に基づく暗号化キー管理

**主要な処理内容**：
1. SqlInstanceまたはInputObjectパラメータから対象データベースを特定
2. Get-DbaDatabaseを使用してデータベースオブジェクトを取得
3. 各データベースのMasterKeyプロパティを確認
4. MasterKey.Export()メソッドで.keyファイルにエクスポート
5. 結果をSMO MasterKeyオブジェクト（プロパティ追加）として返却

**関連システム・外部連携**：SQL Server Management Objects (SMO) のMasterKeyクラスを使用してSQL Serverと連携する。

**権限による制御**：データベースマスターキーの読み取り権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 32 | マスターキー管理 | 補助機能 | データベースマスターキーのバックアップ |

## 機能種別

ファイル出力（暗号化キーエクスポート）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス | - |
| SqlCredential | PSCredential | No | SQL Server認証情報 | - |
| Credential | PSCredential | No | パスワード代替指定 | - |
| Database | string[] | No | 対象データベース名 | - |
| ExcludeDatabase | string[] | No | 除外データベース名 | - |
| SecurePassword | SecureString | No | エクスポートファイル暗号化パスワード | Passwordエイリアスあり |
| Path | string | No | 出力先ディレクトリ | - |
| FileBaseName | string | No | カスタムファイルベース名 | 単一DB用 |
| InputObject | Database[] | No | パイプラインからのDBオブジェクト | - |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

- SqlInstanceパラメータ：SQL Serverインスタンス名の直接指定
- InputObjectパラメータ：Get-DbaDatabaseからのパイプライン入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Database | string | データベース名 |
| DatabaseID | int | データベースID |
| Path (Filename) | string | エクスポートされた.keyファイルパス |
| Status | string | 処理結果（"Success"または"Failure"） |

### 出力先

- PowerShellパイプライン（Microsoft.SqlServer.Management.Smo.MasterKeyオブジェクト＋追加プロパティ）
- ディスクファイル（.key）

## 処理フロー

### 処理シーケンス

```
1. パスワード取得
   └─ CredentialからSecurePasswordを抽出（指定時）
2. データベース取得
   └─ Get-DbaDatabaseで対象DBを取得
3. 各DBに対する処理
   ├─ Path未指定時はBackupDirectoryを使用
   ├─ DB.MasterKey存在確認
   ├─ SecurePassword未指定時は対話入力
   ├─ ファイル名生成（instance-database-masterkey形式）
   ├─ 既存ファイルチェック（存在時はタイムスタンプ付加）
   └─ MasterKey.Export()でエクスポート
4. 結果出力
   └─ MasterKeyオブジェクト（プロパティ追加）を返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{Credential指定?}
    B -->|Yes| C[SecurePassword抽出]
    B -->|No| D[Get-DbaDatabase]
    C --> D
    D --> E[foreach db in InputObject]
    E --> F{Path指定?}
    F -->|No| G[BackupDirectory使用]
    F -->|Yes| H[指定Pathを使用]
    G --> I{Path有効?}
    H --> I
    I -->|No| J[Stop-Function]
    I -->|Yes| K{DBアクセス可能?}
    K -->|No| L[警告出力・スキップ]
    K -->|Yes| M{MasterKey存在?}
    M -->|No| N[メッセージ出力・スキップ]
    M -->|Yes| O{SecurePassword指定?}
    O -->|No| P[対話入力]
    O -->|Yes| Q[ファイル名生成]
    P --> Q
    Q --> R{ファイル存在?}
    R -->|Yes| S[タイムスタンプ付加]
    R -->|No| T[Export実行]
    S --> T
    T --> U{成功?}
    U -->|Yes| V[プロパティ追加]
    U -->|No| W[Failure設定]
    V --> X[結果出力]
    W --> X
    J --> Y{次のDB?}
    L --> Y
    N --> Y
    X --> Y
    Y -->|Yes| E
    Y -->|No| Z[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | デフォルト出力先 | Path未指定時はインスタンスのBackupDirectory | Path未指定時 |
| BR-02 | MasterKey存在確認 | MasterKeyがないDBはスキップ | 常時 |
| BR-03 | 対話パスワード入力 | SecurePassword未指定時はRead-Hostで入力 | SecurePassword/Credential未指定時 |
| BR-04 | パスワード確認入力 | 対話入力時は2回入力で一致確認 | 対話入力時 |
| BR-05 | ファイル名衝突回避 | 既存ファイルがある場合はタイムスタンプ付加 | ファイル存在時 |
| BR-06 | ファイル名形式 | instance-database-masterkey.key形式 | FileBaseName未指定時 |

### 計算ロジック

#### ファイル名生成
- 標準形式：`{fileinstance}-{dbname}-masterkey.key`
- fileinstance: インスタンス名の`\`を`$`に置換

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

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

| 操作 | 対象 | 操作種別 | 概要 |
|-----|------|---------|------|
| sys.symmetric_keys | 対象DB | SELECT | マスターキー情報読み取り |

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

#### sys.symmetric_keys

SMOのMasterKey.Export()メソッドは内部的にBACKUP MASTER KEY文を実行する。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | パスエラー | Path discovery失敗 | Stop-Function -Continue |
| - | アクセスエラー | SQL Serverがパスにアクセス不可 | Stop-Function -Continue |
| - | パスワード不一致 | 対話入力時の2回入力が不一致 | Stop-Function -Continue |
| - | エクスポートエラー | MasterKey.Export()失敗 | Status=Failure、警告出力 |

### リトライ仕様

リトライ機能は実装されていない。エラー発生時は次のデータベースの処理を継続する（-Continueフラグ使用）。

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

各マスターキーのエクスポートは独立して実行される。SQL Serverの内部トランザクションを使用。

## パフォーマンス要件

特に定義なし。操作自体は軽量で、通常は数秒以内に完了する。

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

- エクスポートされた.keyファイルは強力なパスワードで暗号化される
- パスワードは安全に保管し、バックアップドキュメントと一緒に管理すること
- エクスポートされたファイルは安全な場所に保存すること
- 対話入力時はRead-Host -AsSecureStringで入力をマスク

## 備考

- MasterKeyがないデータベースは警告なしでスキップ
- 既存ファイルがある場合、タイムスタンプを付加して衝突回避
- タイムスタンプ付加後1秒スリープで同時実行時の衝突回避

---

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

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

### 推奨読解順序

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

SMOのMasterKeyクラスが中心的なデータ構造である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Backup-DbaDbMasterKey.ps1 | `public/Backup-DbaDbMasterKey.ps1` | パラメータ定義（113-127行目）を確認 |

**読解のコツ**: SecurePasswordパラメータにPasswordエイリアスがある点に注目。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Backup-DbaDbMasterKey.ps1 | `public/Backup-DbaDbMasterKey.ps1` | begin ブロック（128-132行目）でCredential処理 |
| 2-2 | Backup-DbaDbMasterKey.ps1 | `public/Backup-DbaDbMasterKey.ps1` | process ブロック（133-219行目）がメイン処理 |

**主要処理フロー**:
1. **129-131行目**: CredentialからSecurePassword抽出
2. **134-136行目**: Get-DbaDatabaseでDB取得
3. **162-167行目**: MasterKey存在確認
4. **169-177行目**: 対話パスワード入力
5. **200-207行目**: MasterKey.Export()実行

#### Step 3: 出力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Backup-DbaDbMasterKey.ps1 | `public/Backup-DbaDbMasterKey.ps1` | プロパティ追加処理（209-217行目） |

**主要処理フロー**:
- **209-215行目**: Add-Memberで追加プロパティを設定
- **217行目**: Select-DefaultViewで表示プロパティを制御

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

```
Backup-DbaDbMasterKey
    │
    ├─ Get-DbaDatabase (DB取得)
    │      └─ Connect-DbaInstance (接続)
    │
    ├─ Test-DbaPath (パス検証)
    │
    ├─ Join-DbaPath (パス結合)
    │
    ├─ Read-Host -AsSecureString (対話入力)
    │
    ├─ ConvertFrom-SecurePass (パスワード変換)
    │
    └─ MasterKey.Export() (SMOメソッド)
```

### データフロー図

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

SqlInstance ───────────┐
                       │
SqlCredential ─────────┼──▶ Get-DbaDatabase ──▶ Database[]
                       │            │
Database ──────────────┤            │
                       │            ▼
ExcludeDatabase ───────┤     MasterKey確認
                       │            │
Path ──────────────────┤            │
                       │            ▼
SecurePassword ────────┤     Export()
                       │            │
Credential ────────────┘            │
                                    ▼
                              .keyファイル
                                    │
                                    ▼
InputObject ──────────────────────────────────────▶ MasterKey
  (パイプライン)                                   (プロパティ追加済み)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Backup-DbaDbMasterKey.ps1 | `public/Backup-DbaDbMasterKey.ps1` | ソース | メイン機能実装 |
| Get-DbaDbMasterKey.ps1 | `public/Get-DbaDbMasterKey.ps1` | ソース | マスターキー取得 |
| New-DbaDbMasterKey.ps1 | `public/New-DbaDbMasterKey.ps1` | ソース | マスターキー作成 |
| Remove-DbaDbMasterKey.ps1 | `public/Remove-DbaDbMasterKey.ps1` | ソース | マスターキー削除 |
