Skip to main content

Python scrypt bindings

This is a set of Python bindings for the scrypt key derivation function.

Latest Version https://anaconda.org/conda-forge/scrypt/badges/version.svg https://anaconda.org/conda-forge/scrypt/badges/downloads.svg

Scrypt is useful when encrypting password as it is possible to specify a minimum amount of time to use when encrypting and decrypting. If, for example, a password takes 0.05 seconds to verify, a user won’t notice the slight delay when signing in, but doing a brute force search of several billion passwords will take a considerable amount of time. This is in contrast to more traditional hash functions such as MD5 or the SHA family which can be implemented extremely fast on cheap hardware.

Installation

For Debian and Ubuntu, please ensure that the following packages are installed:

$ sudo apt-get install build-essential libssl-dev python-dev

For Fedora and RHEL-derivatives, please ensure that the following packages are installed:

$ sudo yum install gcc openssl-devel python-devel

For OSX, please do the following:

$ brew install openssl
$ export CFLAGS="-I$(brew --prefix openssl)/include $CFLAGS"
$ export LDFLAGS="-L$(brew --prefix openssl)/lib $LDFLAGS"

For OSX, you can also use the precompiled wheels. They are installed by:

$ pip install scrypt

For Windows, please use the precompiled wheels. They are installed by:

$ pip install scrypt

For Windows, when the package should be compiled, the development package from https://slproweb.com/products/Win32OpenSSL.html is needed. It needs to be installed to C:OpenSSL-Win64.

You can install py-scrypt from this repository if you want the latest but possibly non-compiling version:

$ hg clone http://bitbucket.org/mhallin/py-scrypt
$ cd py-scrypt
$ python setup.py build

Become superuser (or use virtualenv):
# python setup.py install

Run tests after install:
$ python setup.py test

Or you can install the latest release from PyPi:

$ pip install scrypt

Users of the Anaconda Python distribution can directly obtain pre-built Windows, Intel Linux or macOS / OSX binaries from the conda-forge channel. This can be done via:

$ conda install -c conda-forge scrypt

If you want py-scrypt for your Python 3 environment, just run the above commands with your Python 3 interpreter. Py-scrypt supports both Python 2 and 3.

From version 0.6.0 (not available on PyPi yet), py-scrypt supports PyPy as well.

Changelog

0.8.8

  • setup.py for windows improved, works with openssl 1.0.2 and 1.1.1

0.8.7

  • setup.py for windows fixed

0.8.6

  • setup.py fixed, scrypt could not be imported in version 0.8.5

0.8.5

  • MANIFEST.in fixed

  • scrypt.py moved into own scrypt directory with __init__.py

  • openssl library path for osx wheel repaired

0.8.4

  • __version__ added to scrypt

  • missing void in sha256.c fixed

0.8.3

  • scrypt updated to 1.2.1

  • Wheels are created for python 3.6

Usage

Fore encryption/decryption, the library exports two functions encrypt and decrypt:

>>> import scrypt
>>> data = scrypt.encrypt('a secret message', 'password', maxtime=0.1) # This will take at least 0.1 seconds
>>> data[:20]
'scrypt\x00\r\x00\x00\x00\x08\x00\x00\x00\x01RX9H'
>>> scrypt.decrypt(data, 'password', maxtime=0.1) # This will also take at least 0.1 seconds
'a secret message'
>>> scrypt.decrypt(data, 'password', maxtime=0.05) # scrypt won't be able to decrypt this data fast enough
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
scrypt.error: decrypting file would take too long
>>> scrypt.decrypt(data, 'wrong password', maxtime=0.1) # scrypt will throw an exception if the password is incorrect
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
scrypt.error: password is incorrect

From these, one can make a simple password verifier using the following functions:

def hash_password(password, maxtime=0.5, datalength=64):
    return scrypt.encrypt(os.urandom(datalength), password, maxtime=maxtime)

def verify_password(hashed_password, guessed_password, maxtime=0.5):
    try:
        scrypt.decrypt(hashed_password, guessed_password, maxtime)
        return True
    except scrypt.error:
        return False

But, if you want output that is deterministic and constant in size, you can use the hash function:

>>> import scrypt
>>> h1 = scrypt.hash('password', 'random salt')
>>> len(h1)  # The hash will be 64 bytes by default, but is overridable.
64
>>> h1[:10]
'\xfe\x87\xf3hS\tUo\xcd\xc8'
>>> h2 = scrypt.hash('password', 'random salt')
>>> h1 == h2 # The hash function is deterministic
True

Acknowledgements

