getClientEncryption() (método mongosh)

getClientEncryption()

Devuelve el objeto ClientEncryption para la colección de la base de datos actual. El objeto ClientEncryption soporta el cifrado y desencriptación explícita (manual) de valores de campos para Cifrado a nivel de campo del lado del cliente.

Devuelve:	El objeto `ClientEncryption` 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 gestionado 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

getClientEncryption() tiene la siguiente sintaxis:

db.getMongo().getClientEncryption();

Utiliza el objeto ClientEncryption para acceder a los siguientes métodos de cifrado explícitos:

Comportamiento

Habilitar el cifrado a nivel de campo del lado del cliente en la conexión a la base de datos

Los métodos mongosh ClientEncryption requieren una conexión a la base de datos con la encriptación en uso activada. Si la conexión actual a la base de datos no se inició con la encriptación en uso activada, entonces:

Utilice el constructor Mongo() de mongosh para establecer una conexión con las opciones de encriptación en uso requeridas. El método Mongo() es compatible con los siguientes proveedores de Key Management Service (KMS) para la gestión de llaves maestras de cliente:
or
Utilice las opciones de línea de comandos mongosh para establecer una conexión con las opciones requeridas. Las opciones de la línea de comandos solo admiten el proveedor Amazon Web Services KMS para la gestión de la llave maestra de cliente.

Ejemplo

El método getKeyVault() crea automáticamente un índice único en el campo keyAltNames con un filtro de índice parcial solo para documentos en los que exista keyAltNames. getKeyVault() crea este índice en la Colección de Bóvedas de Llaves. Esto evita que dos claves de cifrado de datos en el mismo almacén de claves tengan el mismo nombre alternativo de clave y, por lo tanto, evita la ambigüedad sobre qué clave de cifrado de datos es apropiada para el cifrado/descifrado.

Advertencia

No elimines el índice único creado por getKeyVault(). Las operaciones de cifrado a nivel de campo del lado del cliente dependen de la unicidad ejecutada por el servidor de keyAltNames. Remover el índice puede causar un comportamiento inesperado o impredecible.

El siguiente ejemplo utiliza un KMS gestionado localmente para la configuración de cifrado a nivel de campo en el 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")

Crear 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

Utilice el constructor con las opciones de cifrado de campo del lado del cliente configuradas para crear una conexión a la base de datos. Reemplace Mongo() el mongodb://myMongo.example.net URI 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 para recuperar el objeto de cifrado del getClientEncryption() cliente:

clientEncryption = encryptedClient.getClientEncryption()

Obtén más información

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

ClientEncryption.decrypt

getKeyVault