A compilation-free, always up-to-date encryption library for Python that works on Windows, OS X, Linux and BSD. Supports the following versions of Python: 2.6, 2.7, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9 and pypy.
The library integrates with the encryption library that is part of the operating system. This means that a compiler is never needed, and OS security updates take care of patching vulnerabilities. Supported operating systems include:
OS X 10.6 will not be supported due to a lack of available cryptographic primitives and due to lack of vendor support.
Currently the following features are implemented. Many of these should only be used for integration with existing/legacy systems. If you don't know which you should, or should not use, please see Learning.
The feature set was largely driven by the technologies used related to generating and validating X.509 certificates. The various CBC encryption schemes and KDFs are used to load encrypted private keys, and the various RSA padding schemes are part of X.509 signatures.
For modern cryptography not tied to an existing system, please see the Modern Cryptography section of the docs.
Please note that this library does not include modern block modes such as CTR and GCM due to lack of support from both OS X and OpenSSL 0.9.8.
In short, the existing cryptography libraries for Python didn't fit the needs of a couple of projects I was working on. Primarily these are applications distributed to end-users who aren't programmers, that need to handle TLS and various technologies related to X.509 certificates.
If your system is not tied to AES, TLS, X.509, or related technologies, you probably want more modern cryptography.
Depending on your needs, the cryptography package may be a good (or better) fit.
Some things that make oscrypto unique:
Some downsides include:
oscrypto is part of the modularcrypto family of Python packages:
1.2.1 - changelog
pip install oscrypto
oscrypto is licensed under the terms of the MIT license. See the LICENSE file for the exact license text.
Various combinations of platforms and versions of Python are tested via:
Tests are written using
unittest and require no third-party packages.
Depending on what type of source is available for the package, the following commands can be used to run the test suite.
When working within a Git working copy, or an archive of the Git repository, the full test suite is run via:
python run.py tests
To run only some tests, pass a regular expression as a parameter to
python run.py tests aes
To run tests multiple times, in order to catch edge-case bugs, pass an integer
tests. If combined with a regular expression for filtering, pass the
repeat count after the regular expression.
python run.py tests 20 python run.py tests aes 20
To run tests using a custom build of OpenSSL, or to use OpenSSL on Windows or
python run.py use_openssl=/path/to/libcrypto.dylib,/path/to/libssl.dylib tests
When working within an extracted source distribution (aka
PyPi, the full test suite is run via:
python setup.py test
When the package has been installed via pip (or another method), the package
oscrypto_tests may be installed and invoked to run the full test suite:
pip install oscrypto_tests python -m oscrypto_tests
To install the package used for linting, execute:
pip install --user -r requires/lint
The following command will run the linter:
python run.py lint
Support for code coverage can be installed via:
pip install --user -r requires/coverage
Coverage is measured by running:
python run.py coverage
To install the packages requires to generate the API documentation, run:
pip install --user -r requires/api_docs
The documentation can then be generated by running:
python run.py api_docs
To install the necessary packages for releasing a new version on PyPI, run:
pip install --user -r requires/release
Releases are created by:
Making a git tag in semver format
Running the command:
python run.py release
Existing releases can be found at https://pypi.python.org/pypi/oscrypto.
A task named
deps exists to download and stage all necessary testing
dependencies. On posix platforms,
curl is used for downloads and on Windows
Net.WebClient is used. This configuration sidesteps issues
related to getting pip to work properly and messing with
the version of Python being used.
ci task runs
lint (if flake8 is avaiable for the version of Python) and
tests if coverage is not available for the version of Python).
If the current directory is a clean git working copy, the coverage data is
submitted to codecov.io.
python run.py deps python run.py ci