@@ -19,45 +19,43 @@ To get started using in-use encryption in your project, the
1919to be compiled with `libmongocrypt <https://github.com/mongodb/libmongocrypt>`_
2020(enabled by default).
2121
22- Additionally, either `crypt_shared`_ or `mongocryptd`_ are required in order to
22+ Additionally, either `` crypt_shared`` or `` mongocryptd`` are required in order to
2323use *automatic* client-side encryption. Neither is required for *explicit*
2424encryption.
2525
26-
27- crypt_shared
28- ~~~~~~~~~~~~
26+ ``crypt_shared``
27+ ~~~~~~~~~~~~~~~~
2928
3029The :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
3231require you to spawn another process to perform automatic encryption.
3332
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,
3635use the ``cryptSharedLibPath`` auto encryption
3736: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
4140fail if it cannot be loaded.
4241
4342For detailed installation instructions see the MongoDB documentation for the
4443:manual:`Automatic Encryption Shared Library </core/queryable-encryption/reference/shared-library/>`.
4544
45+ ``mongocryptd``
46+ ~~~~~~~~~~~~~~~
4647
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
5149encryption and is included as a component in the
5250:manual:`MongoDB Enterprise Server package </administration/install-enterprise/>`.
5351For detailed installation instructions see the
5452:manual:`MongoDB documentation on mongocryptd </core/csfle/reference/mongocryptd/>`.
5553
56- mongocryptd performs the following:
54+ `` mongocryptd`` performs the following:
5755
5856- Parses the automatic encryption rules specified in the client configuration.
5957 If the ``schemaMap`` auto encryption driver option contains invalid syntax,
60- mongocryptd returns an error.
58+ `` mongocryptd`` returns an error.
6159
6260- Uses the specified automatic encryption rules to mark fields in read and write
6361 operations for encryption.
@@ -67,14 +65,13 @@ mongocryptd performs the following:
6765 see :manual:`Supported Operations for Automatic Encryption </core/csfle/reference/supported-operations/>`.
6866
6967A 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
7169the spawning behavior via various auto encryption
7270:php:`driver options <manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`.
7371
74- mongocryptd is only responsible for supporting automatic client-side encryption
72+ `` mongocryptd`` is only responsible for supporting automatic client-side encryption
7573and does not itself perform any encryption or decryption.
7674
77-
7875Managing Encryption Keys
7976------------------------
8077
@@ -105,7 +102,6 @@ encryption key (e.g. user-specific encryption keys) or create them dynamically.
105102.. literalinclude:: /examples/encryption/create_data_key.php
106103 :language: php
107104
108-
109105.. _alt_name:
110106
111107Referencing Encryption Keys by an Alternative Name
@@ -208,7 +204,7 @@ Explicit Encryption
208204~~~~~~~~~~~~~~~~~~~
209205
210206Explicit 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
212208:php:`MongoDB\Driver\ClientEncryption <mongodb-driver-clientencryption>` class.
213209
214210.. literalinclude:: /examples/encryption/csfle-explicit_encryption.php
0 commit comments