

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á.

# Referência para comandos da CLI do CloudHSM
<a name="cloudhsm_cli-reference"></a>

A CLI do CloudHSM ajuda os administradores a gerenciar usuários em seu cluster. AWS CloudHSM A CLI do CloudHSM pode ser executada em dois modos: modo interativo e modo de comando único. Para começar rapidamente, consulte [Introdução à Interface de Linha de AWS CloudHSM Comando (CLI)](cloudhsm_cli-getting-started.md). 

Para executar a maioria dos comandos da CLI do CloudHSM, você deve iniciar a CLI do CloudHSM e fazer login no HSM. Se você adicionar ou excluir HSMs, atualize os arquivos de configuração do CloudHSM CLI. Caso contrário, as alterações feitas podem não ser efetivas para todos HSMs no cluster.

Os seguintes tópicos descrevem comandos na CLI do CloudHSM: 


| Command | Description | Tipo de usuário | 
| --- | --- | --- | 
| [activate](cloudhsm_cli-cluster-activate.md) | Ativa um cluster CloudHSM e confirma que o cluster é novo. Isso deve ser feito antes que qualquer outra operação possa ser executada. | Administrador desativado | 
| [hsm-info](cloudhsm_cli-cluster-hsm-info.md) | Liste os HSMs em seu cluster. | Tudo [1](#cli-ref-1), incluindo usuários não autenticados. O login não é necessário. | 
| [ecdsa](cloudhsm_cli-crypto-sign-ecdsa.md) | Gera uma assinatura usando uma chave privada EC e o mecanismo de assinatura ECDSA.  | Usuários de criptografia (CU) | 
| [ed25519ph](cloudhsm_cli-crypto-sign-ed25519ph.md) | Gera uma assinatura usando uma chave privada Ed25519 e o mecanismo de assinatura HashEd DSA.  | CU | 
| [rsa-pkcs](cloudhsm_cli-crypto-sign-rsa-pkcs.md) | Gera uma assinatura usando uma chave privada RSA e o mecanismo de assinatura RSA-PKCS. | CU | 
| [rsa-pkcs-pss](cloudhsm_cli-crypto-sign-rsa-pkcs-pss.md) | Gera uma assinatura usando uma chave privada RSA e o mecanismo de RSA-PKCS-PSS assinatura. | CU | 
| [ecdsa](cloudhsm_cli-crypto-verify-ecdsa.md) | Confirma que um arquivo foi assinado no HSM por uma determinada chave pública. Verifica se a assinatura foi gerada usando o mecanismo de assinatura ECDSA. Compara um arquivo assinado com um arquivo de origem e determina se os dois estão criptograficamente relacionados com base em uma determinada chave pública ecdsa e em um mecanismo de assinatura.  | CU | 
| [ed25519ph](cloudhsm_cli-crypto-verify-ed25519ph.md) | Verifica as assinaturas HashEd do DSA usando uma chave pública Ed25519. | CU | 
| [rsa-pkcs](cloudhsm_cli-crypto-verify-rsa-pkcs.md) | Confirma que um arquivo foi assinado no HSM por uma determinada chave pública. Verifica se a assinatura foi gerada usando o mecanismo de assinatura RSA-PKCS. Compara um arquivo assinado com um arquivo de origem e determina se os dois estão criptograficamente relacionados com base em uma determinada chave pública RSA e em um mecanismo de assinatura. | CU | 
| [rsa-pkcs-pss](cloudhsm_cli-crypto-verify-rsa-pkcs-pss.md) | Confirma que um arquivo foi assinado no HSM por uma determinada chave pública. Verifica se a assinatura foi gerada usando o mecanismo de RSA-PKCS-PSS assinatura. Compara um arquivo assinado com um arquivo de origem e determina se os dois estão criptograficamente relacionados com base em uma determinada chave pública RSA e em um mecanismo de assinatura. | CU | 
| [excluir chave](cloudhsm_cli-key-delete.md) | Exclui uma chave do seu AWS CloudHSM cluster. | CU | 
| [key generate-file](cloudhsm_cli-key-generate-file.md) | Gera um arquivo de chave no seu AWS CloudHSM cluster. | CU | 
| [chave generate-asymmetric-pair rsa](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md) | Gera um par de chaves RSA assimétrico em seu cluster. AWS CloudHSM  | CU | 
| [chave, generate-asymmetric-pair etc.](cloudhsm_cli-key-generate-asymmetric-pair-ec.md) | Gera um par de chaves assimétrica de curva elíptica (EC) em seu cluster. AWS CloudHSM  | CU | 
| [key generate-symmetric aes](cloudhsm_cli-key-generate-symmetric-aes.md) | Gera uma chave AES simétrica em seu AWS CloudHSM cluster. | CU | 
| [key generate-symmetric generic-secret](cloudhsm_cli-key-generate-symmetric-generic-secret.md) | Gera uma chave secreta genérica simétrica em seu AWS CloudHSM cluster. | CU | 
| [pem de importação de chaves](cloudhsm_cli-key-import-pem.md) | Importa uma chave no formato PEM para um HSM. Você pode usá-lo para importar chaves públicas que foram geradas fora do HSM. | CU | 
| [lista de chaves](cloudhsm_cli-key-list.md) | Encontra todas as chaves do usuário atual presente no seu AWS CloudHSM cluster. | CU | 
| [replicação de chave](cloudhsm_cli-key-replicate.md) | Replique uma chave de um cluster de origem para um cluster de destino clonado. | CU | 
| [atributo do conjunto de chaves](cloudhsm_cli-key-set-attribute.md) | Define os atributos das chaves no seu AWS CloudHSM cluster. | CUs podem executar esse comando, os administradores podem definir o atributo confiável. | 
| [compartilhamento de chaves](cloudhsm_cli-key-share.md) | Compartilha uma chave com outras CUs pessoas em seu AWS CloudHSM cluster. | CU | 
| [descompartilhar chave](cloudhsm_cli-key-unshare.md) | Cancela o compartilhamento de uma chave com outra CUs em seu AWS CloudHSM cluster. | CU | 
| [aes-gcm](cloudhsm_cli-key-unwrap-aes-gcm.md) | Desencapsula uma chave de carga útil no cluster usando a chave de encapsulamento AES e o mecanismo de desencapsulamento AES-GCM. | CU | 
| [aes-no-pad](cloudhsm_cli-key-unwrap-aes-no-pad.md) | Desempacota uma chave de carga útil no cluster usando a chave de empacotamento AES e o mecanismo de desempacotamento. AES-NO-PAD | CU | 
| [aes-pkcs5-pad](cloudhsm_cli-key-unwrap-aes-pkcs5-pad.md) | Desempacota uma chave de carga útil usando a chave de empacotamento AES e o mecanismo de desempacotamento AES- PKCS5 -PAD. | CU | 
| [aes-zero-pad](cloudhsm_cli-key-unwrap-aes-zero-pad.md) | Desempacota uma chave de carga útil no cluster usando a chave de empacotamento AES e o mecanismo de desempacotamento. AES-ZERO-PAD | CU | 
| [cloudhsm-aes-gcm](cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm.md) | Desempacota uma chave de carga útil no cluster usando a chave de empacotamento AES e o mecanismo de desempacotamento. CLOUDHSM-AES-GCM | CU | 
| [rsa-aes](cloudhsm_cli-key-unwrap-rsa-aes.md) | Desencapsula uma chave de carga útil usando uma chave privada RSA e o mecanismo de desencapsulamento RSA-AES. | CU | 
| [rsa-oaep](cloudhsm_cli-key-unwrap-rsa-oaep.md) | Desencapsula uma chave de carga útil usando a chave privada RSA e o mecanismo de desencapsulamento RSA-OAEP. | CU | 
| [rsa-pkcs](cloudhsm_cli-key-unwrap-rsa-pkcs.md) | Desencapsula uma chave de carga útil usando a chave privada RSA e o mecanismo de desencapsulamento RSA-PKCS. | CU | 
| [aes-gcm](cloudhsm_cli-key-wrap-aes-gcm.md) | Encapsula uma chave de carga útil usando uma chave AES no HSM e o mecanismo de encapsulamento AES-GCM. | CU | 
| [aes-no-pad](cloudhsm_cli-key-wrap-aes-no-pad.md) | Encapsula uma chave de carga útil usando uma chave AES no HSM e o mecanismo de empacotamento AES-NO-PAD. | CU | 
| [aes-pkcs5-pad](cloudhsm_cli-key-wrap-aes-pkcs5-pad.md) | Encapsula uma chave de carga útil usando uma chave AES no HSM e o mecanismo de empacotamento AES- PKCS5 -PAD. | CU | 
| [aes-zero-pad](cloudhsm_cli-key-wrap-aes-zero-pad.md) | Encapsula uma chave de carga útil usando uma chave AES no HSM e o mecanismo de empacotamento AES-ZERO-PAD. | CU | 
| [cloudhsm-aes-gcm](cloudhsm_cli-key-wrap-cloudhsm-aes-gcm.md) | Encapsula uma chave de carga útil usando uma chave AES no HSM e o mecanismo de empacotamento CLOUDHSM-AES-GCM. | CUs | 
| [rsa-aes](cloudhsm_cli-key-wrap-rsa-aes.md) | Encapsula uma chave de carga útil usando uma chave pública RSA no HSM e o mecanismo de encapsulamento RSA-AES. | CU | 
| [rsa-oaep](cloudhsm_cli-key-wrap-rsa-oaep.md) | Encapsula uma chave de carga útil usando uma chave pública RSA no HSM e o mecanismo de encapsulamento RSA-OAEP. | CU | 
| [ Criar uma chave com o RSA-PKCS usando a CloudHSM CLIrsa-pkcs  O comando **key wrap rsa-pkcs** encapsula uma chave de carga útil usando uma chave pública RSA no HSM e o mecanismo de encapsulamento `RSA-PKCS`.   Use o comando **key wrap rsa-pkcs** na CloudHSM CLI para encapsular uma chave de carga útil usando uma chave pública RSA no módulo de segurança de hardware (HSM) e no mecanismo de encapsulamento `RSA-PKCS`. O atributo `extractable` da chave de carga útil deve ser definido como `true`. Somente o proprietário de uma chave, ou seja, o usuário de criptografia que a criou, pode encapsulá-la. Os usuários que compartilham a chave podem usá-la em operações criptográficas. Para usar o **key wrap rsa-pkcs** comando, primeiro você deve ter uma chave RSA em seu AWS CloudHSM cluster. Você pode gerar um par de chaves RSA usando o comando [A generate-asymmetric-pair categoria na CLI do CloudHSM](cloudhsm_cli-key-generate-asymmetric-pair.md) e o atributo `wrap` definido como `true`.  Tipo de usuário  Os seguintes tipos de usuários podem executar este comando.   Usuários de criptomoedas (CUs)     Requisitos    Para executar esse comando, você deve estar registrado(a) como um CU.     Sintaxe  

```
aws-cloudhsm > help key wrap rsa-pkcs
Usage: key wrap rsa-pkcs [OPTIONS] --payload-filter [<PAYLOAD_FILTER>...] --wrapping-filter [<WRAPPING_FILTER>...]

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
      --payload-filter [<PAYLOAD_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 payload key
      --wrapping-filter [<WRAPPING_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 wrapping key
      --path <PATH>
          Path to the binary file where the wrapped key data will be saved
      --wrapping-approval <WRAPPING_APPROVALR>
          File path of signed quorum token file to approve operation for wrapping key
      --payload-approval <PAYLOAD_APPROVALR>
          File path of signed quorum token file to approve operation for payload key
  -h, --help
          Print help
```   Exemplo  Este exemplo mostra como usar o comando **key wrap rsa-pkcs** usando uma chave pública RSA. 

**Example**  

```
aws-cloudhsm > key wrap rsa-pkcs --payload-filter attr.label=payload-key --wrapping-filter attr.label=rsa-public-key-example
{
  "error_code": 0,
  "data": {
    "payload_key_reference": "0x00000000001c08f1",
    "wrapping_key_reference": "0x00000000007008da",
    "wrapped_key_data": "am0Nc7+YE8FWs+5HvU7sIBcXVb24QA0l65nbNAD+1bK+e18BpSfnaI3P+r8Dp+pLu1ofoUy/vtzRjZoCiDofcz4EqCFnGl4GdcJ1/3W/5WRvMatCa2d7cx02swaeZcjKsermPXYRO1lGlfq6NskwMeeTkV8R7Rx9artFrs1y0DdIgIKVaiFHwnBIUMnlQrR2zRmMkfwU1jxMYmOYyD031F5VbnjSrhfMwkww2la7uf/c3XdFJ2+0Bo94c6og/yfPcpOOobJlITCoXhtMRepSdO4OggYq/6nUDuHCtJ86pPGnNahyr7+sAaSI3a5ECQLUjwaIARUCyoRh7EFK3qPXcg=="
  }
```   Argumentos   

***<CLUSTER\$1ID>***  
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) 

***<PAYLOAD\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de carga útil.  
Obrigatório: Sim 

***<PATH>***  
Caminho para o arquivo binário em que os dados da chave encapsulada serão salvos.  
Obrigatório: não 

***<WRAPPING\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de encapsulamento.   
Obrigatório: Sim 

***<WRAPPING\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de encapsulamento. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de encapsulamento for maior do que 1. 

***<PAYLOAD\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de carga útil. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de carga útil for maior do que 1.    Tópicos relacionados    [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)   [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)    ](cloudhsm_cli-key-wrap-rsa-pkcs.md) | Encapsula uma chave de carga útil usando uma chave pública RSA no HSM e o mecanismo de encapsulamento RSA-PKCS. | CU | 
| [login](cloudhsm_cli-login.md) | Faça login no seu AWS CloudHSM cluster. | Administrador, usuário de criptografia (CU) e usuário do dispositivo (AU) | 
| [logout](cloudhsm_cli-logout.md) | Saia do seu AWS CloudHSM cluster. | Administrador, CU e usuário do dispositivo (AU) | 
| [quorum token-sign delete](cloudhsm_cli-qm-token-del.md) | Exclui um ou mais tokens de um serviço autorizado por quórum. | Administrador | 
| [quorum token-sign generate](cloudhsm_cli-qm-token-gen.md) | Gera um token para um serviço autorizado por quórum. | Administrador | 
| [quorum token-sign list](cloudhsm_cli-qm-token-list.md) | Lista todos os tokens de quórum de assinatura de token presentes no seu cluster do CloudHSM. | Tudo [1](#cli-ref-1), incluindo usuários não autenticados. O login não é necessário. | 
| [sinal simbólico de quórum list-quorum-values](cloudhsm_cli-qm-token-list-qm.md) | Lista os valores de quorum definidos no seu cluster CloudHSM. | Tudo [1](#cli-ref-1), incluindo usuários não autenticados. O login não é necessário. | 
| [sinal simbólico de quórum set-quorum-value](cloudhsm_cli-qm-token-set-qm.md) | Define um novo valor de quórum para um serviço autorizado por quórum. | Administrador | 
| [user change-mfa](cloudhsm_cli-user-change-mfa.md) | Altera a estratégia de autenticação multifator (MFA) do usuário. | Administrador, CU | 
| [alterar senha de usuário](cloudhsm_cli-user-change-password.md) | Altera as senhas dos usuários no HSMs. Qualquer usuário pode alterar sua própria senha. Os administradores podem mudar a senha de qualquer pessoa. | Administrador, CU | 
| [criar usuário](cloudhsm_cli-user-create.md) | Cria um usuário no seu AWS CloudHSM cluster. | Administrador | 
| [excluir usuário](cloudhsm_cli-user-delete.md) | Exclui um usuário no seu AWS CloudHSM cluster. | Administrador | 
| [ista de usuários](cloudhsm_cli-user-list.md) | Lista os usuários em seu AWS CloudHSM cluster. | Tudo [1](#cli-ref-1), incluindo usuários não autenticados. O login não é necessário. | 
| [user change-quorum token-sign register](cloudhsm_cli-user-chqm-token-reg.md) | Registra a estratégia de quórum de assinatura de token de quórum para um usuário. | Administrador | 

**Anotações**
+ [1] Todos os usuários incluem todas as funções listadas e usuários não logados.

# A categoria cluster na CLI do CloudHSM
<a name="cloudhsm_cli-cluster"></a>

Na CLI do CloudHSM, **cluster** é uma categoria principal para um grupo de comandos que, quando combinado com a categoria principal, cria um comando específico para clusters. Atualmente, a categoria cluster consiste nos seguintes comandos:

**Topics**
+ [activate](cloudhsm_cli-cluster-activate.md)
+ [hsm-info](cloudhsm_cli-cluster-hsm-info.md)
+ [mtls](cloudhsm_cli-cluster-mtls.md)

# Ativar um cluster com a CLI do CloudHSM
<a name="cloudhsm_cli-cluster-activate"></a>

Use o comando **cluster activate** na CLI do CloudHSM para [ativar um novo cluster](activate-cluster.md) no AWS CloudHSM. Esse comando deve ser executado para que o cluster possa ser usado para executar operações criptográficas.

## Tipo de usuário
<a name="cluster-activate-userType"></a>

Os seguintes tipos de usuários podem executar este comando.
+ Administrador desativado

## Sintaxe
<a name="chsm-cli-cluster-activate-syntax"></a>

Este comando não possui parâmetros.

```
aws-cloudhsm > help cluster activate
Activate a cluster

This command will set the initial Admin password. This process will cause your CloudHSM cluster to
move into the ACTIVE state.

USAGE:
    cloudhsm-cli cluster activate [OPTIONS] [--password <PASSWORD>]

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

      --password <PASSWORD>
          Optional: Plaintext activation password If you do not include this argument you will be prompted for it

  -h, --help
          Print help (see a summary with '-h')
```

## Exemplo
<a name="chsm-cli-cluster-activate-examples"></a>

Esse comando ativa seu cluster definindo a senha inicial para seu usuário administrador.

```
aws-cloudhsm > cluster activate
Enter password:
Confirm password:
{
  "error_code": 0,
  "data": "Cluster activation successful"
}
```

## Tópicos relacionados
<a name="chsm-cluster-activate-seealso"></a>
+ [criar usuário](cloudhsm_cli-user-create.md)
+ [excluir usuário](cloudhsm_cli-user-delete.md)
+ [alterar senha de usuário](cloudhsm_cli-user-change-password.md)

# Lista HSMs com a CLI do CloudHSM
<a name="cloudhsm_cli-cluster-hsm-info"></a>

Use o **cluster hsm-info** comando na CLI do CloudHSM para listar os HSMs módulos de segurança de hardware () em seu cluster. AWS CloudHSM Você não precisa estar conectado na CLI do CloudHSM para executar esse comando.

**nota**  
Se você adicionar ou excluir HSMs, atualize os arquivos de configuração que o AWS CloudHSM cliente e as ferramentas de linha de comando usam. Caso contrário, as alterações feitas podem não ser efetivas HSMs em todas as partes do cluster.

## Tipo de usuário
<a name="chsm-cluster-hsm-info-userType"></a>

Os seguintes tipos de usuários podem executar este comando.
+ Todos os usuários. Você não precisa estar conectado para executar esse comando.

## Sintaxe
<a name="chsm-cluster-hsm-info-syntax"></a>

```
aws-cloudhsm > help cluster hsm-info
List info about each HSM in the cluster

Usage: cloudhsm-cli cluster hsm-info [OPTIONS]

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
  -h, --help                     Print help
```

## Exemplo
<a name="chsm-cluster-hsm-info-examples"></a>

Esse comando lista o HSMs presente em seu AWS CloudHSM cluster.

```
aws-cloudhsm > cluster hsm-info
{
  "error_code": 0,
  "data": {
    "hsms": [
      {
        "vendor": "Marvell Semiconductors, Inc.",
        "model": "NITROX-III CNN35XX-NFBE",
        "serial-number": "5.3G1941-ICM000590",
        "hardware-version-major": "5",
        "hardware-version-minor": "3",
        "firmware-version-major": "2",
        "firmware-version-minor": "6",
        "firmware-build-number": "16",
        "firmware-id": "CNN35XX-NFBE-FW-2.06-16"
        "fips-state": "2 [FIPS mode with single factor authentication]"
      },
      {
        "vendor": "Marvell Semiconductors, Inc.",
        "model": "NITROX-III CNN35XX-NFBE",
        "serial-number": "5.3G1941-ICM000625",
        "hardware-version-major": "5",
        "hardware-version-minor": "3",
        "firmware-version-major": "2",
        "firmware-version-minor": "6",
        "firmware-build-number": "16",
        "firmware-id": "CNN35XX-NFBE-FW-2.06-16"
        "fips-state": "2 [FIPS mode with single factor authentication]"
      },
      {
        "vendor": "Marvell Semiconductors, Inc.",
        "model": "NITROX-III CNN35XX-NFBE",
        "serial-number": "5.3G1941-ICM000663",
        "hardware-version-major": "5",
        "hardware-version-minor": "3",
        "firmware-version-major": "2",
        "firmware-version-minor": "6",
        "firmware-build-number": "16",
        "firmware-id": "CNN35XX-NFBE-FW-2.06-16"
        "fips-state": "2 [FIPS mode with single factor authentication]"
      }
    ]
  }
}
```

O objeto tem os seguintes atributos:
+ **Fornecedor**: o nome do fornecedor do HSM. 
+ **Modelo**: o número do modelo do HSM.
+ **Número de série**: o número de série do dispositivo. Isso pode mudar devido a substituições.
+ **H ardware-version-major**: A versão principal do hardware.
+ **H ardware-version-minor**: A versão secundária do hardware.
+ **F irmware-version-major**: A versão principal do firmware.
+ **F irmware-version-minor**: A versão secundária do firmware.
+ **F irmware-build-number**: O número de compilação do firmware.
+ **Firmware-id**: o ID do firmware, que inclui as versões principais e secundárias junto com a compilação.
+ **Estado FIPS**: o modo FIPS do cluster e o que está nele. HSMs Se estiver no modo FIPS, a saída será “2 [FIPS mode with single factor authentication]”. Se estiver no modo não FIPS, a saída será “0 [non-FIPS mode with single factor authentication]”.

## Tópicos relacionados
<a name="chsm-cluster-hsm-info-seealso"></a>
+ [Ativar um cluster com a CLI do CloudHSM](cloudhsm_cli-cluster-activate.md)

# A categoria cluster mtls na CLI do CloudHSM
<a name="cloudhsm_cli-cluster-mtls"></a>

Na **cluster mtls** CLI do CloudHSM, é uma categoria principal para um grupo de comandos que, quando combinados com a categoria principal, criam um comando específico para clusters. AWS CloudHSM Atualmente, essa categoria consiste nos seguintes comandos:

**Topics**
+ [deregister-trust-anchor](cloudhsm_cli-cluster-mtls-deregister-trust-anchor.md)
+ [get-enforcement](cloudhsm_cli-cluster-mtls-get-enforcement.md)
+ [list-trust-anchors](cloudhsm_cli-cluster-mtls-list-trust-anchors.md)
+ [register-trust-anchor](cloudhsm_cli-cluster-mtls-register-trust-anchor.md)
+ [set-enforcement](cloudhsm_cli-cluster-mtls-set-enforcement.md)

# Cancelar o registro de uma âncora de confiança com a CLI do CloudHSM
<a name="cloudhsm_cli-cluster-mtls-deregister-trust-anchor"></a>

Use o comando **cluster mtls deregister-trust-anchor** na CLI do CloudHSM para cancelar o registro de uma âncora de confiança para TLS mútuo entre o cliente e o AWS CloudHSM.

## Tipo de usuário
<a name="cluster-mtls-deregister-trust-anchor-userType"></a>

Os usuários a seguir podem executar este comando.
+ Administrador

## Requisitos
<a name="cluster-mtls-deregister-trust-anchor-requirements"></a>
+ Para executar esse comando, é necessário se conectar como usuário administrador.

## Sintaxe
<a name="cluster-mtls-deregister-trust-anchor-syntax"></a>

```
aws-cloudhsm > help cluster mtls deregister-trust-anchor
            
Deregister a trust anchor for mtls

Usage: cluster mtls deregister-trust-anchor [OPTIONS] --certificate-reference [<CERTIFICATE_REFERENCE>...]

Options:
      --certificate-reference <CERTIFICATE_REFERENCE>  A hexadecimal or decimal certificate reference
      --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
      --approval <APPROVAL>  Filepath of signed quorum token file to approve operation
  -h, --help                     Print help
```

## Exemplo
<a name="cluster-mtls-deregister-trust-anchor-examples"></a>

**Example**  
No exemplo a seguir, esse comando remove uma âncora de confiança do HSM.  

```
aws-cloudhsm > cluster mtls deregister-trust-anchor --certificate-reference 0x01
                
{
  "error_code": 0,
  "data": {
    "message": "Trust anchor with reference 0x01 deregistered successfully"
  }
}
```
Em seguida, você pode executar o comando **list-trust-anchors** para confirmar que o registro da âncora de confiança foi cancelado do AWS CloudHSM:  

```
aws-cloudhsm > cluster mtls list-trust-anchors
                
{
  "error_code": 0,
  "data": {
    "trust_anchors": []
  }
}
```

## Argumentos
<a name="cluster-mtls-deregister-trust-anchor-arguments"></a>

***<CLUSTER\$1ID>***  
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)

** *<CERTIFICATE\$1REFERENCE>* **  
Uma referência de certificado hexadecimal ou decimal.  
 **Obrigatório**: sim  
Depois de cancelar o registro de uma âncora de confiança no cluster, todas as conexões mTLS existentes usando o certificado do cliente assinado por essa âncora de confiança serão descartadas.

** *<APPROVAL>* **  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de cluster for maior que 1.

## Tópicos relacionados
<a name="cluster-mtls-deregister-trust-anchor-seealso"></a>
+  [cluster mtls reregister-trust-anchor](cloudhsm_cli-cluster-mtls-register-trust-anchor.md) 
+  [cluster mtls list-trust-anchors](cloudhsm_cli-cluster-mtls-list-trust-anchors.md) 
+  [Configurar mTLS (recomendado)](getting-started-setup-mtls.md) 

# Obter o nível de imposição do mTLS com a CloudHSM CLI
<a name="cloudhsm_cli-cluster-mtls-get-enforcement"></a>

Use o comando **cluster mtls get-enforcement** na CloudHSM CLI para obter o nível de imposição do uso do TLS mútuo entre o cliente e o AWS CloudHSM.

## Tipo de usuário
<a name="cluster-mtls-get-enforcement-userType"></a>

Os usuários a seguir podem executar este comando.
+ Administrador
+ Usuários de criptomoedas (CUs)

## Requisitos
<a name="cluster-mtls-get-enforcement-requirements"></a>
+ Para executar esse comando, você deve estar logado como usuário administrador ou usuário criptográfico (CUs).

## Sintaxe
<a name="cluster-mtls-get-enforcement-syntax"></a>

```
aws-cloudhsm > help cluster mtls get-enforcement
            
Get the status of mtls enforcement in the cluster

Usage: cluster mtls get-enforcement [OPTIONS]

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
  -h, --help                     Print help
```

## Exemplo
<a name="cluster-mtls-get-enforcement-examples"></a>

**Example**  
No exemplo a seguir, esse comando lista o nível de imposição do mtls do AWS CloudHSM.  

```
aws-cloudhsm > cluster mtls get-enforcement
                
{
  "error_code": 0,
  "data": {
    "mtls-enforcement-level": "none"
  }
}
```

## Argumentos
<a name="cluster-mtls-get-enforcement-arguments"></a>

***<CLUSTER\$1ID>***  
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)

## Tópicos relacionados
<a name="cluster-mtls-get-enforcement-seealso"></a>
+  [cluster mtls set-enforcement](cloudhsm_cli-cluster-mtls-set-enforcement.md) 
+  [Configurar mTLS (recomendado)](getting-started-setup-mtls.md) 

# Listar âncoras de confiança com o CloudHSM CLI
<a name="cloudhsm_cli-cluster-mtls-list-trust-anchors"></a>

Use o comando **cluster mtls list-trust-anchors** na CloudHSM CLI para listar todas as âncoras de confiança que podem ser usadas para TLS mútuo entre o cliente e o AWS CloudHSM.

## Tipo de usuário
<a name="cluster-mtls-list-trust-anchors-userType"></a>

Os usuários a seguir podem executar este comando.
+ Todos os usuários. Você não precisa estar conectado para executar esse comando.

## Sintaxe
<a name="cluster-mtls-list-trust-anchors-syntax"></a>

```
aws-cloudhsm > help cluster mtls list-trust-anchors
            
List all trust anchors for mtls

Usage: cluster mtls list-trust-anchors [OPTIONS]

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
  -h, --help                     Print help
```

## Exemplo
<a name="cluster-mtls-list-trust-anchors-examples"></a>

**Example**  
No exemplo a seguir, esse comando lista todas as âncoras de confiança registradas do AWS CloudHSM.  

```
aws-cloudhsm > cluster mtls list-trust-anchors
                
{
  "error_code": 0,
  "data": {
    "trust_anchors": [
      {
        "certificate-reference": "0x01",
        "certificate": "<PEM Encoded Certificate 1>",
        "cluster-coverage": "full"
      },
      {
        "certificate-reference": "0x02",
        "certificate": "<PEM Encoded Certificate 2>",
        "cluster-coverage": "full"
      }
    ]
  }
}
```

## Argumentos
<a name="cluster-mtls-list-trust-anchors-arguments"></a>

***<CLUSTER\$1ID>***  
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)

## Tópicos relacionados
<a name="cluster-mtls-register-trust-anchor-seealso"></a>
+  [cluster mtls reregister-trust-anchor](cloudhsm_cli-cluster-mtls-register-trust-anchor.md) 
+  [cluster mtls deregister-trust-anchor](cloudhsm_cli-cluster-mtls-deregister-trust-anchor.md) 
+  [Configurar mTLS (recomendado)](getting-started-setup-mtls.md) 

# Registrar uma âncora de confiança com a CLI do CloudHSM
<a name="cloudhsm_cli-cluster-mtls-register-trust-anchor"></a>

Use o comando **cluster mtls register-trust-anchor** na CLI do CloudHSM para registrar uma âncora de confiança para TLS mútuo entre o cliente e o AWS CloudHSM.

## Tipo de usuário
<a name="cluster-mtls-register-trust-anchor-userType"></a>

Os usuários a seguir podem executar este comando.
+ Administrador

## Requisitos
<a name="cluster-mtls-register-trust-anchor-requirements"></a>

 AWS CloudHSM Aceita âncoras de confiança com os seguintes tipos de chave:


****  

| Tipo de chave | Description | 
| --- | --- | 
| EC |  Curvas secp256r1 (P-256), secp384r1 (P-384) e secp521r1 (P-521).  | 
| RSA |  Chaves RSA de 2.048 bits, 3.072 bits e 4.096 bits.  | 

## Sintaxe
<a name="cluster-mtls-register-trust-anchor-syntax"></a>

```
aws-cloudhsm > help cluster mtls register-trust-anchor
            
Register a trust anchor for mtls

Usage: cluster mtls register-trust-anchor [OPTIONS] --path [<PATH>...]

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
      --path <PATH>  Filepath of the trust anchor to register
      --approval <APPROVAL>  Filepath of signed quorum token file to approve operation
  -h, --help                     Print help
```

## Exemplo
<a name="cluster-mtls-register-trust-anchor-examples"></a>

**Example**  
No exemplo a seguir, esse comando registra uma âncora de confiança no HSM. No máximo 2 (duas) âncoras de confiança podem ser registradas.  

```
aws-cloudhsm > cluster mtls register-trust-anchor --path /home/rootCA
                
{
  "error_code": 0,
  "data": {
    "trust_anchor": {
      "certificate-reference": "0x01",
      "certificate": "<PEM Encoded Certificate>",
      "cluster-coverage": "full"
    }
  }
}
```
Em seguida, você pode executar o comando **list-trust-anchors** para confirmar que a âncora de confiança foi registrada no AWS CloudHSM:  

```
aws-cloudhsm > cluster mtls list-trust-anchors
                
{
  "error_code": 0,
  "data": {
    "trust_anchors": [
      {
        "certificate-reference": "0x01",
        "certificate": "<PEM Encoded Certificate>",
        "cluster-coverage": "full"
      }
    ]
  }
}
```

## Argumentos
<a name="cluster-mtls-register-trust-anchor-arguments"></a>

***<CLUSTER\$1ID>***  
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)

** *<PATH>* **  
O caminho da âncora de confiança a ser registrada.  
 **Obrigatório**: sim  
AWS CloudHSM suporta o registro de certificados intermediários como âncora confiável. Nesses casos, todo o arquivo da cadeia de certificados codificado pelo PEM precisa ser registrado no HSM, com os certificados em ordem hierárquica.   
 AWS CloudHSM suporta uma cadeia de certificados de 6980 bytes.

** *<APPROVAL>* **  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de cluster for maior que 1.

## Tópicos relacionados
<a name="cluster-mtls-register-trust-anchor-seealso"></a>
+  [cluster mtls deregister-trust-anchor](cloudhsm_cli-cluster-mtls-deregister-trust-anchor.md) 
+  [cluster mtls list-trust-anchors](cloudhsm_cli-cluster-mtls-list-trust-anchors.md) 
+  [Configurar mTLS (recomendado)](getting-started-setup-mtls.md) 

# Definir o nível de imposição do mTLS com a CloudHSM CLI
<a name="cloudhsm_cli-cluster-mtls-set-enforcement"></a>

Use o comando **cluster mtls set-enforcement** na CloudHSM CLI para definir o nível de imposição do uso do TLS mútuo entre o cliente e o AWS CloudHSM.

## Tipo de usuário
<a name="cluster-mtls-set-enforcement-userType"></a>

Os usuários a seguir podem executar este comando.
+ Administrador com nome de usuário “admin”

## Requisitos
<a name="cluster-mtls-set-enforcement-requirements"></a>

Para executar esse comando:
+ Pelo menos uma âncora de confiança foi registrada com êxito no AWS CloudHSM.
+ Configure a CloudHSM CLI com a chave privada e o certificado de cliente corretos e inicie a CloudHSM CLI em uma conexão TLS mútua.
+ Você deve fazer login como administrador padrão com o nome de usuário “admin”. Nenhum outro usuário administrador poderá executar esse comando.

## Sintaxe
<a name="cluster-mtls-set-enforcement-syntax"></a>

