@@ -4,18 +4,17 @@ Client-Side Field Level Encryption
4
4
New in MongoDB 4.2, client-side field level encryption allows an application
5
5
to encrypt specific data fields in addition to pre-existing MongoDB
6
6
encryption features such as `Encryption at Rest
7
- <https://docs .mongodb.com/manual/ core/security-encryption-at-rest/ > `_ and
7
+ <https://dochub .mongodb.org/ core/security-encryption-at-rest> `_ and
8
8
`TLS/SSL (Transport Encryption)
9
- <https://docs .mongodb.com/manual/ core/security-transport-encryption/ > `_.
9
+ <https://dochub .mongodb.org/ core/security-tls- transport-encryption> `_.
10
10
11
11
With field level encryption, applications can encrypt fields in documents
12
12
*prior * to transmitting data over the wire to the server. Client-side field
13
13
level encryption supports workloads where applications must guarantee that
14
14
unauthorized parties, including server administrators, cannot read the
15
15
encrypted data.
16
16
17
- .. seealso :: The MongoDB documentation for `Client-Side Field Level Encryption
18
- <https://docs.mongodb.com/manual/core/security-client-side-encryption/>`_.
17
+ .. mongodoc :: client-side-field-level-encryption
19
18
20
19
Dependencies
21
20
------------
@@ -38,10 +37,10 @@ mongocryptd
38
37
39
38
The ``mongocryptd `` binary is required for automatic client-side encryption
40
39
and is included as a component in the `MongoDB Enterprise Server package
41
- <https://docs .mongodb.com/manual/administration/ install-enterprise/ > `_.
40
+ <https://dochub .mongodb.org/core/ install-mongodb- enterprise> `_.
42
41
For detailed installation instructions see
43
42
`the MongoDB documentation on mongocryptd
44
- <https://docs .mongodb.com/manual/reference/security- client-side-encryption-appendix/# mongocryptd> `_.
43
+ <https://dochub .mongodb.org/core/ client-side-field-level- encryption-mongocryptd> `_.
45
44
46
45
``mongocryptd `` performs the following:
47
46
@@ -53,7 +52,7 @@ For detailed installation instructions see
53
52
- Rejects read/write operations that may return unexpected or incorrect results
54
53
when applied to an encrypted field. For supported and unsupported operations,
55
54
see `Read/Write Support with Automatic Field Level Encryption
56
- <https://docs .mongodb.com/manual/reference/security- client-side-query-aggregation- support/ > `_.
55
+ <https://dochub .mongodb.org/core/ client-side-field-level-encryption-read-write- support> `_.
57
56
58
57
A MongoClient configured with auto encryption will automatically spawn the
59
58
``mongocryptd `` process from the application's ``PATH ``. Applications can
@@ -107,7 +106,7 @@ Providing Local Automatic Encryption Rules
107
106
The following example shows how to specify automatic encryption rules via the
108
107
``schema_map `` option. The automatic encryption rules are expressed using a
109
108
`strict subset of the JSON Schema syntax
110
- <https://docs .mongodb.com/manual/reference/security- client-side-automatic-json-schema/ > `_.
109
+ <https://dochub .mongodb.org/core/ client-side-field-level-encryption- automatic-encryption-rules > `_.
111
110
112
111
Supplying a ``schema_map `` provides more security than relying on
113
112
JSON Schemas obtained from the server. It protects against a
@@ -144,7 +143,7 @@ will result in an error.::
144
143
CodecOptions())
145
144
146
145
# Create a new data key and json schema for the encryptedField.
147
- # https://docs .mongodb.com/manual/reference/security- client-side-automatic-json-schema/
146
+ # https://dochub .mongodb.org/core/ client-side-field-level-encryption- automatic-encryption-rules
148
147
data_key_id = client_encryption.create_data_key(
149
148
'local', key_alt_names=['pymongo_encryption_example_1'])
150
149
schema = {
@@ -234,7 +233,7 @@ encryption using
234
233
:class: `~pymongo.encryption.ClientEncryption ` to create a new encryption
235
234
data key and create a collection with the
236
235
`Automatic Encryption JSON Schema Syntax
237
- <https://docs .mongodb.com/manual/reference/security- client-side-automatic-json-schema/ > `_::
236
+ <https://dochub .mongodb.org/core/ client-side-field-level-encryption- automatic-encryption-rules > `_::
238
237
239
238
import os
240
239
0 commit comments