clé set-attribute

Utilisez la key set-attribute commande pour définir les attributs des clés dans votre AWS CloudHSM cluster. Seul le CU qui a créé la clé et qui en est donc propriétaire peut modifier les attributs de la clé.

Pour obtenir la liste des attributs clés qui peuvent être utilisés dans la CLI CloudHSM, consultez. Attributs de clé de la CLI CloudHSM

Type utilisateur

Les types d'utilisateur suivants peuvent exécuter cette commande.

• Seuls les utilisateurs de chiffrement (CU) peuvent exécuter cette commande.

• Les administrateurs peuvent définir l'attribut de confiance.

Prérequis

Pour exécuter cette commande, vous devez être connecté en tant que CU. Pour définir l'attribut sécurisé, vous devez être connecté en tant qu'utilisateur administrateur.

Syntaxe

aws-cloudhsm > help key set-attribute
Set an attribute for a key in the HSM cluster

Usage: cloudhsm-cli key set-attribute [OPTIONS] --filter [<FILTER>...] --name <KEY_ATTRIBUTE> --value <KEY_ATTRIBUTE_VALUE>

Options:
      --cluster-id <CLUSTER_ID>         Unique Id to choose which of the clusters in the config file to run the operation against. If not provided, will fall back to the value provided when interactive mode was started, or error
      --filter [<FILTER>...]            Key reference (e.g. key-reference=0xabc) or space separated list of key attributes in the form of attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE to select a matching key to modify
      --name <KEY_ATTRIBUTE>            Name of attribute to be set
      --value <KEY_ATTRIBUTE_VALUE>...  Attribute value to be set
  -h, --help                            Print help

Exemple : définition d'un attribut clé

L'exemple suivant montre comment utiliser la commande key set-attribute pour définir l'étiquette.

1. Utilisez la clé avec l'étiquette my_key, comme indiqué ici :

   aws-cloudhsm > key set-attribute --filter attr.label=my_key --name encrypt --value false
   {
     "error_code": 0,
     "data": {
       "message": "Attribute set successfully"
     }
   }

2. Utilisez la commande key list pour confirmer que l'attribut encrypt a changé :

   aws-cloudhsm > key list --filter attr.label=my_key --verbose
   {
     "error_code": 0,
     "data": {
       "matched_keys": [
         {
           "key-reference": "0x00000000006400ec",
           "key-info": {
             "key-owners": [
               {
                 "username": "bob",
                 "key-coverage": "full"
               }
             ],
             "shared-users": [],
             "cluster-coverage": "full"
           },
           "attributes": {
             "key-type": "aes",
             "label": "my_key",
             "id": "",
             "check-value": "0x6bd9f7",
             "class": "secret-key",
             "encrypt": false,
             "decrypt": true,
             "token": true,
             "always-sensitive": true,
             "derive": true,
             "destroyable": true,
             "extractable": true,
             "local": true,
             "modifiable": true,
             "never-extractable": false,
             "private": true,
             "sensitive": true,
             "sign": true,
             "trusted": true,
             "unwrap": true,
             "verify": true,
             "wrap": true,
             "wrap-with-trusted": false,
             "key-length-bytes": 32
           }
         }
       ],
       "total_key_count": 1,
       "returned_key_count": 1
     }
   }

Arguments

<CLUSTER_ID>

ID du cluster sur lequel exécuter cette opération.

Obligatoire : si plusieurs clusters ont été configurés.

<KEY_ATTRIBUTE>

Spécifie le nom de l'attribut de la clé.

Obligatoire : oui

<FILTER>

Référence clé (par exemple,key-reference=0xabc) ou liste d'attributs clés séparés par des espaces sous la forme de attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE pour sélectionner une clé correspondante à supprimer.

Pour obtenir la liste des attributs clés de la CLI CloudHSM pris en charge, voir Attributs de clé de la CLI CloudHSM

Obligatoire : non

<KEY_ATTRIBUTE_VALUE>

Spécifie la valeur de l'attribut de la clé.

Obligatoire : oui

<KEY_REFERENCE>

Représentation hexadécimale ou décimale de la clé (comme un handle de clé).

Obligatoire : non

Rubriques en relation

• Utilisation de la CLI CloudHSM pour filtrer les clés

• Attributs de clé de la CLI CloudHSM