```
aws-cloudhsm > help cluster mtls set-enforcement
            
Set mtls enforcement policy in the cluster

Usage: cluster mtls set-enforcement [OPTIONS] --level [<LEVEL>...]

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
      --level <LEVEL>  Level to be set for mtls in the cluster [possible values: none, cluster]
      --approval <APPROVAL>  Filepath of signed quorum token file to approve operation
  -h, --help                     Print help
```

## Exemplo
<a name="cluster-mtls-set-enforcement-examples"></a>

**Example**  
No exemplo a seguir, esse comando define o nível de imposição mtls do cluster AWS CloudHSM a ser. O comando set-enforcement só pode ser executado em uma conexão TLS mútua estabelecida como usuário administrador com nome de usuário “admin”; consulte [definir a imposição do mTLS para AWS CloudHSM](getting-started-setup-mtls.md#getting-start-setup-mtls-enforcement).  

```
aws-cloudhsm > cluster mtls set-enforcement --level cluster
                
{
  "error_code": 0,
  "data": {
    "message": "Mtls enforcement level set to Cluster successfully"
  }
}
```
Em seguida, você pode executar o comando **get-enforcement** para confirmar se o nível de imposição foi definido como cluster:  

```
aws-cloudhsm > cluster mtls get-enforcement
                
{
  "error_code": 0,
  "data": {
    "mtls-enforcement-level": "cluster"
  }
}
```

## Argumentos
<a name="cluster-mtls-set-enforcement-arguments"></a>

***<CLUSTER\$1ID>***  
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)

** *<LEVEL>* **  
Nível a ser definido para mtls no cluster.   
 **Valores válidos**   
+  **cluster**: imponha o uso de TLS mútuo entre o cliente e AWS CloudHSM no cluster.
+  **none**: não imponha o uso de TLS mútuo entre o cliente e AWS CloudHSM no cluster.
 **Obrigatório**: sim  
Depois de impor o uso de mTLS no cluster, todas as conexões não MTLS existentes serão descartadas e a conexão com o cluster será possível apenas com certificados mTLS.

** *<APPROVAL>* **  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de cluster for maior que 1.

## Tópicos relacionados
<a name="cluster-mtls-set-enforcement-seealso"></a>
+  [cluster mtls get-enforcement](cloudhsm_cli-cluster-mtls-get-enforcement.md) 
+  [Configurar mTLS (recomendado)](getting-started-setup-mtls.md) 

# A categoria crypto na CLI do CloudHSM
<a name="cloudhsm_cli-crypto"></a>

Na CLI do CloudHSM, **crypto** é uma categoria principal para um grupo de comandos que, quando combinado com a categoria principal, cria um comando específico para operações criptográficas. Atualmente, essa categoria consiste nos seguintes comandos: 
+ [sign](cloudhsm_cli-crypto-sign.md)
  + [ecdsa](cloudhsm_cli-crypto-sign-ecdsa.md)
  + [ed25519ph](cloudhsm_cli-crypto-sign-ed25519ph.md)
  + [rsa-pkcs](cloudhsm_cli-crypto-sign-rsa-pkcs.md)
  + [rsa-pkcs-pss](cloudhsm_cli-crypto-sign-rsa-pkcs-pss.md)
+ [verificar](cloudhsm_cli-crypto-verify.md)
  + [ecdsa](cloudhsm_cli-crypto-verify-ecdsa.md)
  + [ed25519ph](cloudhsm_cli-crypto-verify-ed25519ph.md)
  + [rsa-pkcs](cloudhsm_cli-crypto-verify-rsa-pkcs.md)
  + [rsa-pkcs-pss](cloudhsm_cli-crypto-verify-rsa-pkcs-pss.md)

# A categoria de assinatura criptográfica na CLI do CloudHSM
<a name="cloudhsm_cli-crypto-sign"></a>

Na CLI do CloudHSM, **crypto sign** é uma categoria principal de um grupo de comandos que, quando combinados com a categoria principal, usam uma chave privada escolhida no seu cluster do AWS CloudHSM para gerar uma assinatura. O comando **crypto sign** tem os seguintes subcomandos:
+ [Gerar uma assinatura com o mecanismo ECDSA na CloudHSM CLI](cloudhsm_cli-crypto-sign-ecdsa.md)
+ [Gere uma assinatura com o mecanismo HashEd DSA na CLI do CloudHSM](cloudhsm_cli-crypto-sign-ed25519ph.md)
+ [Gerar uma assinatura com o mecanismo RSA-PKCS na CloudHSM CLI](cloudhsm_cli-crypto-sign-rsa-pkcs.md)
+ [Gere uma assinatura com o RSA-PKCS-PSS mecanismo na CLI do CloudHSM](cloudhsm_cli-crypto-sign-rsa-pkcs-pss.md)

Para usar o **crypto sign**, primeiro você deve ter uma chave privada no HSM. Você pode gerar uma chave privada com os seguintes comandos:
+ [chave, generate-asymmetric-pair etc.](cloudhsm_cli-key-generate-asymmetric-pair-ec.md)
+ [chave generate-asymmetric-pair rsa](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md)

# Gerar uma assinatura com o mecanismo ECDSA na CloudHSM CLI
<a name="cloudhsm_cli-crypto-sign-ecdsa"></a>

Use o comando **crypto sign ecdsa** na CloudHSM CLI para gerar uma assinatura usando uma chave privada EC e o mecanismo de assinatura ECDSA. 

Para usar o **crypto sign ecdsa** comando, primeiro você deve ter uma chave privada EC em seu AWS CloudHSM cluster. Você pode gerar uma chave privada EC usando o comando [Gerar um par de chaves EC assimétricas com a CloudHSM CLI](cloudhsm_cli-key-generate-asymmetric-pair-ec.md) com o atributo `sign` definido como `true`.

A assinatura ECDSA resultante é gerada no formato`r||s`, em que os componentes r e s são concatenados como dados binários brutos e retornados no formato codificado em base64.

**nota**  
As assinaturas podem ser verificadas AWS CloudHSM com [A categoria de verificação de criptografia na CLI do CloudHSM](cloudhsm_cli-crypto-verify.md) subcomandos.

## Tipo de usuário
<a name="cloudhsm_cli-crypto-sign-ecdsa-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-crypto-sign-ecdsa-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-crypto-sign-ecdsa-syntax"></a>

```
aws-cloudhsm > help crypto sign ecdsa
Sign with the ECDSA mechanism

Usage: crypto sign ecdsa --key-filter [<KEY_FILTER>>...] --hash-function <HASH_FUNCTION> <--data-path <DATA_PATH>|--data <DATA>>

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
      --key-filter [<KEY_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
      --hash-function <HASH_FUNCTION>
          [possible values: sha1, sha224, sha256, sha384, sha512]
      --data-path <DATA_PATH>
          The path to the file containing the data to be signed
      --data <DATA>
          Base64 Encoded data to be signed
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
      --data-type <DATA_TYPE>
          The type of data passed in, either raw or digest [possible values: raw, digest]
  -h, --help
          Print help
```

## Exemplo
<a name="cloudhsm_cli-crypto-sign-ecdsa-examples"></a>

Esses exemplos mostram como usar o **crypto sign ecdsa** para gerar uma assinatura usando o mecanismo de assinatura ECDSA e a função hash `SHA256`. Esse comando usa uma chave privada no HSM.

**Example Exemplo: gerar uma assinatura para dados codificados em base 64**  

```
aws-cloudhsm > crypto sign ecdsa --key-filter attr.label=ec-private --hash-function sha256 --data YWJjMTIz
{
  "error_code": 0,
  "data": {
    "key-reference": "0x00000000007808dd",
    "signature": "4zki+FzjhP7Z/KqoQvh4ueMAxQQVp7FQguZ2wOS3Q5bzk+Hc5irV5iTkuxQbropPttVFZ8V6FgR2fz+sPegwCw=="
  }
}
```

**Example Exemplo: gerar uma assinatura para um arquivo de dados**  

```
aws-cloudhsm > crypto sign ecdsa --key-filter attr.label=ec-private --hash-function sha256 --data-path data.txt
{
  "error_code": 0,
  "data": {
    "key-reference": "0x00000000007808dd",
    "signature": "4zki+FzjhP7Z/KqoQvh4ueMAxQQVp7FQguZ2wOS3Q5bzk+Hc5irV5iTkuxQbropPttVFZ8V6FgR2fz+sPegwCw=="
  }
}
```

## Argumentos
<a name="cloudhsm_cli-crypto-sign-ecdsa-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<DATA>***  
Dados codificados em Base64 a serem assinados.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<DATA\$1PATH>***  
Especifica o local dos dados a serem assinados.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<HASH\$1FUNCTION>***  
Especifica a função hash.   
Valores válidos:  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
Obrigatório: Sim

***<KEY\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de attr.KEY\$1ATTRIBUTE\$1NAME=KEY\$1ATTRIBUTE\$1VALUE para selecionar uma chave correspondente.  
Para obter uma lista dos atributos de chave compatíveis com a CloudHSM CLI, consulte Atributos de chave da CloudHSM CLI.  
Obrigatório: Sim

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de uso da chave privada for maior que 1.

***<DATA\$1TYPE>***  
 Especifica se o valor do parâmetro de dados deve ser criptografado com hash como parte do algoritmo de assinatura. Use `raw` para dados sem hash; use `digest` para resumos, que já estão criptografados com hash.   
Valores válidos:  
+ bruto
+ resumo

