4.6 KiB
PyNaCl: Python binding to the libsodium library
PyNaCl is a Python binding to libsodium, which is a fork of the Networking and Cryptography library. These libraries have a stated goal of improving usability, security and speed. It supports Python 2.7 and 3.4+ as well as PyPy 2.6+.
Features
- Digital signatures
- Secret-key encryption
- Public-key encryption
- Hashing and message authentication
- Password based key derivation and password hashing
Installation
Binary wheel install
PyNaCl ships as a binary wheel on OS X, Windows and Linux manylinux1 [1] , so all dependencies are included. Make sure you have an up-to-date pip and run:
System Message: WARNING/2 (<stdin>, line 42)
Cannot analyze code. Pygments package not found.
.. code-block:: console
$ pip install pynacl
Linux source build
PyNaCl relies on libsodium, a portable C library. A copy is bundled with PyNaCl so to install you can run:
System Message: WARNING/2 (<stdin>, line 52)
Cannot analyze code. Pygments package not found.
.. code-block:: console
$ pip install pynacl
If you'd prefer to use the version of libsodium provided by your distribution, you can disable the bundled copy during install by running:
System Message: WARNING/2 (<stdin>, line 59)
Cannot analyze code. Pygments package not found.
.. code-block:: console
$ SODIUM_INSTALL=system pip install pynacl
Warning
Usage of the legacy easy_install command provided by setuptools is generally discouraged, and is completely unsupported in PyNaCl's case.
| [1] | manylinux1 wheels are built on a baseline linux environment based on Centos 5.11 and should work on most x86 and x86_64 glibc based linux environments. |
Changelog
1.2.1 - 2017-12-04
- Update hypothesis minumum allowed version.
- Infrastructure: add proper configuration for readthedocs builder runtime environment.
1.2.0 - 2017-11-01
- Update libsodium to 1.0.15.
- Infrastructure: add jenkins support for automatic build of manylinux1 binary wheels
- Added support for SealedBox construction.
- Added support for argon2i and argon2id password hashing constructs and restructured high-level password hashing implementation to expose the same interface for all hashers.
- Added support for 128 bit siphashx24 variant of siphash24.
- Added support for from_seed APIs for X25519 keypair generation.
- Dropped support for Python 3.3.
1.1.2 - 2017-03-31
- reorder link time library search path when using bundled libsodium
1.1.1 - 2017-03-15
- Fixed a circular import bug in nacl.utils.
1.1.0 - 2017-03-14
- Dropped support for Python 2.6.
- Added shared_key() method on Box.
- You can now pass None to nonce when encrypting with Box or SecretBox and it will automatically generate a random nonce.
- Added support for siphash24.
- Added support for blake2b.
- Added support for scrypt.
- Update libsodium to 1.0.11.
- Default to the bundled libsodium when compiling.
- All raised exceptions are defined mixing-in nacl.exceptions.CryptoError
1.0.1 - 2016-01-24
- Fix an issue with absolute paths that prevented the creation of wheels.
1.0 - 2016-01-23
- PyNaCl has been ported to use the new APIs available in cffi 1.0+. Due to this change we no longer support PyPy releases older than 2.6.
- Python 3.2 support has been dropped.
- Functions to convert between Ed25519 and Curve25519 keys have been added.
0.3.0 - 2015-03-04
- The low-level API (nacl.c.*) has been changed to match the upstream NaCl C/C++ conventions (as well as those of other NaCl bindings). The order of arguments and return values has changed significantly. To avoid silent failures, nacl.c has been removed, and replaced with nacl.bindings (with the new argument ordering). If you have code which calls these functions (e.g. nacl.c.crypto_box_keypair()), you must review the new docstrings and update your code/imports to match the new conventions.