libmongocrypt-helper 1.7.0.0.1001 → 1.7.4.0.1000

data/ext/libmongocrypt/libmongocrypt/bindings/python/README.rst

@@ -0,0 +1,187 @@
+============
+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 2.7, 3.4+, and PyPy3.5+.
+
+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.2.1
+
+
+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 git@github.com:mongodb/libmongocrypt.git
+  $ python -m pip install ./libmongocrypt/bindings/python
+
+Next, install 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             rhel-62-64-bit      rhel72-zseries-test ubuntu1604-arm64
+  debian10            rhel-67-s390x       suse12-64           ubuntu1804-64
+  debian92            rhel-70-64-bit      suse12-s390x        ubuntu1804-arm64
+  linux-64-amazon-ami rhel-71-ppc64el     suse15-64           windows-test
+  macos               rhel-80-64-bit      ubuntu1604
+
+macOS::
+
+  $ # Set PYMONGOCRYPT_LIB for macOS:
+  $ export PYMONGOCRYPT_LIB=$(pwd)/libmongocrypt-all/macos/nocrypto/lib/libmongocrypt.dylib
+  $ python -c "import pymongocrypt; print(pymongocrypt.libmongocrypt_version())"
+  1.2.1
+
+Windows::
+
+  $ # Set PYMONGOCRYPT_LIB for Windows:
+  $ chmod +x $(pwd)/libmongocrypt-all/windows-test/nocrypto/bin/mongocrypt.dll
+  $ export PYMONGOCRYPT_LIB=$(pwd)/libmongocrypt-all/windows-test/nocrypto/bin/mongocrypt.dll
+  $ python -c "import pymongocrypt; print(pymongocrypt.libmongocrypt_version())"
+  1.2.1
+
+Linux::
+
+  $ # 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.2.1
+
+Dependencies
+============
+
+PyMongoCrypt supports CPython 2.7, 3.4+, PyPy, and PyPy3.5+.
+
+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 "<stdin>", line 1, in <module>
+    File "pymongocrypt/__init__.py", line 15, in <module>
+      from pymongocrypt.binding import libmongocrypt_version, lib
+    File "pymongocrypt/binding.py", line 803, in <module>
+      lib = ffi.dlopen(os.environ.get('PYMONGOCRYPT_LIB', 'mongocrypt'))
+    File "/.../lib/python3.7/site-packages/cffi/api.py", line 146, in dlopen
+      lib, function_cache = _make_ffi_library(self, name, flags)
+    File "/.../lib/python3.7/site-packages/cffi/api.py", line 828, in _make_ffi_library
+      backendlib = _load_backend_lib(backend, libname, flags)
+    File "/.../lib/python3.7/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.2.1
+
+Testing
+=======
+
+The easiest way to run the tests is to run **python setup.py test** in
+the root of the distribution.

data/ext/libmongocrypt/libmongocrypt/bindings/python/RELEASE.rst