## Tópicos relacionados
<a name="cloudhsm_cli-crypto-sign-ecdsa-seealso"></a>
+ [A categoria de assinatura criptográfica na CLI do CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [A categoria de verificação de criptografia na CLI do CloudHSM](cloudhsm_cli-crypto-verify.md)

# Gere uma assinatura com o mecanismo HashEd DSA na CLI do CloudHSM
<a name="cloudhsm_cli-crypto-sign-ed25519ph"></a>

**Importante**  
HashEdAs operações de assinatura de DSA só são suportadas em instâncias hsm2m.medium no modo não FIPS.

Use o **crypto sign ed25519ph** comando na CLI do CloudHSM para gerar uma assinatura usando uma chave privada Ed25519 e o mecanismo de assinatura do DSA. HashEd Para obter informações adicionais sobre o HashEd DSA, consulte [NIST SP 186-5](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-5.pdf), Seção 7.8.

Para usar o **crypto sign ed25519ph** comando, primeiro você deve ter uma chave privada Ed25519 em seu cluster. AWS CloudHSM Você pode gerar uma chave privada Ed25519 usando o [Gerar um par de chaves EC assimétricas com a CloudHSM CLI](cloudhsm_cli-key-generate-asymmetric-pair-ec.md) comando com o `curve` parâmetro definido como `ed25519` e o `sign` atributo definido como. `true`

**nota**  
As assinaturas podem ser verificadas AWS CloudHSM com [A categoria de verificação de criptografia na CLI do CloudHSM](cloudhsm_cli-crypto-verify.md) subcomandos.

## Tipo de usuário
<a name="cloudhsm_cli-crypto-sign-ed25519ph-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-crypto-sign-ed25519ph-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.
+ HashEdAs operações de assinatura de DSA só são suportadas em instâncias hsm2m.medium no modo não FIPS.

## Sintaxe
<a name="cloudhsm_cli-crypto-sign-ed25519ph-syntax"></a>

```
aws-cloudhsm > help crypto sign ed25519ph
Sign with the Ed25519ph mechanism

Usage: crypto sign ed25519ph [OPTIONS] --key-filter [<KEY_FILTER>...] --data-type <DATA_TYPE> --hash-function <HASH_FUNCTION> <--data-path <DATA_PATH>|--data <DATA>>

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
      --key-filter [<KEY_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
      --data-path <DATA_PATH>
          The path to the file containing the data to be signed
      --data <DATA>
          Base64 Encoded data to be signed
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
      --data-type <DATA_TYPE>
          The type of data passed in, either raw or digest [possible values: raw, digest]
      --hash-function <HASH_FUNCTION>
          Hash function [possible values: sha512]
  -h, --help
          Print help
```

## Exemplo
<a name="cloudhsm_cli-crypto-sign-ed25519ph-examples"></a>

Esses exemplos mostram como usar **crypto sign ed25519ph** para gerar uma assinatura usando o mecanismo de assinatura ED25519ph e a função hash. `sha512` Esse comando usa uma chave privada no HSM.

**Example Exemplo: gerar uma assinatura para dados codificados em base 64**  

```
aws-cloudhsm > crypto sign ed25519ph \
    --key-filter attr.label=ed25519-private \
    --data-type raw \
    --hash-function sha512 \
    --data YWJj
{
  "error_code": 0,
  "data": {
    "key-reference": "0x0000000000401cdf",
    "signature": "mKcCIvC4Ehqp0w+BPWg/gJ5GK0acf/h2OUmbuU5trkEx+FBCRjwqNVogA9BirfWqoQuMYeY2Biqq0RwqJgg0Bg=="
  }
}
```

**Example Exemplo: gerar uma assinatura para um arquivo de dados**  

```
aws-cloudhsm > crypto sign ed25519ph \
    --key-filter attr.label=ed25519-private \
    --data-type raw \
    --hash-function sha512 \
    --data-path data.txt
{
  "error_code": 0,
  "data": {
    "key-reference": "0x0000000000401cdf",
    "signature": "mKcCIvC4Ehqp0w+BPWg/gJ5GK0acf/h2OUmbuU5trkEx+FBCRjwqNVogA9BirfWqoQuMYeY2Biqq0RwqJgg0Bg=="
  }
}
```

## Argumentos
<a name="cloudhsm_cli-crypto-sign-ed25519ph-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<DATA>***  
Dados codificados em Base64 a serem assinados.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<DATA\$1PATH>***  
Especifica o local dos dados a serem assinados.  
Obrigatório: Sim (a menos que seja fornecido por meio do parâmetro de dados)

***<HASH\$1FUNCTION>***  
Especifica a função hash. O ED25519ph suporta apenas. SHA512   
Valores válidos:  
+ sha512
Obrigatório: Sim

***<KEY\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de attr.KEY\$1ATTRIBUTE\$1NAME=KEY\$1ATTRIBUTE\$1VALUE para selecionar uma chave correspondente.  
Para obter uma lista dos principais atributos da CLI do CloudHSM compatíveis, consulte. [Atributos de chave da CloudHSM CLI](cloudhsm_cli-key-attributes.md)  
Obrigatório: Sim

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de uso da chave privada for maior que 1.

***<DATA\$1TYPE>***  
 Especifica se o valor do parâmetro de dados deve ser criptografado com hash como parte do algoritmo de assinatura. Use `raw` para dados sem hash; use `digest` para resumos, que já estão criptografados com hash.   
Valores válidos:  
+ bruto
+ resumo
Obrigatório: Sim

## Tópicos relacionados
<a name="cloudhsm_cli-crypto-sign-ed25519ph-seealso"></a>
+ [A categoria de assinatura criptográfica na CLI do CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [A categoria de verificação de criptografia na CLI do CloudHSM](cloudhsm_cli-crypto-verify.md)

# Gerar uma assinatura com o mecanismo RSA-PKCS na CloudHSM CLI
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs"></a>

Use o comando **crypto sign rsa-pkcs** na CloudHSM CLI para gerar uma assinatura usando uma chave privada RSA e o mecanismo de assinatura RSA-PKCS.

Para usar o **crypto sign rsa-pkcs** comando, primeiro você deve ter uma chave privada RSA em seu AWS CloudHSM cluster. Você pode gerar uma chave privada RSA usando o comando [Gerar um par de chaves assimétricas RSA com a CloudHSM CLI](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md) com o atributo `sign` definido como `true`.

**nota**  
As assinaturas podem ser verificadas AWS CloudHSM com [A categoria de verificação de criptografia na CLI do CloudHSM](cloudhsm_cli-crypto-verify.md) subcomandos.

## Tipo de usuário
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-syntax"></a>

```
aws-cloudhsm > help crypto sign rsa-pkcs
Sign with the RSA-PKCS mechanism

Usage: crypto sign rsa-pkcs --key-filter [<KEY_FILTER>>...] --hash-function <HASH_FUNCTION> <--data-path <DATA_PATH>|--data <DATA>>

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
      --key-filter [<KEY_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
      --hash-function <HASH_FUNCTION>
          [possible values: sha1, sha224, sha256, sha384, sha512]
      --data-path <DATA_PATH>
          The path to the file containing the data to be signed
      --data <DATA>
          Base64 Encoded data to be signed
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
      --data-type <DATA_TYPE>
          The type of data passed in, either raw or digest [possible values: raw, digest]
  -h, --help
          Print help
```

## Exemplo
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-examples"></a>

Esses exemplos mostram como usar o **crypto sign rsa-pkcs** para gerar uma assinatura usando o mecanismo de assinatura RSA-PKCS e a função hash `SHA256`. Esse comando usa uma chave privada no HSM.

**Example Exemplo: gerar uma assinatura para dados codificados em base 64**  

```
aws-cloudhsm > crypto sign rsa-pkcs --key-filter attr.label=rsa-private --hash-function sha256 --data YWJjMTIz
{
  "error_code": 0,
  "data": {
    "key-reference": "0x00000000007008db",
    "signature": "XJ7mRyHnDRYrDWTQuuNb+5mhoXx7VTsPMjgOQW4iMN7E42eNHj2Q0oovMmBdHUEH0F4HYG8FBJOBhvGuM8J/z6y41GbowVpUT6WzjnIQs79K9i7i6oR1TYjLnIS3r/zkimuXcS8/ZxyDzru+GO9BUT9FFU/of9cvu4Oyn6a5+IXuCbKNQs19uASuFARUTZ0a0Ny1CB1MulxUpqGTmI91J6evlP7k/2khwDmJ5E8FEar5/Cvbn9t21p3Uj561ngTXrYbIZ2KHpef9jQh/cEIvFLG61sexJjQi8EdTxeDA+I3ITO0qrvvESvA9+Sj7kdG2ceIicFS8/8LwyxiIC31UHQ=="
  }
}
```

**Example Exemplo: gerar uma assinatura para um arquivo de dados**  

```
aws-cloudhsm > crypto sign rsa-pkcs --key-filter attr.label=rsa-private --hash-function sha256 --data-path data.txt
{
  "error_code": 0,
  "data": {
    "key-reference": "0x00000000007008db",
    "signature": "XJ7mRyHnDRYrDWTQuuNb+5mhoXx7VTsPMjgOQW4iMN7E42eNHj2Q0oovMmBdHUEH0F4HYG8FBJOBhvGuM8J/z6y41GbowVpUT6WzjnIQs79K9i7i6oR1TYjLnIS3r/zkimuXcS8/ZxyDzru+GO9BUT9FFU/of9cvu4Oyn6a5+IXuCbKNQs19uASuFARUTZ0a0Ny1CB1MulxUpqGTmI91J6evlP7k/2khwDmJ5E8FEar5/Cvbn9t21p3Uj561ngTXrYbIZ2KHpef9jQh/cEIvFLG61sexJjQi8EdTxeDA+I3ITO0qrvvESvA9+Sj7kdG2ceIicFS8/8LwyxiIC31UHQ=="
  }
}
```

## Argumentos
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<DATA>***  
Dados codificados em Base64 a serem assinados.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<DATA\$1PATH>***  
Especifica o local dos dados a serem assinados.  
Obrigatório: sim (a menos que seja fornecido por meio de dados)

***<HASH\$1FUNCTION>***  
Especifica a função hash.   
Valores válidos:  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
Obrigatório: Sim

***<KEY\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave correspondente.  
Para obter uma lista dos atributos de chave compatíveis com a CloudHSM CLI, consulte Atributos de chave da CloudHSM CLI.  
Obrigatório: Sim

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de uso da chave privada for maior que 1.

***<DATA\$1TYPE>***  
 Especifica se o valor do parâmetro de dados deve ser criptografado com hash como parte do algoritmo de assinatura. Use `raw` para dados sem hash; use `digest` para resumos, que já estão criptografados com hash.   
Em relação a RSA-PKCS, os dados devem ser passados no formato codificado DER, conforme especificado na [RFC 8017, Seção 9.2](https://www.rfc-editor.org/rfc/rfc8017#section-9.2)  
Valores válidos:  
+ bruto
+ resumo

## Tópicos relacionados
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-seealso"></a>
+ [A categoria de assinatura criptográfica na CLI do CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [A categoria de verificação de criptografia na CLI do CloudHSM](cloudhsm_cli-crypto-verify.md)

# Gere uma assinatura com o RSA-PKCS-PSS mecanismo na CLI do CloudHSM
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-pss"></a>

Use o comando **crypto sign rsa-pkcs-pss** na CloudHSM CLI para gerar uma assinatura usando uma chave privada RSA e o mecanismo de assinatura `RSA-PKCS-PSS`.

Para usar o **crypto sign rsa-pkcs-pss** comando, primeiro você deve ter uma chave privada RSA em seu AWS CloudHSM cluster. Você pode gerar uma chave privada RSA usando o comando [Gerar um par de chaves assimétricas RSA com a CloudHSM CLI](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md) com o atributo `sign` definido como `true`.

**nota**  
As assinaturas podem ser verificadas AWS CloudHSM com [A categoria de verificação de criptografia na CLI do CloudHSM](cloudhsm_cli-crypto-verify.md) subcomandos.

## Tipo de usuário
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-syntax"></a>

```
aws-cloudhsm > help crypto sign rsa-pkcs-pss
Sign with the RSA-PKCS-PSS mechanism

Usage: crypto sign rsa-pkcs-pss [OPTIONS] --key-filter [<KEY_FILTER>...] --hash-function <HASH_FUNCTION> --mgf <MGF> --salt-length <SALT_LENGTH> <--data-path <DATA_PATH>|--data <DATA>>

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
      --key-filter [<KEY_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
      --hash-function <HASH_FUNCTION>  [possible values: sha1, sha224, sha256, sha384, sha512]
      --data-path <DATA_PATH>          The path to the file containing the data to be signed
      --data <DATA>                    Base64 Encoded data to be signed
      --mgf <MGF>                      The mask generation function [possible values: mgf1-sha1, mgf1-sha224, mgf1-sha256, mgf1-sha384, mgf1-sha512]
      --salt-length <SALT_LENGTH>      The salt length
      --approval <APPROVAL>            Filepath of signed quorum token file to approve operation
      --data-type <DATA_TYPE>          The type of data passed in, either raw or digest [possible values: raw, digest]
  -h, --help                           Print help
```

## Exemplo
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-examples"></a>

Esses exemplos mostram como usar o **crypto sign rsa-pkcs-pss** para gerar uma assinatura usando o mecanismo de assinatura `RSA-PKCS-PSS` e a função hash `SHA256`. Esse comando usa uma chave privada no HSM.

**Example Exemplo: gerar uma assinatura para dados codificados em base 64**  

```
aws-cloudhsm > crypto sign rsa-pkcs-pss --key-filter attr.label=rsa-private --hash-function sha256 --data YWJjMTIz --salt-length 10 --mgf mgf1-sha256
{
  "error_code": 0,
  "data": {
    "key-reference": "0x00000000007008db",
    "signature": "H/z1rYVMzNAa31K4amE5MTiwGxDdCTgQXCJXRBKVOVm7ZuyI0fGE4sT/BUN+977mQEV2TqtWpTsiF2IpwGM1VfSBRt7h/g4o6YERm1tTQLl7q+AJ7uGGK37zCsWQrAo7Vy8NzPShxekePo/ZegrB1aHWN1fE8H3IPUKqLuMDI9o1Jq6kM986ExS7YmeOIclcZkyykTWqHLQVL2C3+A2bHJZBqRcM5XoIpk8HkPypjpN+m4FNUds30GAemoOMl6asSrEJSthaZWV53OBsDOqzA8Rt8JdhXS+GZp3vNLdL1OTBELDPweXVgAu4dBX0FOvpw/gg6sNvuaDK4YOBv2fqKg=="
  }
}
```

**Example Exemplo: gerar uma assinatura para um arquivo de dados**  

```
aws-cloudhsm > crypto sign rsa-pkcs-pss --key-filter attr.label=rsa-private --hash-function sha256 --data-path data.txt --salt-length 10 --mgf mgf1-sha256
{
  "error_code": 0,
  "data": {
    "key-reference": "0x00000000007008db",
    "signature": "H/z1rYVMzNAa31K4amE5MTiwGxDdCTgQXCJXRBKVOVm7ZuyI0fGE4sT/BUN+977mQEV2TqtWpTsiF2IpwGM1VfSBRt7h/g4o6YERm1tTQLl7q+AJ7uGGK37zCsWQrAo7Vy8NzPShxekePo/ZegrB1aHWN1fE8H3IPUKqLuMDI9o1Jq6kM986ExS7YmeOIclcZkyykTWqHLQVL2C3+A2bHJZBqRcM5XoIpk8HkPypjpN+m4FNUds30GAemoOMl6asSrEJSthaZWV53OBsDOqzA8Rt8JdhXS+GZp3vNLdL1OTBELDPweXVgAu4dBX0FOvpw/gg6sNvuaDK4YOBv2fqKg=="
  }
}
```

## Argumentos
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<DATA>***  
Dados codificados em Base64 a serem assinados.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<DATA\$1PATH>***  
Especifica o local dos dados a serem assinados.  
Obrigatório: sim (a menos que seja fornecido por meio de dados)

***<HASH\$1FUNCTION>***  
Especifica a função hash.   
Valores válidos:  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
Obrigatório: Sim

***<KEY\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave correspondente.  
Para obter uma lista dos atributos de chave compatíveis com a CloudHSM CLI, consulte Atributos de chave da CloudHSM CLI.  
Obrigatório: Sim

***<MGF>***  
Especifica a função de geração da máscara.  
A função hash da função de geração de máscara deve corresponder à função hash do mecanismo de assinatura.
Valores válidos:  
+ mgf1-sha1
+ mgf1-sha224
+ mgf1-sha256
+ mgf1-sha384
+ mgf1-sha512
Obrigatório: Sim

***<SALT\$1LENGTH>***  
Especifica o comprimento do sal.  
Obrigatório: Sim

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de uso da chave privada for maior que 1.

***<DATA\$1TYPE>***  
 Especifica se o valor do parâmetro de dados deve ser criptografado com hash como parte do algoritmo de assinatura. Use `raw` para dados sem hash; use `digest` para resumos, que já estão criptografados com hash.   
Valores válidos:  
+ bruto
+ resumo

## Tópicos relacionados
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-seealso"></a>
+ [A categoria de assinatura criptográfica na CLI do CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [A categoria de verificação de criptografia na CLI do CloudHSM](cloudhsm_cli-crypto-verify.md)

## Tópicos relacionados
<a name="cloudhsm_cli-crypto-sign-seealso"></a>
+ [A categoria de verificação de criptografia na CLI do CloudHSM](cloudhsm_cli-crypto-verify.md)

# A categoria de verificação de criptografia na CLI do CloudHSM
<a name="cloudhsm_cli-crypto-verify"></a>

Na CLI do CloudHSM, **crypto verify** é uma categoria principal de um grupo de comandos que, quando combinados com a categoria principal, confirmam se um arquivo foi assinado por uma determinada chave. O comando **crypto verify** tem os seguintes subcomandos: 
+ [crypto verify ecdsa](cloudhsm_cli-crypto-verify-ecdsa.md)
+ [verificação criptográfica ed25519ph](cloudhsm_cli-crypto-verify-ed25519ph.md)
+ [crypto verify rsa-pkcs](cloudhsm_cli-crypto-verify-rsa-pkcs.md)
+ [verificação criptográfica rsa-pkcs-pss](cloudhsm_cli-crypto-verify-rsa-pkcs-pss.md)

O comando **crypto verify** compara um arquivo assinado com um arquivo de origem e analisa se eles estão criptograficamente relacionados com base em uma determinada chave pública e no mecanismo de assinatura.

**nota**  
Os arquivos podem ser conectados AWS CloudHSM com a [A categoria de assinatura criptográfica na CLI do CloudHSM](cloudhsm_cli-crypto-sign.md) operação.

# Verifique uma assinatura assinada com o mecanismo ECDSA na CloudHSM CLI
<a name="cloudhsm_cli-crypto-verify-ecdsa"></a>

Use o comando **crypto verify ecdsa** na CloudHSM CLI para concluir as seguintes operações:
+ Confirme se um arquivo foi assinado no HSM por uma determinada chave pública.
+ Verifique se a assinatura foi gerada usando o mecanismo de assinatura ECDSA.
+ Compare um arquivo assinado com um arquivo de origem e determina se os dois estão criptograficamente relacionados com base em uma determinada chave pública ecdsa e em um mecanismo de assinatura. 
+  A função de verificação do ECDSA espera a assinatura no formato`r||s`, em que os componentes r e s são concatenados como dados binários brutos. 

Para usar o **crypto verify ecdsa** comando, primeiro você deve ter uma chave pública EC em seu AWS CloudHSM cluster. Você pode importar uma chave pública EC usando o comando [Importar uma chave no formato PEM com a CLI do CloudHSM](cloudhsm_cli-key-import-pem.md) com o atributo `verify` definido como `true`.

**nota**  
Você pode gerar uma assinatura na CloudHSM CLI com os subcomandos contidos em [A categoria de assinatura criptográfica na CLI do CloudHSM](cloudhsm_cli-crypto-sign.md).

## Tipo de usuário
<a name="cloudhsm_cli-crypto-verify-ecdsa-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-crypto-verify-ecdsa-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-crypto-verify-ecdsa-syntax"></a>

```
aws-cloudhsm > help crypto verify ecdsa
Verify with the ECDSA mechanism

Usage: crypto verify ecdsa --key-filter [<KEY_FILTER>...] --hash-function <HASH_FUNCTION> <--data-path <DATA_PATH>|--data <DATA>> <--signature-path <SIGNATURE_PATH>|--signature <SIGNATURE>>

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
      --key-filter [<KEY_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
      --hash-function <HASH_FUNCTION>
          [possible values: sha1, sha224, sha256, sha384, sha512]
      --data-path <DATA_PATH>
          The path to the file containing the data to be verified
      --data <DATA>
          Base64 encoded data to be verified
      --signature-path <SIGNATURE_PATH>
          The path to where the signature is located
      --signature <SIGNATURE>
          Base64 encoded signature to be verified
      --data-type <DATA_TYPE>
          The type of data passed in, either raw or digest [possible values: raw, digest]
  -h, --help
          Print help
```

## Exemplo
<a name="cloudhsm_cli-crypto-verify-ecdsa-examples"></a>

Esses exemplos mostram como usar o **crypto verify ecdsa** para verificar uma assinatura que foi gerada usando o mecanismo de assinatura ECDSA e a função hash `SHA256`. Esse comando usa uma chave pública no HSM.

**Example Exemplo: verificar uma assinatura codificada em Base64 com dados codificados em Base64**  

```
aws-cloudhsm > crypto verify ecdsa --hash-function sha256 --key-filter attr.label=ec-public --data YWJjMTIz --signature 4zki+FzjhP7Z/KqoQvh4ueMAxQQVp7FQguZ2wOS3Q5bzk+Hc5irV5iTkuxQbropPttVFZ8V6FgR2fz+sPegwCw==
{
  "error_code": 0,
  "data": {
    "message": "Signature verified successfully"
  }
}
```

**Example Exemplo: verificar um arquivo de assinatura com um arquivo de dados**  

```
aws-cloudhsm > crypto verify ecdsa --hash-function sha256 --key-filter attr.label=ec-public --data-path data.txt --signature-path signature-file
{
   "error_code": 0,
  "data": {
    "message": "Signature verified successfully"
  }
}
```

**Example Exemplo: provar relacionamento de assinatura falso**  
Esse comando verifica se os dados localizados em `/home/data` foram assinados por uma chave pública com o rótulo `ecdsa-public` usando o mecanismo de assinatura ECDSA para produzir a assinatura localizada em `/home/signature`. Como os argumentos fornecidos não formam um relacionamento de assinatura verdadeiro, o comando retorna uma mensagem de erro.  

```
aws-cloudhsm > crypto verify ecdsa --hash-function sha256 --key-filter attr.label=ec-public --data aW52YWxpZA== --signature +ogk7M7S3iTqFg3SndJfd91dZFr5Qo6YixJl8JwcvqqVgsVuO6o+VKvTRjz0/V05kf3JJbBLr87Q+wLWcMAJfA==
{
  "error_code": 1,
  "data": "Signature verification failed"
}
```

## Argumentos
<a name="cloudhsm_cli-crypto-verify-ecdsa-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<DATA>***  
Dados codificados em Base64 a serem assinados.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<DATA\$1PATH>***  
Especifica o local dos dados a serem assinados.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<HASH\$1FUNCTION>***  
Especifica a função hash.   
Valores válidos:  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
Obrigatório: Sim

***<KEY\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave correspondente.  
Para obter uma lista dos atributos de chave compatíveis com a CloudHSM CLI, consulte Atributos de chave da CloudHSM CLI.  
Obrigatório: Sim

***<SIGNATURE>***  
Assinatura codificada em Base64.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho da assinatura)

***<SIGNATURE\$1PATH>***  
Especifica o local da assinatura.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho da assinatura)

***<DATA\$1TYPE>***  
 Especifica se o valor do parâmetro de dados deve ser criptografado com hash como parte do algoritmo de assinatura. Use `raw` para dados sem hash; use `digest` para resumos, que já estão criptografados com hash.   
Valores válidos:  
+ bruto
+ resumo

## Tópicos relacionados
<a name="cloudhsm_cli-crypto-verify-ecdsa-seealso"></a>
+ [A categoria de assinatura criptográfica na CLI do CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [A categoria de verificação de criptografia na CLI do CloudHSM](cloudhsm_cli-crypto-verify.md)

# Verifique uma assinatura assinada com o mecanismo HashEd DSA na CLI do CloudHSM
<a name="cloudhsm_cli-crypto-verify-ed25519ph"></a>

**Importante**  
HashEdAs operações de verificação de assinatura do DSA só são suportadas em instâncias hsm2m.medium no modo não FIPS.

Use o comando **crypto verify ed25519ph** na CloudHSM CLI para concluir as seguintes operações:
+ Verifique as assinaturas de dados ou arquivos usando uma determinada chave pública Ed25519.
+ Confirme se a assinatura foi gerada usando o mecanismo de assinatura HashEd DSA. Para obter informações adicionais sobre o HashEd DSA, consulte [NIST SP 186-5](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-5.pdf), Seção 7.8.

Para usar o **crypto verify ed25519ph** comando, primeiro você deve ter uma chave pública Ed25519 em seu cluster. AWS CloudHSM Você pode gerar um par de chaves Ed25519 usando o [Gerar um par de chaves EC assimétricas com a CloudHSM CLI](cloudhsm_cli-key-generate-asymmetric-pair-ec.md) comando com o `curve` parâmetro definido como `ed25519` e o `verify` atributo definido como`true`, ou importar uma chave pública Ed25519 usando o [Importar uma chave no formato PEM com a CLI do CloudHSM](cloudhsm_cli-key-import-pem.md) comando com o atributo definido como. `verify` `true`

**nota**  
Você pode gerar uma assinatura na CloudHSM CLI com os subcomandos contidos em [A categoria de assinatura criptográfica na CLI do CloudHSM](cloudhsm_cli-crypto-sign.md).

## Tipo de usuário
<a name="cloudhsm_cli-crypto-verify-ed25519ph-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-crypto-verify-ed25519ph-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.
+ HashEdAs operações de verificação de assinatura do DSA só são suportadas em instâncias hsm2m.medium no modo não FIPS.

## Sintaxe
<a name="cloudhsm_cli-crypto-verify-ed25519ph-syntax"></a>

```
aws-cloudhsm > help crypto verify ed25519ph
Verify with the Ed25519ph mechanism

Usage: crypto verify ed25519ph [OPTIONS] --key-filter [<KEY_FILTER>...] --data-type <DATA_TYPE> --hash-function <HASH_FUNCTION> <--data-path <DATA_PATH>|--data <DATA>> <--signature-path <SIGNATURE_PATH>|--signature <SIGNATURE>>

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
      --key-filter [<KEY_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
      --data-path <DATA_PATH>
          The path to the file containing the data to be verified
      --data <DATA>
          Base64 encoded data to be verified
      --signature-path <SIGNATURE_PATH>
          The path to where the signature is located
      --signature <SIGNATURE>
          Base64 encoded signature to be verified
      --data-type <DATA_TYPE>
          The type of data passed in, either raw or digest [possible values: raw, digest]
      --hash-function <HASH_FUNCTION>
          Hash function [possible values: sha512]
  -h, --help
          Print help
```

## Exemplo
<a name="cloudhsm_cli-crypto-verify-ed25519ph-examples"></a>

Esses exemplos mostram como usar **crypto verify ed25519ph** para verificar uma assinatura que foi gerada usando o mecanismo de assinatura ED25519ph e a função hash. `sha512` Esse comando usa uma chave pública Ed25519 no HSM.

**Example Exemplo: verificar uma assinatura codificada em Base64 com dados codificados em Base64**  

```
aws-cloudhsm > crypto verify ed25519ph \
    --hash-function sha512 \
    --key-filter attr.label=ed25519-public \
    --data-type raw \
    --data YWJj \
    --signature mKcCIvC4Ehqp0w+BPWg/gJ5GK0acf/h2OUmbuU5trkEx+FBCRjwqNVogA9BirfWqoQuMYeY2Biqq0RwqJgg0Bg==
{
  "error_code": 0,
  "data": {
    "message": "Signature verified successfully"
  }
}
```

**Example Exemplo: verificar um arquivo de assinatura com um arquivo de dados**  

```
aws-cloudhsm > crypto verify ed25519ph \
    --hash-function sha512 \
    --key-filter attr.label=ed25519-public \
    --data-type raw \
    --data-path data.txt \
    --signature-path signature-file
{
  "error_code": 0,
  "data": {
    "message": "Signature verified successfully"
  }
}
```

## Argumentos
<a name="cloudhsm_cli-crypto-verify-ed25519ph-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<DATA>***  
Dados codificados em Base64 a serem verificados.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<DATA\$1PATH>***  
Especifica a localização dos dados a serem verificados.  
Obrigatório: Sim (a menos que seja fornecido por meio do parâmetro de dados)

***<HASH\$1FUNCTION>***  
Especifica a função hash. O ED25519ph suporta apenas. SHA512   
Valores válidos:  
+ sha512
Obrigatório: Sim

***<KEY\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave correspondente.  
Para obter uma lista dos principais atributos da CLI do CloudHSM compatíveis, consulte. [Atributos de chave da CloudHSM CLI](cloudhsm_cli-key-attributes.md)  
Obrigatório: Sim

***<SIGNATURE>***  
Assinatura codificada em Base64.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho da assinatura)

***<SIGNATURE\$1PATH>***  
Especifica o local da assinatura.  
Obrigatório: Sim (a menos que seja fornecido por meio do parâmetro de assinatura)

***<DATA\$1TYPE>***  
 Especifica se o valor do parâmetro de dados deve ser codificado como parte do algoritmo de verificação. Use `raw` para dados sem hash; use `digest` para resumos, que já estão criptografados com hash.   
Valores válidos:  
+ bruto
+ resumo
Obrigatório: Sim

## Tópicos relacionados
<a name="cloudhsm_cli-crypto-verify-ed25519ph-seealso"></a>
+ [A categoria de assinatura criptográfica na CLI do CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [A categoria de verificação de criptografia na CLI do CloudHSM](cloudhsm_cli-crypto-verify.md)
+ [Gere uma assinatura com o mecanismo HashEd DSA na CLI do CloudHSM](cloudhsm_cli-crypto-sign-ed25519ph.md)

# Verificar uma assinatura assinada com o mecanismo RSA-PKCS na CloudHSM CLI
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs"></a>

Use o comando **crypto verify rsa-pkcs** na CloudHSM CLI para concluir as seguintes operações:
+ Confirme se um arquivo foi assinado no HSM por uma determinada chave pública.
+ Verifique se a assinatura foi gerada usando o mecanismo de assinatura `RSA-PKCS`.
+ Compare um arquivo assinado com um arquivo de origem e determina se os dois estão criptograficamente relacionados com base em uma determinada chave pública RSA e em um mecanismo de assinatura.

Para usar o **crypto verify rsa-pkcs** comando, primeiro você deve ter uma chave pública RSA em seu AWS CloudHSM cluster.

**nota**  
Você pode gerar uma assinatura usando a CloudHSM CLI com os subcomandos contidos em [A categoria de assinatura criptográfica na CLI do CloudHSM](cloudhsm_cli-crypto-sign.md).

## Tipo de usuário
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-syntax"></a>

```
aws-cloudhsm > help crypto verify rsa-pkcs
Verify with the RSA-PKCS mechanism

Usage: crypto verify rsa-pkcs --key-filter [<KEY_FILTER>...] --hash-function <HASH_FUNCTION> <--data-path <DATA_PATH>|--data <DATA>> <--signature-path <SIGNATURE_PATH>|--signature <SIGNATURE>>

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
      --key-filter [<KEY_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
      --hash-function <HASH_FUNCTION>
          [possible values: sha1, sha224, sha256, sha384, sha512]
      --data-path <DATA_PATH>
          The path to the file containing the data to be verified
      --data <DATA>
          Base64 encoded data to be verified
      --signature-path <SIGNATURE_PATH>
          The path to where the signature is located
      --signature <SIGNATURE>
          Base64 encoded signature to be verified
      --data-type <DATA_TYPE>
          The type of data passed in, either raw or digest [possible values: raw, digest]
  -h, --help
          Print help
```

## Exemplo
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-examples"></a>

Esses exemplos mostram como usar **crypto verify rsa-pkcs** para verificar uma assinatura que foi gerada usando o mecanismo de assinatura RSA-PKCS e a função hash `SHA256`. Esse comando usa uma chave pública no HSM.

**Example Exemplo: verificar uma assinatura codificada em Base64 com dados codificados em Base64**  

```
aws-cloudhsm > crypto verify rsa-pkcs --hash-function sha256 --key-filter attr.label=rsa-public --data YWJjMTIz --signature XJ7mRyHnDRYrDWTQuuNb+5mhoXx7VTsPMjgOQW4iMN7E42eNHj2Q0oovMmBdHUEH0F4HYG8FBJOBhvGuM8J/z6y41GbowVpUT6WzjnIQs79K9i7i6oR1TYjLnIS3r/zkimuXcS8/ZxyDzru+GO9BUT9FFU/of9cvu4Oyn6a5+IXuCbKNQs19uASuFARUTZ0a0Ny1CB1MulxUpqGTmI91J6evlP7k/2khwDmJ5E8FEar5/Cvbn9t21p3Uj561ngTXrYbIZ2KHpef9jQh/cEIvFLG61sexJjQi8EdTxeDA+I3ITO0qrvvESvA9+Sj7kdG2ceIicFS8/8LwyxiIC31UHQ==
{
  "error_code": 0,
  "data": {
    "message": "Signature verified successfully"
  }
}
```

**Example Exemplo: verificar um arquivo de assinatura com um arquivo de dados**  

```
aws-cloudhsm > crypto verify rsa-pkcs --hash-function sha256 --key-filter attr.label=rsa-public --data-path data.txt --signature-path signature-file
{
  "error_code": 0,
  "data": {
    "message": "Signature verified successfully"
  }
}
```

**Example Exemplo: provar relacionamento de assinatura falso**  
Esse comando verifica se os dados inválidos foram assinados por uma chave pública com o rótulo `rsa-public` usando o mecanismo de assinatura RSAPKCS para produzir a assinatura localizada em `/home/signature`. Como os argumentos fornecidos não formam um relacionamento de assinatura verdadeiro, o comando retorna uma mensagem de erro.  

```
aws-cloudhsm > crypto verify rsa-pkcs --hash-function sha256 --key-filter attr.label=rsa-public --data aW52YWxpZA== --signature XJ7mRyHnDRYrDWTQuuNb+5mhoXx7VTsPMjgOQW4iMN7E42eNHj2Q0oovMmBdHUEH0F4HYG8FBJOBhvGuM8J/z6y41GbowVpUT6WzjnIQs79K9i7i6oR1TYjLnIS3r/zkimuXcS8/ZxyDzru+GO9BUT9FFU/of9cvu4Oyn6a5+IXuCbKNQs19uASuFARUTZ0a0Ny1CB1MulxUpqGTmI91J6evlP7k/2khwDmJ5E8FEar5/Cvbn9t21p3Uj561ngTXrYbIZ2KHpef9jQh/cEIvFLG61sexJjQi8EdTxeDA+I3ITO0qrvvESvA9+Sj7kdG2ceIicFS8/8LwyxiIC31UHQ==
{
  "error_code": 1,
  "data": "Signature verification failed"
}
```

## Argumentos
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<DATA>***  
Dados codificados em Base64 a serem assinados.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<DATA\$1PATH>***  
Especifica o local dos dados a serem assinados.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<HASH\$1FUNCTION>***  
Especifica a função hash.   
Valores válidos:  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
Obrigatório: Sim

***<KEY\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave correspondente.  
Para obter uma lista dos atributos de chave compatíveis com a CloudHSM CLI, consulte Atributos de chave da CloudHSM CLI.  
Obrigatório: Sim

***<SIGNATURE>***  
Assinatura codificada em Base64.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho da assinatura)

***<SIGNATURE\$1PATH>***  
Especifica o local da assinatura.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho da assinatura)

***<DATA\$1TYPE>***  
 Especifica se o valor do parâmetro de dados deve ser criptografado com hash como parte do algoritmo de assinatura. Use `raw` para dados sem hash; use `digest` para resumos, que já estão criptografados com hash.   
Em relação a RSA-PKCS, os dados devem ser passados no formato codificado DER, conforme especificado na [RFC 8017, Seção 9.2](https://www.rfc-editor.org/rfc/rfc8017#section-9.2)  
Valores válidos:  
+ bruto
+ resumo

## Tópicos relacionados
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-seealso"></a>
+ [A categoria de assinatura criptográfica na CLI do CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [A categoria de verificação de criptografia na CLI do CloudHSM](cloudhsm_cli-crypto-verify.md)

# Verifique uma assinatura assinada com o RSA-PKCS-PSS mecanismo na CLI do CloudHSM
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss"></a>

Use o comando **crypto sign rsa-pkcs-pss** na CloudHSM CLI para concluir as operações a seguir.
+ Confirme se um arquivo foi assinado no HSM por uma determinada chave pública.
+ Verifique se a assinatura foi gerada usando o mecanismo de assinatura RSA-PKCS-PSS.
+ Compare um arquivo assinado com um arquivo de origem e determina se os dois estão criptograficamente relacionados com base em uma determinada chave pública RSA e em um mecanismo de assinatura.

Para usar o **crypto verify rsa-pkcs-pss** comando, primeiro você deve ter uma chave pública RSA em seu AWS CloudHSM cluster. Você pode importar uma chave pública RSA usando o comando key import pem (ADD UNWRAP LINK HERE) com o atributo `verify` definido como `true`.

**nota**  
Você pode gerar uma assinatura usando a CloudHSM CLI com os subcomandos contidos em [A categoria de assinatura criptográfica na CLI do CloudHSM](cloudhsm_cli-crypto-sign.md).

## Tipo de usuário
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-syntax"></a>

```
aws-cloudhsm > help crypto verify rsa-pkcs-pss
Verify with the RSA-PKCS-PSS mechanism

Usage: crypto verify rsa-pkcs-pss --key-filter [<KEY_FILTER>...] --hash-function <HASH_FUNCTION> --mgf <MGF> --salt-length >SALT_LENGTH< <--data-path <DATA_PATH>|--data <DATA> <--signature-path <SIGNATURE_PATH>|--signature <SIGNATURE>>

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
      --key-filter [<KEY_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
      --hash-function <HASH_FUNCTION>
          [possible values: sha1, sha224, sha256, sha384, sha512]
      --data-path <DATA_PATH>
          The path to the file containing the data to be verified
      --data <DATA>
          Base64 encoded data to be verified
      --signature-path <SIGNATURE_PATH>
          The path to where the signature is located
      --signature <SIGNATURE>
          Base64 encoded signature to be verified
      --data-type <DATA_TYPE>
          The type of data passed in, either raw or digest [possible values: raw, digest]
      --mgf <MGF>
          The mask generation function [possible values: mgf1-sha1, mgf1-sha224, mgf1-sha256, mgf1-sha384, mgf1-sha512]
      --salt-length <SALT_LENGTH>
          The salt length
  -h, --help
          Print help
```

## Exemplo
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-examples"></a>

Esses exemplos mostram como usar **crypto verify rsa-pkcs-pss** para verificar uma assinatura que foi gerada usando o mecanismo de RSA-PKCS-PSS assinatura e a função `SHA256` hash. Esse comando usa uma chave pública no HSM.

**Example Exemplo: verificar uma assinatura codificada em Base64 com dados codificados em Base64**  

```
aws-cloudhsm > crypto verify rsa-pkcs-pss --key-filter attr.label=rsa-public --hash-function sha256 --data YWJjMTIz --salt-length 10 --mgf mgf1-sha256 --signature H/z1rYVMzNAa31K4amE5MTiwGxDdCTgQXCJXRBKVOVm7ZuyI0fGE4sT/BUN+977mQEV2TqtWpTsiF2IpwGM1VfSBRt7h/g4o6YERm1tTQLl7q+AJ7uGGK37zCsWQrAo7Vy8NzPShxekePo/ZegrB1aHWN1fE8H3IPUKqLuMDI9o1Jq6kM986ExS7YmeOIclcZkyykTWqHLQVL2C3+A2bHJZBqRcM5XoIpk8HkPypjpN+m4FNUds30GAemoOMl6asSrEJSthaZWV53OBsDOqzA8Rt8JdhXS+GZp3vNLdL1OTBELDPweXVgAu4dBX0FOvpw/gg6sNvuaDK4YOBv2fqKg==
{
  "error_code": 0,
  "data": {
    "message": "Signature verified successfully"
  }
}
```

**Example Exemplo: verificar um arquivo de assinatura com um arquivo de dados**  

```
aws-cloudhsm > crypto verify rsa-pkcs-pss --key-filter attr.label=rsa-public --hash-function sha256 --data-path data.txt --salt-length 10 --mgf mgf1-sha256 --signature signature-file
{
  "error_code": 0,
  "data": {
    "message": "Signature verified successfully"
  }
}
```

**Example Exemplo: provar relacionamento de assinatura falso**  
Esse comando verifica se os dados inválidos foram assinados por uma chave pública com o rótulo `rsa-public` usando o mecanismo de assinatura RSAPKCSPSS para produzir a assinatura localizada em `/home/signature`. Como os argumentos fornecidos não formam um relacionamento de assinatura verdadeiro, o comando retorna uma mensagem de erro.  

```
aws-cloudhsm > crypto verify rsa-pkcs-pss --key-filter attr.label=rsa-public --hash-function sha256 --data aW52YWxpZA== --salt-length 10 --mgf mgf1-sha256 --signature H/z1rYVMzNAa31K4amE5MTiwGxDdCTgQXCJXRBKVOVm7ZuyI0fGE4sT/BUN+977mQEV2TqtWpTsiF2IpwGM1VfSBRt7h/g4o6YERm1tTQLl7q+AJ7uGGK37zCsWQrAo7Vy8NzPShxekePo/ZegrB1aHWN1fE8H3IPUKqLuMDI9o1Jq6kM986ExS7YmeOIclcZkyykTWqHLQVL2C3+A2bHJZBqRcM5XoIpk8HkPypjpN+m4FNUds30GAemoOMl6asSrEJSthaZWV53OBsDOqzA8Rt8JdhXS+GZp3vNLdL1OTBELDPweXVgAu4dBX0FOvpw/gg6sNvuaDK4YOBv2fqKg==
{
  "error_code": 1,
  "data": "Signature verification failed"
}
```

## Argumentos
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<DATA>***  
Dados codificados em Base64 a serem assinados.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<DATA\$1PATH>***  
Especifica o local dos dados a serem assinados.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<HASH\$1FUNCTION>***  
Especifica a função hash.   
Valores válidos:  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
Obrigatório: Sim

***<KEY\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave correspondente.  
Para obter uma lista dos atributos de chave compatíveis com a CloudHSM CLI, consulte Atributos de chave da CloudHSM CLI.  
Obrigatório: Sim

***<MFG>***  
Especifica a função de geração da máscara.  
A função hash da função de geração de máscara deve corresponder à função hash do mecanismo de assinatura.
Valores válidos:  
+ mgf1-sha1
+ mgf1-sha224
+ mgf1-sha256
+ mgf1-sha384
+ mgf1-sha512
Obrigatório: Sim

***<SIGNATURE>***  
Assinatura codificada em Base64.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho da assinatura)

***<SIGNATURE\$1PATH>***  
Especifica o local da assinatura.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho da assinatura)

***<DATA\$1TYPE>***  
 Especifica se o valor do parâmetro de dados deve ser criptografado com hash como parte do algoritmo de assinatura. Use `raw` para dados sem hash; use `digest` para resumos, que já estão criptografados com hash.   
Valores válidos:  
+ bruto
+ resumo

## Tópicos relacionados
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-seealso"></a>
+ [A categoria de assinatura criptográfica na CLI do CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [A categoria de verificação de criptografia na CLI do CloudHSM](cloudhsm_cli-crypto-verify.md)

# A key na CLI do CloudHSM
<a name="cloudhsm_cli-key"></a>

Na CLI do CloudHSM, **key** é uma categoria principal para um grupo de comandos que, quando combinado com a categoria principal, cria um comando específico para chaves. Atualmente, essa categoria consiste nos seguintes comandos:
+ [excluir](cloudhsm_cli-key-delete.md)
+ [generate-file](cloudhsm_cli-key-generate-file.md)
+ [chave generate-asymmetric-pair](cloudhsm_cli-key-generate-asymmetric-pair.md)
  + [chave generate-asymmetric-pair rsa](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md)
  + [chave, generate-asymmetric-pair etc.](cloudhsm_cli-key-generate-asymmetric-pair-ec.md)
+ [key generate-symmetric](cloudhsm_cli-key-generate-symmetric.md)
  + [key generate-symmetric aes](cloudhsm_cli-key-generate-symmetric-aes.md)
  + [key generate-symmetric generic-secret](cloudhsm_cli-key-generate-symmetric-generic-secret.md)
+ [importar pem](cloudhsm_cli-key-import-pem.md)
+ [listar](cloudhsm_cli-key-list.md)
+ [replicar](cloudhsm_cli-key-replicate.md)
+ [set-attribute](cloudhsm_cli-key-set-attribute.md)
+ [compartilhar](cloudhsm_cli-key-share.md)
+ [cancelar compartilhamento](cloudhsm_cli-key-unshare.md)
+ [unwrap](cloudhsm_cli-key-unwrap.md)
+ [wrap](cloudhsm_cli-key-wrap.md)

# Excluir uma chave com a CLI do CloudHSM
<a name="cloudhsm_cli-key-delete"></a>

Use o **key delete** comando na CLI do CloudHSM para excluir uma chave de um cluster. AWS CloudHSM Você só pode excluir uma chave por vez. A exclusão de uma chave em um par de chaves não tem efeito na outra chave do par. 

Somente o CU que criou a chave e, consequentemente, a possui pode excluir a chave. Os usuários que compartilham a chave, mas não a possuem, podem usá-la em operações criptográficas, mas não podem excluí-la.

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

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

## Requisitos
<a name="key-delete-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="key-delete-syntax"></a>

```
aws-cloudhsm > help key delete
Delete a key in the HSM cluster

Usage: key delete [OPTIONS] --filter [<FILTER>...]

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 for deletion
  -h, --help                     Print help
```

## Exemplo
<a name="key-delete-examples"></a>

```
aws-cloudhsm > key delete --filter attr.label="ec-test-public-key"
{
  "error_code": 0,
  "data": {
    "message": "Key deleted successfully"
  }
}
```

## Argumentos
<a name="key-delete-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para selecionar uma chave correspondente para exclusão.  
Para obter uma lista dos atributos de chave da CLI do CloudHSM com suporte, consulte [Atributos de chave da CloudHSM CLI](cloudhsm_cli-key-attributes.md).  
Obrigatório: Sim

## Tópicos relacionados
<a name="key-delete-seealso"></a>
+ [Listar chaves para um usuário com a CloudHSM CLI](cloudhsm_cli-key-list.md)
+ [Exportar uma chave assimétrica com a CloudHSM CLI](cloudhsm_cli-key-generate-file.md)
+ [Cancelar o compartilhamento de uma chave usando a CloudHSM CLI](cloudhsm_cli-key-unshare.md)
+ [Atributos de chave da CloudHSM CLI](cloudhsm_cli-key-attributes.md)
+ [Filtrar chaves usando a CLI do CloudHSM](manage-keys-cloudhsm-cli-filtering.md)

# Exportar uma chave assimétrica com a CloudHSM CLI
<a name="cloudhsm_cli-key-generate-file"></a>

Use o comando **key generate-file** na CloudHSM CLI para exportar uma chave assimétrica do módulo de segurança de hardware (HSM). Se o destino for uma chave privada, a referência à chave privada será exportada no formato PEM falso. Se o destino for uma chave pública, os bytes da chave pública serão exportados no formato PEM.

O arquivo PEM falso, que não contém o material real da chave privada, mas faz referência à chave privada no HSM, pode ser usado para estabelecer o SSL/TLS descarregamento do seu servidor web para o. AWS CloudHSM Para obter mais informações, consulte [Descarregamento de SSL/TLS](ssl-offload.md).

## Tipo de usuário
<a name="key-generate-file-user-type"></a>

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

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

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

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

```
aws-cloudhsm > help key generate-file
Generate a key file from a key in the HSM cluster. This command does not export any private key data from the HSM

Usage: key generate-file --encoding <ENCODING> --path <PATH> --filter [<FILTER>...]

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
      --encoding <ENCODING>
          Encoding format for the key file

          Possible values:
          - reference-pem: PEM formatted key reference (supports private keys)
          - pem:           PEM format (supports public keys)

      --path <PATH>
          Filepath where the key file will be written

      --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 for file generation

  -h, --help
          Print help (see a summary with '-h')
```

## Exemplo
<a name="key-generate-file-examples"></a>

Este exemplo mostra como usar **key generate-file** para gerar um arquivo de chave em seu AWS CloudHSM cluster.

**Example**  

```
aws-cloudhsm > key generate-file --encoding reference-pem --path /tmp/ec-private-key.pem --filter attr.label="ec-test-private-key"
{
  "error_code": 0,
  "data": {
    "message": "Successfully generated key file"
  }
}
```

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

***<CLUSTER\$1ID>***  
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)

***<FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para selecionar uma chave correspondente para exclusão.  
Para obter uma lista dos atributos de chave compatíveis com a CloudHSM CLI, consulte [Atributos de chave da CloudHSM CLI](cloudhsm_cli-key-attributes.md)  
Obrigatório: não

***<ENCODING>***  
Especifica o formato de codificação para o arquivo de chave  
Obrigatório: Sim

***<PATH>***  
Especifica o caminho do arquivo em que o arquivo de chave será gravado  
Obrigatório: Sim

## Gerar referências de chave KSP (Windows)
<a name="key-generate-ksp-key-reference"></a>

**nota**  
Esse atributo só está disponível no SDK versão 5.16.0 e posterior.

### Pré-requisitos
<a name="key-generate-ksp-key-reference-requirements"></a>
+ Você pode gerar referências de chave KSP somente em plataformas Windows.
+ Você deve fazer login como usuário de criptografia (CU).

### Local do arquivo
<a name="key-generate-ksp-key-reference-options"></a>

Por padrão, o AWS CloudHSM armazena arquivos gerados em: `C:\Users\Default\AppData\Roaming\Microsoft\Crypto\CaviumKSP\GlobalPartition`

Para especificar uma localização diferente, use o parâmetro `--path`.

### Sintaxe
<a name="key-generate-ksp-key-reference-syntax"></a>

```
aws-cloudhsm > help key generate-file --encoding ksp-key-reference 
Generate a key file from a key in the HSM cluster. This command does not export any private key data from the HSM

Usage: key generate-file --encoding <ENCODING> --path <PATH> --filter [<FILTER>...]

Options:
      --encoding <ENCODING>
        Encoding format for the key file

        Possible values:
        - reference-pem:     PEM formatted key reference (supports private keys)
        - pem:               PEM format (supports public keys)
        - ksp-key-reference: KSP key reference format

      --cluster-id <CLUSTER_ID>
        Unique Id to choose which of the clusters in the config file to run the operation against. If not provided with multiple clusters configured, will error

      --path <PATH>
        Directory path where the key file will be written

      --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 for file generation

      --all
        Generate ksp key reference for all available key pairs in HSM

  -h, --help
        Print help (see a summary with '-h')
```

### Exemplo: gerar uma referência de chave KSP usando um filtro de atributos de uma chave privada
<a name="key-generate-ksp-key-reference-example1"></a>

O exemplo a seguir gera uma referência de chave KSP para uma chave privada com um rótulo específico.

**Example**  

```
aws-cloudhsm > key generate-file --encoding ksp-key-reference --path  --filter attr.label="ec-test-private-key"
{
  "error_code": 0,
  "data": {
    "message": "Successfully generated key file"
  }
}
```

### Exemplo: gerar referências de chave KSP para todos os pares de chaves
<a name="key-generate-ksp-key-reference-example2"></a>

O exemplo a seguir gera referências de chave KSP para todos os pares de chaves em seu cluster.

**Example**  

```
aws-cloudhsm > key generate-file --encoding ksp-key-reference --all
{
  "error_code": 0,
  "data": {
    "message": "Successfully generated key file"
  }
}
```

## Tópicos relacionados
<a name="key-generate-file-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)
+ [A generate-asymmetric-pair categoria na CLI do CloudHSM](cloudhsm_cli-key-generate-asymmetric-pair.md)
+ [A categoria generate-symmetric na CLI do CloudHSM](cloudhsm_cli-key-generate-symmetric.md)

# A generate-asymmetric-pair categoria na CLI do CloudHSM
<a name="cloudhsm_cli-key-generate-asymmetric-pair"></a>

Na CLI do CloudHSM, **key generate-asymmetric-pair** é uma categoria principal para um grupo de comandos que, quando combinados com a categoria principal, criam um comando que gera pares de chaves assimétricas. Atualmente, essa categoria consiste nos seguintes comandos:
+ [chave generate-asymmetric-pair etc.](cloudhsm_cli-key-generate-asymmetric-pair-ec.md)
+ [chave generate-asymmetric-pair rsa](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md)

# Gerar um par de chaves EC assimétricas com a CloudHSM CLI
<a name="cloudhsm_cli-key-generate-asymmetric-pair-ec"></a>

Use o **key asymmetric-pair ec** comando na CLI do CloudHSM para gerar um par de chaves de curva elíptica (EC) assimétrica em seu cluster. AWS CloudHSM 

## Tipo de usuário
<a name="key-generate-asymmetric-pair-ec-user-type"></a>

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

## Requisitos
<a name="key-generate-asymmetric-pair-ec-requirements"></a>

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

## Sintaxe
<a name="key-generate-asymmetric-pair-ec-syntax"></a>

```
aws-cloudhsm > help key generate-asymmetric-pair ec
Generate an Elliptic-Curve Cryptography (ECC) key pair

Usage: key generate-asymmetric-pair ec [OPTIONS] --public-label <PUBLIC_LABEL> --private-label <PRIVATE_LABEL> --curve <CURVE>

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
      --public-label <PUBLIC_LABEL>
          Label for the public key
      --private-label <PRIVATE_LABEL>
          Label for the private key
      --session
          Creates a session key pair that exists only in the current session. The key cannot be recovered after the session ends
      --curve <CURVE>
          Elliptic curve used to generate the key pair [possible values: prime256v1, secp256r1, secp224r1, secp384r1, secp256k1, secp521r1, ed25519]
      --public-attributes [<PUBLIC_KEY_ATTRIBUTES>...]
          Space separated list of key attributes to set for the generated EC public key in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE
      --private-attributes [<PRIVATE_KEY_ATTRIBUTES>...]
          Space separated list of key attributes to set for the generated EC private 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 EC private key with
      --manage-private-key-quorum-value <MANAGE_PRIVATE_KEY_QUORUM_VALUE>
          The quorum value for key management operations for the private key
      --use-private-key-quorum-value <USE_PRIVATE_KEY_QUORUM_VALUE>
          The quorum value for key usage operations for the private key
  -h, --help
          Print help
```

## Exemplos
<a name="key-generate-asymmetric-pair-ec-examples"></a>

Esses exemplos mostram como usar o **key generate-asymmetric-pair ec** comando para criar um par de chaves EC.

**Example Exemplo: criar um par de chaves EC**  

```
aws-cloudhsm > key generate-asymmetric-pair ec \
    --curve secp224r1 \
    --public-label ec-public-key-example \
    --private-label ec-private-key-example
{
  "error_code": 0,
  "data": {
    "public_key": {
      "key-reference": "0x000000000012000b",
      "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": "ec",
        "label": "ec-public-key-example",
        "id": "",
        "check-value": "0xd7c1a7",
        "class": "public-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": false,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 57,
        "ec-point": "0x047096513df542250a6b228fd9cb67fd0c903abc93488467681974d6f371083fce1d79da8ad1e9ede745fb9f38ac8622a1b3ebe9270556000c",
        "curve": "secp224r1"
      }
    },
"private_key": {
      "key-reference": "0x000000000012000c",
      "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": "ec",
        "label": "ec-private-key-example",
        "id": "",
        "check-value": "0xd7c1a7",
        "class": "private-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": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 122,
        "ec-point": "0x047096513df542250a6b228fd9cb67fd0c903abc93488467681974d6f371083fce1d79da8ad1e9ede745fb9f38ac8622a1b3ebe9270556000c",
        "curve": "secp224r1"
      }
    }
  }
}
```

**Example Exemplo: criar um par de chaves EC com atributos opcionais**  

```
aws-cloudhsm > key generate-asymmetric-pair ec \
    --curve secp224r1 \
    --public-label ec-public-key-example \
    --private-label ec-private-key-example \
    --public-attributes encrypt=true \
    --private-attributes decrypt=true
{
  "error_code": 0,
  "data": {
    "public_key": {
      "key-reference": "0x00000000002806eb",
      "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": "ec",
        "label": "ec-public-key-example",
        "id": "",
        "check-value": "0xedef86",
        "class": "public-key",
        "encrypt": true,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": false,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 57,
        "ec-point": "0x0487af31882189ec29eddf17a48e8b9cebb075b7b5afc5522fe9c83a029a450cc68592889a1ebf45f32240da5140d58729ffd7b2d44262ddb8",
        "curve": "secp224r1"
      }
    },
    "private_key": {
      "key-reference": "0x0000000000280c82",
      "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": "ec",
        "label": "ec-private-key-example",
        "id": "",
        "check-value": "0xedef86",
        "class": "private-key",
        "encrypt": false,
        "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": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 122,
        "ec-point": "0x0487af31882189ec29eddf17a48e8b9cebb075b7b5afc5522fe9c83a029a450cc68592889a1ebf45f32240da5140d58729ffd7b2d44262ddb8",
        "curve": "secp224r1"
      }
    }
  }
}
```

**Example Exemplo: criar um par de chaves EC 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-asymmetric-pair ec \
    --curve secp224r1 \
    --public-label ec-public-key-example \
    --private-label ec-private-key-example \
    --public-attributes verify=true \
    --private-attributes sign=true
    --share-crypto-users cu2 cu3 cu4 \
    --manage-private-key-quorum-value 4 \
    --use-private-key-quorum-value 2
{
  "error_code": 0,
  "data": {
    "public_key": {
      "key-reference": "0x00000000002806eb",
      "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": "ec",
        "label": "ec-public-key-example",
        "id": "",
        "check-value": "0xedef86",
        "class": "public-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": false,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 57,
        "ec-point": "0x0487af31882189ec29eddf17a48e8b9cebb075b7b5afc5522fe9c83a029a450cc68592889a1ebf45f32240da5140d58729ffd7b2d44262ddb8",
        "curve": "secp224r1"
      }
    },
    "private_key": {
      "key-reference": "0x0000000000280c82",
      "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": "ec",
        "label": "ec-private-key-example",
        "id": "",
        "check-value": "0xedef86",
        "class": "private-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": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 122,
        "ec-point": "0x0487af31882189ec29eddf17a48e8b9cebb075b7b5afc5522fe9c83a029a450cc68592889a1ebf45f32240da5140d58729ffd7b2d44262ddb8",
        "curve": "secp224r1"
      }
    }
  }
}
```

## Argumentos
<a name="key-generate-asymmetric-pair-ec-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<CURVE>***  
Especifica o identificador da curva elíptica.  
+ prime256v1
+ secp256r1
+ secp224r1
+ secp384r1
+ secp256k1
+ secp521r1
+ ed25519 (compatível somente em instâncias hsm2m.medium no modo não FIPS)
Obrigatório: Sim

***<PUBLIC\$1KEY\$1ATTRIBUTES>***  
Especifica uma lista separada por espaços dos principais atributos a serem definidos para a chave pública EC gerada na forma de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` (por exemplo, `verify=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

***<PUBLIC\$1LABEL>***  
Especifica um rótulo definido pelo usuário para a chave pública. 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

***<PRIVATE\$1KEY\$1ATTRIBUTES>***  
Especifica uma lista separada por espaços dos principais atributos a serem definidos para a chave privada EC 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

***<PRIVATE\$1LABEL>***  
Especifica o rótulo da chave privada definida pelo usuário. 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\$1CRYPTO\$1USERS>***  
Especifica uma lista separada por espaços de nomes de usuário dos Usuários de criptografia com os quais compartilhar a chave privada EC  
Obrigatório: não

***<MANAGE\$1PRIVATE\$1KEY\$1QUORUM\$1VALUE>***  
O valor do quórum para as operações de gerenciamento da chave privada. 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\$1PRIVATE\$1KEY\$1QUORUM\$1VALUE>***  
O valor do quórum para as operações de uso da chave privada. 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-asymmetric-pair-ec-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)

# Gerar um par de chaves assimétricas RSA com a CloudHSM CLI
<a name="cloudhsm_cli-key-generate-asymmetric-pair-rsa"></a>

Use o **key generate-asymmetric-pair rsa** comando na CLI do CloudHSM para gerar um par de chaves RSA assimétrico em seu cluster. AWS CloudHSM 

## Tipo de usuário
<a name="key-generate-asymmetric-pair-rsa-userType"></a>

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

## Requisitos
<a name="key-generate-asymmetric-pair-rsa-requirements"></a>

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

## Sintaxe
<a name="key-generate-asymmetric-pair-rsa-syntax"></a>

```
aws-cloudhsm > help key generate-asymmetric-pair rsa
Generate an RSA key pair

Usage: key generate-asymmetric-pair rsa [OPTIONS] --public-label <PUBLIC_LABEL> --private-label <PRIVATE_LABEL> --modulus-size-bits <MODULUS_SIZE_BITS> --public-exponent <PUBLIC_EXPONENT>

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
      --public-label <PUBLIC_LABEL>
          Label for the public key
      --private-label <PRIVATE_LABEL>
          Label for the private key
      --session
          Creates a session key pair that exists only in the current session. The key cannot be recovered after the session ends
      --modulus-size-bits <MODULUS_SIZE_BITS>
          Modulus size in bits used to generate the RSA key pair
      --public-exponent <PUBLIC_EXPONENT>
          Public exponent used to generate the RSA key pair
      --public-attributes [<PUBLIC_KEY_ATTRIBUTES>...]
          Space separated list of key attributes to set for the generated RSA public key in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE
      --private-attributes [<PRIVATE_KEY_ATTRIBUTES>...]
          Space separated list of key attributes to set for the generated RSA private 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 RSA key with
      --manage-private-key-quorum-value <MANAGE_PRIVATE_KEY_QUORUM_VALUE>
          The quorum value for key management operations for the private key
      --use-private-key-quorum-value <USE_PRIVATE_KEY_QUORUM_VALUE>
          The quorum value for key usage operations for the private key
  -h, --help
          Print help
```

## Exemplos
<a name="key-generate-asymmetric-pair-rsa-examples"></a>

Esses exemplos mostram como usar `key generate-asymmetric-pair rsa` para criar um par de chaves RSA.

**Example Exemplo: criar um par de chaves RSA**  

```
aws-cloudhsm > key generate-asymmetric-pair rsa \
--public-exponent 65537 \
--modulus-size-bits 2048 \
--public-label rsa-public-key-example \
--private-label rsa-private-key-example
{
  "error_code": 0,
  "data": {
    "public_key": {
      "key-reference": "0x0000000000160010",
      "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": "rsa",
        "label": "rsa-public-key-example",
        "id": "",
        "check-value": "0x498e1f",
        "class": "public-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": false,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 512,
        "public-exponent": "0x010001",
        "modulus": "0xdfca0669dc8288ed3bad99509bd21c7e6192661407021b3f4cdf4a593d939dd24f4d641af8e4e73b04c847731c6dbdff3385818e08dd6efcbedd6e5b130344968c
e89a065e7d1a46ced96b46b909db2ab6be871ee700fd0a448b6e975bb64cae77c49008749212463e37a577baa57ce3e574cb057e9db131e119badf50c938f26e8a5975c61a8ba7ffe7a1115a
bcebb7d20bd6df1948ae336ae23b52d73b7f3b6acc2543edb6358e08d326d280ce489571f4d34e316a2ea1904d513ca12fa04075fc09ad005c81b7345d7804ff24c45117f0a1020dca7794df037a10aadec8653473b2088711f7b7d8b58431654e14e31af0e00511da641058fb7475ffdbe60f",
        "modulus-size-bits": 2048
      }
    },
"private_key": {
      "key-reference": "0x0000000000160011",
      "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": "rsa",
        "label": "rsa-private-key-example",
        "id": "",
        "check-value": "0x498e1f",
        "class": "private-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": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 1217,
        "public-exponent": "0x010001",
        "modulus": "0xdfca0669dc8288ed3bad99509bd21c7e6192661407021b3f4cdf4a593d939dd24f4d641af8e4e73b04c847731c6dbdff3385818e08dd6efcbedd6e5b130344968ce89a065e7d1a46ced96b46b909db2ab6be871ee700fd0a448b6e975bb64cae77c49008749212463e37a577baa57ce3e574cb057e9db131e119badf50c938f26e8a5975c61a8ba7ffe7a1115abcebb7d20bd6df1948ae336ae23b52d73b7f3b6acc2543edb6358e08d326d280ce489571f4d34e316a2ea1904d513ca12fa04075fc09ad005c81b7345d7804ff24c45117f0a1020dca7794df037a10aadec8653473b2088711f7b7d8b58431654e14e31af0e00511da641058fb7475ffdbe60f",
        "modulus-size-bits": 2048
      }
    }
  }
}
```

**Example Exemplo: criar um par de chaves RSA com atributos opcionais**  

```
aws-cloudhsm > key generate-asymmetric-pair rsa \
--public-exponent 65537 \
--modulus-size-bits 2048 \
--public-label rsa-public-key-example \
--private-label rsa-private-key-example \
--public-attributes encrypt=true \
--private-attributes decrypt=true
{
  "error_code": 0,
  "data": {
    "public_key": {
      "key-reference": "0x0000000000280cc8",
      "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": "rsa",
        "label": "rsa-public-key-example",
        "id": "",
        "check-value": "0x01fe6e",
        "class": "public-key",
        "encrypt": true,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": false,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 512,
        "public-exponent": "0x010001",
        "modulus": "0xb1d27e857a876f4e9fd5de748a763c539b359f937eb4b4260e30d1435485a732c878cdad9c72538e2215351b1d41358c9bf80b599c
73a80fdb457aa7b20cd61e486c326e2cfd5e124a7f6a996437437812b542e3caf85928aa866f0298580f7967ee6aa01440297d7308fdd9b76b70d1b67f12634d
f6e6296d6c116d5744c6d60d14d3bf3cb978fe6b75ac67b7089bafd50d8687213b31abc7dc1bad422780d29c851d5102b56f932551eaf52a9591fd8c43d81ecc
133022653225bd129f8491101725e9ea33e1ded83fb57af35f847e532eb30cd7e726f23910d2671c6364092e834697ec3cef72cc23615a1ba7c5e100156ae0ac
ac3160f0ca9725d38318b7",
        "modulus-size-bits": 2048
      }
    },
    "private_key": {
      "key-reference": "0x0000000000280cc7",
      "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": "rsa",
        "label": "rsa-private-key-example",
        "id": "",
        "check-value": "0x01fe6e",
        "class": "private-key",
        "encrypt": false,
        "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": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 1217,
        "public-exponent": "0x010001",
        "modulus": "0xb1d27e857a876f4e9fd5de748a763c539b359f937eb4b4260e30d1435485a732c878cdad9c72538e2215351b1d41358c9bf80b599c73a80fdb457aa7b20cd61e486c326e2cfd5e124a7f6a996437437812b542e3caf85928aa866f0298580f7967ee6aa01440297d7308fdd9b76b70d1b67f12634df6e6296d6c116d5744c6d60d14d3bf3cb978fe6b75ac67b7089bafd50d8687213b31abc7dc1bad422780d29c851d5102b56f932551eaf52a9591fd8c43d81ecc133022653225bd129f8491101725e9ea33e1ded83fb57af35f847e532eb30cd7e726f23910d2671c6364092e834697ec3cef72cc23615a1ba7c5e100156ae0acac3160f0ca9725d38318b7",
        "modulus-size-bits": 2048
      }
    }
  }
}
```

**Example Exemplo: criar um par de chaves RSA 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-asymmetric-pair rsa \
--public-exponent 65537 \
--modulus-size-bits 2048 \
--public-label rsa-public-key-example \
--private-label rsa-private-key-example \
--public-attributes verify=true \
--private-attributes sign=true
--share-crypto-users cu2 cu3 cu4 \
--manage-private-key-quorum-value 4 \
--use-private-key-quorum-value 2
{
  "error_code": 0,
  "data": {
    "public_key": {
      "key-reference": "0x0000000000280cc8",
      "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": "rsa",
        "label": "rsa-public-key-example",
        "id": "",
        "check-value": "0x01fe6e",
        "class": "public-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": false,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 512,
        "public-exponent": "0x010001",
        "modulus": "0xb1d27e857a876f4e9fd5de748a763c539b359f937eb4b4260e30d1435485a732c878cdad9c72538e2215351b1d41358c9bf80b599c
73a80fdb457aa7b20cd61e486c326e2cfd5e124a7f6a996437437812b542e3caf85928aa866f0298580f7967ee6aa01440297d7308fdd9b76b70d1b67f12634d
f6e6296d6c116d5744c6d60d14d3bf3cb978fe6b75ac67b7089bafd50d8687213b31abc7dc1bad422780d29c851d5102b56f932551eaf52a9591fd8c43d81ecc
133022653225bd129f8491101725e9ea33e1ded83fb57af35f847e532eb30cd7e726f23910d2671c6364092e834697ec3cef72cc23615a1ba7c5e100156ae0ac
ac3160f0ca9725d38318b7",
        "modulus-size-bits": 2048
      }
    },
    "private_key": {
      "key-reference": "0x0000000000280cc7",
      "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": "rsa",
        "label": "rsa-private-key-example",
        "id": "",
        "check-value": "0x01fe6e",
        "class": "private-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": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 1217,
        "public-exponent": "0x010001",
        "modulus": "0xb1d27e857a876f4e9fd5de748a763c539b359f937eb4b4260e30d1435485a732c878cdad9c72538e2215351b1d41358c9bf80b599c73a80fdb457aa7b20cd61e486c326e2cfd5e124a7f6a996437437812b542e3caf85928aa866f0298580f7967ee6aa01440297d7308fdd9b76b70d1b67f12634df6e6296d6c116d5744c6d60d14d3bf3cb978fe6b75ac67b7089bafd50d8687213b31abc7dc1bad422780d29c851d5102b56f932551eaf52a9591fd8c43d81ecc133022653225bd129f8491101725e9ea33e1ded83fb57af35f847e532eb30cd7e726f23910d2671c6364092e834697ec3cef72cc23615a1ba7c5e100156ae0acac3160f0ca9725d38318b7",
        "modulus-size-bits": 2048
      }
    }
  }
}
```

