django-cryptolock 0.1.0

Django authentication using cryptocurrency wallets

Authenticatio using cryptocurrency wallets for Django projects

This package provided a django app containing a set of utilities to make easier to implement the BitId and Monero Cryptolock authentication “protocols”.

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

DISCLAIMER: This package is still in an early stage of development. It isn’t meant to be used on any production scenario yet (in other words, only test projects for now).

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.

Credits

Tools used in rendering this package:

• Cookiecutter

• cookiecutter-djangopackage

History

0.1.0 (2020-03-31)

• Add validation for existing addresses on the signup form

• Add rudimentary BitId support

• Renamed the base auth views to generic names

0.0.2 (2020-01-08)

• A default urls.py is provided by the package so can work “out-of-the-box”.

• Default location for templates moved to django_cryptolock folder.

• Update quickstart guide.

• Update instructions to contribute to the project.

• Add DJCL namespace to all related settings.

• MoneroAddressBackend is now executed when more parameters are added to the authenticate function.

0.0.1 (2019-11-25)

• First release on PyPI.