Benutzertyp Voraussetzungen Syntax Beispiel: Einstellung eines identifizierenden Attributs Argumente Verwandte Themen

Legen Sie die Attribute von Schlüsseln mit Cloud fest HSM CLI

Verwenden Sie den key set-attribute Befehl in Cloud HSMCLI, um die Attribute der Schlüssel in Ihrem AWS CloudHSM Cluster festzulegen. Nur der CU, der den Schlüssel erstellt hat und folglich Eigentümer des Schlüssels ist, kann die Attribute des Schlüssels ändern.

Eine Liste der Schlüsselattribute, die in Cloud verwendet werden können HSMCLI, finden Sie unterSchlüsselattribute für Cloud HSM CLI.

Benutzertyp

Die folgenden Benutzertypen können diesen Befehl ausführen.

Crypto-Benutzer (CUs) können diesen Befehl ausführen.
Administratoren können das vertrauenswürdige Attribut festlegen.

Voraussetzungen

Um diesen Befehl auszuführen, müssen Sie als CU angemeldet sein. Um das vertrauenswürdige Attribut festzulegen, müssen Sie als Admin-Benutzer angemeldet sein.

Syntax


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

Beispiel: Einstellung eines identifizierenden Attributs

Das folgende Beispiel demonstriert, wie Sie mit dem key set-attribute-Befehl das Label setzen.

Verwenden Sie den Schlüssel mit dem Label my_key, wie hier gezeigt:


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

Bestätigen Sie mit dem key list-Befehl, dass sich das encrypt-Attribut geändert hat:


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": [],
          "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
  }
}

Argumente

<CLUSTER_ID>

Die ID des Clusters, auf dem dieser Vorgang ausgeführt werden soll.

Erforderlich: Wenn mehrere Cluster konfiguriert wurden.

<KEY_ATTRIBUTE>

Gibt den Namen des Attributs des Schlüssels an.

Erforderlich: Ja

<FILTER>

Schlüsselreferenz (z. B.key-reference=0xabc) oder durch Leerzeichen getrennte Liste von Schlüsselattributen in der Formattr.KEY_ATTRIBUTE_NAME=KEY_ATTRIBUTE_VALUE, dass ein passender Schlüssel zum Löschen ausgewählt werden soll.

Eine Liste der unterstützten HSM CLI Cloud-Schlüsselattribute finden Sie unter Schlüsselattribute für Cloud HSM CLI

Erforderlich: Nein

<KEY_ATTRIBUTE_VALUE>

Gibt den Wert des Attributs des Schlüssels an.

Erforderlich: Ja

<KEY_REFERENCE>

Eine hexadezimale oder dezimale Darstellung des Schlüssels. (z. B. ein Tastenkürzel).

Erforderlich: Nein