

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# Référence pour les commandes de la CLI CloudHSM
<a name="cloudhsm_cli-reference"></a>

La CLI CloudHSM aide les administrateurs à gérer les utilisateurs de leur cluster. AWS CloudHSM La CLI CloudHSM peut être exécutée dans deux modes : le mode interactif et le mode de commande unique. Pour une mise en route rapide, consultez [Commencer à utiliser l'interface de ligne de AWS CloudHSM commande (CLI)](cloudhsm_cli-getting-started.md). 

Pour exécuter la plupart des commandes de la CLI CloudHSM, vous devez démarrer la CLI CloudHSM et vous connecter au HSM. Si vous ajoutez ou supprimez HSMs, mettez à jour les fichiers de configuration de la CLI CloudHSM. Dans le cas contraire, les modifications que vous apportez risquent de ne pas être efficaces pour tous HSMs les membres du cluster.

Les rubriques suivantes décrivent les commandes de la CLI CloudHSM : 


| Commande | Description | Type d'utilisateur | 
| --- | --- | --- | 
| [activate](cloudhsm_cli-cluster-activate.md) | Active un cluster CloudHSM et confirme qu'il s'agit d'un nouveau cluster. Cela doit être fait avant toute autre opération. | Administrateur non activé | 
| [hsm-info](cloudhsm_cli-cluster-hsm-info.md) | Listez-les HSMs dans votre cluster. | Tout [1](#cli-ref-1), y compris les utilisateurs non authentifiés. La connexion n'est pas requise. | 
| [ecdsa](cloudhsm_cli-crypto-sign-ecdsa.md) | Génère une signature à l'aide d'une clé privée EC et du mécanisme de signature ECDSA.  | Utilisateurs de chiffrement (CU) | 
| [ed25519ph](cloudhsm_cli-crypto-sign-ed25519ph.md) | Génère une signature à l'aide d'une clé privée Ed25519 et du mécanisme de signature HashEd DSA.  | CU | 
| [rsa-pkcs](cloudhsm_cli-crypto-sign-rsa-pkcs.md) | Génère une signature à l'aide d'une clé privée RSA et du mécanisme de signature RSA-PKCS. | CU | 
| [rsa-pkcs-pss](cloudhsm_cli-crypto-sign-rsa-pkcs-pss.md) | Génère une signature à l'aide d'une clé privée RSA et du mécanisme de RSA-PKCS-PSS signature. | CU | 
| [ecdsa](cloudhsm_cli-crypto-verify-ecdsa.md) | Confirme qu'un fichier a été signé dans le HSM à l'aide d'une clé publique donnée. Vérifie que la signature a été générée à l'aide du mécanisme de signature ECDSA. Compare un fichier signé à un fichier source et détermine si les deux sont liés cryptographiquement en fonction d'une clé publique ecdsa et d'un mécanisme de signature donnés.  | CU | 
| [ed25519ph](cloudhsm_cli-crypto-verify-ed25519ph.md) | Vérifie les signatures HashEd DSA à l'aide d'une clé publique Ed25519. | CU | 
| [rsa-pkcs](cloudhsm_cli-crypto-verify-rsa-pkcs.md) | Confirme qu'un fichier a été signé dans le HSM à l'aide d'une clé publique donnée. Vérifie que la signature a été générée à l'aide du mécanisme de signature RSA-PKCS. Compare un fichier signé à un fichier source et détermine si les deux sont liés cryptographiquement en fonction d'une clé publique RSA et d'un mécanisme de signature donnés. | CU | 
| [rsa-pkcs-pss](cloudhsm_cli-crypto-verify-rsa-pkcs-pss.md) | Confirme qu'un fichier a été signé dans le HSM à l'aide d'une clé publique donnée. Vérifie que la signature a été générée à l'aide du mécanisme de RSA-PKCS-PSS signature. Compare un fichier signé à un fichier source et détermine si les deux sont liés cryptographiquement en fonction d'une clé publique RSA et d'un mécanisme de signature donnés. | CU | 
| [Key delete](cloudhsm_cli-key-delete.md) | Supprime une clé de votre AWS CloudHSM cluster. | CU | 
| [key generate-file](cloudhsm_cli-key-generate-file.md) | Génère un fichier clé dans votre AWS CloudHSM cluster. | CU | 
| [clé generate-asymmetric-pair RSA](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md) | Génère une paire de clés RSA asymétrique dans votre AWS CloudHSM cluster. | CU | 
| [clé generate-asymmetric-pair ec](cloudhsm_cli-key-generate-asymmetric-pair-ec.md) | Génère une paire de clés à courbe elliptique asymétrique (EC) dans votre cluster. AWS CloudHSM  | CU | 
| [clé generate-symmetric aes](cloudhsm_cli-key-generate-symmetric-aes.md) | Génère une clé AES symétrique dans votre AWS CloudHSM cluster. | CU | 
| [key generate-symmetric generic-secret](cloudhsm_cli-key-generate-symmetric-generic-secret.md) | Génère une clé secrète générique symétrique dans votre AWS CloudHSM cluster. | CU | 
| [clé d'importation pem](cloudhsm_cli-key-import-pem.md) | Importe une clé au format PEM dans un HSM. Vous pouvez l'utiliser pour importer des clés publiques générées hors du HSM. | CU | 
| [Key list](cloudhsm_cli-key-list.md) | Trouve toutes les clés de l'utilisateur actuel présent dans votre AWS CloudHSM cluster. | CU | 
| [répliquer la clé](cloudhsm_cli-key-replicate.md) | Répliquez une clé d'un cluster source vers un cluster de destination cloné. | CU | 
| [key set-attribute](cloudhsm_cli-key-set-attribute.md) | Définit les attributs des clés de votre AWS CloudHSM cluster. | CUs peuvent exécuter cette commande, les administrateurs peuvent définir l'attribut sécurisé. | 
| [key share](cloudhsm_cli-key-share.md) | Partage une clé avec d'autres CUs membres de votre AWS CloudHSM cluster. | CU | 
| [Key unshare](cloudhsm_cli-key-unshare.md) | Annule le partage d'une clé avec les autres CUs membres de votre AWS CloudHSM cluster. | CU | 
| [aes-gcm](cloudhsm_cli-key-unwrap-aes-gcm.md) | Déballe une clé de charge utile dans le cluster à l'aide de la clé d'encapsulation AES et du mécanisme de déballage AES-GCM. | CU | 
| [aes-no-pad](cloudhsm_cli-key-unwrap-aes-no-pad.md) | Déballe une clé de charge utile dans le cluster à l'aide de la clé d'encapsulation AES et du mécanisme de déballage. AES-NO-PAD | CU | 
| [aes-pkcs5-pad](cloudhsm_cli-key-unwrap-aes-pkcs5-pad.md) | Déballe une clé de charge utile à l'aide de la clé d'encapsulation AES et du mécanisme de déballage AES- PKCS5 -PAD. | CU | 
| [aes-zero-pad](cloudhsm_cli-key-unwrap-aes-zero-pad.md) | Déballe une clé de charge utile dans le cluster à l'aide de la clé d'encapsulation AES et du mécanisme de déballage. AES-ZERO-PAD | CU | 
| [cloudhsm-aes-gcm](cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm.md) | Déballe une clé de charge utile dans le cluster à l'aide de la clé d'encapsulation AES et du mécanisme de déballage. CLOUDHSM-AES-GCM | CU | 
| [rsa-aes](cloudhsm_cli-key-unwrap-rsa-aes.md) | Déballe une clé de charge utile à l'aide d'une clé privée RSA et du mécanisme de déballage RSA-AES. | CU | 
| [rsa-oaep](cloudhsm_cli-key-unwrap-rsa-oaep.md) | Déballe une clé de charge utile à l'aide de la clé privée RSA et du mécanisme de déballage RSA-OAEP. | CU | 
| [rsa-pkcs](cloudhsm_cli-key-unwrap-rsa-pkcs.md) | Déballe une clé de charge utile à l'aide de la clé privée RSA et du mécanisme de déballage RSA-PKCS. | CU | 
| [aes-gcm](cloudhsm_cli-key-wrap-aes-gcm.md) | Enveloppe une clé de charge utile à l'aide d'une clé AES sur le HSM et du mécanisme d'encapsulage AES-GCM. | CU | 
| [aes-no-pad](cloudhsm_cli-key-wrap-aes-no-pad.md) | Encapsule une clé de charge utile à l'aide d'une clé AES sur le HSM et du AES-NO-PAD mécanisme d'encapsulation. | CU | 
| [aes-pkcs5-pad](cloudhsm_cli-key-wrap-aes-pkcs5-pad.md) | Enveloppe une clé de charge utile à l'aide d'une touche AES sur le HSM et du mécanisme d'encapsulage AES- PKCS5 -PAD. | CU | 
| [aes-zero-pad](cloudhsm_cli-key-wrap-aes-zero-pad.md) | Encapsule une clé de charge utile à l'aide d'une clé AES sur le HSM et du AES-ZERO-PAD mécanisme d'encapsulation. | CU | 
| [cloudhsm-aes-gcm](cloudhsm_cli-key-wrap-cloudhsm-aes-gcm.md) | Encapsule une clé de charge utile à l'aide d'une clé AES sur le HSM et du CLOUDHSM-AES-GCM mécanisme d'encapsulation. | CUs | 
| [rsa-aes](cloudhsm_cli-key-wrap-rsa-aes.md) | Encapsule une clé de charge utile à l'aide d'une clé publique RSA sur le HSM et du mécanisme d'encapsulage RSA-AES. | CU | 
| [rsa-oaep](cloudhsm_cli-key-wrap-rsa-oaep.md) | Encapsule une clé de charge utile à l'aide d'une clé publique RSA sur le HSM et du mécanisme d'encapsulage RSA-OAEP. | CU | 
| [ Enveloppez une clé avec RSA-PKCS à l'aide de la CLI CloudHSMrsa-pkcs  La **key wrap rsa-pkcs** commande encapsule une clé de charge utile à l'aide d'une clé publique RSA sur le HSM et du mécanisme d'encapsulation. `RSA-PKCS`   Utilisez la **key wrap rsa-pkcs** commande de la CLI CloudHSM pour encapsuler une clé de charge utile à l'aide d'une clé publique RSA sur le module de sécurité matériel (HSM) et le mécanisme d'encapsulation. `RSA-PKCS` L'`extractable`attribut de la clé de charge utile doit être défini sur. `true` Seul le propriétaire d'une clé, c'est-à-dire l'utilisateur cryptographique (CU) qui a créé la clé, peut encapsuler la clé. Les utilisateurs qui partagent la clé peuvent l'utiliser dans des opérations cryptographiques. Pour utiliser la **key wrap rsa-pkcs** commande, vous devez d'abord disposer d'une clé RSA dans votre AWS CloudHSM cluster. Vous pouvez générer une paire de clés RSA à l'aide de la [La generate-asymmetric-pair catégorie dans la CLI CloudHSM](cloudhsm_cli-key-generate-asymmetric-pair.md) commande et de l'`wrap`attribut définis sur. `true`  Type utilisateur  Les types d'utilisateur suivants peuvent exécuter cette commande.   Utilisateurs de cryptomonnaies (CUs)     Exigences    Pour exécuter cette commande, vous devez être connecté en tant que CU.     Syntaxe  

```
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
```   Exemple  Cet exemple montre comment utiliser la **key wrap rsa-pkcs** commande à l'aide d'une clé publique 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=="
  }
```   Arguments   

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md) 

***<PAYLOAD\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé de charge utile.  
Obligatoire : oui 

***<PATH>***  
Chemin d'accès au fichier binaire dans lequel les données clés encapsulées seront enregistrées.  
Obligatoire : non 

***<WRAPPING\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste d'attributs clés séparés par des espaces sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé d'encapsulation.   
Obligatoire : oui 

***<WRAPPING\$1APPROVALR>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération d'encapsulage de la clé. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé d'encapsulation est supérieure à 1. 

***<PAYLOAD\$1APPROVALR>***  
Spécifie le chemin du fichier vers un fichier de jeton de quorum signé pour approuver le fonctionnement de la clé de charge utile. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé de charge utile est supérieure à 1.    Rubriques en relation    [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)   [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)    ](cloudhsm_cli-key-wrap-rsa-pkcs.md) | Encapsule une clé de charge utile à l'aide d'une clé publique RSA sur le HSM et du mécanisme d'encapsulage RSA-PKCS. | CU | 
| [login](cloudhsm_cli-login.md) | Connectez-vous à votre AWS CloudHSM cluster. | Administrateur, utilisateur du chiffrement (CU) et utilisateur de l'appareil (AU) | 
| [logout](cloudhsm_cli-logout.md) | Déconnectez-vous de votre AWS CloudHSM cluster. | Administrateur, CU et utilisateur de l'appareil (AU) | 
| [quorum token-sign delete](cloudhsm_cli-qm-token-del.md) | Supprime un ou plusieurs jetons pour un service autorisé par quorum. | Admin | 
| [quorum token-sign generate](cloudhsm_cli-qm-token-gen.md) | Génère un jeton pour un service autorisé par quorum. | Admin | 
| [quorum token-sign list](cloudhsm_cli-qm-token-list.md) | Répertorie tous les jetons de quorum token-sign présents dans votre cluster CloudHSM. | Tout [1](#cli-ref-1), y compris les utilisateurs non authentifiés. La connexion n'est pas requise. | 
| [signe du jeton quorum list-quorum-values](cloudhsm_cli-qm-token-list-qm.md) | Répertorie les valeurs de quorum définies dans votre cluster CloudHSM. | Tout [1](#cli-ref-1), y compris les utilisateurs non authentifiés. La connexion n'est pas requise. | 
| [signe du jeton quorum set-quorum-value](cloudhsm_cli-qm-token-set-qm.md) | Définit une nouvelle valeur de quorum pour un service autorisé par quorum. | Admin | 
| [user change-mfa](cloudhsm_cli-user-change-mfa.md) | Modifie la stratégie d'authentification multifactorielle (MFA) d'un utilisateur. | Administrateur, CU | 
| [user change-password](cloudhsm_cli-user-change-password.md) | Modifie les mots de passe des utilisateurs sur le HSMs. Tout utilisateur peut modifier son propre mot de passe. Les administrateur peuvent modifier le mot de passe de n’importe quel utilisateur. | Administrateur, CU | 
| [user create](cloudhsm_cli-user-create.md) | Crée un utilisateur dans votre AWS CloudHSM cluster. | Admin | 
| [user delete](cloudhsm_cli-user-delete.md) | Supprime un utilisateur de votre AWS CloudHSM cluster. | Admin | 
| [user list](cloudhsm_cli-user-list.md) | Répertorie les utilisateurs de votre AWS CloudHSM cluster. | Tout [1](#cli-ref-1), y compris les utilisateurs non authentifiés. La connexion n'est pas requise. | 
| [user change-quorum token-sign register](cloudhsm_cli-user-chqm-token-reg.md) | Enregistre la stratégie de quorum token-sign par quorum pour un utilisateur. | Admin | 

**Annotations**
+ [1] Tous les utilisateurs incluent tous les rôles répertoriés et les utilisateurs non connectés.

# Catégorie de cluster dans la CLI CloudHSM
<a name="cloudhsm_cli-cluster"></a>

Dans la **cluster** CLI CloudHSM, il s'agit d'une catégorie parent pour un groupe de commandes qui, lorsqu'elles sont combinées avec la catégorie parent, créent une commande spécifique aux clusters. Actuellement, la catégorie de cluster comprend les commandes suivantes :

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

# Activer un cluster à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-cluster-activate"></a>

Utilisez la **cluster activate** commande de la [CLI CloudHSM pour activer un](activate-cluster.md) nouveau cluster dans. AWS CloudHSM Cette commande doit être exécutée avant que le cluster puisse être utilisé pour effectuer des opérations cryptographiques.

## Type utilisateur
<a name="cluster-activate-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Administrateur non activé

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

Cette commande n'a pas de paramètres.

```
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')
```

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

Cette commande active votre cluster en définissant le mot de passe initial de votre utilisateur administrateur.

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

## Rubriques en relation
<a name="chsm-cluster-activate-seealso"></a>
+ [Créer un utilisateur](cloudhsm_cli-user-create.md)
+ [Supprimer un utilisateur](cloudhsm_cli-user-delete.md)
+ [Modifier un mot de passe utilisateur](cloudhsm_cli-user-change-password.md)

# Liste HSMs avec CLI CloudHSM
<a name="cloudhsm_cli-cluster-hsm-info"></a>

Utilisez la **cluster hsm-info** commande de la CLI CloudHSM pour répertorier les HSMs modules de sécurité matériels () AWS CloudHSM de votre cluster. Vous n'avez pas besoin d'être connecté à la CLI CloudHSM pour exécuter cette commande.

**Note**  
Si vous ajoutez ou supprimez HSMs, mettez à jour les fichiers de configuration utilisés par le AWS CloudHSM client et les outils de ligne de commande. Dans le cas contraire, les modifications que vous apportez risquent de ne pas s'appliquer HSMs à tous les membres du cluster.

## Type utilisateur
<a name="chsm-cluster-hsm-info-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Tous les utilisateurs. Vous n'avez pas besoin d'être connecté pour exécuter cette commande.

## Syntaxe
<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
```

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

Cette commande répertorie les éléments HSMs présents dans votre 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]"
      }
    ]
  }
}
```

L'objet possède les attributs suivants :
+ **Fournisseur** : nom du fournisseur du HSM. 
+ **Modèle** : le numéro de modèle du HSM.
+ **Numéro de série** : le numéro de série du HSM. Cela peut changer en raison des remplacements.
+ **H ardware-version-major** : La version matérielle majeure.
+ **H ardware-version-minor** : La version matérielle mineure.
+ **F irmware-version-major** : La version principale du microprogramme.
+ **F irmware-version-minor** : Version mineure du microprogramme.
+ **F irmware-build-number** : Numéro de version du microprogramme.
+ **Firmware-id**: ID du microprogramme, qui inclut les versions majeures et mineures ainsi que le build.
+ **État FIPS** : mode FIPS du cluster et de ce qu'il contient. HSMs En mode FIPS, le résultat est « 2 [mode FIPS avec authentification à facteur unique] ». En mode non FIPS, le résultat est « 0 [mode non FIPS avec authentification à facteur unique] ».

## Rubriques en relation
<a name="chsm-cluster-hsm-info-seealso"></a>
+ [Activer un cluster à l'aide de la CLI CloudHSM](cloudhsm_cli-cluster-activate.md)

# La catégorie mtls du cluster dans la CLI CloudHSM
<a name="cloudhsm_cli-cluster-mtls"></a>

Dans la **cluster mtls** CLI CloudHSM, il s'agit d'une catégorie parent pour un groupe de commandes qui, lorsqu'elles sont combinées avec la catégorie parent, créent une commande AWS CloudHSM spécifique aux clusters. Actuellement, cette catégorie comprend les commandes suivantes :

**Topics**
+ [deregister-trust-anchor](cloudhsm_cli-cluster-mtls-deregister-trust-anchor.md)
+ [obtenir l'application](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)
+ [mise en œuvre des ensembles](cloudhsm_cli-cluster-mtls-set-enforcement.md)

# Désenregistrer une ancre de confiance avec la CLI CloudHSM
<a name="cloudhsm_cli-cluster-mtls-deregister-trust-anchor"></a>

Utilisez la **cluster mtls deregister-trust-anchor** commande de la CLI CloudHSM pour annuler l'enregistrement d'une ancre de confiance pour le protocole TLS mutuel entre le client et. AWS CloudHSM

## Type utilisateur
<a name="cluster-mtls-deregister-trust-anchor-userType"></a>

Les utilisateurs suivants peuvent exécuter cette commande.
+ Admin

## Exigences
<a name="cluster-mtls-deregister-trust-anchor-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant qu'utilisateur administrateur.

## Syntaxe
<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
```

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

**Example**  
Dans l'exemple suivant, cette commande supprime une ancre de confiance du HSM.  

```
aws-cloudhsm > cluster mtls deregister-trust-anchor --certificate-reference 0x01
                
{
  "error_code": 0,
  "data": {
    "message": "Trust anchor with reference 0x01 deregistered successfully"
  }
}
```
Vous pouvez ensuite exécuter la **list-trust-anchors** commande pour confirmer que Trust Anchor a été désenregistré du : AWS CloudHSM  

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

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

** *<CERTIFICATE\$1REFERENCE>* **  
Référence de certificat hexadécimale ou décimale.  
 **Obligatoire** : oui  
Après avoir annulé l'enregistrement d'une ancre de confiance dans le cluster, toutes les connexions MTLS existantes utilisant le certificat client signé par cette ancre de confiance seront supprimées.

** *<APPROVAL>* **  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur du quorum du service de cluster de quorum est supérieure à 1.

## Rubriques en relation
<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) 
+  [Configuration des MTL (recommandé)](getting-started-setup-mtls.md) 

# Obtenez le niveau d'application mTLS avec la CLI CloudHSM
<a name="cloudhsm_cli-cluster-mtls-get-enforcement"></a>

Utilisez la **cluster mtls get-enforcement** commande de la CLI CloudHSM pour obtenir le niveau d'application de l'utilisation du protocole TLS mutuel entre le client et. AWS CloudHSM

## Type utilisateur
<a name="cluster-mtls-get-enforcement-userType"></a>

Les utilisateurs suivants peuvent exécuter cette commande.
+ Admin
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cluster-mtls-get-enforcement-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant qu'utilisateur administrateur ou utilisateur cryptographique (CUs).

## Syntaxe
<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
```

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

**Example**  
Dans l'exemple suivant, cette commande répertorie le niveau d'application MTLS du AWS CloudHSM.  

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

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

## Rubriques en relation
<a name="cluster-mtls-get-enforcement-seealso"></a>
+  [application des ensembles MTLS du cluster](cloudhsm_cli-cluster-mtls-set-enforcement.md) 
+  [Configuration des MTL (recommandé)](getting-started-setup-mtls.md) 

# Répertorier les ancres de confiance avec la CLI CloudHSM
<a name="cloudhsm_cli-cluster-mtls-list-trust-anchors"></a>

Utilisez la **cluster mtls list-trust-anchors** commande de la CLI CloudHSM pour répertorier toutes les ancres de confiance qui peuvent être utilisées pour le TLS mutuel entre le client et. AWS CloudHSM

## Type utilisateur
<a name="cluster-mtls-list-trust-anchors-userType"></a>

Les utilisateurs suivants peuvent exécuter cette commande.
+ Tous les utilisateurs. Vous n'avez pas besoin d'être connecté pour exécuter cette commande.

## Syntaxe
<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
```

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

