Skip to content

Commit 9b44f7c

Browse files
author
Chris Cho
authored
DOCSP-31167: Amend admonitions about using security mechanisms together (#3523)
* DOCSP-31167: Amend admonitions about using security mechanisms together * fix text * edits * PRR fixes * PRR fixes
1 parent ed9f4c1 commit 9b44f7c

File tree

2 files changed

+28
-24
lines changed

2 files changed

+28
-24
lines changed

source/core/csfle/features.txt

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ MongoDB and explains their use cases and limitations:
7373
Role-Based Access Control
7474
~~~~~~~~~~~~~~~~~~~~~~~~~
7575

76-
Role-Based Access Control is a security mechanism that
76+
Role-Based Access Control is a security mechanism that
7777
allows administrators to grant and restrict collection-level permissions
7878
for users. With the appropriate role definition and assignment, this
7979
solution prevents accidental disclosure of data and access.
@@ -129,9 +129,11 @@ and the potential security vulnerabilities that they address:
129129

130130
.. important:: Use the Mechanisms Together
131131

132-
To secure a production deployment, you can use multiple security
133-
mechanisms discussed in this guide together. However, you cannot use
134-
both {+csfle-abbrev+} and {+qe+} to encrypt data in the same collection.
132+
To secure a production deployment, use Role-Based Access
133+
Control, Encryption at Rest, Transport Encryption, and optionally, the
134+
In-Use Encryption security mechanisms together. Please note that you cannot
135+
use both {+csfle-abbrev+} and {+qe+} to encrypt different fields in the same
136+
collection.
135137

136138
To learn more about {+qe+}, see :ref:`{+qe+} Features <qe-features>`.
137139

@@ -188,7 +190,7 @@ Solution
188190
~~~~~~~~
189191

190192
MedcoMD uses the following security mechanisms to satisfy their use cases
191-
and protect against the disclosure of sensitive medical data:
193+
and protect against the disclosure of sensitive medical data:
192194

193195
- :ref:`Transport Encryption (TLS/SSL) <csfle-features-transport-encryption>`
194196
to secure data as it travels over the network.

source/core/queryable-encryption/features.txt

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Features
1515
Overview
1616
--------
1717

18-
On this page, you can learn about the security benefits of {+qe+},
18+
On this page, you can learn about the security benefits of {+qe+},
1919
how it works, and how it compares to other security mechanisms supported
2020
by MongoDB. You can also view a fictional scenario that demonstrates the
2121
value of {+qe+} in securing your data.
@@ -30,53 +30,53 @@ encrypt data before transporting it over the network using fully
3030
randomized encryption, while maintaining queryability.
3131
Sensitive data is transparently encrypted and decrypted by the client
3232
and only communicated to and from the server in encrypted form.
33-
The security guarantees for sensitive fields containing both low
33+
The security guarantees for sensitive fields containing both low
3434
cardinality (low-frequency) data and high cardinality data are identical
3535

3636
Unlike :ref:`Client-Side Field Level Encryption <manual-csfle-feature>`
3737
that can use :ref:`Deterministic Encryption <csfle-deterministic-encryption>`,
38-
{+qe+} uses fast, searchable encryption schemes based on `Structured Encryption <https://dl.acm.org/doi/abs/10.1007/978-3-030-77883-5_13>`__.
38+
{+qe+} uses fast, searchable encryption schemes based on `Structured Encryption <https://dl.acm.org/doi/abs/10.1007/978-3-030-77883-5_13>`__.
3939
These schemes produce different encrypted output values even when given
4040
the same cleartext input.
4141

4242
How {+qe+} Works
4343
------------------------------
4444

45-
The diagram below shows the process and architecture of how {+qe+} is
45+
The diagram below shows the process and architecture of how {+qe+} is
4646
used in a customer environment.
4747

4848
.. image:: /images/QE-how-it-works.png
4949
:alt: How Queryable Encryption works
5050

51-
In this diagram, the user is able to query on fully randomly encrypted
51+
In this diagram, the user is able to query on fully randomly encrypted
5252
data such as SSN number.
5353

5454
The process and mechanisms that make this possible within {+qe+} are as follows:
5555

56-
1. When the application submits the query, MongoDB drivers first analyze
56+
1. When the application submits the query, MongoDB drivers first analyze
5757
the query.
5858

59-
2. The driver recognizes the query is against an encrypted field and
60-
requests the encryption keys from the customer-provisioned key
59+
2. The driver recognizes the query is against an encrypted field and
60+
requests the encryption keys from the customer-provisioned key
6161
provider such as:
6262

63-
- AWS Key Management Service (AWS KMS)
63+
- AWS Key Management Service (AWS KMS)
6464
- Google Cloud KMS
6565
- Azure Key Vault
6666
- Any {+kmip-kms+}
6767

68-
3. The driver submits the query to the MongoDB server with the encrypted
68+
3. The driver submits the query to the MongoDB server with the encrypted
6969
fields rendered as ciphertext.
7070

71-
4. Queryable Encryption implements a fast, searchable scheme that allows
72-
the server to process queries on fully encrypted data, without knowing
73-
anything about the data. The data and the query itself remain encrypted
71+
4. Queryable Encryption implements a fast, searchable scheme that allows
72+
the server to process queries on fully encrypted data, without knowing
73+
anything about the data. The data and the query itself remain encrypted
7474
at all times on the server.
7575

76-
5. The MongoDB server returns the encrypted results of the query to the
76+
5. The MongoDB server returns the encrypted results of the query to the
7777
driver.
7878

79-
6. The query results are decrypted with the keys held by the driver and
79+
6. The query results are decrypted with the keys held by the driver and
8080
returned to the client and shown as plaintext.
8181

8282
{+qe+} functions with the help of the following data structures. It is critical
@@ -186,17 +186,19 @@ To learn more, see
186186
Comparison of Features
187187
----------------------
188188

189-
The following diagram describes security features MongoDB supports and
189+
The following diagram describes security features MongoDB supports and
190190
the potential security vulnerabilities that they address:
191191

192192
.. image:: /images/QE_Security_Feature_Chart.png
193193
:alt: Diagram that describes MongoDB security features and the potential vulnerabilities that they address
194194

195195
.. important:: Use the Mechanisms Together
196196

197-
To secure a production deployment, you can use multiple security
198-
mechanisms discussed in this guide together. However, you cannot use
199-
both {+csfle-abbrev+} and {+qe+} to encrypt data in the same collection.
197+
To secure a production deployment, use Role-Based Access
198+
Control, Encryption at Rest, Transport Encryption, and optionally, the
199+
In-Use Encryption security mechanisms together. Please note that you cannot
200+
use both {+csfle+} and {+qe+} to encrypt different fields in the same
201+
collection.
200202

201203
To learn more about {+csfle+}, see :ref:`{+csfle+} Features <csfle-features>`.
202204

0 commit comments

Comments
 (0)