============ django-auth0

.. image:: https://codecov.io/gh/imanhodjaev/django-auth0/branch/master/graph/badge.svg :target: https://codecov.io/gh/imanhodjaev/django-auth0

.. image:: https://landscape.io/github/imanhodjaev/django-auth0/master/landscape.svg?style=flat :target: https://landscape.io/github/imanhodjaev/django-auth0/master :alt: Code Health

.. image:: https://travis-ci.org/imanhodjaev/django-auth0.png?branch=master :target: https://travis-ci.org/imanhodjaev/django-auth0

Django Auth0 authentication backend Backend implemented against Auth0 Regular Python application_

Please use official tutorial and libraries from Auth0 https://auth0.com/docs/quickstart/webapp/django/01-login

Quickstart

• Install django-auth0 $ pip install django-auth0

• Add django_auth0 to INSTALLED_APPS

• Add django_auth0.auth_backend.Auth0Backend to AUTHENTICATION_BACKENDS

.. code-block::python

AUTHENTICATION_BACKENDS = [
    "django_auth0.auth_backend.Auth0Backend",
    "django.contrib.auth.backends.ModelBackend"
]

• Add django_auth0.context_processors.auth0 to CONTEXT_PROCESSORS so necessary template context will be provided

• Include callback urls

.. code-block::python

urlpatterns = [
    ...
    url(r'^auth/', include('django_auth0.urls')),
)

Update AUTH0_CALLBACK_URL in settings.py to the following if want to use default authentication handler

.. code-block::python AUTH0_CALLBACK_URL = 'http://YOUR_DOMAIN/auth/auth_callback'

• Add Auth0 client side JavaScript and initialize it

.. code-block::python

<script src="https://cdn.auth0.com/js/lock-X.Y.min.js"></script>
<script>
  var lock = new Auth0Lock('{{ AUTH0_CLIENT_ID }}', '{{ AUTH0_DOMAIN }}');


  lock.show({
      icon: 'ICON_URL',
      container: 'CONTAINER_ELEMENT',
      callbackURL: 'YOUR_FULL_CALLBACK_URL',
      responseType: 'code',
      authParams: {
          scope: 'openid profile'
      }
  });
</script>

Options:

1. AUTH0_CLIENT_ID - Auth0 client app id,
2. AUTH0_SECRET - Auth0 app secret,
3. AUTH0_DOMAIN - Auth0 subdomain YOU_APP.auth0.com.
4. AUTH0_CALLBACK_URL - Auth0 callback url is full url to your callback view like https://YOUR_DOMAIN/CALLBACK
5. AUTH0_SUCCESS_URL - Url to redirect once you login successfully

Overriding callback view Default callback view looks like this so you can always write your own and set AUTH0_CALLBACK_URL to your custom view it should be url name.

.. code-block::python

def process_login(request):
    """
    Default handler to login user
    :param request: HttpRequest
    """
    code = request.GET.get('code', '')
    json_header = {'content-type': 'application/json'}
    token_url = 'https://%s/oauth/token' % settings.AUTH0_DOMAIN

    token_payload = {
        'client_id': settings.AUTH0_CLIENT_ID,
        'client_secret': settings.AUTH0_SECRET,
        'redirect_uri': reverse(settings.AUTH0_CALLBACK_URL),
        'code': code,
        'grant_type': 'authorization_code'
    }

    token_info = requests.post(token_url,
                               data=json.dumps(token_payload),
                               headers=json_header).json()

    url = 'https://%s/userinfo?access_token=%s'
    user_url = url % (settings.AUTH0_DOMAIN, token_info['access_token'])
    user_info = requests.get(user_url).json()

    # We're saving all user information into the session
    request.session['profile'] = user_info
    user = authenticate(**user_info)

    if user:
        login(request, user)
        return redirect(settings.AUTH0_SUCCESS_URL)

    return HttpResponse(status=400)

Sample application_ is at https://github.com/imanhodjaev/auth0-sample

TODO

• Improve tests,
• Add Auth0 user profile model,
• Add support for settings from Auth0,
• Move string literals to configuration file

Running Tests

Does the code actually work?

::

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install -r requirements-test.txt
(myenv) $ python runtests.py

Credits

Tools used in rendering this package:

• Cookiecutter_
• cookiecutter-djangopackage_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _cookiecutter-djangopackage: https://github.com/pydanny/cookiecutter-djangopackage .. _Sample application: https://github.com/imanhodjaev/auth0-sample .. _Regular Python application: https://auth0.com/docs/quickstart/webapp/python/