鍵の取得
以下を使用して、鍵の鍵素材を取得できます。 IBM® Key Protect for IBM Cloud®.
ライター・アクセス・ポリシーまたは_マネージャー_・アクセス・ポリシーがある場合は、標準鍵の内容 (鍵素材やポリシーの詳細など) を取得できますマネージャー
ルート・キーはデータ・サービスに保管されている他の鍵の暗号化および暗号化解除に使用される対称ラップ鍵。ハードウェア・セキュリティ・モジュールの範囲内に留まる。 モジュールの範囲内にとどまる。 ルート鍵の鍵素材は取得できません。
API を使用したキーの取得
特定の鍵に関する詳細情報を表示するには、次のエンドポイントに対して GET 呼び出しを行います。
https://<region>.kms.cloud.ibm.com/api/v2/keys/<key_ID_or_alias>
-
アクセスまたは管理する鍵の ID を取得します。
この ID 値を使用して、鍵に関する詳細な情報 (鍵の素材自体など) にアクセスします。
GET /v2/keys要求を行うか、または Key Protect GUI。 -
次の
curlコマンドを実行して、鍵と鍵の素材に関する詳細を取得します。$ curl -X GET \ "https://<region>.kms.cloud.ibm.com/api/v2/keys/<key_ID_or_alias>" \ -H "accept: application/vnd.ibm.kms.key+json" \ -H "authorization: Bearer <IAM_token>" \ -H "bluemix-instance: <instance_ID>" \ -H "x-kms-key-ring: <key_ring_ID>" \ -H "correlation-id: <correlation_ID>"次の表に従って、例の要求内の変数を置き換えてください。
| 変数 | 説明 |
|---|---|
| リージョン | 必須。 Key Protect インスタンスが存在する地域を表す us-south や eu-gb などの地域略称。詳細については、 地域サービスエンドポイントを 参照してください。 |
| 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 グループ化キー. |
| correlation_ID | オプション。トランザクションを追跡し、相互に関連付けるために使用される固有 ID。 |
| key_ID_or_alias | 必須。 取得する鍵の ID または別名。 |
GET api/v2/keys/<key_ID_or_alias> の応答が成功すると、キーとキー素材に関する詳細が返されます。 以下の 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-standard-key",
"aliases": [
"alias-1",
"alias-2"
],
"state": 1,
"expirationDate": "2020-03-15T03:50:12Z",
"extractable": true,
"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-12T03:50:12Z",
"createdBy": "...",
"algorithmType": "Deprecated",
"algorithmMetadata": {
"bitLength": "256",
"mode": "Deprecated"
},
"algorithmBitSize": 256,
"algorithmMode": "Deprecated",
"lastUpdateDate": "2020-03-12T03:50:12Z",
"dualAuthDelete": {
"enabled": false
},
"deleted": false,
"payload": "Rm91ciBzY29yZSBhbmQgc2V2ZW4geWVhcnMgYWdv..."
}
]
}
以下の JSON オブジェクトは、ルート鍵の戻り値の例を示しています。
{
"metadata": {
"collectionType": "application/vnd.ibm.kms.key+json",
"collectionTotal": 1
},
"resources": [
{
"type": "application/vnd.ibm.kms.key+json",
"id": "2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
"aliases": [
"alias-1",
"alias-2"
],
"name": "test-root-key",
"state": 1,
"extractable": false,
"crn": "crn:v1:bluemix:public:kms:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:30372f20-d9f1-40b3-b486-a709e1932c9c:key:2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
"imported": false,
"creationDate": "2020-03-05T16:28:38Z",
"createdBy": "...",
"algorithmType": "Deprecated",
"algorithmMetadata": {
"bitLength": "256",
"mode": "Deprecated"
},
"algorithmBitSize": 256,
"algorithmMode": "Deprecated",
"lastUpdateDate": "2020-03-05T16:39:25Z",
"keyVersion": {
"id": "436901cb-f4e4-45f4-bd65-91a7f6d13461",
"creationDate": "2020-03-05T16:39:25Z"
},
"dualAuthDelete": {
"enabled": false
},
"deleted": false
}
]
}
ルート鍵の payload または鍵素材は、ハードウェア・セキュリティー・モジュールの境界内に留まり、取得できません。
応答パラメーターの詳細な説明については、以下を参照してください。 Key Protect REST APIリファレンスドキュメント