Skip to content

DOCSP-37027: Additional 1.17 build fixes #1301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions docs/tutorial/encryption.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,45 +19,45 @@ To get started using in-use encryption in your project, the
to be compiled with `libmongocrypt <https://github.com/mongodb/libmongocrypt>`_
(enabled by default).

Additionally, either `crypt_shared`_ or `mongocryptd`_ are required in order to
Additionally, either ``crypt_shared`` or ``mongocryptd`` are required in order to
use *automatic* client-side encryption. Neither is required for *explicit*
encryption.


crypt_shared
~~~~~~~~~~~~
``crypt_shared``
~~~~~~~~~~~~~~~~

The :manual:`Automatic Encryption Shared Library </core/queryable-encryption/reference/shared-library/>`
(crypt_shared) provides the same functionality as mongocryptd_, but does not
(``crypt_shared``) provides the same functionality as ``mongocryptd``, but does not
require you to spawn another process to perform automatic encryption.

By default, the PHP driver attempts to load crypt_shared from the system path(s)
and uses it automatically if found. To load crypt_shared from another location,
By default, the PHP driver attempts to load ``crypt_shared`` from the system path(s)
and uses it automatically if found. To load ``crypt_shared`` from another location,
use the ``cryptSharedLibPath`` auto encryption
:php:`driver option <manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`
when constructing a client. If the driver cannot load crypt_shared it will
attempt to fallback to using mongocryptd by default. The
``cryptSharedLibRequired`` option may be used to always require crypt_shared and
when constructing a client. If the driver cannot load ``crypt_shared`` it will
attempt to fallback to using ``mongocryptd`` by default. The
``cryptSharedLibRequired`` option may be used to always require ``crypt_shared`` and
fail if it cannot be loaded.

For detailed installation instructions see the MongoDB documentation for the
:manual:`Automatic Encryption Shared Library </core/queryable-encryption/reference/shared-library/>`.


mongocryptd
~~~~~~~~~~~
``mongocryptd``
~~~~~~~~~~~~~~~

The mongocryptd binary is an alternative requirement for automatic client-side
The ``mongocryptd`` binary is an alternative requirement for automatic client-side
encryption and is included as a component in the
:manual:`MongoDB Enterprise Server package </administration/install-enterprise/>`.
For detailed installation instructions see the
:manual:`MongoDB documentation on mongocryptd </core/csfle/reference/mongocryptd/>`.

mongocryptd performs the following:
``mongocryptd`` performs the following:

- Parses the automatic encryption rules specified in the client configuration.
If the ``schemaMap`` auto encryption driver option contains invalid syntax,
mongocryptd returns an error.
``mongocryptd`` returns an error.

- Uses the specified automatic encryption rules to mark fields in read and write
operations for encryption.
Expand All @@ -67,11 +67,11 @@ mongocryptd performs the following:
see :manual:`Supported Operations for Automatic Encryption </core/csfle/reference/supported-operations/>`.

A client configured with auto encryption will automatically spawn the
mongocryptd process from the application's ``PATH``. Applications can control
``mongocryptd`` process from the application's ``PATH``. Applications can control
the spawning behavior via various auto encryption
:php:`driver options <manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`.

mongocryptd is only responsible for supporting automatic client-side encryption
``mongocryptd`` is only responsible for supporting automatic client-side encryption
and does not itself perform any encryption or decryption.


Expand Down Expand Up @@ -208,7 +208,7 @@ Explicit Encryption
~~~~~~~~~~~~~~~~~~~

Explicit encryption is a MongoDB community feature and does not use
crypt_shared_ or mongocryptd_. Explicit encryption is provided by the
``crypt_shared`` or ``mongocryptd``. Explicit encryption is provided by the
:php:`MongoDB\Driver\ClientEncryption <mongodb-driver-clientencryption>` class.

.. literalinclude:: /examples/encryption/csfle-explicit_encryption.php
Expand Down
Loading