**Example**  
Dans l'exemple suivant, cette commande répertorie toutes les ancres de confiance enregistrées à partir du 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"
      }
    ]
  }
}
```

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

## Rubriques en relation
<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) 
+  [Configuration des MTL (recommandé)](getting-started-setup-mtls.md) 

# Enregistrer une ancre de confiance avec la CLI CloudHSM
<a name="cloudhsm_cli-cluster-mtls-register-trust-anchor"></a>

Utilisez la **cluster mtls register-trust-anchor** commande de la CLI CloudHSM pour enregistrer une ancre de confiance pour le protocole TLS mutuel entre le client et. AWS CloudHSM

## Type utilisateur
<a name="cluster-mtls-register-trust-anchor-userType"></a>

Les utilisateurs suivants peuvent exécuter cette commande.
+ Admin

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

 AWS CloudHSM Accepte les ancres de confiance avec les types de clés suivants :


****  

| Type de clé | Description | 
| --- | --- | 
| EC |  Courbes secp256r1 (P-256), secp384r1 (P-384) et secp521r1 (P-521).  | 
| RSA |  Clés RSA 2048 bits, 3072 bits et 4096 bits.  | 

## Syntaxe
<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
```

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

**Example**  
Dans l'exemple suivant, cette commande enregistre une ancre de confiance sur le HSM. Le nombre maximum d'ancres de confiance pouvant être enregistrées est de deux (2).  

```
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"
    }
  }
}
```
Vous pouvez ensuite exécuter la **list-trust-anchors** commande pour confirmer que l'ancre de confiance a été enregistrée sur 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"
      }
    ]
  }
}
```

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

** *<PATH>* **  
Chemin de fichier de l'ancre de confiance à enregistrer.  
 **Obligatoire** : oui  
AWS CloudHSM prend en charge l'enregistrement des certificats intermédiaires en tant qu'ancre de confiance. Dans de tels cas, l'intégralité du fichier de chaîne de certificats codé PEM doit être enregistré sur le HSM, les certificats étant classés par ordre hiérarchique.   
 AWS CloudHSM prend en charge une chaîne de certificats de 6980 octets.

** *<APPROVAL>* **  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur du quorum du service de cluster de quorum est supérieure à 1.

## Rubriques en relation
<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) 
+  [Configuration des MTL (recommandé)](getting-started-setup-mtls.md) 

# Définissez le niveau d'application mTLS à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-cluster-mtls-set-enforcement"></a>

Utilisez la **cluster mtls set-enforcement** commande de la CLI CloudHSM pour définir le niveau d'application de l'utilisation du protocole TLS mutuel entre le client et. AWS CloudHSM

## Type utilisateur
<a name="cluster-mtls-set-enforcement-userType"></a>

Les utilisateurs suivants peuvent exécuter cette commande.
+ Administrateur avec nom d'utilisateur en tant qu'administrateur

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

Pour exécuter cette commande :
+ Au moins une ancre de confiance a été enregistrée avec succès sur le AWS CloudHSM.
+ Configurez la CLI CloudHSM avec la clé privée et le certificat client appropriés, puis démarrez la CLI CloudHSM dans le cadre d'une connexion TLS mutuelle.
+ Vous devez être connecté en tant qu'administrateur par défaut avec le nom d'utilisateur « admin ». Aucun autre utilisateur administrateur ne pourra exécuter cette commande.

## Syntaxe
<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
```

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

**Example**  
Dans l'exemple suivant, cette commande définit le niveau d'application MTLS du cluster AWS CloudHSM à être. La commande set-enforcement ne peut être exécutée que dans le cadre d'une connexion TLS mutuelle et connecté en tant qu'utilisateur administrateur avec le nom d'utilisateur en tant qu'administrateur, voir [définir l'application MTLS](getting-started-setup-mtls.md#getting-start-setup-mtls-enforcement) pour. AWS CloudHSM  

```
aws-cloudhsm > cluster mtls set-enforcement --level cluster
                
{
  "error_code": 0,
  "data": {
    "message": "Mtls enforcement level set to Cluster successfully"
  }
}
```
Vous pouvez ensuite exécuter la **get-enforcement** commande pour confirmer que le niveau d'application a été défini sur cluster :  

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

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

** *<LEVEL>* **  
Niveau à définir pour les MTLS dans le cluster.   
 **Valeurs valides**   
+  **cluster** : appliquez l'utilisation du protocole TLS mutuel entre le client et AWS CloudHSM dans le cluster.
+  **none : n'**appliquez pas l'utilisation du protocole TLS mutuel entre le client et AWS CloudHSM dans le cluster.
 **Obligatoire** : oui  
Une fois que vous aurez imposé l'utilisation de MTLS dans le cluster, toutes les connexions non MTLS existantes seront supprimées et vous ne pourrez vous connecter au cluster qu'avec des certificats MTLS.

** *<APPROVAL>* **  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur du quorum du service de cluster de quorum est supérieure à 1.

## Rubriques en relation
<a name="cluster-mtls-set-enforcement-seealso"></a>
+  [cluster mtls get-enforcement](cloudhsm_cli-cluster-mtls-get-enforcement.md) 
+  [Configuration des MTL (recommandé)](getting-started-setup-mtls.md) 

# La catégorie cryptographique dans la CLI CloudHSM
<a name="cloudhsm_cli-crypto"></a>

Dans la **crypto** CLI CloudHSM, il s'agit d'une catégorie parent pour un groupe de commandes qui, lorsqu'elles sont combinées avec la catégorie parent, créent une commande spécifique aux opérations cryptographiques. Actuellement, cette catégorie comprend les commandes suivantes : 
+ [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)
+ [vérifier](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)

# La catégorie de signes cryptographiques dans la CLI CloudHSM
<a name="cloudhsm_cli-crypto-sign"></a>

Dans la **crypto sign** CLI CloudHSM, il s'agit d'une catégorie parent pour un groupe de commandes qui, lorsqu'il est combiné à la catégorie parent, utilise une clé privée choisie AWS CloudHSM dans votre cluster pour générer une signature. **crypto sign**comporte les sous-commandes suivantes :
+ [Génération d'une signature à l'aide du mécanisme ECDSA dans la CLI CloudHSM](cloudhsm_cli-crypto-sign-ecdsa.md)
+ [Génération d'une signature à l'aide du mécanisme HashEd DSA dans la CLI CloudHSM](cloudhsm_cli-crypto-sign-ed25519ph.md)
+ [Génération d'une signature à l'aide du mécanisme RSA-PKCS dans la CLI CloudHSM](cloudhsm_cli-crypto-sign-rsa-pkcs.md)
+ [Générez une signature avec le RSA-PKCS-PSS mécanisme de la CLI CloudHSM](cloudhsm_cli-crypto-sign-rsa-pkcs-pss.md)

Pour l'utiliser**crypto sign**, vous devez disposer d'une clé privée dans votre HSM. Vous pouvez générer une clé privée à l'aide des commandes suivantes :
+ [clé generate-asymmetric-pair ec](cloudhsm_cli-key-generate-asymmetric-pair-ec.md)
+ [clé generate-asymmetric-pair RSA](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md)

# Génération d'une signature à l'aide du mécanisme ECDSA dans la CLI CloudHSM
<a name="cloudhsm_cli-crypto-sign-ecdsa"></a>

Utilisez la **crypto sign ecdsa** commande de la CLI CloudHSM pour générer une signature à l'aide d'une clé privée EC et du mécanisme de signature ECDSA. 

Pour utiliser la **crypto sign ecdsa** commande, vous devez d'abord disposer d'une clé privée EC dans votre AWS CloudHSM cluster. Vous pouvez générer une clé privée EC à l'aide de la [Génération d'une paire de clés EC asymétriques à l'aide de la CLI CloudHSM](cloudhsm_cli-key-generate-asymmetric-pair-ec.md) commande dont l'`sign`attribut est défini sur`true`.

La signature ECDSA résultante est générée dans le format `r||s` dans lequel les composants r et s sont concaténés sous forme de données binaires brutes et renvoyés au format codé base64.

**Note**  
Les signatures peuvent être vérifiées à l' AWS CloudHSM aide de [La catégorie de vérification cryptographique dans la CLI CloudHSM](cloudhsm_cli-crypto-verify.md) sous-commandes.

## Type utilisateur
<a name="cloudhsm_cli-crypto-sign-ecdsa-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-crypto-sign-ecdsa-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

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

Ces exemples montrent comment générer une signature **crypto sign ecdsa** à l'aide du mécanisme de signature et de la fonction de `SHA256` hachage ECDSA. Cette commande utilise une clé privée dans le HSM.

**Example Exemple : génération d'une signature pour les données codées en 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 Exemple : génération d'une signature pour un fichier de données**  

```
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=="
  }
}
```

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<DATA>***  
Données codées en Base64 à signer.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<DATA\$1PATH>***  
Spécifie l'emplacement des données à signer.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<HASH\$1FUNCTION>***  
Spécifie la fonction de hachage.   
Valeurs valides :  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
Obligatoire : oui

***<KEY\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme attr.KEY\$1ATTRIBUTE\$1NAME=KEY\$1ATTRIBUTE\$1VALUE pour sélectionner une clé correspondante.  
Pour obtenir la liste des attributs clés de la CLI CloudHSM pris en charge, consultez la section Attributs clés de la CLI CloudHSM.  
Obligatoire : oui

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur du quorum du service d'utilisation des clés de la clé privée est supérieure à 1.

***<DATA\$1TYPE>***  
 Spécifie si la valeur du paramètre de données doit être hachée dans le cadre de l'algorithme de signature. `raw`À utiliser pour les données non hachées ; à utiliser `digest` pour les résumés déjà hachés.   
Valeurs valides :  
+ raw
+ digérer

## Rubriques en relation
<a name="cloudhsm_cli-crypto-sign-ecdsa-seealso"></a>
+ [La catégorie de signes cryptographiques dans la CLI CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [La catégorie de vérification cryptographique dans la CLI CloudHSM](cloudhsm_cli-crypto-verify.md)

# Génération d'une signature à l'aide du mécanisme HashEd DSA dans la CLI CloudHSM
<a name="cloudhsm_cli-crypto-sign-ed25519ph"></a>

**Important**  
HashEdLes opérations de signature DSA ne sont prises en charge que sur les instances hsm2m.medium en mode non FIPS.

Utilisez la **crypto sign ed25519ph** commande de la CLI CloudHSM pour générer une signature à l'aide d'une clé privée Ed25519 et du mécanisme de signature DSA. HashEd Pour plus d'informations sur le HashEd DSA, voir le [NIST SP 186-5](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-5.pdf), section 7.8.

Pour utiliser la **crypto sign ed25519ph** commande, vous devez d'abord disposer d'une clé privée Ed25519 dans votre cluster. AWS CloudHSM Vous pouvez générer une clé privée Ed25519 à l'aide de la [Génération d'une paire de clés EC asymétriques à l'aide de la CLI CloudHSM](cloudhsm_cli-key-generate-asymmetric-pair-ec.md) commande avec le `curve` paramètre défini sur `ed25519` et l'`sign`attribut défini sur. `true`

**Note**  
Les signatures peuvent être vérifiées à l' AWS CloudHSM aide de [La catégorie de vérification cryptographique dans la CLI CloudHSM](cloudhsm_cli-crypto-verify.md) sous-commandes.

## Type utilisateur
<a name="cloudhsm_cli-crypto-sign-ed25519ph-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-crypto-sign-ed25519ph-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.
+ HashEdLes opérations de signature DSA ne sont prises en charge que sur les instances hsm2m.medium en mode non FIPS.

## Syntaxe
<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
```

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

Ces exemples montrent comment générer une signature **crypto sign ed25519ph** à l'aide du mécanisme de signature et de la fonction de hachage ED25519ph. `sha512` Cette commande utilise une clé privée dans le HSM.

**Example Exemple : génération d'une signature pour les données codées en 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 Exemple : génération d'une signature pour un fichier de données**  

```
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=="
  }
}
```

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<DATA>***  
Données codées en Base64 à signer.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<DATA\$1PATH>***  
Spécifie l'emplacement des données à signer.  
Obligatoire : Oui (sauf indication contraire dans le paramètre de données)

***<HASH\$1FUNCTION>***  
Spécifie la fonction de hachage. ED25519ph ne prend en charge que. SHA512   
Valeurs valides :  
+ sha512
Obligatoire : oui

***<KEY\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme attr.KEY\$1ATTRIBUTE\$1NAME=KEY\$1ATTRIBUTE\$1VALUE pour sélectionner une clé correspondante.  
Pour obtenir la liste des attributs clés de la CLI CloudHSM pris en charge, consultez. [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)  
Obligatoire : oui

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur du quorum du service d'utilisation des clés de la clé privée est supérieure à 1.

***<DATA\$1TYPE>***  
 Spécifie si la valeur du paramètre de données doit être hachée dans le cadre de l'algorithme de signature. `raw`À utiliser pour les données non hachées ; à utiliser `digest` pour les résumés déjà hachés.   
Valeurs valides :  
+ raw
+ digérer
Obligatoire : oui

## Rubriques en relation
<a name="cloudhsm_cli-crypto-sign-ed25519ph-seealso"></a>
+ [La catégorie de signes cryptographiques dans la CLI CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [La catégorie de vérification cryptographique dans la CLI CloudHSM](cloudhsm_cli-crypto-verify.md)

# Génération d'une signature à l'aide du mécanisme RSA-PKCS dans la CLI CloudHSM
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs"></a>

Utilisez la **crypto sign rsa-pkcs** commande de la CLI CloudHSM pour générer une signature à l'aide d'une clé privée RSA et du mécanisme de signature RSA-PKCS.

Pour utiliser la **crypto sign rsa-pkcs** commande, vous devez d'abord disposer d'une clé privée RSA dans votre AWS CloudHSM cluster. Vous pouvez générer une clé privée RSA à l'aide de la [Génération d'une paire de clés RSA asymétrique avec la CLI CloudHSM](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md) commande dont l'`sign`attribut est défini sur. `true`

**Note**  
Les signatures peuvent être vérifiées à l' AWS CloudHSM aide de [La catégorie de vérification cryptographique dans la CLI CloudHSM](cloudhsm_cli-crypto-verify.md) sous-commandes.

## Type utilisateur
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

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

Ces exemples montrent comment générer une signature **crypto sign rsa-pkcs** à l'aide du mécanisme de signature et `SHA256` de la fonction de hachage RSA-PKCS. Cette commande utilise une clé privée dans le HSM.

**Example Exemple : génération d'une signature pour les données codées en 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 Exemple : génération d'une signature pour un fichier de données**  

```
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=="
  }
}
```

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<DATA>***  
Données codées en Base64 à signer.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<DATA\$1PATH>***  
Spécifie l'emplacement des données à signer.  
Obligatoire : Oui (sauf indication contraire dans les données)

***<HASH\$1FUNCTION>***  
Spécifie la fonction de hachage.   
Valeurs valides :  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
Obligatoire : oui

***<KEY\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé correspondante.  
Pour obtenir la liste des attributs clés de la CLI CloudHSM pris en charge, consultez la section Attributs clés de la CLI CloudHSM.  
Obligatoire : oui

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur du quorum du service d'utilisation des clés de la clé privée est supérieure à 1.

***<DATA\$1TYPE>***  
 Spécifie si la valeur du paramètre de données doit être hachée dans le cadre de l'algorithme de signature. `raw`À utiliser pour les données non hachées ; à utiliser `digest` pour les résumés déjà hachés.   
Pour RSA-PKCS, les données doivent être transmises au format codé DER comme spécifié dans la [RFC](https://www.rfc-editor.org/rfc/rfc8017#section-9.2) 8017, section 9.2  
Valeurs valides :  
+ raw
+ digérer

## Rubriques en relation
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-seealso"></a>
+ [La catégorie de signes cryptographiques dans la CLI CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [La catégorie de vérification cryptographique dans la CLI CloudHSM](cloudhsm_cli-crypto-verify.md)

# Générez une signature avec le RSA-PKCS-PSS mécanisme de la CLI CloudHSM
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-pss"></a>

Utilisez la **crypto sign rsa-pkcs-pss** commande de la CLI CloudHSM pour générer une signature à l'aide d'une clé `RSA-PKCS-PSS` privée RSA et du mécanisme de signature.

Pour utiliser la **crypto sign rsa-pkcs-pss** commande, vous devez d'abord disposer d'une clé privée RSA dans votre AWS CloudHSM cluster. Vous pouvez générer une clé privée RSA à l'aide de la [Génération d'une paire de clés RSA asymétrique avec la CLI CloudHSM](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md) commande dont l'`sign`attribut est défini sur. `true`

**Note**  
Les signatures peuvent être vérifiées à l' AWS CloudHSM aide de [La catégorie de vérification cryptographique dans la CLI CloudHSM](cloudhsm_cli-crypto-verify.md) sous-commandes.

## Type utilisateur
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

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

Ces exemples montrent comment générer une signature **crypto sign rsa-pkcs-pss** à l'aide du mécanisme de signature et de la `RSA-PKCS-PSS` fonction de `SHA256` hachage. Cette commande utilise une clé privée dans le HSM.

**Example Exemple : génération d'une signature pour les données codées en 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 Exemple : générer une signature pour un fichier de données**  

```
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=="
  }
}
```

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<DATA>***  
Données codées en Base64 à signer.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<DATA\$1PATH>***  
Spécifie l'emplacement des données à signer.  
Obligatoire : Oui (sauf indication contraire dans les données)

***<HASH\$1FUNCTION>***  
Spécifie la fonction de hachage.   
Valeurs valides :  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
Obligatoire : oui

***<KEY\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé correspondante.  
Pour obtenir la liste des attributs clés de la CLI CloudHSM pris en charge, consultez la section Attributs clés de la CLI CloudHSM.  
Obligatoire : oui

***<MGF>***  
Spécifie la fonction de génération de masques.  
La fonction de hachage de la fonction de génération de masque doit correspondre à la fonction de hachage du mécanisme de signature.
Valeurs valides :  
+ mgf1-sha1
+ mgf1-sha225
+ mgf1-sha255
+ mgf1-sha385
+ mgf1-sha512
Obligatoire : oui

***<SALT\$1LENGTH>***  
Spécifie la longueur du sel.  
Obligatoire : oui

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur du quorum du service d'utilisation des clés de la clé privée est supérieure à 1.

***<DATA\$1TYPE>***  
 Spécifie si la valeur du paramètre de données doit être hachée dans le cadre de l'algorithme de signature. `raw`À utiliser pour les données non hachées ; à utiliser `digest` pour les résumés déjà hachés.   
Valeurs valides :  
+ raw
+ digérer

## Rubriques en relation
<a name="cloudhsm_cli-crypto-sign-rsa-pkcs-seealso"></a>
+ [La catégorie de signes cryptographiques dans la CLI CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [La catégorie de vérification cryptographique dans la CLI CloudHSM](cloudhsm_cli-crypto-verify.md)

## Rubriques en relation
<a name="cloudhsm_cli-crypto-sign-seealso"></a>
+ [La catégorie de vérification cryptographique dans la CLI CloudHSM](cloudhsm_cli-crypto-verify.md)

# La catégorie de vérification cryptographique dans la CLI CloudHSM
<a name="cloudhsm_cli-crypto-verify"></a>

Dans la **crypto verify** CLI CloudHSM, il s'agit d'une catégorie parent pour un groupe de commandes qui, lorsqu'elle est combinée à la catégorie parent, confirme si un fichier a été signé par une clé donnée. **crypto verify**comporte les sous-commandes suivantes : 
+ [Crypto Verify ECDSA](cloudhsm_cli-crypto-verify-ecdsa.md)
+ [vérification cryptographique ed25519ph](cloudhsm_cli-crypto-verify-ed25519ph.md)
+ [Crypto Verify RSA-PKCS](cloudhsm_cli-crypto-verify-rsa-pkcs.md)
+ [vérification cryptographique rsa-pkcs-pss](cloudhsm_cli-crypto-verify-rsa-pkcs-pss.md)

La **crypto verify** commande compare un fichier signé à un fichier source et analyse s'ils sont liés cryptographiquement en fonction d'une clé publique et d'un mécanisme de signature donnés.

**Note**  
Les fichiers peuvent être connectés à l' AWS CloudHSM aide de [La catégorie de signes cryptographiques dans la CLI CloudHSM](cloudhsm_cli-crypto-sign.md) cette opération.

# Vérifier une signature signée avec le mécanisme ECDSA dans la CLI CloudHSM
<a name="cloudhsm_cli-crypto-verify-ecdsa"></a>

Utilisez la **crypto verify ecdsa** commande de la CLI CloudHSM pour effectuer les opérations suivantes :
+ Confirmez qu'un fichier a été signé dans le HSM à l'aide d'une clé publique donnée.
+ Vérifiez que la signature a été générée à l'aide du mécanisme de signature ECDSA.
+ Comparez un fichier signé à un fichier source et déterminez si les deux sont liés cryptographiquement en fonction d'une clé publique ecdsa et d'un mécanisme de signature donnés. 
+  La fonction de vérification ECDSA attend la signature au format `r||s` dans lequel les composants r et s sont concaténés sous forme de données binaires brutes. 

Pour utiliser la **crypto verify ecdsa** commande, vous devez d'abord disposer d'une clé publique EC dans votre AWS CloudHSM cluster. Vous pouvez importer une clé publique EC à l'aide de la [Importer une clé au format PEM avec la CLI CloudHSM](cloudhsm_cli-key-import-pem.md) commande dont l'`verify`attribut est défini sur`true`.

**Note**  
Vous pouvez générer une signature dans la CLI [La catégorie de signes cryptographiques dans la CLI CloudHSM](cloudhsm_cli-crypto-sign.md) CloudHSM à l'aide de sous-commandes.

## Type utilisateur
<a name="cloudhsm_cli-crypto-verify-ecdsa-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-crypto-verify-ecdsa-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

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

Ces exemples montrent comment vérifier une signature générée **crypto verify ecdsa** à l'aide du mécanisme de signature et de la fonction de `SHA256` hachage ECDSA. Cette commande utilise une clé publique dans le HSM.

**Example Exemple : vérifier une signature codée en Base64 avec des données codées en 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 Exemple : vérifier un fichier de signature avec un fichier de données**  

```
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 Exemple : prouver une fausse relation de signature**  
Cette commande vérifie si les données situées dans ont `/home/data` été signées par une clé publique avec l'étiquette `ecdsa-public` en utilisant le mécanisme de signature ECDSA pour produire la signature située dans. `/home/signature` Comme les arguments fournis ne constituent pas une véritable relation de signature, la commande renvoie un message d'erreur.  

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

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<DATA>***  
Données codées en Base64 à signer.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<DATA\$1PATH>***  
Spécifie l'emplacement des données à signer.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<HASH\$1FUNCTION>***  
Spécifie la fonction de hachage.   
Valeurs valides :  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
Obligatoire : oui

***<KEY\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé correspondante.  
Pour obtenir la liste des attributs clés de la CLI CloudHSM pris en charge, consultez la section Attributs clés de la CLI CloudHSM.  
Obligatoire : oui

***<SIGNATURE>***  
Signature codée en Base64.  
Obligatoire : Oui (sauf indication contraire via le chemin de signature)

***<SIGNATURE\$1PATH>***  
Spécifie l'emplacement de la signature.  
Obligatoire : Oui (sauf indication contraire via le chemin de signature)

