Cifrado de campos y consultabilidad

Overview

En esta guía, puede aprender sobre los siguientes temas de cifrado consultable:

• Cómo especificar campos para el cifrado.

• Cómo especificar si un campo cifrado se puede consultar cuando se crea una colección.

• Tipos de consulta y cuáles puedes utilizar en campos cifrados.

• Qué tener en cuenta al decidir si habilitar consultas en un campo cifrado.

Especificar campos para el cifrado

El cifrado consultable le permite especificar qué campos desea cifrar automáticamente en su documento MongoDB.

Para especificar campos para cifrado y consulta, defina un esquema JSON que incluya las siguientes propiedades:

{
   "firstName": "Jon",
   "lastName": "Snow",
   "patientId": 12345187,
   "address": "123 Cherry Ave",
   "medications": [
      "Adderal",
      "Lipitor"
   ],
   "patientInfo": {
      "ssn": "921-12-1234",
      "billing": {
            "type": "visa",
            "number": "1234-1234-1234-1234"
      }
   }
}

const encryptedFieldsObject = {
   fields: [
      {
         path: "patientId",
         keyId: "<unique data encryption key>",
         bsonType: "int"
      },
      {
         path: "patientInfo.ssn",
         keyId: "<unique data encryption key>",
         bsonType: "string"
      },
      {
         path: "medications",
         keyId: "<unique data encryption key>",
         bsonType: "array"
      },
      {
         path: "patientInfo.billing",
         keyId: "<unique data encryption key>",
         bsonType: "object"
      },
   ]
}

Especificar campos cifrados consultables

Incluya la propiedad queries en los campos que desee que sean consultables en su esquema JSON. Esto permite que un cliente autorizado emita consultas de lectura y escritura utilizando campos cifrados. Puede omitir la propiedad queries a menos que desee poder consultar el campo.

const encryptedFieldsObject = {
   fields: [
      {
         path: "patientId",
         keyId: "<unique data encryption key>",
         bsonType: "int",
         queries: { queryType: "equality" }
      },
      {
         path: "patientInfo.ssn",
         keyId: "<unique data encryption key>",
         bsonType: "string",
         queries: { queryType: "equality" }
      },
      {
         path: "medications",
         keyId: "<unique data encryption key>",
         bsonType: "array"
      },
      {
         path: "patientInfo.billing",
         keyId: "<unique data encryption key>",
         bsonType: "object"
      },
   ]
}

Habilitar el cifrado consultable

Puede habilitar el cifrado consultable en los campos que especifique en un esquema JSON de las siguientes maneras:

• Pase el esquema JSON, representado por la constante encryptedFieldsObject, al cliente que la aplicación utiliza para crear la colección como se muestra en el siguiente fragmento de código:

const client = new MongoClient(uri, {
   autoEncryption: {
      keyVaultNameSpace: "<your keyvault namespace>",
      kmsProviders: "<your kms provider>",
      extraOptions: {
         cryptSharedLibPath: "<path to FLE Shared Library>"
      },
      encryptedFieldsMap: {
         "<databaseName.collectionName>": { encryptedFieldsObject }
      }
   }
   ...
   await client.db("<database name>").createCollection("<collection name>");
}

Para obtener más información sobre autoEncryption las opciones de configuración de, consulte la sección Opciones de MongoClient para cifrado consultable.

• Pase el objeto de campos cifrados a su llamada para crear una nueva colección como se muestra en el siguiente fragmento de código:

await encryptedDB.createCollection("<collection name>", {
   encryptedFields: encryptedFieldsObject
});

Tipos de consulta

El cifrado consultable le permite especificar en qué campos desea habilitar la consulta pasando un tipo de consulta a la opción queries en su objeto de campos cifrados.

El cifrado consultable actualmente admite los tipos de consulta none o equality. El nuevo marco de criptografía introducido como parte del cifrado consultable en MongoDB 6.0 está diseñado para admitir búsquedas cifradas expresivas adicionales, como operadores de rango y de cadena.

Un tipo de consulta none indica que los datos se cifrarán, pero no se prevé que sean consultables. No se pueden ejecutar consultas sobre datos cifrados con un tipo de consulta none. Se devolverán datos cifrados si las consultas se ejecutan sobre:

• campos no cifrados

• campos con un tipo de consulta de equality en la misma colección y descifrados en el cliente.

El tipo de consulta equality le permite consultar campos cifrados utilizando las siguientes expresiones:

• $eq

• $ne

• $in

• $nin

• $and

• $or

• $not

• $nor

• $expr

El cifrado consultable que utiliza el equality tipo de consulta no admite operaciones de lectura o escritura en un campo cuando la operación compara el campo cifrado con cualquiera de los siguientes tipos BSON:

• double

• decimal128

• object

• array

• javascriptWithScope (Obsoleto)

Consideraciones al habilitar la consulta

Al usar el cifrado consultable, puede elegir si desea que un campo cifrado sea consultable. Si no necesita realizar operaciones de lectura ni de escritura que requieran la lectura de un campo cifrado, puede optar por no habilitar las consultas en ese campo. Aun así, puede recuperar el documento completo consultando otros campos consultables o no cifrados.

Al habilitar la consulta de campos cifrados, el Cifrado Consultable crea un índice para cada campo cifrado, lo que puede aumentar la duración de las operaciones de escritura en dicho campo. Cuando una operación de escritura actualiza un campo indexado, MongoDB también actualiza el índice relacionado.

Al habilitar la consulta en un campo cifrado, su colección requiere más espacio de almacenamiento. Estos nombres de colección, que empiezan por enxcol_., contienen metadatos de cifrado importantes.