Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
Click here >
Docs Menu
Docs Home
/ /

Proveedores de KMS

Aprende sobre el sistema de gestión de claves (KMS) proveedores que admite encriptación en uso.

Utilizar un Sistema de Gestión de Claves remoto para gestionar tu Clave Maestra de Cliente tiene las siguientes ventajas en comparación con alojarla en tu sistema de archivos local:

  • Almacenamiento seguro de la clave con auditoría de acceso

  • Reducción del riesgo de problemas de permisos de acceso

  • Disponibilidad y distribución de la clave para clientes remotos

  • Copia de seguridad y recuperación automatizadas de claves

  • Gestión centralizada del ciclo de vida de las claves de cifrado

Además, para los siguientes KMS proveedores, tu KMS cifra y descifra remotamente tu clave de cifrado de datos, asegurando que tu clave maestra de cliente nunca esté expuesta a tu aplicación habilitada para Queryable Encryption o CSFLE:

  • Amazon Web Services KMS

  • Azure Key Vault

  • Google Cloud KMS

En el cifrado en uso, tu sistema de gestión de claves:

  • Crea y cifra la clave maestra del cliente

  • Cifra las claves de cifrado de datos creadas por tu aplicación

  • Descifra las llaves de cifrado de datos

Para obtener más información sobre las llaves maestras de cliente y las llaves de cifrado de datos, consulta Claves de cifrado y bóvedas de claves.

Para crear una llave maestra de cliente, configure su Sistema de Gestión de Claves para generar su llave maestra de cliente de la siguiente manera:

Diagrama

Para ver un tutorial que demuestre cómo crear y almacenar una llave maestra de cliente en su KMS favorito, consulte el Tutorial de cifrado automático Queryable Encryption o el Tutorial de cifrado automático CSFLE.

Para crear una llave de cifrado de datos:

  • Instancie un ClientEncryption instancia en su aplicación habilitada para Queryable Encryption o CSFLE:

    • Proporciona un objeto kmsProviders que especifique las credenciales que tu aplicación utiliza para autenticarse con su proveedor de KMS.

  • Cree una llave de cifrado de datos con el método CreateDataKey del objeto ClientEncryption en su aplicación.

    • Proporciona un objeto dataKeyOpts que especifica con qué clave tu KMS debe cifrar tu nueva clave de cifrado de datos.

Para ver un tutorial que muestra cómo crear y cifrar una clave de cifrado de datos, consulta los siguientes recursos:

Para ver la estructura de los objetos kmsProviders y dataKeyOpts para todos los proveedores de KMS compatibles, consulta Servicios de gestión de claves compatibles.

Las siguientes secciones de esta página presentan la siguiente información para todos los proveedores del sistema de gestión de llaves:

  • Arquitectura del cliente con cifrado en uso habilitado

  • Estructura de objetos kmsProviders

  • Estructura de objetos dataKeyOpts

Tanto Queryable Encryption como CSFLE admiten los siguientes proveedores del Sistema de gestión de claves:

Esta sección proporciona información relacionada con el uso de AWS Key Management Service en tu aplicación con Queryable Encryption o CSFLE habilitado.

Para ver un tutorial que demuestre cómo usar AWS KMS en tu aplicación, consulta Descripción general: Habilitar Queryable Encryption o Utiliza cifrado automático a nivel de campo del lado del cliente con AWS.

El siguiente diagrama describe la arquitectura de una aplicación habilitada con Queryable Encryption utilizando AWS KMS.

Diagrama KMS

Nota

El cliente no puede acceder a la llave maestra de cliente

Cuando uses el sistema de gestión de claves anterior, tu aplicación habilitada para Queryable Encryption no tendrá acceso a tu llave maestra de cliente.

La siguiente tabla presenta la estructura de un objeto kmsProviders para AWS KMS:

Campo
Obligatorio para el usuario de IAM
Requerido para el rol de IAM
Descripción

ID de clave de acceso

Identifica al usuario de la cuenta.

Clave de acceso secreta

Contiene las credenciales de autenticación del usuario de la cuenta.

Session Token

No

Contiene un token obtenido del Servicio de token de seguridad de AWS (AWS STS).

La siguiente tabla presenta la estructura de un objeto dataKeyOpts para AWS KMS:

Campo
Requerido
Descripción

llave

region

No

Región de AWS de tu clave maestra, p. ej. "us-west-2"; requeridos solo si no se especifican en tu ARN.