## Argumentos
<a name="key-generate-asymmetric-pair-rsa-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<MODULUS\$1SIZE\$1BITS>***  
 Especifica o comprimento do módulo em bits. O valor mínimo é 2048.   
Obrigatório: Sim

***<PRIVATE\$1KEY\$1ATTRIBUTES>***  
Especifica uma lista separada por espaços dos atributos de chave a serem definidos para a chave privada RSA 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

***<PRIVATE\$1LABEL>***  
 Especifica o rótulo da chave privada definida pelo usuário. 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

***<PUBLIC\$1EXPONENT>***  
Especifica o expoente público. O valor deve ser um número ímpar maior que ou igual a 65537.  
Obrigatório: Sim

***<PUBLIC\$1KEY\$1ATTRIBUTES>***  
Especifica uma lista separada por espaços dos atributos de chave a serem definidos para a chave pública RSA gerada na forma de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` (por exemplo, `verify=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

***<PUBLIC\$1LABEL>***  
 Especifica um rótulo definido pelo usuário para a chave pública. 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\$1CRYPTO\$1USERS>***  
Especifica uma lista separada por espaços de nomes de usuário dos Usuários de criptografia com os quais compartilhar a chave privada RSA  
Obrigatório: não

***<MANAGE\$1PRIVATE\$1KEY\$1QUORUM\$1VALUE>***  
O valor do quórum para as operações de gerenciamento da chave privada. 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\$1PRIVATE\$1KEY\$1QUORUM\$1VALUE>***  
O valor do quórum para as operações de uso da chave privada. 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-asymmetric-pair-rsa-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)

# A categoria generate-symmetric na CLI do CloudHSM
<a name="cloudhsm_cli-key-generate-symmetric"></a>

Na CLI do CloudHSM, **key generate-symmetric** é uma categoria principal para um grupo de comandos que, quando combinados com a categoria principal, criam um comando que gera chaves simétricas. Atualmente, essa categoria consiste nos seguintes comandos:
+ [key generate-symmetric aes](cloudhsm_cli-key-generate-symmetric-aes.md)
+ [key generate-symmetric generic-secret](cloudhsm_cli-key-generate-symmetric-generic-secret.md)

# 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\$1ID>***  
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\$1ATTRIBUTES>***  
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\$1CRYPTO\$1USERS>***  
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\$1KEY\$1QUORUM\$1VALUE>***  
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\$1KEY\$1QUORUM\$1VALUE>***  
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)

# Gerar uma chave secreta genérica simétrica com a CloudHSM CLI
<a name="cloudhsm_cli-key-generate-symmetric-generic-secret"></a>

Use o **key generate-symmetric generic-secret** comando na CLI do CloudHSM para gerar uma chave secreta genérica simétrica em seu cluster. AWS CloudHSM 

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

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

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

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

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

```
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
      --share-crypto-users [<SHARE_CRYPTO_USERS>...]
          Space separated list of Crypto User usernames to share the generic secret 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-generic-secret-examples"></a>

Estes exemplos mostram como usar o comando **key generate-symmetric generic-secret** para criar uma chave secreta genérica.

**Example Exemplo: criar uma chave 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": [],
        "key-quorum-values": {
          "manage-key-quorum-value": 0,
          "use-key-quorum-value": 0
        },
        "cluster-coverage": "full"
      },
      "attributes": {
        "key-type": "generic-secret",
        "label": "example-generic-secret",
        "id": "",
        "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": 256
      }
    }
  }
}
```

**Example Exemplo: criar uma chave secreta genérica com atributos opcionais**  

```
aws-cloudhsm > key generate-symmetric generic-secret \
--label example-generic-secret \
--key-length-bytes 256 \
--attributes encrypt=true
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000002e08fd",
      "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": "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
      }
    }
  }
}
```

**Example Exemplo: criar uma chave secreta genérica 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 generic-secret \
--label example-generic-secret \
--key-length-bytes 256 \
--attributes 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": "0x00000000002e08fd",
      "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": "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
<a name="key-generate-symmetric-generic-secret-arguments"></a>

***<CLUSTER\$1ID>***  
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\$1ATTRIBUTES>***  
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:
+ 1 a 800
Obrigatório: Sim

***<LABEL>***  
Especifica um rótulo definido pelo usuário para a chave secreta genérica. 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\$1CRYPTO\$1USERS>***  
Lista separada por espaço de nomes de usuário dos Usuários de criptografia com os quais compartilhar a chave secreta genérica  
Obrigatório: não

***<MANAGE\$1KEY\$1QUORUM\$1VALUE>***  
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\$1KEY\$1QUORUM\$1VALUE>***  
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-generic-secret-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)

# Importar uma chave no formato PEM com a CLI do CloudHSM
<a name="cloudhsm_cli-key-import-pem"></a>

Use o **key import pem** comando in AWS CloudHSM para importar uma chave de formato PEM para um módulo de segurança de hardware (HSM). Você pode usá-lo para importar chaves públicas que foram geradas fora do HSM.

**nota**  
Use o comando [Exportar uma chave assimétrica com a CloudHSM CLI](cloudhsm_cli-key-generate-file.md) para criar um arquivo PEM padrão a partir de uma chave pública ou para criar um arquivo PEM de referência a partir de uma chave privada.

## Tipo de usuário
<a name="cloudhsm_cli-key-import-pem-user-type"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-import-pem-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-import-pem-syntax"></a>

```
aws-cloudhsm > help key import pem
Import key from a PEM file

Usage: key import pem [OPTIONS] --path <PATH> --label <LABEL> --key-type-class <KEY_TYPE_CLASS>
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
      --path <PATH>
          Path where the key is located in PEM format
      --label <LABEL>
          Label for the imported key
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of the imported key [possible values: ec-public, rsa-public]
      --attributes [<IMPORT_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the imported key
  -h, --help
          Print help
```

## Exemplos
<a name="cloudhsm_cli-key-import-pem-examples"></a>

Este exemplo mostra como usar o comando **key import pem** para importar uma chave pública RSA de um arquivo no formato PEM.

**Example Exemplo: importar uma chave pública RSA**  

```
aws-cloudhsm > key import pem --path /home/example --label example-imported-key --key-type-class rsa-public
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001e08e3",
      "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": "rsa",
        "label": "example-imported-key",
        "id": "0x",
        "check-value": "0x99fe93",
        "class": "public-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": false,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": false,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 512,
        "public-exponent": "0x010001",
        "modulus": "0x8e9c172c37aa22ed1ce25f7c3a7c936dadc532201400128b044ebb4b96│··3e4930ab910df5a2896eaeb8853cfea0e341227654a8337a7864cc8a87d136f006cfba9e68d0b329│··746c1ad60941668b18699fc8169ff1ec363d0d18292845b2454d6a0b8c5d111b79c047619d460cdf│··be59debbacb66b7abeaf3f3d35dd2b9cfa6b6b7b1258b6866cb4085ac749e9d8552b3a4509e1b86c│··828cc794e22767b4f6b5bc6ff5c96f4b7e60eab305d669cfa2197e85379cb35c659bb58fcd246d48│··d9f6a7f36063b42da025459275aa8e3abedad775387086bd6c198ded868403f4b87ffda5a2d455ac│··aa6cbd00003c31d8d2f51d10cd272b31cf0c4037791f48ad51fb35",
        "modulus-size-bits": 2048
      }
    },
    "message": "Successfully imported key"
  }
}
```

**Example Exemplo: importar uma chave pública RSA com atributos opcionais**  

```
aws-cloudhsm > key import pem --path /home/example --label example-imported-key-with-attributes --key-type-class rsa-public --attributes verify=true
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001e08e3",
      "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": "rsa",
        "label": "example-imported-key-with-attributes",
        "id": "0x",
        "check-value": "0x99fe93",
        "class": "public-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "modifiable": true,
        "never-extractable": false,
        "private": true,
        "sensitive": false,
        "sign": false,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 512,
        "public-exponent": "0x010001",
        "modulus": "0x8e9c172c37aa22ed1ce25f7c3a7c936dadc532201400128b044ebb4b96│··3e4930ab910df5a2896eaeb8853cfea0e341227654a8337a7864cc8a87d136f006cfba9e68d0b329│··746c1ad60941668b18699fc8169ff1ec363d0d18292845b2454d6a0b8c5d111b79c047619d460cdf│··be59debbacb66b7abeaf3f3d35dd2b9cfa6b6b7b1258b6866cb4085ac749e9d8552b3a4509e1b86c│··828cc794e22767b4f6b5bc6ff5c96f4b7e60eab305d669cfa2197e85379cb35c659bb58fcd246d48│··d9f6a7f36063b42da025459275aa8e3abedad775387086bd6c198ded868403f4b87ffda5a2d455ac│··aa6cbd00003c31d8d2f51d10cd272b31cf0c4037791f48ad51fb35",
        "modulus-size-bits": 2048
      }
    },
    "message": "Successfully imported key"
  }
}
```

## Argumentos
<a name="cloudhsm_cli-key-import-pem-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<PATH>***  
Especifica o caminho em que o arquivo de chave está localizado.  
Obrigatório: Sim

***<LABEL>***  
Especifica o rótulo definido pelo usuário para a chave importada. O tamanho máximo para `label` é de 126 caracteres.  
Obrigatório: Sim

***<KEY\$1TYPE\$1CLASS>***  
Tipo e classe da chave encapsulada.  
Possíveis valores:  
+ ec-public
+ rsa-public
Obrigatório: Sim

***<IMPORT\$1KEY\$1ATTRIBUTES>***  
Especifica uma lista separada por espaços dos atributos de chave a serem definidos para a chave importada 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

