/ /

Métodos de cifrado a nivel de campo del lado del cliente

Esta versión de la documentación está archivada y ya no recibe soporte. Para actualizar su implementación 5.0, consulte Procedimientos de actualización de MongoDB.6.0

Nota

Para obtener detalles sobre un método específico, incluida la sintaxis y los ejemplos, haz clic en el enlace a la página de referencia del método.

El mongo Los métodos de cifrado a nivel de campo del cliente requieren una conexión a la base de datos con el cifrado a nivel de campo del cliente habilitado. Si la conexión a la base de datos actual no se inició con el cifrado a nivel de campo del cliente habilitado, puede ocurrir lo siguiente:

Utilice el Mongo() constructor del mongo shell para establecer una conexión con las opciones de cifrado de campo requeridas del lado del cliente. El método admite los siguientes proveedores de Servicios de Gestión de Claves (KMS) para la gestión de Mongo() la Clave Maestra del Cliente (CMK):
or
Utilice las opciones de línea mongo de comandos del shell 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.

Los siguientes métodos son para mongosh solamente. Para obtener instrucciones sobre cómo implementar el cifrado a nivel de campo del lado del cliente utilizando un controlador de MongoDB, consulta la documentación del controlador. Consulta la Tabla de compatibilidad de controladores para obtener una lista completa de controladores con soporte para el cifrado a nivel de campo del lado del cliente.

Nombre	Descripción
`getKeyVault()`	Devuelve el objeto del almacén de claves para la conexión actual de MongoDB.
`KeyVault.createKey()`	Crea una clave de cifrado de datos para su uso con el cifrado a nivel de campo del lado del cliente.
`KeyVault.deleteKey()`	Borra la llave de cifrado de datos especificada del almacén de claves.
`KeyVault.getKey()`	Recupera la clave de cifrado de datos especificada del almacén de claves.
`KeyVault.getKeys()`	Recupera todas las claves en el almacén de claves.
`KeyVault.addKeyAlternateName()`	Asocie un nombre alternativo de clave a la llave de cifrado de datos especificada.
`KeyVault.removeKeyAlternateName()`	Elimine un nombre alternativo de clave de la llave de cifrado de datos especificada.
`KeyVault.getKeyByAltName()`	Recupera las claves con el nombre alternativo de clave especificado.
`getClientEncryption()`	Devuelve el objeto de cifrado del cliente para admitir el cifrado/descifrado explícito de campos.
`ClientEncryption.encrypt()`	Cifra un campo utilizando una llave de cifrado de datos y un algoritmo de cifrado especificado.
`ClientEncryption.decrypt()`	Desencripta un campo utilizando la llave de cifrado de datos asociada y el algoritmo de cifrado.

Volver

Métodos Nativos en mongosh

ClientEncryption.encrypt