***<DATA\$1TYPE>***  
 Spécifie si la valeur du paramètre de données doit être hachée dans le cadre de l'algorithme de signature. `raw`À utiliser pour les données non hachées ; à utiliser `digest` pour les résumés déjà hachés.   
Valeurs valides :  
+ raw
+ digérer

## Rubriques en relation
<a name="cloudhsm_cli-crypto-verify-ecdsa-seealso"></a>
+ [La catégorie de signes cryptographiques dans la CLI CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [La catégorie de vérification cryptographique dans la CLI CloudHSM](cloudhsm_cli-crypto-verify.md)

# Vérifier une signature signée avec le mécanisme HashEd DSA dans la CLI CloudHSM
<a name="cloudhsm_cli-crypto-verify-ed25519ph"></a>

**Important**  
HashEdLes opérations de vérification de signature DSA ne sont prises en charge que sur les instances hsm2m.medium en mode non FIPS.

Utilisez la **crypto verify ed25519ph** commande de la CLI CloudHSM pour effectuer les opérations suivantes :
+ Vérifiez les signatures des données ou des fichiers à l'aide d'une clé publique Ed25519 donnée.
+ Vérifiez que la signature a été générée à l'aide du mécanisme de signature HashEd DSA. Pour plus d'informations sur le HashEd DSA, voir le [NIST SP 186-5](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-5.pdf), section 7.8.

Pour utiliser la **crypto verify ed25519ph** commande, vous devez d'abord disposer d'une clé publique Ed25519 dans votre cluster. AWS CloudHSM Vous pouvez générer une paire de clés Ed25519 à l'aide de la [Génération d'une paire de clés EC asymétriques à l'aide de la CLI CloudHSM](cloudhsm_cli-key-generate-asymmetric-pair-ec.md) commande dont le `curve` paramètre est défini sur `ed25519` et l'`verify`attribut défini sur`true`, ou importer une clé publique Ed25519 à l'aide de la [Importer une clé au format PEM avec la CLI CloudHSM](cloudhsm_cli-key-import-pem.md) commande dont l'attribut est défini sur. `verify` `true`

**Note**  
Vous pouvez générer une signature dans la CLI [La catégorie de signes cryptographiques dans la CLI CloudHSM](cloudhsm_cli-crypto-sign.md) CloudHSM à l'aide de sous-commandes.

## Type utilisateur
<a name="cloudhsm_cli-crypto-verify-ed25519ph-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-crypto-verify-ed25519ph-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.
+ HashEdLes opérations de vérification de signature DSA ne sont prises en charge que sur les instances hsm2m.medium en mode non FIPS.

## Syntaxe
<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
```

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

Ces exemples montrent comment vérifier une signature générée **crypto verify ed25519ph** à l'aide du mécanisme de signature et de la fonction de hachage ED25519ph. `sha512` Cette commande utilise une clé publique Ed25519 dans le HSM.

**Example Exemple : vérifier une signature codée en Base64 avec des données codées en 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 Exemple : vérifier un fichier de signature avec un fichier de données**  

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

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<DATA>***  
Données codées en Base64 à vérifier.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<DATA\$1PATH>***  
Spécifie l'emplacement des données à vérifier.  
Obligatoire : Oui (sauf indication contraire dans le paramètre de données)

***<HASH\$1FUNCTION>***  
Spécifie la fonction de hachage. ED25519ph ne prend en charge que. SHA512   
Valeurs valides :  
+ sha512
Obligatoire : oui

***<KEY\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé correspondante.  
Pour obtenir la liste des attributs clés de la CLI CloudHSM pris en charge, consultez. [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)  
Obligatoire : oui

***<SIGNATURE>***  
Signature codée en Base64.  
Obligatoire : Oui (sauf indication contraire via le chemin de signature)

***<SIGNATURE\$1PATH>***  
Spécifie l'emplacement de la signature.  
Obligatoire : Oui (sauf indication contraire dans le paramètre de signature)

***<DATA\$1TYPE>***  
 Spécifie si la valeur du paramètre de données doit être hachée dans le cadre de l'algorithme de vérification. `raw`À utiliser pour les données non hachées ; à utiliser `digest` pour les résumés déjà hachés.   
Valeurs valides :  
+ raw
+ digérer
Obligatoire : oui

## Rubriques en relation
<a name="cloudhsm_cli-crypto-verify-ed25519ph-seealso"></a>
+ [La catégorie de signes cryptographiques dans la CLI CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [La catégorie de vérification cryptographique dans la CLI CloudHSM](cloudhsm_cli-crypto-verify.md)
+ [Génération d'une signature à l'aide du mécanisme HashEd DSA dans la CLI CloudHSM](cloudhsm_cli-crypto-sign-ed25519ph.md)

# Vérifier une signature signée avec le mécanisme RSA-PKCS dans la CLI CloudHSM
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs"></a>

Utilisez la **crypto verify rsa-pkcs** commande dans la CLI CloudHSM pour effectuer les opérations suivantes :
+ Confirmez qu'un fichier a été signé dans le HSM à l'aide d'une clé publique donnée.
+ Vérifiez que la signature a été générée à l'aide du mécanisme de `RSA-PKCS` signature.
+ Comparez un fichier signé à un fichier source et déterminez si les deux sont liés cryptographiquement en fonction d'une clé publique RSA et d'un mécanisme de signature donnés.

Pour utiliser la **crypto verify rsa-pkcs** commande, vous devez d'abord disposer d'une clé publique RSA dans votre AWS CloudHSM cluster.

**Note**  
Vous pouvez générer une signature à l'aide de la [La catégorie de signes cryptographiques dans la CLI CloudHSM](cloudhsm_cli-crypto-sign.md) CLI CloudHSM avec les sous-commandes.

## Type utilisateur
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

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

Ces exemples montrent comment vérifier une signature générée **crypto verify rsa-pkcs** à l'aide du mécanisme de signature et `SHA256` de la fonction de hachage RSA-PKCS. Cette commande utilise une clé publique dans le HSM.

**Example Exemple : vérifier une signature codée en Base64 avec des données codées en 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 Exemple : vérifier un fichier de signature avec un fichier de données**  

```
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 Exemple : prouver une fausse relation de signature**  
Cette commande vérifie si les données non valides ont été signées par une clé publique avec l'étiquette `rsa-public` en utilisant le mécanisme de signature RSAPKCS pour produire la signature située dans. `/home/signature` Comme les arguments fournis ne constituent pas une véritable relation de signature, la commande renvoie un message d'erreur.  

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

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<DATA>***  
Données codées en Base64 à signer.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<DATA\$1PATH>***  
Spécifie l'emplacement des données à signer.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<HASH\$1FUNCTION>***  
Spécifie la fonction de hachage.   
Valeurs valides :  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
Obligatoire : oui

***<KEY\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé correspondante.  
Pour obtenir la liste des attributs clés de la CLI CloudHSM pris en charge, consultez la section Attributs clés de la CLI CloudHSM.  
Obligatoire : oui

***<SIGNATURE>***  
Signature codée en Base64.  
Obligatoire : Oui (sauf indication contraire via le chemin de signature)

***<SIGNATURE\$1PATH>***  
Spécifie l'emplacement de la signature.  
Obligatoire : Oui (sauf indication contraire via le chemin de signature)

***<DATA\$1TYPE>***  
 Spécifie si la valeur du paramètre de données doit être hachée dans le cadre de l'algorithme de signature. `raw`À utiliser pour les données non hachées ; à utiliser `digest` pour les résumés déjà hachés.   
Pour RSA-PKCS, les données doivent être transmises au format codé DER comme spécifié dans la [RFC](https://www.rfc-editor.org/rfc/rfc8017#section-9.2) 8017, section 9.2  
Valeurs valides :  
+ raw
+ digérer

## Rubriques en relation
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-seealso"></a>
+ [La catégorie de signes cryptographiques dans la CLI CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [La catégorie de vérification cryptographique dans la CLI CloudHSM](cloudhsm_cli-crypto-verify.md)

# Vérifier une signature signée avec le RSA-PKCS-PSS mécanisme dans la CLI CloudHSM
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss"></a>

Utilisez la **crypto sign rsa-pkcs-pss** commande de la CLI CloudHSM pour effectuer les opérations suivantes.
+ Confirmez qu'un fichier a été signé dans le HSM à l'aide d'une clé publique donnée.
+ Vérifiez que la signature a été générée à l'aide du mécanisme de RSA-PKCS-PSS signature.
+ Comparez un fichier signé à un fichier source et déterminez si les deux sont liés cryptographiquement en fonction d'une clé publique RSA et d'un mécanisme de signature donnés.

Pour utiliser la **crypto verify rsa-pkcs-pss** commande, vous devez d'abord disposer d'une clé publique RSA dans votre AWS CloudHSM cluster. Vous pouvez importer une clé publique RSA à l'aide de la commande key import pem (ADD UNWRAP LINK HERE) avec l'`verify`attribut défini sur. `true`

**Note**  
Vous pouvez générer une signature à l'aide de la [La catégorie de signes cryptographiques dans la CLI CloudHSM](cloudhsm_cli-crypto-sign.md) CLI CloudHSM avec les sous-commandes.

## Type utilisateur
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

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

Ces exemples montrent comment vérifier une signature générée **crypto verify rsa-pkcs-pss** à l'aide du mécanisme de RSA-PKCS-PSS signature et de la fonction de `SHA256` hachage. Cette commande utilise une clé publique dans le HSM.

**Example Exemple : vérifier une signature codée en Base64 avec des données codées en 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 Exemple : vérifier un fichier de signature avec un fichier de données**  

```
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 Exemple : prouver une fausse relation de signature**  
Cette commande vérifie si les données non valides ont été signées par une clé publique avec l'étiquette `rsa-public` en utilisant le mécanisme de signature RSAPKCSPSS pour produire la signature située dans. `/home/signature` Comme les arguments fournis ne constituent pas une véritable relation de signature, la commande renvoie un message d'erreur.  

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

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<DATA>***  
Données codées en Base64 à signer.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<DATA\$1PATH>***  
Spécifie l'emplacement des données à signer.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<HASH\$1FUNCTION>***  
Spécifie la fonction de hachage.   
Valeurs valides :  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
Obligatoire : oui

***<KEY\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé correspondante.  
Pour obtenir la liste des attributs clés de la CLI CloudHSM pris en charge, consultez la section Attributs clés de la CLI CloudHSM.  
Obligatoire : oui

***<MFG>***  
Spécifie la fonction de génération de masques.  
La fonction de hachage de la fonction de génération de masque doit correspondre à la fonction de hachage du mécanisme de signature.
Valeurs valides :  
+ mgf1-sha1
+ mgf1-sha225
+ mgf1-sha255
+ mgf1-sha385
+ mgf1-sha512
Obligatoire : oui

***<SIGNATURE>***  
Signature codée en Base64.  
Obligatoire : Oui (sauf indication contraire via le chemin de signature)

***<SIGNATURE\$1PATH>***  
Spécifie l'emplacement de la signature.  
Obligatoire : Oui (sauf indication contraire via le chemin de signature)

***<DATA\$1TYPE>***  
 Spécifie si la valeur du paramètre de données doit être hachée dans le cadre de l'algorithme de signature. `raw`À utiliser pour les données non hachées ; à utiliser `digest` pour les résumés déjà hachés.   
Valeurs valides :  
+ raw
+ digérer

## Rubriques en relation
<a name="cloudhsm_cli-crypto-verify-rsa-pkcs-pss-seealso"></a>
+ [La catégorie de signes cryptographiques dans la CLI CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [La catégorie de vérification cryptographique dans la CLI CloudHSM](cloudhsm_cli-crypto-verify.md)

# La catégorie clé de la CLI CloudHSM
<a name="cloudhsm_cli-key"></a>

Dans la **key** CLI CloudHSM, il s'agit d'une catégorie parent pour un groupe de commandes qui, lorsqu'elles sont combinées avec la catégorie parent, créent une commande spécifique aux touches. Actuellement, cette catégorie comprend les commandes suivantes :
+ [supprimer](cloudhsm_cli-key-delete.md)
+ [generate-file](cloudhsm_cli-key-generate-file.md)
+ [key generate-asymmetric-pair](cloudhsm_cli-key-generate-asymmetric-pair.md)
  + [clé generate-asymmetric-pair RSA](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md)
  + [clé generate-asymmetric-pair ec](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)
  + [clé generate-symmetric generic-secret](cloudhsm_cli-key-generate-symmetric-generic-secret.md)
+ [importer un fichier pem](cloudhsm_cli-key-import-pem.md)
+ [liste](cloudhsm_cli-key-list.md)
+ [répliquer](cloudhsm_cli-key-replicate.md)
+ [set-attribute](cloudhsm_cli-key-set-attribute.md)
+ [partager](cloudhsm_cli-key-share.md)
+ [unshare](cloudhsm_cli-key-unshare.md)
+ [déballer](cloudhsm_cli-key-unwrap.md)
+ [envelopper](cloudhsm_cli-key-wrap.md)

# Supprimer une clé à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-delete"></a>

Utilisez la **key delete** commande de la CLI CloudHSM pour supprimer une clé AWS CloudHSM d'un cluster. Vous pouvez supprimer une seule clé à la fois. La suppression d'une clé dans une paire de clés n'a aucun effet sur l'autre clé de la paire. 

Seul le CU qui a créé la clé et qui en est donc propriétaire peut supprimer la clé. Les utilisateurs qui partagent la clé, sans la posséder, peuvent l'utiliser dans des opérations de chiffrement, mais pas la supprimer.

## Type utilisateur
<a name="key-delete-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="key-delete-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

## Exemple
<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"
  }
}
```

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste d'attributs clés séparés par des espaces sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé correspondante à supprimer.  
Pour obtenir la liste des attributs de clé de la CLI CloudHSM pris en charge, voir [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)  
Obligatoire : oui

## Rubriques en relation
<a name="key-delete-seealso"></a>
+ [Répertorier les clés d'un utilisateur avec la CLI CloudHSM](cloudhsm_cli-key-list.md)
+ [Exporter une clé asymétrique avec la CLI CloudHSM](cloudhsm_cli-key-generate-file.md)
+ [Annuler le partage d'une clé à l'aide de la CLI CloudHSM](cloudhsm_cli-key-unshare.md)
+ [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)
+ [Clés de filtrage à l'aide de la CLI CloudHSM](manage-keys-cloudhsm-cli-filtering.md)

# Exporter une clé asymétrique avec la CLI CloudHSM
<a name="cloudhsm_cli-key-generate-file"></a>

Utilisez la **key generate-file** commande de la CLI CloudHSM pour exporter une clé asymétrique depuis le module de sécurité matérielle (HSM). Si la cible est une clé privée, la référence à la clé privée sera exportée au faux format PEM. Si la cible est une clé publique, les octets de la clé publique seront exportés au format PEM.

Le faux fichier PEM, qui ne contient pas le contenu de la clé privée mais fait référence à la clé privée dans le HSM, peut être utilisé pour établir un SSL/TLS déchargement de votre serveur Web vers. AWS CloudHSM Pour plus d'informations, consultez la section [Déchargement SSL/TLS](ssl-offload.md).

## Type utilisateur
<a name="key-generate-file-user-type"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

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

Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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')
```

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

Cet exemple montre comment **key generate-file** générer un fichier clé dans votre 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"
  }
}
```

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste d'attributs clés séparés par des espaces sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé correspondante à supprimer.  
Pour obtenir la liste des attributs clés de la CLI CloudHSM pris en charge, voir [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)  
Obligatoire : non

***<ENCODING>***  
Spécifie le format de codage pour le fichier clé  
Obligatoire : oui

***<PATH>***  
Spécifie le chemin du fichier dans lequel le fichier clé sera écrit  
Obligatoire : oui

## Génération de références clés KSP (Windows)
<a name="key-generate-ksp-key-reference"></a>

**Note**  
Cette fonctionnalité n'est disponible que dans les versions 5.16.0 et ultérieures du SDK.

### Conditions préalables
<a name="key-generate-ksp-key-reference-requirements"></a>
+ Vous pouvez générer des références clés KSP uniquement sur les plateformes Windows.
+ Vous devez vous connecter en tant qu'utilisateur cryptographique (CU).

### Emplacement du fichier
<a name="key-generate-ksp-key-reference-options"></a>

Par défaut, AWS CloudHSM stocke les fichiers générés dans : `C:\Users\Default\AppData\Roaming\Microsoft\Crypto\CaviumKSP\GlobalPartition`

Pour spécifier un autre emplacement, utilisez le `--path` paramètre.

### Syntaxe
<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')
```

### Exemple — Génération d'une référence de clé KSP à l'aide d'un filtre d'attribut d'une clé privée
<a name="key-generate-ksp-key-reference-example1"></a>

L'exemple suivant génère une référence de clé KSP pour une clé privée avec une étiquette spécifique.

**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"
  }
}
```

### Exemple — Génération de références de clés KSP pour toutes les paires de clés
<a name="key-generate-ksp-key-reference-example2"></a>

L'exemple suivant génère des références de clé KSP pour toutes les paires de clés de votre cluster.

**Example**  

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

## Rubriques en relation
<a name="key-generate-file-seealso"></a>
+ [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)
+ [Clés de filtrage à l'aide de la CLI CloudHSM](manage-keys-cloudhsm-cli-filtering.md)
+ [La generate-asymmetric-pair catégorie dans la CLI CloudHSM](cloudhsm_cli-key-generate-asymmetric-pair.md)
+ [La catégorie generate-symetric dans la CLI CloudHSM](cloudhsm_cli-key-generate-symmetric.md)

# La generate-asymmetric-pair catégorie dans la CLI CloudHSM
<a name="cloudhsm_cli-key-generate-asymmetric-pair"></a>

Dans la **key generate-asymmetric-pair** CLI CloudHSM, il s'agit d'une catégorie parent pour un groupe de commandes qui, lorsqu'elles sont combinées avec la catégorie parent, créent une commande qui génère des paires de clés asymétriques. Actuellement, cette catégorie comprend les commandes suivantes :
+ [clé generate-asymmetric-pair ec](cloudhsm_cli-key-generate-asymmetric-pair-ec.md)
+ [clé generate-asymmetric-pair RSA](cloudhsm_cli-key-generate-asymmetric-pair-rsa.md)

# Génération d'une paire de clés EC asymétriques à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-generate-asymmetric-pair-ec"></a>

Utilisez la **key asymmetric-pair ec** commande de la CLI CloudHSM pour générer une paire de clés à courbe elliptique asymétrique (EC) dans votre cluster. AWS CloudHSM 

## Type utilisateur
<a name="key-generate-asymmetric-pair-ec-user-type"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

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

Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

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

Ces exemples montrent comment utiliser la commande **key generate-asymmetric-pair ec** pour créer une paire de clés EC.

**Example Exemple : créer une paire de clés 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 Exemple : créer une paire de clés EC avec des attributs facultatifs**  

```
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 Exemple : créer une paire de clés EC avec des valeurs de quorum**  
Lors de la génération d'une clé avec des contrôles de quorum, la clé doit être associée à un nombre minimum d'utilisateurs égal à la plus grande valeur de quorum clé. Les utilisateurs associés incluent le propriétaire de la clé et les utilisateurs cryptographiques avec lesquels la clé est partagée. Pour déterminer le nombre minimum d'utilisateurs avec lesquels partager la clé, obtenez la valeur de quorum la plus élevée entre la valeur du quorum d'utilisation de la clé et la valeur du quorum de gestion des clés, puis soustrayez 1 pour tenir compte du propriétaire de la clé, qui est associé par défaut à la clé. Pour partager la clé avec un plus grand nombre d'utilisateurs, utilisez la **[Partager une clé à l'aide de la CLI CloudHSM](cloudhsm_cli-key-share.md)** commande.  

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

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<CURVE>***  
Spécifie l'identifiant de la courbe elliptique.  
+ prime256v1
+ secp256r1
+ secp224r1
+ secp384r1
+ secp256k1
+ secp521r1
+ ed25519 (uniquement pris en charge sur les instances hsm2m.medium en mode non FIPS)
Obligatoire : oui

***<PUBLIC\$1KEY\$1ATTRIBUTES>***  
Spécifie une liste séparée par des espaces d'attributs clés à définir pour la clé publique EC générée sous la forme `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` (par exemple, `verify=true`)  
Pour obtenir la liste des attributs de clés pris en charge, consultez [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md).  
Obligatoire : non

***<PUBLIC\$1LABEL>***  
Spécifie une étiquette définie par l'utilisateur pour public-key. La taille maximale autorisée `label` est de 127 caractères pour le SDK client 5.11 et versions ultérieures. Le SDK client 5.10 et les versions antérieures sont limités à 126 caractères.  
Obligatoire : oui

***<PRIVATE\$1KEY\$1ATTRIBUTES>***  
Spécifie une liste séparée par des espaces d'attributs clés à définir pour la clé privée EC générée sous la forme `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` (par exemple, `sign=true`)  
Pour obtenir la liste des attributs de clés pris en charge, consultez [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md).  
Obligatoire : non

***<PRIVATE\$1LABEL>***  
Spécifie l'étiquette définie par l'utilisateur pour private-key. La taille maximale autorisée `label` est de 127 caractères pour le SDK client 5.11 et versions ultérieures. Le SDK client 5.10 et les versions antérieures sont limités à 126 caractères.  
Obligatoire : oui

***<SESSION>***  
Crée une clé qui existe uniquement dans la session en cours. La clé ne peut pas être récupérée une fois la session terminée.  
Utilisez ce paramètre lorsque vous n'avez besoin que brièvement d'une clé, par exemple une clé d'encapsulage qui chiffre, puis déchiffre rapidement, une autre clé. N'utilisez pas de clé de session pour chiffrer les données que vous pourriez avoir besoin de déchiffrer après la fin de la session.  
Par défaut, les clés générées sont des clés persistantes (jetons). La transmission vers <SESSION> change cela, garantissant qu'une clé générée avec cet argument est une clé de session (éphémère).  
Obligatoire : non

***<SHARE\$1CRYPTO\$1USERS>***  
Spécifie une liste séparée par des espaces de noms d'utilisateur Crypto User avec lesquels partager la clé privée EC  
Obligatoire : non

***<MANAGE\$1PRIVATE\$1KEY\$1QUORUM\$1VALUE>***  
La valeur du quorum pour les opérations de gestion des clés de la clé privée. Cette valeur doit être inférieure ou égale au nombre d'utilisateurs auxquels la clé est associée. Cela inclut les utilisateurs avec lesquels la clé est partagée et le propriétaire de la clé. Valeur maximale de 8.  
Obligatoire : non

***<USE\$1PRIVATE\$1KEY\$1QUORUM\$1VALUE>***  
La valeur du quorum pour les opérations d'utilisation des clés privées. Cette valeur doit être inférieure ou égale au nombre d'utilisateurs auxquels la clé est associée. Cela inclut les utilisateurs avec lesquels la clé est partagée et le propriétaire de la clé. Valeur maximale de 8.  
Obligatoire : non

## Rubriques en relation
<a name="key-generate-asymmetric-pair-ec-seealso"></a>
+ [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)
+ [Clés de filtrage à l'aide de la CLI CloudHSM](manage-keys-cloudhsm-cli-filtering.md)

# Génération d'une paire de clés RSA asymétrique avec la CLI CloudHSM
<a name="cloudhsm_cli-key-generate-asymmetric-pair-rsa"></a>

Utilisez la **key generate-asymmetric-pair rsa** commande de la CLI CloudHSM pour générer une paire de clés RSA asymétrique dans votre cluster. AWS CloudHSM 

## Type utilisateur
<a name="key-generate-asymmetric-pair-rsa-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

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

Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

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

Ces exemples montrent comment utiliser `key generate-asymmetric-pair rsa` pour créer une paire de clés RSA.

**Example Exemple : créer une paire de clés 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 Exemple : créer une paire de clés RSA avec des attributs facultatifs**  

```
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 Exemple : créer une paire de clés RSA avec des valeurs de quorum**  
Lors de la génération d'une clé avec des contrôles de quorum, la clé doit être associée à un nombre minimum d'utilisateurs égal à la plus grande valeur de quorum clé. Les utilisateurs associés incluent le propriétaire de la clé et les utilisateurs cryptographiques avec lesquels la clé est partagée. Pour déterminer le nombre minimum d'utilisateurs avec lesquels partager la clé, obtenez la valeur de quorum la plus élevée entre la valeur du quorum d'utilisation de la clé et la valeur du quorum de gestion des clés, puis soustrayez 1 pour tenir compte du propriétaire de la clé, qui est associé par défaut à la clé. Pour partager la clé avec un plus grand nombre d'utilisateurs, utilisez la **[Partager une clé à l'aide de la CLI CloudHSM](cloudhsm_cli-key-share.md)** commande.  

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

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<MODULUS\$1SIZE\$1BITS>***  
 Indique la longueur du module en bits. La valeur minimale est de 2048.   
Obligatoire : oui

***<PRIVATE\$1KEY\$1ATTRIBUTES>***  
Spécifie une liste séparée par des espaces d'attributs clés à définir pour la clé privée RSA générée sous la forme `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` (par exemple, `sign=true`)  
Pour obtenir la liste des attributs de clés pris en charge, consultez [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md).  
Obligatoire : non

***<PRIVATE\$1LABEL>***  
 Spécifie l'étiquette définie par l'utilisateur pour private-key. La taille maximale autorisée `label` est de 127 caractères pour le SDK client 5.11 et versions ultérieures. Le SDK client 5.10 et les versions antérieures sont limités à 126 caractères.  
Obligatoire : oui

***<PUBLIC\$1EXPONENT>***  
Spécifie l' exposant public. La valeur doit être un entier impair supérieur ou égal à 65 537.  
Obligatoire : oui

***<PUBLIC\$1KEY\$1ATTRIBUTES>***  
Spécifie une liste séparée par des espaces d'attributs clés à définir pour la clé publique RSA générée sous la forme `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` (par exemple, `verify=true`)  
Pour obtenir la liste des attributs de clés pris en charge, consultez .[Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)  
Obligatoire : non

***<PUBLIC\$1LABEL>***  
 Spécifie une étiquette définie par l'utilisateur pour public-key. La taille maximale autorisée `label` est de 127 caractères pour le SDK client 5.11 et versions ultérieures. Le SDK client 5.10 et les versions antérieures sont limités à 126 caractères.  
Obligatoire : oui

***<SESSION>***  
Crée une clé qui existe uniquement dans la session en cours. La clé ne peut pas être récupérée une fois la session terminée.  
Utilisez ce paramètre lorsque vous n'avez besoin que brièvement d'une clé, par exemple une clé d'encapsulage qui chiffre, puis déchiffre rapidement, une autre clé. N'utilisez pas de clé de session pour chiffrer les données que vous pourriez avoir besoin de déchiffrer après la fin de la session.  
Par défaut, les clés générées sont des clés persistantes (jetons). La transmission vers <SESSION> change cela, garantissant qu'une clé générée avec cet argument est une clé de session (éphémère).  
Obligatoire : non

***<SHARE\$1CRYPTO\$1USERS>***  
Spécifie une liste séparée par des espaces de noms d'utilisateur Crypto avec lesquels partager la clé privée RSA  
Obligatoire : non

***<MANAGE\$1PRIVATE\$1KEY\$1QUORUM\$1VALUE>***  
La valeur du quorum pour les opérations de gestion des clés de la clé privée. Cette valeur doit être inférieure ou égale au nombre d'utilisateurs auxquels la clé est associée. Cela inclut les utilisateurs avec lesquels la clé est partagée et le propriétaire de la clé. Valeur maximale de 8.  
Obligatoire : non

***<USE\$1PRIVATE\$1KEY\$1QUORUM\$1VALUE>***  
La valeur du quorum pour les opérations d'utilisation des clés privées. Cette valeur doit être inférieure ou égale au nombre d'utilisateurs auxquels la clé est associée. Cela inclut les utilisateurs avec lesquels la clé est partagée et le propriétaire de la clé. Valeur maximale de 8.  
Obligatoire : non

## Rubriques en relation
<a name="key-generate-asymmetric-pair-rsa-seealso"></a>
+ [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)
+ [Clés de filtrage à l'aide de la CLI CloudHSM](manage-keys-cloudhsm-cli-filtering.md)

# La catégorie generate-symetric dans la CLI CloudHSM
<a name="cloudhsm_cli-key-generate-symmetric"></a>

Dans la **key generate-symmetric** CLI CloudHSM, il s'agit d'une catégorie parent pour un groupe de commandes qui, lorsqu'elles sont combinées avec la catégorie parent, créent une commande qui génère des clés symétriques. Actuellement, cette catégorie comprend les commandes suivantes :
+ [clé generate-symmetric aes](cloudhsm_cli-key-generate-symmetric-aes.md)
+ [clé generate-symmetric generic-secret](cloudhsm_cli-key-generate-symmetric-generic-secret.md)

# Génération d'une clé AES symétrique avec la CLI CloudHSM
<a name="cloudhsm_cli-key-generate-symmetric-aes"></a>

Utilisez la **key generate-symmetric aes** commande de la CLI CloudHSM pour générer une clé AES symétrique dans votre cluster. AWS CloudHSM 

## Type utilisateur
<a name="key-generate-symmetric-aes-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

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

Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

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

Ces exemples montrent comment utiliser la commande **key generate-symmetric aes** pour créer une clé AES.

**Example Exemple : création d'une clé 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 Exemple : création d'une clé AES avec des attributs facultatifs**  

```
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 Exemple : créer une clé AES avec des valeurs de quorum**  
Lors de la génération d'une clé avec des contrôles de quorum, la clé doit être associée à un nombre minimum d'utilisateurs égal à la plus grande valeur de quorum clé. Les utilisateurs associés incluent le propriétaire de la clé et les utilisateurs cryptographiques avec lesquels la clé est partagée. Pour déterminer le nombre minimum d'utilisateurs avec lesquels partager la clé, obtenez la valeur de quorum la plus élevée entre la valeur du quorum d'utilisation de la clé et la valeur du quorum de gestion des clés, puis soustrayez 1 pour tenir compte du propriétaire de la clé, qui est associé par défaut à la clé. Pour partager la clé avec un plus grand nombre d'utilisateurs, utilisez la **[Partager une clé à l'aide de la CLI CloudHSM](cloudhsm_cli-key-share.md)** commande.  

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

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<KEY\$1ATTRIBUTES>***  
Spécifie une liste séparée par des espaces d'attributs de clés à définir pour la clé AES générée sous la forme `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` (par exemple, `sign=true`).  
Pour obtenir la liste des attributs de clés pris en charge, consultez .[Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)  
Obligatoire : non

***<KEY-LENGTH-BYTES>***  
Spécifie la taille de la clé en octets.  

Valeurs valides :
+ 16, 24 et 32
Obligatoire : oui

***<LABEL>***  
Spécifie une étiquette définie par l'utilisateur pour la clé AES. La taille maximale autorisée `label` est de 127 caractères pour le SDK client 5.11 et versions ultérieures. Le SDK client 5.10 et les versions antérieures sont limités à 126 caractères.  
Obligatoire : oui

***<SESSION>***  
Crée une clé qui existe uniquement dans la session en cours. La clé ne peut pas être récupérée une fois la session terminée.  
Utilisez ce paramètre lorsque vous n'avez besoin que brièvement d'une clé, par exemple une clé d'encapsulage qui chiffre, puis déchiffre rapidement, une autre clé. N'utilisez pas de clé de session pour chiffrer les données que vous pourriez avoir besoin de déchiffrer après la fin de la session.  
Par défaut, les clés générées sont des clés persistantes (jetons). La transmission vers <SESSION> change cela, garantissant qu'une clé générée avec cet argument est une clé de session (éphémère).  
Obligatoire : non

***<SHARE\$1CRYPTO\$1USERS>***  
Spécifie une liste séparée par des espaces de noms d'utilisateur Crypto avec lesquels partager la clé AES  
Obligatoire : non

***<MANAGE\$1KEY\$1QUORUM\$1VALUE>***  
La valeur du quorum pour les opérations de gestion clés. Cette valeur doit être inférieure ou égale au nombre d'utilisateurs auxquels la clé est associée. Cela inclut les utilisateurs avec lesquels la clé est partagée et le propriétaire de la clé. Valeur maximale de 8.  
Obligatoire : non

***<USE\$1KEY\$1QUORUM\$1VALUE>***  
La valeur du quorum pour les opérations d'utilisation des clés. Cette valeur doit être inférieure ou égale au nombre d'utilisateurs auxquels la clé est associée. Cela inclut les utilisateurs avec lesquels la clé est partagée et le propriétaire de la clé. Valeur maximale de 8.  
Obligatoire : non

## Rubriques en relation
<a name="key-generate-symmetric-aes-seealso"></a>
+ [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)
+ [Clés de filtrage à l'aide de la CLI CloudHSM](manage-keys-cloudhsm-cli-filtering.md)

# Génération d'une clé secrète générique symétrique avec la CLI CloudHSM
<a name="cloudhsm_cli-key-generate-symmetric-generic-secret"></a>

Utilisez la **key generate-symmetric generic-secret** commande de la CLI CloudHSM pour générer une clé secrète générique symétrique dans votre cluster. AWS CloudHSM 

## Type utilisateur
<a name="key-generate-symmetric-generic-secret-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

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

Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

## Exemples
<a name="key-generate-symmetric-generic-secret-examples"></a>

Ces exemples montrent comment utiliser la commande **key generate-symmetric generic-secret** pour créer une clé secrète générique.

**Example Exemple : création d'une clé secrète générique**  

```
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 Exemple : création d'une clé secrète générique avec des attributs facultatifs**  

```
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 Exemple : créer une clé secrète générique avec des valeurs de quorum**  
Lors de la génération d'une clé avec des contrôles de quorum, la clé doit être associée à un nombre minimum d'utilisateurs égal à la plus grande valeur de quorum clé. Les utilisateurs associés incluent le propriétaire de la clé et les utilisateurs cryptographiques avec lesquels la clé est partagée. Pour déterminer le nombre minimum d'utilisateurs avec lesquels partager la clé, obtenez la valeur de quorum la plus élevée entre la valeur du quorum d'utilisation de la clé et la valeur du quorum de gestion des clés, puis soustrayez 1 pour tenir compte du propriétaire de la clé, qui est associé par défaut à la clé. Pour partager la clé avec un plus grand nombre d'utilisateurs, utilisez la **[Partager une clé à l'aide de la CLI CloudHSM](cloudhsm_cli-key-share.md)** commande.  

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

## Arguments
<a name="key-generate-symmetric-generic-secret-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<KEY\$1ATTRIBUTES>***  
Spécifie une liste séparée par des espaces d'attributs de clés à définir pour la clé AES générée sous la forme `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` (par exemple, `sign=true`).  
Pour obtenir la liste des attributs de clés pris en charge, consultez .[Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)  
Obligatoire : non

***<KEY-LENGTH-BYTES>***  
Spécifie la taille de la clé en octets.  

Valeurs valides :
+ 1 à 800
Obligatoire : oui

***<LABEL>***  
Spécifie une étiquette définie par l'utilisateur pour la clé secrète générique. La taille maximale autorisée `label` est de 127 caractères pour le SDK client 5.11 et versions ultérieures. Le SDK client 5.10 et versions antérieures est limité à 126 caractères.  
Obligatoire : oui

***<SESSION>***  
Crée une clé qui existe uniquement dans la session en cours. La clé ne peut pas être récupérée une fois la session terminée.  
Utilisez ce paramètre lorsque vous n'avez besoin que brièvement d'une clé, par exemple une clé d'encapsulage qui chiffre, puis déchiffre rapidement, une autre clé. N'utilisez pas de clé de session pour chiffrer les données que vous pourriez avoir besoin de déchiffrer après la fin de la session.  
Par défaut, les clés générées sont des clés persistantes (jetons). La transmission vers <SESSION> change cela, garantissant qu'une clé générée avec cet argument est une clé de session (éphémère).  
Obligatoire : non

***<SHARE\$1CRYPTO\$1USERS>***  
Liste séparée par des espaces de noms d'utilisateur Crypto avec lesquels partager la clé secrète générique  
Obligatoire : non

***<MANAGE\$1KEY\$1QUORUM\$1VALUE>***  
La valeur du quorum pour les opérations de gestion clés. Cette valeur doit être inférieure ou égale au nombre d'utilisateurs auxquels la clé est associée. Cela inclut les utilisateurs avec lesquels la clé est partagée et le propriétaire de la clé. Valeur maximale de 8.  
Obligatoire : non

***<USE\$1KEY\$1QUORUM\$1VALUE>***  
La valeur du quorum pour les opérations d'utilisation des clés. Cette valeur doit être inférieure ou égale au nombre d'utilisateurs auxquels la clé est associée. Cela inclut les utilisateurs avec lesquels la clé est partagée et le propriétaire de la clé. Valeur maximale de 8.  
Obligatoire : non

## Rubriques en relation
<a name="key-generate-symmetric-generic-secret-seealso"></a>
+ [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)
+ [Clés de filtrage à l'aide de la CLI CloudHSM](manage-keys-cloudhsm-cli-filtering.md)

# Importer une clé au format PEM avec la CLI CloudHSM
<a name="cloudhsm_cli-key-import-pem"></a>

Utilisez la **key import pem** commande in AWS CloudHSM pour importer une clé au format PEM dans un module de sécurité matérielle (HSM). Vous pouvez l'utiliser pour importer des clés publiques générées hors du HSM.

**Note**  
Utilisez la [Exporter une clé asymétrique avec la CLI CloudHSM](cloudhsm_cli-key-generate-file.md) commande pour créer un fichier PEM standard à partir d'une clé publique ou pour créer un fichier PEM de référence à partir d'une clé privée.

## Type utilisateur
<a name="cloudhsm_cli-key-import-pem-user-type"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-import-pem-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

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

Cet exemple montre comment utiliser la **key import pem** commande pour importer une clé publique RSA à partir d'un fichier au format PEM.

**Example Exemple : importation d'une clé publique 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 Exemple : importation d'une clé publique RSA avec des attributs facultatifs**  

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

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<PATH>***  
Spécifie le chemin du fichier où se trouve le fichier clé.  
Obligatoire : oui

***<LABEL>***  
Spécifie une étiquette définie par l'utilisateur pour la clé importée. La taille maximale autorisée pour `label` est de 126 caractères.  
Obligatoire : oui

***<KEY\$1TYPE\$1CLASS>***  
Type de clé et classe de clé encapsulée.  
Valeurs possibles :  
+ ec-public
+ rsa-public
Obligatoire : oui

***<IMPORT\$1KEY\$1ATTRIBUTES>***  
Spécifie une liste séparée par des espaces d'attributs clés à définir pour la clé importée sous la forme `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` (par exemple,`sign=true`). Pour obtenir la liste des attributs de clés pris en charge, consultez [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md).  
Obligatoire : non

## Rubriques en relation
<a name="cloudhsm_cli-key-import-pem-seealso"></a>
+ [La catégorie de signes cryptographiques dans la CLI CloudHSM](cloudhsm_cli-crypto-sign.md)
+ [La catégorie de vérification cryptographique dans la CLI CloudHSM](cloudhsm_cli-crypto-verify.md)

# Répertorier les clés d'un utilisateur avec la CLI CloudHSM
<a name="cloudhsm_cli-key-list"></a>

Utilisez la **key list** commande de la CLI CloudHSM pour rechercher toutes les clés de l'utilisateur actuel présent AWS CloudHSM dans votre cluster. La sortie inclut les clés que l'utilisateur possède et partage, ainsi que toutes les clés publiques des HSM dans le cluster CloudHSM.

## Type utilisateur
<a name="chsm-cli-key-list-user-type"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Administrateurs () COs
+ Utilisateurs de cryptomonnaies (CUs)

## Syntaxe
<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
```

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

Les exemples suivants montrent les différentes manières d'exécuter la commande **key list**. Les exemples suivants montrent les sorties en tant qu'utilisateur cryptographique.

**Example Exemple : Rechercher toutes les clés — valeur par défaut**  
Cette commande répertorie les clés de l'utilisateur connecté présent dans le AWS CloudHSM cluster.  
Par défaut, seules 10 touches de l'utilisateur actuellement connecté sont affichées, et seules les touches `key-reference` et `label` sont affichées en sortie. Utilisez les options de pagination appropriées pour afficher plus ou moins de clés en sortie.

```
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 Exemple : Rechercher toutes les clés — détaillé**  
La sortie inclut les clés que l'utilisateur possède et partage, ainsi que toutes les clés publiques du HSMs.  
Remarque : Par défaut, seules 10 clés de l'utilisateur actuellement connecté sont affichées. Utilisez les options de pagination appropriées pour afficher plus ou moins de clés en sortie.

```
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 Exemple : retour paginé**  
L'exemple suivant affiche un sous-ensemble paginé des clés qui ne montre que deux clés. L'exemple fournit ensuite un appel suivant pour afficher les deux touches suivantes.  

```
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"
  }
}
```
Pour afficher les 2 touches suivantes, un appel suivant peut être effectué :  

```
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"
  }
}
```
Pour d'autres exemples illustrant le fonctionnement du mécanisme de filtration des clés dans la CLI CloudHSM, consultez [Clés de filtrage à l'aide de la CLI CloudHSM](manage-keys-cloudhsm-cli-filtering.md).

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner les clés correspondantes à répertorier.  
Pour obtenir la liste des attributs clés de la CLI CloudHSM pris en charge, voir [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)  
Obligatoire : non

***<MAX\$1ITEMS>***  
Le nombre total d'éléments à renvoyer dans la sortie de la commande. Si le nombre total d'éléments disponibles est supérieur à la valeur spécifiée, un jeton NextToken est fourni dans la sortie de la commande. Pour reprendre la pagination, fournissez la valeur de next-token dans l'argument starting-token d'une commande suivante.  
Obligatoire : non

***<STARTING\$1TOKEN>***  
Jeton permettant de spécifier où commencer la pagination. Il s'agit du jeton next-token d'une réponse tronquée précédemment.  
Obligatoire : non

***<VERBOSE>***  
Le cas échéant, imprime tous les attributs et informations clés pour chaque clé correspondante. Par défaut, chaque clé correspondante affiche uniquement sa référence de clé et son attribut d'étiquette. Cet indicateur n'a aucun effet lorsqu'il est utilisé par les administrateurs.  
Obligatoire : non

## Rubriques en relation
<a name="chsm-key-list-seealso"></a>
+ [Supprimer une clé à l'aide de la CLI CloudHSM](cloudhsm_cli-key-delete.md)
+ [Exporter une clé asymétrique avec la CLI CloudHSM](cloudhsm_cli-key-generate-file.md)
+ [Annuler le partage d'une clé à l'aide de la CLI CloudHSM](cloudhsm_cli-key-unshare.md)
+ [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)
+ [Clés de filtrage à l'aide de la CLI CloudHSM](manage-keys-cloudhsm-cli-filtering.md)

# Répliquer une clé à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-replicate"></a>

Utilisez la **key replicate** commande de la CLI CloudHSM pour répliquer une clé d'un cluster source vers AWS CloudHSM un cluster de destination. AWS CloudHSM 

## Type utilisateur
<a name="chsm-cli-key-replicate-user-type"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Administrateurs () COs
+ Utilisateurs de cryptomonnaies (CUs)
**Note**  
Les utilisateurs de cryptomonnaies doivent posséder la clé pour utiliser cette commande.

## Exigences
<a name="cloudhsm_cli-key-replicate-requirements"></a>
+ Les clusters source et de destination doivent être des clones. Cela signifie que l'un a été créé à partir d'une sauvegarde de l'autre, ou qu'ils ont tous deux été créés à partir d'une sauvegarde commune. Pour plus d’informations, consultez [Création de clusters à partir de sauvegardes](create-cluster-from-backup.md).
+ Le propriétaire de la clé doit exister sur le cluster de destination. En outre, si la clé est partagée avec des utilisateurs, ceux-ci doivent également exister sur le cluster de destination.
+ Pour exécuter cette commande, vous devez être connecté en tant qu'utilisateur cryptographique ou administrateur sur les clusters source et de destination.
  +  En mode commande unique, la commande utilisera les variables d'environnement CLOUDHSM\$1PIN et CLOUDHSM\$1ROLE pour s'authentifier sur le cluster source. Pour plus d’informations, consultez [Mode commande unique](cloudhsm_cli-modes.md#cloudhsm_cli-mode-single-command). Pour fournir des informations d'identification pour le cluster de destination, vous devez définir deux variables environnementales supplémentaires : DESTINATION\$1CLOUDHSM\$1PIN et DESTINATION\$1CLOUDHSM\$1ROLE :

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

    ```
    $ export DESTINATION_CLOUDHSM_PIN=<username:password>
    ```
  +  En mode interactif, les utilisateurs devront se connecter explicitement aux clusters source et de destination.

## Syntaxe
<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
```

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

**Example Exemple : clé de réplication**  
Cette commande réplique une clé d'un cluster source vers un cluster de destination cloné. L'exemple ci-dessous illustre le résultat lorsque vous êtes connecté en tant qu'utilisateur cryptographique sur les deux 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"
  }
}
```

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

***<FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé correspondante sur le cluster source.  
Pour obtenir la liste des attributs clés de la CLI CloudHSM pris en charge, voir [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)  
Obligatoire : oui

***<SOURCE\$1CLUSTER\$1ID>***  
ID du cluster source.  
Obligatoire : oui

***<DESTINATION\$1CLUSTER\$1ID>***  
L'ID du cluster de destination.  
Obligatoire : oui

## Rubriques en relation
<a name="chsm-key-replicate-seealso"></a>
+ [Connexion à plusieurs clusters à l'aide de la CLI CloudHSM](cloudhsm_cli-configs-multi-cluster.md)

# Définissez les attributs des clés à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-set-attribute"></a>

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

Pour obtenir la liste des attributs clés qui peuvent être utilisés dans la CLI CloudHSM, consultez. [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)

## Type utilisateur
<a name="chsm-cli-key-set-attribute-user-type"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Les utilisateurs de cryptomonnaies (CUs) peuvent exécuter cette commande.
+ Les administrateurs peuvent définir l'attribut de confiance.

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

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

## Syntaxe
<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
```

## Exemple : définition d'un attribut clé
<a name="chsm-cli-key-set-attribute-examples"></a>

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

**Example**  

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

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

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

   ```
   aws-cloudhsm > key list --filter attr.label=my_key --verbose
   {
     "error_code": 0,
     "data": {
       "matched_keys": [
         {
           "key-reference": "0x00000000006400ec",
           "key-info": {
             "key-owners": [
               {
                 "username": "bob",
                 "key-coverage": "full"
               }
             ],
             "shared-users": [],
           "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
     }
   }
   ```

## Arguments
<a name="chsm-cli-key-set-attribute-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<KEY\$1ATTRIBUTE>***  
Spécifie le nom de l'attribut de la clé.  
Obligatoire : oui

***<FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste d'attributs clés séparés par des espaces sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé correspondante à supprimer.  
Pour obtenir la liste des attributs clés de la CLI CloudHSM pris en charge, voir [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)  
Obligatoire : non

***<KEY\$1ATTRIBUTE\$1VALUE>***  
Spécifie la valeur de l'attribut de la clé.  
Obligatoire : oui

***<KEY\$1REFERENCE>***  
Représentation hexadécimale ou décimale de la clé (comme un handle de clé).  
Obligatoire : non

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur de quorum du service de gestion des clés de la clé est supérieure à 1.

## Rubriques en relation
<a name="chsm-cli-key-set-attribute-see-also"></a>
+ [Clés de filtrage à l'aide de la CLI CloudHSM](manage-keys-cloudhsm-cli-filtering.md)
+ [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)

# Partager une clé à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-share"></a>

Utilisez la **key share** commande de la CLI CloudHSM pour partager une clé CUs avec d'autres AWS CloudHSM membres de votre cluster.

Seul le CU qui a créé la clé et qui en est donc propriétaire peut partager la clé. Les utilisateurs avec lesquels la clé est partagée peuvent utiliser la clé dans des opérations de chiffrement, mais ils ne peuvent pas l'exporter, la supprimer ni la partager ou annuler son partage avec d'autres utilisateurs. De plus, ces utilisateurs ne peuvent pas modifier les [attributs de clé](cloudhsm_cli-key-attributes.md).

## Type utilisateur
<a name="chsm-cli-key-share-user-type"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

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

Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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')
```

## Exemple : partager une clé avec un autre CU
<a name="chsm-cli-key-share-examples"></a>

L'exemple suivant montre comment utiliser la commande **key share** pour partager une clé avec le CU `alice`.

**Example**  

1. Exécutez la commande **key share** pour partager la clé avec `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. Exécutez la commande **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. Dans la liste ci-dessus, vérifiez que `alice` se trouve dans la liste des `shared-users`

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste d'attributs clés séparés par des espaces sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé correspondante à supprimer.  
Pour obtenir la liste des attributs de clés pris en charge, consultez .[Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)  
Obligatoire : oui

***<USERNAME>***  
Spécifie un nom convivial pour l'utilisateur. La longueur maximale est de 31 caractères. Le seul caractère spécial autorisé est un trait de soulignement ( \$1 ). Le nom d'utilisateur n’est pas sensible à la casse dans cette commande, il est toujours affiché en minuscules.  
Obligatoire : oui

***<ROLE>***  
Spécifie le rôle attribué à cet utilisateur. Ce paramètre est obligatoire. Pour obtenir le rôle de l'utilisateur, utilisez la commande user list. Pour plus d'informations sur les types d'utilisateur sur un HSM, consultez [Types d'utilisateurs HSM pour la CLI CloudHSM](understanding-users.md).  
Obligatoire : oui

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur de quorum du service de gestion des clés de la clé est supérieure à 1.

## Rubriques en relation
<a name="chsm-cli-key-share-see-also"></a>
+ [Clés de filtrage à l'aide de la CLI CloudHSM](manage-keys-cloudhsm-cli-filtering.md)
+ [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)

# Annuler le partage d'une clé à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-unshare"></a>

Utilisez la **key unshare** commande de la CLI CloudHSM pour annuler le partage d'une clé CUs avec d'autres membres de votre cluster. AWS CloudHSM 

Seul le CU qui a créé la clé et qui en est donc propriétaire peut annuler le partage de la clé. Les utilisateurs avec lesquels la clé est partagée peuvent utiliser la clé dans des opérations de chiffrement, mais ils ne peuvent pas l'exporter, la supprimer ni la partager ou annuler son partage avec d'autres utilisateurs. De plus, ces utilisateurs ne peuvent pas modifier les [attributs de clé](cloudhsm_cli-key-attributes.md).

## Type utilisateur
<a name="chsm-cli-key-unshare-user-type"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

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

Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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')
```

## Exemple : annuler le partage d'une clé avec un autre CU
<a name="chsm-cli-key-share-examples"></a>

L'exemple suivant montre comment utiliser la commande **key unshare** pour annuler le partage d'une clé avec le CU`alice`.

**Example**  

1. Exécutez la commande **key list** et filtrez en fonction de la touche spécifique avec laquelle vous souhaitez annuler le partage avec `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. Confirmez que `alice` se trouve dans la sortie `shared-users` et exécutez la commande **key unshare** suivante pour annuler le partage de la clé avec `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. Exécutez à nouveau la commande `key list` pour confirmer que la clé n'a pas été partagée avec `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
     }
   }
   ```

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste d'attributs clés séparés par des espaces sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé correspondante à supprimer.  
Pour obtenir la liste des attributs de clés pris en charge, consultez .[Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)  
Obligatoire : oui

***<USERNAME>***  
Spécifie un nom convivial pour l'utilisateur. La longueur maximale est de 31 caractères. Le seul caractère spécial autorisé est un trait de soulignement ( \$1 ). Le nom d'utilisateur n’est pas sensible à la casse dans cette commande, il est toujours affiché en minuscules.  
Obligatoire : oui

***<ROLE>***  
Spécifie le rôle attribué à cet utilisateur. Ce paramètre est obligatoire. Pour obtenir le rôle de l'utilisateur, utilisez la commande user list. Pour plus d'informations sur les types d'utilisateur sur un HSM, consultez [Types d'utilisateurs HSM pour la CLI CloudHSM](understanding-users.md).  
Obligatoire : oui

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur de quorum du service de gestion des clés de la clé est supérieure à 1.

## Rubriques en relation
<a name="chsm-cli-key-unshare-see-also"></a>
+ [Clés de filtrage à l'aide de la CLI CloudHSM](manage-keys-cloudhsm-cli-filtering.md)
+ [Attributs de clé de la CLI CloudHSM](cloudhsm_cli-key-attributes.md)

# La commande key unwrap dans la CLI CloudHSM
<a name="cloudhsm_cli-key-unwrap"></a>

La commande **key unwrap** parent de la CLI CloudHSM importe une clé privée cryptée (encapsulée) symétrique ou asymétrique d'un fichier vers le HSM. Cette commande est conçue pour importer des clés chiffrées qui ont été encapsulées par la [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md) commande, mais elle peut également être utilisée pour désencapsuler des clés encapsulées avec d'autres outils. Toutefois, dans ces cas, nous vous recommandons d'utiliser les bibliothèques de logiciels PKCS \$1 11 ou JCE pour désencapsuler la clé.
+ [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)

# Désencapsuler une clé avec AES-GCM à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-unwrap-aes-gcm"></a>

Utilisez la **key unwrap aes-gcm** commande de la CLI CloudHSM pour désencapsuler une clé de charge utile dans le cluster à l'aide de la clé d'encapsulation AES et du mécanisme de déballage. `AES-GCM`

Les clés non emballées peuvent être utilisées de la même manière que les clés générées par AWS CloudHSM. Pour indiquer qu'ils n'ont pas été générés localement, leur `local` attribut est défini sur`false`.

Pour utiliser la **key unwrap aes-gcm** commande, vous devez disposer de la clé d'encapsulation AES dans votre AWS CloudHSM cluster et son `unwrap` attribut doit être défini sur`true`.

## Type utilisateur
<a name="cloudhsm_cli-key-unwrap-aes-gcm-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-unwrap-aes-gcm-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

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

Ces exemples montrent comment utiliser la **key unwrap aes-gcm** commande à l'aide d'une clé AES avec la valeur `unwrap` d'attribut définie sur`true`.

**Example Exemple : désencapsuler une clé de charge utile à partir de données clés encapsulées codées en 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 Exemple : désencapsuler une clé de charge utile fournie via un chemin de données**  

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

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé à utiliser pour déballer.  
Obligatoire : oui

***<DATA\$1PATH>***  
Chemin d'accès au fichier binaire contenant les données clés encapsulées.  
Obligatoire : Oui (sauf si fourni via des données codées en Base64)

***<DATA>***  
Données clés encapsulées codées en Base64.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<ATTRIBUTES>***  
Liste d'attributs clés séparés par des espaces sous la forme de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour la clé encapsulée.  
Obligatoire : non

***<AAD>***  
En tant que valeur de données authentifiées supplémentaires (AAD) GCM, en hexadécimal.  
Obligatoire : non

***<TAG\$1LENGTH\$1BITS>***  
Longueur de la balise Aes GCM en bits.  
Obligatoire : oui

***<KEY\$1TYPE\$1CLASS>***  
Type de clé et classe de clé encapsulée [valeurs possibles :`aes`,`des3`,`ec-private`,`generic-secret`,`rsa-private`].  
Obligatoire : oui

***<LABEL>***  
Étiquette pour la clé déballée.  
Obligatoire : oui

***<SESSION>***  
Crée une clé de session qui n'existe que dans la session en cours. La clé ne peut pas être récupérée une fois la session terminée.  
Obligatoire : non

***<IV>***  
Valeur initiale utilisée pour envelopper la clé, en hexadécimal.  
Obligatoire : non

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur de quorum du service de gestion des clés de la clé de déballage est supérieure à 1.

## Rubriques en relation
<a name="cloudhsm_cli-key-unwrap-aes-gcm-seealso"></a>
+ [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)
+ [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)

# Désencapsuler une clé à l' AES-NO-PADaide de la CLI CloudHSM
<a name="cloudhsm_cli-key-unwrap-aes-no-pad"></a>

Utilisez la **key unwrap aes-no-pad** commande de la CLI CloudHSM pour désencapsuler une clé de charge utile AWS CloudHSM dans le cluster à l'aide de la clé d'encapsulation AES et du mécanisme de déballage. `AES-NO-PAD`

Les clés non emballées peuvent être utilisées de la même manière que les clés générées par AWS CloudHSM. Pour indiquer qu'ils n'ont pas été générés localement, leur `local` attribut est défini sur`false`.

Pour utiliser la **key unwrap aes-no-pad** commande, vous devez disposer de la clé d'encapsulation AES dans votre AWS CloudHSM cluster et son `unwrap` attribut doit être défini sur`true`.

## Type utilisateur
<a name="cloudhsm_cli-key-unwrap-aes-no-pad-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-unwrap-aes-no-pad-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

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

Ces exemples montrent comment utiliser la **key unwrap aes-no-pad** commande à l'aide d'une clé AES avec la valeur `unwrap` d'attribut définie sur`true`.

**Example Exemple : désencapsuler une clé de charge utile à partir de données clés encapsulées codées en 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 Exemple : désencapsuler une clé de charge utile fournie via un chemin de données**  

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

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé à utiliser pour le déballage.  
Obligatoire : oui

***<DATA\$1PATH>***  
Chemin d'accès au fichier binaire contenant les données clés encapsulées.  
Obligatoire : Oui (sauf si fourni via des données codées en Base64)

***<DATA>***  
Données clés encapsulées codées en Base64.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<ATTRIBUTES>***  
Liste d'attributs clés séparés par des espaces sous la forme de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour la clé encapsulée.  
Obligatoire : non

***<KEY\$1TYPE\$1CLASS>***  
Type de clé et classe de clé encapsulée [valeurs possibles :`aes`,`des3`,`ec-private`,`generic-secret`,`rsa-private`].  
Obligatoire : oui

***<LABEL>***  
Étiquette pour la clé déballée.  
Obligatoire : oui

***<SESSION>***  
Crée une clé de session qui n'existe que dans la session en cours. La clé ne peut pas être récupérée une fois la session terminée.  
Obligatoire : non

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur de quorum du service de gestion des clés de la clé de déballage est supérieure à 1.

## Rubriques en relation
<a name="cloudhsm_cli-key-unwrap-aes-no-pad-seealso"></a>
+ [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)
+ [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)

# Désencapsuler une clé avec AES- PKCS5 -PAD à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad"></a>

Utilisez la **key unwrap aes-pkcs5-pad** commande de la CLI CloudHSM pour déballer une clé de charge utile à l'aide de la clé d'encapsulation AES et du mécanisme de déballage. `AES-PKCS5-PAD`

Les clés non emballées peuvent être utilisées de la même manière que les clés générées par AWS CloudHSM. Pour indiquer qu'ils n'ont pas été générés localement, leur `local` attribut est défini sur`false`.

Pour utiliser la **key unwrap aes-pkcs5-pad** commande, vous devez disposer de la clé d'encapsulation AES dans votre AWS CloudHSM cluster et son `unwrap` attribut doit être défini sur`true`.

## Type utilisateur
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

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

Ces exemples montrent comment utiliser la **key unwrap aes-pkcs5-pad** commande à l'aide d'une clé AES avec la valeur `unwrap` d'attribut définie sur`true`.

**Example Exemple : désencapsuler une clé de charge utile à partir de données clés encapsulées codées en 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 Exemple : désencapsuler une clé de charge utile fournie via un chemin de données**  

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

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé à utiliser pour le déballage.  
Obligatoire : oui

***<DATA\$1PATH>***  
Chemin d'accès au fichier binaire contenant les données clés encapsulées.  
Obligatoire : Oui (sauf si fourni via des données codées en Base64)

***<DATA>***  
Données clés encapsulées codées en Base64.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<ATTRIBUTES>***  
Liste d'attributs clés séparés par des espaces sous la forme de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour la clé encapsulée.  
Obligatoire : non

***<KEY\$1TYPE\$1CLASS>***  
Type de clé et classe de clé encapsulée [valeurs possibles :`aes`,`des3`,`ec-private`,`generic-secret`,`rsa-private`].  
Obligatoire : oui

***<LABEL>***  
Étiquette pour la clé déballée.  
Obligatoire : oui

***<SESSION>***  
Crée une clé de session qui n'existe que dans la session en cours. La clé ne peut pas être récupérée une fois la session terminée.  
Obligatoire : non

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur de quorum du service de gestion des clés de la clé de déballage est supérieure à 1.

## Rubriques en relation
<a name="cloudhsm_cli-key-unwrap-aes-pkcs5-pad-seealso"></a>
+ [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)
+ [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)

# Désencapsuler une clé à l' AES-ZERO-PADaide de la CLI CloudHSM
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad"></a>

Utilisez la **key unwrap aes-zero-pad** commande de la CLI CloudHSM pour désencapsuler une clé de charge utile AWS CloudHSM dans le cluster à l'aide de la clé d'encapsulation AES et du mécanisme de déballage. `AES-ZERO-PAD`

Les clés non emballées peuvent être utilisées de la même manière que les clés générées par AWS CloudHSM. Pour indiquer qu'ils n'ont pas été générés localement, leur `local` attribut est défini sur`false`.

Pour utiliser la **key unwrap aes-no-pad** commande, vous devez disposer de la clé d'encapsulation AES dans votre AWS CloudHSM cluster et son `unwrap` attribut doit être défini sur`true`.

## Type utilisateur
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

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

Ces exemples montrent comment utiliser la **key unwrap aes-zero-pad** commande à l'aide d'une clé AES avec la valeur `unwrap` d'attribut définie sur`true`.

**Example Exemple : désencapsuler une clé de charge utile à partir de données clés encapsulées codées en 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 Exemple : désencapsuler une clé de charge utile fournie via un chemin de données**  

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

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé à utiliser pour le déballage.  
Obligatoire : oui

***<DATA\$1PATH>***  
Chemin d'accès au fichier binaire contenant les données clés encapsulées.  
Obligatoire : Oui (sauf si fourni via des données codées en Base64)

***<DATA>***  
Données clés encapsulées codées en Base64.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<ATTRIBUTES>***  
Liste d'attributs clés séparés par des espaces sous la forme de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour la clé encapsulée.  
Obligatoire : non

***<KEY\$1TYPE\$1CLASS>***  
Type de clé et classe de clé encapsulée [valeurs possibles :`aes`,`des3`,`ec-private`,`generic-secret`,`rsa-private`].  
Obligatoire : oui

***<LABEL>***  
Étiquette pour la clé déballée.  
Obligatoire : oui

***<SESSION>***  
Crée une clé de session qui n'existe que dans la session en cours. La clé ne peut pas être récupérée une fois la session terminée.  
Obligatoire : non

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur de quorum du service de gestion des clés de la clé de déballage est supérieure à 1.

## Rubriques en relation
<a name="cloudhsm_cli-key-unwrap-aes-zero-pad-seealso"></a>
+ [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)
+ [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)

# Désencapsuler une clé à l' CLOUDHSM-AES-GCMaide de la CLI CloudHSM
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm"></a>

Utilisez la **key unwrap cloudhsm-aes-gcm** commande de la CLI CloudHSM pour désencapsuler une clé de charge utile AWS CloudHSM dans le cluster à l'aide de la clé d'encapsulation AES et du mécanisme de déballage. `CLOUDHSM-AES-GCM`

Les clés non emballées peuvent être utilisées de la même manière que les clés générées par AWS CloudHSM. Pour indiquer qu'ils n'ont pas été générés localement, leur `local` attribut est défini sur`false`.

Pour utiliser la **key unwrap cloudhsm-aes-gcm** commande, vous devez disposer de la clé d'encapsulation AES dans votre AWS CloudHSM cluster et son `unwrap` attribut doit être défini sur`true`.

## Type utilisateur
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

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

Ces exemples montrent comment utiliser la **key unwrap cloudhsm-aes-gcm** commande à l'aide d'une clé AES avec la valeur `unwrap` d'attribut définie sur`true`.

**Example Exemple : désencapsuler une clé de charge utile à partir de données clés encapsulées codées en 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 Exemple : déballer une clé de charge utile fournie via un chemin de données**  

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

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

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste d'attributs clés séparés par des espaces sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé à déballer.  
Obligatoire : oui

***<DATA\$1PATH>***  
Chemin d'accès au fichier binaire contenant les données clés encapsulées.  
Obligatoire : Oui (sauf si fourni via des données codées en Base64)

***<DATA>***  
Données clés encapsulées codées en Base64.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<ATTRIBUTES>***  
Liste d'attributs clés séparés par des espaces sous la forme `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` d'une clé encapsulée.  
Obligatoire : non

***<AAD>***  
En tant que valeur de données authentifiées supplémentaires (AAD) GCM, en hexadécimal.  
Obligatoire : non

***<TAG\$1LENGTH\$1BITS>***  
Longueur de la balise Aes GCM en bits.  
Obligatoire : oui

***<KEY\$1TYPE\$1CLASS>***  
Type de clé et classe de clé encapsulée [valeurs possibles :`aes`,`des3`,`ec-private`,`generic-secret`,`rsa-private`].  
Obligatoire : oui

***<LABEL>***  
Étiquette pour la clé déballée.  
Obligatoire : oui

***<SESSION>***  
Crée une clé de session qui n'existe que dans la session en cours. La clé ne peut pas être récupérée une fois la session terminée.  
Obligatoire : non

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur de quorum du service de gestion des clés de la clé de déballage est supérieure à 1.

## Rubriques en relation
<a name="cloudhsm_cli-key-unwrap-cloudhsm-aes-gcm-seealso"></a>
+ [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)
+ [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)

# Désencapsuler une clé avec RSA-AES à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-unwrap-rsa-aes"></a>

Utilisez la **key unwrap rsa-aes** commande de la CLI CloudHSM pour déballer une clé de charge utile à l'aide d'une clé privée RSA et du mécanisme de déballage. `RSA-AES`

Les clés non emballées peuvent être utilisées de la même manière que les clés générées par AWS CloudHSM. Pour indiquer qu'ils n'ont pas été générés localement, leur `local` attribut est défini sur`false`.

Pour utiliser le**key unwrap rsa-aes**, vous devez disposer de la clé privée RSA de la clé d'encapsulation publique RSA dans votre AWS CloudHSM cluster, et son `unwrap` attribut doit être défini sur. `true` 

**Note**  
Cette commande est uniquement disponible avec la CLI CloudHSM 5.11\$1.

## Type utilisateur
<a name="cloudhsm_cli-key-unwrap-rsa-aes-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-unwrap-rsa-aes-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

## Exemple
<a name="cloudhsm_cli-key-unwrap-rsa-aes-examples"></a>

Ces exemples montrent comment utiliser la **key unwrap rsa-aes** commande à l'aide de la clé privée RSA avec la valeur `unwrap` d'attribut définie sur. `true`

**Example Exemple : désencapsuler une clé de charge utile à partir de données clés encapsulées codées en 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 Exemple : désencapsuler une clé de charge utile fournie via un chemin de données**  

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

## Arguments
<a name="cloudhsm_cli-key-unwrap-rsa-aes-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé à déballer.  
Obligatoire : oui

***<DATA\$1PATH>***  
Chemin d'accès au fichier binaire contenant les données clés encapsulées.  
Obligatoire : Oui (sauf si fourni via des données codées en Base64)

***<DATA>***  
Données clés encapsulées codées en Base64.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<ATTRIBUTES>***  
Liste d'attributs clés séparés par des espaces sous la forme de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour la clé encapsulée.  
Obligatoire : non

***<KEY\$1TYPE\$1CLASS>***  
Type de clé et classe de clé encapsulée [valeurs possibles :`aes`,`des3`,`ec-private`,`generic-secret`,`rsa-private`].  
Obligatoire : oui

***<HASH\$1FUNCTION>***  
Spécifie la fonction de hachage.  
Valeurs valides :  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
Obligatoire : oui

***<MGF>***  
Spécifie la fonction de génération de masques.   
La fonction de hachage de la fonction de génération de masque doit correspondre à la fonction de hachage du mécanisme de signature.
Valeurs valides :  
+ mgf1-sha1
+ mgf1-sha225
+ mgf1-sha255
+ mgf1-sha385
+ mgf1-sha512
Obligatoire : oui

***<LABEL>***  
Étiquette pour la clé déballée.  
Obligatoire : oui

***<SESSION>***  
Crée une clé de session qui n'existe que dans la session en cours. La clé ne peut pas être récupérée une fois la session terminée.  
Obligatoire : non

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur de quorum du service de gestion des clés de la clé de déballage est supérieure à 1.

## Rubriques en relation
<a name="cloudhsm_cli-key-unwrap-rsa-aes-seealso"></a>
+ [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)
+ [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)

# Désencapsuler une clé avec RSA-OAEP à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-unwrap-rsa-oaep"></a>

Utilisez la **key unwrap rsa-oaep** commande de la CLI CloudHSM pour déballer une clé de charge utile à l'aide de la clé privée RSA et du mécanisme de déballage. `RSA-OAEP`

Les clés non emballées peuvent être utilisées de la même manière que les clés générées par AWS CloudHSM. Pour indiquer qu'ils n'ont pas été générés localement, leur `local` attribut est défini sur`false`.

Pour utiliser la **key unwrap rsa-oaep** commande, vous devez disposer de la clé privée RSA de la clé d'encapsulation publique RSA dans votre AWS CloudHSM cluster, et son `unwrap` attribut doit être défini sur. `true`

## Type utilisateur
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

## Exemples
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-examples"></a>

Ces exemples montrent comment utiliser la **key unwrap rsa-oaep** commande à l'aide de la clé privée RSA avec la valeur `unwrap` d'attribut définie sur. `true`

**Example Exemple : désencapsuler une clé de charge utile à partir de données clés encapsulées codées en 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 Exemple : déballer une clé de charge utile fournie via un chemin de données**  

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

## Arguments
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé à utiliser pour déballer.  
Obligatoire : oui

***<DATA\$1PATH>***  
Chemin d'accès au fichier binaire contenant les données clés encapsulées.  
Obligatoire : Oui (sauf si fourni via des données codées en Base64)

***<DATA>***  
Données clés encapsulées codées en Base64.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<ATTRIBUTES>***  
Liste d'attributs clés séparés par des espaces sous la forme `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` d'une clé encapsulée.  
Obligatoire : non

***<KEY\$1TYPE\$1CLASS>***  
Type de clé et classe de clé encapsulée [valeurs possibles :`aes`,`des3`,`ec-private`,`generic-secret`,`rsa-private`].  
Obligatoire : oui

***<HASH\$1FUNCTION>***  
Spécifie la fonction de hachage.  
Valeurs valides :  
+ sha1
+ sha224
+ sha256
+ sha384
+ sha512
Obligatoire : oui

***<MGF>***  
Spécifie la fonction de génération de masques.   
La fonction de hachage de la fonction de génération de masque doit correspondre à la fonction de hachage du mécanisme de signature.
Valeurs valides :  
+ mgf1-sha1
+ mgf1-sha225
+ mgf1-sha255
+ mgf1-sha385
+ mgf1-sha512
Obligatoire : oui

***<LABEL>***  
Étiquette pour la clé déballée.  
Obligatoire : oui

***<SESSION>***  
Crée une clé de session qui n'existe que dans la session en cours. La clé ne peut pas être récupérée une fois la session terminée.  
Obligatoire : non

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur de quorum du service de gestion des clés de la clé de déballage est supérieure à 1.

## Rubriques en relation
<a name="cloudhsm_cli-key-unwrap-rsa-oaep-seealso"></a>
+ [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)
+ [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)

# Désencapsuler une clé avec RSA-PKCS à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs"></a>

Utilisez la **key unwrap rsa-pkcs** commande de la CLI CloudHSM pour déballer une clé de charge utile à l'aide de la clé privée RSA et du mécanisme de déballage. `RSA-PKCS`

Les clés non emballées peuvent être utilisées de la même manière que les clés générées par AWS CloudHSM. Pour indiquer qu'ils n'ont pas été générés localement, leur `local` attribut est défini sur`false`.

Pour utiliser le **unwrap rsa-pkcs** raccourci clavier, vous devez disposer de la clé privée RSA de la clé d'encapsulation publique RSA dans votre AWS CloudHSM cluster, et son `unwrap` attribut doit être défini sur. `true`

## Type utilisateur
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

## Exemples
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-examples"></a>

Ces exemples montrent comment utiliser la **key unwrap rsa-oaep** commande à l'aide d'une clé AES avec la valeur `unwrap` d'attribut définie sur`true`.

**Example Exemple : désencapsuler une clé de charge utile à partir de données clés encapsulées codées en 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 Exemple : désencapsuler une clé de charge utile fournie via un chemin de données**  

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

## Arguments
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé à utiliser pour le déballage.  
Obligatoire : oui

***<DATA\$1PATH>***  
Chemin d'accès au fichier binaire contenant les données clés encapsulées.  
Obligatoire : Oui (sauf si fourni via des données codées en Base64)

***<DATA>***  
Données clés encapsulées codées en Base64.  
Obligatoire : Oui (sauf indication contraire via le chemin de données)

***<ATTRIBUTES>***  
Liste d'attributs clés séparés par des espaces sous la forme de `KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour la clé encapsulée.  
Obligatoire : non

***<KEY\$1TYPE\$1CLASS>***  
Type de clé et classe de clé encapsulée [valeurs possibles :`aes`,`des3`,`ec-private`,`generic-secret`,`rsa-private`].  
Obligatoire : oui

***<LABEL>***  
Étiquette pour la clé déballée.  
Obligatoire : oui

***<SESSION>***  
Crée une clé de session qui n'existe que dans la session en cours. La clé ne peut pas être récupérée une fois la session terminée.  
Obligatoire : non

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur de quorum du service de gestion des clés de la clé de déballage est supérieure à 1.

## Rubriques en relation
<a name="cloudhsm_cli-key-unwrap-rsa-pkcs-seealso"></a>
+ [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)
+ [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)

# La commande key wrap dans la CLI CloudHSM
<a name="cloudhsm_cli-key-wrap"></a>

La **key wrap** commande de la CLI CloudHSM exporte une copie chiffrée d'une clé privée symétrique ou asymétrique depuis le module de sécurité matérielle (HSM) vers un fichier. Lorsque vous exécutez**key wrap**, vous spécifiez deux éléments : la clé à exporter et le fichier de sortie. La clé à exporter est une clé du HSM qui cryptera (encapsulera) la clé que vous souhaitez exporter.

La **key wrap** commande ne supprime pas la clé du HSM et ne vous empêche pas de l'utiliser dans des opérations cryptographiques. Vous pouvez exporter la même clé plusieurs fois. Pour réimporter la clé chiffrée dans le HSM, utilisez[La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md). Seul le propriétaire d'une clé, c'est-à-dire l'utilisateur cryptographique (CU) qui a créé la clé, peut encapsuler la clé. Les utilisateurs avec lesquels la clé est partagée ne peuvent l'utiliser que dans le cadre d'opérations cryptographiques.

La **key wrap** commande comprend les sous-commandes suivantes :
+ [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)

# Enveloppez une clé avec AES-GCM à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-wrap-aes-gcm"></a>

Utilisez la **key wrap aes-gcm** commande de la CLI CloudHSM pour encapsuler une clé de charge utile à l'aide d'une clé AES sur le module de sécurité matériel (HSM) et le mécanisme d'encapsulation. `AES-GCM` L'`extractable`attribut de la clé de charge utile doit être défini sur. `true`

Seul le propriétaire d'une clé, c'est-à-dire l'utilisateur cryptographique (CU) qui a créé la clé, peut encapsuler la clé. Les utilisateurs qui partagent la clé peuvent l'utiliser dans des opérations cryptographiques.

Pour utiliser la **key wrap aes-gcm** commande, vous devez d'abord disposer d'une clé AES dans votre AWS CloudHSM cluster. Vous pouvez générer une clé AES à encapsuler avec la [Génération d'une clé AES symétrique avec la CLI CloudHSM](cloudhsm_cli-key-generate-symmetric-aes.md) commande et l'`wrap`attribut définis sur`true`.

## Type utilisateur
<a name="cloudhsm_cli-key-wrap-aes-gcm-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-wrap-aes-gcm-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

## Exemple
<a name="cloudhsm_cli-key-wrap-aes-gcm-examples"></a>

Cet exemple montre comment utiliser la **key wrap aes-gcm** commande à l'aide d'une touche 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"
  }
}
```

## Arguments
<a name="cloudhsm_cli-key-wrap-aes-gcm-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<PAYLOAD\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé de charge utile.  
Obligatoire : oui

***<PATH>***  
Chemin d'accès au fichier binaire dans lequel les données clés encapsulées seront enregistrées.  
Obligatoire : non

***<WRAPPING\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste d'attributs clés séparés par des espaces sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé d'encapsulation.   
Obligatoire : oui

***<AAD>***  
Valeur des données authentifiées supplémentaires (AAD) AES GCM, en hexadécimal.   
Obligatoire : non

***<TAG\$1LENGTH\$1BITS>***  
Longueur de la balise AES GCM en bits.  
Obligatoire : oui

***<WRAPPING\$1APPROVALR>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération d'encapsulage de la clé. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé d'encapsulation est supérieure à 1.

***<PAYLOAD\$1APPROVALR>***  
Spécifie le chemin du fichier vers un fichier de jeton de quorum signé pour approuver le fonctionnement de la clé de charge utile. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé de charge utile est supérieure à 1.

## Rubriques en relation
<a name="cloudhsm_cli-key-wrap-aes-gcm-seealso"></a>
+ [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)
+ [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)

# Enveloppez une clé à AES-NO-PAD l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-wrap-aes-no-pad"></a>

Utilisez la **key wrap aes-no-pad** commande de la CLI CloudHSM pour encapsuler une clé de charge utile à l'aide d'une clé AES sur le module de sécurité matériel (HSM) et le mécanisme d'encapsulation. `AES-NO-PAD` L'`extractable`attribut de la clé de charge utile doit être défini sur. `true`

Seul le propriétaire d'une clé, c'est-à-dire l'utilisateur cryptographique (CU) qui a créé la clé, peut encapsuler la clé. Les utilisateurs qui partagent la clé peuvent l'utiliser dans des opérations cryptographiques.

Pour utiliser la **key wrap aes-no-pad** commande, vous devez d'abord disposer d'une clé AES dans votre AWS CloudHSM cluster. Vous pouvez générer une clé AES pour l'encapsulage à l'aide de la [Génération d'une clé AES symétrique avec la CLI CloudHSM](cloudhsm_cli-key-generate-symmetric-aes.md) commande et de l'`wrap`attribut définis sur`true`.

## Type utilisateur
<a name="cloudhsm_cli-key-wrap-aes-no-pad-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-wrap-aes-no-pad-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

## Exemple
<a name="cloudhsm_cli-key-wrap-aes-no-pad-examples"></a>

Cet exemple montre comment utiliser la **key wrap aes-no-pad** commande à l'aide d'une clé AES avec la valeur `wrap` d'attribut définie sur`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"
  }
}
```

## Arguments
<a name="cloudhsm_cli-key-wrap-aes-no-pad-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<PAYLOAD\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé de charge utile.  
Obligatoire : oui

***<PATH>***  
Chemin d'accès au fichier binaire dans lequel les données clés encapsulées seront enregistrées.  
Obligatoire : non

***<WRAPPING\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste d'attributs clés séparés par des espaces sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé d'encapsulation.   
Obligatoire : oui

***<WRAPPING\$1APPROVALR>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération d'encapsulage de la clé. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé d'encapsulation est supérieure à 1.

***<PAYLOAD\$1APPROVALR>***  
Spécifie le chemin du fichier vers un fichier de jeton de quorum signé pour approuver le fonctionnement de la clé de charge utile. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé de charge utile est supérieure à 1.

## Rubriques en relation
<a name="cloudhsm_cli-key-wrap-aes-no-pad-seealso"></a>
+ [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)
+ [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)

# Enveloppez une clé avec AES- PKCS5 -PAD à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad"></a>

Utilisez la **key wrap aes-pkcs5-pad** commande de la CLI CloudHSM pour encapsuler une clé de charge utile à l'aide d'une clé AES sur le module de sécurité matériel (HSM) et le mécanisme d'encapsulation. `AES-PKCS5-PAD` L'`extractable`attribut de la clé de charge utile doit être défini sur. `true`

Seul le propriétaire d'une clé, c'est-à-dire l'utilisateur cryptographique (CU) qui a créé la clé, peut encapsuler la clé. Les utilisateurs qui partagent la clé peuvent l'utiliser dans des opérations cryptographiques.

Pour utiliser la **key wrap aes-pkcs5-pad** commande, vous devez d'abord disposer d'une clé AES dans votre AWS CloudHSM cluster. Vous pouvez générer une clé AES pour l'encapsulage à l'aide de la [Génération d'une clé AES symétrique avec la CLI CloudHSM](cloudhsm_cli-key-generate-symmetric-aes.md) commande et de l'`wrap`attribut définis sur`true`.

## Type utilisateur
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

## Exemple
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-examples"></a>

Cet exemple montre comment utiliser la **key wrap aes-pkcs5-pad** commande à l'aide d'une clé AES avec la valeur `wrap` d'attribut définie sur`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="
  }
}
```

## Arguments
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<PAYLOAD\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé de charge utile.  
Obligatoire : oui

***<PATH>***  
Chemin d'accès au fichier binaire dans lequel les données clés encapsulées seront enregistrées.  
Obligatoire : non

***<WRAPPING\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste d'attributs clés séparés par des espaces sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé d'encapsulation.   
Obligatoire : oui

***<WRAPPING\$1APPROVALR>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération d'encapsulage de la clé. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé d'encapsulation est supérieure à 1.

***<PAYLOAD\$1APPROVALR>***  
Spécifie le chemin du fichier vers un fichier de jeton de quorum signé pour approuver le fonctionnement de la clé de charge utile. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé de charge utile est supérieure à 1.

## Rubriques en relation
<a name="cloudhsm_cli-key-wrap-aes-pkcs5-pad-seealso"></a>
+ [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)
+ [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)

# Enveloppez une clé à AES-ZERO-PAD l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-wrap-aes-zero-pad"></a>

Utilisez la **key wrap aes-zero-pad** commande de la CLI CloudHSM pour encapsuler une clé de charge utile à l'aide d'une clé AES sur le module de sécurité matériel (HSM) et le mécanisme d'encapsulation. `AES-ZERO-PAD` L'`extractable`attribut de la clé de charge utile doit être défini sur. `true`

Seul le propriétaire d'une clé, c'est-à-dire l'utilisateur cryptographique (CU) qui a créé la clé, peut encapsuler la clé. Les utilisateurs qui partagent la clé peuvent l'utiliser dans des opérations cryptographiques.

Pour utiliser la **key wrap aes-zero-pad** commande, vous devez d'abord disposer d'une clé AES dans votre AWS CloudHSM cluster. Vous pouvez générer une clé AES pour l'encapsulage à l'aide de la [Génération d'une clé AES symétrique avec la CLI CloudHSM](cloudhsm_cli-key-generate-symmetric-aes.md) commande dont l'`wrap`attribut est défini sur`true`.

## Type utilisateur
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

## Exemple
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-examples"></a>

Cet exemple montre comment utiliser la **key wrap aes-zero-pad ** commande à l'aide d'une clé AES avec la valeur `wrap` d'attribut définie sur`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"
  }
}
```

## Arguments
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<PAYLOAD\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé de charge utile.  
Obligatoire : oui

***<PATH>***  
Chemin d'accès au fichier binaire dans lequel les données clés encapsulées seront enregistrées.  
Obligatoire : non

***<WRAPPING\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé d'encapsulation.   
Obligatoire : oui

***<WRAPPING\$1APPROVALR>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération d'encapsulage de la clé. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé d'encapsulation est supérieure à 1.

***<PAYLOAD\$1APPROVALR>***  
Spécifie le chemin du fichier vers un fichier de jeton de quorum signé pour approuver le fonctionnement de la clé de charge utile. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé de charge utile est supérieure à 1.

## Rubriques en relation
<a name="cloudhsm_cli-key-wrap-aes-zero-pad-seealso"></a>
+ [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)
+ [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)

# Enveloppez une clé à CLOUDHSM-AES-GCM l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm"></a>

Utilisez la **key wrap cloudhsm-aes-gcm** commande de la CLI CloudHSM pour encapsuler une clé de charge utile à l'aide d'une clé AES sur le module de sécurité matériel (HSM) et le mécanisme d'encapsulation. `CLOUDHSM-AES-GCM` L'`extractable`attribut de la clé de charge utile doit être défini sur. `true`

Seul le propriétaire d'une clé, c'est-à-dire l'utilisateur cryptographique (CU) qui a créé la clé, peut encapsuler la clé. Les utilisateurs qui partagent la clé peuvent l'utiliser dans des opérations cryptographiques.

Pour utiliser la **key wrap cloudhsm-aes-gcm** commande, vous devez d'abord disposer d'une clé AES dans votre AWS CloudHSM cluster. Vous pouvez générer une clé AES à encapsuler avec la [Génération d'une clé AES symétrique avec la CLI CloudHSM](cloudhsm_cli-key-generate-symmetric-aes.md) commande et l'`wrap`attribut définis sur`true`.

## Type utilisateur
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

## Exemple
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-examples"></a>

Cet exemple montre comment utiliser la **key wrap cloudhsm-aes-gcm** commande à l'aide d'une touche 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"
  }
}
```

## Arguments
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<PAYLOAD\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé de charge utile.  
Obligatoire : oui

***<PATH>***  
Chemin d'accès au fichier binaire dans lequel les données clés encapsulées seront enregistrées.  
Obligatoire : non

***<WRAPPING\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste d'attributs clés séparés par des espaces sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé d'encapsulation.   
Obligatoire : oui

***<AAD>***  
Valeur des données authentifiées supplémentaires (AAD) AES GCM, en hexadécimal.   
Obligatoire : non

***<TAG\$1LENGTH\$1BITS>***  
Longueur de la balise AES GCM en bits.  
Obligatoire : oui

***<WRAPPING\$1APPROVALR>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération d'encapsulage de la clé. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé d'encapsulation est supérieure à 1.

***<PAYLOAD\$1APPROVALR>***  
Spécifie le chemin du fichier vers un fichier de jeton de quorum signé pour approuver le fonctionnement de la clé de charge utile. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé de charge utile est supérieure à 1.

## Rubriques en relation
<a name="cloudhsm_cli-key-wrap-cloudhsm-aes-gcm-seealso"></a>
+ [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)
+ [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)

# Enveloppez une clé avec RSA-AES à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-wrap-rsa-aes"></a>

Utilisez la **key wrap rsa-aes** commande de la CLI CloudHSM pour encapsuler une clé de charge utile à l'aide d'une clé publique RSA sur le module de sécurité matériel (HSM) et du mécanisme d'encapsulage RSA-AES. L'`extractable`attribut de la clé de charge utile doit être défini sur. `true`

Seul le propriétaire d'une clé, c'est-à-dire l'utilisateur cryptographique (CU) qui a créé la clé, peut encapsuler la clé. Les utilisateurs qui partagent la clé peuvent l'utiliser dans des opérations cryptographiques.

Pour utiliser la **key wrap rsa-aes** commande, vous devez d'abord disposer d'une clé RSA dans votre AWS CloudHSM cluster. Vous pouvez générer une paire de clés RSA à l'aide de la [La generate-asymmetric-pair catégorie dans la CLI CloudHSM](cloudhsm_cli-key-generate-asymmetric-pair.md) commande et de l'`wrap`attribut définis sur. `true`

## Type utilisateur
<a name="cloudhsm_cli-key-wrap-rsa-aes-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-wrap-rsa-aes-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

## Exemple
<a name="cloudhsm_cli-key-wrap-rsa-aes-examples"></a>

Cet exemple montre comment utiliser la **key wrap rsa-ae** commande à l'aide d'une clé publique RSA dont la valeur `wrap` d'attribut est définie sur. `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=="
  }
}
```

## Arguments
<a name="cloudhsm_cli-key-wrap-rsa-aes-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<PAYLOAD\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé de charge utile.  
Obligatoire : oui

***<PATH>***  
Chemin d'accès au fichier binaire dans lequel les données clés encapsulées seront enregistrées.  
Obligatoire : non

***<WRAPPING\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste d'attributs clés séparés par des espaces sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé d'encapsulation.   
Obligatoire : oui

***<MGF>***  
Spécifie la fonction de génération de masques.  
La fonction de hachage de la fonction de génération de masque doit correspondre à la fonction de hachage du mécanisme de signature.
Valeurs valides  
+ mgf1-sha1
+ mgf1-sha225
+ mgf1-sha255
+ mgf1-sha385
+ mgf1-sha512
Obligatoire : oui

***<WRAPPING\$1APPROVALR>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération d'encapsulage de la clé. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé d'encapsulation est supérieure à 1.

***<PAYLOAD\$1APPROVALR>***  
Spécifie le chemin du fichier vers un fichier de jeton de quorum signé pour approuver le fonctionnement de la clé de charge utile. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé de charge utile est supérieure à 1.

## Rubriques en relation
<a name="cloudhsm_cli-key-wrap-rsa-aes-seealso"></a>
+ [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)
+ [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)

# Enveloppez une clé avec RSA-OAEP à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-wrap-rsa-oaep"></a>

Utilisez la **key wrap rsa-oaep** commande de la CLI CloudHSM pour encapsuler une clé de charge utile à l'aide d'une clé publique RSA sur le module de sécurité matériel (HSM) et le mécanisme d'encapsulation. `RSA-OAEP` L'`extractable`attribut de la clé de charge utile doit être défini sur. `true`

Seul le propriétaire d'une clé, c'est-à-dire l'utilisateur cryptographique (CU) qui a créé la clé, peut encapsuler la clé. Les utilisateurs qui partagent la clé peuvent l'utiliser dans des opérations cryptographiques.

Pour utiliser la **key wrap rsa-oaep** commande, vous devez d'abord disposer d'une clé RSA dans votre AWS CloudHSM cluster. Vous pouvez générer une paire de clés RSA à l'aide de la [La generate-asymmetric-pair catégorie dans la CLI CloudHSM](cloudhsm_cli-key-generate-asymmetric-pair.md) commande et de l'`wrap`attribut définis sur. `true`

## Type utilisateur
<a name="cloudhsm_cli-key-unwrap-rsa-aes-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-unwrap-rsa-aes-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

## Exemple
<a name="cloudhsm_cli-key-unwrap-rsa-aes-examples"></a>

Cet exemple montre comment utiliser la **key wrap rsa-oaep** commande à l'aide d'une clé publique RSA dont la valeur `wrap` d'attribut est définie sur. `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=="
  }
}
```

## Arguments
<a name="cloudhsm_cli-key-unwrap-rsa-aes-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<PAYLOAD\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé de charge utile.  
Obligatoire : oui

***<PATH>***  
Chemin d'accès au fichier binaire dans lequel les données clés encapsulées seront enregistrées.  
Obligatoire : non

***<WRAPPING\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste d'attributs clés séparés par des espaces sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé d'encapsulation.   
Obligatoire : oui

***<MGF>***  
Spécifie la fonction de génération de masques.  
La fonction de hachage de la fonction de génération de masque doit correspondre à la fonction de hachage du mécanisme de signature.
Valeurs valides  
+ mgf1-sha1
+ mgf1-sha225
+ mgf1-sha255
+ mgf1-sha385
+ mgf1-sha512
Obligatoire : oui

***<WRAPPING\$1APPROVALR>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération d'encapsulage de la clé. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé d'encapsulation est supérieure à 1.

***<PAYLOAD\$1APPROVALR>***  
Spécifie le chemin du fichier vers un fichier de jeton de quorum signé pour approuver le fonctionnement de la clé de charge utile. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé de charge utile est supérieure à 1.

## Rubriques en relation
<a name="cloudhsm_cli-key-unwrap-rsa-aes-seealso"></a>
+ [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)
+ [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)

# Enveloppez une clé avec RSA-PKCS à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-key-wrap-rsa-pkcs"></a>

Utilisez la **key wrap rsa-pkcs** commande de la CLI CloudHSM pour encapsuler une clé de charge utile à l'aide d'une clé publique RSA sur le module de sécurité matériel (HSM) et le mécanisme d'encapsulation. `RSA-PKCS` L'`extractable`attribut de la clé de charge utile doit être défini sur. `true`

Seul le propriétaire d'une clé, c'est-à-dire l'utilisateur cryptographique (CU) qui a créé la clé, peut encapsuler la clé. Les utilisateurs qui partagent la clé peuvent l'utiliser dans des opérations cryptographiques.

Pour utiliser la **key wrap rsa-pkcs** commande, vous devez d'abord disposer d'une clé RSA dans votre AWS CloudHSM cluster. Vous pouvez générer une paire de clés RSA à l'aide de la [La generate-asymmetric-pair catégorie dans la CLI CloudHSM](cloudhsm_cli-key-generate-asymmetric-pair.md) commande et de l'`wrap`attribut définis sur. `true`

## Type utilisateur
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Utilisateurs de cryptomonnaies (CUs)

## Exigences
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-requirements"></a>
+ Pour exécuter cette commande, vous devez être connecté en tant que CU.

## Syntaxe
<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
```

