getKeyVault() (método mongosh)

getKeyVault()

Devuelve el objeto KeyVault para la conexión actual con la base de datos. El objeto KeyVault admite la gestión de claves de cifrado de datos para Cifrado a nivel de campo del lado del cliente.

Devuelve:	El objeto `KeyVault` para la conexión actual de la base de datos.

Compatibilidad

Este comando está disponible en implementaciones alojadas en los siguientes entornos:

MongoDB Atlas: El servicio totalmente administrado para implementaciones de MongoDB en la nube.

MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB
MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Sintaxis

getKeyVault() tiene la siguiente sintaxis:

keyVault = db.getMongo().getKeyVault();

Utiliza el objeto KeyVault para acceder a los siguientes métodos de gestión de llaves de cifrado de datos:

Comportamiento

Requiere configurar cifrado a nivel de campo del lado del cliente en la conexión a la base de datos.

El siguiente ejemplo utiliza una clave administrada localmente para la configuración de cifrado a nivel de campo del lado del cliente.

Los métodos mongosh ClientEncryption requieren una conexión a la base de datos con el cifrado en uso habilitado. Si la conexión actual a la base de datos no se inició con el cifrado en uso habilitado, se producirá uno de los siguientes errores:

Utilice el constructor Mongo() del mongosh para establecer una conexión con las opciones de cifrado en uso requeridas. El método Mongo() admite los siguientes proveedores de servicio de administración de claves (KMS) para la administración de la clave maestra del cliente (CMK):
or
Utilice las opciones de línea de comandos mongosh para establecer una conexión con las opciones requeridas. Estas opciones solo son compatibles con el proveedor KMS de Amazon Web Services para la gestión de CMK.

Índice Parcial Único en Key Vault

El método getKeyVault() crea automáticamente un índice único en el campo keyAltNames con un filtro de índice parcial para solo los documentos donde existe keyAltNames. getKeyVault() crea este índice en la colección de claves. Esto impide que dos claves de cifrado de datos en la misma clave tengan el mismo nombre alternativo y, por lo tanto, evita ambigüedades sobre qué clave de cifrado de datos es la adecuada para el cifrado/descifrado.

Advertencia

No elimine el índice único creado por getKeyVault(). Las operaciones de cifrado de campo del lado del cliente dependen de la unicidad de keyAltNames impuesta por el servidor. Eliminar el índice puede provocar un comportamiento inesperado o impredecible.

Ejemplo

El siguiente ejemplo utiliza una clave administrada localmente para la configuración de cifrado a nivel de campo del lado del cliente.

Inicia mongosh

Inicie el cliente mongosh.

mongosh --nodb

Genere su clave

Para configurar el cifrado a nivel de campo del lado del cliente para una clave gestionada localmente, genera una string de 96 bytes codificada en base64 sin saltos de línea.

const TEST_LOCAL_KEY = require("crypto").randomBytes(96).toString("base64")

Crea las opciones de cifrado a nivel de campo del lado del cliente

Cree las opciones de cifrado a nivel de campo del lado del cliente usando la string de clave local generada:

 let autoEncryptionOpts = {
   "keyVaultNamespace" : "encryption.__dataKeys",
   "kmsProviders" : {
     "local" : {
       "key" : BinData(0, TEST_LOCAL_KEY)
     }
   }
 }

Crea tu cliente cifrado

Utiliza el Mongo() constructor con las opciones de cifrado a nivel de campo del lado del cliente configuradas para crear una conexión a la base de datos. Reemplace el URI mongodb://myMongo.example.net por el URI de la cadena de conexión del clúster de destino.

encryptedClient = Mongo(
  "mongodb://myMongo.example.net:27017/?replSetName=myMongo",
   autoEncryptionOpts
)

Utilice el método getKeyVault() para recuperar el objeto de la bóveda de claves:

keyVault = encryptedClient.getKeyVault()

Para obtener la documentación completa sobre cómo iniciar conexiones MongoDB con el cifrado a nivel de campo en el lado del cliente activado, consulte Mongo().

Volver

getClientEncryption

KeyVault.addKeyName