pymongocrypt

============ PyMongoCrypt

:Info: Python bindings for libmongocrypt. See GitHub <https://github.com/mongodb/libmongocrypt/tree/master/bindings/python>_ for the latest source. :Author: Shane Harvey

About

Python wrapper library for libmongocrypt that supports client side encryption in drivers. PyMongoCrypt uses cffi <https://pypi.org/project/cffi/>_ and cryptography <https://pypi.org/project/cryptography/>_.

PyMongoCrypt supports Python 3.8+ and PyPy3.9+.

Support / Feedback

For issues with, questions about, or feedback for PyMongoCrypt, please look into our support channels <http://www.mongodb.org/about/support>. Please do not email any of the PyMongoCrypt developers directly with issues or questions - you're more likely to get an answer on the mongodb-user <http://groups.google.com/group/mongodb-user> list on Google Groups.

Bugs / Feature Requests

Think you’ve found a bug? Want to see a new feature in PyMongoCrypt? Please open a case in our issue management tool, JIRA:

• Create an account and login <https://jira.mongodb.org>_.
• Navigate to the PYTHON project <https://jira.mongodb.org/browse/PYTHON>_.
• Click Create Issue - Please provide as much information as possible about the issue type and how to reproduce it.

Bug reports in JIRA for all driver projects (i.e. PYTHON, CSHARP, JAVA) and the Core Server (i.e. SERVER) project are public.

How To Ask For Help

Please include all of the following information when opening an issue:

• Detailed steps to reproduce the problem, including full traceback, if possible.

• The exact python version used, with patch level::

  $ python -c "import sys; print(sys.version)"

• The exact version of PyMongoCrypt used::

  $ python -c "import pymongocrypt; print(pymongocrypt.version)"

• The exact version of libbmongocrypt used by PyMongoCrypt::

  $ python -c "import pymongocrypt; print(pymongocrypt.libmongocrypt_version())"

• The exact version of PyMongo used (if applicable), with patch level::

  $ python -c "import pymongo; print(pymongo.version); print(pymongo.has_c())"

• The operating system and version (e.g. Windows 7, OSX 10.8, ...)

• Web framework or asynchronous network library used, if any, with version (e.g. Django 1.7, mod_wsgi 4.3.0, gevent 1.0.1, Tornado 4.0.2, ...)

Security Vulnerabilities

If you've identified a security vulnerability in a driver or any other MongoDB project, please report it according to the instructions here <http://docs.mongodb.org/manual/tutorial/create-a-vulnerability-report>_.

Installation

PyMongoCrypt can be installed with pip <http://pypi.python.org/pypi/pip>_::

$ python -m pip install pymongocrypt $ python -c "import pymongocrypt; print(pymongocrypt.libmongocrypt_version())" 1.9.0

PyMongoCrypt ships wheels for macOS, Windows, and manylinux2010 that include an embedded libmongocrypt build.

Installing from wheels on Linux requires pip 19 or later because it adds support for manylinux2010 wheels <https://pip.pypa.io/en/stable/news/#id108>_. Older versions of pip will attempt installation using the pymongocrypt-X.Y.tar.gz source distribution which requires the extra step of downloading and installing libmongocrypt as described below. Users can upgrade to pip 19 by running::

$ python -m pip install --upgrade 'pip>=19'

Installing from source

Installing from source (or the pymongocrypt-X.Y.tar.gz source distribution, or pip < 19 on Linux) requires an extra step of installing libmongocrypt. First, install PyMongoCrypt from source::

$ git clone [e-mail]:mongodb/libmongocrypt.git $ python -m pip install ./libmongocrypt/bindings/python

Next, install libmongocrypt:

Installing libmongocrypt ^^^^^^^^^^^^^^^^^^^^^^^^

libmongocrypt is continuously built and published on evergreen. The latest tarball containing libmongocrypt built on all supported variants is published here <https://s3.amazonaws.com/mciuploads/libmongocrypt/all/master/latest/libmongocrypt-all.tar.gz>_. Download and extract libmongocrypt-all.tar.gz and set PYMONGOCRYPT_LIB to the path to your operating system's libmongocrypt.so file. For example::

