Création d'un alias de clé à l'aide de l'interface utilisateur

Créez un alias de clé avec l'interface utilisateur en procédant comme suit:

1. Connectez-vous à l'interface utilisateur.

2. Accédez à Menu > Liste de ressources pour afficher la liste de vos ressources.

3. Dans la liste de ressources IBM Cloud, sélectionnez votre instance Hyper Protect Crypto Services mise à disposition.

4. Sélectionnez l'onglet Clés KMS dans le menu latéral et recherchez la clé pour laquelle vous souhaitez créer des alias de clé.

5. Cliquez sur l'icône Actions pour ouvrir la liste des options de la clé et cliquez sur Éditer les alias de clé.

6. Séparez les alias de clé par une virgule. Vous pouvez ajouter jusqu'à cinq alias pour une clé.

   Chaque alias doit être alphanumérique, sensible à la casse et ne peut pas contenir d'espaces ou de caractères spéciaux autres que des tirets (-) ou des traits de soulignement (_). L'alias ne peut pas être un identificateur unique universel de version 4 et ne doit pas être un nom réservé Hyper Protect Crypto Services : allowed_ip, key, keys, metadata, policy, policies, registration, registrations, ring, rings, rotate, wrap, unwrap, rewrap, version, versions. La taille de l'alias peut être de 2 à 90 caractères (inclus).

7. Cliquez sur Sauvegarder.

Création d'un alias de clé avec l'API

Pour créer un alias de clé, vous devez effectuer un appel POST au noeud final suivant.

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

1. Extrayez vos données d'authentification afin d'utiliser les clés dans le service.

   Pour créer un alias de clé, vous devez avoir un rôle d'accès au service de Gestionnaire ou Éditeur. Pour savoir comment les rôles IAM sont mappés Les actions de service Hyper Protect Crypto Services, consultez lesrôles d'accès au service.

2. Créez un alias de clé en exécutant la commande curl suivante.

   $ 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>"
   

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

   Tableau 1. Décrit les variables requises pour créer un alias de clé avec l'API Hyper Protect Crypto Services

   Variables	Description
   region	Obligatoire. Abréviation de la région, telle que us-south, qui représente la zone géographique dans laquelle réside votre instance Hyper Protect Crypto Services. Pour plus d'informations, voir Nœuds finaux de service régional.
   port	Obligatoire. Numéro de port du noeud final d'API.
   key_ID	Obligatoire. Identificateur de la clé que vous souhaitez associer à un alias. Pour extraire un ID de clé, voir interface de programmation de clés de liste.
   key_alias	Obligatoire. Nom lisible permettant d'identifier facilement votre clé. Chaque alias doit être alphanumérique, sensible à la casse et ne peut pas contenir d'espaces ou de caractères spéciaux autres que des tirets (-) ou des traits de soulignement (_). L'alias ne peut pas être un UUID de version 4 et ne doit pas être un nom réservé Hyper Protect Crypto Services: allowed_ip, key, keys, metadata, policy, policies, registration, registrations, ring, rings, rotate, wrap, unwrap, rewrap, version, versions. La taille d'alias peut être comprise entre 2 et 90 caractères (inclus). Remarque: Vous ne pouvez pas avoir de noms d'alias en double dans votre instance Hyper Protect Crypto Services.
   IAM_token	Obligatoire. Votre jeton d'accès IBM Cloud. Incluez le contenu complet du jeton IAM, y compris la valeur Bearer, dans la demande curl. Pour plus d'informations, voir Extraction d'un jeton d'accès.
   instance_ID	Obligatoire. Identificateur unique affecté à votre instance de service Hyper Protect Crypto Services. Pour plus d'informations, voir Extraction d'un ID d'instance.
   correlation_ID	Identificateur unique qui est utilisé pour suivre et corréler des transactions.

   Pour garantir la confidentialité de vos données personnelles, évitez de saisir des informations personnelles (PII), telles que votre nom ou votre emplacement, lorsque vous créez un alias de clé. Pour d'autres exemples d'informations identifiant la personne, voir la section 2.2 du document NIST Special Publication 800-122.

   Une réponse POST api/v2/keys/<key_ID>/aliases/<key_alias> réussie renvoie l'alias de votre clé, ainsi que d'autres métadonnées. L'alias est un nom unique qui est affecté à votre clé et qui peut être utilisé pour extraire plus d'informations sur la clé associée.

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

   Pour une description détaillée des paramètres de réponse, voir Hyper Protect Crypto Services Documentation de référence de l'API REST.

Suppression d'alias de clé à l'aide de l'interface utilisateur

Supprimez un alias de clé à l'aide de l'interface utilisateur en procédant comme suit:

1. Connectez-vous à l'interface utilisateur.
2. Accédez à Menu > Liste de ressources pour afficher la liste de vos ressources.
3. Dans la liste de ressources IBM Cloud, sélectionnez votre instance Hyper Protect Crypto Services mise à disposition.
4. Sélectionnez l'onglet Clés KMS dans le menu latéral et recherchez la clé pour laquelle vous souhaitez créer des alias de clé.
5. Cliquez sur l'icône Actions pour ouvrir la liste des options de la clé et cliquez sur Éditer les alias de clé.
6. Supprimez l'alias de clé que vous souhaitez supprimer et cliquez sur Sauvegarder.

Suppression d'un alias de clé avec l'API

Pour supprimer un alias de clé, effectuez un appel DELETE au noeud final suivant.

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

1. Extrayez vos données d'authentification afin d'utiliser les clés dans le service.

2. Supprimez un alias de clé en exécutant la commande curl suivante.

   $ 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>"
   

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

   Tableau 2. Décrit les variables requises pour supprimer un alias de clé avec l'API Hyper Protect Crypto Services

   Variables	Description
   region	Obligatoire. Abréviation de la région, telle que us-south, qui représente la zone géographique dans laquelle réside votre instance Hyper Protect Crypto Services. Pour plus d'informations, voir Nœuds finaux de service régional.
   port	Obligatoire. Numéro de port du noeud final d'API.
   key_ID	Obligatoire. Identificateur unique de la clé.
   key_alias	Obligatoire. Nom unique et lisible qui identifie votre clé.
   IAM_token	Obligatoire. Votre jeton d'accès IBM Cloud. Incluez le contenu complet du jeton IAM, y compris la valeur Bearer, dans la demande curl. Pour plus d'informations, voir Extraction d'un jeton d'accès.
   instance_ID	Obligatoire. Identificateur unique affecté à votre instance de service Hyper Protect Crypto Services. Pour plus d'informations, voir Extraction d'un ID d'instance.
   correlation_ID	Identificateur unique qui est utilisé pour suivre et corréler des transactions.

   Une demande DELETE api/v2/keys/<key_ID>/aliases/<key_alias> réussie renvoie une réponse HTTP 204 No Content, ce qui indique que l'alias associé à votre clé a été supprimé.

   La suppression d'un alias du service peut prendre jusqu'à 10 minutes.