Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-12732

Docs for SERVER-40477: mongocryptd should error when to-be-encrypted element's type does not match schema

    XMLWordPrintable

Details

    Description

      Description

      Description:

      See the query feature support document for FLE: https://docs.google.com/document/d/1r8jB7qr25UPW76-EFyR7DQsZ2ApPcRxGTRrFpBErsa4/edit. I'd be happy to answer or questions or take docs CRs.

      Engineering Ticket Description:

      In order to ensure that the FLE system works transparently for equality predicates against encrypted fields, we must implement the following constraints:

      • Any field encrypted with the deterministic algorithm must specify exactly one BSON type. This was implemented under SERVER-40627.
      • Queries can only contain equality predicates against encrypted an encrypted field if the field is encrypted with the deterministic algorithm. This was implemented under SERVER-40378.
      • The BSON type of the constant for an equality predicate must match the BSON type specified in the JSON Schema. Implementing this final constraint is the work tracked by this ticket.

      Taken together, these restrictions prevent a situation where users can issue a query against an encrypted field such as {ssn: {$eq: NumberInt(12345678)}} and expect matches where ssn can be any of the types {int, long, double, decimal}. One cannot build an application using FLE which queries mixed-type encrypted fields. Instead, when using deterministic encryption to ensure queryability, users must define a schema which names exactly one type for the encrypted field. Furthermore, they must write the query so that any constant in an equality predicate against the encrypted field has matching type. For instance, if a user creates a schema specifying that ssn is deterministically encrypted int, they may not run an equality query such as {ssn: {$eq: NumberLong(12345678)}}, since "long" is not the type specified in the schema.

      Original description

      BSONElement equality semantics involve a logical comparison function rather than byte-wise equality. Therefore, two equal BSONElements may result in unequal ciphertext after encryption, even with the "Deterministic" encryption algorithm. If we want FLE equality to work transparently, the client should encrypt a KeyString encoding. Decryption would similarly be a two-step process in which we decrypt and then decode the KeyString.

      The simplest example of this is integers of different types. The integer 42 can be BSON-encoded as either a NumberDouble, NumberInt, or NumberLong. The actual bytes inside the BSONElement are different for all three cases, yet all three are considered equal.

      Scope of changes

      Impact to Other Docs

      MVP (Work and Date)

      Resources (Scope or Design Docs, Invision, etc.)

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              kay.kim@mongodb.com Kay Kim (Inactive)
              Ravind Kumar Ravind Kumar (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:
                2 years, 51 weeks, 3 days ago