Liste der Rootschlüssel oder Standardschlüssel abrufen

Sie können Ihre Rootschlüssel oder Standardschlüssel, die in Ihrer bereitgestellten Instanz von Hyper Protect Crypto Services verwaltet werden, in einer übergeordneten Ansicht anzeigen, indem Sie einen GET-Aufruf an den folgenden Endpunkt absetzen.

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

1. Rufen Sie Ihren Service- und Authentifizierungsnachweis ab, um mit den Schlüsseln im Service zu arbeiten.

2. Zeigen Sie allgemeine Merkmale zu Ihren Schlüsseln an, indem Sie den folgenden cURL-Befehl ausführen.

   curl -X GET \
   "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys" \
   -H 'accept: application/vnd.ibm.collection+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 2. Beschreibt die Variablen, die zum Anzeigen von Schlüsseln mit der API erforderlich sind

   Variabel	Beschreibung
   region	Die Regionsabkürzung, z. B. us-south oder au-syd, die das geografische Gebiet darstellt, in dem sich Ihre Hyper Protect Crypto Services-Serviceinstanz befindet. Weitere Informationen finden Sie unter Regionale Serviceendpunkte.
   port	Erforderlich. Die Portnummer des API-Endpunkts.
   IAM_token	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	Die eindeutige ID, die Ihrer Hyper Protect Crypto Services-Serviceinstanz 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	Optional. Die eindeutige ID, die zum Überwachen und Korrelieren von Transaktionen verwendet wird.

   Eine erfolgreiche Anforderung GET /v2/keys gibt eine Sammlung von Schlüsseln zurück, die in Ihrer Hyper Protect Crypto Services-Instanz verfügbar sind.

   {
     "metadata": {
       "collectionType": "application/vnd.ibm.kms.key+json",
       "collectionTotal": 2
     },
     "resources": [
       {
         "id": "02fd6835-6001-4482-a892-13bd2085f75d",
         "type": "application/vnd.ibm.kms.key+json",
         "name": "Root-key",
         "state": 1,
         "crn": "crn:v1:bluemix:public:hs-crypto:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:12e8c9c2-a162-472d-b7d6-8b9a86b815a6:key:02fd6835-6001-4482-a892-13bd2085f75d",
         "createdBy": "...",
         "creationDate": "2020-03-11T16:30:06Z",
         "lastUpdateDate": "2020-03-11T16:30:06Z",
         "algorithmMetadata": {
           "bitLength": "256",
           "mode": "CBC_PAD"
         },
         "extractable": false,
         "imported": true,
         "algorithmMode": "CBC_PAD",
         "algorithmBitSize": 256,
         "dualAuthDelete": {
           "enabled": false
         }
       },
       {
         "id": "2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
         "type": "application/vnd.ibm.kms.key+json",
         "name": "Standard-key",
         "state": 1,
         "crn": "crn:v1:bluemix:public:hs-crypto:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:30372f20-d9f1-40b3-b486-a709e1932c9c:key:2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
         "createdBy": "...",
         "creationDate": "2020-03-12T03:50:12Z",
         "lastUpdateDate": "2020-03-12T03:50:12Z",
         "algorithmMetadata": {
           "bitLength": "256",
           "mode": "CBC_PAD"
         },
         "extractable": true,
         "imported": false,
         "algorithmMode": "CBC_PAD",
         "algorithmBitSize": 256,
         "dualAuthDelete": {
           "enabled": false
         }
       }
     ]
   }
   

   Standardmäßig gibt die Anforderung GET api/v2/keys die ersten 200 Schlüssel zurück. Sie können diese Begrenzung jedoch mithilfe des Parameters limit bei der Abfrage anpassen. Weitere Informationen zu limit und offset finden Sie unter Untergruppe von Schlüsseln abrufen.

   Wird nicht die vollständige Liste der Schlüssel angezeigt? Möglicherweise müssen Sie limit und offset verwenden oder wenden Sie sich an Ihren Administrator, um sicherzustellen, dass Ihnen die richtige Zugriffsebene für Schlüssel in Ihrer Instanz zugewiesen wird. Weitere Informationen finden Sie unter Anzeigen oder Auflisten von Schlüsseln nicht möglich.

Untergruppe von Schlüsseln abrufen

Durch die Angabe der Parameter limit und offset bei der Abfrage können Sie eine Untergruppe Ihrer Schlüssel abrufen, die mit dem Wert beginnt, den Sie für offset angeben.

Beispiel: Sie verfügen über insgesamt 3000 Schlüssel, die in der Hyper Protect Crypto Services-Serviceinstanz gespeichert sind, möchten aber mit der Abfrage GET /keys nur die Schlüssel 200 bis 300 abrufen.

Sie können die folgende Beispielanforderung verwenden, um eine andere Gruppe von Schlüsseln abzurufen.

curl -X GET \
  'https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys?offset=<offset>&limit=<limit>' \
  -H 'accept: application/vnd.ibm.collection+json' \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'bluemix-instance: <instance_ID>'

Ersetzen Sie die Variablen limit und offset in der Anforderung, wie in der folgenden Tabelle beschrieben.

Hinweise zur Verwendung liefern Ihnen die folgenden Beispiele für das Festlegen der Abfrageparameter limit und offset.

Mit dem Wert für 'offset' wird die relative Position eines bestimmten Schlüssels im Dataset angegeben. Der Wert für offset wird mit der Basis null angegeben, d. h., dass sich der zehnte Verschlüsselungsschlüssel in einem Dataset an der Position 9 befindet.

Schlüssel nach Status abrufen

Durch die Angabe des Parameters state in der Abfrage können Sie Schlüssel abrufen, die die Statuswerte aufweisen, die Sie angeben.

Beispiel: Sie haben möglicherweise Schlüssel in Ihrer Serviceinstanz, die sich im aktiven, ausgesetzten und gelöschten Status befinden. Sie wollen jedoch nur Schlüssel im aktiven Status abrufen, wenn Sie eine Anforderung GET /keys ausführen.

Der Statusabfrageparameter enthält eine durch Kommas getrennte Liste mit ganzen Zahlen von 0 bis 5 ohne Leerzeichen oder abschließende Kommas. Gültige Statuswerte basieren auf der Spezifikation von NIST SP 800-57. Weitere Informationen zum Schlüsselstatus finden Sie im Abschnitt zu Schlüsselstatuswerten und Statusübergängen.

Sie können die folgende Beispielanforderung verwenden, um eine andere Gruppe von Schlüsseln abzurufen.

curl -X GET \
  'https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys?state=<state_integers>' \
  -H 'accept: application/vnd.ibm.collection+json' \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'bluemix-instance: <instance_ID>'

Ersetzen Sie die Variable für den Parameter state in Ihrer Anforderung anhand der Angaben in der folgenden Tabelle.

Hinweise zur Verwendung können Sie den folgenden Beispielen für das Festlegen des Abfrageparameters state entnehmen.