key set-attribute

Use el key set-attribute comando para establecer los atributos de las claves del AWS CloudHSM clúster. Solamente el CU que creó la clave y que, por lo tanto, es su propietario, puede cambiar los atributos de la clave.

Para obtener una lista de los atributos clave que se pueden usar en la CLI de CloudHSM, consulte Atributos clave de la nube HSM CLI.

Tipo de usuario

Los tipos de usuarios siguientes pueden ejecutar este comando.

• Solo los usuarios de criptografía (CU) pueden ejecutar este comando.

• Los administradores pueden establecer el atributo de confianza.

Requisitos

Para ejecutar este comando, debe iniciar sesión como CU. Para establecer el atributo de confianza, debe iniciar sesión como usuario administrador.

Sintaxis

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

Ejemplo: configuración de un atributo clave

El siguiente ejemplo muestra cómo utilizar el comando key set-attribute para establecer la etiqueta.

1. Utilice la clave con la etiqueta my_key, como se muestra a continuación:

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

2. Utilice el comando key list para confirmar que el atributo encrypt ha cambiado:

   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
     }
   }

Argumentos

<CLUSTER_ID>

El ID del clúster en el que se va a ejecutar esta operación.

Obligatorio: si se han configurado varios clústeres.

<KEY_ATTRIBUTE>

Especifica el nombre del atributo de la clave.

Obligatorio: sí

<FILTER>

Referencia clave (por ejemplokey-reference=0xabc) o lista de atributos clave separados por espacios en forma de attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE para seleccionar una clave coincidente para su eliminación.

Para obtener una lista de los atributos clave de la CLI de CloudHSM compatibles, consulte Atributos clave de la nube HSM CLI

Obligatorio: no

<KEY_ATTRIBUTE_VALUE>

Especifica el valor del atributo de la clave.

Obligatorio: sí

<KEY_REFERENCE>

Representación hexadecimal o decimal de la clave (como el identificador de una clave).

Obligatorio: no

Temas relacionados de

• Uso de la CLI de CloudHSM para filtrar claves

• Atributos clave de la nube HSM CLI