Authentication using cryptocurrency wallets for Django projects
Go to file
Gonçalo Valério 9c433636da
This package is no longer maintained
2023-01-23 11:31:05 +00:00
.github Remove travis-ci and add github actions workflows (#16) 2021-01-22 21:40:58 +00:00
django_cryptolock First implementation of authentication views for DRF projects 2020-07-14 18:17:55 +01:00
docs current active challenges are now stored on the database 2020-05-12 16:53:23 +01:00
example Add both backends to the example project again 2020-05-12 18:10:19 +01:00
tests First implementation of authentication views for DRF projects 2020-07-14 18:17:55 +01:00
.coveragerc Initial commit. Cookiecutter based project structure 2019-09-24 18:02:54 +01:00
.gitignore add tests for the current address model and validator 2019-10-15 19:13:39 +01:00
AUTHORS.rst Challenge length is now configurable 2020-05-12 13:53:39 +01:00
CONTRIBUTING.rst update documentation 2020-03-31 18:37:34 +01:00
HISTORY.rst Remove travis-ci and add github actions workflows (#16) 2021-01-22 21:40:58 +00:00
LICENSE Initial commit. Cookiecutter based project structure 2019-09-24 18:02:54 +01:00
MANIFEST.in Add first implementation of the authentication backend 2019-10-15 17:45:18 +01:00
Makefile update quickstart guide 2019-12-01 00:07:03 +00:00
README.rst This package is no longer maintained 2023-01-23 11:31:05 +00:00
manage.py Initial commit. Cookiecutter based project structure 2019-09-24 18:02:54 +01:00
pytest.ini use pytest for testing 2019-10-15 18:13:56 +01:00
requirements.txt removed unused dependency: python-bitcoinaddress 2020-02-19 18:14:25 +00:00
requirements_dev.txt First implementation of authentication views for DRF projects 2020-07-14 18:17:55 +01:00
requirements_test.txt Remove travis-ci and add github actions workflows (#16) 2021-01-22 21:40:58 +00:00
setup.cfg bumb version 2020-03-31 18:42:47 +01:00
setup.py First implementation of authentication views for DRF projects 2020-07-14 18:17:55 +01:00
tox.ini Remove travis-ci and add github actions workflows (#16) 2021-01-22 21:40:58 +00:00

README.rst

=============================
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`:

.. code-block:: python

    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:

.. code-block:: python

    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:

.. code-block:: python

    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).