Recuperación de una clave

Puede recuperar el material de clave de una clave utilizando IBM® Key Protect for IBM Cloud®.

Si tiene una política de acceso de Escritor o Gestor, puede recuperar el contenido de una clave estándar, como su material de clave y sus detalles de políticas.

Las claves raízUna clave de encapsulado simétrica que se utiliza para cifrar y descifrar otras claves almacenadas en un servicio de datos. permanecen dentro de los límites de un módulo de seguridad de hardware hardware. No se puede recuperar el material de clave para una clave raíz.

Recuperación de una clave con la API

Para ver información detallada sobre una clave específica, puede realizar una llamada GET al siguiente punto final.

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

  1. Recupere sus credenciales de servicio y de autenticación para trabajar con claves en el servicio.

  2. Recuperar el ID de la clave que desea acceder o gestionar.

    El valor de la ID se utiliza para acceder a la información detallada acerca de la clave, como el propio material de la clave. Puede recuperar el ID de una clave especificada realizando una solicitud GET /v2/keys o accediendo a la GUI de Key Protect.

  3. Ejecute el siguiente mandato curl para obtener detalles sobre la clave y el material de la clave.

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

    Sustituya las variables de la solicitud de ejemplo de acuerdo con la siguiente tabla.

Describe las variables que se necesitan para ver una clave especificada con la API Key Protect.
Variable Descripción
región Obligatorio. La abreviatura de la región, como us-south o eu-gb, que representa el área geográfica donde reside su instancia Key Protect.

Para más información, consulte Puntos finales de servicio regionales.
IAM_token Obligatorio. Su señal de acceso de IBM Cloud. Incluya el contenido completo de la señal IAM, incluido el valor Bearer, en la solicitud curl.

Para más información, consulte Recuperación de un token de acceso.
instance_ID Obligatorio. El único identificador que está asignado a su instancia de servicio de Key Protect.

Para más información, consulte Recuperar un ID de instancia.
ID_conjunto_claves Opcional. El identificador exclusivo del conjunto de claves del que forma parte la clave. Si no se especifica, Key Protect buscará la clave en todos los conjuntos de claves asociados con la instancia especificada. Se recomienda especificar el ID de conjunto de claves para optimizar la solicitud.

Nota: El ID de llavero de las claves que se crean sin una cabecera x-kms-key-ring es: por defecto.
For more information, see Teclas de agrupación.
correlation_ID Opcional. El identificador exclusivo que se utiliza para realizar un seguimiento y correlacionar transacciones.
key_ID_or_alias Obligatorio. El identificador o alias para la clave que desea recuperar.

Una respuesta GET api/v2/keys/<key_ID_or_alias> satisfactoria devuelve detalles sobre la clave y el material de clave. El siguiente objeto JSON muestra un valor devuelto de ejemplo para una clave estándar.

{
    "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..."
        }
    ]
}

El siguiente objeto JSON muestra un valor devuelto de ejemplo para una clave raíz.

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

La payload o material de clave para una clave raíz permanece dentro de los límites de un módulo de seguridad de hardware y no se puede recuperar.

Para obtener una descripción detallada de los parámetros de respuesta, consulte el Key Protect Documento de referencia de la API REST.