(DOCSP-24822) Remove OpenSSL from In Use Enc Tuts (#2046)

biniona-mongodb · web-flow · commit df5f9cf4d055 · 2022-10-25T08:25:17.000-04:00
* wip add new code snippets

* add updates to most samples

* additional comments

* update tabs, add links to sample apps

* remove openssl from installation requirements

* clarify when openssl is required in gcp and kmip bash commands

* add missing open ssl link

* add bash commands

* test powershell command

* proofread

* nl - feedback
diff --git a/source/core/csfle/install.txt b/source/core/csfle/install.txt
@@ -27,7 +27,6 @@ in your development environment:
 
 - Install :manual:`MongoDB Enterprise Edition version 4.2 or later </installation/#mongodb-enterprise-edition-installation-tutorials>`.
 - Install a :ref:`MongoDB Driver Compatible with CSFLE <csfle-driver-compatibility>`.
-- Install `OpenSSL <https://www.openssl.org/source/>`__ *optional*.
 - Start a
   :manual:`MongoDB instance </tutorial/manage-mongodb-processes/#start-mongod-processes>`
   or
diff --git a/source/core/csfle/quick-start.txt b/source/core/csfle/quick-start.txt
@@ -94,6 +94,40 @@ Procedure
 
       .. include:: /includes/quick-start/cmk.rst
 
+      .. see:: Complete Code
+
+         .. tabs-drivers::
+
+            .. tab::
+               :tabid: java-sync
+
+               To view the complete code for making a {+cmk-long+}, see
+               `our Github repository <{+sample-app-url-csfle+}/java/local/reader/src/main/java/com/mongodb/csfle/MakeDataKey.java>`__.
+
+            .. tab::
+               :tabid: nodejs
+
+               To view the complete code for making a {+cmk-long+}, see
+               `our Github repository <{+sample-app-url-csfle+}/node/local/reader/make_data_key.js>`__.
+
+            .. tab::
+               :tabid: python
+
+               To view the complete code for making a {+cmk-long+}, see
+               `our Github repository <{+sample-app-url-csfle+}/python/local/reader/make_data_key.py>`__.
+
+            .. tab::
+               :tabid: csharp
+
+               To view the complete code for making a {+cmk-long+}, see
+               `our Github repository <{+sample-app-url-csfle+}/dotnet/local/reader/CSFLE/MakeDataKey.cs>`__.
+
+            .. tab::
+               :tabid: go
+
+               To view the complete code for making a {+cmk-long+}, see
+               `our Github repository <{+sample-app-url-csfle+}/go/local/reader/make-data-key.go>`__.
+
    .. step:: Create a Unique Index on your {+key-vault-long+}
 
       .. include:: /includes/quick-start/key-vault-index.rst
diff --git a/source/core/queryable-encryption/install.txt b/source/core/queryable-encryption/install.txt
@@ -27,7 +27,6 @@ in your development environment:
 
 - Download the :ref:`{+shared-library+} <qe-reference-shared-library-download>`.
 - Install a :ref:`MongoDB Driver Compatible with {+qe+} <qe-driver-compatibility>`.
-- Install `OpenSSL <https://www.openssl.org/source/>`__ *optional*.
 - Start an
   :atlas:`Atlas Cluster </getting-started?jmp=docs>`
   or a
diff --git a/source/core/queryable-encryption/quick-start.txt b/source/core/queryable-encryption/quick-start.txt
@@ -89,6 +89,46 @@ Procedure
 
       .. include:: /includes/queryable-encryption/quick-start/cmk.rst
 
+      .. see:: Complete Code
+
+         .. tabs-drivers::
+
+            .. tab::
+               :tabid: shell
+
+               To view the complete code for making a {+cmk-long+}, see
+               `our Github repository <{+sample-app-url-qe+}/mongosh/local/reader/make_data_key.js>`__.
+
+            .. tab::
+               :tabid: nodejs
+
+               To view the complete code for making a {+cmk-long+}, see
+               `our Github repository <{+sample-app-url-qe+}/node/local/reader/make_data_key.js>`__.
+
+            .. tab::
+               :tabid: python
+
+               To view the complete code for making a {+cmk-long+}, see
+               `our Github repository <{+sample-app-url-qe+}/python/local/reader/make_data_key.py>`__.
+
+            .. tab::
+               :tabid: java-sync
+
+               To view the complete code for making a {+cmk-long+}, see
+               `our Github repository <{+sample-app-url-qe+}/java/local/reader/src/main/java/com/mongodb/qe/MakeDataKey.java>`__.
+
+            .. tab::
+               :tabid: go
+
+               To view the complete code for making a {+cmk-long+}, see
+               `our Github repository <{+sample-app-url-qe+}/go/local/reader/make-data-key.go>`__.
+
+            .. tab::
+               :tabid: csharp
+
+               To view the complete code for making a {+cmk-long+}, see
+               `our Github repository <{+sample-app-url-qe+}/dotnet/local/reader/QueryableEncryption/MakeDataKey.cs>`__.
+
    .. step:: Create a Unique Index on your {+key-vault-long+}
 
       .. include:: /includes/queryable-encryption/quick-start/key-vault-index.rst
@@ -137,7 +177,6 @@ Procedure
                To view the complete code for making a {+dek-long+}, see
                `our Github repository <{+sample-app-url-qe+}/dotnet/local/reader/QueryableEncryption/MakeDataKey.cs>`__.
 
-
    .. step:: Configure your MongoClient for Encrypted Reads and Writes
 
       .. include:: /includes/queryable-encryption/quick-start/client.rst
diff --git a/source/core/queryable-encryption/tutorials/explicit-encryption.txt b/source/core/queryable-encryption/tutorials/explicit-encryption.txt
@@ -76,6 +76,40 @@ Procedure
 
       .. include:: /includes/queryable-encryption/tutorials/exp/cmk.rst
 
+      .. see:: Complete Code
+
+         .. tabs-drivers::
+
+            .. tab::
+               :tabid: nodejs
+
+               To view the complete code for making a {+cmk-long+}, see
+               `the {+qe+} sample application repository <{+sample-app-url-qe+}/node/exp/reader/make_data_key.js>`__.
+
+            .. tab::
+               :tabid: python
+
+               To view the complete code for making a {+cmk-long+}, see
+               `the {+qe+} sample application repository <{+sample-app-url-qe+}/python/exp/reader/make_data_key.py>`__.
+
+            .. tab::
+               :tabid: java-sync
+
+               To view the complete code for making a {+cmk-long+}, see
+               `the {+qe+} sample application repository <{+sample-app-url-qe+}/java/exp/reader/src/main/java/com/mongodb/qe/MakeDataKey.java>`__.
+
+            .. tab::
+               :tabid: go
+
+               To view the complete code for making a {+cmk-long+}, see
+               `the {+qe+} sample application repository <{+sample-app-url-qe+}/go/exp/reader/make-data-key.go>`__.
+
+            .. tab::
+               :tabid: csharp
+
+               To view the complete code for making a {+cmk-long+}, see
+               `the {+qe+} sample application repository <{+sample-app-url-qe+}/dotnet/exp/reader/QueryableEncryption/MakeDataKey.cs>`__.
+
    .. step:: Create a Unique Index on your {+key-vault-long+}
 
       .. include:: /includes/queryable-encryption/tutorials/exp/key-vault-index.rst
diff --git a/source/includes/generated/in-use-encryption/csfle/dotnet/local/reader/CSFLE/MakeDataKey.cs b/source/includes/generated/in-use-encryption/csfle/dotnet/local/reader/CSFLE/MakeDataKey.cs
@@ -15,6 +15,7 @@ public static void MakeKey()
         {
 
 
+            // start-local-cmk
             using (var randomNumberGenerator = System.Security.Cryptography.RandomNumberGenerator.Create())
             {
                 var bytes = new byte[96];
@@ -23,6 +24,7 @@ public static void MakeKey()
                 Console.WriteLine(localMasterKeyBase64Write);
                 File.WriteAllText("master-key.txt", localMasterKeyBase64Write);
             }
+            // end-local-cmk
 
             // start-kmsproviders
             var kmsProviders = new Dictionary<string, IReadOnlyDictionary<string, object>>();
diff --git a/source/includes/generated/in-use-encryption/csfle/go/local/reader/make-data-key.go b/source/includes/generated/in-use-encryption/csfle/go/local/reader/make-data-key.go
@@ -16,6 +16,7 @@ import (
 	"io/ioutil"
 )
 
+// start-local-cmk
 func localMasterKey() []byte {
 	key := make([]byte, 96)
 	if _, err := rand.Read(key); err != nil {
@@ -27,6 +28,8 @@ func localMasterKey() []byte {
 	return key
 }
 
+// end-local-cmk
+
 func MakeKey() error {
 
 	localMasterKey()
diff --git a/source/includes/generated/in-use-encryption/csfle/java/local/reader/src/main/java/com/mongodb/csfle/MakeDataKey.java b/source/includes/generated/in-use-encryption/csfle/java/local/reader/src/main/java/com/mongodb/csfle/MakeDataKey.java
@@ -52,11 +52,13 @@
 public class MakeDataKey {
 
     public static void main(String[] args) throws Exception {
+        // start-local-cmk
         byte[] localMasterKeyWrite = new byte[96];
         new SecureRandom().nextBytes(localMasterKeyWrite);
         try (FileOutputStream stream = new FileOutputStream("master-key.txt")) {
             stream.write(localMasterKeyWrite);
         }
+        // end-local-cmk
 
         // start-kmsproviders
         String kmsProvider = "local";
diff --git a/source/includes/generated/in-use-encryption/csfle/node/local/reader/make_data_key.js b/source/includes/generated/in-use-encryption/csfle/node/local/reader/make_data_key.js
@@ -2,13 +2,15 @@ const mongodb = require("mongodb");
 const { ClientEncryption } = require("mongodb-client-encryption");
 const { MongoClient, Binary } = mongodb;
 
+// start-local-cmk
 const fs = require("fs");
 const crypto = require("crypto");
 try {
   fs.writeFileSync("master-key.txt", crypto.randomBytes(96));
 } catch (err) {
   console.error(err);
 }
+// end-local-cmk
 
 // start-kmsproviders
 const provider = "local";
diff --git a/source/includes/generated/in-use-encryption/csfle/python/local/reader/make_data_key.py b/source/includes/generated/in-use-encryption/csfle/python/local/reader/make_data_key.py
@@ -6,12 +6,14 @@
 from bson.codec_options import CodecOptions
 from bson.binary import STANDARD, UUID
 
+# start-local-cmk
 import os
 
 path = "master-key.txt"
 file_bytes = os.urandom(96)
 with open(path, "wb") as f:
     f.write(file_bytes)
+# end-local-cmk
 
 # start-kmsproviders
 path = "./master-key.txt"
diff --git a/source/includes/generated/in-use-encryption/queryable-encryption/dotnet/exp/reader/QueryableEncryption/MakeDataKey.cs b/source/includes/generated/in-use-encryption/queryable-encryption/dotnet/exp/reader/QueryableEncryption/MakeDataKey.cs
@@ -12,13 +12,15 @@ internal static class MakeDataKey
     {
         public static void MakeKey()
         {
+            // start-local-cmk
             using (var randomNumberGenerator = System.Security.Cryptography.RandomNumberGenerator.Create())
             {
                 var bytes = new byte[96];
                 randomNumberGenerator.GetBytes(bytes);
                 var localMasterKeyBase64Write = Convert.ToBase64String(bytes);
                 File.WriteAllText("master-key.txt", localMasterKeyBase64Write);
             }
+            // end-local-cmk
 
             // start-kmsproviders
             var kmsProviders = new Dictionary<string, IReadOnlyDictionary<string, object>>();
diff --git a/source/includes/generated/in-use-encryption/queryable-encryption/dotnet/local/reader/QueryableEncryption/MakeDataKey.cs b/source/includes/generated/in-use-encryption/queryable-encryption/dotnet/local/reader/QueryableEncryption/MakeDataKey.cs
@@ -12,13 +12,15 @@ internal static class MakeDataKey
     {
         public static void MakeKey()
         {
+            // start-local-cmk
             using (var randomNumberGenerator = System.Security.Cryptography.RandomNumberGenerator.Create())
             {
                 var bytes = new byte[96];
                 randomNumberGenerator.GetBytes(bytes);
                 var localMasterKeyBase64Write = Convert.ToBase64String(bytes);
                 File.WriteAllText("master-key.txt", localMasterKeyBase64Write);
             }
+            // end-local-cmk
 
             // start-kmsproviders
             var kmsProviders = new Dictionary<string, IReadOnlyDictionary<string, object>>();
diff --git a/source/includes/generated/in-use-encryption/queryable-encryption/go/exp/reader/make-data-key.go b/source/includes/generated/in-use-encryption/queryable-encryption/go/exp/reader/make-data-key.go
@@ -15,6 +15,7 @@ import (
 	"io/ioutil"
 )
 
+// start-local-cmk
 func localMasterKey() []byte {
 	key := make([]byte, 96)
 	if _, err := rand.Read(key); err != nil {
@@ -26,6 +27,8 @@ func localMasterKey() []byte {
 	return key
 }
 
+// end-local-cmk
+
 func MakeKey() error {
 
 	localMasterKey()
diff --git a/source/includes/generated/in-use-encryption/queryable-encryption/go/local/reader/make-data-key.go b/source/includes/generated/in-use-encryption/queryable-encryption/go/local/reader/make-data-key.go
@@ -15,6 +15,7 @@ import (
 	"io/ioutil"
 )
 
+// start-local-cmk
 func localMasterKey() []byte {
 	key := make([]byte, 96)
 	if _, err := rand.Read(key); err != nil {
@@ -26,6 +27,8 @@ func localMasterKey() []byte {
 	return key
 }
 
+// end-local-cmk
+
 func MakeKey() error {
 
 	localMasterKey()
diff --git a/source/includes/generated/in-use-encryption/queryable-encryption/java/exp/reader/src/main/java/com/mongodb/qe/MakeDataKey.java b/source/includes/generated/in-use-encryption/queryable-encryption/java/exp/reader/src/main/java/com/mongodb/qe/MakeDataKey.java
@@ -57,11 +57,13 @@ public class MakeDataKey {
 
     public static void main(String[] args) throws Exception {
 
+        // start-local-cmk
         byte[] localMasterKeyWrite = new byte[96];
         new SecureRandom().nextBytes(localMasterKeyWrite);
         try (FileOutputStream stream = new FileOutputStream("master-key.txt")) {
             stream.write(localMasterKeyWrite);
         }
+        // end-local-cmk
 
         // start-kmsproviders
         String kmsProvider = "local";
diff --git a/source/includes/generated/in-use-encryption/queryable-encryption/java/local/reader/src/main/java/com/mongodb/qe/MakeDataKey.java b/source/includes/generated/in-use-encryption/queryable-encryption/java/local/reader/src/main/java/com/mongodb/qe/MakeDataKey.java
@@ -57,11 +57,13 @@ public class MakeDataKey {
 
     public static void main(String[] args) throws Exception {
 
+        // start-local-cmk
         byte[] localMasterKeyWrite = new byte[96];
         new SecureRandom().nextBytes(localMasterKeyWrite);
         try (FileOutputStream stream = new FileOutputStream("master-key.txt")) {
             stream.write(localMasterKeyWrite);
         }
+        // end-local-cmk
 
         // start-kmsproviders
         String kmsProvider = "local";
diff --git a/source/includes/generated/in-use-encryption/queryable-encryption/mongosh/local/reader/make_data_key.js b/source/includes/generated/in-use-encryption/queryable-encryption/mongosh/local/reader/make_data_key.js
@@ -4,11 +4,13 @@ const keyVaultNamespace = `${keyVaultDatabase}.${keyVaultCollection}`;
 const secretDB = "medicalRecords";
 const secretCollection = "patients";
 
+// start-local-cmk
 try {
   fs.writeFileSync("./master-key.txt", crypto.randomBytes(96));
 } catch (err) {
   console.error(err);
 }
+// end-local-cmk
 
 // start-kmsproviders
 const provider = "local";
diff --git a/source/includes/generated/in-use-encryption/queryable-encryption/node/exp/reader/make_data_key.js b/source/includes/generated/in-use-encryption/queryable-encryption/node/exp/reader/make_data_key.js
@@ -7,13 +7,15 @@ const keyVaultNamespace = `${keyVaultDatabase}.${keyVaultCollection}`;
 const secretDB = "medicalRecords";
 const secretCollection = "patients";
 
+// start-local-cmk
 const fs = require("fs");
 const crypto = require("crypto");
 try {
   fs.writeFileSync("master-key.txt", crypto.randomBytes(96));
 } catch (err) {
   console.error(err);
 }
+// end-local-cmk
 
 // start-kmsproviders
 const provider = "local";
diff --git a/source/includes/generated/in-use-encryption/queryable-encryption/node/local/reader/make_data_key.js b/source/includes/generated/in-use-encryption/queryable-encryption/node/local/reader/make_data_key.js
@@ -7,13 +7,15 @@ const keyVaultNamespace = `${keyVaultDatabase}.${keyVaultCollection}`;
 const secretDB = "medicalRecords";
 const secretCollection = "patients";
 
+// start-local-cmk
 const fs = require("fs");
 const crypto = require("crypto");
 try {
   fs.writeFileSync("master-key.txt", crypto.randomBytes(96));
 } catch (err) {
   console.error(err);
 }
+// end-local-cmk
 
 // start-kmsproviders
 const provider = "local";
diff --git a/source/includes/generated/in-use-encryption/queryable-encryption/python/exp/reader/make_data_key.py b/source/includes/generated/in-use-encryption/queryable-encryption/python/exp/reader/make_data_key.py
@@ -8,10 +8,12 @@
 
 import os
 
+# start-local-cmk
 path = "master-key.txt"
 file_bytes = os.urandom(96)
 with open(path, "wb") as f:
     f.write(file_bytes)
+# end-local-cmk
 
 # start-kmsproviders
 provider = "local"
diff --git a/source/includes/generated/in-use-encryption/queryable-encryption/python/local/reader/make_data_key.py b/source/includes/generated/in-use-encryption/queryable-encryption/python/local/reader/make_data_key.py
@@ -8,10 +8,12 @@
 
 import os
 
+# start-local-cmk
 path = "master-key.txt"
 file_bytes = os.urandom(96)
 with open(path, "wb") as f:
     f.write(file_bytes)
+# end-local-cmk
 
 # start-kmsproviders
 provider = "local"
diff --git a/source/includes/in-use-encryption/cmk-bash.rst b/source/includes/in-use-encryption/cmk-bash.rst
diff --git a/source/includes/queryable-encryption/quick-start/cmk.rst b/source/includes/queryable-encryption/quick-start/cmk.rst
diff --git a/source/includes/queryable-encryption/reference/kms-providers/gcp.rst b/source/includes/queryable-encryption/reference/kms-providers/gcp.rst
diff --git a/source/includes/queryable-encryption/tutorials/automatic/gcp/gcp-credentials-note.rst b/source/includes/queryable-encryption/tutorials/automatic/gcp/gcp-credentials-note.rst
diff --git a/source/includes/queryable-encryption/tutorials/automatic/kmip/certificates.rst b/source/includes/queryable-encryption/tutorials/automatic/kmip/certificates.rst
diff --git a/source/includes/queryable-encryption/tutorials/exp/cmk.rst b/source/includes/queryable-encryption/tutorials/exp/cmk.rst
diff --git a/source/includes/quick-start/cmk.rst b/source/includes/quick-start/cmk.rst
diff --git a/source/includes/reference/kms-providers/gcp.rst b/source/includes/reference/kms-providers/gcp.rst
diff --git a/source/includes/tutorials/automatic/gcp/gcp-credentials-note.rst b/source/includes/tutorials/automatic/gcp/gcp-credentials-note.rst
diff --git a/source/includes/tutorials/automatic/kmip/certificates.rst b/source/includes/tutorials/automatic/kmip/certificates.rst

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ public static void MakeKey()`
`15`	`15`	`{`
`16`	`16`
`17`	`17`
	`18`	`+ // start-local-cmk`
`18`	`19`	`using (var randomNumberGenerator = System.Security.Cryptography.RandomNumberGenerator.Create())`
`19`	`20`	`{`
`20`	`21`	`var bytes = new byte[96];`
`@@ -23,6 +24,7 @@ public static void MakeKey()`
`23`	`24`	`Console.WriteLine(localMasterKeyBase64Write);`
`24`	`25`	`File.WriteAllText("master-key.txt", localMasterKeyBase64Write);`
`25`	`26`	`}`
	`27`	`+ // end-local-cmk`
`26`	`28`
`27`	`29`	`// start-kmsproviders`
`28`	`30`	`var kmsProviders = new Dictionary<string, IReadOnlyDictionary<string, object>>();`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ import (`
`16`	`16`	`"io/ioutil"`
`17`	`17`	`)`
`18`	`18`
	`19`	`+// start-local-cmk`
`19`	`20`	`func localMasterKey() []byte {`
`20`	`21`	`key := make([]byte, 96)`
`21`	`22`	`if _, err := rand.Read(key); err != nil {`
`@@ -27,6 +28,8 @@ func localMasterKey() []byte {`
`27`	`28`	`return key`
`28`	`29`	`}`
`29`	`30`
	`31`	`+// end-local-cmk`
	`32`	`+`
`30`	`33`	`func MakeKey() error {`
`31`	`34`
`32`	`35`	`localMasterKey()`