use shared library instead of mongocryptd

Author: timgraham

.github/workflows/encrypted_settings.py

@@ -4,13 +4,16 @@
 from mongodb_settings import *  # noqa: F403
 from pymongo.encryption import AutoEncryptionOpts
 
+os.environ["LD_LIBRARY_PATH"] = os.environ["GITHUB_WORKSPACE"] + "/lib/"
+
 DATABASES["encrypted"] = {  # noqa: F405
     "ENGINE": "django_mongodb_backend",
     "NAME": "djangotests_encrypted",
     "OPTIONS": {
         "auto_encryption_opts": AutoEncryptionOpts(
             key_vault_namespace="djangotests_encrypted.__keyVault",
             kms_providers={"local": {"key": os.urandom(96)}},
+            crypt_shared_lib_path=os.environ["GITHUB_WORKSPACE"] + "/lib/mongo_crypt_v1.so",
         ),
         "directConnection": True,
     },

.github/workflows/test-python-atlas.yml

@@ -52,26 +52,10 @@ jobs:
       - name: Start local Atlas
         working-directory: .
         run: bash .github/workflows/start_local_atlas.sh mongodb/mongodb-atlas-local:8.0.15
-      - name: Install mongosh
+      - name: Download crypt shared
         run: |
-          wget -q https://downloads.mongodb.com/compass/mongosh-2.2.10-linux-x64.tgz
-          tar -xzf mongosh-*-linux-x64.tgz
-          sudo cp mongosh-*-linux-x64/bin/mongosh /usr/local/bin/
-          mongosh --version
-      - name: Install mongocryptd from Enterprise tarball
-        run: |
-          curl -sSL -o mongodb-enterprise.tgz "https://downloads.mongodb.com/linux/mongodb-linux-x86_64-enterprise-ubuntu2204-8.0.15.tgz"
-          tar -xzf mongodb-enterprise.tgz
-          sudo cp mongodb-linux-x86_64-enterprise-ubuntu2204-8.0.15/bin/mongocryptd /usr/local/bin/
-      - name: Start mongocryptd
-        run: |
-          nohup mongocryptd --logpath=/tmp/mongocryptd.log &
-      - name: Verify MongoDB installation
-        run: |
-          mongosh --eval 'db.runCommand({ connectionStatus: 1 })'
-      - name: Verify mongocryptd is running
-        run: |
-          pgrep mongocryptd
+          wget https://downloads.mongodb.com/linux/mongo_crypt_shared_v1-linux-x86_64-enterprise-ubuntu2404-8.2.1.tgz
+          tar -xvzf mongo_crypt_shared_v1-linux-x86_64-enterprise-ubuntu2404-8.2.1.tgz lib/mongo_crypt_v1.so
       - name: Run tests
         run: python3 django_repo/tests/runtests_.py
     permissions:

docs/howto/queryable-encryption.rst

@@ -285,5 +285,29 @@ settings::
         },
     }
 
+
+.. admonition:: Dynamic library path configuration
+
+    The Automatic Encryption Shared Library is platform‑specific. Make sure to
+    download the correct version for your operating system and architecture,
+    and configure your environment so the system can locate it.
+
+    Use the following variables depending on your platform:
+
+    +---------------+---------------------------------+
+    | **Platform**  | **Environment Variable**        |
+    +---------------+---------------------------------+
+    | Windows       | ``PATH``                        |
+    +---------------+---------------------------------+
+    | macOS         | ``DYLD_FALLBACK_LIBRARY_PATH``  |
+    +---------------+---------------------------------+
+    | Linux         | ``LD_LIBRARY_PATH``             |
+    +---------------+---------------------------------+
+
+    For example on macOS, you can set the ``DYLD_FALLBACK_LIBRARY_PATH``
+    environment variable in your shell before starting your Django application::
+
+        $ export DYLD_FALLBACK_LIBRARY_PATH="/path/to/mongo_crypt_shared_v1.dylib:$DYLD_FALLBACK_LIBRARY_PATH"
+
 You are now ready to :doc:`start developing applications
 </topics/queryable-encryption>` with Queryable Encryption!