## Exemple
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-examples"></a>

Cet exemple montre comment utiliser la **key wrap rsa-pkcs** commande à l'aide d'une clé publique 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=="
  }
```

## Arguments
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<PAYLOAD\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste séparée par des espaces d'attributs clés sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé de charge utile.  
Obligatoire : oui

***<PATH>***  
Chemin d'accès au fichier binaire dans lequel les données clés encapsulées seront enregistrées.  
Obligatoire : non

***<WRAPPING\$1FILTER>***  
Référence clé (par exemple,`key-reference=0xabc`) ou liste d'attributs clés séparés par des espaces sous la forme de `attr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE` pour sélectionner une clé d'encapsulation.   
Obligatoire : oui

***<WRAPPING\$1APPROVALR>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération d'encapsulage de la clé. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé d'encapsulation est supérieure à 1.

***<PAYLOAD\$1APPROVALR>***  
Spécifie le chemin du fichier vers un fichier de jeton de quorum signé pour approuver le fonctionnement de la clé de charge utile. Obligatoire uniquement si la valeur du quorum du service de gestion des clés de la clé de charge utile est supérieure à 1.

## Rubriques en relation
<a name="cloudhsm_cli-key-wrap-rsa-pkcs-seealso"></a>
+ [La commande key wrap dans la CLI CloudHSM](cloudhsm_cli-key-wrap.md)
+ [La commande key unwrap dans la CLI CloudHSM](cloudhsm_cli-key-unwrap.md)

# Connectez-vous à un HSM à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-login"></a>

Vous pouvez utiliser la **login** commande dans la CLI CloudHSM pour vous connecter et vous déconnecter de chaque sécurité matérielle (HSM) d'un cluster. AWS CloudHSM Cette commande comporte la sous-commande suivante :
+ [mfa-token-sign](cloudhsm_cli-login-mfa-token-sign.md)

**Note**  
Si vous dépassez cinq tentatives de connexion incorrectes, votre compte est verrouillé. Pour déverrouiller le compte, un administrateur doit réinitialiser votre mot de passe à l'aide de la commande [user change-password](cloudhsm_cli-user-change-password.md) dans cloudhsm\$1cli.

## Pour résoudre les problèmes de connexion et de déconnexion
<a name="troubleshoot-login-logout"></a>

Si vous avez plusieurs HSM dans votre cluster, vous pouvez autoriser des tentatives de connexion incorrectes supplémentaires avant que votre compte soit verrouillé. Cela est dû au fait que le client CloudHSM équilibre la charge entre différents facteurs. HSMs Par conséquent, la tentative de connexion peut ne pas commencer sur le même HSM à chaque fois. Si vous testez cette fonctionnalité, nous vous recommandons de le faire sur un cluster avec un seul HSM actif. 

Si vous avez créé votre cluster avant février 2018, votre compte est verrouillé après 20 tentatives de connexion incorrectes. 

## Type utilisateur
<a name="chsm-cli-login-logout-userType"></a>

Les utilisateurs suivants peuvent exécuter cette commande.
+ Administrateur non activé
+ Admin
+ Utilisateur de chiffrement (CU)

## Syntaxe
<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')
```