endpoint

No

Nombre de host personalizado para el endpoint de AWS si está configurado para su cuenta.

Esta sección proporciona información relacionada con el uso de Azure Key Vault en su aplicación habilitada para Queryable Encryption o CSFLE.

Para ver un tutorial que demuestre cómo utilizar Azure Key Vault en tu aplicación, consulta Descripción general: Habilitar Queryable Encryption o Utiliza cifrado de campo a nivel de cliente automático con Azure.

El siguiente diagrama describe la arquitectura de una aplicación habilitada para Queryable Encryption que usa Azure Key Vault.

Diagrama KMS

Nota

El cliente no puede acceder a la llave maestra de cliente

Cuando uses el sistema de gestión de claves anterior, tu aplicación habilitada para Queryable Encryption no tendrá acceso a tu llave maestra de cliente.

La siguiente tabla presenta la estructura de un objeto kmsProviders para Azure Key Vault:

Campo
Requerido
Descripción

azure.tenantId

Identifica la organización de la cuenta.

azure.clientId

Identifica el clientId para autenticar tu aplicación registrada.

azure.clientSecret

Se utiliza para autenticar la aplicación registrada.

azure.identityPlatformEndpoint

No

Especifica un nombre de host y un número de puerto para el servidor de autenticación. De forma predeterminada, se utiliza login.microsoftonline.com y solo es necesario para instancias de Azure no comerciales, como cuentas gubernamentales o de China.

La siguiente tabla presenta la estructura de un objeto dataKeyOpts para Azure Key Vault:

Campo
Requerido
Descripción

keyName

Nombre de la clave maestra

versión de la clave

No, pero se recomienda encarecidamente

Versión de la clave maestra

keyVaultEndpoint

URL de la bóveda de claves. P. ej. myVaultName.vault.azure.net

Advertencia

Si no se incluye un campo keyVersion, Azure Key Vault intentará descifrar las llaves de cifrado de datos utilizando la llave maestra de cliente más reciente. Si rotas la llave maestra de cliente, pero no vuelves a envolver las claves de cifrado de datos con la nueva clave maestra, el intento de descifrar una DEK existente falla, ya que la DEK está cifrada con la versión anterior de la llave maestra de cliente.

Esta sección proporciona información relacionada con el uso de Google Cloud Key Management en tu aplicación habilitada para Queryable Encryption o CSFLE.

Para ver un tutorial que demuestra cómo utilizar el KMS de GCP en su aplicación, consulte la descripción general: habilite el Queryable Encryption o utilice el cifrado automático a nivel de campo del lado del cliente con GCP.

El siguiente diagrama describe la arquitectura de una aplicación habilitada para Queryable Encryption utilizando GCP KMS.

Diagrama KMS

Nota

El cliente no puede acceder a la llave maestra de cliente

Cuando uses el sistema de gestión de claves anterior, tu aplicación habilitada para Queryable Encryption no tendrá acceso a tu llave maestra de cliente.

La siguiente tabla presenta la estructura de un objeto kmsProviders para GCP KMS:

Campo
Requerido
Descripción

correo electrónico

Identifica la dirección de correo electrónico de tu cuenta de servicio.

llave privada

Identifies your service account private key in either base64 string or Binary subtype 0 format without the prefix and suffix markers.

Suppose your service account private key value is as follows:
-----BEGIN PRIVATE KEY-----\nyour-private-key\n-----END PRIVATE KEY-----\n
The value you would specify for this field is:
your-private-key
If you have a user-key.json credential file, you can extract the string by executing the following command in a bash or similar shell. The following command requires that you install OpenSSL :
cat user-key.json | jq -r .private_key | openssl pkcs8 -topk8 -nocrypt -inform PEM -outform DER | base64 -w 0

endpoint

No

Especifica un nombre de host y un número de puerto para el servidor de autenticación. Por defecto es oauth2.googleapis.com.

La siguiente tabla presenta la estructura de un objeto dataKeyOpts para GCP KMS:

Campo
Requerido
Descripción

ID del proyecto

Identificador para tu proyecto en el que creaste la clave.

Ubicación

Región especificada para tu clave.

keyRing

Identificador del grupo de claves al que pertenece su clave.

keyName

Identificador de la clave maestra simétrica.

versión de la clave

No

Especifica la versión de la clave nombrada. Si no se especifica, se utiliza la versión por defecto de la clave.

endpoint

No

