Skip to content

Commit d2c3e39

Browse files
Adding updated readers for KMIP CSFLE (#1721)
* adding updated readers for KMIP CSFLE * cleanup * feedback * unused spacing * updated casing on java paths * renaming java files * Revert "renaming java files" This reverts commit 1028299baa2505c523c285b3479d6b5dff656f88. * Delete insertEncryptedDocument.java * Delete makeDataKey.java * Delete insertEncryptedDocument.java * Delete makeDataKey.java * Delete insertEncryptedDocument.java * Delete makeDataKey.java * Delete makeDataKey.java * Delete insertEncryptedDocument.java * Delete makeDataKey.java * testing rename changes * node-csfle fix
1 parent 64fe449 commit d2c3e39

File tree

77 files changed

+1837
-170
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+1837
-170
lines changed

source/core/csfle/quick-start.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Procedure
112112
:tabid: java-sync
113113

114114
To view the complete code for making a {+dek-long+}, see
115-
`our Github repository <{+sample-app-url-csfle+}/java/local/reader/src/main/java/com/mongodb/csfle/makeDataKey.java>`__.
115+
`our Github repository <{+sample-app-url-csfle+}/java/local/reader/src/main/java/com/mongodb/csfle/MakeDataKey.java>`__.
116116

117117
.. tab::
118118
:tabid: nodejs
@@ -154,7 +154,7 @@ Procedure
154154
:tabid: java-sync
155155

156156
To view the complete code for inserting an encrypted document, see
157-
`our Github repository <{+sample-app-url-csfle+}/java/local/reader/src/main/java/com/mongodb/csfle/insertEncryptedDocument.java>`__.
157+
`our Github repository <{+sample-app-url-csfle+}/java/local/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
158158

159159
.. tab::
160160
:tabid: nodejs
@@ -192,7 +192,7 @@ Procedure
192192
:tabid: java-sync
193193

194194
To view the complete code for finding an encrypted document, see
195-
`our Github repository <{+sample-app-url-csfle+}/java/local/reader/src/main/java/com/mongodb/csfle/insertEncryptedDocument.java>`__.
195+
`our Github repository <{+sample-app-url-csfle+}/java/local/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
196196

197197
.. tab::
198198
:tabid: nodejs

source/core/csfle/tutorials/aws/aws-automatic.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Create the Application
107107
:tabid: java-sync
108108

109109
To view the complete code for making a {+dek-long+}, see
110-
`our Github repository <{+sample-app-url-csfle+}/java/aws/reader/src/main/java/com/mongodb/csfle/makeDataKey.java>`__.
110+
`our Github repository <{+sample-app-url-csfle+}/java/aws/reader/src/main/java/com/mongodb/csfle/MakeDataKey.java>`__.
111111

112112
.. tab::
113113
:tabid: nodejs
@@ -149,7 +149,7 @@ Create the Application
149149
:tabid: java-sync
150150

151151
To view the complete code for inserting an encrypted document, see
152-
`our Github repository <{+sample-app-url-csfle+}/java/aws/reader/src/main/java/com/mongodb/csfle/insertEncryptedDocument.java>`__.
152+
`our Github repository <{+sample-app-url-csfle+}/java/aws/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
153153

154154
.. tab::
155155
:tabid: nodejs
@@ -187,7 +187,7 @@ Create the Application
187187
:tabid: java-sync
188188

189189
To view the complete code for finding an encrypted document, see
190-
`our Github repository <{+sample-app-url-csfle+}/java/aws/reader/src/main/java/com/mongodb/csfle/insertEncryptedDocument.java>`__.
190+
`our Github repository <{+sample-app-url-csfle+}/java/aws/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
191191

192192
.. tab::
193193
:tabid: nodejs

source/core/csfle/tutorials/azure/azure-automatic.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Create the Application
105105
:tabid: java-sync
106106

107107
To view the complete code for making a {+dek-long+}, see
108-
`our Github repository <{+sample-app-url-csfle+}/java/azure/reader/src/main/java/com/mongodb/csfle/makeDataKey.java>`__.
108+
`our Github repository <{+sample-app-url-csfle+}/java/azure/reader/src/main/java/com/mongodb/csfle/MakeDataKey.java>`__.
109109

110110
.. tab::
111111
:tabid: nodejs
@@ -147,7 +147,7 @@ Create the Application
147147
:tabid: java-sync
148148

149149
To view the complete code for inserting an encrypted document, see
150-
`our Github repository <{+sample-app-url-csfle+}/java/azure/reader/src/main/java/com/mongodb/csfle/insertEncryptedDocument.java>`__.
150+
`our Github repository <{+sample-app-url-csfle+}/java/azure/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
151151

152152
.. tab::
153153
:tabid: nodejs
@@ -185,7 +185,7 @@ Create the Application
185185
:tabid: java-sync
186186

187187
To view the complete code for finding an encrypted document, see
188-
`our Github repository <{+sample-app-url-csfle+}/java/azure/reader/src/main/java/com/mongodb/csfle/insertEncryptedDocument.java>`__.
188+
`our Github repository <{+sample-app-url-csfle+}/java/azure/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
189189

190190
.. tab::
191191
:tabid: nodejs

source/core/csfle/tutorials/gcp/gcp-automatic.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ your application to see relevant code samples.
108108
:tabid: java-sync
109109

110110
To view the complete code for making a {+dek-long+}, see
111-
`our Github repository <{+sample-app-url-csfle+}/java/gcp/reader/src/main/java/com/mongodb/csfle/makeDataKey.java>`__.
111+
`our Github repository <{+sample-app-url-csfle+}/java/gcp/reader/src/main/java/com/mongodb/csfle/MakeDataKey.java>`__.
112112

113113
.. tab::
114114
:tabid: nodejs
@@ -150,7 +150,7 @@ your application to see relevant code samples.
150150
:tabid: java-sync
151151

152152
To view the complete code for inserting an encrypted document, see
153-
`our Github repository <{+sample-app-url-csfle+}/java/gcp/reader/src/main/java/com/mongodb/csfle/insertEncryptedDocument.java>`__.
153+
`our Github repository <{+sample-app-url-csfle+}/java/gcp/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
154154

155155
.. tab::
156156
:tabid: nodejs
@@ -188,7 +188,7 @@ your application to see relevant code samples.
188188
:tabid: java-sync
189189

190190
To view the complete code for finding an encrypted document, see
191-
`our Github repository <{+sample-app-url-csfle+}/java/gcp/reader/src/main/java/com/mongodb/csfle/insertEncryptedDocument.java>`__.
191+
`our Github repository <{+sample-app-url-csfle+}/java/gcp/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
192192

193193
.. tab::
194194
:tabid: nodejs

source/includes/generated/in-use-encryption/csfle/dotnet/aws/reader/CSFLE/InsertEncryptedDocument.cs

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public static void Insert()
1818
// end-key-vault
1919
var coll = "patients";
2020
var db = "medicalRecords";
21-
var db_namespace = $"{db}.{coll}";
21+
var dbNamespace = $"{db}.{coll}";
2222

2323
// start-kmsproviders
2424
var kmsProviders = new Dictionary<string, IReadOnlyDictionary<string, object>>();
@@ -108,9 +108,10 @@ public static void Insert()
108108
}
109109
};
110110
var schemaMap = new Dictionary<string, BsonDocument>();
111-
schemaMap.Add(db_namespace, schema);
111+
schemaMap.Add(dbNamespace, schema);
112112
// end-schema
113113

