Instalar y configurar mongocryptd para Queryable Encryption

Overview

mongocryptd está instalado con MongoDB Enterprise Server (versión 4.2 y posteriores).

Al crear un cliente MongoDB habilitado para Queryable Encryption, el proceso mongocryptd se inicia automáticamente por defecto y maneja las siguientes responsabilidades:

• Utiliza las reglas automáticas de cifrado especificadas para marcar campos en operaciones de lectura y escritura para su cifrado.

• Evita que se ejecuten operaciones no permitidas en campos cifrados.

• Analiza el esquema de cifrado especificado para la conexión de la base de datos. Las reglas de cifrado automático utilizan un subconjunto estricto de la sintaxis del JSON schema. Si las reglas de cifrado automático contienen una sintaxis inválida de cifrado automático o cualquier sintaxis de validación de documentos, mongocryptd devuelve un error.

mongocryptd es responsable únicamente de las funciones anteriores, y no realiza ninguna de las siguientes:

• mongocryptd no realiza cifrado ni descifrado por sí mismo

• mongocryptd no accede a ningún material de llave de cifrado

• mongocryptd no escucha a través de la red

Los drivers compatibles con MongoDB 4.2 y posteriores utilizan la Biblioteca libmongocryptde Apache librería para realizar cifrado a nivel de campo del lado del cliente y descifrado automático.

Los drivers oficiales compatibles con MongoDB 4.2+, mongosh, y el shell heredado 4.2 o posterior mongo requieren acceso al proceso mongocryptd en la máquina host del cliente. Estos clientes buscan el proceso mongocryptd en la ruta del sistema por defecto.

Instalación

Para los sistemas operativos Linux compatibles, instala el paquete del servidor siguiendo el tutorial de instalación en Linux , sigue las instrucciones de instalación documentadas e instala el paquete de servidores mongodb-enterprise. Alternativamente, especifique mongodb-enterprise-cryptd en su lugar para instalar solo el binario mongocryptd. El gestor de paquetes instala los binarios en una ubicación del PATH del sistema (por ejemplo, /usr/bin/)

Para OSX, instala el paquete del servidor siguiendo el tutorial de instalación en MacOS. El gestor de paquetes instala los binarios en una ubicación en la ruta del sistema.

Para Windows, instala el paquete del servidor siguiendo el tutorial de instalación en Windows. Debes agregar el paquete mongocryptd al PATH de tu sistema después de la instalación. Consulta las mejores prácticas documentadas para tu instalación de Windows para obtener instrucciones sobre cómo agregar el archivo binario mongocryptd a la variable PATH del sistema.

Para instalaciones a través de un fichero comprimido oficial o un fichero ZIP, siga las mejores prácticas documentadas para su sistema operativo para agregar el binario mongocryptd al PATH de su sistema.

Configuración

Si el controlador compatible con la versión 4.2+ tiene acceso al proceso mongocryptd, por defecto, el controlador gestiona la creación del proceso mongocryptd.

Puedes configurar cómo tu driver inicia mongocryptd mediante los siguientes parámetros:

var extraOptions = new Dictionary<string, object>()
{
    { "mongocryptdSpawnArgs", new [] { "--port=30000" } },
};
autoEncryptionOptions.With(extraOptions: extraOptions);

var extraOptions = new Dictionary<string, object>()
{
    { "idleShutdownTimeoutSecs", 60 },
};
autoEncryptionOptions.With(extraOptions: extraOptions);

extraOptions := map[string]interface{}{
    "mongocryptdSpawnArgs": []string{
        "--port=30000",
    },
}

extraOptions := map[string]interface{}{
    "mongocryptdSpawnArgs": []string{
        "--idleShutdownTimeoutSecs=75",
    },
}

List<String> spawnArgs = new ArrayList<String>();
spawnArgs.add("--port=30000");
Map<String, Object> extraOpts = new HashMap<String, Object>();
extraOpts.put("mongocryptdSpawnArgs", spawnArgs);
AutoEncryptionSettings autoEncryptionSettings = AutoEncryptionSettings.builder()
    ...
    .extraOptions(extraOpts);

List<String> spawnArgs = new ArrayList<String>();
spawnArgs.add("--idleShutdownTimeoutSecs")
    .add("60");
Map<String, Object> extraOpts = new HashMap<String, Object>();
extraOpts.put("mongocryptdSpawnArgs", spawnArgs);
AutoEncryptionSettings autoEncryptionSettings = AutoEncryptionSettings.builder()
    ...
    .extraOptions(extraOpts);

autoEncryption: {
  ...
  extraOptions: {
    mongocryptdSpawnArgs: ["--port", "30000"],
    mongocryptdURI: 'mongodb://localhost:30000',
  }

autoEncryption: {
  ...
  extraOptions: {
    mongocryptdSpawnArgs: ["--idleShutdownTimeoutSecs", "75"]
  }

auto_encryption_opts = AutoEncryptionOpts(mongocryptd_spawn_args=['--port=30000'])

auto_encryption_opts = AutoEncryptionOpts(mongocryptd_spawn_args=['--idleShutdownTimeoutSecs=75'])