Django-Cryptolock

DISCLAIMER: This project is no longer maintained. Feel free to fork. The PyPI package will remain available, but any user's should replace it as soon as possible.

Authentication using cryptocurrency wallets for Django projects.

This package provides a django app containing a set of utilities to implement the BitId and Monero Cryptolock authentication "protocols".

Future releases might include other cryptocurrencies but for the being (until we reach some stability) all the focus will remain on BTC and XMR.

Documentation

The full documentation is at https://django-cryptolock.readthedocs.io.

Quickstart

1. Install Django-Cryptolock:

   pip install django-cryptolock
   

2. Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    "django_cryptolock.apps.DjangoCryptolockConfig",
    ...
)

3. Migrate your database:

   python manage.py migrate
   

4. Add the following settings to your project for the Monero Backend:

AUTHENTICATION_BACKENDS = [
    "django_cryptolock.backends.MoneroAddressBackend",
    ...
]
DJCL_MONERO_NETWORK = "mainnet"
DJCL_MONERO_WALLET_RPC_PROTOCOL = "<http_or_https>"
DJCL_MONERO_WALLET_RPC_HOST = "<wallet_rpc_host>:<port>"
DJCL_MONERO_WALLET_RPC_USER = "<user>"
DJCL_MONERO_WALLET_RPC_PASS = "<password>"

5. Add Django-Cryptolock's URL patterns:

from django.conf.urls import url


urlpatterns = [
    ...
    url(r"^auth/", include("django_cryptolock.urls", namespace="django_cryptolock")),
    ...
]

More detailed information can be found in the [documentation](#documentation).