UI を使用した鍵リングの作成

次の手順を実行して、UI を使用してキーリングを作成します。

1. UI にログインします。

2. 「メニュー」>**「リソース・リスト」**に移動し、リソースのリストを表示します。

3. IBM Cloud リソース・リストで、Hyper Protect Crypto Services のプロビジョン済みインスタンスを選択します。

4. 新しい鍵リングを作成するには、サイド・メニューの**「KMS 鍵リング (KMS key rings)」**タブを選択します。

5. **「鍵管理サービスの鍵リング」テーブルで「鍵リングの追加」**をクリックします。

   サービス・インスタンスには、鍵リングや EP11 キー・ストアなど、最大 5 つのキー・ストアを無料で作成できます。 追加の鍵リングまたは EP11 キー・ストアごとに、月額 $225 USD から始まる段階的な料金が課金されます。

6. **「鍵リング ID」に入力して「鍵リングの追加」**をクリックします。

API を使用した鍵リングの作成

以下のエンドポイントへの POST 呼び出しを行うことにより、鍵リングを作成します。

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/key_rings

1. サービス内で鍵の処理を行うために、認証資格情報を取得します。

2. 以下の curl コマンドを実行して、鍵リングを作成します。

   $ curl -X POST \
       "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/key_rings/<key_ring_id>" \
       -H "authorization: Bearer <IAM_token>" \
       -H "bluemix-instance: <instance_ID>" \
       -H "correlation-id: <correlation_ID>"
   

   次の表に従って、例の要求内の変数を置き換えてください。

   表 1. キー管理サービスAPIを使用してキーリングを作成するために必要な変数について説明します。

   変数	説明
   region	必須。 地域の略語、例：us-south 、あなたの地理的エリアを表しますHyper Protect Crypto Servicesインスタンスが存在します。 詳細については、リージョナル・サービス・エンドポイントを参照してください。
   port	必須。 API エンドポイントのポート番号。
   key_ring_id	必須。 作成する鍵リングの固有 ID。
   IAM_token	必須。 IBM Cloud アクセス・トークン。 完全な内容を含める IAM ベアラー値を含むトークンを curl リクエスト。 詳しくは、アクセス・トークンの取得を参照してください。
   instance_ID	必須。 Hyper Protect Crypto Services サービス・インスタンスに割り当てられた固有 ID。 詳細については、インスタンス ID のリトリーブを参照してください。
   correlation_ID	トランザクションを追跡し、相互に関連付けるために使用される固有 ID。

   POST api/v2/key_rings 要求が成功すると、鍵リングが作成されて、標準鍵とルート鍵の保持に使用できるようになったことを示す HTTP 201 Created 応答が返されます。

UI を使用した別の鍵リングへの鍵の移動

次の手順を実行すると、UI を使用してキーを別のキー リングに転送できます。

1. UI にログインします。
2. 「メニュー」>**「リソース・リスト」**に移動し、リソースのリストを表示します。
3. IBM Cloud リソース・リストで、Hyper Protect Crypto Services のプロビジョン済みインスタンスを選択します。
4. サイド・メニューの**「KMS キー」タブを選択して、「キー」**テーブルを開きます。
5. リストから転送したいキーを見つけ、アクション・アイコン をクリックしてオプション・リストを開きます。
6. **「キー・リングの変更」**をクリックします。
7. キーの移動先のキー・リング ID を選択し、**「キー・リングの変更」**をクリックします。

API を使用した別の鍵リングへの鍵の移動

以下のエンドポイントに PATCH 呼び出しを実行して、鍵を別の鍵リングに移動します。

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID>

1. サービス内で鍵の処理を行うために、認証資格情報を取得します。

   キーのキー・リングを更新するには、少なくともキーおよびターゲット・キー・リングに対する_「マネージャー」_サービス・アクセス権限が必要です。 IAM 役割と Hyper Protect Crypto Services サービスでのアクションの対応関係について詳しくは、サービス・アクセスの役割を参照してください。