114+
114115
// start-extra-options
115116
var mongoBinariesPath = "<Path to mongocryptd binary>";
116117
var extraOptions = new Dictionary<string, object>()
@@ -129,7 +130,8 @@ public static void Insert()
129130
keyVaultNamespace: keyVaultNamespace,
130131
kmsProviders: kmsProviders,
131132
schemaMap: schemaMap,
132-
extraOptions: extraOptions);
133+
extraOptions: extraOptions
134+
);
133135
clientSettings.AutoEncryptionOptions = autoEncryptionOptions;
134136
var secureClient = new MongoClient(clientSettings);
135137
// end-client
@@ -167,9 +169,10 @@ public static void Insert()
167169
var filter = Builders<BsonDocument>.Filter.Eq("name", "Jon Doe");
168170
var regularResult = regularCollection.Find(filter).Limit(1).ToList()[0];
169171
Console.WriteLine($"\n{regularResult}\n");
172+
170173
Console.WriteLine("Finding a document with encrypted client, searching on an encrypted field");
171174
var ssnFilter = Builders<BsonDocument>.Filter.Eq("ssn", 145014000);
172-
var secureResult = secureCollection.Find(ssnFilter).Limit(1).ToList()[0];
175+
var secureResult = secureCollection.Find(ssnFilter).Limit(1).First();
173176
Console.WriteLine($"\n{secureResult}\n");
174177
// end-find
175178
}