@@ -0,0 +1,107 @@
+=====================
+PyMongoCrypt Releases
+=====================
+
+Versioning
+----------
+
+PyMongoCrypt's version numbers follow `semantic versioning`_: each version
+number is structured "major.minor.patch". Patch releases fix bugs, minor
+releases add features (and may fix bugs), and major releases include API
+changes that break backwards compatibility (and may add features and fix
+bugs).
+
+In between releases we add .devN to the version number to denote the version
+under development. So if we just released 1.0.0, then the current dev
+version might be 1.0.1.dev0 or 1.1.0.dev0.
+
+PyMongoCrypt's version numbers do not necessarily correspond to the embedded
+libmongocrypt library's version number. For example, assume the current
+PyMongoCrypt version is 1.0 and libmongocrypt is 1.0. Let's say that
+libmongocrypt 2.0.0 is released which has breaking changes to its API. If
+those 2.0.0 changes do not require any breaking changes to PyMongoCrypt, then
+the next version can be 1.1.
+
+.. _semantic versioning: http://semver.org/
+
+Release Process
+---------------
+
+PyMongoCrypt ships wheels for macOS, Windows, and manylinux2010 that include
+an embedded libmongocrypt build. Releasing a new version requires macOS with
+Docker and a Windows machine.
+
+#. Create a ticket for the release and create a PR.  The PR needs to include
+   the next steps including the version change because the branch is protected
+   from directly pushing commits.
+#. Edit the release.sh script to embed the most recent libmongocrypt tag into
+   our wheels, for example::
+
+     # The libmongocrypt git revision release to embed in our wheels.
+     -REVISION=$(git rev-list -n 1 1.0.0)
+     +REVISION=$(git rev-list -n 1 1.0.1)
+
+#. Add a changlog entry for this release in CHANGELOG.rst.
+#. Bump "__version__" in ``pymongocrypt/version.py``.
+#. After merging the PR, clone the repository and check out the commit
+   with the version change.
+
+#. Create and push tag::
+
+   $ git tag -a "pymongocrypt-<version>" -m "pymongocrypt-<version"
+   $ git push --tags
+
+#. Pushing a tag will trigger a release process in Evergreen which builds
+   wheels for manylinux, macOS, and Windows. Wait for the "release-python-combine"
+   task to complete and then download the "Release Python files all" archive. See:
+   https://evergreen.mongodb.com/waterfall/libmongocrypt?bv_filter=release
+   (requires auth)
+
+   The contents should look like this::
+
+     $ ls path/to/archive
+     pymongocrypt-<version>.tar.gz
+     pymongocrypt-<version>-py2.py3-none-manylinux2010_x86_64.whl
+     pymongocrypt-<version>-py2.py3-none-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
+     pymongocrypt-<version>-py2.py3-none-macosx_10_14_x86_64.whl
+     pymongocrypt-<version>-py2.py3-none-macosx_11_0_universal2.whl
+     pymongocrypt-<version>-py2.py3-none-win_amd64.whl
+
+#. Upload all the release packages to PyPI with twine::
+
+     $ python3 -m twine upload dist/*
+
+#. Create a new PR against the same ticket to update version to a ``.dev0``
+   version.
+
+
+Manually Creating Wheels
+------------------------
+
+#. Build the release packages for macOS and manylinux by running the release.sh
+   script on macOS. Note that Docker must be running::
+
+     $ git clone git@github.com:mongodb/libmongocrypt.git
+     $ cd libmongocrypt/bindings/python
+     $ git checkout "pymongocrypt <release version number>"
+     $ MACOS_TARGET=macos_x86_64 PYTHON=<python37> ./release.sh
+     $ PYTHON=<python310> ./release.sh
+
+  Make sure to run using the official binaries for Python 3.7 and 3.10.  You
+  should end up with the same files created by Evergreen (except for the Windows wheel).
+
+#. To build the release package for Windows, launch a windows-64-vsMulti-small
+   Evergreen spawn host, clone the repro, checkout the release tag, and run
+   the release script::
+
+     $ git clone git@github.com:mongodb/libmongocrypt.git
+     $ cd libmongocrypt/bindings/python
+     $ git checkout "pymongocrypt <release version number>"
+     $ ./release.sh
+
+   This will create the following distributions::
+
+     $ ls dist
+     pymongocrypt-<version>-py2.py3-none-win_amd64.whl
+
+

data/ext/libmongocrypt/libmongocrypt/bindings/python/build-manylinux-wheel.sh

@@ -0,0 +1,16 @@
+#!/bin/bash -ex
+cd /python
+
+# Compile wheel
+# https://github.com/pypa/manylinux/issues/49
+rm -rf build
+/opt/python/cp37-cp37m/bin/python setup.py bdist_wheel --universal
+
+# Audit wheels and write manylinux tag
+for whl in dist/*.whl; do
+    # Skip already built manylinux wheels.
+    if [[ "$whl" != *"manylinux"* ]]; then
+        auditwheel repair $whl -w dist
+        rm $whl
+    fi
+done

data/ext/libmongocrypt/libmongocrypt/bindings/python/pymongocrypt/__init__.py

@@ -0,0 +1,16 @@
+# Copyright 2019-present MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from pymongocrypt.binding import libmongocrypt_version, lib
+from pymongocrypt.version import __version__

data/ext/libmongocrypt/libmongocrypt/bindings/python/pymongocrypt/auto_encrypter.py

@@ -0,0 +1,61 @@
+# Copyright 2019-present MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from pymongocrypt.mongocrypt import MongoCrypt
+from pymongocrypt.state_machine import run_state_machine
+
+
+class AutoEncrypter(object):
+    def __init__(self, callback, mongo_crypt_opts):
+        """Encrypts and decrypts MongoDB commands.
+
+        This class is used by a driver to support automatic encryption and
+        decryption of MongoDB commands.
+
+        :Parameters:
+          - `callback`: A :class:`MongoCryptCallback`.
+          - `mongo_crypt_opts`: A :class:`MongoCryptOptions`.
+        """
+        self.callback = callback
+        self.mongocrypt = MongoCrypt(mongo_crypt_opts, callback)
+
+    def encrypt(self, database, cmd):
+        """Encrypt a MongoDB command.
+
+        :Parameters:
+          - `database`: The database for this command.
+          - `cmd`: A MongoDB command as BSON.
+
+        :Returns:
+          The encrypted command.
+        """
+        with self.mongocrypt.encryption_context(database, cmd) as ctx:
+            return run_state_machine(ctx, self.callback)
+
+    def decrypt(self, response):
+        """Decrypt a MongoDB command response.
+
+        :Parameters:
+          - `response`: A MongoDB command response as BSON.
+
+        :Returns:
+          The decrypted command response.
+        """
+        with self.mongocrypt.decryption_context(response) as ctx:
+            return run_state_machine(ctx, self.callback)
+
+    def close(self):
+        """Cleanup resources."""
+        self.mongocrypt.close()
+        self.callback.close()

data/ext/libmongocrypt/libmongocrypt/bindings/python/pymongocrypt/binary.py

@@ -0,0 +1,94 @@
+# Copyright 2019-present MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Internal helpers for dealing with mongocrypt_binary_t."""
+
+from pymongocrypt.binding import ffi, lib
+from pymongocrypt.errors import MongoCryptError
+
+
+def _to_bytes(mongocrypt_binary):
+    """Returns this mongocrypt_binary_t as bytes."""
+    data = lib.mongocrypt_binary_data(mongocrypt_binary)
+    if data == ffi.NULL:
+        raise MongoCryptError('mongocrypt_binary_data returned NULL')
+    data_len = lib.mongocrypt_binary_len(mongocrypt_binary)
+    return ffi.unpack(ffi.cast("char*", data), data_len)
+
+
+def _write_bytes(mongocrypt_binary, data):
+    """Writes the given data to a mongocrypt_binary_t."""
+    buf = lib.mongocrypt_binary_data(mongocrypt_binary)
+    if buf == ffi.NULL:
+        raise MongoCryptError('mongocrypt_binary_data returned NULL')
+
+    ffi.memmove(buf, data, len(data))
+
+
+class _MongoCryptBinary(object):
+    __slots__ = ("bin",)
+
+    def __init__(self, binary):
+        """Wraps a mongocrypt_binary_t."""
+        if binary == ffi.NULL:
+            raise MongoCryptError(
+                "unable to create new mongocrypt_binary object")
+        self.bin = binary
+
+    def _close(self):
+        """Cleanup resources."""
+        if self.bin:
+            lib.mongocrypt_binary_destroy(self.bin)
+            self.bin = None
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self._close()
+
+    def to_bytes(self):
+        """Returns this mongocrypt_binary_t as bytes."""
+        data = lib.mongocrypt_binary_data(self.bin)
+        if data == ffi.NULL:
+            return b''
+        data_len = lib.mongocrypt_binary_len(self.bin)
+        return ffi.unpack(ffi.cast("char*", data), data_len)
+
+
+class MongoCryptBinaryOut(_MongoCryptBinary):
+    __slots__ = ()
+
+    def __init__(self):
+        """Wraps a mongocrypt_binary_t."""
+        super(MongoCryptBinaryOut, self).__init__(lib.mongocrypt_binary_new())
+
+
+class MongoCryptBinaryIn(_MongoCryptBinary):
+    __slots__ = ("cref",)
+
+    def __init__(self, data):
+        """Creates a mongocrypt_binary_t from binary data."""
+        # mongocrypt_binary_t does not own the data it is passed so we need to
+        # create a separate reference to keep the data alive.
+        self.cref = ffi.from_buffer("uint8_t[]", data)
+        super(MongoCryptBinaryIn, self).__init__(
+            lib.mongocrypt_binary_new_from_data(self.cref, len(data)))
+
+    def _close(self):
+        """Cleanup resources."""
+        super(MongoCryptBinaryIn, self)._close()
+        if self.cref is not None:
+            ffi.release(self.cref)
+            self.cref = None