## Exemple
<a name="chsm-cli-login-example"></a>

**Example**  
Cette commande vous connecte à tous les membres HSMs d'un cluster avec les informations d'identification d'un utilisateur administrateur nommé`admin1`.  

```
aws-cloudhsm > login --username admin1 --role admin
Enter password:
{
  "error_code": 0,
  "data": {
    "username": "admin1",
    "role": "admin"
  }
}
```

## Arguments
<a name="login-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<USERNAME>***  
Spécifie un nom convivial pour l'utilisateur. La longueur maximale est de 31 caractères. Le seul caractère spécial autorisé est un trait de soulignement ( \$1 ). Le nom d'utilisateur n’est pas sensible à la casse dans cette commande, il est toujours affiché en minuscules.  
Obligatoire : oui

***<ROLE>***  
Spécifie le rôle attribué à cet utilisateur. Les valeurs valides sont **admin**, **crypto-user**.  
Pour obtenir le rôle de l'utilisateur, utilisez la **user list** commande. Pour plus d'informations sur les types d'utilisateur sur un HSM, consultez [Comprendre les utilisateurs HSM](manage-hsm-users.md).  
Obligatoire : oui

***<PASSWORD>***  
Spécifie le mot de passe de l'utilisateur qui se connecte au HSMs.  
Obligatoire : les clients doivent fournir le mot de passe soit via l'argument de ligne de `--password` commande, soit l'omettre pour être invités de manière interactive.  
L'utilisation de l'`--password`argument sur la ligne de commande peut exposer les informations d'identification dans l'historique de votre shell. Envisagez de demander le mot de passe de manière interactive ou d'effacer l'historique de votre shell après utilisation.

