Criação de um adaptador

Um máximo de 200 adaptadores pode ser criado em uma única instância. Cada adaptador pode ter um máximo de 200 certificados associados a ele.

Os adaptadores KMIP são criados usando Key Protect chaves raiz. Se você não tiver uma chave raiz, crie uma.

Antes de começar, certifique-se de que possui a função “ Manager ” ou a função “ KmipAdapterManager ” na instância.

Para criar um adaptador:

1. No menu de navegação, clique em “Adaptadores KMIP ”. Se este for o seu primeiro adaptador, a tabela estará vazia.

2. Clique em Criar.

3. No painel lateral, forneça as seguintes informações:

   • Nome- Digite um nome para o adaptador (2 a 40 caracteres).
   • Descrição (opcional) — Insira uma descrição para o adaptador (2 a 240 caracteres).
   • Chave raiz- Selecione a chave raiz a ser usada para este adaptador. A chave raiz criptografa as chaves KMIP criadas pelo adaptador. Sua chave raiz deve estar no estado “ active ” para que seu adaptador funcione corretamente.

4. Opcional: Adicione um certificado público TLS para permitir que o titular do certificado privado correspondente se comunique com Key Protect por meio do adaptador KMIP. Somente certificados autorizados podem enviar solicitações pelo protocolo KMIP à sua instância.

   Para adicionar um certificado:

   1. Clique em Incluir.
   2. Digite um nome para o certificado.
   3. Insira o conteúdo do certificado no formato PEM, incluindo as tags BEGIN CERTIFICATE e END CERTIFICATE.
   4. Clique em “Adicionar certificado ”.

   A associação do certificado pode levar alguns minutos. Um certificado só pode estar associado a um único adaptador em uma região do Key Protect.

Os recursos gerenciados por meio do protocolo KMIP não podem ser acessados pela API HTTP.

Mantenha em segurança a chave privada de todos os certificados enviados. Qualquer certificado carregado em um adaptador KMIP pode realizar todas as operações KMIP compatíveis.

Visualização e atualização dos detalhes do adaptador

O painel de detalhes do adaptador exibe informações sobre um adaptador e permite que você realize ações como adicionar certificados.

Para visualizar os detalhes do adaptador:

1. Clique no menu de ações (⋯) do adaptador.
2. Selecione “Detalhes ”.

O painel de detalhes exibe o nome do adaptador, a descrição, as chaves simétricas KMIP associadas e os certificados carregados. Você também pode enviar certificados adicionais a partir deste painel.

As chaves simétricas do KMIP não podem ser excluídas pelo console. Para excluir chaves, use a CLI. Somente chaves simétricas KMIP que não estejam no estado “ Active ” (estado 1) podem ser excluídas. Não é possível excluir um adaptador se ele contiver chaves no estado “ Active ”.

Os recursos de cada adaptador são protegidos por uma chave raiz. Não é possível excluir uma chave raiz que esteja ativa e associada a um adaptador.

Cada chave simétrica KMIP criada conta como uma única versão de chave e incorre em uma cobrança de uma versão de chave. A exclusão de uma chave simétrica KMIP é definitiva.

Criação e uso de adaptadores KMIP na API

Esta seção descreve como usar adaptadores KMIP do perfil native_1.0 com a API, incluindo a adição e remoção de certificados de cliente KMIP, bem como a visualização e exclusão de objetos KMIP.

É possível criar um adaptador KMIP realizando uma chamada POST para o seguinte endpoint.

https://<region>.kms.cloud.ibm.com/api/v2/kmip_adapters

As operações nos sub-recursos do adaptador KMIP, incluindo certificados de cliente KMIP e objetos KMIP, estarão nos seguintes pontos de extremidade:

https://<region>.kms.cloud.ibm.com/api/v2/kmip_adapters/<adapter_name_or_ID>/certificates
https://<region>.kms.cloud.ibm.com/api/v2/kmip_adapters/<adapter_name_or_ID>/kmip_objects

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

2. Copie o ID da chave raiz que você deseja usar para criar o adaptador KMIP.

   Para obter o ID de uma chave na instância do Key Protect, é possível recuperar uma lista de chaves ou acessar o painel do Key Protect painel de controle.

3. Crie um adaptador KMIP com o seguinte comando curl:

   $ curl -X POST \
       "https://<region>.kms.cloud.ibm.com/api/v2/kmip_adapters" \
       -H "accept: application/vnd.ibm.kms.kmip_adapter+json" \
       -H "authorization: Bearer <IAM_token>" \
       -H "bluemix-instance: <instance_ID>" \
       -H "content-type: application/vnd.ibm.kms.kmip_adapter+json" \
       -d '{
               "metadata": {
                   "collectionType": "application/vnd.ibm.kms.kmip_adapter+json",
                   "collectionTotal": 1
               },
               "resources": [
                   {
                   "name": "<adapter_name>",
                   "description": "<adapter_description>",
                   "profile": "native_1.0",
                   "profile_data": {
                       "crk_id": "<root_keyID_or_alias>"
                   }
                   }
               ]
           }'
   

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

4. Opcional: você pode listar os adaptadores KMIP que existem em uma instância com o seguinte comando curl:

   $ curl -X GET \
       "https://<region>.kms.cloud.ibm.com/api/v2/kmip_adapters" \
       -H "accept: application/vnd.ibm.kms.kmip_adapter+json" \
       -H "authorization: Bearer <IAM_token>" \
       -H "bluemix-instance: <instance_ID>" \
       -H "content-type: application/vnd.ibm.kms.kmip_adapter+json"
   

   Você também pode obter um adaptador KMIP específico usando o seguinte comando curl:

   $ curl -X GET \
       "https://<region>.kms.cloud.ibm.com/api/v2/kmip_adapters/<adapter_name_or_ID>" \
       -H "accept: application/vnd.ibm.kms.kmip_adapter+json" \
       -H "authorization: Bearer <IAM_token>" \
       -H "bluemix-instance: <instance_ID>" \
       -H "content-type: application/vnd.ibm.kms.kmip_adapter+json"
   

   Observe que você pode usar o UUID do adaptador ou o nome do adaptador para obter um adaptador específico.

5. Você pode excluir um adaptador KMIP com o seguinte comando curl:

   $ curl -X DELETE \
       "https://<region>.kms.cloud.ibm.com/api/v2/kmip_adapters/<adapter_name_or_ID>" \
       -H "accept: application/vnd.ibm.kms.kmip_adapter+json" \
       -H "authorization: Bearer <IAM_token>" \
       -H "bluemix-instance: <instance_ID>" \
       -H "content-type: application/vnd.ibm.kms.kmip_adapter+json"
   

   Você só pode excluir o adaptador KMIP se todos os objetos KMIP sob o adaptador forem excluídos.