pombredanne / django-bcrypt

A git mirror of django-bcrypt.

django-bcrypt

You should be using bcrypt.

django-bcrypt makes it easy to use bcrypt to hash passwords with Django.

• Mercurial: http://bitbucket.org/dwaiter/django-bcrypt/
• Git: http://github.com/dwaiter/django-bcrypt/
• Documentation: http://django-bcrypt.rtfd.org/
• Issues: http://bitbucket.org/dwaiter/django-bcrypt/issues?status=new&status=open

Installation and Usage

Install the package with pip and Mercurial or git:

pip install -e hg+http://bitbucket.org/dwaiter/django-bcrypt#egg=django-bcrypt

# or ...

pip install -e git://github.com/dwaiter/django-bcrypt.git#egg=django-bcrypt

Add django_bcrypt to your INSTALLED_APPS.

That's it.

Any new passwords set will be hashed with bcrypt. Old passwords will still work fine.

Configuration

You can configure how django-bcrypt behaves with a few settings in your settings.py file.

BCRYPT_ENABLED

Enables bcrypt hashing when User.set_password() is called.

Default: True

BCRYPT_ENABLED_UNDER_TEST

Enables bcrypt hashing when running inside Django TestCases.

Default: False (to speed up user creation)

BCRYPT_ROUNDS

Number of rounds to use for bcrypt hashing. Increase this as computers get faster.

You can change the number of rounds without breaking already-hashed passwords. New passwords will use the new number of rounds, and old ones will use the old number.

Default: 12

BCRYPT_MIGRATE

Enables bcrypt password migration on a check_password() call.

The hash is also migrated when BCRYPT_ROUNDS changes.

Default: False

Acknowledgements

This is pretty much a packaged-up version of this blog post for easier use.

It also depends on the py-bcrypt library.