Cifrado de campos y consultabilidad

Overview

En esta guía, puedes aprender sobre los siguientes temas de Queryable Encryption:

• Cómo especificar los campos para el cifrado.

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

• Tipos de query y cuáles puede utilizar en campos cifrados.

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

Especifique los campos para el cifrado

La Cifrado Consultable permite especificar qué campos se desea cifrar automáticamente en el documento MongoDB.

Para especificar campos para cifrado y consulta, defina un JSON schema 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

Incluye la propiedad queries en los campos que deseas que sean consultables en tu JSON schema. Esto permite que un cliente autorizado emita queries de lectura y guardar utilizando campos cifrados. Puede omitir la propiedad queries a menos que quiera 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 Queryable Encryption

Puedes habilitar la encriptación Queryable en los campos que especifiques en un esquema JSON de las siguientes maneras:

• Pase el JSON schema, representado por la constante encryptedFieldsObject, al cliente que utiliza la aplicación para crear la colección, como se muestra en el siguiente snippet:

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 las opciones de configuración de autoEncryption, consulte la sección Opciones MongoClient para Queryable Encryption.

• Pasa el objeto de campos cifrados a tu llamada para crear una nueva colección, como se muestra en el siguiente snippet:

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

Tipos de consulta

El cifrado consultable (Queryable Encryption) permite especificar en qué campos se puede habilitar la interrogación al proporcionar un tipo de query en la opción queries del objeto de campos cifrados.

Queryable Encryption actualmente admite los tipos de consultas none o equality. El nuevo marco de criptografía, introducido como parte de Queryable Encryption en MongoDB 6.0, está diseñado para adaptarse a búsquedas cifradas expresivas adicionales, como operadores de rango y de string.

Un tipo de consulta de none indica que los datos serán cifrados, pero no está previsto que sean consultables. No se pueden ejecutar queries sobre datos cifrados con un tipo de query none. Se devolverán datos cifrados si se ejecutan queries en:

• campos no cifrados

• campos con un tipo de query 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

Cuando utilizas Queryable Encryption, puedes decidir si hacer que un campo encriptado sea consultable. Si no necesita realizar operaciones de lectura o de escritura que requieran leer un campo cifrado, puede decidir no habilitar las consultas en ese campo. Aún puedes recuperar todo el documento consultando otros campos que sean consultables o no estén 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.

Cuando habilitas las consultas sobre un campo cifrado, tu colección requiere más espacio de almacenamiento. Estos nombres de colecciones, que comienzan con enxcol_., contienen metadatos de cifrado importantes.