查看有关根密钥或标准密钥的详细信息

您可以使用以下命令检索单个加密密钥的一般特征: IBM Cloud® Hyper Protect Crypto Services.

检索根密钥或标准密钥需要 WriterManager 访问策略,但您可能需要一种方法来仅查看有关根密钥或标准密钥 (例如,过渡历史记录或配置) 的详细信息,而不检索密钥本身。 如果您具有 读者 访问许可权,那么可以使用 Hyper Protect Crypto Services 密钥管理 API 来仅检索有关根密钥或标准密钥的元数据。

使用 UI 查看密钥详细信息

您可以通过完成以下步骤来查看有关使用 UI 的特定密钥的详细信息:

  1. 登录 UI
  2. 菜单>资源列表查看您的资源列表。
  3. 从 IBM Cloud 资源列表,选择 Hyper Protect Crypto Services 的已供应实例。
  4. KMS 密钥页面,使用按键表来浏览您的服务中的密钥。
  5. 单击 操作 图标 "操作" 图标 以打开特定键的选项列表。
  6. 从选项菜单中,单击 查看密钥详细信息 以查看密钥的详细信息。

使用密钥管理服务 API 查看密钥详细信息

要查看有关特定根键或标准键的详细信息,您可以进行 GET 调用以下端点。

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID_or_alias>/metadata
  1. 检索认证凭证以使用服务中的密钥

  2. 检索您想要检查的密钥的 ID。

    标识值用于访问有关密钥的详细信息。 您可以通过以下方法在服务实例中找到密钥的标识: 检索密钥列表,或者通过访问 UI。

  3. 通过运行以下 cURL 命令获取有关密钥的详细信息。

    curl -X GET \
      'https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID_or_alias>/metadata' \
      -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>'
    

    根据下表替换示例请求中的变量。

    表 1. 描述查看有关使用 API 的密钥的详细信息所需的变量
    变量 描述
    region 必需。 地区缩写,例如 us-south 或者 eu-de,代表您的Hyper Protect Crypto Services实例驻留。 有关更多信息,请参阅区域服务端点
    key_ID_or_alias 必需。 要检查的密钥的标识或别名。
    IAM_token 必需。 您的 IBM Cloud 访问令牌。 在 cURL 请求中包含 IAM 令牌的完整内容,包括 Bearer 值。 有关详细信息,请参阅For more information, see 检索访问令牌
    instance_ID 必需。 分配给您的Hyper Protect Crypto Services实例。 有关详细信息,请参阅For more information, see 检索实例 ID
    key_ring_ID 可选。 密钥所属的密钥环的唯一标识。 如果未指定,那么 Hyper Protect Crypto Services 将在与指定实例关联的每个密钥环中搜索密钥。 因此,建议为更优化的请求指定密钥环标识。

    注: 在没有 x-kms-key-ring 头的情况下创建的密钥的密钥环标识为: 缺省值。 有关更多信息,请参阅 管理密钥环

    correlation_ID 用于跟踪和关联事务的唯一标识。

    成功的 GET api/v2/keys/<key_ID_or_alias>/metadata 响应将返回有关密钥的详细信息。 以下 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",
          "state": 1,
          "extractable": true,
          "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:50:12Z",
          "createdBy": "...",
          "algorithmType": "AES",
          "algorithmMetadata": {
            "bitLength": "256",
            "mode": "CBC_PAD"
          },
          "algorithmBitSize": 256,
          "algorithmMode": "CBC_PAD",
          "lastUpdateDate": "2020-03-12T03:50:12Z",
          "dualAuthDelete": {
            "enabled": false
          },
          "deleted": false
        }
      ]
    }
    

    需要检索标准密钥的 payload 值吗? 要了解更多信息,请参阅 检索根密钥或标准密钥

    有关响应参数的详细描述,请参阅 Hyper Protect Crypto Services 密钥管理 REST API 参考文档