Scrypt was created by Colin Percival and is licensed as 2-clause BSD. Since scrypt does not normally build as a shared library, I have included the source for the currently latest version of the library in this repository. When a new version arrives, I will update these sources.

Kelvin Wong on Bitbucket provided changes to make the library available on Mac OS X 10.6 and earlier, as well as changes to make the library work more like the command-line version of scrypt by default. Kelvin also contributed with the unit tests, lots of cross platform testing and work on the hash function.

Burstaholic on Bitbucket provided the necessary changes to make the library build on Windows.

The python-appveyor-demo repository for setting up automated Windows builds for a multitude of Python versions.

License

This library is licensed under the same license as scrypt; 2-clause BSD.

Metadata

Release files for scrypt 0.8.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scrypt 0.8.8
File Size Uploaded Provenance Actions
scrypt-0.8.8.tar.gz 53.2 kB Without provenance Details for scrypt-0.8.8.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for scrypt 0.8.8
File Actions
scrypt-0.8.8-cp37-cp37m-win_amd64.whl CPython 3.7 CPython 3.7 pymalloc Windows x86-64 Details for scrypt-0.8.8-cp37-cp37m-win_amd64.whl
scrypt-0.8.8-cp37-cp37m-win32.whl CPython 3.7 CPython 3.7 pymalloc Windows x86-32 Details for scrypt-0.8.8-cp37-cp37m-win32.whl
scrypt-0.8.8-cp36-cp36m-win_amd64.whl CPython 3.6 CPython 3.6 pymalloc Windows x86-64 Details for scrypt-0.8.8-cp36-cp36m-win_amd64.whl
scrypt-0.8.8-cp36-cp36m-win32.whl CPython 3.6 CPython 3.6 pymalloc Windows x86-32 Details for scrypt-0.8.8-cp36-cp36m-win32.whl
scrypt-0.8.8-cp35-cp35m-win_amd64.whl CPython 3.5 CPython 3.5 pymalloc Windows x86-64 Details for scrypt-0.8.8-cp35-cp35m-win_amd64.whl
scrypt-0.8.8-cp35-cp35m-win32.whl CPython 3.5 CPython 3.5 pymalloc Windows x86-32 Details for scrypt-0.8.8-cp35-cp35m-win32.whl
scrypt-0.8.8-cp34-cp34m-win_amd64.whl CPython 3.4 CPython 3.4 pymalloc Windows x86-64 Details for scrypt-0.8.8-cp34-cp34m-win_amd64.whl
scrypt-0.8.8-cp34-cp34m-win32.whl CPython 3.4 CPython 3.4 pymalloc Windows x86-32 Details for scrypt-0.8.8-cp34-cp34m-win32.whl
scrypt-0.8.8-cp27-cp27m-win_amd64.whl CPython 2.7 CPython 2.7 pymalloc Windows x86-64 Details for scrypt-0.8.8-cp27-cp27m-win_amd64.whl
scrypt-0.8.8-cp27-cp27m-win32.whl CPython 2.7 CPython 2.7 pymalloc Windows x86-32 Details for scrypt-0.8.8-cp27-cp27m-win32.whl

Total release size: 297.5 kB

Release files / scrypt-0.8.8.tar.gz

Download URL scrypt-0.8.8.tar.gz
Size 53.2 kB
Tags Source
SHA-256 checksum
How to use checksums
bfbb764d2af8a79bb9cacb1fc32a9d85eac8fd1ff7ca8d66cf03dc255305b836
BLAKE2b-256 checksum
How to use checksums
f10290b3b4a51aeafae418bcc5a0c03617477005e2ac613c4091cec6205f6c66
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.1

Release files / scrypt-0.8.8-cp37-cp37m-win_amd64.whl

Download URL scrypt-0.8.8-cp37-cp37m-win_amd64.whl
Size 27.5 kB
Tags CPython 3.7 CPython 3.7 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
30c8233891805009e84936ad41341fb958e1295d3a4a9b72cc260332a1f432cb
BLAKE2b-256 checksum
How to use checksums
d6b3a7091d33f9ed3a8abdd7a19070e1771ac0fa5847944b8e61f70a85818ffc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.1

Release files / scrypt-0.8.8-cp37-cp37m-win32.whl

Download URL scrypt-0.8.8-cp37-cp37m-win32.whl
Size 24.5 kB
Tags CPython 3.7 CPython 3.7 pymalloc Windows x86-32
SHA-256 checksum
How to use checksums
857abc6c9eca16f3b79fea4d2d9a0dc03ebea15f0656f3e6053fcd56ac1e5634
BLAKE2b-256 checksum
How to use checksums
2e609b0f81eb10fe414b1e0a8b195f48bf83434e07156ea104fe60b10569a3d2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.1

