getClientEncryption()

Esta versión de la documentación se archivó y ya no se admite. Para actualizar tu implementación de 5.0, consulta el Procedimientos de actualización de MongoDB.6.0

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 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 constructor Mongo() desde la mongo shell para establecer una conexión con las opciones de cifrado a nivel de campo del lado del cliente requeridas. El método Mongo() admite los siguientes proveedores de Key Management Service (KMS) para la gestión de la llave maestra de cliente (llave maestra de cliente):
or
Utiliza las mongo opciones de línea de comandos del shell para establecer una conexión con las opciones requeridas. Las opciones de línea de comandos solo son compatibles con el proveedor de Amazon Web Services KMS para la gestión de 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 en el lado del cliente dependen de la unicidad de keyAltNames impuesta por el servidor. Remover el índice podría provocar 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.

Para configurar el cifrado a nivel de campo del lado del cliente para una clave administrada localmente, se requiere especificar una cadena de 96 bytes codificada en base64 sin saltos de línea. La siguiente operación genera una clave que cumple los requisitos indicados y la carga en el shell:mongo

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)
    }
  }
}

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