## Tópicos relacionados
<a name="cloudhsm_cli-key-import-pem-seealso"></a>
+ [A categoria de assinatura criptográfica na CLI do CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [A categoria de verificação de criptografia na CLI do CloudHSM](cloudhsm_cli-crypto-verify.md)

# Listar chaves para um usuário com a CloudHSM CLI
<a name="cloudhsm_cli-key-list"></a>

Use o **key list** comando na CLI do CloudHSM para encontrar todas as chaves do usuário atual presente em seu cluster. AWS CloudHSM A saída inclui chaves que o usuário possui e compartilha, bem como todas as chaves públicas no cluster CloudHSM.

## Tipo de usuário
<a name="chsm-cli-key-list-user-type"></a>

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

## Sintaxe
<a name="chsm-cli-key-list-syntax"></a>

```
aws-cloudhsm > help key list
List the keys the current user owns, shares, and all public keys in the HSM cluster

Usage: key list [OPTIONS]

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 matching key(s) to list
      --max-items <MAX_ITEMS>
          The total number of items to return in the command's output. If the total number of items available is more than the value specified, a next-token is provided in the command's output. To resume pagination, provide the next-token value in the starting-token argument of a subsequent command [default: 10]
      --starting-token <STARTING_TOKEN>
          A token to specify where to start paginating. This is the next-token from a previously truncated response
  -v, --verbose
          If included, prints all attributes and key information for each matched key. By default each matched key only displays its key-reference and label attribute. This flag when used by Admins has no effect
  -h, --help
          Print help
```

## Exemplos
<a name="chsm-cli-key-list-examples"></a>

Os exemplos a seguir mostram as diferentes maneiras de executar o comando **key list**. Os exemplos a seguir mostram as saídas como um usuário de criptografia.

**Example Exemplo: descobrir todas as chaves – padrão**  
Esse comando lista as chaves do usuário conectado presente no AWS CloudHSM cluster.  
Por padrão, somente 10 chaves do usuário atualmente conectado são exibidas, e somente o `key-reference` e `label` são exibidos como saída. Use as opções de paginação apropriadas para exibir mais ou menos teclas como saída.

```
aws-cloudhsm > key list
{
  "error_code": 0,
  "data": {
    "matched_keys": [
      {
        "key-reference": "0x00000000000003d5",
        "attributes": {
          "label": "test_label_1"
        }
      },
      {
        "key-reference": "0x0000000000000626",
        "attributes": {
          "label": "test_label_2"
        }
      },.
      ...8 keys later...
    ],
    "total_key_count": 56,
    "returned_key_count": 10,
    "next_token": "10"
  }
}
```

**Example Exemplo: encontrar todas as chaves – detalhado**  
A saída inclui chaves que o usuário possui e compartilha, bem como todas as chaves públicas no HSMs.  
Observação: por padrão, somente 10 chaves do usuário atualmente conectado são exibidas. Use as opções de paginação apropriadas para exibir mais ou menos teclas como saída.

```
aws-cloudhsm > key list --verbose
{
  "error_code": 0,
  "data": {
    "matched_keys": [
      {
        "key-reference": "0x000000000012000c",
        "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": "ec",
          "label": "ec-test-private-key",
          "id": "",
          "check-value": "0x2a737d",
          "class": "private-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": false,
          "trusted": false,
          "unwrap": false,
          "verify": false,
          "wrap": false,
          "wrap-with-trusted": false,
          "key-length-bytes": 122,
          "ec-point": "0x0442d53274a6c0ec1a23c165dcb9ccdd72c64e98ae1a9594bb5284e752c746280667e11f1e983493c1c605e0a8071ede47ca280f94c6b2aa33",
          "curve": "secp224r1"
        }
      },
      {
        "key-reference": "0x000000000012000d",
        "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": "ec",
          "label": "ec-test-public-key",
          "id": "",
          "check-value": "0x2a737d",
          "class": "public-key",
          "encrypt": false,
          "decrypt": false,
          "token": true,
          "always-sensitive": false,
          "derive": false,
          "destroyable": true,
          "extractable": true,
          "local": true,
          "modifiable": true,
          "never-extractable": false,
          "private": true,
          "sensitive": false,
          "sign": false,
          "trusted": false,
          "unwrap": false,
          "verify": false,
          "wrap": false,
          "wrap-with-trusted": false,
          "key-length-bytes": 57,
          "ec-point": "0x0442d53274a6c0ec1a23c165dcb9ccdd72c64e98ae1a9594bb5284e752c746280667e11f1e983493c1c605e0a8071ede47ca280f94c6b2aa33",
          "curve": "secp224r1"
        }
      }
    ],
      ...8 keys later...
    "total_key_count": 1580,
    "returned_key_count": 10
  }
}
```

**Example Exemplo: retorno paginado**  
O exemplo a seguir exibe um subconjunto paginado das chaves que mostra somente duas chaves. Em seguida, o exemplo fornece uma chamada subsequente para exibir as próximas duas teclas.  

```
aws-cloudhsm > key list --verbose --max-items 2
{
  "error_code": 0,
  "data": {
    "matched_keys": [
      {
        "key-reference": "0x0000000000000030",
        "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": "98a6688d1d964ed7b45b9cec5c4b1909",
          "id": "",
          "check-value": "0xb28a46",
          "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": 32
        }
      },
      {
        "key-reference": "0x0000000000000042",
        "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": "4ad6cdcbc02044e09fa954143efde233",
          "id": "",
          "check-value": "0xc98104",
          "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": true,
          "verify": true,
          "wrap": true,
          "wrap-with-trusted": false,
          "key-length-bytes": 16
        }
      }
    ],
    "total_key_count": 1580,
    "returned_key_count": 2,
    "next_token": "2"
  }
}
```
Para exibir as próximas 2 teclas, uma chamada subsequente pode ser feita:  

```
aws-cloudhsm > key list --verbose --max-items 2 --starting-token 2
{
  "error_code": 0,
  "data": {
    "matched_keys": [
      {
        "key-reference": "0x0000000000000081",
        "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": "6793b8439d044046982e5b895791e47f",
          "id": "",
          "check-value": "0x3f986f",
          "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": 32
        }
      },
      {
        "key-reference": "0x0000000000000089",
        "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": "56b30fa05c6741faab8f606d3b7fe105",
          "id": "",
          "check-value": "0xe9201a",
          "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": 32
        }
      }
    ],
    "total_key_count": 1580,
    "returned_key_count": 2,
    "next_token": "4"
  }
}
```
Para ver mais exemplos que demonstram como o mecanismo de filtragem de chaves funciona na CloudHSM CLI, consulte [Filtrar chaves usando a CLI do CloudHSM](manage-keys-cloudhsm-cli-filtering.md).

## Argumentos
<a name="key-list-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chaves na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para selecionar chaves correspondentes à lista.  
Para obter uma lista dos atributos de chave compatíveis com a CloudHSM CLI, consulte [Atributos de chave da CloudHSM CLI](cloudhsm_cli-key-attributes.md)  
Obrigatório: não

***<MAX\$1ITEMS>***  
O número total de itens para retornar na saída do comando. Se o número total de itens disponíveis for maior que o valor especificado, um NextToken é fornecido na saída do comando. Para retomar a paginação, forneça o valor do NextToken no argumento starting-token de um comando subsequente.  
Obrigatório: não

***<STARTING\$1TOKEN>***  
Um token para especificar onde iniciar a paginação. Esse é o NextToken de uma resposta truncada anteriormente.  
Obrigatório: não

***<VERBOSE>***  
Se incluído, imprime todos os atributos e as principais informações de cada chave correspondente. Por padrão, cada chave correspondente exibe apenas sua referência de chave e atributo de rótulo. Esse sinalizador, quando usado por administradores, não tem efeito.  
Obrigatório: não

## Tópicos relacionados
<a name="chsm-key-list-seealso"></a>
+ [Excluir uma chave com a CLI do CloudHSM](cloudhsm_cli-key-delete.md)
+ [Exportar uma chave assimétrica com a CloudHSM CLI](cloudhsm_cli-key-generate-file.md)
+ [Cancelar o compartilhamento de uma chave usando a CloudHSM CLI](cloudhsm_cli-key-unshare.md)
+ [Atributos de chave da CloudHSM CLI](cloudhsm_cli-key-attributes.md)
+ [Filtrar chaves usando a CLI do CloudHSM](manage-keys-cloudhsm-cli-filtering.md)

# Replicar uma chave com a CLI do CloudHSM
<a name="cloudhsm_cli-key-replicate"></a>

Use o **key replicate** comando na CLI do CloudHSM para replicar uma chave de um cluster de origem para um cluster de destino AWS CloudHSM . AWS CloudHSM 

## Tipo de usuário
<a name="chsm-cli-key-replicate-user-type"></a>

Os seguintes tipos de usuários podem executar este comando.
+ Administradores () COs
+ Usuários de criptomoedas (CUs)
**nota**  
Os usuários criptográficos devem possuir a chave para usar esse comando.

## Requisitos
<a name="cloudhsm_cli-key-replicate-requirements"></a>
+ Os clusters de origem e destino devem ser clones. Isso significa que um foi criado a partir de um backup do outro, ou ambos foram criados a partir de um backup comum. Consulte [Criar clusters de backups](create-cluster-from-backup.md) para obter mais informações.
+ O proprietário da chave deve existir no cluster de destino. Além disso, se a chave for compartilhada com quaisquer usuários, esses usuários também deverão existir no cluster de destino.
+ Para executar esse comando, é necessário estar registrado como usuário de criptografia ou administrador nos clusters de origem e de destino.
  +  No modo de comando único, o comando usará as variáveis ambientais CLOUDHSM\$1PIN e CLOUDHSM\$1ROLE para se autenticar no cluster de origem. Consulte [Modo de comando único](cloudhsm_cli-modes.md#cloudhsm_cli-mode-single-command) para obter mais informações. Para fornecer credenciais ao cluster de destino, é preciso definir duas variáveis ambientais adicionais: DESTINATION\$1CLOUDHSM\$1PIN e DESTINATION\$1CLOUDHSM\$1ROLE:

    ```
    $ export DESTINATION_CLOUDHSM_ROLE=<role>
    ```

    ```
    $ export DESTINATION_CLOUDHSM_PIN=<username:password>
    ```
  +  No modo interativo, os usuários precisarão fazer login explícito nos clusters de origem e de destino.

## Sintaxe
<a name="chsm-cli-key-replicate-syntax"></a>

```
aws-cloudhsm > help key replicate
Replicate a key from a source to a destination cluster

Usage: key replicate --filter [<FILTER>...] --source-cluster-id <SOURCE_CLUSTER_ID> --destination-cluster-id <DESTINATION_CLUSTER_ID>

Options:
      --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 matching key on the source cluster
      --source-cluster-id <SOURCE_CLUSTER_ID>
          Source cluster ID
      --destination-cluster-id <DESTINATION_CLUSTER_ID>
          Destination cluster ID
  -h, --help
          Print help
```

## Exemplos
<a name="chsm-cli-key-replicate-examples"></a>

**Example Exemplo: replicar chave**  
Esse comando replica uma chave de um cluster de origem para um cluster de destino clonado. O exemplo abaixo demonstra a saída quando conectado como usuário criptográfico em ambos os clusters.  

```
crypto-user-1@cluster-1234abcdefg > key replicate \
      --filter attr.label=example-key \
      --source-cluster-id cluster-1234abcdefg \
      --destination-cluster-id cluster-2345bcdefgh
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x0000000000300006",
      "key-info": {
        "key-owners": [
          {
            "username": "crypto-user-1",
            "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-key",
        "id": "0x",
        "check-value": "0x5e118e",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": true,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": true,
        "modifiable": true,
        "never-extractable": true,
        "private": true,
        "sensitive": true,
        "sign": true,
        "trusted": false,
        "unwrap": false,
        "verify": true,
        "wrap": false,
        "wrap-with-trusted": false,
        "key-length-bytes": 16
      }
    },
    "message": "Successfully replicated key"
  }
}
```

## Argumentos
<a name="key-replicate-arguments"></a>

***<FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para selecionar uma chave correspondente no cluster de origem.  
Para obter uma lista dos atributos de chave compatíveis com a CloudHSM CLI, consulte [Atributos de chave da CloudHSM CLI](cloudhsm_cli-key-attributes.md)  
Obrigatório: Sim

***<SOURCE\$1CLUSTER\$1ID>***  
O ID do cluster de origem.  
Obrigatório: Sim

***<DESTINATION\$1CLUSTER\$1ID>***  
O ID do cluster de destino.  
Obrigatório: Sim

## Tópicos relacionados
<a name="chsm-key-replicate-seealso"></a>
+ [Conectar-se a vários clusters com a CLI do CloudHSM](cloudhsm_cli-configs-multi-cluster.md)

# Definir os atributos das chaves com a CloudHSM CLI
<a name="cloudhsm_cli-key-set-attribute"></a>

Use o **key set-attribute** comando na CLI do CloudHSM para definir os atributos das chaves no seu cluster. AWS CloudHSM Somente o CU que criou a chave e, consequentemente, a possui pode alterar os atributos da chave.

Para obter uma lista dos principais atributos que podem ser usados na CloudHSM CLI, consulte [Atributos de chave da CloudHSM CLI](cloudhsm_cli-key-attributes.md).

## Tipo de usuário
<a name="chsm-cli-key-set-attribute-user-type"></a>

Os seguintes tipos de usuários podem executar este comando.
+ Usuários criptográficos (CUs) podem executar esse comando.
+ Os administradores podem definir o atributo confiável.

## Requisitos
<a name="chsm-cli-key-set-attribute-requirements"></a>

Para executar esse comando, você deve estar registrado como um CU. Para definir o atributo confiável, você deve estar logado como um usuário administrador.

## Sintaxe
<a name="chsm-cli-key-set-attribute-syntax"></a>

```
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
      --approval <APPROVAL>            Filepath of signed quorum token file to approve operation
  -h, --help                            Print help
```

## Exemplo: configuração de um atributo de chave
<a name="chsm-cli-key-set-attribute-examples"></a>

O exemplo a seguir mostra como usar o comando **key set-attribute** para definir o rótulo.

**Example**  

1. Use a chave com o rótulo `my_key`, conforme mostrado aqui:

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

1. Use o comando **key list** para confirmar que o atributo `encrypt` foi alterado:

   ```
   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": [],
           "key-quorum-values": {
             "manage-key-quorum-value": 0,
             "use-key-quorum-value": 0
           },
             "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
<a name="chsm-cli-key-set-attribute-arguments"></a>

***<CLUSTER\$1ID>***  
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\$1ATTRIBUTE>***  
Especifica o nome do atributo de chave.  
Obrigatório: Sim

***<FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para selecionar uma chave correspondente para exclusão.  
Para obter uma lista dos atributos de chave compatíveis com a CloudHSM CLI, consulte [Atributos de chave da CloudHSM CLI](cloudhsm_cli-key-attributes.md)  
Obrigatório: não

***<KEY\$1ATTRIBUTE\$1VALUE>***  
A chave especifica o nome do atributo.  
Obrigatório: Sim

***<KEY\$1REFERENCE>***  
Uma representação hexadecimal ou decimal da chave. (como uma alça de chave).  
Obrigatório: não

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave for maior do que 1.

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

# Compartilhar uma chave usando a CloudHSM CLI
<a name="cloudhsm_cli-key-share"></a>

Use o **key share** comando na CLI do CloudHSM para compartilhar uma chave CUs com outras pessoas em seu cluster. AWS CloudHSM 

Somente a UC que criou a chave e, consequentemente, a possui pode cancelar o compartilhamento da chave. Os usuários com quem a chave é compartilhada podem usá-la em operações criptográficas, mas não podem excluí-la, exportá-la, compartilhá-la nem descompartilhá-la. Além disso, esses usuários não podem alterar [os principais atributos](cloudhsm_cli-key-attributes.md).

## Tipo de usuário
<a name="chsm-cli-key-share-user-type"></a>

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

## Requisitos
<a name="chsm-cli-key-share-requirements"></a>

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

## Sintaxe
<a name="chsm-cli-key-share-syntax"></a>

```
aws-cloudhsm > help key share
Share a key in the HSM cluster with another user

Usage: key share --filter [<FILTER>...] --username <USERNAME> --role <ROLE>

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 for sharing

      --username <USERNAME>
          A username with which the key will be shared

      --role <ROLE>
          Role the user has in the cluster

          Possible values:
          - crypto-user: A CryptoUser has the ability to manage and use keys
          - admin:       An Admin has the ability to manage user accounts

      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation

  -h, --help
          Print help (see a summary with '-h')
```

## Exemplo: compartilhar uma chave com outro CU
<a name="chsm-cli-key-share-examples"></a>

O exemplo a seguir mostra como usar o comando **key share** para compartilhar uma chave com a CU `alice`.

**Example**  

1. Execute o comando **key share** com o qual compartilhar a chave `alice`.

   ```
   aws-cloudhsm > key share --filter attr.label="rsa_key_to_share" attr.class=private-key --username alice --role crypto-user
   {
     "error_code": 0,
     "data": {
       "message": "Key shared successfully"
     }
   }
   ```

1. Execute o comando **key list**.

   ```
   aws-cloudhsm > key list --filter attr.label="rsa_key_to_share" attr.class=private-key --verbose
   {
     "error_code": 0,
     "data": {
       "matched_keys": [
         {
           "key-reference": "0x00000000001c0686",
           "key-info": {
             "key-owners": [
               {
                 "username": "cu3",
                 "key-coverage": "full"
               }
             ],
             "shared-users": [
               {
                 "username": "cu2",
                 "key-coverage": "full"
               },
               {
                 "username": "cu1",
                 "key-coverage": "full"
               },
               {
                 "username": "cu4",
                 "key-coverage": "full"
               },
               {
                 "username": "cu5",
                 "key-coverage": "full"
               },
               {
                 "username": "cu6",
                 "key-coverage": "full"
               },
               {
                 "username": "cu7",
                 "key-coverage": "full"
               },
               {
                 "username": "alice",
                 "key-coverage": "full"
               }
             ],
             "key-quorum-values": {
               "manage-key-quorum-value": 0,
               "use-key-quorum-value": 0
             },
             "cluster-coverage": "full"
           },
           "attributes": {
             "key-type": "rsa",
             "label": "rsa_key_to_share",
             "id": "",
             "check-value": "0xae8ff0",
             "class": "private-key",
             "encrypt": false,
             "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": true,
             "verify": false,
             "wrap": false,
             "wrap-with-trusted": false,
             "key-length-bytes": 1219,
             "public-exponent": "0x010001",
             "modulus": "0xa8855cba933cec0c21a4df0450ec31675c024f3e65b2b215a53d2bda6dcd191f75729150b59b4d86df58254c8f518f7d000cc04d8e958e7502c7c33098e28da4d94378ef34fb57d1cc7e042d9119bd79be0df728421a980a397095157da24cf3cc2b6dab12225d33fdca11f0c6ed1a5127f12488cda9a556814b39b06cd8373ff5d371db2212887853621b8510faa7b0779fbdec447e1f1d19f343acb02b22526487a31f6c704f8f003cb4f7013136f90cc17c2c20e414dc1fc7bcfb392d59c767900319679fc3307388633485657ce2e1a3deab0f985b0747ef4ed339de78147d1985d14fdd8634219321e49e3f5715e79c298f18658504bab04086bfbdcd3b",
             "modulus-size-bits": 2048
           }
         }
       ],
       "total_key_count": 1,
       "returned_key_count": 1
     }
   }
   ```

1. Na lista acima, verifique se `alice` está na lista de `shared-users`

## Argumentos
<a name="chsm-cli-key-share-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para selecionar uma chave correspondente para exclusão.  
Para obter uma lista dos atributos de chave compatíveis, consulte [Atributos de chave da CloudHSM CLI](cloudhsm_cli-key-attributes.md).  
Obrigatório: Sim

***<USERNAME>***  
Especifica um nome amigável para o usuário. O tamanho máximo é de 31 caracteres. O único caractere especial permitido é um sublinhado ( \$1 ). O nome de usuário não diferencia maiúsculas de minúsculas neste comando. O nome de usuário é sempre exibido em minúsculas.  
Obrigatório: Sim

***<ROLE>***  
Especifica a função atribuída a esse usuário. Esse parâmetro é obrigatório. Para obter a função do usuário, use o comando lista de usuário. Para obter informações detalhadas sobre os tipos de usuários em um HSM, consulte [Tipos de usuários do HSM para a CLI do CloudHSM](understanding-users.md).  
Obrigatório: Sim

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave for maior do que 1.

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

# Cancelar o compartilhamento de uma chave usando a CloudHSM CLI
<a name="cloudhsm_cli-key-unshare"></a>

Use o **key unshare** comando na CLI do CloudHSM para cancelar o compartilhamento de uma chave com outras pessoas em seu cluster. CUs AWS CloudHSM 

Somente o CU que criou a chave e, consequentemente, a possui pode cancelar o compartilhamento da chave. Os usuários com quem a chave é compartilhada podem usá-la em operações criptográficas, mas não podem excluí-la, exportá-la, compartilhá-la nem descompartilhá-la. Além disso, esses usuários não podem alterar [os principais atributos](cloudhsm_cli-key-attributes.md).

## Tipo de usuário
<a name="chsm-cli-key-unshare-user-type"></a>

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

## Requisitos
<a name="chsm-cli-key-unshare-requirements"></a>

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

## Sintaxe
<a name="chsm-cli-key-unshare-syntax"></a>

```
aws-cloudhsm > help key unshare
Unshare a key in the HSM cluster with another user

Usage: key unshare --filter [<FILTER>...] --username <USERNAME> --role <ROLE>

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 for unsharing

      --username <USERNAME>
          A username with which the key will be unshared

      --role <ROLE>
          Role the user has in the cluster

          Possible values:
          - crypto-user: A CryptoUser has the ability to manage and use keys
          - admin:       An Admin has the ability to manage user accounts

      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation

  -h, --help
          Print help (see a summary with '-h')
```

## Exemplo: cancelar o compartilhamento de uma chave com outro CU
<a name="chsm-cli-key-share-examples"></a>

O exemplo a seguir mostra como usar o comando **key unshare** para descompartilhar uma chave com a CU `alice`.

**Example**  

1. Execute o comando **key list** e filtre pela chave específica com a qual você deseja cancelar o compartilhamento com `alice`.

   ```
   aws-cloudhsm > key list --filter attr.label="rsa_key_to_share" attr.class=private-key --verbose
   {
     "error_code": 0,
     "data": {
       "matched_keys": [
         {
           "key-reference": "0x00000000001c0686",
           "key-info": {
             "key-owners": [
               {
                 "username": "cu3",
                 "key-coverage": "full"
               }
             ],
             "shared-users": [
               {
                 "username": "cu2",
                 "key-coverage": "full"
               },
               {
                 "username": "cu1",
                 "key-coverage": "full"
               },
               {
                 "username": "cu4",
                 "key-coverage": "full"
               },
               {
                 "username": "cu5",
                 "key-coverage": "full"
               },
               {
                 "username": "cu6",
                 "key-coverage": "full"
               },
               {
                 "username": "cu7",
                 "key-coverage": "full"
               },
               {
                 "username": "alice",
                 "key-coverage": "full"
               }
             ],
             "key-quorum-values": {
               "manage-key-quorum-value": 0,
               "use-key-quorum-value": 0
             },
             "cluster-coverage": "full"
           },
           "attributes": {
             "key-type": "rsa",
             "label": "rsa_key_to_share",
             "id": "",
             "check-value": "0xae8ff0",
             "class": "private-key",
             "encrypt": false,
             "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": true,
             "verify": false,
             "wrap": false,
             "wrap-with-trusted": false,
             "key-length-bytes": 1219,
             "public-exponent": "0x010001",
             "modulus": "0xa8855cba933cec0c21a4df0450ec31675c024f3e65b2b215a53d2bda6dcd191f75729150b59b4d86df58254c8f518f7d000cc04d8e958e7502c7c33098e28da4d94378ef34fb57d1cc7e042d9119bd79be0df728421a980a397095157da24cf3cc2b6dab12225d33fdca11f0c6ed1a5127f12488cda9a556814b39b06cd8373ff5d371db2212887853621b8510faa7b0779fbdec447e1f1d19f343acb02b22526487a31f6c704f8f003cb4f7013136f90cc17c2c20e414dc1fc7bcfb392d59c767900319679fc3307388633485657ce2e1a3deab0f985b0747ef4ed339de78147d1985d14fdd8634219321e49e3f5715e79c298f18658504bab04086bfbdcd3b",
             "modulus-size-bits": 2048
           }
         }
       ],
       "total_key_count": 1,
       "returned_key_count": 1
     }
   }
   ```

1. Confirme que `alice` está na saída `shared-users` e execute o comando **key unshare** a seguir para cancelar o compartilhamento da chave com `alice`.

   ```
   aws-cloudhsm > key unshare --filter attr.label="rsa_key_to_share" attr.class=private-key --username alice --role crypto-user
   {
     "error_code": 0,
     "data": {
       "message": "Key unshared successfully"
     }
   }
   ```

1. Execute o comando `key list` novamente para confirmar que a chave não foi compartilhada com `alice`.

   ```
   aws-cloudhsm > key list --filter attr.label="rsa_key_to_share" attr.class=private-key --verbose
   {
     "error_code": 0,
     "data": {
       "matched_keys": [
         {
           "key-reference": "0x00000000001c0686",
           "key-info": {
             "key-owners": [
               {
                 "username": "cu3",
                 "key-coverage": "full"
               }
             ],
             "shared-users": [
               {
                 "username": "cu2",
                 "key-coverage": "full"
               },
               {
                 "username": "cu1",
                 "key-coverage": "full"
               },
               {
                 "username": "cu4",
                 "key-coverage": "full"
               },
               {
                 "username": "cu5",
                 "key-coverage": "full"
               },
               {
                 "username": "cu6",
                 "key-coverage": "full"
               },
               {
                 "username": "cu7",
                 "key-coverage": "full"
               },
             ],
             "key-quorum-values": {
               "manage-key-quorum-value": 0,
               "use-key-quorum-value": 0
             },
             "cluster-coverage": "full"
           },
           "attributes": {
             "key-type": "rsa",
             "label": "rsa_key_to_share",
             "id": "",
             "check-value": "0xae8ff0",
             "class": "private-key",
             "encrypt": false,
             "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": true,
             "verify": false,
             "wrap": false,
             "wrap-with-trusted": false,
             "key-length-bytes": 1219,
             "public-exponent": "0x010001",
             "modulus": "0xa8855cba933cec0c21a4df0450ec31675c024f3e65b2b215a53d2bda6dcd191f75729150b59b4d86df58254c8f518f7d000cc04d8e958e7502c7c33098e28da4d94378ef34fb57d1cc7e042d9119bd79be0df728421a980a397095157da24cf3cc2b6dab12225d33fdca11f0c6ed1a5127f12488cda9a556814b39b06cd8373ff5d371db2212887853621b8510faa7b0779fbdec447e1f1d19f343acb02b22526487a31f6c704f8f003cb4f7013136f90cc17c2c20e414dc1fc7bcfb392d59c767900319679fc3307388633485657ce2e1a3deab0f985b0747ef4ed339de78147d1985d14fdd8634219321e49e3f5715e79c298f18658504bab04086bfbdcd3b",
             "modulus-size-bits": 2048
           }
         }
       ],
       "total_key_count": 1,
       "returned_key_count": 1
     }
   }
   ```

## Argumentos
<a name="chsm-cli-key-unshare-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para selecionar uma chave correspondente para exclusão.  
Para obter uma lista dos atributos de chave compatíveis, consulte [Atributos de chave da CloudHSM CLI](cloudhsm_cli-key-attributes.md).  
Obrigatório: Sim

***<USERNAME>***  
Especifica um nome amigável para o usuário. O tamanho máximo é de 31 caracteres. O único caractere especial permitido é um sublinhado ( \$1 ). O nome de usuário não diferencia maiúsculas de minúsculas neste comando. O nome de usuário é sempre exibido em minúsculas.  
Obrigatório: Sim

***<ROLE>***  
Especifica a função atribuída a esse usuário. Esse parâmetro é obrigatório. Para obter a função do usuário, use o comando lista de usuário. Para obter informações detalhadas sobre os tipos de usuários em um HSM, consulte [Tipos de usuários do HSM para a CLI do CloudHSM](understanding-users.md).  
Obrigatório: Sim

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave for maior do que 1.

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

# O comando key unwrap na CLI do CloudHSM
<a name="cloudhsm_cli-key-unwrap"></a>

O comando principal **key unwrap** na CLI do CloudHSM importa uma chave privada simétrica ou assimétrica criptografada (encapsulada) de um arquivo para o Hardware Security Module (HSM – Módulo de segurança de hardware). Esse comando é projetado para importar chaves criptografadas que foram encapsuladas pelo comando [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md), mas também pode ser usado para desencapsular chaves que foram encapsuladas com outras ferramentas. No entanto, nessas situações, recomendamos usar as bibliotecas de software PKCS\$111 ou JCE para desencapsular a chave.
+ [aes-gcm](cloudhsm_cli-key-unwrap-aes-gcm.md)
+ [aes-no-pad](cloudhsm_cli-key-unwrap-aes-no-pad.md)
+ [aes-pkcs5-pad](cloudhsm_cli-key-unwrap-aes-pkcs5-pad.md)
+ [aes-zero-pad](cloudhsm_cli-key-unwrap-aes-zero-pad.md)
+ [cloudhsm-aes-gcm](cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm.md)
+ [rsa-aes](cloudhsm_cli-key-unwrap-rsa-aes.md)
+ [rsa-oaep](cloudhsm_cli-key-unwrap-rsa-oaep.md)
+ [rsa-pkcs](cloudhsm_cli-key-unwrap-rsa-pkcs.md)

# Desencapsular uma chave com o AES-GCM usando a CloudHSM CLI
<a name="cloudhsm_cli-key-unwrap-aes-gcm"></a>

Use o comando **key unwrap aes-gcm** na CloudHSM CLI para desencapsular uma chave de carga útil no cluster usando a chave de encapsulamento AES e o mecanismo de desencapsulamento `AES-GCM`.

As chaves desembrulhadas podem ser usadas da mesma forma que as chaves geradas pelo AWS CloudHSM. Para indicar que elas não foram geradas localmente, o atributo `local` é definido como `false`.

Para usar o **key unwrap aes-gcm** comando, você deve ter a chave de encapsulamento AES em seu AWS CloudHSM cluster e seu `unwrap` atributo deve estar definido como. `true`

## Tipo de usuário
<a name="cloudhsm_cli-key-unwrap-aes-gcm-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-unwrap-aes-gcm-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-unwrap-aes-gcm-syntax"></a>

```
aws-cloudhsm > help key unwrap aes-gcm
Usage: key unwrap aes-gcm [OPTIONS] --filter [<FILTER>...] --tag-length-bits <TAG_LENGTH_BITS> --key-type-class <KEY_TYPE_CLASS> --label <LABEL> --iv <IV> <--data-path <DATA_PATH>|--data <DATA>>

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 key to unwrap with
      --data-path <DATA_PATH>
          Path to the binary file containing the wrapped key data
      --data <DATA>
          Base64 encoded wrapped key data
      --attributes [<UNWRAPPED_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the unwrapped key
      --share-crypto-users [<SHARE_CRYPTO_USERS;...]
          Space separated list of Crypto User usernames to share the unwrapped key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE;
          The quorum value for key management operations for the unwrapped key
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE;
          The quorum value for key usage operations for the unwrapped key
      --aad <AAD>
          Aes GCM Additional Authenticated Data (AAD) value, in hex
      --tag-length-bits <TAG_LENGTH_BITS>
          Aes GCM tag length in bits
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of wrapped key [possible values: aes, des3, ec-private, generic-secret, rsa-private]
      --label <LABEL>
          Label for the unwrapped key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --iv <IV>
          Initial value used to wrap the key, in hex
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
  -h, --help
          Print help
```

## Exemplos
<a name="cloudhsm_cli-key-unwrap-aes-gcm-examples"></a>

Esses exemplos mostram como usar o comando **key unwrap aes-gcm** usando uma chave AES com o valor do atributo `unwrap` definido como `true`.

**Example Exemplo: desencapsular uma chave de carga útil dos dados da chave encapsulada codificada em Base64**  

```
aws-cloudhsm > key unwrap aes-gcm --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --tag-length-bits 64  --aad 0x10 --iv 0xf90613bb8e337ec0339aad21 --data xvslgrtg8kHzrvekny97tLSIeokpPwV8
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001808e4",
      "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": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "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": 16
      }
    }
  }
}
```

**Example Exemplo: desencapsular uma chave de carga útil fornecida por meio de um caminho de dados**  

```
aws-cloudhsm > key unwrap aes-gcm --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --tag-length-bits 64  --aad 0x10 --iv 0xf90613bb8e337ec0339aad21 --data-path payload-key.pem
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001808e4",
      "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": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "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": 16
      }
    }
  }
}
```

## Argumentos
<a name="cloudhsm_cli-key-unwrap-aes-gcm-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços contendo atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para selecionar uma chave para ser usada no desencapsulamento.  
Obrigatório: Sim

***<DATA\$1PATH>***  
Caminho para o arquivo binário que contém os dados da chave encapsulada.  
Obrigatório: sim (a menos que seja fornecido por meio de dados codificados em Base64)

***<DATA>***  
Dados de chaves encapsuladas codificados em Base64.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<ATTRIBUTES>***  
Lista separada por espaço contendo atributos de chaves na forma de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para a chave encapsulada.  
Obrigatório: não

***<AAD>***  
Valor de dados autenticados adicionais (AAD) do Aes GCM, em hexadecimal.  
Obrigatório: não

***<TAG\$1LENGTH\$1BITS>***  
Comprimento de tag do Aes GCM em bits.  
Obrigatório: Sim

***<KEY\$1TYPE\$1CLASS>***  
Tipo de chave e classe da chave encapsulada [valores possíveis: `aes`, `des3`, `ec-private`, `generic-secret`, `rsa-private`].  
Obrigatório: Sim

***<LABEL>***  
Rótulo da chave desencapsulada.  
Obrigatório: Sim

***<SESSION>***  
Cria uma chave de sessão que existe apenas na sessão atual. A chave não pode ser recuperada após o término da sessão.  
Obrigatório: não

***<IV>***  
Valor inicial usado para encapsular a chave, em hexadecimal.  
Obrigatório: não

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de desempacotamento for maior do que 1.

## Tópicos relacionados
<a name="cloudhsm_cli-key-unwrap-aes-gcm-seealso"></a>
+ [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)
+ [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)

# Desembrulhe uma chave AES-NO-PAD usando a CLI do CloudHSM
<a name="cloudhsm_cli-key-unwrap-aes-no-pad"></a>

Use o **key unwrap aes-no-pad** comando na CLI do CloudHSM para desempacotar uma chave de carga no cluster usando a chave de empacotamento AES e o AWS CloudHSM mecanismo de desempacotamento. `AES-NO-PAD`

As chaves desembrulhadas podem ser usadas da mesma forma que as chaves geradas pelo AWS CloudHSM. Para indicar que elas não foram geradas localmente, o atributo `local` é definido como `false`.

Para usar o **key unwrap aes-no-pad** comando, você deve ter a chave de encapsulamento AES em seu AWS CloudHSM cluster e seu `unwrap` atributo deve estar definido como. `true`

## Tipo de usuário
<a name="cloudhsm_cli-key-unwrap-aes-no-pad-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-unwrap-aes-no-pad-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-unwrap-aes-no-pad-syntax"></a>

```
aws-cloudhsm > help key unwrap aes-no-pad
Usage: key unwrap aes-no-pad [OPTIONS] --filter [<FILTER>...] --key-type-class <KEY_TYPE_CLASS> --label <LABEL> <--data-path <DATA_PATH>|--data <DATA>>

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 key to unwrap with
      --data-path <DATA_PATH>
          Path to the binary file containing the wrapped key data
      --data <DATA>
          Base64 encoded wrapped key data
      --attributes [<UNWRAPPED_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the unwrapped key
      --share-crypto-users [<SHARE_CRYPTO_USERS;...]
          Space separated list of Crypto User usernames to share the unwrapped key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE;
          The quorum value for key management operations for the unwrapped key
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE;
          The quorum value for key usage operations for the unwrapped key
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of wrapped key [possible values: aes, des3, ec-private, generic-secret, rsa-private]
      --label <LABEL>
          Label for the unwrapped key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
  -h, --help
          Print help
```

## Exemplos
<a name="cloudhsm_cli-key-unwrap-aes-no-pad-examples"></a>

Esses exemplos mostram como usar o comando **key unwrap aes-no-pad** usando uma chave AES com o valor do atributo `unwrap` definido como `true`.

**Example Exemplo: desencapsular uma chave de carga útil dos dados da chave encapsulada codificada em Base64**  

```
aws-cloudhsm > key unwrap aes-no-pad --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --data eXK3PMAOnKM9y3YX6brbhtMoC060EOH9
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001c08ec",
      "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": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "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": 16
      }
    }
  }
}
```

**Example Exemplo: desencapsular uma chave de carga útil fornecida por meio de um caminho de dados**  

```
aws-cloudhsm > key unwrap aes-no-pad --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --data-path payload-key.pem
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001c08ec",
      "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": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "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": 16
      }
    }
  }
}
```

## Argumentos
<a name="cloudhsm_cli-key-unwrap-aes-no-pad-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços contendo atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para selecionar uma chave para ser usada no desencapsulamento.  
Obrigatório: Sim

***<DATA\$1PATH>***  
Caminho para o arquivo binário que contém os dados da chave encapsulada.  
Obrigatório: sim (a menos que seja fornecido por meio de dados codificados em Base64)

***<DATA>***  
Dados de chaves encapsuladas codificados em Base64.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<ATTRIBUTES>***  
Lista separada por espaço contendo atributos de chaves na forma de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para a chave encapsulada.  
Obrigatório: não

***<KEY\$1TYPE\$1CLASS>***  
Tipo de chave e classe da chave encapsulada [valores possíveis: `aes`, `des3`, `ec-private`, `generic-secret`, `rsa-private`].  
Obrigatório: Sim

***<LABEL>***  
Rótulo da chave desencapsulada.  
Obrigatório: Sim

***<SESSION>***  
Cria uma chave de sessão que existe apenas na sessão atual. A chave não pode ser recuperada após o término da sessão.  
Obrigatório: não

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de desempacotamento for maior do que 1.

## Tópicos relacionados
<a name="cloudhsm_cli-key-unwrap-aes-no-pad-seealso"></a>
+ [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)
+ [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)

# Desempacote uma chave com o AES- PKCS5 -PAD usando a CLI do CloudHSM
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad"></a>

Use o comando **key unwrap aes-pkcs5-pad** na CloudHSM CLI para desencapsular uma chave de carga útil usando a chave de encapsulamento AES e o mecanismo de desencapsulamento `AES-PKCS5-PAD`.

As chaves desembrulhadas podem ser usadas da mesma forma que as chaves geradas pelo AWS CloudHSM. Para indicar que elas não foram geradas localmente, o atributo `local` é definido como `false`.

Para usar o **key unwrap aes-pkcs5-pad** comando, você deve ter a chave de encapsulamento AES em seu AWS CloudHSM cluster e seu `unwrap` atributo deve estar definido como. `true`

## Tipo de usuário
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad-syntax"></a>

```
aws-cloudhsm > help key unwrap aes-pkcs5-pad
Usage: key unwrap aes-pkcs5-pad [OPTIONS] --filter [<FILTER>...] --key-type-class <KEY_TYPE_CLASS> --label <LABEL> <--data-path <DATA_PATH>|--data <DATA>>

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 key to unwrap with
      --data-path <DATA_PATH>
          Path to the binary file containing the wrapped key data
      --data <DATA>
          Base64 encoded wrapped key data
      --attributes [<UNWRAPPED_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the unwrapped key
      --share-crypto-users [<SHARE_CRYPTO_USERS;...]
          Space separated list of Crypto User usernames to share the unwrapped key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE;
          The quorum value for key management operations for the unwrapped key
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE;
          The quorum value for key usage operations for the unwrapped key
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of wrapped key [possible values: aes, des3, ec-private, generic-secret, rsa-private]
      --label <LABEL>
          Label for the unwrapped key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
  -h, --help
          Print help
```

## Exemplos
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad-examples"></a>

Esses exemplos mostram como usar o comando **key unwrap aes-pkcs5-pad** usando uma chave AES com o valor do atributo `unwrap` definido como `true`.

**Example Exemplo: desencapsular uma chave de carga útil dos dados da chave encapsulada codificada em Base64**  

```
aws-cloudhsm > key unwrap aes-pkcs5-pad --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --data MbuYNresfOKyGNnxKWen88nSfX+uUE/0qmGofSisicY=
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001c08e3",
      "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": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "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": 16
      }
    }
  }
}
```

**Example Exemplo: desencapsular uma chave de carga útil fornecida por meio de um caminho de dados**  

```
aws-cloudhsm > key unwrap aes-pkcs5-pad --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --data-path payload-key.pem
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001c08e3",
      "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": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "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": 16
      }
    }
  }
}
```

## Argumentos
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços contendo atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para selecionar uma chave para ser usada no desencapsulamento.  
Obrigatório: Sim

***<DATA\$1PATH>***  
Caminho para o arquivo binário que contém os dados da chave encapsulada.  
Obrigatório: sim (a menos que seja fornecido por meio de dados codificados em Base64)

***<DATA>***  
Dados de chaves encapsuladas codificados em Base64.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<ATTRIBUTES>***  
Lista separada por espaço contendo atributos de chaves na forma de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para a chave encapsulada.  
Obrigatório: não

***<KEY\$1TYPE\$1CLASS>***  
Tipo de chave e classe da chave encapsulada [valores possíveis: `aes`, `des3`, `ec-private`, `generic-secret`, `rsa-private`].  
Obrigatório: Sim

***<LABEL>***  
Rótulo da chave desencapsulada.  
Obrigatório: Sim

***<SESSION>***  
Cria uma chave de sessão que existe apenas na sessão atual. A chave não pode ser recuperada após o término da sessão.  
Obrigatório: não

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de desempacotamento for maior do que 1.

## Tópicos relacionados
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad-seealso"></a>
+ [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)
+ [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)

# Desembrulhe uma chave AES-ZERO-PAD usando a CLI do CloudHSM
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad"></a>

Use o **key unwrap aes-zero-pad** comando na CLI do CloudHSM para desempacotar uma chave de carga no cluster usando a chave de empacotamento AES e o AWS CloudHSM mecanismo de desempacotamento. `AES-ZERO-PAD`

As chaves desembrulhadas podem ser usadas da mesma forma que as chaves geradas pelo AWS CloudHSM. Para indicar que elas não foram geradas localmente, o atributo `local` é definido como `false`.

Para usar o **key unwrap aes-no-pad** comando, você deve ter a chave de encapsulamento AES em seu AWS CloudHSM cluster e seu `unwrap` atributo deve estar definido como. `true`

## Tipo de usuário
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad-syntax"></a>

```
aws-cloudhsm > help key unwrap aes-zero-pad
Usage: key unwrap aes-zero-pad [OPTIONS] --filter [<FILTER>...] --key-type-class <KEY_TYPE_CLASS> --label <LABEL> <--data-path <DATA_PATH>|--data <DATA>>

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 key to unwrap with
      --data-path <DATA_PATH>
          Path to the binary file containing the wrapped key data
      --data <DATA>
          Base64 encoded wrapped key data
      --attributes [<UNWRAPPED_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the unwrapped key
      --share-crypto-users [<SHARE_CRYPTO_USERS;...]
          Space separated list of Crypto User usernames to share the unwrapped key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE;
          The quorum value for key management operations for the unwrapped key
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE;
          The quorum value for key usage operations for the unwrapped key
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of wrapped key [possible values: aes, des3, ec-private, generic-secret, rsa-private]
      --label <LABEL>
          Label for the unwrapped key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
  -h, --help
          Print help
```

## Exemplos
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad-examples"></a>

Esses exemplos mostram como usar o comando **key unwrap aes-zero-pad** usando uma chave AES com o valor do atributo `unwrap` definido como `true`.

**Example Exemplo: desencapsular uma chave de carga útil dos dados da chave encapsulada codificada em Base64**  

```
aws-cloudhsm > key unwrap aes-zero-pad --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --data L1wVlL/YeBNVAw6Mpk3owFJZXBzDLONt
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001c08e7",
      "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": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "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": 16
      }
    }
  }
}
```

**Example Exemplo: desencapsular uma chave de carga útil fornecida por meio de um caminho de dados**  

```
aws-cloudhsm > key unwrap aes-zero-pad --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --data-path payload-key.pem
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001c08e7",
      "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": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "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": 16
      }
    }
  }
}
```

## Argumentos
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços contendo atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para selecionar uma chave para ser usada no desencapsulamento.  
Obrigatório: Sim

***<DATA\$1PATH>***  
Caminho para o arquivo binário que contém os dados da chave encapsulada.  
Obrigatório: sim (a menos que seja fornecido por meio de dados codificados em Base64)

***<DATA>***  
Dados de chaves encapsuladas codificados em Base64.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<ATTRIBUTES>***  
Lista separada por espaço contendo atributos de chaves na forma de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para a chave encapsulada.  
Obrigatório: não

***<KEY\$1TYPE\$1CLASS>***  
Tipo de chave e classe da chave encapsulada [valores possíveis: `aes`, `des3`, `ec-private`, `generic-secret`, `rsa-private`].  
Obrigatório: Sim

***<LABEL>***  
Rótulo da chave desencapsulada.  
Obrigatório: Sim

***<SESSION>***  
Cria uma chave de sessão que existe apenas na sessão atual. A chave não pode ser recuperada após o término da sessão.  
Obrigatório: não

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de desempacotamento for maior do que 1.

## Tópicos relacionados
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad-seealso"></a>
+ [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)
+ [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)

# Desembrulhe uma chave CLOUDHSM-AES-GCM usando a CLI do CloudHSM
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm"></a>

Use o **key unwrap cloudhsm-aes-gcm** comando na CLI do CloudHSM para desempacotar uma chave de carga no cluster usando a chave de empacotamento AES e o AWS CloudHSM mecanismo de desempacotamento. `CLOUDHSM-AES-GCM`

As chaves desembrulhadas podem ser usadas da mesma forma que as chaves geradas pelo AWS CloudHSM. Para indicar que elas não foram geradas localmente, o atributo `local` é definido como `false`.

Para usar o **key unwrap cloudhsm-aes-gcm** comando, você deve ter a chave de encapsulamento AES em seu AWS CloudHSM cluster e seu `unwrap` atributo deve estar definido como. `true`

## Tipo de usuário
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm-syntax"></a>

```
aws-cloudhsm > help key unwrap cloudhsm-aes-gcm
Usage: key unwrap cloudhsm-aes-gcm [OPTIONS] --filter [<FILTER>...] --tag-length-bits <TAG_LENGTH_BITS> --key-type-class <KEY_TYPE_CLASS> --label <LABEL> <--data-path <DATA_PATH>|--data <DATA>>

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 key to unwrap with
      --data-path <DATA_PATH>
          Path to the binary file containing the wrapped key data
      --data <DATA>
          Base64 encoded wrapped key data
      --attributes [<UNWRAPPED_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the unwrapped key
      --share-crypto-users [<SHARE_CRYPTO_USERS;...]
          Space separated list of Crypto User usernames to share the unwrapped key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE;
          The quorum value for key management operations for the unwrapped key
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE;
          The quorum value for key usage operations for the unwrapped key
      --aad <AAD>
          Aes GCM Additional Authenticated Data (AAD) value, in hex
      --tag-length-bits <TAG_LENGTH_BITS>
          Aes GCM tag length in bits
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of wrapped key [possible values: aes, des3, ec-private, generic-secret, rsa-private]
      --label <LABEL>
          Label for the unwrapped key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
  -h, --help
          Print help
```

## Exemplos
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm-examples"></a>

Esses exemplos mostram como usar o comando **key unwrap cloudhsm-aes-gcm** usando uma chave AES com o valor do atributo `unwrap` definido como `true`.

**Example Exemplo: desencapsular uma chave de carga útil dos dados da chave encapsulada codificada em Base64**  

```
aws-cloudhsm > key unwrap cloudhsm-aes-gcm --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --tag-length-bits 64  --aad 0x10 --data 6Rn8nkjEriDYlnP3P8nPkYQ8hplOEJ899zsrF+aTB0i/fIlZ
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001408e8",
      "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": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "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": 16
      }
    }
  }
}
```

**Example Exemplo: desencapsular uma chave de carga útil fornecida por meio de um caminho de dados**  

```
aws-cloudhsm > key unwrap cloudhsm-aes-gcm --key-type-class aes --label aes-unwrapped --filter attr.label=aes-example --tag-length-bits 64  --aad 0x10 --data-path payload-key.pem
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001408e8",
      "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": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "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": 16
      }
    }
  }
}
```

## Argumentos
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços contendo atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para selecionar uma chave para ser usada no desencapsulamento.  
Obrigatório: Sim

***<DATA\$1PATH>***  
Caminho para o arquivo binário que contém os dados da chave encapsulada.  
Obrigatório: sim (a menos que seja fornecido por meio de dados codificados em Base64)

***<DATA>***  
Dados de chaves encapsuladas codificados em Base64.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<ATTRIBUTES>***  
Lista separada por espaço contendo atributos de chaves na forma de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para a chave encapsulada.  
Obrigatório: não

***<AAD>***  
Valor de dados autenticados adicionais (AAD) do Aes GCM, em hexadecimal.  
Obrigatório: não

***<TAG\$1LENGTH\$1BITS>***  
Comprimento de tag do Aes GCM em bits.  
Obrigatório: Sim

***<KEY\$1TYPE\$1CLASS>***  
Tipo de chave e classe da chave encapsulada [valores possíveis: `aes`, `des3`, `ec-private`, `generic-secret`, `rsa-private`].  
Obrigatório: Sim

***<LABEL>***  
Rótulo da chave desencapsulada.  
Obrigatório: Sim

***<SESSION>***  
Cria uma chave de sessão que existe apenas na sessão atual. A chave não pode ser recuperada após o término da sessão.  
Obrigatório: não

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de desempacotamento for maior do que 1.

## Tópicos relacionados
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm-seealso"></a>
+ [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)
+ [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)

# Desencapsular uma chave com o RSA-AES usando a CloudHSM CLI
<a name="cloudhsm_cli-key-unwrap-rsa-aes"></a>

Use o comando **key unwrap rsa-aes** na CloudHSM CLI para desencapsular uma chave de carga útil usando uma chave privada RSA e o mecanismo de desencapsulamento `RSA-AES`.

As chaves desembrulhadas podem ser usadas da mesma forma que as chaves geradas pelo AWS CloudHSM. Para indicar que elas não foram geradas localmente, o atributo `local` é definido como `false`.

Para usar o**key unwrap rsa-aes**, você deve ter a chave privada RSA da chave de empacotamento pública RSA em seu AWS CloudHSM cluster e seu `unwrap` atributo deve estar definido como. `true` 

**nota**  
Esse comando está disponível somente com o CloudHSM CLI 5.11\$1.

## Tipo de usuário
<a name="cloudhsm_cli-key-unwrap-rsa-aes-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-unwrap-rsa-aes-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-unwrap-rsa-aes-syntax"></a>

```
aws-cloudhsm > help key unwrap rsa-aes
Usage: key unwrap rsa-aes [OPTIONS] --filter [<FILTER>...] --hash-function <HASH_FUNCTION> --mgf <MGF> --key-type-class <KEY_TYPE_CLASS> --label <LABEL> <--data-path <DATA_PATH>|--data <DATA>>

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 key to unwrap with
      --data-path <DATA_PATH>
          Path to the binary file containing the wrapped key data
      --data <DATA>
          Base64 encoded wrapped key data
      --attributes [<UNWRAPPED_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the unwrapped key
      --share-crypto-users [<SHARE_CRYPTO_USERS;...]
          Space separated list of Crypto User usernames to share the unwrapped key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE;
          The quorum value for key management operations for the unwrapped key
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE;
          The quorum value for key usage operations for the unwrapped key
      --hash-function <HASH_FUNCTION>
          Hash algorithm [possible values: sha1, sha224, sha256, sha384, sha512]
      --mgf <MGF>
          Mask Generation Function algorithm [possible values: mgf1-sha1, mgf1-sha224, mgf1-sha256, mgf1-sha384, mgf1-sha512]
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of wrapped key [possible values: aes, des3, ec-private, generic-secret, rsa-private]
      --label <LABEL>
          Label for the unwrapped key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
  -h, --help
          Print help
```

## Exemplo
<a name="cloudhsm_cli-key-unwrap-rsa-aes-examples"></a>

Esses exemplos mostram como usar o comando **key unwrap rsa-aes** usando a chave privada RSA com o valor do atributo `unwrap` definido como `true`.

**Example Exemplo: desencapsular uma chave de carga útil dos dados da chave encapsulada codificada em Base64**  

```
aws-cloudhsm > key unwrap rsa-aes --key-type-class aes --label aes-unwrapped --filter attr.label=rsa-private-key-example --hash-function sha256 --mgf mgf1-sha256 --data HrSE1DEyLjIeyGdPa9R+ebiqB5TIJGyamPker31ZebPwRA+NcerbAJO8DJ1lXPygZcI21vIFSZJuWMEiWpe1R9D/5WSYgxLVKex30xCFqebtEzxbKuv4DOmU4meSofqREYvtb3EoIKwjyxCMRQFgoyUCuP4y0f0eSv0k6rSJh4NuCsHptXZbtgNeRcR4botN7LlzkEIUcq4fVHaatCwd0J1QGKHKyRhkol+RL5WGXKe4nAboAkC5GO7veI5yHL1SaKlssSJtTL/CFpbSLsAFuYbv/NUCWwMY5mwyVTCSlw+HlgKK+5TH1MzBaSi8fpfyepLT8sHy2Q/VRl6ifb49p6m0KQFbRVvz/OWUd6l4d97BdgtaEz6ueg==
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001808e2",
      "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": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "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": 16
      }
    }
  }
}
```

**Example Exemplo: desencapsular uma chave de carga útil fornecida por meio de um caminho de dados**  

```
aws-cloudhsm > key unwrap rsa-aes --key-type-class aes --label aes-unwrapped --filter attr.label=rsa-private-key-example --hash-function sha256 --mgf mgf1-sha256 --data-path payload-key.pem
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001808e2",
      "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": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "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": 16
      }
    }
  }
}
```

## Argumentos
<a name="cloudhsm_cli-key-unwrap-rsa-aes-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços contendo atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para selecionar uma chave para ser usada no desencapsulamento.  
Obrigatório: Sim

***<DATA\$1PATH>***  
Caminho para o arquivo binário que contém os dados da chave encapsulada.  
Obrigatório: sim (a menos que seja fornecido por meio de dados codificados em Base64)

***<DATA>***  
Dados de chaves encapsuladas codificados em Base64.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<ATTRIBUTES>***  
Lista separada por espaço contendo atributos de chaves na forma de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para a chave encapsulada.  
Obrigatório: não

***<KEY\$1TYPE\$1CLASS>***  
Tipo de chave e classe da chave encapsulada [valores possíveis: `aes`, `des3`, `ec-private`, `generic-secret`, `rsa-private`].  
Obrigatório: Sim

***<HASH\$1FUNCTION>***  
Especifica a função hash.  
Valores válidos:  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
Obrigatório: Sim

***<MGF>***  
Especifica a função de geração da máscara.   
A função hash da função de geração de máscara deve corresponder à função hash do mecanismo de assinatura.
Valores válidos:  
+ mgf1-sha1
+ mgf1-sha224
+ mgf1-sha256
+ mgf1-sha384
+ mgf1-sha512
Obrigatório: Sim

***<LABEL>***  
Rótulo da chave desencapsulada.  
Obrigatório: Sim

***<SESSION>***  
Cria uma chave de sessão que existe apenas na sessão atual. A chave não pode ser recuperada após o término da sessão.  
Obrigatório: não

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de desempacotamento for maior do que 1.

## Tópicos relacionados
<a name="cloudhsm_cli-key-unwrap-rsa-aes-seealso"></a>
+ [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)
+ [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)

# Desencapsular uma chave com o RSA-OAEP usando a CloudHSM CLI
<a name="cloudhsm_cli-key-unwrap-rsa-oaep"></a>

Use o comando **key unwrap rsa-oaep** na CloudHSM CLI para desencapsular uma chave de carga útil usando a chave privada RSA e o mecanismo de desencapsulamento `RSA-OAEP`.

As chaves desembrulhadas podem ser usadas da mesma forma que as chaves geradas pelo AWS CloudHSM. Para indicar que elas não foram geradas localmente, o atributo `local` é definido como `false`.

Para usar o **key unwrap rsa-oaep** comando, você deve ter a chave privada RSA da chave de empacotamento pública RSA em seu AWS CloudHSM cluster e seu `unwrap` atributo deve estar definido como. `true`

## Tipo de usuário
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-syntax"></a>

```
aws-cloudhsm > help key unwrap rsa-oaep
Usage: key unwrap rsa-oaep [OPTIONS] --filter [<FILTER>...] --hash-function <HASH_FUNCTION> --mgf <MGF> --key-type-class <KEY_TYPE_CLASS> --label <LABEL> <--data-path <DATA_PATH>|--data <DATA>

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 key to unwrap with
      --data-path <DATA_PATH>
          Path to the binary file containing the wrapped key data
      --data <DATA>
          Base64 encoded wrapped key data
      --attributes [<UNWRAPPED_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the unwrapped key
      --share-crypto-users [<SHARE_CRYPTO_USERS;...]
          Space separated list of Crypto User usernames to share the unwrapped key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE;
          The quorum value for key management operations for the unwrapped key
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE;
          The quorum value for key usage operations for the unwrapped key
      --hash-function <HASH_FUNCTION>
          Hash algorithm [possible values: sha1, sha224, sha256, sha384, sha512]
      --mgf <MGF>
          Mask Generation Function algorithm [possible values: mgf1-sha1, mgf1-sha224, mgf1-sha256, mgf1-sha384, mgf1-sha512]
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of wrapped key [possible values: aes, des3, ec-private, generic-secret, rsa-private]
      --label <LABEL>
          Label for the unwrapped key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
  -h, --help
          Print help
```

## Exemplos
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-examples"></a>

Esses exemplos mostram como usar o comando **key unwrap rsa-oaep** usando a chave privada RSA com o valor do atributo `unwrap` definido como `true`.

**Example Exemplo: desencapsular uma chave de carga útil dos dados da chave encapsulada codificada em Base64**  

```
aws-cloudhsm > key unwrap rsa-oaep --key-type-class aes --label aes-unwrapped --filter attr.label=rsa-private-example-key --hash-function sha256 --mgf mgf1-sha256 --data OjJe4msobPLz9TuSAdULEu17T5rMDWtSlLyBSkLbaZnYzzpdrhsbGLbwZJCtB/jGkDNdB4qyTAOQwEpggGf6v+Yx6JcesNeKKNU8XZal/YBoHC8noTGUSDI2qr+u2tDc84NPv6d+F2KOONXsSxMhmxzzNG/gzTVIJhOuy/B1yHjGP4mOXoDZf5+7f5M1CjxBmz4Vva/wrWHGCSG0yOaWblEvOiHAIt3UBdyKmU+/My4xjfJv7WGGu3DFUUIZ06TihRtKQhUYU1M9u6NPf9riJJfHsk6QCuSZ9yWThDT9as6i7e3htnyDhIhGWaoK8JU855cN/YNKAUqkNpC4FPL3iw==
{
  "data": {
    "key": {
      "key-reference": "0x00000000001808e9",
      "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": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "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": 16
      }
    }
  }
}
```

**Example Exemplo: desencapsular uma chave de carga útil fornecida por meio de um caminho de dados**  

```
aws-cloudhsm > key unwrap rsa-oaep --key-type-class aes --label aes-unwrapped --filter attr.label=rsa-private-example-key --hash-function sha256 --mgf mgf1-sha256 --data-path payload-key.pem
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001808e9",
      "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": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "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": 16
      }
    }
  }
}
```

## Argumentos
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços contendo atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para selecionar uma chave para ser usada no desencapsulamento.  
Obrigatório: Sim

***<DATA\$1PATH>***  
Caminho para o arquivo binário que contém os dados da chave encapsulada.  
Obrigatório: sim (a menos que seja fornecido por meio de dados codificados em Base64)

***<DATA>***  
Dados de chaves encapsuladas codificados em Base64.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<ATTRIBUTES>***  
Lista separada por espaço contendo atributos de chaves na forma de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para a chave encapsulada.  
Obrigatório: não

***<KEY\$1TYPE\$1CLASS>***  
Tipo de chave e classe da chave encapsulada [valores possíveis: `aes`, `des3`, `ec-private`, `generic-secret`, `rsa-private`].  
Obrigatório: Sim

***<HASH\$1FUNCTION>***  
Especifica a função hash.  
Valores válidos:  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
Obrigatório: Sim

***<MGF>***  
Especifica a função de geração da máscara.   
A função hash da função de geração de máscara deve corresponder à função hash do mecanismo de assinatura.
Valores válidos:  
+ mgf1-sha1
+ mgf1-sha224
+ mgf1-sha256
+ mgf1-sha384
+ mgf1-sha512
Obrigatório: Sim

***<LABEL>***  
Rótulo da chave desencapsulada.  
Obrigatório: Sim

***<SESSION>***  
Cria uma chave de sessão que existe apenas na sessão atual. A chave não pode ser recuperada após o término da sessão.  
Obrigatório: não

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de desempacotamento for maior do que 1.

## Tópicos relacionados
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-seealso"></a>
+ [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)
+ [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)

# Desencapsular uma chave com o RSA-PKCS usando a CloudHSM CLI
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs"></a>

Use o comando **key unwrap rsa-pkcs** na CloudHSM CLI para desencapsular uma chave de carga útil usando a chave privada RSA e o mecanismo de desencapsulamento `RSA-PKCS`.

As chaves desembrulhadas podem ser usadas da mesma forma que as chaves geradas pelo AWS CloudHSM. Para indicar que elas não foram geradas localmente, o atributo `local` é definido como `false`.

Para usar o **unwrap rsa-pkcs** comando key, você deve ter a chave privada RSA da chave de empacotamento pública RSA em seu AWS CloudHSM cluster e seu `unwrap` atributo deve estar definido como. `true`

## Tipo de usuário
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-syntax"></a>

```
aws-cloudhsm > help key unwrap rsa-pkcs
Usage: key unwrap rsa-pkcs [OPTIONS] --filter [<FILTER>...] --key-type-class <KEY_TYPE_CLASS> --label <LABEL> <--data-path <DATA_PATH>|--data <DATA>>

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 key to unwrap with
      --data-path <DATA_PATH>
          Path to the binary file containing the wrapped key data
      --data <DATA>
          Base64 encoded wrapped key data
      --attributes [<UNWRAPPED_KEY_ATTRIBUTES>...]
          Space separated list of key attributes in the form of KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE for the unwrapped key
      --share-crypto-users [<SHARE_CRYPTO_USERS;...]
          Space separated list of Crypto User usernames to share the unwrapped key with
      --manage-key-quorum-value <MANAGE_KEY_QUORUM_VALUE;
          The quorum value for key management operations for the unwrapped key
      --use-key-quorum-value <USE_KEY_QUORUM_VALUE;
          The quorum value for key usage operations for the unwrapped key
      --key-type-class <KEY_TYPE_CLASS>
          Key type and class of wrapped key [possible values: aes, des3, ec-private, generic-secret, rsa-private]
      --label <LABEL>
          Label for the unwrapped key
      --session
          Creates a session key that exists only in the current session. The key cannot be recovered after the session ends
      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
  -h, --help
          Print help