2. 以下の curl コマンドを実行して、鍵の鍵リングを更新します。

   $ curl -X PATCH \
     "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID>" \
     -H 'accept: application/vnd.ibm.kms.key+json' \
     -H 'authorization: Bearer <IAM_token>' \
     -H 'bluemix-instance: <instance_ID>' \
     -H 'content-type: application/vnd.ibm.kms.key+json' \
     -H "x-kms-key-ring: <original_key_ring_ID>" \
     -H "correlation-id: <correlation_ID>" \
     -d '{
       "keyRingID": "<new_key_ring_ID>"
     }'
   

   次の表に従って、例の要求内の変数を置き換えてください。

   表 2. キー管理サービス API を使用してキーのキー リングを更新するために必要な変数について説明します。

   変数	説明
   region	必須。 地域の略語、例：us-south 、あなたの地理的エリアを表しますHyper Protect Crypto Servicesインスタンスが存在します。 詳細については、リージョナル・サービス・エンドポイントを参照してください。
   port	必須。 API エンドポイントのポート番号。
   IAM_token	必須。 IBM Cloud アクセス・トークン。 完全な内容を含める IAM ベアラー値を含むトークンを curl リクエスト。 詳しくは、アクセス・トークンの取得を参照してください。
   instance_ID	必須。 Hyper Protect Crypto Services サービス・インスタンスに割り当てられた固有 ID。 詳細については、インスタンス ID のリトリーブを参照してください。
   original_key_ring_ID	オプション。 鍵が属する鍵リングの固有 ID。 指定しないと、Hyper Protect Crypto Services は、指定されたインスタンスに関連付けられているすべての鍵リングで鍵を検索します。 このため、鍵リング ID を指定して、より最適化された要求を行うことをお勧めします。 注: パスワードなしでキーを作成すると、x-kms-key-ring ヘッダーの場合、キーのキーリングは次のようになります。default。
   correlation_ID	トランザクションを追跡し、相互に関連付けるために使用される固有 ID。
   new_key_ring_ID	必須。 キーの移動先のターゲット・キー・リングの固有 ID。

   PATCH api/v2/keys/key_ID 要求が成功すると、キーのメタデータ (キーが現在属しているキー・リングの ID を含む) が返されます。

   {
    "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"
              ],
            "description": "A test root key",
            "state": 1,
            "extractable": false,
            "keyRingID": "new-key-ring",
            "crn": "crn:v1:bluemix:public:hs-crypto:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:12e8c9c2-a162-472d-b7d6-8b9a86b815a6:key:02fd6835-6001-4482-a892-13bd2085f75d",
            "imported": false,
            "creationDate": "2020-03-12T03:37:32Z",
            "createdBy": "...",
            "algorithmType": "AES",
            "algorithmMetadata": {
                "bitLength": "256",
                "mode": "CBC_PAD"
            },
            "algorithmBitSize": 256,
            "algorithmMode": "CBC_PAD",
            "lastUpdateDate": "2020-03-12T03:37:32Z",
            "keyVersion": {
                "id": "2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
                "creationDate": "2020-03-12T03:37:32Z"
            },
            "dualAuthDelete": {
                "enabled": false
            },
            "deleted": false
        }
    ]
   }
   

UI でキーリングを一覧表示する

UI を使用してキーリングを参照するには、次の手順を実行します。

1. UI にログインします。
2. 「メニュー」>**「リソース・リスト」**に移動し、リソースのリストを表示します。
3. IBM Cloud リソース・リストで、Hyper Protect Crypto Services のプロビジョン済みインスタンスを選択します。
4. 鍵リングを参照するには、サイド・メニューの**「KMS 鍵リング (KMS key rings)」**タブを選択します。

鍵リング・テーブルには、以下の情報が含まれています。

API を使用した鍵リングのリスト表示

以下のエンドポイントへの GET 呼び出しを行うことにより、鍵リングを参照できます。

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/key_rings

1. サービス内で鍵の処理を行うために、認証資格情報を取得します。