source/includes/generated/in-use-encryption/csfle/dotnet/aws/reader/CSFLE/MakeDataKey.cs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,8 @@ public static void MakeKey()
3434
{ "key", "<Your AWS Key ARN>" },
3535
});
3636
// end-datakeyopts
37-
3837
// start-create-index
3938
var connectionString = "<Your MongoDB URI>";
40-
// start-create-dek
4139
var keyVaultNamespace = CollectionNamespace.FromFullName("encryption.__keyVault");
4240
var keyVaultClient = new MongoClient(connectionString);
4341
var indexOptions = new CreateIndexOptions<BsonDocument>();
@@ -49,19 +47,22 @@ public static void MakeKey()
4947
var keyVaultDatabase = keyVaultClient.GetDatabase(keyVaultNamespace.DatabaseNamespace.ToString());
5048
// Drop the Key Vault Collection in case you created this collection
5149
// in a previous run of this application.
52-
keyVaultDatabase.DropCollection(keyVaultNamespace.CollectionName.ToString());
50+
keyVaultDatabase.DropCollection(keyVaultNamespace.CollectionName);
5351
// Drop the database storing your encrypted fields as all
5452
// the DEKs encrypting those fields were deleted in the preceding line.
5553
keyVaultClient.GetDatabase("medicalRecords").DropCollection("patients");
5654
var keyVaultCollection = keyVaultDatabase.GetCollection<BsonDocument>(keyVaultNamespace.CollectionName.ToString());
5755
keyVaultCollection.Indexes.CreateOne(indexModel);
5856
// end-create-index
5957

58+
6059
// start-create-dek
6160
var clientEncryptionOptions = new ClientEncryptionOptions(
6261
keyVaultClient: keyVaultClient,
6362
keyVaultNamespace: keyVaultNamespace,
64-
kmsProviders: kmsProviders);
63+
kmsProviders: kmsProviders
64+
);
65+
6566
var clientEncryption = new ClientEncryption(clientEncryptionOptions);
6667
var dataKeyId = clientEncryption.CreateDataKey(provider, dataKeyOptions, CancellationToken.None);
6768
var dataKeyIdBase64 = Convert.ToBase64String(GuidConverter.ToBytes(dataKeyId, GuidRepresentation.Standard));

source/includes/generated/in-use-encryption/csfle/dotnet/azure/reader/CSFLE/InsertEncryptedDocument.cs

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public static void Insert()
1818
// end-key-vault
1919
var coll = "patients";
2020
var db = "medicalRecords";
21-
var db_namespace = $"{db}.{coll}";
21+
var dbNamespace = $"{db}.{coll}";
2222

2323
// start-kmsproviders
2424
var kmsProviders = new Dictionary<string, IReadOnlyDictionary<string, object>>();
@@ -109,9 +109,10 @@ public static void Insert()
109109
}
110110
};
111111
var schemaMap = new Dictionary<string, BsonDocument>();
112-
schemaMap.Add(db_namespace, schema);
112+
schemaMap.Add(dbNamespace, schema);
113113
// end-schema
114114