```

## Exemplos
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-examples"></a>

Esses exemplos mostram como usar o comando **key unwrap rsa-oaep** usando uma chave AES com o valor do atributo `unwrap` definido como `true`.

**Example Exemplo: desencapsular uma chave de carga útil dos dados da chave encapsulada codificada em Base64**  

```
aws-cloudhsm > key unwrap rsa-pkcs --key-type-class aes --label aes-unwrapped --filter attr.label=rsa-private-key-example --data am0Nc7+YE8FWs+5HvU7sIBcXVb24QA0l65nbNAD+1bK+e18BpSfnaI3P+r8Dp+pLu1ofoUy/vtzRjZoCiDofcz4EqCFnGl4GdcJ1/3W/5WRvMatCa2d7cx02swaeZcjKsermPXYRO1lGlfq6NskwMeeTkV8R7Rx9artFrs1y0DdIgIKVaiFHwnBIUMnlQrR2zRmMkfwU1jxMYmOYyD031F5VbnjSrhfMwkww2la7uf/c3XdFJ2+0Bo94c6og/yfPcpOOobJlITCoXhtMRepSdO4OggYq/6nUDuHCtJ86pPGnNahyr7+sAaSI3a5ECQLUjwaIARUCyoRh7EFK3qPXcg==
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001c08ef",
      "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": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "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": 16
      }
    }
  }
}
```

**Example Exemplo: desencapsular uma chave de carga útil fornecida por meio de um caminho de dados**  

```
aws-cloudhsm > key unwrap rsa-pkcs --key-type-class aes --label aes-unwrapped --filter attr.label=rsa-private-key-example --data-path payload-key.pem
{
  "error_code": 0,
  "data": {
    "key": {
      "key-reference": "0x00000000001c08ef",
      "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": "aes-unwrapped",
        "id": "0x",
        "check-value": "0x8d9099",
        "class": "secret-key",
        "encrypt": false,
        "decrypt": false,
        "token": true,
        "always-sensitive": false,
        "derive": false,
        "destroyable": true,
        "extractable": true,
        "local": false,
        "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": 16
      }
    }
  }
}
```

## Argumentos
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços contendo atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para selecionar uma chave para ser usada no desencapsulamento.  
Obrigatório: Sim

***<DATA\$1PATH>***  
Caminho para o arquivo binário que contém os dados da chave encapsulada.  
Obrigatório: sim (a menos que seja fornecido por meio de dados codificados em Base64)

***<DATA>***  
Dados de chaves encapsuladas codificados em Base64.  
Obrigatório: sim (a menos que seja fornecido por meio do caminho de dados)

***<ATTRIBUTES>***  
Lista separada por espaço contendo atributos de chaves na forma de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` para a chave encapsulada.  
Obrigatório: não

***<KEY\$1TYPE\$1CLASS>***  
Tipo de chave e classe da chave encapsulada [valores possíveis: `aes`, `des3`, `ec-private`, `generic-secret`, `rsa-private`].  
Obrigatório: Sim

***<LABEL>***  
Rótulo da chave desencapsulada.  
Obrigatório: Sim

***<SESSION>***  
Cria uma chave de sessão que existe apenas na sessão atual. A chave não pode ser recuperada após o término da sessão.  
Obrigatório: não

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de desempacotamento for maior do que 1.

## Tópicos relacionados
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-seealso"></a>
+ [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)
+ [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)

# O comando key wrap na CLI do CloudHSM
<a name="cloudhsm_cli-key-wrap"></a>

O comando **key wrap** na CLI do CloudHSM exporta uma cópia criptografada de uma chave privada simétrica ou assimétrica do módulo de segurança de hardware (HSM) para um arquivo. Ao executar o comando **key wrap**, você especifica duas coisas: a chave a ser exportada e o arquivo de saída. A chave a ser exportada é uma chave no HSM que criptografará (encapsulará) a chave que você deseja exportar.

O comando **key wrap** não remove a chave do HSM nem impede que você use a chave em operações criptográficas. É possível exportar a mesma chave várias vezes. Para importar a chave criptografada novamente no HSM, use [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md). Somente o proprietário de uma chave, ou seja, o usuário de criptografia que a criou, pode encapsulá-la. Os usuários com quem essa chave é compartilhada podem usá-la somente em operações criptográficas.

O comando **key wrap** oferece consiste nos seguintes subcomandos:
+ [aes-gcm](cloudhsm_cli-key-wrap-aes-gcm.md)
+ [aes-no-pad](cloudhsm_cli-key-wrap-aes-no-pad.md)
+ [aes-pkcs5-pad](cloudhsm_cli-key-wrap-aes-pkcs5-pad.md)
+ [aes-zero-pad](cloudhsm_cli-key-wrap-aes-zero-pad.md)
+ [cloudhsm-aes-gcm](cloudhsm_cli-key-wrap-cloudhsm-aes-gcm.md)
+ [rsa-aes](cloudhsm_cli-key-wrap-rsa-aes.md)
+ [rsa-oaep](cloudhsm_cli-key-wrap-rsa-oaep.md)
+ [rsa-pkcs](cloudhsm_cli-key-wrap-rsa-pkcs.md)

# Encapsular uma chave com o AES-GCM usando a CloudHSM CLI
<a name="cloudhsm_cli-key-wrap-aes-gcm"></a>

Use o comando **key wrap aes-gcm** na CloudHSM CLI para encapsular uma chave de carga útil usando uma chave AES no módulo de segurança de hardware (HSM) e no mecanismo de encapsulamento `AES-GCM`. O atributo `extractable` da chave de carga útil deve ser definido como `true`.

Somente o proprietário de uma chave, ou seja, o usuário de criptografia que a criou, pode encapsulá-la. Os usuários que compartilham a chave podem usá-la em operações criptográficas.

Para usar o **key wrap aes-gcm** comando, primeiro você deve ter uma chave AES em seu AWS CloudHSM cluster. Você pode gerar uma chave AES para encapsular com o comando [Gerar uma chave AES simétrica com a CloudHSM CLI](cloudhsm_cli-key-generate-symmetric-aes.md) e o atributo `wrap` definido como `true`.

## Tipo de usuário
<a name="cloudhsm_cli-key-wrap-aes-gcm-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-wrap-aes-gcm-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-wrap-aes-gcm-syntax"></a>

```
aws-cloudhsm > help key wrap aes-gcm
Usage: key wrap aes-gcm [OPTIONS] --payload-filter [<PAYLOAD_FILTER>...] --wrapping-filter [<WRAPPING_FILTER>...] --tag-length-bits <TAG_LENGTH_BITS>

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
      --payload-filter [<PAYLOAD_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 payload key
      --wrapping-filter [<WRAPPING_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 wrapping key
      --path <PATH>
          Path to the binary file where the wrapped key data will be saved
      --wrapping-approval <WRAPPING_APPROVALR>
          File path of signed quorum token file to approve operation for wrapping key
      --payload-approval <PAYLOAD_APPROVALR>
          File path of signed quorum token file to approve operation for payload key
      --aad <AAD>
          Aes GCM Additional Authenticated Data (AAD) value, in hex
      --tag-length-bits <TAG_LENGTH_BITS>
          Aes GCM tag length in bits
  -h, --help
          Print help
```

## Exemplo
<a name="cloudhsm_cli-key-wrap-aes-gcm-examples"></a>

Este exemplo mostra como usar o comando **key wrap aes-gcm** usando uma chave AES.

**Example**  

```
aws-cloudhsm > key wrap aes-gcm --payload-filter attr.label=payload-key --wrapping-filter attr.label=aes-example --tag-length-bits 64  --aad 0x10
{
  "error_code": 0,
  "data": {
    "payload_key_reference": "0x00000000001c08f1",
    "wrapping_key_reference": "0x00000000001c08ea",
    "iv": "0xf90613bb8e337ec0339aad21",
    "wrapped_key_data": "xvslgrtg8kHzrvekny97tLSIeokpPwV8"
  }
}
```

## Argumentos
<a name="cloudhsm_cli-key-wrap-aes-gcm-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<PAYLOAD\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de carga útil.  
Obrigatório: Sim

***<PATH>***  
Caminho para o arquivo binário em que os dados da chave encapsulada serão salvos.  
Obrigatório: não

***<WRAPPING\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de encapsulamento.   
Obrigatório: Sim

***<AAD>***  
Valor de dados autenticados adicionais (AAD) do AES GCM, em hexadecimal.   
Obrigatório: não

***<TAG\$1LENGTH\$1BITS>***  
Comprimento do rótulo AES GCM em bits.  
Obrigatório: Sim

***<WRAPPING\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de encapsulamento. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de encapsulamento for maior do que 1.

***<PAYLOAD\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de carga útil. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de carga útil for maior do que 1.

## Tópicos relacionados
<a name="cloudhsm_cli-key-wrap-aes-gcm-seealso"></a>
+ [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)
+ [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)

# Envolva uma chave AES-NO-PAD usando a CLI do CloudHSM
<a name="cloudhsm_cli-key-wrap-aes-no-pad"></a>

Use o comando **key wrap aes-no-pad** na CloudHSM CLI para encapsular uma chave de carga útil usando uma chave AES no módulo de segurança de hardware (HSM) e no mecanismo de encapsulamento `AES-NO-PAD`. O atributo `extractable` da chave de carga útil deve ser definido como `true`.

Somente o proprietário de uma chave, ou seja, o usuário de criptografia que a criou, pode encapsulá-la. Os usuários que compartilham a chave podem usá-la em operações criptográficas.

Para usar o **key wrap aes-no-pad** comando, primeiro você deve ter uma chave AES em seu AWS CloudHSM cluster. Você pode gerar uma chave AES para encapsular usando o comando [Gerar uma chave AES simétrica com a CloudHSM CLI](cloudhsm_cli-key-generate-symmetric-aes.md) e o atributo `wrap` definido como `true`.

## Tipo de usuário
<a name="cloudhsm_cli-key-wrap-aes-no-pad-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-wrap-aes-no-pad-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-wrap-aes-no-pad-syntax"></a>

```
aws-cloudhsm > help key wrap aes-no-pad
Usage: key wrap aes-no-pad [OPTIONS] --payload-filter [<PAYLOAD_FILTER>...] --wrapping-filter [<WRAPPING_FILTER>...]

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
      --payload-filter [<PAYLOAD_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 payload key
      --wrapping-filter [<WRAPPING_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 wrapping key
      --path <PATH>
          Path to the binary file where the wrapped key data will be saved
      --wrapping-approval <WRAPPING_APPROVALR>
          File path of signed quorum token file to approve operation for wrapping key
      --payload-approval <PAYLOAD_APPROVALR>
          File path of signed quorum token file to approve operation for payload key
  -h, --help
          Print help
```

## Exemplo
<a name="cloudhsm_cli-key-wrap-aes-no-pad-examples"></a>

Este exemplo mostra como usar o comando **key wrap aes-no-pad** usando uma chave AES com o valor do atributo `wrap` definido como `true`.

**Example**  

```
aws-cloudhsm > key wrap aes-no-pad --payload-filter attr.label=payload-key --wrapping-filter attr.label=aes-example
{
  "error_code": 0,
  "data": {
    "payload_key_reference": "0x00000000001c08f1",
    "wrapping_key_reference": "0x00000000001c08ea",
    "wrapped_key_data": "eXK3PMAOnKM9y3YX6brbhtMoC060EOH9"
  }
}
```

## Argumentos
<a name="cloudhsm_cli-key-wrap-aes-no-pad-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<PAYLOAD\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de carga útil.  
Obrigatório: Sim

***<PATH>***  
Caminho para o arquivo binário em que os dados da chave encapsulada serão salvos.  
Obrigatório: não

***<WRAPPING\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de encapsulamento.   
Obrigatório: Sim

***<WRAPPING\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de encapsulamento. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de encapsulamento for maior do que 1.

***<PAYLOAD\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de carga útil. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de carga útil for maior do que 1.

## Tópicos relacionados
<a name="cloudhsm_cli-key-wrap-aes-no-pad-seealso"></a>
+ [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)
+ [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)

# Encapsular uma chave com AES- PKCS5 -PAD usando o CloudHSM CLI
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad"></a>

Use o comando **key wrap aes-pkcs5-pad** na CloudHSM CLI para encapsular uma chave de carga útil usando uma chave AES no módulo de segurança de hardware (HSM) e no mecanismo de encapsulamento `AES-PKCS5-PAD`. O atributo `extractable` da chave de carga útil deve ser definido como `true`.

Somente o proprietário de uma chave, ou seja, o usuário de criptografia que a criou, pode encapsulá-la. Os usuários que compartilham a chave podem usá-la em operações criptográficas.

Para usar o **key wrap aes-pkcs5-pad** comando, primeiro você deve ter uma chave AES em seu AWS CloudHSM cluster. Você pode gerar uma chave AES para encapsular usando o comando [Gerar uma chave AES simétrica com a CloudHSM CLI](cloudhsm_cli-key-generate-symmetric-aes.md) e o atributo `wrap` definido como `true`.

## Tipo de usuário
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-syntax"></a>

```
aws-cloudhsm > help key wrap aes-pkcs5-pad
Usage: key wrap aes-pkcs5-pad [OPTIONS] --payload-filter [<PAYLOAD_FILTER>...] --wrapping-filter [<WRAPPING_FILTER>...]

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
      --payload-filter [<PAYLOAD_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 payload key
      --wrapping-filter [<WRAPPING_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 wrapping key
      --path <PATH>
          Path to the binary file where the wrapped key data will be saved
      --wrapping-approval <WRAPPING_APPROVALR>
          File path of signed quorum token file to approve operation for wrapping key
      --payload-approval <PAYLOAD_APPROVALR>
          File path of signed quorum token file to approve operation for payload key
  -h, --help
          Print help
```

## Exemplo
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-examples"></a>

Este exemplo mostra como usar o comando **key wrap aes-pkcs5-pad** usando uma chave AES com o valor do atributo `wrap` definido como `true`.

**Example**  

```
aws-cloudhsm > key wrap aes-pkcs5-pad --payload-filter attr.label=payload-key --wrapping-filter attr.label=aes-example
{
  "error_code": 0,
  "data": {
    "payload_key_reference": "0x00000000001c08f1",
    "wrapping_key_reference": "0x00000000001c08ea",
    "wrapped_key_data": "MbuYNresfOKyGNnxKWen88nSfX+uUE/0qmGofSisicY="
  }
}
```

## Argumentos
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<PAYLOAD\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de carga útil.  
Obrigatório: Sim

***<PATH>***  
Caminho para o arquivo binário em que os dados da chave encapsulada serão salvos.  
Obrigatório: não

***<WRAPPING\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de encapsulamento.   
Obrigatório: Sim

***<WRAPPING\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de encapsulamento. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de encapsulamento for maior do que 1.

***<PAYLOAD\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de carga útil. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de carga útil for maior do que 1.

## Tópicos relacionados
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-seealso"></a>
+ [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)
+ [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)

# Envolva uma chave AES-ZERO-PAD usando a CLI do CloudHSM
<a name="cloudhsm_cli-key-wrap-aes-zero-pad"></a>

Use o comando **key wrap aes-zero-pad** na CloudHSM CLI para encapsular uma chave de carga útil usando uma chave AES no módulo de segurança de hardware (HSM) e o mecanismo de encapsulamento `AES-ZERO-PAD`. O atributo `extractable` da chave de carga útil deve ser definido como `true`.

Somente o proprietário de uma chave, ou seja, o usuário de criptografia que a criou, pode encapsulá-la. Os usuários que compartilham a chave podem usá-la em operações criptográficas.

Para usar o **key wrap aes-zero-pad** comando, primeiro você deve ter uma chave AES em seu AWS CloudHSM cluster. Você pode gerar uma chave AES para encapsular usando o comando [Gerar uma chave AES simétrica com a CloudHSM CLI](cloudhsm_cli-key-generate-symmetric-aes.md) com o atributo `wrap` definido como `true`.

## Tipo de usuário
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-syntax"></a>

```
aws-cloudhsm > help key wrap aes-zero-pad
Usage: key wrap aes-zero-pad [OPTIONS] --payload-filter [<PAYLOAD_FILTER>...] --wrapping-filter [<WRAPPING_FILTER>...]

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
      --payload-filter [<PAYLOAD_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 payload key
      --wrapping-filter [<WRAPPING_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 wrapping key
      --path <PATH>
          Path to the binary file where the wrapped key data will be saved
      --wrapping-approval <WRAPPING_APPROVALR>
          File path of signed quorum token file to approve operation for wrapping key
      --payload-approval <PAYLOAD_APPROVALR>
          File path of signed quorum token file to approve operation for payload key
  -h, --help
          Print help
```

## Exemplo
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-examples"></a>

Este exemplo mostra como usar o comando **key wrap aes-zero-pad ** usando uma chave AES com o valor do atributo `wrap` definido como `true`.

**Example**  

```
aws-cloudhsm > key wrap aes-zero-pad --payload-filter attr.label=payload-key --wrapping-filter attr.label=aes-example
{
  "error_code": 0,
  "data": {
    "payload_key_reference": "0x00000000001c08f1",
    "wrapping_key_reference": "0x00000000001c08ea",
    "wrapped_key_data": "L1wVlL/YeBNVAw6Mpk3owFJZXBzDLONt"
  }
}
```

## Argumentos
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<PAYLOAD\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de carga útil.  
Obrigatório: Sim

***<PATH>***  
Caminho para o arquivo binário em que os dados da chave encapsulada serão salvos.  
Obrigatório: não

***<WRAPPING\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de encapsulamento.   
Obrigatório: Sim

***<WRAPPING\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de encapsulamento. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de encapsulamento for maior do que 1.

***<PAYLOAD\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de carga útil. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de carga útil for maior do que 1.

## Tópicos relacionados
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-seealso"></a>
+ [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)
+ [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)

# Envolva uma chave CLOUDHSM-AES-GCM usando a CLI do CloudHSM
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm"></a>

