# 機能設計書 30-Backup-DbaServiceMasterKey

## 概要

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

### 本機能の処理概要

Backup-DbaServiceMasterKeyは、SQL Serverインスタンスのサービスマスターキー（SMK）を暗号化された.keyファイルにエクスポートするPowerShellコマンドレットである。

**業務上の目的・背景**：サービスマスターキー（SMK）は、SQL Serverの暗号化階層の最上位に位置し、データベースマスターキーや証明書を暗号化するために使用される。SMKを失った場合、暗号化されたデータベースの復旧やサーバー移行時に深刻な問題が発生する。本機能は、災害復旧シナリオに備えてSMKを安全にバックアップする手段を提供する。

**機能の利用シーン**：
- 新規SQL Serverインスタンス構築後の即時バックアップ
- サーバー移行前のSMKバックアップ
- 災害復旧計画の一環としての定期バックアップ
- 暗号化データベースを別サーバーに移行する準備

**主要な処理内容**：
1. SqlInstanceパラメータからSQL Serverインスタンスに接続
2. インスタンスのServiceMasterKeyプロパティを取得
3. SecurePassword未指定時は対話入力でパスワードを取得
4. ServiceMasterKey.Export()メソッドで.keyファイルにエクスポート
5. 結果をSMO ServiceMasterKeyオブジェクト（プロパティ追加）として返却

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

**権限による制御**：sysadmin固定サーバーロールのメンバーシップが必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 120 | サービスマスターキー | 主機能 | サービスマスターキーのバックアップ |

## 機能種別

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

- SqlInstanceパラメータ：SQL Serverインスタンス名の直接指定またはパイプライン入力

## 出力仕様

### 出力データ

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

### 出力先

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

## 処理フロー

### 処理シーケンス

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

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{KeyCredential指定?}
    B -->|Yes| C[SecurePassword抽出]
    B -->|No| D[foreach instance in SqlInstance]
    C --> D
    D --> E[Connect-DbaInstance]
    E --> F{接続成功?}
    F -->|No| G[Stop-Function -Continue]
    F -->|Yes| H{Path指定?}
    H -->|No| I[BackupDirectory使用]
    H -->|Yes| J[指定Pathを使用]
    I --> K{Path有効?}
    J --> K
    K -->|No| L[Stop-Function -Continue]
    K -->|Yes| M[ServiceMasterKey取得]
    M --> N{SecurePassword指定?}
    N -->|No| O[対話入力]
    N -->|Yes| P[ファイル名生成]
    O --> Q{パスワード一致?}
    Q -->|No| R[Stop-Function -Continue]
    Q -->|Yes| P
    P --> S{ファイル存在?}
    S -->|Yes| T[タイムスタンプ付加]
    S -->|No| U[Export実行]
    T --> U
    U --> V{成功?}
    V -->|Yes| W[Status=Success]
    V -->|No| X[Status=Failure]
    W --> Y[プロパティ追加]
    X --> Y
    Y --> Z[結果出力]
    G --> AA{次のインスタンス?}
    L --> AA
    Z --> AA
    AA -->|Yes| D
    AA -->|No| AB[終了]
```

## ビジネスルール

### 業務ルール

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

### 計算ロジック

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

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

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

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

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

#### sys.symmetric_keys

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

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

## パフォーマンス要件

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

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

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

## 備考

- サービスマスターキーはインスタンスに1つしか存在しない
- 既存ファイルがある場合、タイムスタンプを付加して衝突回避
- タイムスタンプ付加後1秒スリープで同時実行時の衝突回避

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: SqlInstanceがMandatoryでValueFromPipelineである点に注目。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Backup-DbaServiceMasterKey.ps1 | `public/Backup-DbaServiceMasterKey.ps1` | begin ブロック（101-105行目）でKeyCredential処理 |
| 2-2 | Backup-DbaServiceMasterKey.ps1 | `public/Backup-DbaServiceMasterKey.ps1` | process ブロック（106-175行目）がメイン処理 |

**主要処理フロー**:
1. **102-104行目**: KeyCredentialからSecurePassword抽出
2. **107-112行目**: Connect-DbaInstanceで接続
3. **114-116行目**: Path未指定時BackupDirectory使用
4. **127行目**: ServiceMasterKey取得
5. **130-137行目**: 対話パスワード入力
6. **157-159行目**: ServiceMasterKey.Export()実行

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

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

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

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

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

### データフロー図

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

SqlInstance ───────────┐
  (パイプライン可)      │
                       │
SqlCredential ─────────┼──▶ Connect-DbaInstance ──▶ Server
                       │            │
Path ──────────────────┤            │
                       │            ▼
SecurePassword ────────┤     ServiceMasterKey取得
                       │            │
KeyCredential ─────────┘            ▼
                              Export()
                                    │
                                    ▼
                              .keyファイル
                                    │
                                    ▼
                            ServiceMasterKey
                          (プロパティ追加済み)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Backup-DbaServiceMasterKey.ps1 | `public/Backup-DbaServiceMasterKey.ps1` | ソース | メイン機能実装 |
| New-DbaServiceMasterKey.ps1 | `public/New-DbaServiceMasterKey.ps1` | ソース | サービスマスターキー再生成 |
| Backup-DbaDbMasterKey.ps1 | `public/Backup-DbaDbMasterKey.ps1` | ソース | 関連：DBマスターキーバックアップ |
