Authentication using cryptocurrency wallets for Django projects
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Gonçalo Valério 938416ac61
Remove travis-ci and add github actions workflows (#16)
2 years ago
.github Remove travis-ci and add github actions workflows (#16) 2 years ago
django_cryptolock First implementation of authentication views for DRF projects 2 years ago
docs current active challenges are now stored on the database 3 years ago
example Add both backends to the example project again 3 years ago
tests First implementation of authentication views for DRF projects 2 years ago
.coveragerc Initial commit. Cookiecutter based project structure 3 years ago
.gitignore add tests for the current address model and validator 3 years ago
AUTHORS.rst Challenge length is now configurable 3 years ago
CONTRIBUTING.rst update documentation 3 years ago
HISTORY.rst Remove travis-ci and add github actions workflows (#16) 2 years ago
LICENSE Initial commit. Cookiecutter based project structure 3 years ago
MANIFEST.in Add first implementation of the authentication backend 3 years ago
Makefile update quickstart guide 3 years ago
README.rst Remove travis-ci and add github actions workflows (#16) 2 years ago
manage.py Initial commit. Cookiecutter based project structure 3 years ago
pytest.ini use pytest for testing 3 years ago
requirements.txt removed unused dependency: python-bitcoinaddress 3 years ago
requirements_dev.txt First implementation of authentication views for DRF projects 2 years ago
requirements_test.txt Remove travis-ci and add github actions workflows (#16) 2 years ago
setup.cfg bumb version 3 years ago
setup.py First implementation of authentication views for DRF projects 2 years ago
tox.ini Remove travis-ci and add github actions workflows (#16) 2 years ago

README.rst

=============================
Django-Cryptolock
=============================

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.

**DISCLAIMER:** This package is on a early stage of development, It isn't meant to be
used on production (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`:

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