## Rubriques en relation
<a name="login-seeAlso"></a>
+ [Mise en route avec la CLI CloudHSM](cloudhsm_cli-getting-started.md)
+ [Activation du cluster](activate-cluster.md)

# Connectez-vous à un HSM à l'aide de la MFA à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-login-mfa-token-sign"></a>

Utilisez la **login mfa-token-sign** commande de la CLI AWS CloudHSM CloudHSM pour vous connecter à un module de sécurité matérielle (HSM) à l'aide de l'authentification multifactorielle (MFA). Pour utiliser cette commande, vous devez d'abord configurer la [MFA pour la CLI CloudHSM](login-mfa-token-sign.md).

## Type utilisateur
<a name="cloudhsm_cli-login-mfa-token-userType"></a>

Les utilisateurs suivants peuvent exécuter cette commande.
+ Admin
+ Utilisateur de chiffrement (CU)

## Syntaxe
<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
```

## Exemple
<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"
  }
}
```

## Arguments
<a name="cloudhsm_cli-login-mfa-token-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<TOKEN>***  
Chemin de fichier dans lequel le fichier de jeton non signé sera écrit.  
Obligatoire : oui

## Rubriques en relation
<a name="cloudhsm_cli-login-mfa-token-seeAlso"></a>
+ [Mise en route avec la CLI CloudHSM](cloudhsm_cli-getting-started.md)
+ [Activation du cluster](activate-cluster.md)
+ [Utilisation de la CLI CloudHSM pour gérer la MFA](login-mfa-token-sign.md)

