Skip to main content

Scrypt for Python

Project description

Build Status Coverage Status PyPI version

There are a lot of different scrypt modules for Python, but none of them have everything that I’d like, so here’s One More1.

Features

  • Uses hashlib.scrypt on Python 3.6+ and OpenSSL 1.1+.
  • Uses system libscrypt2 as the next choice.
  • If neither is available, tries the scrypt Python module3 or libsodium4.
  • Offers a pure Python scrypt implementation for when there is no C scrypt.
  • Not unusably slow, even in pure Python… at least with pypy5.

With PyPy as the interpreter the Python implementation is around one fifth the speed of C scrypt. With CPython it is about 250x slower.

Requirements

  • Python 3.4+. Equivalent versions of PyPy should also work.
  • For Python 2.7.8+ support install the latest version 1.x instead.
  • If you want speed, you should use one of:
    • Python 3.6+ with OpenSSL 1.1+
    • libscrypt 1.8+ (older may work)
    • py-scrypt 0.6+ (pip install scrypt)
    • libsodium 1.0+

Usage

You can install the most recent release from PyPi using:

pip install pylibscrypt

You most likely want to create MCF hashes and store them somewhere, then check user-entered passwords against those hashes. For that you only need to use two functions from the API:

from pylibscrypt import scrypt_mcf, scrypt_mcf_check
# Generate an MCF hash with random salt
mcf = scrypt_mcf('Hello World')
# Test it
print(scrypt_mcf_check(mcf, 'Hello World'))   # prints True
print(scrypt_mcf_check(mcf, 'HelloPyWorld'))  # prints False

For full API, you can try help(pylibscrypt) from python after importing.

It is highly recommended that you use a random salt, i.e. don’t pass one.

Versioning

The package has a version number that can be read from python like so:

print(pylibscrypt.__version__)

The version number is of the form X.Y.Z, following Semantic Versioning6. Unreleased versions include a -git version specifier, e.g. 2.0.0-git < 2.0.0. Releases are tagged vX.Y.Z and release branches bX.Y.x when they differ from master.

Development

Development happens on GitHub7. If you find a bug, please open an issue there.

Running pylibscrypt.tests will test all implementations with some quick tests. Running any implementation directly (e.g. pylibscrypt.pylibsodium) will also compare to scrypt test vectors from the paper but this is slow for the pure Python version (pypyscrypt) unless running with pypy.

You can test more comprehensively using the docker test environment. Either build and run using make docker-run or pull the jvarho/pylibscrypt image and run using docker run -v ${PWD}:/app jvarho/pylibscrypt.

Pull requests should be automatically tested and will not be merged if broken.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pylibscrypt, version 2.0.0
Filename, size File type Python version Upload date Hashes
Filename, size pylibscrypt-2.0.0.tar.gz (17.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page