Especifica el host y el puerto opcional de nube KMS. El valor por defecto es cloudkms.googleapis.com.

Esta sección proporciona información relacionada con el uso de un KMIP Sistema de Gestión de Claves compatible en tu aplicación con Queryable Encryption o CSFLE habilitada.

Para aprender a configurar KMIP con HashiCorp Vault, consulte Administrar claves de cifrado de cliente con Vault como un servidor KMIP en la documentación de HashiCorp Vault.

El siguiente diagrama describe la arquitectura de una aplicación con Queryable Encryption habilitada que utiliza un proveedor de claves compatible con KMIP.

Diagrama

Importante

El cliente Accede a la llave maestra de cliente

Cuando tu aplicación habilitada para Queryable Encryption utiliza un proveedor de claves que cumple con KMIPsin especificar la opción delegated, tu aplicación accede directamente a tu llave maestra de cliente. Para evitar el acceso directo a tu llave maestra de cliente, puedes establecer la opción delegated en true en tu objeto dataKeyOpts.

La siguiente tabla presenta la estructura de un objeto kmsProviders para un Sistema de Gestión de Claves compatible con KMIP:

Nota

Autentícate a través de TLS/SSL

Tu aplicación habilitada con Queryable Encryption se autentica a través de TLS/SSL al usar KMIP.

Campo
Requerido
Descripción

endpoint

Especifica un nombre de host y un número de puerto para el servidor de autenticación.

La siguiente tabla presenta la estructura de un objeto dataKeyOpts para un Sistema de Gestión de Claves compatible con KMIP:

Campo
Requerido
Descripción

keyId

No

El campo keyId de un objeto gestionado de datos secretos de 96 bytes almacenado en tu proveedor de claves compatible con KMIP.

Si no se especifica el campo keyId en el documento masterKey que se envía al proveedor de claves compatible con KMIP, el driver creará un nuevo objeto gestionado de datos secretos de 96 bytes en su proveedor de claves compatible con KMIPpara que actúe como su clave maestra.

endpoint

El URI de su proveedor de claves compatible con KMIP.

delegado

No

Configura esta opción en true para delegar el cifrado y descifrado de tu DEK a tu proveedor de claves compatible con KMIP. Delegar esto al proveedor de claves que cumple con KMIPgarantiza que nunca tengas acceso directo a la llave maestra de cliente.

Si no se configura la opción delegated en true, la aplicación accede directamente y transporta la llave maestra de cliente desde el proveedor de KMIP.

IMPORTANTE: La opción delegated no está disponible en los controladores de Ruby o Go.

Esta sección proporciona información relacionada con el uso de un proveedor de claves local en tu aplicación habilitada para Queryable Encryption o CSFLE.

Advertencia

Asegurar tu archivo de clave local en producción

Recomendamos almacenar sus claves maestras de cliente en un sistema de gestión de claves remoto (KMS). Para aprender a utilizar un KMS remoto en tu implementación de cifrado consultable, consulta la guía Tutoriales sobre Queryable Encryption.

Si optas por usar un proveedor local de llaves en producción, proceder con extrema precaución y no almacenarlo en el sistema de archivos. Considera inyectar la clave en la aplicación cliente mediante un proceso sidecar o usa otro método que mantenga la clave segura.

Para ver un tutorial que demuestre cómo utilizar un Proveedor de Llaves Local para probar Cifrado Consultable, consulta el Inicio rápido de Queryable Encryption o el Inicio rápido de CSFLE.

Cuando usas un Proveedor de Llaves Locales para pruebas, la aplicación recupera la Llave maestra del cliente del equipo en el que se ejecuta. Para usar un Proveedor de Claves Local en producción, utiliza un enfoque que no almacene la clave en el sistema de archivos. Por ejemplo, puedes inyectar la clave en el proceso del cliente a través de un sidecar.

El siguiente diagrama describe la arquitectura de una aplicación habilitada para cifrado consultable mediante un proveedor de claves local.

Diagrama de arquitectura del proveedor de claves local.

La siguiente tabla presenta la estructura de un objeto kmsProviders para un proveedor de claves local:

Campo
Requerido
Descripción

llave

La clave maestra utilizada para cifrar/descifrar claves de datos. La clave maestra se transmite como una string codificada en base64.

Cuando usas un Proveedor de Clave Local, especificas tu llave maestra de cliente a través de tu objeto kmsProviders.

Volver

Llaves y bóvedas de claves

En esta página