# 機能設計書 611-Remove-DbaDbAsymmetricKey

## 概要

本ドキュメントは、SQL Serverデータベースから非対称キーを削除するdbatools PowerShell関数 `Remove-DbaDbAsymmetricKey` の機能設計書である。

### 本機能の処理概要

**業務上の目的・背景**：非対称キーはSQL Serverの暗号化階層の一部であり、暗号化、デジタル署名、対称キーや証明書の保護に使用される。セキュリティ監査時の不要な暗号化オブジェクトのクリーンアップ、古い暗号化スキームの廃止、コンプライアンス要件を満たすために不要になったキーの削除など、データベースセキュリティ管理において重要な役割を果たす。本機能は、これらの運用タスクを効率的に実行するためのPowerShellコマンドを提供する。

**機能の利用シーン**：
- セキュリティ監査後の不要な非対称キーのクリーンアップ
- 暗号化キーのローテーション作業における古いキーの削除
- 暗号化インフラストラクチャの廃止作業
- データベース移行前のセキュリティオブジェクト整理

**主要な処理内容**：
1. SqlInstanceパラメータが指定された場合、Get-DbaDbAsymmetricKeyを呼び出して対象の非対称キーを取得
2. パイプライン入力またはGet-DbaDbAsymmetricKeyから取得した非対称キーオブジェクトを処理
3. 各非対称キーに対してDROP ASYMMETRIC KEYコマンドを実行
4. 削除結果をPSCustomObjectとして出力

**関連システム・外部連携**：SQL Server Management Objects (SMO) を使用してSQL Serverインスタンスと連携する。Invoke-DbaQueryを使用してT-SQLコマンドを実行する。

**権限による制御**：非対称キーの削除には、対象データベースでのCONTROL権限または非対称キーに対するALTER ANY ASYMMETRIC KEY権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 49 | 非対称キー管理 | 主機能 | 非対称キーの削除 |

## 機能種別

データベース操作（DELETE）- セキュリティオブジェクト管理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象のSQL Serverインスタンス | 有効なインスタンス名 |
| SqlCredential | PSCredential | No | 代替認証情報 | 有効な資格情報オブジェクト |
| Name | string[] | No | 削除する非対称キーの名前 | - |
| Database | string[] | No | 対象のデータベース名（デフォルト: master） | 有効なデータベース名 |
| InputObject | Microsoft.SqlServer.Management.Smo.AsymmetricKey[] | No | パイプライン入力用の非対称キーオブジェクト | 有効なAsymmetricKeyオブジェクト |
| EnableException | switch | No | 例外処理の有効化 | - |
| WhatIf | switch | No | 実行せずに処理内容を表示 | - |
| Confirm | switch | No | 実行前に確認プロンプトを表示 | - |

### 入力データソース

- SqlInstanceパラメータ: コマンドライン引数
- InputObject: Get-DbaDbAsymmetricKeyからのパイプライン入力
- SqlCredential: Get-Credentialコマンドレットまたは事前定義の資格情報

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名（例: MSSQLSERVER） |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Database | string | 非対称キーが削除されたデータベース名 |
| Name | string | 削除された非対称キーの名前 |
| Status | string | 削除結果（"Success"） |

### 出力先

PowerShellパイプライン - 呼び出し元のスクリプトまたはコンソールに出力

## 処理フロー

### 処理シーケンス

