key generate-symmetric generic-secret

El comando key generate-asymmetric-pair genera una clave secreta genérica y simétrica en su clúster de AWS CloudHSM.

Tipo de usuario

Los tipos de usuarios siguientes pueden ejecutar este comando.

• Usuarios de criptografía (CU)

Requisitos

Para ejecutar este comando, debe iniciar sesión como CU.

Sintaxis

aws-cloudhsm > key help generate-symmetric generic-secret
Generate a generic secret key

Usage: key generate-symmetric generic-secret [OPTIONS] --label <LABEL> --key-length-bytes <KEY_LENGTH_BYTES>

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
      --label <LABEL>
          Label for the key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --key-length-bytes <KEY_LENGTH_BYTES>
          Key length in bytes
      --attributes [<KEY_ATTRIBUTES>...]
          Space separated list of key attributes to set for the generated generic secret key in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE
  -h, --help
          Print help

Ejemplos

En estos ejemplos se muestra cómo usar el comando key generate-symmetric generic-secret para crear una clave secreta genérica.

ejemplo Ejemplo: crear una clave secreta genérica

aws-cloudhsm > key generate-symmetric generic-secret \
--label example-generic-secret \
--key-length-bytes 256
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000002e08fd",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "cluster-coverage": "session"
      },
      "attributes": {
        "key-type": "generic-secret",
        "label": "example-generic-secret",
        "id": "",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": false,
        "always-sensitive": true,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 256
      }
    }
  }
}

ejemplo Ejemplo: cree una clave secreta genérica con atributos opcionales

aws-cloudhsm > key generate-symmetric generic-secret \
--label example-generic-secret \
--key-length-bytes 256 \
--attributes token=true encrypt=true
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000002e08fd",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "cluster-coverage": "session"
      },
      "attributes": {
        "key-type": "generic-secret",
        "label": "example-generic-secret",
        "id": "",
        "class": "secret-key",
        "encrypt": true,
        "decrypt": false,
        "token": true,
        "always-sensitive": true,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 256
      }
    }
  }
}

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

Especifica una lista de atributos de clave separados por espacios que se debe configurar para la clave AES generada en forma de KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE (por ejemplo, token=true).

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

Obligatorio: no

<KEY-LENGTH-BYTES>

Especifica la longitud de la clave en bytes.

Valores válidos:

• 1 a 800

Obligatorio: sí

<LABEL>

Especifica una etiqueta definida del usuario para la clave secreta genérica. El tamaño máximo permitido label es de 127 caracteres para el SDK de cliente 5.11 y versiones posteriores. El SDK de cliente 5.10 y versiones anteriores tiene un límite de 126 caracteres.

Obligatorio: sí

<SESSION>

Crea una clave que solo existe en la sesión actual. La clave no se podrá recuperar una vez finalizada la sesión.

Utilice este parámetro cuando necesite una clave solo brevemente, por ejemplo, una clave de encapsulamiento que cifre y, a continuación, descifre rápidamente otra clave. No utilice una clave de sesión para cifrar los datos que pueda necesitar descifrar una vez finalizada la sesión.

De forma predeterminada, las claves que se generan son claves persistentes (token). La transferencia a <SESSION> cambia este estado, lo que garantiza que la clave generada con este argumento sea una clave de sesión (efímera).

Obligatorio: no

Temas relacionados de

• Atributos de clave de la CLI de CloudHSM

• Uso de la CLI de CloudHSM para filtrar claves