Visualizando detalhes sobre uma chave raiz ou uma chave padrão

Para recuperar as características gerais de uma única chave de criptografia, é possível utilizar o IBM Cloud® Hyper Protect Crypto Services.

Recuperar uma chave raiz ou uma chave padrão requer uma política de acesso de Gravador ou Gerenciador, mas você pode precisar de uma maneira de visualizar apenas os detalhes sobre uma chave raiz ou uma chave padrão, como o histórico de transição ou configuração, sem recuperar a própria chave. Se você tiver a permissão de acesso _Leitor, será possível usar a API de gerenciamento de chave _ Hyper Protect Crypto Services para recuperar apenas os metadados sobre uma chave raiz ou uma chave padrão.

Visualizando detalhes da chave com a IU

É possível visualizar detalhes sobre uma chave específica com a IU concluindo as etapas a seguir:

  1. Efetue login na IU.
  2. Acesse Menu > Lista de recursos para visualizar uma lista de seus recursos.
  3. Em sua lista de recursos do IBM Cloud, selecione a sua instância provisionada do Hyper Protect Crypto Services.
  4. Na página Chaves KMS, use a tabela Chaves para procurar as chaves em seu serviço.
  5. Clique no ícone Ações ícone Ações para abrir uma lista de opções para a chave específica.
  6. A partir do menu de opções, clique em Visualizar detalhes da chave para visualizar os detalhes da chave.

Visualizando detalhes da chave com a API de serviço de gerenciamento de chaves

Para visualizar informações detalhadas sobre uma chave raiz específica ou uma chave padrão, é possível fazer uma chamada GET para o terminal a seguir.

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID_or_alias>/metadata
  1. Recupere as suas credenciais de autenticação para trabalhar com chaves no serviço.

  2. Recupere o ID da chave que você gostaria de inspecionar.

    O valor de ID é usado para acessar informações detalhadas sobre a chave. É possível localizar o ID para uma chave em sua instância de serviço por recuperando uma lista de suas chaves ou acessando a UI.

  3. Obtenha os detalhes sobre a chave executando o comando cURL a seguir.

    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>'
    

    Substitua as variáveis na solicitação de exemplo de acordo com a tabela a seguir.

    Tabela 1. Descreve as variáveis necessárias para visualizar detalhes sobre uma chave com a API
    Variável Descrição
    region Obrigatório. A abreviação da região, como us-south ou eu-de, que representa a área geográfica na qual sua instância do Hyper Protect Crypto Services reside. Para obter mais informações, consulte Terminais de serviços regionais.
    key_ID_or_alias Obrigatório. O identificador ou alias para a chave que você deseja inspecionar.
    IAM_token Obrigatório. Seu token de acesso do IBM Cloud. Inclua o conteúdo integral do token IAM, incluindo valor Bearer, na solicitação cURL. Para obter mais informações, consulte Recuperando um token de acesso.
    instance_ID Obrigatório. O identificador exclusivo que é designado para a sua instância do Hyper Protect Crypto Services. Para obter mais informações, consulte Recuperando um ID da instância.
    key_ring_ID Opcional. O identificador exclusivo do conjunto de chaves ao qual a chave pertence. Se não especificado, o Hyper Protect Crypto Services procurará a chave em cada conjunto de chaves associado à instância especificada. Portanto, sugere-se especificar o ID do conjunto de chaves para uma solicitação mais otimizada.

    Nota: o ID do conjunto de chaves de chaves que são criadas sem um cabeçalho x-kms-key-ring é: default. Para obter mais informações, consulte Gerenciando conjuntos de chaves.

    correlation_ID O identificador exclusivo que é usado para rastrear e correlacionar transações.

    Quando bem-sucedida, a resposta de GET api/v2/keys/<key_ID_or_alias>/metadata retorna detalhes sobre a chave. O objeto JSON a seguir mostra um valor retornado de exemplo para uma chave padrão.

    {
      "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
        }
      ]
    }
    

    É necessário recuperar o valor de payload para uma chave padrão? Para saber mais, consulte Recuperando uma chave raiz ou uma chave padrão.

    Para obter uma descrição detalhada dos parâmetros de resposta, consulte o Hyper Protect Crypto Services gerenciamento de chaves doc de referência da API REST.