```
1. 入力パラメータの検証
   └─ SqlInstanceが指定された場合、Get-DbaDbAsymmetricKeyを呼び出し
2. 非対称キーオブジェクトのループ処理
   └─ 各キーに対して以下を実行
3. ShouldProcess確認
   └─ WhatIfまたはConfirmの処理
4. DROP ASYMMETRIC KEYコマンド実行
   └─ Invoke-DbaQueryを使用してT-SQLを実行
5. 結果オブジェクトの出力
   └─ PSCustomObjectとして結果を出力
6. エラー処理
   └─ 失敗時はStop-Functionで処理を継続
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance指定?}
    B -->|Yes| C[Get-DbaDbAsymmetricKeyで取得]
    B -->|No| D[InputObjectを使用]
    C --> E[InputObjectに追加]
    D --> F[非対称キーループ開始]
    E --> F
    F --> G{キーが残っている?}
    G -->|No| H[終了]
    G -->|Yes| I{ShouldProcess?}
    I -->|No| J[次のキーへ]
    I -->|Yes| K[DROP ASYMMETRIC KEY実行]
    K --> L{成功?}
    L -->|Yes| M[結果オブジェクト出力]
    L -->|No| N[Stop-Function呼び出し]
    M --> J
    N --> J
    J --> G
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | デフォルトデータベース | Databaseパラメータが未指定の場合、masterデータベースが対象となる | Database未指定時 |
| BR-002 | パイプライン優先 | InputObjectとSqlInstanceの両方が指定された場合、両方の結果が処理される | 両方指定時 |
| BR-003 | 確認プロンプト | ConfirmImpactがHighのため、デフォルトで確認プロンプトが表示される | Confirm:$false未指定時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 非対称キー削除 | sys.asymmetric_keys | DELETE | 指定された非対称キーを削除 |

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

#### sys.asymmetric_keys

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | DROP ASYMMETRIC KEY [キー名] | SMOではなくT-SQLで直接削除 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | キー削除失敗 | 非対称キーが使用中または権限不足 | Stop-Functionで警告を出力し、次のキーの処理を継続 |
| - | 接続エラー | SQL Serverインスタンスに接続できない | Get-DbaDbAsymmetricKey内でエラー処理 |

### リトライ仕様

リトライ機能なし - エラー発生時は次のキーの処理を継続

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

個々のDROP ASYMMETRIC KEYコマンドは自動コミットで実行される。複数キーの削除はそれぞれ独立したトランザクションで処理される。

## パフォーマンス要件

特に定義されていない。大量の非対称キーを削除する場合は、パイプラインを使用した一括処理を推奨。

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

- 非対称キーの削除には適切なデータベース権限が必要
- Windows認証、SQL Server認証、Active Directory認証をサポート
- MFAサポートにはConnect-DbaInstanceを使用
- 削除操作は監査ログに記録される（SQL Serverの監査設定に依存）

## 備考

- SMOの.netメソッドではエラーハンドリングが正しく動作しないため、Invoke-DbaQueryを使用してT-SQLを直接実行している
- パイプライン入力のサポートにより、Get-DbaDbAsymmetricKeyでフィルタリングした結果を直接削除可能

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | AsymmetricKey (SMO) | Microsoft.SqlServer.Management.Smo | SQL Server非対称キーのSMOオブジェクト構造を理解する |

**読解のコツ**: SMOのAsymmetricKeyオブジェクトは、Parentプロパティでデータベースオブジェクトを参照し、そのParentでサーバーオブジェクトにアクセスできる。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaDbAsymmetricKey.ps1 | `public/Remove-DbaDbAsymmetricKey.ps1` | メイン関数の入口とパラメータ定義を確認 |

**主要処理フロー**:
1. **79-88行目**: パラメータブロック定義 - CmdletBinding属性でShouldProcess、ConfirmImpact=Highを設定
2. **90-92行目**: SqlInstance指定時にGet-DbaDbAsymmetricKeyを呼び出し
3. **93-95行目**: 非対称キーオブジェクトからデータベースとサーバー情報を取得
4. **97行目**: ShouldProcess確認
5. **99-101行目**: Invoke-DbaQueryでDROP ASYMMETRIC KEYを実行
6. **103-110行目**: 成功時に結果オブジェクトを出力
7. **111-113行目**: エラー時にStop-Functionで処理を継続

#### Step 3: 依存関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbAsymmetricKey.ps1 | `public/Get-DbaDbAsymmetricKey.ps1` | 非対称キーオブジェクトの取得方法を理解 |
| 3-2 | Invoke-DbaQuery.ps1 | `public/Invoke-DbaQuery.ps1` | T-SQLクエリの実行方法を理解 |

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

```
Remove-DbaDbAsymmetricKey
    │
    ├─ Get-DbaDbAsymmetricKey (SqlInstance指定時)
    │      └─ Connect-DbaInstance
    │             └─ SMO Server接続
    │
    ├─ ShouldProcess (確認処理)
    │
    └─ Invoke-DbaQuery
           └─ DROP ASYMMETRIC KEY実行
```

### データフロー図

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

SqlInstance     ───┬──▶ Get-DbaDbAsymmetricKey ───┐
SqlCredential   ───┤                               │
Name            ───┤                               │
Database        ───┘                               │
                                                   ▼
InputObject     ─────────────────────────────▶ foreach loop
                                                   │
                                                   ▼
                                            Invoke-DbaQuery
                                          (DROP ASYMMETRIC KEY)
                                                   │
                                                   ▼
                                            [PSCustomObject] ───▶ パイプライン出力
                                            ComputerName
                                            InstanceName
                                            SqlInstance
                                            Database
                                            Name
                                            Status
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaDbAsymmetricKey.ps1 | `public/Remove-DbaDbAsymmetricKey.ps1` | ソース | メイン関数 |
| Get-DbaDbAsymmetricKey.ps1 | `public/Get-DbaDbAsymmetricKey.ps1` | ソース | 非対称キー取得関数 |
| Invoke-DbaQuery.ps1 | `public/Invoke-DbaQuery.ps1` | ソース | クエリ実行関数 |
| Remove-DbaDbAsymmetricKey.Tests.ps1 | `tests/Remove-DbaDbAsymmetricKey.Tests.ps1` | テスト | 単体テスト |
