鍵の削除に二重認証ポリシーを使う
IBM® Key Protect サービス・インスタンスを設定した後、二重認証ポリシーを設定することで、ポリシーを適用する鍵の削除に2人の管理者の承認を必要とすることで、悪意や事故によって鍵が削除されないようにすることができます。 このガイドでは、コンソールとAPIの使用方法を説明します。 CLIに関する説明は、 Key Protect CLI referenceを ご覧ください。
二重許可設定の管理
二重認証ポリシー("dual auth "ポリシーとも呼ばれる)はインスタンス・レベルで設定でき、その後に作成される鍵や特定の鍵に自動的に適用される。 鍵のポリシーを生成する方法が何であれ、鍵の削除には2人の管理者の承認が必要である。
二重認証ポリシーを設定する際の考慮事項
-
Key Protectインスタンスで二重認証を有効にすると、そのポリシーは以降のすべての鍵に適用されます。 インスタンスレベルで二重認証を有効にすると、そのインスタンスに追加される新しいキーはすべて、自動的に二重認証ポリシーを継承します。 これは、インスタンスの_Manager_レベルの権限を持つユーザが、どのユーザがキーを作成したかに関係なく、その後に作成されるすべてのキーに適用されるポリシーを設定したい場合に便利です。 インスタンス・レベルのポリシーは、_Manager_レベルの権限(またはデュアル認証ポリシ ーを設定する権限を含む特別なロール)を持つユーザーによってのみ変更できるため、_Manager_は、その後に作成されるすべての鍵にそのポリシーが適用されていることを保証できる。 なお、既存のキーはこのポリシー変更の影響を受けず、削除には引き続き1回の承認が必要となります。
-
Key Protect インスタンスの二重許可ポリシーはいつでも無効にすることができます。 単一の許可を可能にするために 既存の二重許可ポリシーを無効にする必要がある場合、その変更はインスタンスに追加する将来の鍵にのみ適用されることに注意してください。 二重許可ポリシーの下で作成された既存の鍵を削除するには、引き続き 2 人のユーザーからのアクションが必要です。 鍵が二重許可ポリシーを継承した後でポリシーを元に戻すことはできません。
-
一旦デュアル認証ポリシーが鍵に適用されると、ポリシーを変更することはできない。 インスタンスのデュアル認証ポリシーを有効または無効にすることは可能だが、キーの デュアル認証ポリシーを無効にすることはできない。 キーは削除されるまでポリシーを保持する。
-
二重認証ポリシーは、APIを使用して特定のキーにのみ適用できる。 個々の鍵に対する二重認証ポリシーは、コンソールでは設定できない。 CLI または API のいずれかを使用する必要があります。 同様に、鍵が二重認証ポリシーを持っているかどうかも、コンソールでは確認できない。
-
2つ目のアカウント管理者がいない限り、デュアル認証を設定しないでください。 そうでなければ、キーを削除することはできない 定義によれば、デュアル認証ポリシーは、2人のユーザーがポリシーを保持するキーを削除する必要がある。 その結果、ベストプラクティスは、インスタンスまたはキーにポリシーを確立する前に、セカンドユーザーを確保することです。
-
デュアル認証ポリシーを使用するには、そのインスタンスまたはキーに対して「 マネージャー 」アクセスポリシーが割り当てられている必要があります。 IAM 役割と Key Protect サービスでのアクションの対応関係について詳しくは、サービス・アクセスの役割を参照してください。
二重認証ポリシーによるキーの削除については、 キーの削除 を参照してください。
コンソールを使用した Key Protect インスタンスの二重許可の有効化
インスタンスで二重認証ポリシーを有効にする際、グラフィカルインターフェースを使用したい場合は、コンソールを利用できます。
Key Protect インスタンスの作成後に、以下のステップを実行して、二重許可ポリシーを作成します。
-
「メニュー」>**「リソース・リスト」**に移動し、リソースのリストを表示します。
-
IBM Cloud リソース・リストで、Key Protect のプロビジョン済みインスタンスを選択します。
-
ナビゲーションメニューで、「 ポリシー 」をクリックします。
-
「 デュアル認証の削除 」セクションで、スイッチを切り替えてポリシーを有効にしてください。
-
「 保存 」をクリックして変更を反映してください。
API を使用した Key Protect インスタンスの二重許可の有効化
インスタンス管理者は、以下のエンドポイントへの
PUT 呼び出しを行うことによって、 Key Protect インスタンスの二重許可ポリシーを有効にします。
https://<region>.kms.cloud.ibm.com/api/v2/instance/policies?policy=dualAuthDelete
-
二重認証ポリシーを有効または無効にするには、 Key Protect インスタンスに対して「 Manager 」アクセスポリシーが割り当てられている必要があります。 IAM 役割と Key Protect サービスでのアクションの対応関係について詳しくは、サービス・アクセスの役割を参照してください。
-
以下の
curlコマンドを実行して、 Key Protect インスタンスの二重許可ポリシーを有効にします。$ curl -X PUT \ "https://<region>.kms.cloud.ibm.com/api/v2/instance/policies?policy=dualAuthDelete" \ -H "accept: application/vnd.ibm.kms.policy+json" \ -H "authorization: Bearer <IAM_token>" \ -H "bluemix-instance: <instance_ID>" \ -H "x-kms-key-ring: <key_ring_ID>" \ -H "content-type: application/vnd.ibm.kms.policy+json" \ -d '{ "metadata": { "collectionType": "application/vnd.ibm.kms.policy+json", "collectionTotal": 1 }, "resources": [ { "policy_type": "dualAuthDelete", "policy_data": { "enabled": true } } ] }'次の表に従って、例の要求内の変数を置き換えてください。
| 変数 | 説明 |
|---|---|
| リージョン | 必須。 us-south や eu-gb といった地域略称は、 Key Protect インスタンスが配置されている地理的エリアを表します。詳細については、「 地域別サービスエンドポイント 」を参照してください。 |
| IAM_token | 必須。 IBM Cloud アクセス・トークン。 Bearer 値を含む、IAM トークンの全コンテンツを cURL 要求に組み込みます。 詳細については、「 アクセストークンの取得 」を参照してください。 |
| instance_ID | 必須。 Key Protect サービス・インスタンスに割り当てられた固有 ID。 詳細については、「 インスタンス ID の取得 」を参照してください。 |
| key_ring_ID | オプション。 鍵が含まれている鍵リングの固有 ID。 指定しない場合は、Key Protect が、指定されたインスタンスに関連付けられているすべての鍵リングで鍵を検索します。 鍵リング ID を指定して、より最適化された要求を行うことをお勧めします。 注: x-kms-key-ring ヘッダーを指定せずに作成されたキーのキーリングIDは、「default」となります。For more information, see グループ化キー. |
要求が成功すると、Key Protect インスタンスの二重許可が有効になったことを示す HTTP 204 No Content 応答が返されます。 サービスに作成またはインポートする鍵は、削除するために 2 つの許可を必要とするようになります。 詳しくは、鍵の削除を参照してください。
オプション: 二重許可ポリシーの有効化の確認
ポリシーのリスト表示の要求を実行して、二重許可ポリシー鍵が有効になったことを確認できます。
$ curl -X GET \
"https://<region>.kms.cloud.ibm.com/api/v2/instance/policies?policy=dualAuthDelete" \
-H "accept: application/vnd.ibm.kms.policy+json" \
-H "authorization: Bearer <IAM_token>" \
-H "bluemix-instance: <instance_ID>"
ここで、<instance_ID> はインスタンスの名前で、<IAM_token> は IAM トークンです。
コンソールを使用した Key Protect インスタンスの二重許可の無効化
インスタンスの二重認証ポリシーをグラフィカルインターフェースを使用して無効にしたい場合は、コンソールを使用できます。
Key Protect インスタンスの作成後に、以下のステップを実行して、二重許可ポリシーを作成します。
-
「メニュー」>**「リソース・リスト」**に移動し、リソースのリストを表示します。
-
IBM Cloud リソース・リストで、Key Protect のプロビジョン済みインスタンスを選択します。
-
ナビゲーションメニューで、「 ポリシー 」をクリックします。
-
「 デュアル認証の削除 」セクションで、スイッチを切り替えてポリシーを無効にしてください。
-
「 保存 」をクリックして変更を反映してください。
API を使用した Key Protect インスタンスの二重許可の無効化
インスタンス管理者として、以下のエンドポイントに対して PUT 呼び出しを行うことで、 Key Protect インスタンスの既存の二重認証ポリシーを無効にすることができます。
https://<region>.kms.cloud.ibm.com/api/v2/instance/policies?policy=dualAuthDelete
-
二重認証ポリシーを有効または無効にするには、 Key Protect インスタンスに対して「 Manager 」アクセスポリシーが割り当てられている必要があります。 IAM 役割と Key Protect サービスでのアクションの対応関係について詳しくは、サービス・アクセスの役割を参照してください。
-
次の
curlコマンドを実行して、 Key Protect インスタンスの既存の二重認証ポリシーを無効にします。$ curl -X PUT \ "https://<region>.kms.cloud.ibm.com/api/v2/instance/policies?policy=dualAuthDelete" \ -H "accept: application/vnd.ibm.kms.policy+json" \ -H "authorization: Bearer <IAM_token>" \ -H "bluemix-instance: <instance_ID>" \ -H "x-kms-key-ring: <key_ring_ID>" \ -H "content-type: application/vnd.ibm.kms.policy+json" \ -d '{ "metadata": { "collectionType": "application/vnd.ibm.kms.policy+json", "collectionTotal": 1 }, "resources": [ { "type": "application/vnd.ibm.kms.policy+json", "dualAuthDelete": { "enabled": false } } ] }'次の表に従って、例の要求内の変数を置き換えてください。
| 変数 | 説明 |
|---|---|
| リージョン | 必須。 us-south や eu-gb といった地域略称は、 Key Protect インスタンスが配置されている地理的エリアを表します。詳細については、「 地域別サービスエンドポイント 」を参照してください。 |
| IAM_token | 必須。 IBM Cloud アクセス・トークン。 Bearer 値を含む、IAM トークンの全コンテンツを cURL 要求に組み込みます。 詳細については、「 アクセストークンの取得 」を参照してください。 |
| instance_ID | 必須。 Key Protect サービス・インスタンスに割り当てられた固有 ID。 詳細については、「 インスタンス ID の取得 」を参照してください。 |
| key_ring_ID | オプション。 鍵が含まれている鍵リングの固有 ID。 指定されていない場合、Key Protect は、指定されたインスタンスに関連付けられているすべての鍵リングで鍵を検索します。 鍵リング ID を指定して、より最適化された要求を行うことをお勧めします。 注: x-kms-key-ring ヘッダーを指定せずに作成されたキーのキーリングIDは、「default」となります。For more information, see グループ化キー. |
要求が成功すると、サービス・インスタンスの二重許可ポリシーが更新されたことを示す HTTP 204 No Content 応答が返されます。 サービスに作成またはインポートする鍵は、削除するために 1 つのみの許可を必要とするようになります。 詳しくは、鍵の削除を参照してください。
オプション: 二重許可ポリシーの無効化の確認
ポリシーのリスト表示の要求を実行して、二重許可ポリシーの鍵が無効になったことを確認できます。
$ curl -X GET \
"https://<region>.kms.cloud.ibm.com/api/v2/instance/policies?policy=dualAuthDelete" \
-H "accept: application/vnd.ibm.kms.policy+json" \
-H "authorization: Bearer <IAM_token>" \
-H "bluemix-instance: <instance_ID>"
ここで、<instance_ID> はインスタンスの名前で、<IAM_token> は IAM トークンです。
特定のキーに二重認証ポリシーを設定する
また、 IBM® Key Protect for IBM Cloud® を使用することで、個々のキーに対して二重認証ポリシーを設定することもできます。 このアクションはAPIやCLIを使わなければできないわけではない。
二重許可を鍵レベルで有効にした後は、鍵と関連付けられたポリシーを変更して、単一の許可で鍵を削除できるようにすることはできません。
鍵の二重許可ポリシーの表示
概略を把握するため、以下のエンドポイントへの GET 呼び出しを行うことによって、単一の鍵の二重許可ポリシーを取得できます。
https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/policies?policy=dualAuthDelete
-
サービス内で鍵の処理を行うために、認証資格情報を取得します。
二重許可ポリシーを操作するには、インスタンスまたはキーの_「マネージャー」_アクセス権限ポリシーが割り当てられている必要があります。 IAM 役割と Key Protect サービスでのアクションの対応関係について詳しくは、サービス・アクセスの役割を参照してください。
-
以下の
curlコマンドを実行して、指定した鍵の二重許可ポリシーを取得します。$ curl -X GET \ "https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/policies?policy=dualAuthDelete" \ -H "accept: application/vnd.ibm.kms.policy+json" \ -H "authorization: Bearer <IAM_token>" \ -H "bluemix-instance: <instance_ID>"次の表に従って、例の要求内の変数を置き換えてください。
| 変数 | 説明 |
|---|---|
| keyID_or_alias | 必須。 既存のローテーション・ポリシーを持つ鍵の固有 ID または別名。 |
| リージョン | 必須。 us-south や eu-gb といった地域略称は、 Key Protect インスタンスが配置されている地理的エリアを表します。詳細については、「 地域別サービスエンドポイント 」を参照してください。 |
| IAM_token | 必須。 IBM Cloud アクセス・トークン。 Bearer 値を含む、IAM トークンの全コンテンツを cURL 要求に組み込みます。 詳細については、「 アクセストークンの取得 」を参照してください。 |
| instance_ID | 必須。 Key Protect サービス・インスタンスに割り当てられた固有 ID。 詳細については、「 インスタンス ID の取得 」を参照してください。 |
要求が成功すると、鍵と関連付けられた二重許可ポリシーの詳細が返されます。 以下の JSON オブジェクトは、鍵に既存の二重許可ポリシーがある場合の応答例を示しています。
{
"metadata": {
"collectionTotal": 1,
"collectionType": "application/vnd.ibm.kms.policy+json"
},
"resources": [
{
"id": "02fd6835-6001-4482-a892-13bd2085f75d",
"crn": "crn:v1:bluemix:public:kms:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:12e8c9c2-a162-472d-b7d6-8b9a86b815a6:key:02fd6835-6001-4482-a892-13bd2085f75d",
"dualAuthDelete": {
"enabled": true
},
"createdBy": "...",
"creationDate": "2020-03-10T20:41:27Z",
"updatedBy": "...",
"lastUpdateDate": "2020-03-16T20:41:27Z"
}
]
}
以下の JSON は、鍵に既存の二重許可ポリシーがない場合の応答例を示しています。
{
"metadata": {
"collectionTotal": 0,
"collectionType": "application/vnd.ibm.kms.policy+json"
}
}
キーに対する二重認証ポリシーの作成
二重認証ポリシーは、APIを使ってキーに設定することもできる。 以下のエンドポイントへの PUT 呼び出しを行うことによって、単一の鍵の二重許可ポリシーを作成します。
https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/policies?policy=dualAuthDelete
単一の鍵に対して二重許可ポリシーを有効にした後、そのポリシーを元に戻すことはできません。
-
サービス内で鍵の処理を行うために、認証資格情報を取得します。
二重許可ポリシーを操作するには、インスタンスまたはキーの_「マネージャー」_アクセス権限ポリシーが割り当てられている必要があります。 IAM 役割と Key Protect サービスでのアクションの対応関係について詳しくは、サービス・アクセスの役割を参照してください。
-
以下の
curlコマンドを実行して、指定した鍵に対して二重許可を有効にします。$ curl -X PUT \ "https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/policies?policy=dualAuthDelete" \ -H "authorization: Bearer <IAM_token>" \ -H "bluemix-instance: <instance_ID>" \ -H "content-type: application/vnd.ibm.kms.policy+json" \ -d '{ "metadata": { "collectionType": "application/vnd.ibm.kms.policy+json", "collectionTotal": 1 }, "resources": [ { "type": "application/vnd.ibm.kms.policy+json", "dualAuthDelete": { "enabled": true } } ] }'次の表に従って、例の要求内の変数を置き換えてください。
| 変数 | 説明 |
|---|---|
| keyID_or_alias | 必須。 二重許可ポリシーを作成する対象となる鍵の固有 ID または別名。 |
| リージョン | 必須。 us-south や eu-gb といった地域略称は、 Key Protect インスタンスが配置されている地理的エリアを表します。詳細については、「 地域別サービスエンドポイント 」を参照してください。 |
| IAM_token | 必須。 IBM Cloud アクセス・トークン。 Bearer 値を含む、IAM トークンの全コンテンツを cURL 要求に組み込みます。 詳細については、「 アクセストークンの取得 」を参照してください。 |
| instance_ID | 必須。 Key Protect サービス・インスタンスに割り当てられた固有 ID。 詳細については、「 インスタンス ID の取得 」を参照してください。 |
要求が成功すると、鍵の二重許可ポリシー詳細と共に 200 OK 応答が返されます。 以下の JSON オブジェクトは、応答の例を示しています。
{
"metadata": {
"collectionType": "application/vnd.ibm.kms.policy+json",
"collectionTotal": 1
},
"resources": [
{
"id": "2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
"crn": "crn:v1:bluemix:public:kms:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:30372f20-d9f1-40b3-b486-a709e1932c9c:key:2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
"dualAuthDelete": {
"enabled": true
},
"createdBy": "...",
"creationDate": "2020-03-10T20:41:27Z",
"updatedBy": "...",
"lastUpdateDate": "2020-03-16T20:41:27Z"
}
]
}
これで、鍵の削除には 2 人のユーザーからの許可が必要になりました。
二重認証ポリシーが設定されているキーの削除
二重認証ポリシーを持つ鍵の削除は、コンソール、API、またはCLIを使って行うことができる。 二重許可ポリシーの理由にかかわらず、削除方式は同じです。 鍵の削除権限を持つユーザーの 1 人が鍵に削除のスケジュールを設定したら、もう 1 人のユーザーがその設定を確認します。
二重許可プロセスを使用することによって、IBM® Key Protect for IBM Cloud® を使用して安全に暗号鍵を削除できます。
鍵を削除する前に、鍵を削除およびパージする前の考慮事項を必ず確認してください。
二重認証ポリシーを保持する鍵を削除する際の考慮点
二重許可を使用して鍵を削除する前に、以下を行ってください。
-
誰が Key Protect リソースの削除を許可できるのかを判別します。 二重許可を使用するには、鍵に削除予定を設定できるユーザーと、鍵を削除できるもう 1 人のユーザーを確認してください。 _ライター_または_マネージャー_の役割を持つユーザーは、削除用の鍵を設定できますが、鍵を削除できるのは_マネージャー_の役割を持つユーザーのみです。
-
7 日間の許可期間内に鍵を削除するように計画します。 最初のユーザーが鍵の削除を許可すると、その鍵は アクティブ 状態に 7 日間残ります。その間、鍵に対するすべての鍵操作が許可されます。 削除を完了するために、_マネージャー_の役割を持つ別のユーザーが Key Protect GUI または API を使用して、その 7 日間の任意の時点で鍵を削除できます。その時点で、鍵は破棄状態に移行します。 アクティブな鍵はパージできないので、鍵をパージするためには、もう 1 人のユーザーが鍵を削除する必要があることに注意してください。
-
削除してから 90 日後に、鍵とその関連データはアクセス不能になります。 鍵を削除すると、その鍵は「ソフト削除」されます。これは、削除から 30 日以内であれば、鍵とその関連データを復元できることを意味します。 90 日が経つまでは、鍵のメタデータ、登録、ポリシーなどの関連データをまだ取得できます。 90 日を過ぎると、鍵は自動パージ (つまりハード削除) の対象になり、関連データは Key Protect サービスから完全に削除されます。
コンソールでの鍵の削除の許可
二重許可をインスタンスに対して有効にするか、または鍵に対して有効にした場合は、Key Protect IBM Cloud のコンソールで、鍵を削除するための 1 番目の許可を付与することができます。
-
「メニュー」>**「リソース・リスト」**に移動し、リソースのリストを表示します。
-
IBM Cloud リソース・リストで、Key Protect のプロビジョン済みインスタンスを選択します。
-
アプリケーションの詳細ページで、**「鍵 (Keys)」**テーブルを使用して、サービス内の鍵を参照します。
-
「⋯」アイコンをクリックして、削除する鍵に関するオプションのリストを開きます。
-
オプションメニューから「 削除のスケジュール 」をクリックし、そのキーに 関連付けられているリソースを確認します。
-
Nextボタンをクリックし、鍵の名前を入力し、Schedule deletionをクリックします。 -
別のユーザーに連絡して、鍵の削除を実行します。
鍵の削除を許可するには、他のユーザーがそのインスタンスまたは鍵に対する_マネージャー_・アクセス・ポリシーを持っている必要があります。
二重許可を有効にした鍵をコンソールでパージする
マネージャー・アクセス・ポリシーを持つ他のユーザーが鍵の削除を許可してから 4 時間後に、いずれかのユーザーが KeyPurge 属性を保持している限り、鍵をパージできます。
「⋯」アイコンをクリックして、パージする鍵のオプションのリストを開き、**「パージ」**をクリックします。 鍵を削除できない場合は、鍵が別のユーザーによって削除を許可されてから少なくとも 4 時間経過していること、および KeyPurge 属性を保持していることを確認してください。
API を使用した鍵の削除の許可
インスタンスまたはキーに対して二重認証を有効にした後、以下のエンドポイントに対して POST 呼び出しを行うことで、キーを削除するための最初の認証を行うことができます。
https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/actions/setKeyForDeletion
-
サービス内で鍵の処理を行うために、認証資格情報を取得します。
削除対象キーを設定するには、そのインスタンスまたはキーの_「マネージャー」または「ライター」_ アクセス権限ポリシーが割り当てられている必要があります。 IAM 役割と Key Protect サービスでのアクションの対応関係について詳しくは、サービス・アクセスの役割を参照してください。
-
削除できるよう設定 (許可) する鍵の ID をコピーします。
-
鍵を削除するための 1 番目の許可を与えます。
$ curl -X POST \ "https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/actions/setKeyForDeletion" \ -H "accept: application/vnd.ibm.kms.key_action+json" \ -H "authorization: Bearer <IAM_token>" \ -H "bluemix-instance: <instance_ID>" \ -H "content-type: application/vnd.ibm.kms.key_action+json"次の表に従って、例の要求内の変数を置き換えてください。
| 変数 | 説明 |
|---|---|
| リージョン | 必須。 us-south や eu-gb といった地域略称は、 Key Protect インスタンスが配置されている地理的エリアを表します。詳細については、「 地域別サービスエンドポイント 」を参照してください。 |
| key_ID_or_alias | 必須。 ローテートするルート鍵の固有 ID または別名。 |
| IAM_token | 必須。 IBM Cloud アクセス・トークン。 Bearer 値を含む、IAM トークンの全コンテンツを cURL 要求に組み込みます。 詳細については、「 アクセストークンの取得 」を参照してください。 |
| instance_ID | 必須。 Key Protect サービス・インスタンスに割り当てられた固有 ID。 詳細については、「 インスタンス ID の取得 」を参照してください。 |
要求が成功すると、鍵の削除が許可されたことを示す HTTP 204 No Content 応答が返されます。 「 マネージャー 」アクセスポリシーを持つ別のユーザーも、 Key Protect コンソールまたはAPIを使用して、 そのキーを削除 できるようになりました。
削除が許可済みのキーが削除されないようにするには、POST /api/v2/keys/<keyID_or_alias>/actions/unsetKeyForDeletion を呼び出して既存の許可を削除します。
キーの削除
キーを削除対象として設定した後、 マネージャー権限ポリシー を持つ別のユーザーが、 Key Protect のGUIまたはAPIを使用して、そのキーを安全に削除することができます。
Key Protect は、鍵を削除する許可が最初に与えられたときから始まる 7 日間の許可期間を設定します。 この 7 日間の期間中、鍵はアクティブ 状態のままであり、すべての鍵操作が鍵に対して許可されます。 他のユーザーによる対応がなく、7日間の期間が経過した場合は、キーを削除するために二重承認プロセスを再度実行する必要があります。
以下のエンドポイントへの DELETE 呼び出しを行うことによって、鍵とその内容を削除します。
https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>
-
削除する鍵の ID を取得します。
GET /v2/keys要求を行うか、Key Protect ダッシュボードに鍵を表示することで、指定の鍵の ID を取得できます。 -
次の
curlコマンドを実行して、鍵とその内容を削除します。$ curl -X DELETE \ "https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>" \ -H "authorization: Bearer <IAM_token>" \ -H "bluemix-instance: <instance_ID>" \ -H "prefer: <return_preference>"次の表に従って、例の要求内の変数を置き換えてください。
| 変数 | 説明 |
|---|---|
| リージョン | 必須。 us-south や eu-gb といった地域略称は、 Key Protect インスタンスが配置されている地理的エリアを表します。詳細については、「 地域別サービスエンドポイント 」を参照してください。 |
| key_ID_or_alias | 必須。 削除対象の鍵の固有 ID または別名。 |
| IAM_token | 必須。 IBM Cloud アクセス・トークン。 Bearer 値を含む、IAM トークンの全コンテンツを cURL 要求に組み込みます。 詳細については、「 アクセストークンの取得 」を参照してください。 |
| instance_ID | 必須。 Key Protect サービス・インスタンスに割り当てられた固有 ID。 詳細については、「 インスタンス ID の取得 」を参照してください。 |
| return_preference | オプション。 POST および DELETE の操作に関するサーバーの動作を変更するヘッダー。 return_preference 変数を return=minimal に設定すると、サービスは, 成功した削除応答を返します。 変数を return=representation に設定すると、サービスは鍵の素材と鍵のメタデータの両方を返します。 |
return_preference 変数を return=representation に設定すると、DELETE 要求の詳細が応答のエンティティー本体で返されます。
鍵を削除すると、鍵はDeactivated の鍵の状態に遷移します。 24 時間後、鍵が元の状態に戻らない場合、鍵はDestroyed 状態に遷移します。 破棄された鍵を復元できるのは、30 日が経過するか有効期限日に達するか、どちらか早いほうまでです。 どちらかに達すると、鍵の内容は完全に消去され、アクセスできなくなります。
以下の JSON オブジェクトは、返された値の例を示しています。
{
"metadata": {
"collectionType": "application/vnd.ibm.kms.key+json",
"collectionTotal": 1
},
"resources": [
{
"type": "application/vnd.ibm.kms.key+json",
"id": "02fd6835-6001-4482-a892-13bd2085f75d",
"name": "test-root-key",
"aliases": [
"alias-1",
"alias-2"
],
"state": 5,
"extractable": false,
"crn": "crn:v1:bluemix:public:kms:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:12e8c9c2-a162-472d-b7d6-8b9a86b815a6:key:02fd6835-6001-4482-a892-13bd2085f75d",
"imported": false,
"creationDate": "2020-03-10T20:41:27Z",
"createdBy": "...",
"algorithmType": "Deprecated",
"algorithmMetadata": {
"bitLength": "256",
"mode": "Deprecated"
},
"algorithmBitSize": 256,
"algorithmMode": "Deprecated",
"lastUpdateDate": "2020-03-16T20:41:27Z",
"dualAuthDelete": {
"enabled": false
},
"deleted": true,
"deletionDate": "2020-03-16T21:46:53Z",
"deletedBy": "..."
}
]
}
利用可能なパラメータの詳細については、『 Key Protect REST API リファレンスドキュメント 』を参照してください。
鍵のパージ
鍵を削除すると、鍵素材がただちに非アクティブ化され、Key Protect サービスのバックストアに移動されます。 鍵の削除から 4 時間後に、鍵を手動でパージできるようになります。 鍵の削除から 30 日後に、鍵は復元できなくなり、鍵素材は破棄されます。 手動でパージされた場合を除き、鍵の削除から 90 日後に、鍵は自動パージの対象になり、すべての関連データが Key Protect サービスから完全に削除 (つまり「ハード削除」) されます。
鍵を削除してパージする方法について詳しくは、鍵の削除およびパージについて を参照してください。
以下の表に、削除された鍵に関連するデータを取得するために使用できる API をリストします。
| API | 説明 |
|---|---|
| 鍵の取得 | 鍵の詳細を取得します |
| 鍵メタデータの取得 | 鍵メタデータの取得 |
| 登録の取得 | 鍵に関連付けられている登録のリストを取得します |
既存の許可の取り消し
7 日間の許可期間が終わる前に鍵の許可を取り消す必要がある場合は、 以下のエンドポイントに POST 呼び出しを実行して、既存の許可を取り消すことができます。
https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/actions/unsetKeyForDeletion
-
サービス内で鍵の処理を行うために、認証資格情報を取得します。
キーの削除許可を削除するには、インスタンスまたはキーに対して_「マネージャー」または「ライター」_アクセス権限ポリシーが割り当てられている必要があります。 IAM 役割と Key Protect サービスでのアクションの対応関係について詳しくは、サービス・アクセスの役割を参照してください。
-
削除許可の設定を取り消す鍵の ID をコピーします。
-
鍵を削除するための既存の許可を取り消します。
$ curl -X POST \ "https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/actions/unsetKeyForDeletion" \ -H "accept: application/vnd.ibm.kms.key_action+json" \ -H "authorization: Bearer <IAM_token>" \ -H "bluemix-instance: <instance_ID>" \ -H "content-type: application/vnd.ibm.kms.key_action+json"次の表に従って、例の要求内の変数を置き換えてください。
| 変数 | 説明 |
|---|---|
| リージョン | 必須。 Key Protect インスタンスが |
存在している地理的領域を表す、
地域の省略形
(例: `us-south` または
`eu-gb`)。<br>詳細については、「 [地域別サービスエンドポイント](/docs/key-protect?topic=key-protect-regions#service-endpoints) 」を参照してください。 |
| key_ID_or_alias | 必須。 ローテートするルート鍵の固有 ID または別名。 | | IAM_token | 必須。 IBM Cloud アクセス・トークン。 Bearer 値を含む、IAM トークンの全コンテンツを cURL 要求に組み込みます。
詳細については、「 アクセストークンの取得 」を参照してください。 | | instance_ID | 必須。 Key Protect サービス・インスタンスに割り当てられた固有 ID。
詳細については、「 インスタンス ID の取得 」を参照してください。 |
要求が成功すると、鍵の削除がもう許可されなくなったことを示す HTTP 204 No Content 応答が返されます。 二重承認プロセスをやり直す必要がある場合は、削除用のキーを設定するために、再度承認を発行することができます。