Details zu einem Rootschlüssel oder Standardschlüssel anzeigen

Sie können die allgemeinen Merkmale eines einzelnen Verschlüsselungsschlüssels abrufen mithilfe von IBM Cloud® Hyper Protect Crypto Services.

Das Abrufen eines Rootschlüssels oder eines Standardschlüssels erfordert eine Writer- oder Manager-Zugriffsrichtlinie, aber Sie benötigen möglicherweise eine Möglichkeit, nur die Details zu einem Rootschlüssel oder einem Standardschlüssel anzuzeigen, wie z. B. den Übergangsverlauf oder die Konfiguration, ohne den Schlüssel selbst abzurufen. Wenn Sie Reader-Zugriffsberechtigungen besitzen, können Sie die Hyper Protect Crypto Services-Schlüsselverwaltungs-API verwenden, um nur Metadaten zu einem Rootschlüssel oder einem Standardschlüssel abzurufen.

Anzeigen wichtiger Details mit der Benutzeroberfläche

Sie können Details zu einem bestimmten Schlüssel mit der Benutzeroberfläche anzeigen, indem Sie die folgenden Schritte ausführen:

  1. Melden Sie sich bei der Benutzerschnittstelle an.
  2. Rufen Sie Menü > Ressourcenliste auf, um eine Liste Ihrer Ressourcen anzuzeigen.
  3. Wählen Sie in Ihrer IBM Cloud-Ressourcenliste die bereitgestellte Instanz von Hyper Protect Crypto Services aus.
  4. Verwenden Sie auf der Seite KMS-Schlüssel die Tabelle Schlüssel, um die Schlüssel in Ihrem Service zu durchsuchen.
  5. Klicken Sie auf das Symbol Aktionen Symbol „Aktionen“, um eine Liste der Optionen für einen bestimmten Schlüssel zu öffnen.
  6. Klicken Sie im Optionsmenü auf Schlüsseldetails anzeigen, um die Details des Schlüssels anzuzeigen.

Schlüsseldetails mit der API des Schlüsselmanagementservice anzeigen

Zum Anzeigen detaillierter Informationen zu einem bestimmten Rootschlüssel oder Standardschlüssel können Sie einen GET-Aufruf an den folgenden Endpunkt absetzen.

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID_or_alias>/metadata

  1. Rufen Sie Ihre Authentifizierungsnachweise für die Arbeit mit Schlüsseln im Service ab.

  2. Rufen Sie die ID des Schlüssels ab, den Sie untersuchen wollen.

    Der ID-Wert wird für den Zugriff auf detaillierte Informationen zu dem Schlüssel verwendet. Sie finden die ID für einen Schlüssel in Ihrer Serviceinstanz wie folgt:Abrufen einer Liste Ihrer Schlüssel oder durch Zugriff auf die Benutzeroberfläche.

  3. Führen Sie den folgenden cURL-Befehl aus, um Details zu dem Schlüssel abzurufen.

    curl -X GET \
  'https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID_or_alias>/metadata' \
  -H 'accept: application/vnd.ibm.kms.key+json' \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'bluemix-instance: <instance_ID>' \
  -H 'x-kms-key-ring: <key_ring_ID>' \
  -H 'correlation-id: <correlation_ID>'

    Ersetzen Sie die Variablen in der Beispielanforderung entsprechend der folgenden Tabelle.

    Tabelle 1. Beschreibt die Variablen, die erforderlich sind, um Details zu einem Schlüssel mit der API anzuzeigen.
    Variabel Beschreibung
    region Erforderlich. Die Regionsabkürzung, wie zum Beispiel us-south oder eu-de, das den geografischen Bereich darstellt, in dem IhrHyper Protect Crypto Services Instanz befindet. Weitere Informationen finden Sie unter Regionale Serviceendpunkte.
    key_ID_or_alias Erforderlich. Die ID oder der Aliasname für den Schlüssel, den Sie überprüfen möchten.
    IAM_token Erforderlich. Ihr IBM Cloud-Zugriffstoken. Nehmen Sie den vollständigen Inhalt des IAM-Tokens einschließlich des Werts für Bearer in die cURL-Anforderung auf. Weitere Informationen finden Sie unter Zugriffstoken abrufen.
    instance_ID Erforderlich. Die eindeutige ID, die Ihrer Hyper Protect Crypto Services-Instanz zugewiesen ist. Weitere Informationen finden Sie unter Instanz-ID abrufen.
    key_ring_ID Optional. Die eindeutige ID des Schlüsselrings, zu dem der Schlüssel gehört. Wenn diese Option nicht angegeben wird, sucht Hyper Protect Crypto Services nach dem Schlüssel in jedem Schlüsselring, der der angegebenen Instanz zugeordnet ist. Daher wird empfohlen, die Schlüsselring-ID für eine optimierte Anforderung anzugeben.

    Hinweis: Die Schlüsselring-ID der Schlüssel, die ohne den Header x-kms-key-ring erstellt werden, lautet wie folgt: default. Weitere Informationen finden Sie im Abschnitt zum Verwalten von Schlüsselringen.
    correlation_ID Die eindeutige ID, die zum Überwachen und Korrelieren von Transaktionen verwendet wird.

    Eine erfolgreiche GET api/v2/keys/<key_ID_or_alias>/metadata-Antwort gibt Details zu Ihrem Schlüssel zurück. Das folgende JSON-Objekt zeigt ein Beispiel für einen zurückgegebenen Wert für einen Standardschlüssel.

    {
  "metadata": {
    "collectionType": "application/vnd.ibm.kms.key+json",
    "collectionTotal": 1
  },
  "resources": [
    {
      "type": "application/vnd.ibm.kms.key+json",
      "id": "02fd6835-6001-4482-a892-13bd2085f75d",
      "name": "test-standard-key",
      "state": 1,
      "extractable": true,
      "crn": "crn:v1:bluemix:public:hs-crypto:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:12e8c9c2-a162-472d-b7d6-8b9a86b815a6:key:02fd6835-6001-4482-a892-13bd2085f75d",
      "imported": false,
      "creationDate": "2020-03-12T03:50:12Z",
      "createdBy": "...",
      "algorithmType": "AES",
      "algorithmMetadata": {
        "bitLength": "256",
        "mode": "CBC_PAD"
      },
      "algorithmBitSize": 256,
      "algorithmMode": "CBC_PAD",
      "lastUpdateDate": "2020-03-12T03:50:12Z",
      "dualAuthDelete": {
        "enabled": false
      },
      "deleted": false
    }
  ]
}

    Sie müssen den Wert von payload für einen Standardwert abrufen? Weitere Informationen finden Sie unter Rootschlüssel oder Standardschlüssel abrufen.

    Eine ausführliche Beschreibung der Antwortparameter finden Sie im Hyper Protect Crypto Services-Schlüsselmanagement REST-API-Referenzdokument.