115+
115116
// start-extra-options
116117
var mongoBinariesPath = "<Path to mongocryptd binary>";
117118
var extraOptions = new Dictionary<string, object>()
@@ -130,7 +131,8 @@ public static void Insert()
130131
keyVaultNamespace: keyVaultNamespace,
131132
kmsProviders: kmsProviders,
132133
schemaMap: schemaMap,
133-
extraOptions: extraOptions);
134+
extraOptions: extraOptions
135+
);
134136
clientSettings.AutoEncryptionOptions = autoEncryptionOptions;
135137
var secureClient = new MongoClient(clientSettings);
136138
// end-client
@@ -168,9 +170,10 @@ public static void Insert()
168170
var filter = Builders<BsonDocument>.Filter.Eq("name", "Jon Doe");
169171
var regularResult = regularCollection.Find(filter).Limit(1).ToList()[0];
170172
Console.WriteLine($"\n{regularResult}\n");
173+
171174
Console.WriteLine("Finding a document with encrypted client, searching on an encrypted field");
172175
var ssnFilter = Builders<BsonDocument>.Filter.Eq("ssn", 145014000);
173-
var secureResult = secureCollection.Find(ssnFilter).Limit(1).ToList()[0];
176+
var secureResult = secureCollection.Find(ssnFilter).Limit(1).First();
174177
Console.WriteLine($"\n{secureResult}\n");
175178
// end-find
176179
}

source/includes/generated/in-use-encryption/csfle/dotnet/azure/reader/CSFLE/MakeDataKey.cs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,8 @@ public static void MakeKey()
3535
{ "keyVaultEndpoint", "<Your Azure Key Vault Endpoint>" },
3636
});
3737
// end-datakeyopts
38-
3938
// start-create-index
4039
var connectionString = "<Your MongoDB URI>";
41-
// start-create-dek
4240
var keyVaultNamespace = CollectionNamespace.FromFullName("encryption.__keyVault");
4341
var keyVaultClient = new MongoClient(connectionString);
4442
var indexOptions = new CreateIndexOptions<BsonDocument>();
@@ -50,19 +48,22 @@ public static void MakeKey()
5048
var keyVaultDatabase = keyVaultClient.GetDatabase(keyVaultNamespace.DatabaseNamespace.ToString());
5149
// Drop the Key Vault Collection in case you created this collection
5250
// in a previous run of this application.
53-
keyVaultDatabase.DropCollection(keyVaultNamespace.CollectionName.ToString());
51+
keyVaultDatabase.DropCollection(keyVaultNamespace.CollectionName);
5452
// Drop the database storing your encrypted fields as all
5553
// the DEKs encrypting those fields were deleted in the preceding line.
5654
keyVaultClient.GetDatabase("medicalRecords").DropCollection("patients");
5755
var keyVaultCollection = keyVaultDatabase.GetCollection<BsonDocument>(keyVaultNamespace.CollectionName.ToString());
5856
keyVaultCollection.Indexes.CreateOne(indexModel);
5957
// end-create-index
6058

59+
6160
// start-create-dek
6261
var clientEncryptionOptions = new ClientEncryptionOptions(
6362
keyVaultClient: keyVaultClient,
6463
keyVaultNamespace: keyVaultNamespace,
65-
kmsProviders: kmsProviders);
64+
kmsProviders: kmsProviders
65+
);
66+
6667
var clientEncryption = new ClientEncryption(clientEncryptionOptions);
6768
var dataKeyId = clientEncryption.CreateDataKey(provider, dataKeyOptions, CancellationToken.None);
6869
var dataKeyIdBase64 = Convert.ToBase64String(GuidConverter.ToBytes(dataKeyId, GuidRepresentation.Standard));

source/includes/generated/in-use-encryption/csfle/dotnet/gcp/reader/CSFLE/InsertEncryptedDocument.cs

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public static void Insert()
1818
// end-key-vault
1919
var coll = "patients";
2020
var db = "medicalRecords";
21-
var db_namespace = $"{db}.{coll}";
21+
var dbNamespace = $"{db}.{coll}";
2222

