scrypt

Bindings for the scrypt key derivation function library

These details have not been verified by PyPI

Project links

Homepage

Project description

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

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

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

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.

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.

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

0.8.27

Oct 11, 2024

0.8.24

Mar 1, 2024

0.8.23

Mar 1, 2024

0.8.22

Mar 1, 2024

0.8.21

Jan 20, 2024

0.8.20

Feb 21, 2022

0.8.19

Dec 3, 2021

0.8.18

Apr 16, 2021

0.8.17

Sep 14, 2020

0.8.16

Sep 9, 2020

0.8.15

May 21, 2020

0.8.14

May 21, 2020

0.8.13

Feb 12, 2019

0.8.12

Feb 12, 2019

0.8.11

Feb 12, 2019

0.8.10

Feb 12, 2019

0.8.9

Feb 12, 2019

0.8.8

Feb 11, 2019

0.8.7

Feb 1, 2019

0.8.6

Feb 8, 2018

0.8.5

Feb 8, 2018

0.8.4

Feb 8, 2018

0.8.3

Feb 6, 2018

0.8.2

Feb 6, 2018

This version

0.8.0

Sep 17, 2016

0.7.1

Jul 5, 2015

0.7.0

Jul 4, 2015

0.6.1

Apr 20, 2013

0.6.0

Apr 19, 2013

0.5.5

Jun 17, 2012

0.5.4

Jun 10, 2012

0.5.3

Mar 29, 2012

0.5.2

Nov 12, 2011

0.5.1

May 31, 2011

0.5.0

May 31, 2011

0.4.0

Jan 22, 2011

0.3.0

Jan 22, 2011

0.1.0

Apr 24, 2010

Download files

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