django-honeywords

Django implementation of the Honeywords Project

Project description

=================
Django Honeywords
=================
Django implementation of the `Honeywords Project`_ by Ari Juels and Ronald L. Rivest.

.. _Honeywords Project: http://people.csail.mit.edu/rivest/honeywords/

Generates a list of honeywords along with the actual user password on user registration. If the wrong compromised honeyword is used to login, the user account will be automatically deactivated.

Written for Django 2.2 on Python 3.6

Honeychecker Quick Link
-----------------------

`Honeychecker`__

__ honeychecker.py_

Quick Start
-----------
#) Install Django Honeywords::

pip install django-honeywords

#) Add ``honeywords`` to ``INSTALLED_APPS`` in ``settings.py``::

INSTALLED_APPS = [
...
'honeywords',
]

#) Add ``honeywords.hashers.HoneywordHasher`` to top of ``PASSWORD_HASHERS`` in ``settings.py`` (or add ``PASSWORD_HASHERS`` if missing)::

PASSWORD_HASHERS = [
'honeywords.hashers.HoneywordHasher',
'django.contrib.auth.hashers.PBKDF2PasswordHasher',
'django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher',
'django.contrib.auth.hashers.Argon2PasswordHasher',
'django.contrib.auth.hashers.BCryptSHA256PasswordHasher',
]

#) Add ``honeywords.backends.HoneywordsBackend`` to the top of ``AUTHENTICATION_BACKENDS`` in ``settings.py`` (or add ``AUTHENTICATION_BACKENDS`` if missing)::

AUTHENTICATION_BACKENDS = [
'honeywords.backends.HoneywordsBackend',
'django.contrib.auth.backends.ModelBackend',
]

#) Add ``HONEYCHECKER_URI = http(s)://<url/ip>:<port>`` into ``settings.py``::

HONEYCHECKER_URI = 'http://192.168.56.101:55555'

#) Create Honeywords table::

./manage.py makemigrations honeywords
./manage.py migrate

#) Download `honeychecker.py`_ to the Honeychecker server::

wget -c https://raw.githubusercontent.com/ooknosi/django_honeywords/master/src/honeywords/honeychecker.py

.. _honeychecker.py: https://raw.githubusercontent.com/ooknosi/django_honeywords/master/src/honeywords/honeychecker.py

#) Edit the ``IP``, ``PORT`` and ``DATABASE`` settings in ``honeychecker.py``::

### Settings
IP = '192.168.56.101'
PORT = 55555
DATABASE = 'honeychecker_db.sqlite3'
###

#) Run ``honeychecker.py`` on the Honeychecker server::

python honeychecker.py

Documentation
-------------
TODO