Criando alias de chave com a IU

Crie um alias de chave com a UI 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. Selecione a guia Chaves do KMS no menu lateral e encontre a chave para a qual você deseja criar aliases de chave.

5. Clique no ícone Ações para abrir a lista de opções para a chave e clique em Editar aliases de chave.

6. Insira aliases de chave separados por uma vírgula. É possível incluir até cinco aliases para uma chave.

   Cada alias deve ser alfanumérico, fazer distinção entre maiúsculas e minúsculas e não pode conter espaços ou caracteres especiais diferentes de traços (-) ou sublinhados (_). O alias não pode ser um UUID versão 4 e não deve ser um nome reservado do Hyper Protect Crypto Services: allowed_ip, key, keys, metadata, policy, policies, registration, registrations, ring, rings, rotate, wrap, unwrap, rewrap, version, versions. O tamanho do alias pode ter de 2 a 90 caracteres (inclusive).

7. Clique em Salvar.

Criando aliases de chave com a API

Crie um alias de chave fazendo uma chamada POST para o terminal a seguir.

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

1. Recupere as suas credenciais de autenticação para trabalhar com chaves no serviço.

   Para criar um alias de chave, deve-se ser designado a uma função de acesso de serviço de Gerenciador ou Gravador. Para saber como as funções do IAM mapeiam para ações de serviço do Hyper Protect Crypto Services, confira Funções de acesso de serviço.

2. Crie um alias de chave executando o comando curl a seguir.

   $ curl -X POST \
       "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID>/aliases/<key_alias>" \
       -H "authorization: Bearer <IAM_token>" \
       -H "bluemix-instance: <instance_ID>" \
       -H "content-type: application/vnd.ibm.kms.key+json" \
       -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 criar um alias de chave com a API Hyper Protect Crypto Services

   Variável	Descrição
   region	Obrigatório. A abreviação da região, como us-south, 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.
   port	Obrigatório. O número da porta do terminal da API.
   key_ID	Obrigatório. O identificador para a chave que você deseja associar a um alias. Para recuperar um ID de chave, consulte a API de chaves de lista.
   key_alias	Obrigatório. Um nome exclusivo legível para fácil identificação da sua chave. Cada alias deve ser alfanumérico, com distinção entre maiúsculas e minúsculas e não pode conter espaços ou caracteres especiais diferentes de traços (-) ou sublinhados (_). O alias não pode ser um UUID versão 4 e não deve ser um nome reservado Hyper Protect Crypto Services: allowed_ip, key, keys, metadata, policy, policies, registration, registrations, ring, rings, rotate, wrap, unwrap, rewrap, version, versions. O tamanho do alias pode ser de 2 a 90 caracteres (inclusive). Nota: não é possível ter nomes de alias duplicados na instância do Hyper Protect Crypto Services.
   IAM_token	Obrigatório. Seu token de acesso do IBM Cloud. Inclua o conteúdo integral do token IAM, incluindo o valor Bearer, na solicitação curl. Para obter mais informações, veja Recuperando um token de acesso.
   instance_ID	Obrigatório. O identificador exclusivo que é designado para sua instância de serviço Hyper Protect Crypto Services. Para obter mais informações, consulte Recuperando um ID da instância.
   correlation_ID	O identificador exclusivo que é usado para rastrear e correlacionar transações.

   Para proteger a confidencialidade de seus dados pessoais, evite inserir informações pessoais identificáveis (PII), como seu nome ou localização, quando criar um alias de chave. Para obter mais exemplos de PIII, consulte a seção 2.2 da Publicação Especial NIST 800-122.

   Uma resposta POST api/v2/keys/<key_ID>/aliases/<key_alias> bem-sucedida retorna o alias para sua chave, juntamente com outros metadados. O alias é um nome exclusivo que é designado à sua chave e pode ser usado para para recuperar mais informações sobre a chave associada.

   {
       "metadata": {
           "collectionType": "application/vnd.ibm.kms.key+json",
           "collectionTotal": 1
       },
       "resources": [
           {
               "keyId": "02fd6835-6001-4482-a892-13bd2085f75d",
               "alias": "test-alias",
               "creationDate": "2020-03-12T03:37:32Z",
               "createdBy": "..."
           }
       ]
   }
   

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

Excluindo aliases de chave com a UI

Exclua um alias de chaves com a UI 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. Selecione a guia Chaves do KMS no menu lateral e encontre a chave para a qual você deseja criar aliases de chave.
5. Clique no ícone Ações para abrir a lista de opções para a chave e clique em Editar aliases de chave.
6. Exclua o alias de chave que você deseja remover e clique em Salvar.

Excluindo aliases de chave com a API

Exclua um alias de chave fazendo uma chamada DELETE para o terminal a seguir.

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

1. Recupere as suas credenciais de autenticação para trabalhar com chaves no serviço.

2. Exclua um alias de chave executando o comando curl a seguir.

   $ curl -X DELETE \
       "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID>/aliases/<key_alias>" \
       -H "authorization: Bearer <IAM_token>" \
       -H "bluemix-instance: <instance_ID>" \
       -H "content-type: application/vnd.ibm.kms.key+json" \
       -H "correlation-id: <correlation_ID>"
   

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

   Tabela 2. Descreve as variáveis necessárias para excluir um alias de chave com a API Hyper Protect Crypto Services

   Variável	Descrição
   region	Obrigatório. A abreviação da região, como us-south, 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.
   port	Obrigatório. O número da porta do terminal da API.
   key_ID	Obrigatório. O identificador exclusivo para a chave.
   key_alias	Obrigatório. O nome exclusivo, legível que identifica sua chave.
   IAM_token	Obrigatório. Seu token de acesso do IBM Cloud. Inclua o conteúdo integral do token IAM, incluindo o valor Bearer, na solicitação curl. Para obter mais informações, veja Recuperando um token de acesso.
   instance_ID	Obrigatório. O identificador exclusivo que é designado para sua instância de serviço Hyper Protect Crypto Services. Para obter mais informações, consulte Recuperando um ID da instância.
   correlation_ID	O identificador exclusivo que é usado para rastrear e correlacionar transações.

   Uma solicitação de DELETE api/v2/keys/<key_ID>/aliases/<key_alias> bem-sucedida retorna uma resposta HTTP 204 No Content, que indica que o alias associado à sua chave foi excluído.

   Leva até cinco minutos para que um alias seja excluído do serviço.