# Déconnectez-vous d'un HSM à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-logout"></a>

Utilisez la **logout** commande de la CLI CloudHSM pour vous déconnecter de chaque module de sécurité matériel (HSM) d'un cluster. AWS CloudHSM 

## Type utilisateur
<a name="chsm-cli-logout-userType"></a>

Les utilisateurs suivants peuvent exécuter cette commande.
+ Admin
+ Utilisateur de chiffrement (CU)

## Syntaxe
<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
```

## Exemple
<a name="chsm-cli-logout-example"></a>

**Example**  
Cette commande vous déconnecte de tous les HSMs éléments d'un cluster.  

```
aws-cloudhsm > logout
{
  "error_code": 0,
  "data": "Logout successful"
}
```

## Rubriques en relation
<a name="logout-seeAlso"></a>
+ [Mise en route avec la CLI CloudHSM](cloudhsm_cli-getting-started.md)
+ [Activation du cluster](activate-cluster.md)

# Catégorie d'utilisateur dans la CLI CloudHSM
<a name="cloudhsm_cli-user"></a>

Dans la **user** CLI CloudHSM, il s'agit d'une catégorie parent pour un groupe de commandes qui, lorsqu'elles sont combinées avec la catégorie parent, créent une commande spécifique aux utilisateurs. Actuellement, la catégorie utilisateur comprend les commandes suivantes :
+ [user change-mfa](cloudhsm_cli-user-change-mfa.md)
+ [user change-password](cloudhsm_cli-user-change-password.md)
+ [user create](cloudhsm_cli-user-create.md)
+ [user delete](cloudhsm_cli-user-delete.md)
+ [user list](cloudhsm_cli-user-list.md)
+ [répliquer par l'utilisateur](cloudhsm_cli-user-replicate.md)

# La catégorie user change-mfa dans la CLI CloudHSM
<a name="cloudhsm_cli-user-change-mfa"></a>

Dans la **user change-mfa** CLI CloudHSM, il s'agit d'une catégorie parent pour un groupe de commandes qui, lorsqu'elles sont combinées avec la catégorie parent, créent une commande spécifique à la modification de l'authentification multifactorielle (MFA) pour les utilisateurs.

Actuellement, cette catégorie comprend la sous-commande suivante :
+ [token-sign](cloudhsm_cli-user-change-mfa-token-sign.md)

# Modifier la configuration MFA d'un utilisateur avec la CLI CloudHSM
<a name="cloudhsm_cli-user-change-mfa-token-sign"></a>

Utilisez la **user change-mfa token-sign** commande de la CLI CloudHSM pour mettre à jour la configuration de l'authentification multifactorielle (MFA) d'un compte utilisateur. N'importe quel compte utilisateur peut exécuter cette commande. Les comptes dotés du rôle d'administrateur peuvent exécuter cette commande pour d'autres utilisateurs.

## Type utilisateur
<a name="user-change-mfa-type"></a>

Les utilisateurs suivants peuvent exécuter cette commande.
+ Admin
+ Utilisateur de chiffrement 

## Syntaxe
<a name="user-change-mfa-syntax"></a>

Actuellement, il n'existe qu'une seule stratégie multifactorielle disponible pour les utilisateurs : 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)
```

La stratégie Token Sign demande un fichier de jetons dans lequel écrire des jetons non signés.

```
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')
```

## Exemple
<a name="user-change-mfa-examples"></a>

Cette commande écrira un jeton non signé par HSM de votre cluster dans le fichier spécifié par `token`. Lorsque vous y êtes invité, signez les jetons du fichier.

**Example : écrivez un jeton non signé par HSM dans votre 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"
  }
}
```

### Arguments
<a name="user-change-mfa-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<ROLE>***  
Spécifie le rôle attribué au compte utilisateur. Ce paramètre est obligatoire. Pour plus d'informations sur les types d'utilisateur sur un HSM, consultez [Comprendre les utilisateurs HSM](manage-hsm-users.md).  
**Valeurs valides**  
+ **Administrateur** : les administrateurs peuvent gérer les utilisateurs, mais ils ne peuvent pas gérer les clés.
+ **CU** : les utilisateurs de chiffrement peuvent créer et gérer des clés, et utiliser ces clés dans des opérations de chiffrement.

***<USERNAME>***  
Spécifie un nom convivial pour l'utilisateur. La longueur maximale est de 31 caractères. Le seul caractère spécial autorisé est un trait de soulignement ( \$1 ).  
Vous ne pouvez pas modifier le nom d'un utilisateur après l'avoir créé. Dans les commandes de la CLI CloudHSM, le rôle et le mot de passe sont sensibles à la casse, mais le nom d'utilisateur ne l'est pas.  
**Obligatoire** : oui

***<CHANGE\$1PASSWORD>***  
Spécifie le nouveau mot de passe en texte brut de l'utilisateur dont la MFA est enregistrée/désenregistrée.  
**Obligatoire** : oui

***<TOKEN>***  
Chemin de fichier dans lequel le fichier de jeton non signé sera écrit.  
**Obligatoire** : oui

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur du quorum du service utilisateur du quorum est supérieure à 1.

***<DEREGISTER>***  
Désenregistre la clé publique MFA, si elle est présente.

***<CHANGE-QUORUM>***  
Modifie la clé publique du quorum ainsi que la clé MFA.

## Rubriques en relation
<a name="user-change-mfa-seealso"></a>
+ [Comprendre l'authentification à deux facteurs pour les utilisateurs HSM](login-mfa-token-sign.md)

# Modifier le mot de passe d'un utilisateur avec la CLI CloudHSM
<a name="cloudhsm_cli-user-change-password"></a>

Utilisez la **user change-password** commande de la CLI CloudHSM pour modifier le mot de passe d'un utilisateur AWS CloudHSM existant dans votre cluster. Pour activer la MFA pour un utilisateur, utilisez la commande `user change-mfa`.

Tout utilisateur peut modifier son propre mot de passe. En outre, les utilisateurs dotés du rôle d'administrateur peuvent modifier le mot de passe d'un autre utilisateur du cluster. Vous n'avez pas besoin d'entrer le mot de passe actuel pour effectuer la modification.

**Note**  
Vous ne pouvez pas modifier le mot de passe d'un utilisateur qui est actuellement connecté au cluster.

## Type utilisateur
<a name="change-password-user-type"></a>

Les utilisateurs suivants peuvent exécuter cette commande.
+ Admin
+ Utilisateur de chiffrement (CU)

## Syntaxe
<a name="change-password-syntax"></a>

**Note**  
 Pour activer l'authentification multifactorielle (MFA) pour un utilisateur, utilisez **user change-mfa** la commande.

```
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')
```

## Exemple
<a name="change-password-examples"></a>

Les exemples suivants montrent comment utiliser **user change-password** pour réinitialiser le mot de passe de l'utilisateur actuel ou de tout autre utilisateur dans votre cluster.

**Example : Modifier votre mot de passe**  
Tout utilisateur du cluster peut utiliser **user change-password** pour modifier son propre mot de passe.  
La sortie suivante montre que Bob est actuellement connecté en tant qu'utilisateur de chiffrement (CU).  

```
aws-cloudhsm > user change-password --username bob --role crypto-user
Enter password:
Confirm password:
{
  "error_code": 0,
  "data": {
    "username": "bob",
    "role": "crypto-user"
  }
}
```

## Arguments
<a name="change-password-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur du quorum du service utilisateur du quorum est supérieure à 1.

***<DEREGISTER-MFA>***  
Désenregistre la clé publique MFA, si elle est présente.

***<DEREGISTER-QUORUM>***  
Désenregistrez la clé publique Quorum, si elle est présente.

***<PASSWORD>***  
Spécifie le nouveau mot de passe de l'utilisateur en texte brut. Les caractères suivants ne sont pas autorisés « : »  
**Obligatoire** : oui

***<ROLE>***  
Spécifie le rôle attribué au compte utilisateur. Ce paramètre est obligatoire. Pour plus d'informations sur les types d'utilisateur sur un HSM, consultez [Comprendre les utilisateurs HSM](manage-hsm-users.md).  
**Valeurs valides**  
+ **Administrateur** : les administrateurs peuvent gérer les utilisateurs, mais ils ne peuvent pas gérer les clés.
+ **CU** : les utilisateurs de chiffrement peuvent créer et gérer des clés, et utiliser ces clés dans des opérations de chiffrement.

***<USERNAME>***  
Spécifie un nom convivial pour l'utilisateur. La longueur maximale est de 31 caractères. Le seul caractère spécial autorisé est un trait de soulignement ( \$1 ).  
Vous ne pouvez pas modifier le nom d'un utilisateur après l'avoir créé. Dans les commandes de la CLI CloudHSM, le rôle et le mot de passe sont sensibles à la casse, mais le nom d'utilisateur ne l'est pas.  
**Obligatoire** : oui

## Rubriques en relation
<a name="change-password-seealso"></a>
+ [Répertorier les utilisateurs](cloudhsm_cli-user-list.md)
+ [Créer un utilisateur](cloudhsm_cli-user-create.md)
+ [Supprimer un utilisateur](cloudhsm_cli-user-delete.md)

# La catégorie user change-quorum dans la CLI CloudHSM
<a name="cloudhsm_cli-user-chqm"></a>

Dans la **user change-quorum** CLI CloudHSM, il s'agit d'une catégorie parent pour un groupe de commandes qui, lorsqu'elles sont combinées avec la catégorie parent, créent une commande spécifique à la modification du quorum des utilisateurs.

**user change-quorum** est utilisé pour enregistrer l'authentification du quorum des utilisateurs à l'aide d'une stratégie de quorum spécifiée. À partir du SDK 5.8.0, une seule stratégie de quorum est disponible pour les utilisateurs, comme indiqué ci-dessous.

Actuellement, cette catégorie comprend la catégorie et la sous-commande suivantes :
+ [token-sign](cloudhsm_cli-user-chqm-token.md)
  + [register](cloudhsm_cli-user-chqm-token-reg.md)

# La catégorie user change-quorum token-sign dans la CLI CloudHSM
<a name="cloudhsm_cli-user-chqm-token"></a>

Dans la **user change-quorum token-sign** CLI CloudHSM, il existe une catégorie parent pour les commandes qui, combinées à cette catégorie parent, créent une commande spécifique aux opérations de quorum par signature de jetons.

Actuellement, cette catégorie comprend les commandes suivantes :
+ [register](cloudhsm_cli-user-chqm-token-reg.md)

# Enregistrez la stratégie de quorum par signature jeton d'un utilisateur à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-user-chqm-token-reg"></a>

Utilisez la commande **user change-quorum token-sign register** de la CLI CloudHSM pour enregistrer la stratégie de quorum token-sign pour un utilisateur administrateur.

## Type utilisateur
<a name="token-register-user-type"></a>

Les utilisateurs suivants peuvent exécuter cette commande.
+ Admin

## Syntaxe
<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')
```

## Exemple
<a name="token-register-examples"></a>

**Example**  
Pour exécuter cette commande, vous devez être connecté sous le nom d'utilisateur pour lequel vous souhaitez **register quorum token-sign**.  

```
aws-cloudhsm > login --username admin1 --role admin
Enter password:
{
  "error_code": 0,
  "data": {
    "username": "admin1",
    "role": "admin"
  }
}
```
La commande **user change-quorum token-sign register** enregistrera votre clé publique auprès du HSM. Par conséquent, vous serez qualifié d'approbateur de quorum pour les opérations nécessitant un quorum qui requièrent qu'un utilisateur obtienne des signatures de quorum pour atteindre le seuil de quorum requis.  

```
aws-cloudhsm > user change-quorum token-sign register \
    --public-key /home/mypemfile \
    --signed-token /home/mysignedtoken
{
  "error_code": 0,
  "data": {
    "username": "admin1",
    "role": "admin"
  }
}
```
Vous pouvez maintenant exécuter la commande **user list** et confirmer que quorum token-sign a été enregistré pour cet utilisateur.  

```
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"
      }
    ]
  }
}
```

## Arguments
<a name="token-register-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<PUBLIC-KEY>***  
Chemin d'accès au fichier PEM à clé publique.  
**Obligatoire** : oui

***<SIGNED-TOKEN>***  
Chemin de fichier avec jeton signé par clé privée de l'utilisateur.  
**Obligatoire** : oui

