As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# Gerar uma chave AES simétrica com a CloudHSM CLI
<a name="cloudhsm_cli-key-generate-symmetric-aes"></a>

Use o **key generate-symmetric aes** comando na CLI do CloudHSM para gerar uma chave AES simétrica no seu cluster. AWS CloudHSM 

## Tipo de usuário
<a name="key-generate-symmetric-aes-userType"></a>

Os seguintes tipos de usuários podem executar este comando.
+ Usuários de criptomoedas (CUs)

## Requisitos
<a name="key-generate-symmetric-aes-requirements"></a>

Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="key-generate-symmetric-aes-syntax"></a>

```
aws-cloudhsm > help key generate-symmetric aes
Generate an AES key

Usage: key generate-symmetric aes [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 AES key in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE
      --share-crypto-users [{{<SHARE_CRYPTO_USERS>}}...]
          Space separated list of Crypto User usernames to share the AES key with
      --manage-key-quorum-value {{<MANAGE_KEY_QUORUM_VALUE>}}
          The quorum value for key management operations
      --use-key-quorum-value {{<USE_KEY_QUORUM_VALUE>}}
          The quorum value for key usage operations
  -h, --help
          Print help
```

## Exemplos
<a name="key-generate-symmetric-aes-examples"></a>

Esses exemplos mostram como usar o **key generate-symmetric aes** comando para criar uma chave AES.

**Example Exemplo: crie uma chave AES**  

```
aws-cloudhsm > key generate-symmetric aes \
--label example-aes \
--key-length-bytes 24
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000002e06bf",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "example-aes",
        "id": "",
        "check-value": "0x9b94bd",
        "class": "secret-key",
        "encrypt": false,
        "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": 24
      }
    }
  }
}
```

**Example Exemplo: crie uma chave AES com atributos opcionais**  

```
aws-cloudhsm > key generate-symmetric aes \
--label example-aes \
--key-length-bytes 24 \
--attributes decrypt=true encrypt=true
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000002e06bf",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "example-aes",
        "id": "",
        "check-value": "0x9b94bd",
        "class": "secret-key",
        "encrypt": true,
        "decrypt": true,
        "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": 24
      }
    }
  }
}
```

**Example Exemplo: criar uma chave AES com valores de quórum**  
Ao gerar uma chave com controles de quórum, a chave deve estar associada a um número mínimo de usuários igual ao maior valor de quórum da chave. Os usuários associados incluem o proprietário da chave e os usuários de criptografia com quem essa chave é compartilhada. Para definir o número mínimo de usuários com quem compartilhar a chave, obtenha o maior valor de quórum entre o valor do quórum de uso da chave e o valor do quórum de gerenciamento de chaves e subtraia 1 para contabilizar o proprietário da chave, que, por padrão, está associado à chave. Para compartilhar a chave com mais usuários, use o comando **[Compartilhar uma chave usando a CloudHSM CLI](cloudhsm_cli-key-share.md)**.  

```
aws-cloudhsm > key generate-symmetric aes \
--label example-aes \
--key-length-bytes 24 \
--attributes decrypt=true encrypt=true
--share-crypto-users cu2 cu3 cu4 \
--manage-key-quorum-value 4 \
--use-key-quorum-value 2
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000002e06bf",
      "key-info": {
        "key-owners": [
          {
            "username": "cu1",
            "key-coverage": "full"
          }
        ],
        "shared-users": [
          {
            "username": "cu2",
            "key-coverage": "full"
          },
          {
            "username": "cu3",
            "key-coverage": "full"
          },
          {
            "username": "cu4",
            "key-coverage": "full"
          },
        ],
        "key-quorum-values": {
          "manage-key-quorum-value": 4,
          "use-key-quorum-value": 2
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "aes",
        "label": "example-aes",
        "id": "",
        "check-value": "0x9b94bd",
        "class": "secret-key",
        "encrypt": true,
        "decrypt": true,
        "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": 24
      }
    }
  }
}
```

## Argumentos
<a name="key-generate-symmetric-aes-arguments"></a>

**{{<CLUSTER\_ID>}}**  
O ID do cluster em que essa operação será executada.  
Obrigatório: se vários clusters tiverem sido [configurados.](cloudhsm_cli-configs-multi-cluster.md)

**{{<KEY\_ATTRIBUTES>}}**  
Especifica uma lista separada por espaços dos atributos de chave a serem definidos para a chave AES gerada na forma de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` (por exemplo, `sign=true`).  
Para obter uma lista dos atributos de chave compatíveis, consulte [Atributos de chave da CloudHSM CLI](cloudhsm_cli-key-attributes.md).  
Obrigatório: não

**{{<KEY-LENGTH-BYTES>}}**  
Especifica o tamanho da chave em bytes.  

Valores válidos:
+ 16, 24 e 32
Obrigatório: Sim

**{{<LABEL>}}**  
Especifica o rótulo da chave privada definida pelo usuário para a chave AES. O tamanho máximo permitido para `label` é de 127 caracteres no Client SDK 5.11 e versões posteriores. O Client SDK 5.10 e versões anteriores têm um limite de 126 caracteres.  
Obrigatório: Sim

**{{<SESSION>}}**  
Cria uma chave que existe apenas na sessão atual. A chave não pode ser recuperada após o término da sessão.  
Use esse parâmetro quando precisar de uma chave apenas brevemente, como uma chave de encapsulamento que criptografa e, em seguida, descriptografa rapidamente outra chave. Não use uma chave de sessão para criptografar dados que você talvez precise descriptografar após o término da sessão.  
Por padrão, as chaves geradas são chaves persistentes (tokens). Passar <SESSION> muda isso, garantindo que uma chave gerada com esse argumento seja uma chave de sessão (efêmera).  
Obrigatório: não

**{{<SHARE\_CRYPTO\_USERS>}}**  
Especifica uma lista separada por espaços de nomes de usuário dos Usuários de criptografia com os quais compartilhar a chave AES  
Obrigatório: não

**{{<MANAGE\_KEY\_QUORUM\_VALUE>}}**  
O valor do quórum para as operações de gerenciamento da chave. Esse valor deve ser menor que ou igual ao número de usuários ao qual essa chave está associada. Isso inclui os usuários com quem a chave é compartilhada e o proprietário da chave. Valor máximo é 8.  
Obrigatório: não

**{{<USE\_KEY\_QUORUM\_VALUE>}}**  
O valor do quórum para as operações de uso da chave. Esse valor deve ser menor que ou igual ao número de usuários ao qual essa chave está associada. Isso inclui os usuários com quem a chave é compartilhada e o proprietário da chave. Valor máximo é 8.  
Obrigatório: não

## Tópicos relacionados
<a name="key-generate-symmetric-aes-seealso"></a>
+ [Atributos de chave da CloudHSM CLI](cloudhsm_cli-key-attributes.md)
+ [Filtrar chaves usando a CLI do CloudHSM](manage-keys-cloudhsm-cli-filtering.md)