@@ -19,45 +19,43 @@ To get started using in-use encryption in your project, the
19
19
to be compiled with `libmongocrypt <https://github.com/mongodb/libmongocrypt>`_
20
20
(enabled by default).
21
21
22
- Additionally, either `crypt_shared`_ or `mongocryptd`_ are required in order to
22
+ Additionally, either `` crypt_shared`` or `` mongocryptd`` are required in order to
23
23
use *automatic* client-side encryption. Neither is required for *explicit*
24
24
encryption.
25
25
26
-
27
- crypt_shared
28
- ~~~~~~~~~~~~
26
+ ``crypt_shared``
27
+ ~~~~~~~~~~~~~~~~
29
28
30
29
The :manual:`Automatic Encryption Shared Library </core/queryable-encryption/reference/shared-library/>`
31
- (crypt_shared) provides the same functionality as mongocryptd_ , but does not
30
+ (`` crypt_shared`` ) provides the same functionality as ``mongocryptd`` , but does not
32
31
require you to spawn another process to perform automatic encryption.
33
32
34
- By default, the PHP driver attempts to load crypt_shared from the system path(s)
35
- and uses it automatically if found. To load crypt_shared from another location,
33
+ By default, the PHP driver attempts to load `` crypt_shared`` from the system path(s)
34
+ and uses it automatically if found. To load `` crypt_shared`` from another location,
36
35
use the ``cryptSharedLibPath`` auto encryption
37
36
:php:`driver option <manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`
38
- when constructing a client. If the driver cannot load crypt_shared it will
39
- attempt to fallback to using mongocryptd by default. The
40
- ``cryptSharedLibRequired`` option may be used to always require crypt_shared and
37
+ when constructing a client. If the driver cannot load `` crypt_shared`` it will
38
+ attempt to fallback to using `` mongocryptd`` by default. The
39
+ ``cryptSharedLibRequired`` option may be used to always require `` crypt_shared`` and
41
40
fail if it cannot be loaded.
42
41
43
42
For detailed installation instructions see the MongoDB documentation for the
44
43
:manual:`Automatic Encryption Shared Library </core/queryable-encryption/reference/shared-library/>`.
45
44
45
+ ``mongocryptd``
46
+ ~~~~~~~~~~~~~~~
46
47
47
- mongocryptd
48
- ~~~~~~~~~~~
49
-
50
- The mongocryptd binary is an alternative requirement for automatic client-side
48
+ The ``mongocryptd`` binary is an alternative requirement for automatic client-side
51
49
encryption and is included as a component in the
52
50
:manual:`MongoDB Enterprise Server package </administration/install-enterprise/>`.
53
51
For detailed installation instructions see the
54
52
:manual:`MongoDB documentation on mongocryptd </core/csfle/reference/mongocryptd/>`.
55
53
56
- mongocryptd performs the following:
54
+ `` mongocryptd`` performs the following:
57
55
58
56
- Parses the automatic encryption rules specified in the client configuration.
59
57
If the ``schemaMap`` auto encryption driver option contains invalid syntax,
60
- mongocryptd returns an error.
58
+ `` mongocryptd`` returns an error.
61
59
62
60
- Uses the specified automatic encryption rules to mark fields in read and write
63
61
operations for encryption.
@@ -67,14 +65,13 @@ mongocryptd performs the following:
67
65
see :manual:`Supported Operations for Automatic Encryption </core/csfle/reference/supported-operations/>`.
68
66
69
67
A client configured with auto encryption will automatically spawn the
70
- mongocryptd process from the application's ``PATH``. Applications can control
68
+ `` mongocryptd`` process from the application's ``PATH``. Applications can control
71
69
the spawning behavior via various auto encryption
72
70
:php:`driver options <manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`.
73
71
74
- mongocryptd is only responsible for supporting automatic client-side encryption
72
+ `` mongocryptd`` is only responsible for supporting automatic client-side encryption
75
73
and does not itself perform any encryption or decryption.
76
74
77
-
78
75
Managing Encryption Keys
79
76
------------------------
80
77
@@ -105,7 +102,6 @@ encryption key (e.g. user-specific encryption keys) or create them dynamically.
105
102
.. literalinclude:: /examples/encryption/create_data_key.php
106
103
:language: php
107
104
108
-
109
105
.. _alt_name:
110
106
111
107
Referencing Encryption Keys by an Alternative Name
@@ -208,7 +204,7 @@ Explicit Encryption
208
204
~~~~~~~~~~~~~~~~~~~
209
205
210
206
Explicit encryption is a MongoDB community feature and does not use
211
- crypt_shared_ or mongocryptd_ . Explicit encryption is provided by the
207
+ ``crypt_shared`` or ``mongocryptd`` . Explicit encryption is provided by the
212
208
:php:`MongoDB\Driver\ClientEncryption <mongodb-driver-clientencryption>` class.
213
209
214
210
.. literalinclude:: /examples/encryption/csfle-explicit_encryption.php
0 commit comments