Use o comando **key wrap cloudhsm-aes-gcm** na CloudHSM CLI para encapsular uma chave de carga útil usando uma chave AES no módulo de segurança de hardware (HSM) e no mecanismo de encapsulamento `CLOUDHSM-AES-GCM`. O atributo `extractable` da chave de carga útil deve ser definido como `true`.

Somente o proprietário de uma chave, ou seja, o usuário de criptografia que a criou, pode encapsulá-la. Os usuários que compartilham a chave podem usá-la em operações criptográficas.

Para usar o **key wrap cloudhsm-aes-gcm** comando, primeiro você deve ter uma chave AES em seu AWS CloudHSM cluster. Você pode gerar uma chave AES para encapsular com o comando [Gerar uma chave AES simétrica com a CloudHSM CLI](cloudhsm_cli-key-generate-symmetric-aes.md) e o atributo `wrap` definido como `true`.

## Tipo de usuário
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-syntax"></a>

```
aws-cloudhsm > help key wrap cloudhsm-aes-gcm
Usage: key wrap cloudhsm-aes-gcm [OPTIONS] --payload-filter [<PAYLOAD_FILTER>...] --wrapping-filter [<WRAPPING_FILTER>...] --tag-length-bits <TAG_LENGTH_BITS>

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
      --payload-filter [<PAYLOAD_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 payload key
      --wrapping-filter [<WRAPPING_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 wrapping key
      --path <PATH>
          Path to the binary file where the wrapped key data will be saved
      --wrapping-approval <WRAPPING_APPROVALR>
          File path of signed quorum token file to approve operation for wrapping key
      --payload-approval <PAYLOAD_APPROVALR>
          File path of signed quorum token file to approve operation for payload key
      --aad <AAD>
          Aes GCM Additional Authenticated Data (AAD) value, in hex
      --tag-length-bits <TAG_LENGTH_BITS>
          Aes GCM tag length in bits
  -h, --help
          Print help
```

## Exemplo
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-examples"></a>

Este exemplo mostra como usar o comando **key wrap cloudhsm-aes-gcm** usando uma chave AES.

**Example**  

```
aws-cloudhsm > key wrap cloudhsm-aes-gcm --payload-filter attr.label=payload-key --wrapping-filter attr.label=aes-example --tag-length-bits 64 --aad 0x10
{
  "error_code": 0,
  "data": {
    "payload_key_reference": "0x00000000001c08f1",
    "wrapping_key_reference": "0x00000000001c08ea",
    "wrapped_key_data": "6Rn8nkjEriDYlnP3P8nPkYQ8hplOEJ899zsrF+aTB0i/fIlZ"
  }
}
```

## Argumentos
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<PAYLOAD\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de carga útil.  
Obrigatório: Sim

***<PATH>***  
Caminho para o arquivo binário em que os dados da chave encapsulada serão salvos.  
Obrigatório: não

***<WRAPPING\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de encapsulamento.   
Obrigatório: Sim

***<AAD>***  
Valor de dados autenticados adicionais (AAD) do AES GCM, em hexadecimal.   
Obrigatório: não

***<TAG\$1LENGTH\$1BITS>***  
Comprimento do rótulo AES GCM em bits.  
Obrigatório: Sim

***<WRAPPING\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de encapsulamento. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de encapsulamento for maior do que 1.

***<PAYLOAD\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de carga útil. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de carga útil for maior do que 1.

## Tópicos relacionados
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-seealso"></a>
+ [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)
+ [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)

# Criar uma chave com o RSA-AES usando a CloudHSM CLI
<a name="cloudhsm_cli-key-wrap-rsa-aes"></a>

Use o comando **key wrap rsa-aes** na CloudHSM CLI para encapsular uma chave de carga útil usando uma chave pública RSA no módulo de segurança de hardware (HSM) e no mecanismo de encapsulamento RSA-AES. O atributo `extractable` da chave de carga útil deve ser definido como `true`.

Somente o proprietário de uma chave, ou seja, o usuário de criptografia que a criou, pode encapsulá-la. Os usuários que compartilham a chave podem usá-la em operações criptográficas.

Para usar o **key wrap rsa-aes** comando, primeiro você deve ter uma chave RSA em seu AWS CloudHSM cluster. Você pode gerar um par de chaves RSA usando o comando [A generate-asymmetric-pair categoria na CLI do CloudHSM](cloudhsm_cli-key-generate-asymmetric-pair.md) e o atributo `wrap` definido como `true`.

## Tipo de usuário
<a name="cloudhsm_cli-key-wrap-rsa-aes-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-wrap-rsa-aes-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-wrap-rsa-aes-syntax"></a>

```
aws-cloudhsm > help key wrap rsa-aes
Usage: key wrap rsa-aes [OPTIONS] --payload-filter [<PAYLOAD_FILTER>...] --wrapping-filter [<WRAPPING_FILTER>...] --hash-function <HASH_FUNCTION> --mgf <MGF>

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
      --payload-filter [<PAYLOAD_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 payload key
      --wrapping-filter [<WRAPPING_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 wrapping key
      --path <PATH>
          Path to the binary file where the wrapped key data will be saved
      --wrapping-approval <WRAPPING_APPROVALR>
          File path of signed quorum token file to approve operation for wrapping key
      --payload-approval <PAYLOAD_APPROVALR>
          File path of signed quorum token file to approve operation for payload key
      --hash-function <HASH_FUNCTION>
          Hash algorithm [possible values: sha1, sha224, sha256, sha384, sha512]
      --mgf <MGF>
          Mask Generation Function algorithm [possible values: mgf1-sha1, mgf1-sha224, mgf1-sha256, mgf1-sha384, mgf1-sha512]
  -h, --help
          Print help
```

## Exemplo
<a name="cloudhsm_cli-key-wrap-rsa-aes-examples"></a>

Este exemplo mostra como usar o comando **key wrap rsa-ae** usando uma chave pública RSA com o valor do atributo `wrap` definido como `true`.

**Example**  

```
aws-cloudhsm > key wrap rsa-aes --payload-filter attr.label=payload-key --wrapping-filter attr.label=rsa-public-key-example --hash-function sha256 --mgf mgf1-sha256
{
  "error_code": 0,
  "data": {
    "payload-key-reference": "0x00000000001c08f1",
    "wrapping-key-reference": "0x00000000007008da",
    "wrapped-key-data": "HrSE1DEyLjIeyGdPa9R+ebiqB5TIJGyamPker31ZebPwRA+NcerbAJO8DJ1lXPygZcI21vIFSZJuWMEiWpe1R9D/5WSYgxLVKex30xCFqebtEzxbKuv4DOmU4meSofqREYvtb3EoIKwjyxCMRQFgoyUCuP4y0f0eSv0k6rSJh4NuCsHptXZbtgNeRcR4botN7LlzkEIUcq4fVHaatCwd0J1QGKHKyRhkol+RL5WGXKe4nAboAkC5GO7veI5yHL1SaKlssSJtTL/CFpbSLsAFuYbv/NUCWwMY5mwyVTCSlw+HlgKK+5TH1MzBaSi8fpfyepLT8sHy2Q/VRl6ifb49p6m0KQFbRVvz/OWUd6l4d97BdgtaEz6ueg=="
  }
}
```

## Argumentos
<a name="cloudhsm_cli-key-wrap-rsa-aes-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<PAYLOAD\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de carga útil.  
Obrigatório: Sim

***<PATH>***  
Caminho para o arquivo binário em que os dados da chave encapsulada serão salvos.  
Obrigatório: não

***<WRAPPING\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de encapsulamento.   
Obrigatório: Sim

***<MGF>***  
Especifica a função de geração da máscara.  
A função hash da função de geração de máscara deve corresponder à função hash do mecanismo de assinatura.
Valores válidos  
+ mgf1-sha1
+ mgf1-sha224
+ mgf1-sha256
+ mgf1-sha384
+ mgf1-sha512
Obrigatório: Sim

***<WRAPPING\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de encapsulamento. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de encapsulamento for maior do que 1.

***<PAYLOAD\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de carga útil. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de carga útil for maior do que 1.

## Tópicos relacionados
<a name="cloudhsm_cli-key-wrap-rsa-aes-seealso"></a>
+ [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)
+ [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)

# Encapsular uma chave com o RSA-OAEP usando a CloudHSM CLI
<a name="cloudhsm_cli-key-wrap-rsa-oaep"></a>

Use o comando **key wrap rsa-oaep** na CloudHSM CLI para encapsular uma chave de carga útil usando uma chave pública RSA no módulo de segurança de hardware (HSM) e no mecanismo de encapsulamento `RSA-OAEP`. O atributo `extractable` da chave de carga útil deve ser definido como `true`.

Somente o proprietário de uma chave, ou seja, o usuário de criptografia que a criou, pode encapsulá-la. Os usuários que compartilham a chave podem usá-la em operações criptográficas.

Para usar o **key wrap rsa-oaep** comando, primeiro você deve ter uma chave RSA em seu AWS CloudHSM cluster. Você pode gerar um par de chaves RSA usando o comando [A generate-asymmetric-pair categoria na CLI do CloudHSM](cloudhsm_cli-key-generate-asymmetric-pair.md) e o atributo `wrap` definido como `true`.

## Tipo de usuário
<a name="cloudhsm_cli-key-unwrap-rsa-aes-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-unwrap-rsa-aes-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-unwrap-rsa-aes-syntax"></a>

```
aws-cloudhsm > help key wrap rsa-oaep
Usage: key wrap rsa-oaep [OPTIONS] --payload-filter [<PAYLOAD_FILTER>...] --wrapping-filter [<WRAPPING_FILTER>...] --hash-function <HASH_FUNCTION> --mgf <MGF>

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
      --payload-filter [<PAYLOAD_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 payload key
      --wrapping-filter [<WRAPPING_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 wrapping key
      --path <PATH>
          Path to the binary file where the wrapped key data will be saved
      --wrapping-approval <WRAPPING_APPROVALR>
          File path of signed quorum token file to approve operation for wrapping key
      --payload-approval <PAYLOAD_APPROVALR>
          File path of signed quorum token file to approve operation for payload key
      --hash-function <HASH_FUNCTION>
          Hash algorithm [possible values: sha1, sha224, sha256, sha384, sha512]
      --mgf <MGF>
          Mask Generation Function algorithm [possible values: mgf1-sha1, mgf1-sha224, mgf1-sha256, mgf1-sha384, mgf1-sha512]
  -h, --help
          Print help
```

## Exemplo
<a name="cloudhsm_cli-key-unwrap-rsa-aes-examples"></a>

Este exemplo mostra como usar o comando **key wrap rsa-oaep** usando uma chave pública RSA com o valor do atributo `wrap` definido como `true`.

**Example**  

```
aws-cloudhsm > key wrap rsa-oaep --payload-filter attr.label=payload-key --wrapping-filter attr.label=rsa-public-key-example --hash-function sha256 --mgf mgf1-sha256
{
  "error_code": 0,
  "data": {
    "payload-key-reference": "0x00000000001c08f1",
    "wrapping-key-reference": "0x00000000007008da",
    "wrapped-key-data": "OjJe4msobPLz9TuSAdULEu17T5rMDWtSlLyBSkLbaZnYzzpdrhsbGLbwZJCtB/jGkDNdB4qyTAOQwEpggGf6v+Yx6JcesNeKKNU8XZal/YBoHC8noTGUSDI2qr+u2tDc84NPv6d+F2KOONXsSxMhmxzzNG/gzTVIJhOuy/B1yHjGP4mOXoDZf5+7f5M1CjxBmz4Vva/wrWHGCSG0yOaWblEvOiHAIt3UBdyKmU+/My4xjfJv7WGGu3DFUUIZ06TihRtKQhUYU1M9u6NPf9riJJfHsk6QCuSZ9yWThDT9as6i7e3htnyDhIhGWaoK8JU855cN/YNKAUqkNpC4FPL3iw=="
  }
}
```

## Argumentos
<a name="cloudhsm_cli-key-unwrap-rsa-aes-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<PAYLOAD\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de carga útil.  
Obrigatório: Sim

***<PATH>***  
Caminho para o arquivo binário em que os dados da chave encapsulada serão salvos.  
Obrigatório: não

***<WRAPPING\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de encapsulamento.   
Obrigatório: Sim

***<MGF>***  
Especifica a função de geração da máscara.  
A função hash da função de geração de máscara deve corresponder à função hash do mecanismo de assinatura.
Valores válidos  
+ mgf1-sha1
+ mgf1-sha224
+ mgf1-sha256
+ mgf1-sha384
+ mgf1-sha512
Obrigatório: Sim

***<WRAPPING\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de encapsulamento. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de encapsulamento for maior do que 1.

***<PAYLOAD\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de carga útil. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de carga útil for maior do que 1.

## Tópicos relacionados
<a name="cloudhsm_cli-key-unwrap-rsa-aes-seealso"></a>
+ [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)
+ [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)

# Criar uma chave com o RSA-PKCS usando a CloudHSM CLI
<a name="cloudhsm_cli-key-wrap-rsa-pkcs"></a>

Use o comando **key wrap rsa-pkcs** na CloudHSM CLI para encapsular uma chave de carga útil usando uma chave pública RSA no módulo de segurança de hardware (HSM) e no mecanismo de encapsulamento `RSA-PKCS`. O atributo `extractable` da chave de carga útil deve ser definido como `true`.

Somente o proprietário de uma chave, ou seja, o usuário de criptografia que a criou, pode encapsulá-la. Os usuários que compartilham a chave podem usá-la em operações criptográficas.

Para usar o **key wrap rsa-pkcs** comando, primeiro você deve ter uma chave RSA em seu AWS CloudHSM cluster. Você pode gerar um par de chaves RSA usando o comando [A generate-asymmetric-pair categoria na CLI do CloudHSM](cloudhsm_cli-key-generate-asymmetric-pair.md) e o atributo `wrap` definido como `true`.

## Tipo de usuário
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-userType"></a>

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

## Requisitos
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-requirements"></a>
+ Para executar esse comando, você deve estar registrado(a) como um CU.

## Sintaxe
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-syntax"></a>

```
aws-cloudhsm > help key wrap rsa-pkcs
Usage: key wrap rsa-pkcs [OPTIONS] --payload-filter [<PAYLOAD_FILTER>...] --wrapping-filter [<WRAPPING_FILTER>...]

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
      --payload-filter [<PAYLOAD_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 payload key
      --wrapping-filter [<WRAPPING_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 wrapping key
      --path <PATH>
          Path to the binary file where the wrapped key data will be saved
      --wrapping-approval <WRAPPING_APPROVALR>
          File path of signed quorum token file to approve operation for wrapping key
      --payload-approval <PAYLOAD_APPROVALR>
          File path of signed quorum token file to approve operation for payload key
  -h, --help
          Print help
```

## Exemplo
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-examples"></a>

Este exemplo mostra como usar o comando **key wrap rsa-pkcs** usando uma chave pública RSA.

**Example**  

```
aws-cloudhsm > key wrap rsa-pkcs --payload-filter attr.label=payload-key --wrapping-filter attr.label=rsa-public-key-example
{
  "error_code": 0,
  "data": {
    "payload_key_reference": "0x00000000001c08f1",
    "wrapping_key_reference": "0x00000000007008da",
    "wrapped_key_data": "am0Nc7+YE8FWs+5HvU7sIBcXVb24QA0l65nbNAD+1bK+e18BpSfnaI3P+r8Dp+pLu1ofoUy/vtzRjZoCiDofcz4EqCFnGl4GdcJ1/3W/5WRvMatCa2d7cx02swaeZcjKsermPXYRO1lGlfq6NskwMeeTkV8R7Rx9artFrs1y0DdIgIKVaiFHwnBIUMnlQrR2zRmMkfwU1jxMYmOYyD031F5VbnjSrhfMwkww2la7uf/c3XdFJ2+0Bo94c6og/yfPcpOOobJlITCoXhtMRepSdO4OggYq/6nUDuHCtJ86pPGnNahyr7+sAaSI3a5ECQLUjwaIARUCyoRh7EFK3qPXcg=="
  }
```

## Argumentos
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<PAYLOAD\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de carga útil.  
Obrigatório: Sim

***<PATH>***  
Caminho para o arquivo binário em que os dados da chave encapsulada serão salvos.  
Obrigatório: não

***<WRAPPING\$1FILTER>***  
Referência de chave (por exemplo, `key-reference=0xabc`) ou lista separada por espaços de atributos de chave na forma de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` selecionar uma chave de encapsulamento.   
Obrigatório: Sim

***<WRAPPING\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de encapsulamento. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de encapsulamento for maior do que 1.

***<PAYLOAD\$1APPROVALR>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação da chave de carga útil. Exigido somente se o valor do quórum do serviço de gerenciamento de chaves da chave de carga útil for maior do que 1.

## Tópicos relacionados
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-seealso"></a>
+ [O comando key wrap na CLI do CloudHSM](cloudhsm_cli-key-wrap.md)
+ [O comando key unwrap na CLI do CloudHSM](cloudhsm_cli-key-unwrap.md)

# Fazer login em um HSM usando a CLI do CloudHSM
<a name="cloudhsm_cli-login"></a>

Você pode usar o **login** comando na CLI do CloudHSM para entrar e sair de cada segurança de hardware (HSM) em um cluster. AWS CloudHSM Esse comando tem o subcomando a seguir:
+ [mfa-token-sign](cloudhsm_cli-login-mfa-token-sign.md)

**nota**  
Se você exceder cinco tentativas incorretas de login, sua conta será bloqueada. Para desbloquear a conta, um administrador deve redefinir sua senha usando o comando [user change-password](cloudhsm_cli-user-change-password.md) em cloudhsm\$1cli.

## Para solucionar problemas de login e logout
<a name="troubleshoot-login-logout"></a>

Se você tiver mais de um HSM no cluster, pode ser que mais tentativas de login sejam permitidas antes de a sua conta ser bloqueada. Isso ocorre porque o cliente CloudHSM equilibra a carga em vários. HSMs Sendo assim, pode ser que as tentativas de login não comecem sempre no mesmo HSM. Se você estiver testando essa funcionalidade, recomendamos fazer isso em um cluster com apenas um HSM ativo. 

Se você criou seu cluster antes de fevereiro de 2018, sua conta será bloqueada após 20 tentativas incorretas de login. 

## Tipo de usuário
<a name="chsm-cli-login-logout-userType"></a>

Os usuários a seguir podem executar esses comandos.
+ Administrador desativado
+ Administrador
+ Crypto user (CU) (usuário de criptografia)

## Sintaxe
<a name="chsm-cli-login-syntax"></a>

```
aws-cloudhsm > help login
Login to your cluster  
        
USAGE:
    cloudhsm-cli login [OPTIONS] --username <USERNAME> --role <ROLE> [COMMAND]
    
Commands:
  mfa-token-sign  Login with token-sign mfa
  help            Print this message or the help of the given subcommand(s)

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

        --username <USERNAME>
            Username to access the Cluster
        
        --role <ROLE>
            Role the user has in the Cluster
            
           Possible values:
           - crypto-user: A CryptoUser has the ability to manage and use keys
           - admin:       An Admin has the ability to manage user accounts

        --password <PASSWORD>
           Optional: Plaintext user's password. If you do not include this argument you will be prompted for it

  -h, --help
          Print help (see a summary with '-h')
```

## Exemplo
<a name="chsm-cli-login-example"></a>

**Example**  
Esse comando conecta você a todos HSMs em um cluster com as credenciais de um usuário administrador chamado`admin1`.  

```
aws-cloudhsm > login --username admin1 --role admin
Enter password:
{
  "error_code": 0,
  "data": {
    "username": "admin1",
    "role": "admin"
  }
}
```

## Argumentos
<a name="login-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<USERNAME>***  
Especifica um nome amigável para o usuário. O tamanho máximo é de 31 caracteres. O único caractere especial permitido é um sublinhado ( \$1 ). O nome de usuário não diferencia maiúsculas de minúsculas neste comando. O nome de usuário é sempre exibido em minúsculas.  
Obrigatório: Sim

***<ROLE>***  
Especifica a função atribuída a esse usuário. Os valores válidos são **admin**, **crypto-user**.  
Para obter a função do usuário, use o **user list** comando. Para obter informações detalhadas sobre os tipos de usuários em um HSM, consulte [Noções básicas dos usuários de HSM](manage-hsm-users.md).  
Obrigatório: Sim

***<PASSWORD>***  
Especifica a senha do usuário que está fazendo login no HSMs.  
Obrigatório: os clientes devem fornecer a senha por meio do argumento da linha de `--password` comando ou omiti-la para ser solicitada interativamente.  
Usar o `--password` argumento na linha de comando pode expor as credenciais em seu histórico de shell. Considere solicitar a senha de forma interativa ou limpar o histórico do shell após o uso.

## Tópicos relacionados
<a name="login-seeAlso"></a>
+ [Conceitos básicos sobre a CloudHSM CLI](cloudhsm_cli-getting-started.md)
+ [Ativar o cluster](activate-cluster.md)

# Fazer login com MFA em um HSM usando a CloudHSM CLI
<a name="cloudhsm_cli-login-mfa-token-sign"></a>

Use o **login mfa-token-sign** comando na CLI do AWS CloudHSM CloudHSM para fazer login em um módulo de segurança de hardware (HSM) usando autenticação multifator (MFA). Para usar esse comando, você precisa primeiro configurar a [MFA para a CloudHSM CLI](login-mfa-token-sign.md).

## Tipo de usuário
<a name="cloudhsm_cli-login-mfa-token-userType"></a>

Os usuários a seguir podem executar esses comandos.
+ Administrador
+ Crypto user (CU) (usuário de criptografia)

## Sintaxe
<a name="cloudhsm_cli-login-mfa-token-syntax"></a>

```
aws-cloudhsm > help login mfa-token-sign
Login with token-sign mfa

USAGE:
    login --username <username> --role <role> mfa-token-sign --token <token>

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
      --token <TOKEN>            Filepath where the unsigned token file will be written
  -h, --help                     Print help
```

## Exemplo
<a name="cloudhsm_cli-login-mfa-token-example"></a>

**Example**  

```
aws-cloudhsm > login --username test_user --role admin mfa-token-sign --token /home/valid.token
Enter password:
Enter signed token file path (press enter if same as the unsigned token file):
{
  "error_code": 0,
  "data": {
    "username": "test_user",
    "role": "admin"
  }
}
```

## Argumentos
<a name="cloudhsm_cli-login-mfa-token-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<TOKEN>***  
Caminho onde o arquivo de token não assinado será gravado.  
Obrigatório: Sim

## Tópicos relacionados
<a name="cloudhsm_cli-login-mfa-token-seeAlso"></a>
+ [Conceitos básicos sobre a CloudHSM CLI](cloudhsm_cli-getting-started.md)
+ [Ativar o cluster](activate-cluster.md)
+ [Usar a CloudHSM CLI para gerenciar a MFA](login-mfa-token-sign.md)

# Sair de um HSM usando a CLI do CloudHSM
<a name="cloudhsm_cli-logout"></a>

Use o **logout** comando na CLI do CloudHSM para sair de cada módulo de segurança de hardware (HSM) em um cluster. AWS CloudHSM 

## Tipo de usuário
<a name="chsm-cli-logout-userType"></a>

Os usuários a seguir podem executar este comando.
+ Administrador
+ Crypto user (CU) (usuário de criptografia)

## Sintaxe
<a name="chsm-cli-logout-syntax"></a>

```
aws-cloudhsm > help logout
Logout of your cluster

USAGE:
    logout

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
    -h, --help                    Print help information
    -V, --version                 Print version information
```

## Exemplo
<a name="chsm-cli-logout-example"></a>

**Example**  
Esse comando desconecta você de tudo HSMs em um cluster.  

```
aws-cloudhsm > logout
{
  "error_code": 0,
  "data": "Logout successful"
}
```

## Tópicos relacionados
<a name="logout-seeAlso"></a>
+ [Conceitos básicos sobre a CloudHSM CLI](cloudhsm_cli-getting-started.md)
+ [Ativar o cluster](activate-cluster.md)

# A categoria user na CLI do CloudHSM
<a name="cloudhsm_cli-user"></a>

Na CLI do CloudHSM, **user** é uma categoria principal para um grupo de comandos que, quando combinado com a categoria principal, cria um comando específico para usuários. Atualmente, a categoria de usuário consiste nos seguintes comandos:
+ [user change-mfa](cloudhsm_cli-user-change-mfa.md)
+ [alterar senha de usuário](cloudhsm_cli-user-change-password.md)
+ [criar usuário](cloudhsm_cli-user-create.md)
+ [excluir usuário](cloudhsm_cli-user-delete.md)
+ [ista de usuários](cloudhsm_cli-user-list.md)
+ [replicação do usuário](cloudhsm_cli-user-replicate.md)

# A categoria user change-mfa na CLI do CloudHSM
<a name="cloudhsm_cli-user-change-mfa"></a>

Na CLI do CloudHSM, **user change-mfa** é uma categoria principal para um grupo de comandos que, quando combinados com a categoria principal, criam um comando específico para mudar a autenticação multifator (MFA) para os usuários.

Atualmente, essa categoria consiste nos seguintes subcomandos:
+ [sinal de token](cloudhsm_cli-user-change-mfa-token-sign.md)

# Alterar a configuração de MFA de um usuário com a CLI do CloudHSM
<a name="cloudhsm_cli-user-change-mfa-token-sign"></a>

Use o comando **user change-mfa token-sign** na CLI do CloudHSM para atualizar a configuração de autenticação multifator (MFA) de uma conta de usuário. Qualquer conta de usuário pode executar esse comando. Contas com a função de administrador podem executar esse comando para outros usuários.

## Tipo de usuário
<a name="user-change-mfa-type"></a>

Os usuários a seguir podem executar este comando.
+ Administrador
+ Usuário de criptografia 

## Sintaxe
<a name="user-change-mfa-syntax"></a>

Atualmente, há apenas uma única estratégia multifatorial disponível para os usuários: Token Sign.

```
aws-cloudhsm > help user change-mfa
Change a user's Mfa Strategy

Usage:
    user change-mfa <COMMAND>
  
Commands:
  token-sign  Register or Deregister a public key using token-sign mfa strategy
  help        Print this message or the help of the given subcommand(s)
```

A estratégia Token Sign solicita um arquivo Token para gravar tokens não assinados.

```
aws-cloudhsm > help user change-mfa token-sign
Register or Deregister a public key using token-sign mfa strategy

Usage: user change-mfa token-sign [OPTIONS] --username <USERNAME> --role <ROLE> <--token <TOKEN>|--deregister>

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

      --username <USERNAME>
          Username of the user that will be modified

      --role <ROLE>
          Role the user has in the cluster

          Possible values:
          - crypto-user: A CryptoUser has the ability to manage and use keys
          - admin:       An Admin has the ability to manage user accounts

      --change-password <CHANGE_PASSWORD>
          Optional: Plaintext user's password. If you do not include this argument you will be prompted for it

      --token <TOKEN>
          Filepath where the unsigned token file will be written. Required for enabling MFA for a user

      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation

      --deregister
          Deregister the MFA public key, if present

      --change-quorum
          Change the Quorum public key along with the MFA key

  -h, --help
          Print help (see a summary with '-h')
```

## Exemplo
<a name="user-change-mfa-examples"></a>

Esse comando grava um token não assinado por HSM em seu cluster no arquivo especificado por `token`. Quando for solicitado, assine os tokens no arquivo.

**Example : grave um token não assinado por HSM em seu cluster**  

```
aws-cloudhsm > user change-mfa token-sign --username cu1 --change-password password --role crypto-user --token /path/myfile
Enter signed token file path (press enter if same as the unsigned token file):
Enter public key PEM file path:/path/mypemfile
{
  "error_code": 0,
  "data": {
    "username": "test_user",
    "role": "admin"
  }
}
```

### Argumentos
<a name="user-change-mfa-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<ROLE>***  
Especifica a função atribuída à conta do usuário. Esse parâmetro é obrigatório. Para obter informações detalhadas sobre os tipos de usuários em um HSM, consulte [Noções básicas dos usuários de HSM](manage-hsm-users.md).  
**Valores válidos**  
+ **Administrador**: os administradores podem gerenciar usuários, mas não podem gerenciar chaves.
+ **Usuário de criptografia**: usuários de criptografia podem criar chaves de gerenciamento e usar chaves em operações criptográficas.

***<USERNAME>***  
Especifica um nome amigável para o usuário. O tamanho máximo é de 31 caracteres. O único caractere especial permitido é um sublinhado ( \$1 ).  
Não é possível alterar o nome de um usuário após sua criação. Em comandos da CLI do CloudHSM, a função e a senha diferenciam maiúsculas de minúsculas, mas o nome do usuário não diferencia.  
**Obrigatório**: sim

***<CHANGE\$1PASSWORD>***  
Especifica a nova senha em texto simples do usuário cujo MFA está sendo registrado/cancelado.  
**Obrigatório**: sim

***<TOKEN>***  
Caminho onde o arquivo de token não assinado será gravado.  
**Obrigatório**: sim

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de usuário do quórum for maior que 1.

***<DEREGISTER>***  
Cancela o registro da chave pública da MFA, se presente.

***<CHANGE-QUORUM>***  
Altera a chave pública do quórum junto com a chave de MFA.

## Tópicos relacionados
<a name="user-change-mfa-seealso"></a>
+ [Noções básicas sobre 2FA para usuários de HSM](login-mfa-token-sign.md)

# Alterar a senha de um usuário com a CLI do CloudHSM
<a name="cloudhsm_cli-user-change-password"></a>

Use o **user change-password** comando na CLI do CloudHSM para alterar a senha de um usuário existente em seu cluster. AWS CloudHSM Para habilitar o MFA para um usuário, use o comando `user change-mfa`.

Qualquer usuário pode alterar sua própria senha. Além disso, os usuários com a função de administrador podem alterar a senha de outro usuário no cluster. Você não precisa inserir a senha atual para fazer a alteração.

**nota**  
No entanto, não é possível alterar a senha de um usuário que está conectado no momento ao cluster.

## Tipo de usuário
<a name="change-password-user-type"></a>

Os usuários a seguir podem executar este comando.
+ Administrador
+ Crypto user (CU) (usuário de criptografia)

## Sintaxe
<a name="change-password-syntax"></a>

**nota**  
 Para habilitar a autenticação multifator (MFA) para um usuário, use o comando **user change-mfa**.

```
aws-cloudhsm > help user change-password
Change a user's password

    Usage:
        cloudhsm-cli user change-password [OPTIONS] --username <USERNAME> --role <ROLE> [--password <PASSWORD>]
    
    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

      --username <USERNAME>
          Username of the user that will be modified

      --role <ROLE>
          Role the user has in the cluster

          Possible values:
          - crypto-user: A CryptoUser has the ability to manage and use keys
          - admin:       An Admin has the ability to manage user accounts

      --password <PASSWORD>
          Optional: Plaintext user's password. If you do not include this argument you will be prompted for it

      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
          
      --deregister-mfa <DEREGISTER-MFA>
          Deregister the user's mfa public key, if present
          
      --deregister-quorum <DEREGISTER-QUORUM>
          Deregister the user's quorum public key, if present
 -h, --help
          Print help (see a summary with '-h')
```

## Exemplo
<a name="change-password-examples"></a>

Os exemplos a seguir mostram como usar **user change-password** para redefinir a senha do usuário atual ou de qualquer outro usuário em seu cluster.

**Example : Alterar sua senha**  
Qualquer usuário no cluster pode usar **user change-password** para alterar sua própria senha.  
A saída a seguir mostra que Bob está atualmente conectado como um usuário de criptografia (CU).  

```
aws-cloudhsm > user change-password --username bob --role crypto-user
Enter password:
Confirm password:
{
  "error_code": 0,
  "data": {
    "username": "bob",
    "role": "crypto-user"
  }
}
```

## Argumentos
<a name="change-password-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de usuário do quórum for maior que 1.

***<DEREGISTER-MFA>***  
Cancela o registro da chave pública da MFA, se presente.

***<DEREGISTER-QUORUM>***  
Cancele o registro da chave pública do quórum, se estiver presente.

***<PASSWORD>***  
Especifica a nova senha em texto simples do usuário. Os seguintes caracteres não são aceitos ‘:’  
**Obrigatório**: sim

***<ROLE>***  
Especifica a função atribuída à conta do usuário. Esse parâmetro é obrigatório. Para obter informações detalhadas sobre os tipos de usuários em um HSM, consulte [Noções básicas dos usuários de HSM](manage-hsm-users.md).  
**Valores válidos**  
+ **Administrador**: os administradores podem gerenciar usuários, mas não podem gerenciar chaves.
+ **Usuário de criptografia**: usuários de criptografia podem criar chaves de gerenciamento e usar chaves em operações criptográficas.

***<USERNAME>***  
Especifica um nome amigável para o usuário. O tamanho máximo é de 31 caracteres. O único caractere especial permitido é um sublinhado ( \$1 ).  
Não é possível alterar o nome de um usuário após sua criação. Em comandos da CLI do CloudHSM, a função e a senha diferenciam maiúsculas de minúsculas, mas o nome do usuário não diferencia.  
**Obrigatório**: sim

## Tópicos relacionados
<a name="change-password-seealso"></a>
+ [lista de usuários](cloudhsm_cli-user-list.md)
+ [criar usuário](cloudhsm_cli-user-create.md)
+ [excluir usuário](cloudhsm_cli-user-delete.md)

# A categoria de quórum de alterações de usuário na CLI do CloudHSM
<a name="cloudhsm_cli-user-chqm"></a>

Na CLI do CloudHSM, **user change-quorum** é uma categoria principal para um grupo de comandos que, quando combinados com a categoria principal, criam um comando específico para mudar o quórum para os usuários.

**user change-quorum**é usado para registrar a autenticação de quórum de usuários usando uma estratégia de quórum especificada. A partir do SDK 5.8.0, há apenas uma única estratégia de quórum disponível para os usuários, conforme mostrado abaixo.

Atualmente, essa categoria consiste nos seguintes categorias e subcomandos:
+ [sinal de token](cloudhsm_cli-user-chqm-token.md)
  + [registro](cloudhsm_cli-user-chqm-token-reg.md)

# A categoria user change-quorum token-sign na CLI do CloudHSM
<a name="cloudhsm_cli-user-chqm-token"></a>

Na CLI do CloudHSM, **user change-quorum token-sign** é uma categoria principal para um grupo de comandos que, quando combinado com a categoria principal, cria um comando específico para operações de quórum de assinatura de token.

Atualmente, essa categoria consiste nos seguintes comandos:
+ [registro](cloudhsm_cli-user-chqm-token-reg.md)

# Registrar a estratégia de quórum de assinatura de token de um usuário usando a CLI do CloudHSM
<a name="cloudhsm_cli-user-chqm-token-reg"></a>

Use o comando **user change-quorum token-sign register** na CLI do CloudHSM para registrar a estratégia de quorum de assinatura de token para um usuário administrador.

## Tipo de usuário
<a name="token-register-user-type"></a>

Os usuários a seguir podem executar este comando.
+ Administrador

## Sintaxe
<a name="token-register-syntax"></a>

```
aws-cloudhsm > help user change-quorum token-sign register
Register a user for quorum authentication with a public key

