Locarise Django Rest-Framework Oauth2 Support

Social Login for Locarise Auth provider (accounts.locarise.com)

---

This module provides

• An oauth2 support for django-rest-framework, connected to Locarise Oauth2 provider.
• An users application (models and DRF views).

Works with:

• Django >= 2.2.8 < 3 and djangorestframework>=3.11.0
• Python 3.7

Installation

Python

Install with pip:

$ pip install git+https://github.com/locarise/locarise-drf-oauth2-support#egg=locarise-drf-oauth2-support==0.4.1

Django

You have the choice to install only the Oauth client, only the users application or both.

Oauth2 Client Installation

Requirements

A user models with at least:

• uid: 22 characters CharField
• email EmailField

If you haven't it yet, you can install the users app (see below).

A Oauth2 client:

• url likes http://127.0.0.1:8009/
• redirect uri likes http://127.0.0.1:8009/complete/locarise-oauth2/
• client type is confidential

You can create a client or read its parameters through https://accounts.locarise.com/admin/provider/client/ interface.

Installation

Add these apps to your INSTALLED_APPS

INSTALLED_APPS = (
    ...,
    'social_django',
    'locarise_drf_oauth2_support.oauth2_client',
)

Add these context processors to your TEMPLATE_CONTEXT_PROCESSORS

TEMPLATES = [
    {
        ...
        'OPTIONS': {
            'context_processors': [
                ...
                'social_django.context_processors.backends',
                'social_django.context_processors.login_redirect',
            ],
        },
    }
]

Set Locarise authentication backend:

AUTHENTICATION_BACKENDS = (
    'locarise_drf_oauth2_support.oauth2_client.backends.LocariseOAuth2',
    'django.contrib.auth.backends.ModelBackend',
)

Configure your client ID and Secret

SOCIAL_AUTH_LOCARISE_OAUTH2_KEY = os.environ.get(
    'LOCARISE_OAUTH2_CLIENT_ID',
    'XXXXXXXXXXXXXXXXXXXXX'
)
SOCIAL_AUTH_LOCARISE_OAUTH2_SECRET = os.environ.get(
    'LOCARISE_OAUTH2_CLIENT_SECRET',
    'YYYYYYYYYYYYYYYYYYYYY'
)

Optional (Locarise production endpoints are set by default)

SOCIAL_AUTH_LOCARISE_OAUTH2_TOKEN_URL = os.environ.get(
    'LOCARISE_OAUTH2_TOKEN_URL',
    'http://127.0.0.1:8001/oauth2/access_token'
)
SOCIAL_AUTH_LOCARISE_OAUTH2_AUTHORIZATION_URL = os.environ.get(
    'LOCARISE_OAUTH2_AUTHORIZATION_URL',
    'http://127.0.0.1:8001/oauth2/authorize'
)
SOCIAL_AUTH_API_PROFILE_URL = os.environ.get(
    'LOCARISE_API_PROFILE_URL',
    'http://127.0.0.1:8001/userinfo'
)

According to your User model fields, you have to define which fields from accounts.locarise.com you want to copy in local (choices come from http://accounts.locarise.com/userinfo endpoint).

SOCIAL_AUTH_USER_FIELDS = [
    'uid', 'email', 'first_name', 'last_name', 'is_staff', 'is_active',
    'locale', 'organizations'
]

Include auth urls to your urls.py

urlpatterns = patterns(
    ...
    # Authentication
    url(r'', include('locarise_drf_oauth2_support.oauth2_client.urls')),
)

Notes

If you want your API has the same behavior than the others, add these apps to your INSTALLED_APPS

INSTALLED_APPS = (
    ...
    'corsheaders',
    'rest_framework',
    'rest_framework.authtoken',
)

Set up REST Framework classes:

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'rest_framework.authentication.TokenAuthentication',
        'rest_framework.authentication.SessionAuthentication',
    ),
    'DEFAULT_PERMISSION_CLASSES': (
        'rest_framework.permissions.IsAuthenticated',
    ),
}

Users application installation

Add this app to your INSTALLED_APPS

INSTALLED_APPS = (
    ...
   'locarise_drf_oauth2_support.users',
)

And declare:

AUTH_USER_MODEL = 'users.User'

Then include auth urls to your urls.py

urlpatterns = patterns(
    ...
    # Users
    url(r'', include('locarise_drf_oauth2_support.users.urls')),
)

Testing

Install and run tox:

$ pip install tox
$ tox

Continuous integration

CircleCI is already set up for this project.

License

Copyright (c) 2013-2017, Locarise inc. All rights reserved.