Recupero di una chiave

Si può recuperare il materiale della chiave per una chiave usando IBM® Key Protect for IBM Cloud®.

Se si dispone di un criterio di accesso Writer o Manager, è possibile recuperare il contenuto di una chiave standard, come il materiale della chiave e i dettagli del criterio di una chiave standard, come il materiale della chiave e i dettagli del criterio.

Le chiavi radiceUna chiave di impacchettamento simmetrica utilizzata per la crittografia e la decrittografia di altre chiavi archiviate in un servizio di dati. rimangono all'interno dei limiti di un modulo di sicurezza hardware modulo. Non è possibile recuperare il materiale della chiave per una chiave principale.

Recupero di una chiave con l'API

Per visualizzare informazioni dettagliate su una chiave specifica, puoi effettuare una chiamata GET al seguente endpoint.

https://<region>.kms.cloud.ibm.com/api/v2/keys/<key_ID_or_alias>

  1. Richiama le tue credenziali del servizio e di autenticazione per utilizzare le chiavi nel servizio.

  2. Richiama l'ID della chiave che desideri gestire o a cui vuoi accedere.

    Il valore ID viene utilizzato per accedere a informazioni dettagliate sulla chiave, come il materiale della chiave stesso. È possibile recuperare l'ID di una chiave specificata facendo una richiesta a GET /v2/keys, oppure accedendo al file Key Protect GUI.

  3. Eseguire il seguente comando curl per ottenere dettagli sulla chiave e sul materiale della chiave materiale. 

    $ curl -X GET \
    "https://<region>.kms.cloud.ibm.com/api/v2/keys/<key_ID_or_alias>" \
    -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>"

    Sostituisci le variabili nella richiesta di esempio in base alla seguente tabella.

Descrive le variabili necessarie per visualizzare una chiave specifica con l'API Key Protect API.
Variabile Descrizione
regione Richiesto. L'abbreviazione della regione, come us-south o eu-gb, che rappresenta l'area geografica in cui risiede l'istanza Key Protect.

Per ulteriori informazioni, vedere Endpoint del servizio regionale.
IAM_token Richiesto. Il tuo token di accesso IBM Cloud. Includere l'intero contenuto del token IAM, compreso il valore Bearer, nella richiesta curl.

Per ulteriori informazioni, vedere Recupero di un token di accesso.
instance_id Richiesto. L'identificatore unico assegnato all'istanza del servizio Key Protect.

Per ulteriori informazioni, vedere Recupero dell'ID di un'istanza.
iD_anello_chiave Facoltativo. L'identificatore univoco del portachiavi di cui fa parte la chiave. Se non specificato, Key Protect cercherà la chiave in ogni portachiavi associato all'istanza specificata. Si consiglia di specificare l'ID del portachiavi per una richiesta più ottimizzata

Nota: L'ID del portachiavi creato senza intestazione x-kms-key-ring è: default.
For more information, see Tasti di raggruppamento.
iD correlazione Facoltativo: l'identificativo univoco utilizzato per tracciare e correlare le transazioni.
iD_chiave_o_alias Richiesto. L'identificatore o l'alias della chiave che si desidera recuperare.

Una risposta di successo a GET api/v2/keys/<key_ID_or_alias> restituisce i dettagli sulla chiave e sul materiale della chiave. Il seguente oggetto JSON mostra un valore restituito di esempio per una chiave standard.

{
    "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",
            "aliases": [
                "alias-1",
                "alias-2"
                ],
            "state": 1,
            "expirationDate": "2020-03-15T03:50:12Z",
            "extractable": true,
            "crn": "crn:v1:bluemix:public:kms: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": "Deprecated",
            "algorithmMetadata": {
                "bitLength": "256",
                "mode": "Deprecated"
            },
            "algorithmBitSize": 256,
            "algorithmMode": "Deprecated",
            "lastUpdateDate": "2020-03-12T03:50:12Z",
            "dualAuthDelete": {
                "enabled": false
            },
            "deleted": false,
            "payload": "Rm91ciBzY29yZSBhbmQgc2V2ZW4geWVhcnMgYWdv..."
        }
    ]
}

Il seguente oggetto JSON mostra un esempio di valore restituito per una chiave principale.

{
    "metadata": {
        "collectionType": "application/vnd.ibm.kms.key+json",
        "collectionTotal": 1
    },
    "resources": [
        {
            "type": "application/vnd.ibm.kms.key+json",
            "id": "2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
            "aliases": [
                "alias-1",
                "alias-2"
            ],
            "name": "test-root-key",
            "state": 1,
            "extractable": false,
            "crn": "crn:v1:bluemix:public:kms:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:30372f20-d9f1-40b3-b486-a709e1932c9c:key:2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
            "imported": false,
            "creationDate": "2020-03-05T16:28:38Z",
            "createdBy": "...",
            "algorithmType": "Deprecated",
            "algorithmMetadata": {
                "bitLength": "256",
                "mode": "Deprecated"
            },
            "algorithmBitSize": 256,
            "algorithmMode": "Deprecated",
            "lastUpdateDate": "2020-03-05T16:39:25Z",
            "keyVersion": {
                "id": "436901cb-f4e4-45f4-bd65-91a7f6d13461",
                "creationDate": "2020-03-05T16:39:25Z"
            },
            "dualAuthDelete": {
                "enabled": false
            },
            "deleted": false
        }
    ]
}

Il sito payload o il materiale della chiave principale rimane all'interno di un modulo di sicurezza hardware e non può essere recuperato modulo di sicurezza hardware e non può essere recuperato.

Per una descrizione dettagliata dei parametri di risposta, si veda il documento Key Protect Documento di riferimento dell'API REST.