## Rubriques en relation
<a name="token-register-seealso"></a>
+ [Utilisation de la CLI CloudHSM pour gérer l'authentification par quorum](quorum-auth-chsm-cli.md)
+ [Utilisation de l'authentification par quorum pour les administrateurs : première configuration](quorum-auth-chsm-cli-first-time.md)
+ [Modifier la valeur minimale du quorum pour les administrateurs](quorum-auth-chsm-cli-min-value.md)
+ [Noms et types de services prenant en charge l'authentification par quorum](quorum-auth-chsm-cli-service-names.md)

# Création d'un AWS CloudHSM utilisateur à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-user-create"></a>

La **user create** commande de la CLI CloudHSM crée un utilisateur AWS CloudHSM dans votre cluster. Seuls les comptes utilisateurs dotés du rôle d'administrateur peuvent exécuter cette commande.

## Type utilisateur
<a name="user-create-userType"></a>

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

## Exigences
<a name="user-create-requirements"></a>

Pour exécuter cette commande, vous devez être connecté en tant qu'utilisateur administrateur

## Syntaxe
<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')
```

## Exemple
<a name="user-create-examples"></a>

Ces exemples montrent comment **user create** créer de nouveaux utilisateurs dans votre HSMs.

**Example : Créer un utilisateur de chiffrement**  
Cet exemple crée un compte dans votre AWS CloudHSM cluster avec le rôle d'utilisateur cryptographique.  

```
aws-cloudhsm > user create --username alice --role crypto-user
Enter password:
Confirm password:
{
  "error_code": 0,
  "data": {
    "username": "alice",
    "role": "crypto-user"
  }
}
```

## Arguments
<a name="user-create-arguments"></a>

*<CLUSTER\$1ID>*  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

*<USERNAME>*  
Spécifie un nom convivial pour l'utilisateur. La longueur maximale est de 31 caractères. Le seul caractère spécial autorisé est un trait de soulignement ( \$1 ). Le nom d'utilisateur n’est pas sensible à la casse dans cette commande, il est toujours affiché en minuscules.  
Obligatoire : oui

*<ROLE>*  
Spécifie le rôle attribué à cet utilisateur. Ce paramètre est obligatoire. Les valeurs valides sont **admin**, **crypto-user**.  
Pour obtenir le rôle de l'utilisateur, utilisez la commande **user list**. Pour plus d'informations sur les types d'utilisateur sur un HSM, consultez [Comprendre les utilisateurs HSM](manage-hsm-users.md).

*<PASSWORD>*  
Spécifie le mot de passe de l'utilisateur qui se connecte au HSMs. Les caractères suivants ne sont pas autorisés « : »  
Obligatoire : oui

*<APPROVAL>*  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur du quorum du service utilisateur du quorum est supérieure à 1.

## Rubriques en relation
<a name="user-create-seealso"></a>
+ [user list](cloudhsm_cli-user-list.md)
+ [user delete](cloudhsm_cli-user-delete.md)
+ [Modifier un mot de passe utilisateur](cloudhsm_cli-user-change-password.md)

# Supprimer un AWS CloudHSM utilisateur à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-user-delete"></a>

La **user delete** commande de la CLI CloudHSM supprime un utilisateur de votre cluster. AWS CloudHSM Seuls les comptes utilisateurs dotés du rôle d'administrateur peuvent exécuter cette commande. Vous ne pouvez pas supprimer un utilisateur actuellement connecté à un HSM. 

## Type utilisateur
<a name="user-delete-userType"></a>

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

## Exigences
<a name="user-delete-requirements"></a>
+ Vous ne pouvez pas supprimer les comptes utilisateurs qui possèdent des clés.
+ Votre compte utilisateur doit avoir le rôle d'administrateur pour exécuter cette commande.

## Syntaxe
<a name="user-delete-syntax"></a>

Comme cette commande n'a pas de paramètres nommés, vous devez entrer les arguments dans l'ordre spécifié dans le diagramme de syntaxe.

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

## Exemple
<a name="user-delete-examples"></a>

```
aws-cloudhsm > user delete --username alice --role crypto-user
{
  "error_code": 0,
  "data": {
    "username": "alice",
    "role": "crypto-user"
  }
}
```

## Arguments
<a name="user-delete-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<USERNAME>***  
Spécifie un nom convivial pour l'utilisateur. La longueur maximale est de 31 caractères. Le seul caractère spécial autorisé est un trait de soulignement ( \$1 ). Le nom d'utilisateur n’est pas sensible à la casse dans cette commande, il est toujours affiché en minuscules.  
Obligatoire : oui

***<ROLE>***  
Spécifie le rôle attribué à cet utilisateur. Ce paramètre est obligatoire. Les valeurs valides sont **admin**, **crypto-user**.  
Pour obtenir le rôle de l'utilisateur, utilisez la commande **user list**. Pour plus d'informations sur les types d'utilisateur sur un HSM, consultez [Comprendre les utilisateurs HSM](manage-hsm-users.md).  
Obligatoire : oui

***<APPROVAL>***  
Spécifie le chemin d'accès à un fichier de jeton de quorum signé pour approuver l'opération. Obligatoire uniquement si la valeur du quorum du service utilisateur du quorum est supérieure à 1.  
Obligatoire : oui

## Rubriques en relation
<a name="user-delete-seealso"></a>
+ [Répertorier les utilisateurs](cloudhsm_cli-user-list.md)
+ [Créer un utilisateur](cloudhsm_cli-user-create.md)
+ [Modifier un mot de passe utilisateur](cloudhsm_cli-user-change-password.md)

# Répertorier tous les AWS CloudHSM utilisateurs utilisant la CLI CloudHSM
<a name="cloudhsm_cli-user-list"></a>

La **user list** commande de la CLI CloudHSM répertorie les comptes utilisateur présents AWS CloudHSM dans votre cluster. Vous n'avez pas besoin d'être connecté à la CLI CloudHSM pour exécuter cette commande.

**Note**  
Si vous ajoutez ou supprimez HSMs, mettez à jour les fichiers de configuration utilisés par le AWS CloudHSM client et les outils de ligne de commande. Dans le cas contraire, les modifications que vous apportez risquent de ne pas s'appliquer HSMs à tous les membres du cluster.

## Type utilisateur
<a name="user-list-userType"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Tous les utilisateurs. Vous n'avez pas besoin d'être connecté pour exécuter cette commande.

## Syntaxe
<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
```

## Exemple
<a name="chsm-cli-user-list-examples"></a>

Cette commande répertorie les utilisateurs présents dans votre cluster 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"
      }
    ]
  }
}
```

La sortie inclut les attributs utilisateur suivants :
+ **Username** : affiche le nom convivial défini pour l'utilisateur. Le nom d'utilisateur est toujours affiché en minuscules. 
+ **Role** : détermine les opérations que l'utilisateur peut effectuer sur le HSM.
+ **Locked** : indique si ce compte utilisateur a été verrouillé.
+ **MFA** : indique les mécanismes d'authentification multifactorielle pris en charge pour ce compte utilisateur.
+ **Cluster coverage** : indique la disponibilité de ce compte utilisateur à l'échelle du cluster.

## Rubriques en relation
<a name="chsm-user-list-seealso"></a>
+ [listUsers](key_mgmt_util-listUsers.md) dans key\$1mgmt\$1util
+ [Créer un utilisateur](cloudhsm_cli-user-create.md)
+ [Supprimer un utilisateur](cloudhsm_cli-user-delete.md)
+ [Modifier un mot de passe utilisateur](cloudhsm_cli-user-change-password.md)

# Répliquer un utilisateur à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-user-replicate"></a>

Utilisez la **user replicate** commande de la CLI CloudHSM pour répliquer un utilisateur d'un cluster source vers AWS CloudHSM un cluster de destination. AWS CloudHSM 

## Type utilisateur
<a name="chsm-cli-user-replicate-user-type"></a>

Les types d'utilisateur suivants peuvent exécuter cette commande.
+ Administrateurs () COs

## Exigences
<a name="cloudhsm_cli-user-replicate-requirements"></a>
+ Les clusters source et de destination doivent être des clones. Cela signifie que l'un a été créé à partir d'une sauvegarde de l'autre, ou qu'ils ont tous deux été créés à partir d'une sauvegarde commune. Pour plus d’informations, consultez [Création de clusters à partir de sauvegardes](create-cluster-from-backup.md).
+ Pour exécuter cette commande, vous devez être connecté en tant qu'administrateur sur les clusters source et de destination.
  +  En mode commande unique, la commande utilisera les variables d'environnement CLOUDHSM\$1PIN et CLOUDHSM\$1ROLE pour s'authentifier sur le cluster source. Pour plus d’informations, consultez [Mode commande unique](cloudhsm_cli-modes.md#cloudhsm_cli-mode-single-command). Pour fournir des informations d'identification pour le cluster de destination, vous devez définir deux variables environnementales supplémentaires : DESTINATION\$1CLOUDHSM\$1PIN et DESTINATION\$1CLOUDHSM\$1ROLE :

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

    ```
    $ export DESTINATION_CLOUDHSM_PIN=<username:password>
    ```
  +  En mode interactif, les utilisateurs devront se connecter explicitement aux clusters source et de destination.

## Syntaxe
<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')
```

## Exemples
<a name="chsm-cli-user-replicate-examples"></a>

**Example Exemple : répliquer un utilisateur**  
Cette commande réplique un utilisateur d'un cluster source vers un cluster de destination cloné. L'exemple ci-dessous illustre le résultat lorsque vous êtes connecté en tant qu'administrateur sur les deux 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"
  }
}
```

## Arguments
<a name="user-replicate-arguments"></a>

***<USERNAME>***  
Spécifie le nom d'utilisateur de l'utilisateur à répliquer dans le cluster source.  
Obligatoire : oui

***<ROLE>***  
Spécifie le rôle attribué à cet utilisateur. Ce paramètre est obligatoire. Les valeurs valides sont **admin**, **crypto-user**.  
Pour obtenir le rôle de l'utilisateur, utilisez la commande **user list**. Pour plus d'informations sur les types d'utilisateur sur un HSM, consultez [Comprendre les utilisateurs HSM](manage-hsm-users.md).  
Obligatoire : oui

***<SOURCE\$1CLUSTER\$1ID>***  
ID du cluster source.  
Obligatoire : oui

***<DESTINATION\$1CLUSTER\$1ID>***  
L'ID du cluster de destination.  
Obligatoire : oui

## Rubriques en relation
<a name="chsm-user-replicate-seealso"></a>
+ [Connexion à plusieurs clusters à l'aide de la CLI CloudHSM](cloudhsm_cli-configs-multi-cluster.md)

# La catégorie de quorum dans la CLI CloudHSM
<a name="cloudhsm_cli-qm"></a>

Dans la **quorum** CLI CloudHSM, il s'agit d'une catégorie parent pour un groupe de commandes qui, lorsqu'il est **quorum** combiné avec, crée une commande spécifique à l'authentification par quorum, ou aux opérations M sur N. Actuellement, cette catégorie comprend la sous-catégorie **token-sign** qui comprend ses propres commandes. Cliquez sur le lien ci-dessous pour plus d'informations.
+ [token-sign](cloudhsm_cli-qm-token.md)

**Services d'administrateur** : l'authentification par quorum est utilisée pour les services dotés de privilèges d'administrateur tels que la création d'utilisateurs, la suppression d'utilisateurs, la modification des mots de passe des utilisateurs, la définition des valeurs de quorum et la désactivation des fonctionnalités de quorum et de MFA.

**Services aux utilisateurs cryptographiques** : l'authentification par quorum est utilisée pour les services privilégiés des utilisateurs cryptographiques associés à une clé spécifique, tels que la signature avec une clé, sharing/unsharing une clé, wrapping/unwrapping une clé et la définition de l'attribut d'une clé. La valeur de quorum d'une clé associée est configurée lorsque la clé est générée, importée ou déballée. La valeur du quorum doit être égale ou inférieure au nombre d'utilisateurs auxquels la clé est associée, y compris les utilisateurs avec lesquels la clé est partagée et le propriétaire de la clé.

Chaque type de service est ensuite décomposé en un nom de service éligible, qui contient un ensemble spécifique d'opérations de service prises en charge par le quorum qui peuvent être effectuées.


****  

| Nom du service | Type de service | Opérations de service | 
| --- | --- | --- | 
| user | Admin |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 
| quorum | Admin |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 
| grappe 1 | Admin |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 
| gestion des clés | Utilisateur de Crypto |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 
| utilisation des clés | Utilisateur de Crypto |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/cloudhsm/latest/userguide/cloudhsm_cli-qm.html)  | 

[1] Le service Cluster est exclusivement disponible sur hsm2m.medium

## Rubriques en relation
<a name="cloudhsm_cli-qm-seealso"></a>
+ [Configurer l'authentification par quorum pour les AWS CloudHSM administrateurs à l'aide de la CLI CloudHSM](quorum-auth-chsm-cli-first-time.md)
+ [Gestion de l'authentification par quorum (contrôle d'accès M of N) à l'aide de la CLI CloudHSM](quorum-auth-chsm-cli.md)

# La catégorie quorum token-sign dans la CLI CloudHSM
<a name="cloudhsm_cli-qm-token"></a>

Dans la **quorum token-sign** CLI CloudHSM, il existe une catégorie pour un groupe de commandes qui, lorsqu'elles sont **quorum token-sign** combinées avec, créent une commande spécifique à l'authentification par quorum, ou aux opérations M sur N.

Actuellement, cette catégorie comprend les commandes suivantes :
+ [supprimer](cloudhsm_cli-qm-token-del.md)
+ [generate](cloudhsm_cli-qm-token-gen.md)
+ [liste](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)

# Supprimer les jetons de quorum à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-qm-token-del"></a>

Utilisez la commande **quorum token-sign delete** de la CLI CloudHSM pour supprimer un ou plusieurs jetons pour un service autorisé par quorum.

## Type utilisateur
<a name="quorum-token-delete-user-type"></a>

Les utilisateurs suivants peuvent exécuter cette commande.
+ Admin

## Syntaxe
<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')
```

## Exemple
<a name="quorum-token-delete-examples"></a>

L'exemple suivant montre comment la commande **quorum token-sign delete** de la CLI CloudHSM peut être utilisée pour supprimer un ou plusieurs jetons pour un service autorisé par quorum.

**Example : Supprimer un ou plusieurs jetons pour un service autorisé par quorum**  

```
aws-cloudhsm > quorum token-sign delete --scope all
{
  "error_code": 0,
  "data": "Deletion of quorum token(s) successful"
}
```

## Arguments
<a name="quorum-token-delete-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<SCOPE>***  
Étendue dans laquelle les jetons seront supprimés dans le AWS CloudHSM cluster.  
**Valeurs valides**  
+ **Utilisateur** : Utilisé pour supprimer uniquement les jetons appartenant à l'utilisateur connecté.
+ **Tout** : Utilisé pour supprimer tous les jetons du AWS CloudHSM cluster.

## Rubriques en relation
<a name="quorum-token-delete-seealso"></a>
+ [Répertorier les utilisateurs](cloudhsm_cli-user-list.md)
+ [Créer un utilisateur](cloudhsm_cli-user-create.md)
+ [Supprimer un utilisateur](cloudhsm_cli-user-delete.md)

# Génération d'un jeton de quorum à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-qm-token-gen"></a>

Utilisez la commande **quorum token-sign generate** de la CLI CloudHSM pour générer un jeton pour un service autorisé par quorum.

L'obtention d'un jeton actif par utilisateur et par service sur un cluster HSM est limitée pour l'utilisateur des services et le quorum. Cette limite ne s'applique pas aux jetons liés à des services clés.

**Note**  
Seuls les administrateurs et les utilisateurs de cryptomonnaies peuvent générer des jetons de service spécifiques. Pour plus d'informations sur les types et les noms de services, voir [Noms de services et types prenant en charge l'authentification par quorum](quorum-auth-chsm-cli-service-names.md)

**Services d'administrateur** : l'authentification par quorum est utilisée pour les services dotés de privilèges d'administrateur tels que la création d'utilisateurs, la suppression d'utilisateurs, la modification des mots de passe des utilisateurs, la définition des valeurs de quorum et la désactivation des fonctionnalités de quorum et de MFA.

**Services aux utilisateurs cryptographiques** : l'authentification par quorum est utilisée pour les services privilégiés des utilisateurs cryptographiques associés à une clé spécifique, tels que la signature avec une clé, sharing/unsharing une clé, wrapping/unwrapping une clé et la définition de l'attribut d'une clé. La valeur de quorum d'une clé associée est configurée lorsque la clé est générée, importée ou déballée. La valeur du quorum doit être égale ou inférieure au nombre d'utilisateurs auxquels la clé est associée, y compris les utilisateurs avec lesquels la clé est partagée et le propriétaire de la clé.

Chaque type de service est ensuite décomposé en un nom de service éligible, qui contient un ensemble spécifique d'opérations de service prises en charge par le quorum qui peuvent être effectuées.


****  

| Nom du service | Type de service | Opérations de service | 
| --- | --- | --- | 
| user | Admin |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 
| quorum | Admin |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 
| grappe 1 | Admin |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 
| gestion des clés | Utilisateur de Crypto |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 
| utilisation des clés | Utilisateur de Crypto |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/cloudhsm/latest/userguide/cloudhsm_cli-qm-token-gen.html)  | 

[1] Le service Cluster est exclusivement disponible sur hsm2m.medium

## Type utilisateur
<a name="quorum-token-generate-user-type"></a>

Les utilisateurs suivants peuvent exécuter cette commande.
+ Admin
+ Utilisateur de chiffrement (CU)

## Syntaxe
<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
```

## Exemple
<a name="quorum-token-generate-examples"></a>

Cette commande écrira un jeton non signé par HSM de votre cluster dans le fichier spécifié par `token`.

**Example : écrivez un jeton non signé par HSM dans votre cluster**  

```
aws-cloudhsm > quorum token-sign generate --service user --token /home/tfile
{
  "error_code": 0,
  "data": {
    "filepath": "/home/tfile"
  }
}
```

## Arguments
<a name="quorum-token-generate-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<SERVICE>***  
Spécifie le service autorisé par le quorum pour lequel générer un jeton. Ce paramètre est obligatoire.  
**Valeurs valides**  
+ **utilisateur** : service de gestion des utilisateurs utilisé pour exécuter les opérations de gestion des utilisateurs autorisés par quorum.
+ **quorum** : service de gestion du quorum utilisé pour définir les valeurs de quorum autorisées pour tout service autorisé par quorum.
+ **cluster** : service de gestion de cluster utilisé pour exécuter le quorum afin de gérer les configurations à l'échelle du cluster, telles que l'application du protocole MTLS, l'enregistrement et le désenregistrement du protocole MTLS.
+ **enregistrement** : génère un jeton non signé à utiliser lors de l'enregistrement d'une clé publique pour l'autorisation du quorum.
+ **key-usage** : génère un jeton non signé qui est utilisé pour exécuter les opérations d'utilisation des clés autorisées par le quorum.
+ **gestion des clés** : génère un jeton non signé qui est utilisé pour exécuter les opérations de gestion des clés autorisées par le quorum.
**Obligatoire** : oui

***<TOKEN>***  
Chemin de fichier dans lequel le fichier de jeton non signé sera écrit.  
**Obligatoire** : oui

## Rubriques en relation
<a name="quorum-token-generate-seealso"></a>
+ [Noms et types de services prenant en charge l'authentification par quorum](quorum-auth-chsm-cli-service-names.md)

# Répertorier les jetons de quorum à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-qm-token-list"></a>

Utilisez la **quorum token-sign list** commande de la CLI CloudHSM pour répertorier tous les jetons de quorum tokensign présents dans votre cluster. AWS CloudHSM Cela inclut les jetons générés par d'autres utilisateurs. Un jeton est lié à un utilisateur. Ainsi, même si vous pouvez voir des jetons d'autres utilisateurs, vous ne pourrez utiliser que les jetons associés à l'utilisateur actuellement connecté.

Pour plus d'informations sur les types et les noms de services, consultez la section [Noms des services et types prenant en charge l'authentification par quorum](quorum-auth-chsm-cli-service-names.md). Pour plus d'informations sur le contenu affiché à partir des jetons listés, reportez-vous aux sections [Gestion et utilisation des clés avec authentification par quorum activée pour l'utilisation de la AWS CloudHSM CLI CloudHSM](key-quorum-auth-chsm-cli-crypto-user.md) pour les jetons associés `key-management` à et aux `key-usage` services, et [Gestion des utilisateurs avec authentification par quorum activée pour l' AWS CloudHSM utilisation de la CLI CloudHSM](quorum-auth-chsm-cli-admin.md) pour les jetons associés à `user``quorum`, ou au `cluster` service, respectivement.

## Type utilisateur
<a name="quorum-token-list-user-type"></a>

Les utilisateurs suivants peuvent exécuter cette commande.
+ Admin
+ Utilisateur de chiffrement (CU)

## Syntaxe
<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
```

## Exemple
<a name="quorum-token-list-examples"></a>

Cette commande listera tous les jetons de signature présents dans votre AWS CloudHSM cluster. Cela inclut les jetons générés par d'autres utilisateurs. Un jeton est lié à un utilisateur. Ainsi, même si vous pouvez voir des jetons d'autres utilisateurs, vous ne pourrez utiliser que les jetons associés à l'utilisateur actuellement connecté.

**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
      }
    ]
  }
}
```

## Rubriques en relation
<a name="quorum-token-list-seealso"></a>
+ [quorum token-sign generate](cloudhsm_cli-qm-token-gen.md)

# Afficher les valeurs de quorum à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-qm-token-list-qm"></a>

Utilisez la **quorum token-sign list-quorum-values** commande de la CLI CloudHSM pour répertorier les valeurs de quorum définies AWS CloudHSM dans votre cluster.

## Type utilisateur
<a name="quorum-token-list-qm-user-type"></a>

Les utilisateurs suivants peuvent exécuter cette commande.
+ Tous les utilisateurs. Vous n'avez pas besoin d'être connecté pour exécuter cette commande.

## Syntaxe
<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
```

## Exemple
<a name="quorum-token-list-qm-examples"></a>

Cette commande répertorie les valeurs de quorum définies dans votre AWS CloudHSM cluster pour chaque service.

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

## Rubriques en relation
<a name="quorum-token-list-qm-seealso"></a>
+ [Noms et types de services prenant en charge l'authentification par quorum](quorum-auth-chsm-cli-service-names.md)
+  [Configuration des MTL (recommandé)](getting-started-setup-mtls.md) 

# Mettre à jour une valeur de quorum à l'aide de la CLI CloudHSM
<a name="cloudhsm_cli-qm-token-set-qm"></a>

Utilisez la commande **quorum token-sign set-quorum-value** de la CLI CloudHSM pour définir une nouvelle valeur de quorum pour un service autorisé par quorum.

## Type utilisateur
<a name="quorum-token-set-qm-user-type"></a>

Les utilisateurs suivants peuvent exécuter cette commande.
+ Admin

## Syntaxe
<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')
```

## Exemple
<a name="quorum-token-set-qm-examples"></a>

**Example**  
Dans l'exemple suivant, cette commande écrit un jeton non signé par HSM de votre cluster dans le fichier spécifié par jeton. Lorsque vous y êtes invité, signez les jetons du fichier.  

```
aws-cloudhsm > quorum token-sign set-quorum-value --service quorum --value 2
{
  "error_code": 0,
  "data": "Set Quorum Value successful"
}
```
Vous pouvez ensuite exécuter la commande **list-quorum-values** pour confirmer que la valeur du quorum pour le service de gestion du quorum a été définie :  
**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
  }
}
```

## Arguments
<a name="quorum-token-set-qm-arguments"></a>

***<CLUSTER\$1ID>***  
ID du cluster sur lequel exécuter cette opération.  
Obligatoire : si plusieurs clusters ont été [configurés.](cloudhsm_cli-configs-multi-cluster.md)

***<APPROVAL>***  
Le chemin du fichier de jeton signé à approuver sur le HSM.

***<SERVICE>***  
Spécifie le service autorisé par le quorum pour lequel générer un jeton. Ce paramètre est obligatoire. Pour plus d'informations sur les types et les noms de services, consultez la section [Noms des services et types prenant en charge l'authentification par quorum](quorum-auth-chsm-cli-service-names.md).  
**Valeurs valides**  
+ **user** : le service de gestion des utilisateurs. Service utilisé pour exécuter les opérations de gestion des utilisateurs autorisés par quorum.
+ **quorum** : le service de gestion du quorum. Service utilisé pour définir les valeurs de quorum autorisées pour tout service autorisé par quorum.
+ **cluster** : service de gestion de cluster utilisé pour exécuter le quorum afin de gérer les configurations à l'échelle du cluster, telles que l'application du protocole MTLS, l'enregistrement du protocole MTLS et le désenregistrement du protocole MTLS.
+ **registration** : génère un jeton non signé à utiliser pour enregistrer une clé publique pour l'autorisation du quorum.
**Obligatoire** : oui

***<VALUE>***  
Spécifie la valeur du quorum à définir. La valeur maximale du quorum est de huit (8).  
**Obligatoire** : oui

## Rubriques en relation
<a name="quorum-token-set-qm-seealso"></a>
+ [signe du jeton quorum list-quorum-values](cloudhsm_cli-qm-token-list-qm.md)
+ [Noms et types de services prenant en charge l'authentification par quorum](quorum-auth-chsm-cli-service-names.md)
+ [Configuration des MTL (recommandé)](getting-started-setup-mtls.md)