Usage: user change-quorum token-sign register --public-key <PUBLIC_KEY> --signed-token <SIGNED_TOKEN>

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
      --public-key <PUBLIC_KEY>      Filepath to public key PEM file
      --signed-token <SIGNED_TOKEN>  Filepath with token signed by user private key
  -h, --help Print help (see a summary with '-h')
```

## Exemplo
<a name="token-register-examples"></a>

**Example**  
Para executar este comando, você precisará estar logado como o usuário que deseja **register quorum token-sign**.  

```
aws-cloudhsm > login --username admin1 --role admin
Enter password:
{
  "error_code": 0,
  "data": {
    "username": "admin1",
    "role": "admin"
  }
}
```
O comando **user change-quorum token-sign register** registrará sua chave pública no HSM. Como resultado, ele o qualificará como aprovador de quórum para operações exigidas por quórum que exijam que o usuário obtenha assinaturas de quórum para atingir o limite de valor de quórum necessário.  

```
aws-cloudhsm > user change-quorum token-sign register \
    --public-key /home/mypemfile \
    --signed-token /home/mysignedtoken
{
  "error_code": 0,
  "data": {
    "username": "admin1",
    "role": "admin"
  }
}
```
Agora você pode executar o comando **user list** e confirmar se o quorum token-sign foi registrado para esse usuário.  

```
aws-cloudhsm > user list
{
  "error_code": 0,
  "data": {
    "users": [
      {
        "username": "admin",
        "role": "admin",
        "locked": "false",
        "mfa": [],
        "quorum": [],
        "cluster-coverage": "full"
      },
      {
        "username": "admin1",
        "role": "admin",
        "locked": "false",
        "mfa": [],
        "quorum": [
          {        
            "strategy": "token-sign",
            "status": "enabled"
          }
        ],
        "cluster-coverage": "full"
      }
    ]
  }
}
```

## Argumentos
<a name="token-register-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<PUBLIC-KEY>***  
Caminho de arquivo para o arquivo PEM de chave pública.  
**Obrigatório**: sim

***<SIGNED-TOKEN>***  
Caminho de arquivo com token assinado pela chave privada do usuário.  
**Obrigatório**: sim

## Tópicos relacionados
<a name="token-register-seealso"></a>
+ [Usar a CLI do CloudHSM para gerenciar a autenticação de quórum](quorum-auth-chsm-cli.md)
+ [Usar a autenticação de quórum para administradores: configuração inicial](quorum-auth-chsm-cli-first-time.md)
+ [Altere o valor mínimo do quórum para administradores](quorum-auth-chsm-cli-min-value.md)
+ [Nomes e tipos de serviços que oferecem suporte à autenticação de quórum](quorum-auth-chsm-cli-service-names.md)

# Crie um AWS CloudHSM usuário com o CloudHSM CLI
<a name="cloudhsm_cli-user-create"></a>

O **user create** comando na CLI do CloudHSM cria um usuário no seu cluster. AWS CloudHSM Somente contas de usuário com a função de administrador podem executar esse comando.

## Tipo de usuário
<a name="user-create-userType"></a>

Os seguintes tipos de usuários podem executar este comando.
+ Administrador

## Requisitos
<a name="user-create-requirements"></a>

Para executar esse comando, você deve estar registrado em log como usuário administrador

## Sintaxe
<a name="user-create-syntax"></a>

```
aws-cloudhsm > help user create
Create a new user

Usage: cloudhsm-cli user create [OPTIONS] --username <USERNAME> --role <ROLE> [--password <PASSWORD>]

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

      --username <USERNAME>
          Username to access the HSM cluster

      --role <ROLE>
          Role the user has in the cluster

          Possible values:
          - crypto-user: A CryptoUser has the ability to manage and use keys
          - admin:       An Admin has the ability to manage user accounts

      --password <PASSWORD>
          Optional: Plaintext user's password. If you do not include this argument you will be prompted for it

      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation

  -h, --help
          Print help (see a summary with '-h')
```

## Exemplo
<a name="user-create-examples"></a>

Esses exemplos mostram como usar **user create** para criar novos usuários em seu HSMs.

**Example : criar um usuário de criptografia**  
Este exemplo cria uma conta em seu AWS CloudHSM cluster com a função de usuário criptográfico.  

```
aws-cloudhsm > user create --username alice --role crypto-user
Enter password:
Confirm password:
{
  "error_code": 0,
  "data": {
    "username": "alice",
    "role": "crypto-user"
  }
}
```

## Argumentos
<a name="user-create-arguments"></a>

*<CLUSTER\$1ID>*  
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)

*<USERNAME>*  
Especifica um nome amigável para o usuário. O tamanho máximo é de 31 caracteres. O único caractere especial permitido é um sublinhado ( \$1 ). O nome de usuário não diferencia maiúsculas de minúsculas neste comando. O nome de usuário é sempre exibido em minúsculas.  
Obrigatório: Sim

*<ROLE>*  
Especifica a função atribuída a esse usuário. Esse parâmetro é obrigatório. Os valores válidos são **admin**, **crypto-user**.  
Para obter a função do usuário, use o comando **user list**. Para obter informações detalhadas sobre os tipos de usuários em um HSM, consulte [Noções básicas dos usuários de HSM](manage-hsm-users.md).

*<PASSWORD>*  
Especifica a senha do usuário que está fazendo login no HSMs. Os seguintes caracteres não são aceitos ‘:’  
Obrigatório: Sim

*<APPROVAL>*  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de usuário do quórum for maior que 1.

## Tópicos relacionados
<a name="user-create-seealso"></a>
+ [lista de usuários](cloudhsm_cli-user-list.md)
+ [excluir usuário](cloudhsm_cli-user-delete.md)
+ [alterar senha de usuário](cloudhsm_cli-user-change-password.md)

# Excluir um AWS CloudHSM usuário com a CLI do CloudHSM
<a name="cloudhsm_cli-user-delete"></a>

O **user delete** comando na CLI do CloudHSM exclui um usuário do seu cluster. AWS CloudHSM Somente contas de usuário com a função de administrador podem executar esse comando. Você não pode excluir um usuário que esteja atualmente conectado a um HSM. 

## Tipo de usuário
<a name="user-delete-userType"></a>

Os seguintes tipos de usuários podem executar este comando.
+ Administrador

## Requisitos
<a name="user-delete-requirements"></a>
+ Você não pode excluir contas de usuários que possuem chaves.
+ Sua conta de usuário deve ter a função de administrador para executar esse comando.

## Sintaxe
<a name="user-delete-syntax"></a>

Como esses comandos não têm parâmetros específicos, insira os argumentos na ordem especificada nos diagramas de sintaxe.

```
aws-cloudhsm > help user delete
Delete a user

Usage: user delete [OPTIONS] --username <USERNAME> --role <ROLE>

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

      --username <USERNAME>
          Username to access the HSM cluster

      --role <ROLE>
          Role the user has in the cluster

          Possible values:
          - crypto-user: A CryptoUser has the ability to manage and use keys
          - admin:       An Admin has the ability to manage user accounts

      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation
```

## Exemplo
<a name="user-delete-examples"></a>

```
aws-cloudhsm > user delete --username alice --role crypto-user
{
  "error_code": 0,
  "data": {
    "username": "alice",
    "role": "crypto-user"
  }
}
```

## Argumentos
<a name="user-delete-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<USERNAME>***  
Especifica um nome amigável para o usuário. O tamanho máximo é de 31 caracteres. O único caractere especial permitido é um sublinhado ( \$1 ). O nome de usuário não diferencia maiúsculas de minúsculas neste comando. O nome de usuário é sempre exibido em minúsculas.  
Obrigatório: Sim

***<ROLE>***  
Especifica a função atribuída a esse usuário. Esse parâmetro é obrigatório. Os valores válidos são **admin**, **crypto-user**.  
Para obter a função do usuário, use o comando **user list**. Para obter informações detalhadas sobre os tipos de usuários em um HSM, consulte [Noções básicas dos usuários de HSM](manage-hsm-users.md).  
Obrigatório: Sim

***<APPROVAL>***  
Especifica o caminho do arquivo para um arquivo de token de quórum designado para aprovar a operação. Exigido somente se o valor do quórum do serviço de usuário do quórum for maior que 1.  
Obrigatório: Sim

## Tópicos relacionados
<a name="user-delete-seealso"></a>
+ [lista de usuários](cloudhsm_cli-user-list.md)
+ [criar usuário](cloudhsm_cli-user-create.md)
+ [alterar senha de usuário](cloudhsm_cli-user-change-password.md)

# Listar todos os AWS CloudHSM usuários com o CloudHSM CLI
<a name="cloudhsm_cli-user-list"></a>

O **user list** comando na CLI do CloudHSM lista as contas de usuário presentes no seu cluster. AWS CloudHSM Você não precisa estar conectado na CLI do CloudHSM para executar esse comando.

**nota**  
Se você adicionar ou excluir HSMs, atualize os arquivos de configuração que o AWS CloudHSM cliente e as ferramentas de linha de comando usam. Caso contrário, as alterações feitas podem não ser efetivas HSMs em todas as partes do cluster.

## Tipo de usuário
<a name="user-list-userType"></a>

Os seguintes tipos de usuários podem executar este comando.
+ Todos os usuários. Você não precisa estar conectado para executar esse comando.

## Sintaxe
<a name="chsm-cli-user-list-syntax"></a>

```
aws-cloudhsm > help user list
List the users in your cluster

USAGE:
    user list

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
  -h, --help                     Print help
```

## Exemplo
<a name="chsm-cli-user-list-examples"></a>

Este comando lista os usuários presentes em seu cluster do CloudHSM.

```
aws-cloudhsm > user list
{
  "error_code": 0,
  "data": {
    "users": [
      {
        "username": "admin",
        "role": "admin",
        "locked": "false",
        "mfa": [],
        "cluster-coverage": "full"
      },
      {
        "username": "test_user",
        "role": "admin",
        "locked": "false",
        "mfa": [
          {
            "strategy": "token-sign",
            "status": "enabled"
          }
        ],
        "cluster-coverage": "full"
      },
      {
        "username": "app_user",
        "role": "internal(APPLIANCE_USER)",
        "locked": "false",
        "mfa": [],
        "cluster-coverage": "full"
      }
    ]
  }
}
```

A saída inclui os seguintes atributos do usuário:
+ **User Name**: exibe o nome amigável definido pelo usuário para o usuário. O nome de usuário é sempre exibido em letras minúsculas. 
+ **Role**: determina as operações que o usuário pode executar no HSM.
+ **Bloqueado**: indica se essa conta de usuário foi bloqueada.
+ **MFA**: indica os mecanismos de autenticação multifatorial compatíveis com essa conta de usuário.
+ **Cobertura do cluster**: indica a disponibilidade dessa conta de usuário em todo o cluster.

## Tópicos relacionados
<a name="chsm-user-list-seealso"></a>
+ [listUsers](key_mgmt_util-listUsers.md) em key\$1mgmt\$1util
+ [criar usuário](cloudhsm_cli-user-create.md)
+ [excluir usuário](cloudhsm_cli-user-delete.md)
+ [alterar senha de usuário](cloudhsm_cli-user-change-password.md)

# Replicar um usuário com a CloudHSM CLI
<a name="cloudhsm_cli-user-replicate"></a>

Use o **user replicate** comando na CLI do CloudHSM para replicar um usuário de um cluster de origem para um cluster de destino AWS CloudHSM . AWS CloudHSM 

## Tipo de usuário
<a name="chsm-cli-user-replicate-user-type"></a>

Os seguintes tipos de usuários podem executar este comando.
+ Administradores () COs

## Requisitos
<a name="cloudhsm_cli-user-replicate-requirements"></a>
+ Os clusters de origem e destino devem ser clones. Isso significa que um foi criado a partir de um backup do outro, ou ambos foram criados a partir de um backup comum. Consulte [Criar clusters de backups](create-cluster-from-backup.md) para obter mais informações.
+ Para executar esse comando, é necessário estar registrado como administrador nos clusters de origem e de destino.
  +  No modo de comando único, o comando usará as variáveis ambientais CLOUDHSM\$1PIN e CLOUDHSM\$1ROLE para se autenticar no cluster de origem. Consulte [Modo de comando único](cloudhsm_cli-modes.md#cloudhsm_cli-mode-single-command) para obter mais informações. Para fornecer credenciais ao cluster de destino, é preciso definir duas variáveis ambientais adicionais: DESTINATION\$1CLOUDHSM\$1PIN e DESTINATION\$1CLOUDHSM\$1ROLE:

    ```
    $ export DESTINATION_CLOUDHSM_ROLE=<role>
    ```

    ```
    $ export DESTINATION_CLOUDHSM_PIN=<username:password>
    ```
  +  No modo interativo, os usuários precisarão fazer login explícito nos clusters de origem e de destino.

## Sintaxe
<a name="chsm-cli-user-replicate-syntax"></a>

```
aws-cloudhsm > help user replicate
Replicate a user from a source to a destination cluster

Usage: user replicate --username <USERNAME> --role <ROLE> --source-cluster-id <SOURCE_CLUSTER_ID> --destination-cluster-id <DESTINATION_CLUSTER_ID>

Options:
      --username <USERNAME>
          Username of the user to replicate

      --role <ROLE>
          Role the user has in the cluster

          Possible values:
          - crypto-user: A CryptoUser has the ability to manage and use keys
          - admin:       An Admin has the ability to manage user accounts

      --source-cluster-id <SOURCE_CLUSTER_ID>
          Source cluster ID

      --destination-cluster-id <DESTINATION_CLUSTER_ID>
          Destination cluster ID

  -h, --help
          Print help (see a summary with '-h')
```

## Exemplos
<a name="chsm-cli-user-replicate-examples"></a>

**Example Exemplo: replicar usuário**  
Esse comando replica um usuário de um cluster de origem para um cluster de destino clonado. O exemplo abaixo demonstra a saída quando conectado como um administrador em ambos os clusters.  

```
admin-user@cluster-1234abcdefg > user replicate \
      --username example-admin \
      --role admin \
      --source-cluster-id cluster-1234abcdefg \
      --destination-cluster-id cluster-2345bcdefgh
{
  "error_code": 0,
  "data": {
    "user": {
      "username": "example-admin",
      "role": "admin",
      "locked": "false",
      "mfa": [],
      "quorum": [],
      "cluster-coverage": "full"
    },
    "message": "Successfully replicated user"
  }
}
```

## Argumentos
<a name="user-replicate-arguments"></a>

***<USERNAME>***  
Especifica o nome de usuário do usuário a ser replicado no cluster de origem.  
Obrigatório: Sim

***<ROLE>***  
Especifica a função atribuída a esse usuário. Esse parâmetro é obrigatório. Os valores válidos são **admin**, **crypto-user**.  
Para obter a função do usuário, use o comando **user list**. Para obter informações detalhadas sobre os tipos de usuários em um HSM, consulte [Noções básicas dos usuários de HSM](manage-hsm-users.md).  
Obrigatório: Sim

***<SOURCE\$1CLUSTER\$1ID>***  
O ID do cluster de origem.  
Obrigatório: Sim

***<DESTINATION\$1CLUSTER\$1ID>***  
O ID do cluster de destino.  
Obrigatório: Sim

## Tópicos relacionados
<a name="chsm-user-replicate-seealso"></a>
+ [Conectar-se a vários clusters com a CLI do CloudHSM](cloudhsm_cli-configs-multi-cluster.md)

# A categoria de quórum na CloudHSM CLI
<a name="cloudhsm_cli-qm"></a>

Na CloudHSM CLI, **quorum** é uma categoria principal para um grupo de comandos que, quando combinado com **quorum**, cria um comando específico para autenticação de quórum ou operações M de N. Atualmente, essa categoria consiste na subcategoria **token-sign** que consiste em seus próprios comandos. Clique no link a seguir para obter detalhes.
+ [sinal de token](cloudhsm_cli-qm-token.md)

**Serviços administrativos**: a autenticação de quórum é usada para serviços com privilégios administrativos, como criar usuários, excluir usuários, alterar senhas de usuários, definir valores de quórum e desativar recursos de quórum e MFA.

**Serviços de criptografia para usuários**: a autenticação de quórum é usada para serviços privilegiados de usuários criptográficos associados a uma chave específica, como assinar com uma chave, uma chave, sharing/unsharing uma chave e definir o atributo de wrapping/unwrapping uma chave. O valor do quórum de uma chave associada é configurado quando a chave é gerada, importada ou desencapsulada. O valor do quórum deve ser igual ou menor do que o número de usuários aos quais a chave está associada, o que inclui usuários com os quais a chave é compartilhada e o proprietário da chave.

Cada tipo de serviço é subdividido em um nome de serviço qualificado, que contém um conjunto específico de operações de serviço suportadas por quórum que podem ser executadas.


****  

| Nome do serviço | Tipo de serviço | Operações de serviço | 
| --- | --- | --- | 
| usuário | Administrador |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 
| quorum | Administrador |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 
| cluster1 | Administrador |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 
| gerenciamento de chaves | Usuário de criptografia |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 
| uso de chave | Usuário de criptografia |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 

[1] O serviço de cluster está disponível exclusivamente em instâncias hsm2m.medium

## Tópicos relacionados
<a name="cloudhsm_cli-qm-seealso"></a>
+ [Configurar a autenticação de quórum para AWS CloudHSM administradores usando o CloudHSM CLI](quorum-auth-chsm-cli-first-time.md)
+ [Gerenciar a autenticação de quórum (controle de acesso M ou N) usando a CLI do CloudHSM](quorum-auth-chsm-cli.md)

# A categoria quorum token-sign na CLI do CloudHSM
<a name="cloudhsm_cli-qm-token"></a>

Na CLI do CloudHSM, **quorum token-sign** é uma categoria para um grupo de comandos que, quando combinado com **quorum token-sign**, cria um comando específico para autenticação de quórum ou operações M de N.

Atualmente, essa categoria consiste nos seguintes comandos:
+ [excluir](cloudhsm_cli-qm-token-del.md)
+ [generate](cloudhsm_cli-qm-token-gen.md)
+ [listar](cloudhsm_cli-qm-token-list.md)
+ [list-quorum-values](cloudhsm_cli-qm-token-list-qm.md)
+ [set-quorum-value](cloudhsm_cli-qm-token-set-qm.md)

# Excluir tokens de quórum usando a CloudHSM CLI
<a name="cloudhsm_cli-qm-token-del"></a>

Use o comando do **quorum token-sign delete** na CloudHSM CLI para excluir um ou mais tokens de um serviço autorizado por quórum.

## Tipo de usuário
<a name="quorum-token-delete-user-type"></a>

Os usuários a seguir podem executar este comando.
+ Administrador

## Sintaxe
<a name="quorum-token-delete-syntax"></a>

```
aws-cloudhsm > help quorum token-sign delete 
Delete one or more Quorum Tokens

Usage: quorum token-sign delete --scope <SCOPE>

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

      --scope <SCOPE>
          Scope of which token(s) will be deleted

          Possible values:
          - user: Deletes all token(s) of currently logged in user
          - all:  Deletes all token(s) on the HSM
  -h, --help
          Print help (see a summary with '-h')
```

## Exemplo
<a name="quorum-token-delete-examples"></a>

O exemplo seguinte mostra como o comando do **quorum token-sign delete** na CloudHSM CLI pode ser usado para excluir um ou mais tokens de um serviço autorizado por quórum.

**Example : exclui um ou mais tokens de um serviço autorizado por quórum**  

```
aws-cloudhsm > quorum token-sign delete --scope all
{
  "error_code": 0,
  "data": "Deletion of quorum token(s) successful"
}
```

## Argumentos
<a name="quorum-token-delete-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<SCOPE>***  
O escopo no qual os tokens serão excluídos no AWS CloudHSM cluster.  
**Valores válidos**  
+ **Usuário**: usado para excluir somente tokens pertencentes ao usuário conectado.
+ **Todos**: usado para excluir todos os tokens no AWS CloudHSM cluster.

## Tópicos relacionados
<a name="quorum-token-delete-seealso"></a>
+ [lista de usuários](cloudhsm_cli-user-list.md)
+ [criar usuário](cloudhsm_cli-user-create.md)
+ [excluir usuário](cloudhsm_cli-user-delete.md)

# Gerar um token de quórum usando a CloudHSM CLI
<a name="cloudhsm_cli-qm-token-gen"></a>

Use o comando **quorum token-sign generate** na CloudHSM CLI para gerar um token para um serviço autorizado de quórum.

Há um limite para obter um token ativo por usuário por serviço em um cluster HSM para usuários e quórum de serviços. Esse limite não se aplica ao tokens relacionados aos serviços chave.

**nota**  
Somente Administradores e Usuários de criptografia podem gerar tokens de serviço específicos. Para obter mais informações sobre tipos e nomes de serviços, consulte [Nomes e tipos de serviços que oferecem suporte à autenticação de quórum.](quorum-auth-chsm-cli-service-names.md)

**Serviços administrativos**: a autenticação de quórum é usada para serviços com privilégios administrativos, como criar usuários, excluir usuários, alterar senhas de usuários, definir valores de quórum e desativar recursos de quórum e MFA.

**Serviços de criptografia para usuários**: a autenticação de quórum é usada para serviços privilegiados de usuários criptográficos associados a uma chave específica, como assinar com uma chave, uma chave, sharing/unsharing uma chave e definir o atributo de wrapping/unwrapping uma chave. O valor do quórum de uma chave associada é configurado quando a chave é gerada, importada ou desencapsulada. O valor do quórum deve ser igual ou menor do que o número de usuários aos quais a chave está associada, o que inclui usuários com os quais a chave é compartilhada e o proprietário da chave.

Cada tipo de serviço é subdividido em um nome de serviço qualificado, que contém um conjunto específico de operações de serviço suportadas por quórum que podem ser executadas.


****  

| Nome do serviço | Tipo de serviço | Operações de serviço | 
| --- | --- | --- | 
| usuário | Administrador |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 
| quorum | Administrador |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 
| cluster1 | Administrador |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 
| gerenciamento de chaves | Usuário de criptografia |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 
| uso de chave | Usuário de criptografia |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 

[1] O serviço de cluster está disponível exclusivamente em instâncias hsm2m.medium

## Tipo de usuário
<a name="quorum-token-generate-user-type"></a>

Os usuários a seguir podem executar este comando.
+ Administrador
+ Crypto user (CU) (usuário de criptografia)

## Sintaxe
<a name="quorum-token-generate-syntax"></a>

```
aws-cloudhsm > help quorum token-sign generate
Generate a token

Usage: quorum token-sign generate --service <SERVICE> --token <TOKEN>

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

      --service <SERVICE>
          Service the token will be used for

          Possible values:
          - user:
            User management service is used for executing quorum authenticated user management operations
          - quorum:
            Quorum management service is used for setting quorum values for any quorum service
          - cluster: 
            Cluster management service is used for executing quorum for cluster wide configuration managements like mtls enforcement, mtls registration and mtls deregistration
          - registration:
            Registration service is used for registering a public key for quorum authentication
          - key-usage:
            Key usage service is used for executing quorum authenticated key usage operations
          - key-management:
            Key management service is used for executing quorum authenticated key management operations

      --token <TOKEN>
          Filepath where the unsigned token file will be written
  -h, --help                     Print help
```

## Exemplo
<a name="quorum-token-generate-examples"></a>

Esse comando grava um token não assinado por HSM em seu cluster no arquivo especificado por `token`.

**Example : grave um token não assinado por HSM em seu cluster**  

```
aws-cloudhsm > quorum token-sign generate --service user --token /home/tfile
{
  "error_code": 0,
  "data": {
    "filepath": "/home/tfile"
  }
}
```

## Argumentos
<a name="quorum-token-generate-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<SERVICE>***  
Especifica o serviço autorizado de quórum para o qual gerar um token. Esse parâmetro é obrigatório.  
**Valores válidos**  
+ **user**: serviço de gerenciamento de usuário usado para executar operações de gerenciamento de usuários autorizados por quórum.
+ **quorum**: serviço de gerenciamento de quórum usado para definir valores de quórum autorizado para qualquer serviço autorizado por quórum.
+ **cluster**: o serviço de gerenciamento de cluster usado para executar o quórum para gerenciamentos de configuração em todo o cluster, como imposição de mtls, registro de mtls e cancelamento de registro de mtls.
+ **registration**: gera um token não assinado para uso no registro de uma chave pública para autorização de quórum.
+ **key-usage**: gera um token não assinado que é usado para executar operações de uso de chaves autorizadas por quórum.
+ **key-management**: gera um token não assinado que é usado para executar operações de gerenciamento de chaves autorizadas por quórum.
**Obrigatório**: sim

***<TOKEN>***  
Caminho onde o arquivo de token não assinado será gravado.  
**Obrigatório**: sim

## Tópicos relacionados
<a name="quorum-token-generate-seealso"></a>
+ [Nomes e tipos de serviços que oferecem suporte à autenticação de quórum](quorum-auth-chsm-cli-service-names.md)

# Listar tokens de quórum usando a CloudHSM CLI
<a name="cloudhsm_cli-qm-token-list"></a>

Use o **quorum token-sign list** comando na CLI do CloudHSM para listar todos os tokens de quorum de assinatura de token presentes em seu cluster. AWS CloudHSM Isso inclui tokens gerados por outros usuários. Um token está vinculado a um usuário e, portanto, embora seja possível possa ver tokens de outros usuários, você poderá usar somente os tokens associados ao usuário atualmente conectado.

Para obter mais informações sobre tipos e nomes de serviços, consulte [Nomes e tipos de serviços que oferecem suporte à autenticação de quorum.](quorum-auth-chsm-cli-service-names.md) Para saber mais sobre o conteúdo exibido nos tokens listados, consulte [Gerenciamento e uso de chaves com autenticação de quorum habilitada para usar a CLI do AWS CloudHSM CloudHSM](key-quorum-auth-chsm-cli-crypto-user.md) para os tokens associados aos serviços `key-management` e `key-usage` e consulte [Gerenciamento de usuários com autenticação de quorum habilitada para usar o CloudHSM AWS CloudHSM CLI](quorum-auth-chsm-cli-admin.md) para os tokens associados aos serviços `user`, `quorum` ou `cluster`, respectivamente.

## Tipo de usuário
<a name="quorum-token-list-user-type"></a>

Os usuários a seguir podem executar este comando.
+ Administrador
+ Crypto user (CU) (usuário de criptografia)

## Sintaxe
<a name="quorum-token-list-syntax"></a>

```
aws-cloudhsm > help quorum token-sign list
List the token-sign tokens in your cluster

Usage: quorum token-sign list

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
  -h, --help                     Print help
```

## Exemplo
<a name="quorum-token-list-examples"></a>

Esse comando listará todos os tokens de assinatura de token presentes em seu cluster. AWS CloudHSM Isso inclui tokens gerados por outros usuários. Um token está vinculado a um usuário e, portanto, embora seja possível possa ver tokens de outros usuários, você poderá usar somente os tokens associados ao usuário atualmente conectado.

**Example**  

```
aws-cloudhsm > quorum token-sign list
{
  "error_code": 0,
  "data": {
    "tokens": [
      {
        "username": "admin",
        "service": "quorum",
        "approvals-required": 2,
        "number-of-approvals": 0,
        "token-timeout-seconds": 397,
        "cluster-coverage": "full"
      },
      {
        "username": "admin",
        "service": "user",
        "approvals-required": 2,
        "number-of-approvals": 0,
        "token-timeout-seconds": 588,
        "cluster-coverage": "full"
      },
      {
        "username": "crypto_user1",
        "service": "key-management",
        "key-reference": "0x00000000002c33f7",
        "minimum-token-count": 1
      },
      {
        "username": "crypto_user1",
        "service": "key-usage",
        "key-reference": "0x00000000002c33f7",
        "minimum-token-count": 1
      }
    ]
  }
}
```

## Tópicos relacionados
<a name="quorum-token-list-seealso"></a>
+ [quorum token-sign generate](cloudhsm_cli-qm-token-gen.md)

# Mostrar valores de quórum usando a CLI do CloudHSM
<a name="cloudhsm_cli-qm-token-list-qm"></a>

Use o **quorum token-sign list-quorum-values** comando na CLI do CloudHSM para listar os valores de quorum definidos no seu cluster. AWS CloudHSM 

## Tipo de usuário
<a name="quorum-token-list-qm-user-type"></a>

Os usuários a seguir podem executar este comando.
+ Todos os usuários. Você não precisa estar conectado para executar esse comando.

## Sintaxe
<a name="quorum-token-list-qm-syntax"></a>

```
aws-cloudhsm > help quorum token-sign list-quorum-values
List current quorum values

Usage: quorum token-sign list-quorum-values

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
  -h, --help                     Print help
```

## Exemplo
<a name="quorum-token-list-qm-examples"></a>

Esse comando lista os valores de quórum definidos em seu AWS CloudHSM cluster para cada serviço.

**Example**  
**hsm1.medium**:  

```
aws-cloudhsm > quorum token-sign list-quorum-values
{
  "error_code": 0,
  "data": {
    "user": 1,
    "quorum": 1
  }
}
```
**hsm2m.medium**:  

```
aws-cloudhsm > quorum token-sign list-quorum-values
{
  "error_code": 0,
  "data": {
    "user": 1,
    "quorum": 1,
    "cluster": 1
  }
}
```

## Tópicos relacionados
<a name="quorum-token-list-qm-seealso"></a>
+ [Nomes e tipos de serviços que oferecem suporte à autenticação de quórum](quorum-auth-chsm-cli-service-names.md)
+  [Configurar mTLS (recomendado)](getting-started-setup-mtls.md) 

# Atualizar um valor de quórum usando a CLI do CloudHSM
<a name="cloudhsm_cli-qm-token-set-qm"></a>

Use o comando **quorum token-sign set-quorum-value** na CLI do CloudHSM para definir um novo valor de quórum para um serviço autorizado de quórum.

## Tipo de usuário
<a name="quorum-token-set-qm-user-type"></a>

Os usuários a seguir podem executar este comando.
+ Administrador

## Sintaxe
<a name="quorum-token-set-qm-syntax"></a>

```
aws-cloudhsm > help quorum token-sign set-quorum-value
Set a quorum value

Usage: quorum token-sign set-quorum-value [OPTIONS] --service <SERVICE> --value <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

      --service <SERVICE>
          Service the token will be used for

          Possible values:
          - user:
            User management service is used for executing quorum authenticated user management operations
          - quorum:
            Quorum management service is used for setting quorum values for any quorum service
          - cluster: 
            Cluster management service is used for executing quorum for cluster wide configuration managements like mtls enforcement, mtls registration and mtls deregistration

      --value <VALUE>
          Value to set for service

      --approval <APPROVAL>
          Filepath of signed quorum token file to approve operation

  -h, --help
          Print help (see a summary with '-h')
```

## Exemplo
<a name="quorum-token-set-qm-examples"></a>

**Example**  
No exemplo a seguir, esse comando grava um token não assinado por HSM em seu cluster no arquivo especificado pelo token. Quando for solicitado, assine os tokens no arquivo.  

```
aws-cloudhsm > quorum token-sign set-quorum-value --service quorum --value 2
{
  "error_code": 0,
  "data": "Set Quorum Value successful"
}
```
Em seguida, você pode executar o comando **list-quorum-values** para confirmar se o valor do quórum para o serviço de gerenciamento de quórum foi definido:  
**hsm1.medium**:  

```
aws-cloudhsm > quorum token-sign list-quorum-values
{
  "error_code": 0,
  "data": {
    "user": 1,
    "quorum": 2
  }
}
```
**hsm2m.medium**:  

```
aws-cloudhsm > quorum token-sign list-quorum-values
{
  "error_code": 0,
  "data": {
    "user": 1,
    "quorum": 2,
    "cluster": 1
  }
}
```

## Argumentos
<a name="quorum-token-set-qm-arguments"></a>

***<CLUSTER\$1ID>***  
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)

***<APPROVAL>***  
O caminho do arquivo de token assinado a ser aprovado no HSM.

***<SERVICE>***  
Especifica o serviço autorizado de quórum para o qual gerar um token. Esse parâmetro é obrigatório. Para obter mais informações sobre tipos e nomes de serviços, consulte [Nomes e tipos de serviços que oferecem suporte à autenticação de quorum.](quorum-auth-chsm-cli-service-names.md)  
**Valores válidos**  
+ **usuário**: o serviço de gerenciamento de usuários. Serviço usado para executar operações de gerenciamento de usuários autorizados por quórum.
+ **quorum**: o serviço de gerenciamento de quórum. Serviço usado para definir valores de quórum autorizado para qualquer serviço autorizado por quórum.
+ **cluster**: o serviço de gerenciamento de cluster usado para executar o quórum para gerenciamentos de configuração em todo o cluster, como imposição de mtls, registro de mtls e cancelamento de registro de mtls.
+ **registro**: gera um token não assinado para uso no registro de uma chave pública para autorização de quórum.
**Obrigatório**: sim

***<VALUE>***  
Especifica o valor do quorum a ser definido. O valor máximo do quórum é oito (8).  
**Obrigatório**: sim

## Tópicos relacionados
<a name="quorum-token-set-qm-seealso"></a>
+ [sinal simbólico de quórum list-quorum-values](cloudhsm_cli-qm-token-list-qm.md)
+ [Nomes e tipos de serviços que oferecem suporte à autenticação de quórum](quorum-auth-chsm-cli-service-names.md)
+ [Configurar mTLS (recomendado)](getting-started-setup-mtls.md)