Add support for Field-Level Automatic and Queryable Encryption #2759
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GromNaN
force-pushed
the
fle
branch
2 times, most recently
from
a6ec9ed to
81f3e90
Compare
alcaeus
reviewed
May 7, 2025
| <xs:element name="field" type="odm:field" minOccurs="0" maxOccurs="unbounded" /> | ||
| <xs:element name="embed-one" type="odm:embed-one" minOccurs="0" maxOccurs="unbounded" /> | ||
| <xs:element name="embed-many" type="odm:embed-many" minOccurs="0" maxOccurs="unbounded" /> | ||
| <xs:element name="encrypt" type="odm:encrypt-field" minOccurs="0" maxOccurs="1" /> |
There was a problem hiding this comment.
Why is this an element instead of an attribute? Is it to future-proof this in case there will be options for encrypting entire documents in future?
There was a problem hiding this comment.
Yes, I plan to add a "key" attribute to the element.
| $this->dm->getClientEncryption(), | ||
| $this->dm->getConfiguration()->getKmsProvider(), | ||
| null, // @todo when is it necessary to set the master key? | ||
| $options, |
There was a problem hiding this comment.
Should you be using $this->getWriteOptions here like below and add the encrypted field config?
GromNaN
commented
May 7, 2025
GromNaN
force-pushed
the
fle
branch
2 times, most recently
from
0fc420d to
34a9d06
Compare
GromNaN
commented
May 22, 2025
Comment on lines
+322
to
+328
| 'min', 'max' => match ($mapping['type']) { | ||
| Type::INT => (int) $encryptValue, | ||
| Type::FLOAT => (float) $encryptValue, | ||
| Type::DECIMAL128 => new Decimal128((string) $encryptValue), | ||
| Type::DATE, Type::DATE_IMMUTABLE => new UTCDateTime(new DateTimeImmutable((string) $encryptValue)), | ||
| default => null, // Invalid | ||
| }, |
There was a problem hiding this comment.
I've added the transformation of values from string to native BSON types here; should use the Type::convertToDatabaseValue() inside EncryptionFieldMap.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Implementation:
#[Encrypt]attribute with field encryption options.autoEncryptionconfiguration with options to create an encryption client (MongoDB collection that stores encryption keys for each field)The encrypted collection must be created using the schema manager (
odm:schema:createcommand)