Release files / scrypt-0.8.8-cp36-cp36m-win_amd64.whl

Download URL scrypt-0.8.8-cp36-cp36m-win_amd64.whl
Size 27.2 kB
Tags CPython 3.6 CPython 3.6 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
209d7ba3deb205bfc5a02bbe317aa1bac8f8215235ebc336cd056891f0e9dafe
BLAKE2b-256 checksum
How to use checksums
8bf2668d6343b101162298de15ab311a4b26acd65bbc781da00e22d236dfcee5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.1

Release files / scrypt-0.8.8-cp36-cp36m-win32.whl

Download URL scrypt-0.8.8-cp36-cp36m-win32.whl
Size 23.1 kB
Tags CPython 3.6 CPython 3.6 pymalloc Windows x86-32
SHA-256 checksum
How to use checksums
cb80489987870f83532c463c22ba6b1f67987c5c492cb6d485fc45fe55cf0d3f
BLAKE2b-256 checksum
How to use checksums
189ee0c2e3d64f01422e2e4650426ede39456490c80ef83359dde15b888479c9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.1

Release files / scrypt-0.8.8-cp35-cp35m-win_amd64.whl

Download URL scrypt-0.8.8-cp35-cp35m-win_amd64.whl
Size 27.2 kB
Tags CPython 3.5 CPython 3.5 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
791321d122aa3f0299705c097be30d1449e997df950b6170aac527fa35954fca
BLAKE2b-256 checksum
How to use checksums
940128a8ec9b65e63273b8a48a7125a8b2a9a649e214c6b8aeec633f7059d06c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.1

Release files / scrypt-0.8.8-cp35-cp35m-win32.whl

Download URL scrypt-0.8.8-cp35-cp35m-win32.whl
Size 23.1 kB
Tags CPython 3.5 CPython 3.5 pymalloc Windows x86-32
SHA-256 checksum
How to use checksums
96bc13f55bd772638e28ac5f8b4ded5745ee865e8e77b94733901ae86410b1a5
BLAKE2b-256 checksum
How to use checksums
58d0c4a3a96fdc49a2d45ed029fd66ec7a3b7a8fec45f7f19b3ae68bafeb2617
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.1

Release files / scrypt-0.8.8-cp34-cp34m-win_amd64.whl

Download URL scrypt-0.8.8-cp34-cp34m-win_amd64.whl
Size 24.6 kB
Tags CPython 3.4 CPython 3.4 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
648566f0fc4c179ecbd711a6eb70f71832fc2f46dfb9eba6998da0b63c7ec59e
BLAKE2b-256 checksum
How to use checksums
d872447859dcc8daad044387f42405fabee0e547e86c15e1aec12a0c0040c227
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.1

Release files / scrypt-0.8.8-cp34-cp34m-win32.whl

Download URL scrypt-0.8.8-cp34-cp34m-win32.whl
Size 21.4 kB
Tags CPython 3.4 CPython 3.4 pymalloc Windows x86-32
SHA-256 checksum
How to use checksums
18e3bbe405c365a32d6c99b2ec494e2c2e38eb0318578c588c1861920dc4d32a
BLAKE2b-256 checksum
How to use checksums
abcb3c375c44d7dcf50d238c4ab72c7792470082876cea8285d8656f71cb134d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.1

Release files / scrypt-0.8.8-cp27-cp27m-win_amd64.whl

Download URL scrypt-0.8.8-cp27-cp27m-win_amd64.whl
Size 24.2 kB
Tags CPython 2.7 CPython 2.7 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
6c760ebc7b5cdf9a539202d4ee867b9a1a7db84bdd19360a25ec270f57b11b65
BLAKE2b-256 checksum
How to use checksums
3c4108da522d9542be709ccbea0ee22f16d4c69e88eeaf736d83ec23643ed1ad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.1

Release files / scrypt-0.8.8-cp27-cp27m-win32.whl

Download URL scrypt-0.8.8-cp27-cp27m-win32.whl
Size 21.4 kB
Tags CPython 2.7 CPython 2.7 pymalloc Windows x86-32
SHA-256 checksum
How to use checksums
5c82a5e327dfe877f813f828dc4c7b6bcc15ae1ee6c0e4992ea5f7cd440640be
BLAKE2b-256 checksum
How to use checksums
252ad9461884d67602fa77c67421c8186a813fdd2dbcb3f4bf123d21ae31a6b2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.1

Security for scrypt 0.8.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.8.8 This release

11 release files No provenance

0.4.0

0.3.0

0.1.0

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page