@@ -19,45 +19,45 @@ 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
26
27
- crypt_shared
28
- ~~~~~~~~~~~~
27
+ `` crypt_shared``
28
+ ~~~~~~~~~~~~~~~~
29
29
30
30
The :manual:`Automatic Encryption Shared Library </core/queryable-encryption/reference/shared-library/>`
31
- (crypt_shared) provides the same functionality as mongocryptd_ , but does not
31
+ (`` crypt_shared`` ) provides the same functionality as ``mongocryptd`` , but does not
32
32
require you to spawn another process to perform automatic encryption.
33
33
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,
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,
36
36
use the ``cryptSharedLibPath`` auto encryption
37
37
: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
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
41
41
fail if it cannot be loaded.
42
42
43
43
For detailed installation instructions see the MongoDB documentation for the
44
44
:manual:`Automatic Encryption Shared Library </core/queryable-encryption/reference/shared-library/>`.
45
45
46
46
47
- mongocryptd
48
- ~~~~~~~~~~~
47
+ `` mongocryptd``
48
+ ~~~~~~~~~~~~~~~
49
49
50
- The mongocryptd binary is an alternative requirement for automatic client-side
50
+ The `` mongocryptd`` binary is an alternative requirement for automatic client-side
51
51
encryption and is included as a component in the
52
52
:manual:`MongoDB Enterprise Server package </administration/install-enterprise/>`.
53
53
For detailed installation instructions see the
54
54
:manual:`MongoDB documentation on mongocryptd </core/csfle/reference/mongocryptd/>`.
55
55
56
- mongocryptd performs the following:
56
+ `` mongocryptd`` performs the following:
57
57
58
58
- Parses the automatic encryption rules specified in the client configuration.
59
59
If the ``schemaMap`` auto encryption driver option contains invalid syntax,
60
- mongocryptd returns an error.
60
+ `` mongocryptd`` returns an error.
61
61
62
62
- Uses the specified automatic encryption rules to mark fields in read and write
63
63
operations for encryption.
@@ -67,11 +67,11 @@ mongocryptd performs the following:
67
67
see :manual:`Supported Operations for Automatic Encryption </core/csfle/reference/supported-operations/>`.
68
68
69
69
A client configured with auto encryption will automatically spawn the
70
- mongocryptd process from the application's ``PATH``. Applications can control
70
+ `` mongocryptd`` process from the application's ``PATH``. Applications can control
71
71
the spawning behavior via various auto encryption
72
72
:php:`driver options <manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`.
73
73
74
- mongocryptd is only responsible for supporting automatic client-side encryption
74
+ `` mongocryptd`` is only responsible for supporting automatic client-side encryption
75
75
and does not itself perform any encryption or decryption.
76
76
77
77
@@ -208,7 +208,7 @@ Explicit Encryption
208
208
~~~~~~~~~~~~~~~~~~~
209
209
210
210
Explicit encryption is a MongoDB community feature and does not use
211
- crypt_shared_ or mongocryptd_ . Explicit encryption is provided by the
211
+ ``crypt_shared`` or ``mongocryptd`` . Explicit encryption is provided by the
212
212
:php:`MongoDB\Driver\ClientEncryption <mongodb-driver-clientencryption>` class.
213
213
214
214
.. literalinclude:: /examples/encryption/csfle-explicit_encryption.php
0 commit comments