Acerca de esta tarea
Para que los campos cifrados sean consultables, cree un Esquema de cifrado. Este esquema define qué campos se pueden consultar y qué tipos de consultas están permitidos. Para obtener más información, consulta Campos cifrados y consultas habilitadas.
Importante
Queryable Encryption admite queries de igualdad y de rango. Solo puedes configurar un campo para un tipo de query.
Antes de comenzar
Cuando hagas que los campos cifrados sean consultables, considera el rendimiento y la seguridad. Para obtener detalles sobre cómo cada opción de configuración afecta a estos, consulta Configura los campos cifrados para una búsqueda y almacenamiento óptimos.
Para utilizar los prefijos, sufijos o consultas de query de Public Preview con
mongosh, debe descargar por separado la biblioteca compartida de cifrado automático 8.2 o superior, luego especificar la ruta de la biblioteca a mongosh usando la opción --cryptSharedLibPath.
Referencia de campo
Puedes configurar el cifrado para cada campo en el arreglo fields de tu encryptedFieldsObject. La siguiente tabla describe los subcampos disponibles:
Campo | Tipo | Descripción |
|---|---|---|
| String | Obligatorio. La ruta en notación de puntos al campo |
| String | Obligatorio. El tipo BSON del campo que se va cifrar. Para obtener una lista completa de los tipos admitidos, consulte BSON types admitidos y no admitidos. |
| UUID | Opcional. El UUID del DEK a utilizar para encriptar este campo. El UUID es un BSON datos binarios elemento del subtipo Los ID de clave deben ser únicos. Especificar un Si se omite, puedes utilizar el método asistente |
| Objeto | opcional. Permite consultas sobre este campo cifrado. Si se omite, el campo se cifra pero no se puede consultar. Para obtener más información sobre las opciones de query, consulta Configura campos cifrados para una búsqueda y almacenamiento óptimos. |
Pasos
Especifica los campos a cifrar.
Agregue las cadenas
pathybsonTypea un documento dentro del arreglo de campos:const encryptedFieldsObject = { fields: [ { path: "myDocumentField", bsonType: "int" } ] } Importante
Puedes especificar cualquier campo para el cifrado excepto el campo
_id.Opcionalmente, establece un campo
keyIdcon el ID DEK.Importante
Los ID de clave deben ser únicos, de lo contrario, el servidor devuelve un error.
Al configurar
AutoEncryptionSettingsen el cliente, puedes utilizar el método asistentecreateEncryptedCollectionpara crear claves automáticamente.{ path: "myDocumentField", bsonType: "int", keyId: "<unique data encryption key>" }
Habilitar consultas de rango en los campos deseados.
Esto permite realizar consultas con los $lt $lte$gtoperadores,,$gte y.
Para obtener detalles sobre cómo las siguientes opciones afectan la seguridad y el rendimiento, consulte Configurar campos cifrados para una búsqueda y almacenamiento óptimos.
Agregue el objeto
queriesy establezcaqueryTypeen"range":{ path: "myDocumentRangeField", bsonType: "int", queries: { queryType: "range" } } Configura los siguientes campos:
CampoTipoDescripciónIgual que campo
bsonTypeObligatorio si
bsonTypeesdecimalodouble. Opcional pero muy recomendable si esint,longodate. Por defecto, se establecen en los valores mínimos y máximos delbsonType.Cuando sea posible, especificar límites en una query mejora el rendimiento. Si consulta valores fuera de estos límites inclusivos, MongoDB devuelve un error.
{ path: "myDocumentRangeField", bsonType: "int", queries: { queryType: "range", min: 0, max: 1200 } }
Activa las consultas de prefijos, sufijos o subcadenas en los campos deseados.
Estos tipos de consulta son solo para los campos string. Puede habilitar prefixPreview y suffixPreview en el mismo campo, pero no podrá habilitar ninguno si usa substringPreview.
Advertencia
Las consultas de prefijos, sufijos y subcadenas están en vista previa pública
Las búsquedas por prefijo, sufijo y subcadena de Queryable Encryption ya están disponibles en la vista previa pública en MongoDB 8.2. No habilite estos tipos de query en producción. La funcionalidad de la vista previa pública será incompatible con la funcionalidad GA, y deberá descartar cualquier colección que permita estas queries.
prefixPreviewlas consultas habilitan las expresiones de agregación de$encStrStartsWithy$encStrNormalizedEq.suffixPreviewlas consultas habilitan las expresiones de agregación de$encStrEndsWithy$encStrNormalizedEq.substringPreviewlas consultas habilitan las expresiones de agregación de$encStrContainsy$encStrNormalizedEq.
Agrega el objeto
queriesy definequeryTypecomo"prefixPreview","suffixPreview"o"substringPreview":{ path: "myDocumentStringField", bsonType: "string", queries: { queryType: "substringPreview" } } Configura los siguientes campos.
Para obtener detalles sobre cómo afectan la seguridad y el rendimiento, consulta Configurar campos cifrados para búsqueda y almacenamiento óptimos.
CampoTipoDescripciónentero
substringPreviewsolo queries. La longitud máxima permitida para un campo indexado por subcadena.entero
La longitud mínima permitida de prefijo/sufijo/subcadena para query.
entero
La longitud máxima permitida de prefijo/sufijo/subcadena para query.
IMPORTANTE: Este ajuste tiene un gran impacto en el rendimiento de las query. Limítalo siempre que sea posible.
Booleano
opcional. Si las consultas distinguen entre mayúsculas y minúsculas. Por defecto
true.Booleano
opcional. Si las búsquedas son sensibles a los signos diacríticos. Por defecto
true.{ path: "myDocumentStringField", bsonType: "string", queries: { "queryType": "substringPreview", "strMaxLength": 30, "strMinQueryLength": 1, "strMaxQueryLength": 20, "caseSensitive": false } }
Ejemplo
Este ejemplo muestra cómo crear un esquema de cifrado para datos hospitalarios.
Considere el siguiente documento que contiene información de identificación personal (PII), información de tarjetas de crédito e información médica confidencial:
{ "firstName": "Jon", "lastName": "Snow", "patientId": 12345187, "address": "123 Cherry Ave", "medications": [ "Adderall", "Lipitor" ], "patientInfo": { "ssn": "921-12-1234", "billing": { "type": "visa", "number": "1234-1234-1234-1234" } } }
Para garantizar que la información médica confidencial y los datos personales identificables permanezcan seguros, este esquema de cifrado añade los campos relevantes:
const encryptedFieldsObject = { fields: [ { path: "patientId", bsonType: "int" }, { path: "patientInfo.ssn", bsonType: "string" }, { path: "medications", bsonType: "array" }, { path: "patientInfo.billing", bsonType: "object" } ] }
Añadir la propiedad queries hace que los campos patientId y patientInfo.ssn sean consultables. Este ejemplo permite consultas de igualdad:
const encryptedFieldsObject = { fields: [ { path: "patientId", bsonType: "int", queries: { queryType: "equality" } }, { path: "patientInfo.ssn", bsonType: "string", queries: { queryType: "equality" } }, { path: "medications", bsonType: "array" }, { path: "patientInfo.billing", bsonType: "object" }, ] }