Création d'un adaptateur

Un maximum de 200 adaptateurs peut être créé sur une seule instance. Chaque adaptateur peut être associé à un maximum de 200 certificats.

Les adaptateurs KMIP sont créés à l'aide de Key Protect clés racines. Si vous n'avez pas de clé racine, créez-en une.

Avant de commencer, assurez-vous de disposer du rôle « Manager » ou du rôle « KmipAdapterManager » sur l'instance.

Pour créer un adaptateur :

1. Dans le menu de navigation, cliquez sur « Adaptateurs KMIP ». S'il s'agit de votre premier adaptateur, le tableau est vide.

2. Cliquez sur Créer.

3. Dans l'encadré latéral, veuillez indiquer les informations suivantes :

   • Nom- Saisissez un nom pour l'adaptateur (2 à 40 caractères).
   • Description (facultatif)- Saisissez une description pour l'adaptateur (2 à 240 caractères).
   • Clé racine: sélectionnez la clé racine à utiliser pour cet adaptateur. La clé racine chiffre les clés KMIP générées par l'adaptateur. Votre clé racine doit être en état « active » pour que votre adaptateur fonctionne correctement.

4. Facultatif : ajoutez un certificat public TLS afin de permettre au détenteur du certificat privé correspondant de communiquer avec Key Protect via l'adaptateur KMIP. Seuls les certificats autorisés peuvent envoyer des requêtes via le protocole KMIP à votre instance.

   Pour ajouter un certificat :

   1. Cliquez sur Ajouter.
   2. Saisissez un nom pour le certificat.
   3. Saisissez le contenu du certificat au format PEM, en incluant les balises BEGIN CERTIFICATE et END CERTIFICATE.
   4. Cliquez sur « Ajouter un certificat ».

   L'association des certificats peut prendre quelques minutes. Un certificat ne peut être associé qu'à un seul adaptateur dans une région d' Key Protect.

Les ressources gérées via le protocole KMIP ne sont pas accessibles via l'API HTTP.

Veillez à protéger la clé privée de tous les certificats que vous téléchargez. Tout certificat téléchargé vers un adaptateur KMIP permet d'effectuer toutes les opérations KMIP prises en charge.

Affichage et mise à jour des détails de l'adaptateur

Le panneau de détails de l'adaptateur affiche des informations sur un adaptateur et vous permet d'effectuer des actions telles que l'ajout de certificats.

Pour consulter les détails de l'adaptateur :

1. Cliquez sur le menu d'actions (⋯) de l'adaptateur.
2. Sélectionnez « Détails ».

Le panneau de détails affiche le nom de l'adaptateur, sa description, les clés symétriques KMIP associées et les certificats téléchargés. Vous pouvez également importer des certificats supplémentaires à partir de ce panneau.

Les clés symétriques KMIP ne peuvent pas être supprimées via la console. Pour supprimer des clés, utilisez l'interface de ligne de commande(CLI). Seules les clés symétriques KMIP qui ne sont pas dans l'état « Active » (état 1) peuvent être supprimées. Vous ne pouvez pas supprimer un adaptateur s'il contient des clés dont l'état est « Active ».

Les ressources de chaque adaptateur sont protégées par une clé racine. Vous ne pouvez pas supprimer une clé racine active et associée à un adaptateur.

Chaque clé symétrique KMIP créée compte pour une seule version de clé et entraîne des frais pour une version de clé. La suppression d'une clé symétrique KMIP est définitive.

Création et utilisation d'adaptateurs KMIP dans l'API

Cette section décrit comment utiliser les adaptateurs KMIP du profil « native_1.0 » avec l'API, notamment comment ajouter et supprimer des certificats client KMIP, ainsi que comment afficher et supprimer des objets KMIP.

Vous pouvez créer un adaptateur KMIP en effectuant un appel « POST » vers le point de terminaison suivant.

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

Les opérations sur les sous-ressources de l'adaptateur KMIP, y compris les certificats des clients KMIP et les objets KMIP, se feront dans les points de terminaison suivants :

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. Extrayez les données d'authentification afin d'utiliser les clés dans le service.

2. Copiez l'ID de la clé racine que vous souhaitez utiliser pour créer votre adaptateur KMIP.

   Vous pouvez trouver l'ID d'une clé dans votre instance Key Protect enextrayant une liste de vos clés ou en accédant au tableau de bord Key Protect tableau de bord.

3. Créez un adaptateur KMIP avec la commande suivante 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>"
                   }
                   }
               ]
           }'
   

   Remplacez les variables de l'exemple de demande conformément au tableau suivant :

4. Facultatif : vous pouvez dresser la liste des adaptateurs KMIP qui existent dans une instance avec la commande suivante 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"
   

   Vous pouvez également obtenir un adaptateur KMIP spécifique en utilisant la commande suivante 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"
   

   Notez que vous pouvez utiliser soit l'UUID de l'adaptateur, soit son nom pour obtenir un adaptateur spécifique.

5. Vous pouvez supprimer un adaptateur KMIP avec la commande suivante 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"
   

   Vous ne pouvez supprimer l'adaptateur KMIP que si tous les objets KMIP sous l'adaptateur sont supprimés.