Skip to content

Commit 834308f

Browse files
Document new extraOptions for auto-encryption
1 parent cbfdfca commit 834308f

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

src/libmongoc/doc/mongoc_auto_encryption_opts_set_extra.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,34 @@ Parameters
2525
* ``mongocryptdBypassSpawn`` set to true to prevent the driver from spawning the mongocryptd process (default behavior is to spawn).
2626
* ``mongocryptdSpawnPath`` set to a path (with trailing slash) to search for mongocryptd (defaults to empty string and uses default system paths).
2727
* ``mongocryptdSpawnArgs`` set to an array of string arguments to pass to ``mongocryptd`` when spawning (defaults to ``[ "--idleShutdownTimeoutSecs=60" ]``).
28+
* ``csflePath`` - Set a filepath string referring to a ``csfle`` dynamic library
29+
file. Default is undefined.
30+
31+
* If not specified (the default), ``libmongocrypt`` will attempt to load
32+
``csfle`` using the host system's default dynamic-library-search system.
33+
* If used, should be the path to the ``csfle`` dynamic library file itself,
34+
not just the directory that contains it.
35+
* If the given path is a relative path and the first path component is
36+
``$ORIGIN``, the ``$ORIGIN`` component will be replaced with the absolute
37+
path to the directory containing the ``libmongocrypt`` library in use by the
38+
application.
39+
40+
.. note:: No other ``RPATH``/``RUNPATH``-style substitutions are availbale.
41+
42+
* If the given path is a relative path, the path will be resolves relative to
43+
the working directory of the operating system process.
44+
* If this option is specified and ``libmongocrypt`` fails to load ``csfle``
45+
from that filepath, ``libmongocrypt`` will fail to initialize with a
46+
hard-error, and will not attempt to search for ``csfle`` in any other
47+
locations.
48+
49+
* ``csfleRequired`` - If set to ``true``, and ``libmongocrypt`` fails to load a
50+
``csfle`` dynamic library, generate a hard-error and do not attempt to spawn
51+
``mongocryptd``.
52+
53+
If set to ``false`` (the default), ``csflePath`` is not specified, *and*
54+
``libmongocrypt`` fails to load ``csfle``, then ``libmongocrypt`` will proceed
55+
without ``csfle`` and fall back to using ``mongocryptd``.
2856

2957
For more information, see the `Client-Side Encryption specification <https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#extraoptions>`_.
3058

0 commit comments

Comments
 (0)