Criar um esquema de criptografia

Crie o esquema de criptografia.

Inclua um encryptedFieldsObject com uma array fields aninhada:

const encryptedFieldsObject = {
   fields: []
}

Especifique os campos a serem criptografados.

1. Adicione as strings path e bsonType a um documento dentro da array de campos:

   const encryptedFieldsObject = {
      fields: [
         {
            path: "myDocumentField",
            bsonType: "int"
         }
      ]
   }

   Importante

   Você pode especificar qualquer campo de criptografia, exceto o campo _id.

2. Opcionalmente, defina um campo keyId com a ID da DEK.

   Importante

   Os IDs de chave devem ser exclusivos, caso contrário, o servidor retornará um erro.

   Ao configurar AutoEncryptionSettings no cliente, você pode usar o método assistente createEncryptedCollection para criar chaves automaticamente.

   {
      path: "myDocumentField",
      bsonType: "int",
      keyId: "<unique data encryption key>"
   }

Habilite as queries de igualdade nos campos desejados.

Isso permite executar queries com os operadores $eq, $ne, $in e $nin .

Adicione o objeto queries e defina queryType como "equality":

{
   path: "myDocumentField",
   bsonType: "int",
   queries: { queryType: "equality" }
}

Habilite as queries de intervalo nos campos desejados.

Isso permite executar queries com os operadores $lt, $lte, $gt e $gte .

Para obter detalhes sobre como as seguintes opções afetam a segurança e o desempenho, consulte Configurar campos criptografados para otimização de pesquisa e armazenamento.

1. Adicione o objeto queries e defina queryType como "range":

   {
      path: "myDocumentRangeField",
      bsonType: "int",
      queries: { queryType: "range" }
   }

2. Defina os seguintes campos:

   Campo	Tipo	Descrição
   min e max	Igual ao campo bsonType	Obrigatório se bsonType for decimal ou double. Opcional, mas altamente recomendado se for int, long ou date. O padrão é os valores mínimo e máximo de bsonType. Quando possível, especificar limites em uma query melhora o desempenho. Se estiver consultando valores fora desses limites inclusivos, o MongoDB retornará um erro.

   {
      path: "myDocumentRangeField",
      bsonType: "int",
      queries: { queryType: "range",
                 min: 0,
                 max: 1200
      }
   }

Ative queries de prefixo, sufixo ou substring nos campos desejados.

Esses tipos de query são somente para campos string. Você pode habilitar prefixPreview e suffixPreview no mesmo campo, mas não pode habilitar nenhum dos dois se estiver usando substringPreview.

• prefixPreview as queries habilitam as expressões de agregação $encStrStartsWith e $encStrNormalizedEq.

• suffixPreview as queries habilitam as expressões de agregação $encStrEndsWith e $encStrNormalizedEq.

• substringPreview as queries habilitam as expressões de agregação $encStrContains e $encStrNormalizedEq.

1. Adicione o objeto queries e defina queryType para "prefixPreview", "suffixPreview" ou "substringPreview":

   {
      path: "myDocumentStringField",
      bsonType: "string",
      queries: { queryType: "substringPreview" }
   }

2. Defina os seguintes campos.

   Para obter detalhes sobre como eles afetam a segurança e o desempenho, consulte Configurar campos criptografados para otimização de pesquisa e armazenamento.

   Campo	Tipo	Descrição
   strMaxLength	inteiro	substringPreview apenas consultas. O comprimento máximo permitido para um campo indexado por substring.
   strMinQueryLength	inteiro	O comprimento mínimo de prefixo/sufixo/substring permitido para query.
   strMaxQueryLength	inteiro	O comprimento máximo de prefixo/sufixo/substring permitido para query. IMPORTANTE: esta configuração afeta fortemente o desempenho da query. Limite-o sempre que possível.
   caseSensitive	Boolean	Opcional. Se as queries diferenciam maiúsculas de minúsculas. Padrão é true.
   diacriticSensitive	Boolean	Opcional. Se as queries são sensíveis a diacríticos. Padrão é true.

   {
      path: "myDocumentStringField",
      bsonType: "string",
      queries: {
         "queryType": "substringPreview",
         "strMaxLength": 30,
         "strMinQueryLength": 1,
         "strMaxQueryLength": 20,
         "caseSensitive": false
      }
   }