2. 以下の curl コマンドを実行して、鍵リングに関する一般的な特性を表示します。

   $ curl -X GET \
       "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/key_rings" \
       -H "accept: application/vnd.ibm.kms.key_ring+json" \
       -H "authorization: Bearer <IAM_token>" \
       -H "bluemix-instance: <instance_ID>" \
       -H "correlation-id: <correlation_ID>"
   

   次の表に従って、例の要求内の変数を置き換えてください。

   表 4。 キー管理サービス API を使用してキー リングを表示するために必要な変数について説明します。

   変数	説明
   region	必須。 地域の略語、例：us-south 、あなたの地理的エリアを表しますHyper Protect Crypto Servicesインスタンスが存在します。 詳細については、リージョナル・サービス・エンドポイントを参照してください。
   port	必須。 API エンドポイントのポート番号。
   IAM_token	必須。 IBM Cloud アクセス・トークン。 完全な内容を含める IAM ベアラー値を含むトークンを curl リクエスト。 詳しくは、アクセス・トークンの取得を参照してください。
   instance_ID	必須。 Hyper Protect Crypto Services インスタンスに割り当てられた固有 ID。 詳細については、インスタンス ID のリトリーブを参照してください。
   correlation_ID	トランザクションを追跡し、相互に関連付けるために使用される固有 ID。

   GET api/v2/key_rings 要求が成功すると、Hyper Protect Crypto Services サービス・インスタンス内の使用可能な鍵リングの集合が返されます。

   {
       "metadata": {
           "collectionType": "application/vnd.ibm.kms.key_ring+json",
           "collectionTotal": 2
       },
       "resources": [
           {
               "id": "default"
           },
           {
               "id": "Sample Key Ring 2",
               "creationDate": "2020-03-12T11:00:06Z",
               "createdBy": "..."
           }
       ]
   }
   

UI でキーリングを削除する

UI を使用してキーリングを削除するには、次の手順を実行します。

1. UI にログインします。
2. 「メニュー」>**「リソース・リスト」**に移動し、リソースのリストを表示します。
3. IBM Cloud リソース・リストで、Hyper Protect Crypto Services のプロビジョン済みインスタンスを選択します。
4. サイド・メニューの**「KMS 鍵リング (KMS key rings)」**タブを選択して、鍵リングを参照します。
5. 削除したいキー・リングを見つけ、その行の末尾にある削除アイコンをクリックします。
6. 削除内容を確認して、**「鍵リングの削除」**をクリックします。

API を使用した鍵リングの削除

以下のエンドポイントへの DELETE 呼び出しを行うことによって、鍵リングを削除できます。

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/key_rings/<key_ring_id>

1. サービス内で鍵の処理を行うために、認証資格情報を取得します。

2. 削除する鍵リングの ID を取得します。

   Hyper Protect Crypto Services インスタンス内の鍵リングの ID は、鍵リングのリストを取得することで見つけることができます。

3. 次の curl コマンドを実行して、鍵リングを削除します。

   $ curl -X DELETE \
       "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/key_rings/<key_ring_id>" \
       -H "authorization: Bearer <IAM_token>" \
       -H "bluemix-instance: <instance_ID>" \
       -H "prefer: <return_preference>"
   

   次の表に従って、例の要求内の変数を置き換えてください。

   表 5. 鍵管理サービス API を使用して鍵を削除するために必要な変数について説明します。

   変数	説明
   region	必須。 地域の略語、例：us-south 、あなたの地理的エリアを表しますHyper Protect Crypto Servicesインスタンスが存在します。 詳細については、リージョナル・サービス・エンドポイントを参照してください。
   port	必須。 API エンドポイントのポート番号。
   key_ring_id	必須。 削除する鍵リングの固有 ID。
   IAM_token	必須。 IBM Cloud アクセス・トークン。 完全な内容を含める IAM ベアラー値を含むトークンを curl リクエスト。 詳しくは、アクセス・トークンの取得を参照してください。
   instance_ID	必須。 Hyper Protect Crypto Services サービス・インスタンスに割り当てられた固有 ID。 詳細については、インスタンス ID のリトリーブを参照してください。

   要求が成功すると、鍵リングが正常に削除されたことを示す HTTP 204 No Content 応答が返されます。