Exporter une clé asymétrique à l'aide de la CLI CloudHSM

Utilisez la key generate-file commande de la CLI CloudHSM pour exporter une clé asymétrique depuis le module de sécurité matériel (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 la véritable clé privée mais fait référence à la clé privée dans le HSM, peut être utilisé pour établir le SSL/TLS déchargement de votre serveur Web vers. AWS CloudHSM Pour plus d'informations, consultez la section SSL/TLS Déchargement.

Type utilisateur

Les types d'utilisateur suivants peuvent exécuter cette commande.

Exigences

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

Syntaxe

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)
          - cloudhsm-reference-pem: CloudHSM reference PEM format (supports private 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')

Exemples

Ces exemples montrent comment générer un fichier clé key generate-file à partir d'une clé de votre AWS CloudHSM cluster.

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

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

Arguments

Génération de références clés KSP (Windows)

Conditions préalables

Emplacement du fichier

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

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 attributaire d'une clé privée

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

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érez des références de clés KSP pour toutes les paires de clés

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

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

Rubriques associées