$ curl -O https://s3.amazonaws.com/mciuploads/libmongocrypt/all/master/latest/libmongocrypt-all.tar.gz $ mkdir libmongocrypt-all && tar xzf libmongocrypt-all.tar.gz -C libmongocrypt-all $ ls libmongocrypt-all amazon2 debian92 rhel-80-64-bit rhel72-zseries-test ubuntu1804-arm64 amazon2-arm64 linux-64-amazon-ami rhel-81-ppc64el suse12-64 ubuntu2004-64 amazon2023 macos rhel-82-arm64 suse15-64 ubuntu2004-arm64 amazon2023-arm64 rhel-62-64-bit rhel-83-zseries ubuntu1604 ubuntu2204-64 debian10 rhel-70-64-bit rhel-91-64-bit ubuntu1604-arm64 ubuntu2204-arm64 debian11 rhel-71-ppc64el rhel-91-arm64 ubuntu1804-64 windows-test

macOS::

$ # Set PYMONGOCRYPT_LIB for macOS: $ export PYMONGOCRYPT_LIB=$(pwd)/libmongocrypt-all/macos/lib/libmongocrypt.dylib $ python -c "import pymongocrypt; print(pymongocrypt.libmongocrypt_version())" 1.9.0

Windows::

$ # Set PYMONGOCRYPT_LIB for Windows: $ chmod +x $(pwd)/libmongocrypt-all/windows-test/bin/mongocrypt.dll $ export PYMONGOCRYPT_LIB=$(pwd)/libmongocrypt-all/windows-test/bin/mongocrypt.dll $ python -c "import pymongocrypt; print(pymongocrypt.libmongocrypt_version())" 1.9.0

Linux: set the libmongocrypt build for your platform, for example for Ubuntu 22.04 x86_64::

$ # Set PYMONGOCRYPT_LIB for Ubuntu 22.04 x86_64: $ export PYMONGOCRYPT_LIB=$(pwd)/libmongocrypt-all/ubuntu2204-64/lib/libmongocrypt.so $ python -c "import pymongocrypt; print(pymongocrypt.libmongocrypt_version())" 1.9.0 $ # Check that native crypto is enabled for better performance: $ python -c 'from pymongocrypt.binding import lib;print(lib.mongocrypt_is_crypto_available())' True

Note if your Linux platform is not available, the generic RHEL 6.2 x86_64 "nocrypto" build should still be compatible however the "nocrypto" build will result in lower performance for encryption and decryption::

$ # Set PYMONGOCRYPT_LIB for RHEL 6.2 x86_64: $ export PYMONGOCRYPT_LIB=$(pwd)/libmongocrypt-all/rhel-62-64-bit/nocrypto/lib64/libmongocrypt.so $ python -c "import pymongocrypt; print(pymongocrypt.libmongocrypt_version())" 1.9.0 $ python -c 'from pymongocrypt.binding import lib;print(lib.mongocrypt_is_crypto_available())' False

Other methods of installation (brew, rpm, yum, apt-get, deb, etc...) are documented here: https://www.mongodb.com/docs/manual/core/csfle/reference/libmongocrypt/#linux-installation

Dependencies

PyMongoCrypt supports Python 3.8+ and PyPy3.9+.

PyMongoCrypt requires cffi <https://pypi.org/project/cffi/>_ and cryptography <https://pypi.org/project/cryptography/>_.

If not installed using one of the official wheels, PyMongoCrypt also requires libmongocrypt to be installed on your system. If libmongocrypt is not installed you will see an error like this:

.. code-block:: python

import pymongocrypt Traceback (most recent call last): File "", line 1, in File "pymongocrypt/init.py", line 15, in from pymongocrypt.binding import libmongocrypt_version, lib File "pymongocrypt/binding.py", line 803, in lib = ffi.dlopen(os.environ.get('PYMONGOCRYPT_LIB', 'mongocrypt')) File "/.../lib/python3.8/site-packages/cffi/api.py", line 146, in dlopen lib, function_cache = _make_ffi_library(self, name, flags) File "/.../lib/python3.8/site-packages/cffi/api.py", line 828, in _make_ffi_library backendlib = _load_backend_lib(backend, libname, flags) File "/.../lib/python3.8/site-packages/cffi/api.py", line 823, in _load_backend_lib raise OSError(msg) OSError: ctypes.util.find_library() did not manage to locate a library called 'mongocrypt'

Use the PYMONGOCRYPT_LIB environment variable to load a locally installed libmongocrypt build without relying on platform specific library path environment variables, like LD_LIBRARY_PATH. For example::

$ export PYMONGOCRYPT_LIB='/path/to/libmongocrypt.so' $ python -c "import pymongocrypt; print(pymongocrypt.libmongocrypt_version())" 1.9.0

Testing

The easiest way to run the tests is to run python setup.py test in the root of the distribution.