Skip to content

Update documentation of encrypted field configuration. #4991

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Update documentation of encrypted field configuration. #4991

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a09630c
Resolve merge conflict in mongo-encryption.adoc.
ricardohsmello Jun 5, 2025
60107a8
Resolve merge conflict in mongo-encryption.adoc.
ricardohsmello Jun 5, 2025
ab1ab0c
Restore missing encryption config and switch 'pin' to string.
ricardohsmello Jun 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 11 additions & 13 deletions src/main/antora/modules/ROOT/pages/mongodb/mongo-encryption.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,11 +140,17 @@ Manual Collection Setup::
====
[source,java,indent=0,subs="verbatim,quotes",role="primary"]
----

BsonBinary pinDK = clientEncryption.createDataKey("local", new com.mongodb.client.model.vault.DataKeyOptions());
BsonBinary ssnDK = clientEncryption.createDataKey("local", new com.mongodb.client.model.vault.DataKeyOptions());
BsonBinary ageDK = clientEncryption.createDataKey("local", new com.mongodb.client.model.vault.DataKeyOptions());
BsonBinary signDK = clientEncryption.createDataKey("local", new com.mongodb.client.model.vault.DataKeyOptions());

CollectionOptions collectionOptions = CollectionOptions.encryptedCollection(options -> options
.queryable(encrypted(string("ssn")).algorithm("Indexed"), equality().contention(0))
.queryable(encrypted(int32("age")).algorithm("Range"), range().contention(8).min(0).max(150))
.encrypted(string("pin"))
.queryable(encrypted(int64("address.sign")).algorithm("Range"), range().contention(2).min(-10L).max(10L))
.encrypted(int32("pin"), pinDK)
.queryable(encrypted(string("ssn")).algorithm("Indexed").keyId(ssnDK.asUuid()), equality().contention(0))
.queryable(encrypted(int32("age")).algorithm("Range").keyId(ageDK.asUuid()), range().contention(8).min(0).max(150))
.queryable(encrypted(int64("address.sign")).algorithm("Range").keyId(signDK.asUuid()), range().contention(2).min(-10L).max(10L))
);

mongoTemplate.createCollection(Patient.class, collectionOptions); <1>
Expand All @@ -161,16 +167,13 @@ class Patient {

@Id String id;

@Encrypted(algorithm = "Indexed")
@Encrypted(algorithm = "Indexed") //
@Queryable(queryType = "equality", contentionFactor = 0)
String ssn;

@RangeEncrypted(contentionFactor = 8, rangeOptions = "{ 'min' : 0, 'max' : 150 }")
Integer age;

@Encrypted(algorithm = "Unindexed")
String pin;

Address address;
}

Expand Down Expand Up @@ -214,11 +217,6 @@ MongoDB Collection Info::
bsonType: 'int',
queries: [ { queryType: 'range', contention: Long('8'), min: 0, max: 150 } ]
},
{
keyId: ...,
path: 'pin',
bsonType: 'string'
},
{
keyId: ...,
path: 'address.sign',
Expand Down