getClientEncryption()Devuelve el objeto
ClientEncryptionde la colección de bases de datos actual. El objetoClientEncryptionadmite el cifrado y descifrado explícito (manual) de valores de campo para Cifrado a nivel de campo del lado del cliente.Devuelve: El objeto ClientEncryptionpara la conexión de base de datos actual.
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();
Utilice el objeto ClientEncryption para acceder a los siguientes métodos de cifrado explícito:
Comportamiento
Habilitar el cifrado a nivel de campo del lado del cliente en la conexión a la base de datos
Los métodos de cifrado de campo del lado del cliente requieren una conexión a la base de datos con el cifrado de campo del lado del cliente habilitado. Si la conexión actual a la base de datos no se inició con el cifrado de campo del lado del cliente habilitado, puede ocurrir lo mongo siguiente:
Utilice el
Mongo()constructor delmongoshell 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 deMongo()la Clave Maestra del Cliente (CMK):or
Utilice las opciones de línea
mongode 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.
Ejemplo
El método getKeyVault() crea automáticamente un índice único en el keyAltNames campo con un filtro de índice parcial solo para los documentos donde keyAltNames existe. crea este índice en la colección del almacén de claves. 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 la adecuada para elgetKeyVault() cifrado/descifrado.
Advertencia
No elimine el índice único creado getKeyVault() por. Las operaciones de cifrado a nivel de campo del cliente dependen de la unicidad de impuesta por keyAltNames el servidor. Eliminar el índice puede provocar un comportamiento inesperado o impredecible.
El siguiente ejemplo utiliza un KMS administrado localmente para la configuración de cifrado a nivel de campo del lado del cliente.
Para configurar el cifrado a nivel de campo del lado del64 96cliente para una clave administrada localmente, se requiere mongo especificar una cadena de bytes codificada en base sin saltos de línea. La siguiente operación genera una clave que cumple los requisitos indicados y la carga en el shell:
TEST_LOCAL_KEY=$(echo "$(head -c 96 /dev/urandom | base64 | tr -d '\n')") mongosh --nodb --shell --eval "var TEST_LOCAL_KEY='$TEST_LOCAL_KEY'"
Cree el objeto de cifrado a nivel de campo lado del cliente mediante el string de clave local generado:
var ClientSideFieldLevelEncryptionOptions = { "keyVaultNamespace" : "encryption.__dataKeys", "kmsProviders" : { "local" : { "key" : BinData(0, TEST_LOCAL_KEY) } } }
Utilice el constructor para crear una conexión de base de datos con las opciones de cifrado de campo del lado del Mongo() cliente.mongodb://myMongo.example.net Reemplace el URI por el URI de la cadena de conexión del clúster de destino.
encryptedClient = Mongo( "mongodb://myMongo.example.net:27017/?replSetName=myMongo", ClientSideFieldLevelEncryptionOptions )
Utilice el método para recuperar el objeto de cifrado del getClientEncryption() cliente:
clientEncryption = encryptedClient.getClientEncryption()
Para obtener documentación completa sobre cómo iniciar conexiones MongoDB con el cifrado de nivel de campo del lado del cliente habilitado,Mongo() consulte.