2323
// start-kmsproviders
2424
var kmsProviders = new Dictionary<string, IReadOnlyDictionary<string, object>>();
@@ -108,9 +108,10 @@ public static void Insert()
108108
}
109109
};
110110
var schemaMap = new Dictionary<string, BsonDocument>();
111-
schemaMap.Add(db_namespace, schema);
111+
schemaMap.Add(dbNamespace, schema);
112112
// end-schema
113113

114+
114115
// start-extra-options
115116
var mongoBinariesPath = "<Path to mongocryptd binary>";
116117
var extraOptions = new Dictionary<string, object>()
@@ -129,7 +130,8 @@ public static void Insert()
129130
keyVaultNamespace: keyVaultNamespace,
130131
kmsProviders: kmsProviders,
131132
schemaMap: schemaMap,
132-
extraOptions: extraOptions);
133+
extraOptions: extraOptions
134+
);
133135
clientSettings.AutoEncryptionOptions = autoEncryptionOptions;
134136
var secureClient = new MongoClient(clientSettings);
135137
// end-client
@@ -167,9 +169,10 @@ public static void Insert()
167169
var filter = Builders<BsonDocument>.Filter.Eq("name", "Jon Doe");
168170
var regularResult = regularCollection.Find(filter).Limit(1).ToList()[0];
169171
Console.WriteLine($"\n{regularResult}\n");
172+
170173
Console.WriteLine("Finding a document with encrypted client, searching on an encrypted field");
171174
var ssnFilter = Builders<BsonDocument>.Filter.Eq("ssn", 145014000);
172-
var secureResult = secureCollection.Find(ssnFilter).Limit(1).ToList()[0];
175+
var secureResult = secureCollection.Find(ssnFilter).Limit(1).First();
173176
Console.WriteLine($"\n{secureResult}\n");
174177
// end-find
175178
}

source/includes/generated/in-use-encryption/csfle/dotnet/gcp/reader/CSFLE/MakeDataKey.cs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,8 @@ public static void MakeKey()
3636
{ "keyName", "<Your GCP Key Name>" },
3737
});
3838
// end-datakeyopts
39-
4039
// start-create-index
4140
var connectionString = "<Your MongoDB URI>";
42-
// start-create-dek
4341
var keyVaultNamespace = CollectionNamespace.FromFullName("encryption.__keyVault");
4442
var keyVaultClient = new MongoClient(connectionString);
4543
var indexOptions = new CreateIndexOptions<BsonDocument>();
@@ -51,19 +49,22 @@ public static void MakeKey()
5149
var keyVaultDatabase = keyVaultClient.GetDatabase(keyVaultNamespace.DatabaseNamespace.ToString());
5250
// Drop the Key Vault Collection in case you created this collection
5351
// in a previous run of this application.
54-
keyVaultDatabase.DropCollection(keyVaultNamespace.CollectionName.ToString());
52+
keyVaultDatabase.DropCollection(keyVaultNamespace.CollectionName);
5553
// Drop the database storing your encrypted fields as all
5654
// the DEKs encrypting those fields were deleted in the preceding line.
5755
keyVaultClient.GetDatabase("medicalRecords").DropCollection("patients");
5856
var keyVaultCollection = keyVaultDatabase.GetCollection<BsonDocument>(keyVaultNamespace.CollectionName.ToString());
5957
keyVaultCollection.Indexes.CreateOne(indexModel);
6058
// end-create-index
6159

60+
6261
// start-create-dek
6362
var clientEncryptionOptions = new ClientEncryptionOptions(
6463
keyVaultClient: keyVaultClient,
6564
keyVaultNamespace: keyVaultNamespace,
66-
kmsProviders: kmsProviders);
65+
kmsProviders: kmsProviders
66+
);
67+
6768
var clientEncryption = new ClientEncryption(clientEncryptionOptions);
6869
var dataKeyId = clientEncryption.CreateDataKey(provider, dataKeyOptions, CancellationToken.None);
6970
var dataKeyIdBase64 = Convert.ToBase64String(GuidConverter.ToBytes(dataKeyId, GuidRepresentation.Standard));

0 commit comments

Comments
 (0)