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
alcaeus
reviewed
May 7, 2025
| #[Encrypt] | ||
| ---------- | ||
|
|
||
| The `#[Encrypt]` attribute is used to define an encrypted field mapping for a document property. It allows you to configure fields for encryption and queryable encryption in MongoDB. |
There was a problem hiding this comment.
RST syntax requires two backticks for inline code:
Suggested change
| The `#[Encrypt]` attribute is used to define an encrypted field mapping for a document property. It allows you to configure fields for encryption and queryable encryption in MongoDB. | |
| The ``#[Encrypt]`` attribute is used to define an encrypted field mapping for a document property. It allows you to configure fields for encryption and queryable encryption in MongoDB. |
| public string $name; | ||
| } | ||
|
|
||
| For more details, refer to the MongoDB documentation on [Queryable Encryption](https://www.mongodb.com/docs/manual/core/queryable-encryption/fundamentals/encrypt-and-query/). |
There was a problem hiding this comment.
Wrong link syntax:
Suggested change
| For more details, refer to the MongoDB documentation on [Queryable Encryption](https://www.mongodb.com/docs/manual/core/queryable-encryption/fundamentals/encrypt-and-query/). | |
| For more details, refer to the MongoDB documentation on `Queryable Encryption <https://www.mongodb.com/docs/manual/core/queryable-encryption/fundamentals/encrypt-and-query/>`_. |
| @@ -16,7 +16,7 @@ | |||
| <xs:complexType> | |||
| <xs:choice minOccurs="0" maxOccurs="unbounded"> | |||
| <xs:element name="document" type="odm:document" minOccurs="0" maxOccurs="unbounded" /> | |||
| <xs:element name="embedded-document" type="odm:document" minOccurs="0" maxOccurs="unbounded" /> | |||
| <xs:element name="embedded-document" type="odm:embedded-document" minOccurs="0" maxOccurs="unbounded" /> | |||
There was a problem hiding this comment.
Noted that this change will disappear when #2766 is merged.
| @@ -225,6 +220,21 @@ public function getClient(): Client | |||
| return $this->client; | |||
| } | |||
|
|
|||
| public function getClientEncryption(): ClientEncryption | |||
There was a problem hiding this comment.
We may want to mark this method as internal:
Suggested change
| public function getClientEncryption(): ClientEncryption | |
| /** @internal **/ | |
| public function getClientEncryption(): ClientEncryption |
| * @param positive-int|null $contention | ||
| */ | ||
| public function __construct( | ||
| public ?string $queryType = null, |
There was a problem hiding this comment.
Would it make sense to use a backed enum for this?
| <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
|
|
||
| public function testCreateAndQueryEncryptedCollection(): void | ||
| { | ||
| // @todo skip if not using MongoDB < 7, single node or not enterprise |
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)