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 and pypy.
- Supported Operating Systems
- Why Another Python Crypto Library?
- Related Crypto Libraries
- Current Release
- Continuous Integration
Supported Operating Systems
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:
- Windows XP or newer
- OS X 10.7 or newer
- Linux or BSD
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.
- TLSv1.x socket wrappers
- Certificate verification performed by OS trust roots
- Custom CA certificate support
- SNI support (except Windows XP)
- Session reuse via IDs/tickets
- Modern cipher suites (RC4, DES, anon and NULL ciphers disabled)
- Weak DH parameters and certificate signatures rejected
- SSLv3 disabled by default, SSLv2 unimplemented
- CRL/OCSP revocation checks consistenty disabled
- Exporting OS trust roots
- PEM-formatted CA certs from the OS for OpenSSL-based code
- AES (128, 192, 256), CBC mode, PKCS7 padding
- AES (128, 192, 256), CBC mode, no padding
- TripleDES 3-key, CBC mode, PKCS5 padding
- TripleDes 2-key, CBC mode, PKCS5 padding
- DES, CBC mode, PKCS5 padding
- RC2 (40-128), CBC mode, PKCS5 padding
- RC4 (40-128)
- RSA PKCSv1.5
- RSA OAEP (SHA1 only)
- Generating public/private key pairs
- RSA (1024, 2048, 3072, 4096 bit)
- DSA (1024 bit on all platforms - 2048, 3072 bit with OpenSSL 1.x or Windows 8)
- EC (secp256r1, secp384r1, secp521r1 curves)
- Generating DH parameters
- Signing and verification
- RSA PKCSv1.5
- RSA PSS
- Loading and normalizing DER and PEM formatted keys
- RSA public and private keys
- DSA public and private keys
- EC public and private keys
- X.509 Certificates
- PKCS#12 archives (
- Key derivation
- PKCS#12 KDF
- Random byte generation
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.
Why Another Python Crypto Library?
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:
- No compiler needed, ever. No need to pre-compile shared libraries. Just distribute the Python source files, any way you want.
- Uses the operating system's crypto library - does not require OpenSSL on Windows or OS X.
- Relies on the operating system for security patching. You don't need to rebuild all of your apps every time there is a new TLS vulnerability.
- Intentionally limited in scope to crypto primitives. Other libraries built upon it deal with certificate path validation, creating certificates and CSRs, constructing CMS structures.
- Built on top of a fast, pure-Python ASN.1 parser, asn1crypto.
- TLS functionality uses the operating system's trust list/CA certs and is pre-configured with sane defaults
- Public APIs are simple and use strict type checks to avoid errors
Some downsides include:
- Does not currently implement:
- standalone DH key exchange
- various encryption modes such as GCM, CCM, CTR, CFB, OFB, ECB
- key wrapping
- Non-TLS functionality is architected for dealing with data that fits in memory and is available all at once
- Developed by a single developer
Related Crypto Libraries
oscrypto is part of the modularcrypto family of Python packages:
0.17.3 - changelog
- Python 2.6, 2.7, 3.2, 3.3, 3.4, 3.5, 3.6, pypy
pip install oscrypto
oscrypto is licensed under the terms of the MIT license. See the LICENSE file for the exact license text.
Tests are written using
unittest and require no third-party packages:
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
OS X, add
python run.py use_openssl=/path/to/libcrypto.dylib,/path/to/libssl.dylib tests
To install required development dependencies, execute:
pip install -r dev-requirements.txt
The following commands will run the linter and test coverage:
python run.py lint python run.py coverage
The following will regenerate the API documentation:
python run.py api_docs
python run.py release