rest-social-auth 0.2.0

Django rest framework resources for social auth

OAuth signin with django rest framework.

Requirements

• python (2.6, 2.7, 3.4)

• django (1.6, 1.7, 1.8)

• djangorestframework (3.1)

Release notes

Here

Motivation

To have a resource, that will do very simple thing: take the oauth code from social provider (for example facebook) and return the authenticated user. That’s it.

I can’t find such util for django rest framework. There are packages (for example django-rest-auth), that take access_token, not the code. Also, i’ve used to work with awesome library python-social-auth, so it will be nice to use it again. In fact, most of the work is done by this package. Current util brings a little help to integrate django-rest-framework and python-social-auth.

Quick start

1. Install this package to your python distribution:

   pip install rest-social-auth

2. Do the settings

   Install apps

   INSTALLED_APPS = (
       ...
       'rest_framework',
       'rest_framework.authtoken',  # only if you use token authentication
       'social.apps.django_app.default',  # python social auth
       'rest_social_auth',  # this package
   )

   python-social-auth settings, look documentation for more details

   SOCIAL_AUTH_FACEBOOK_KEY = 'your app client id'
   SOCIAL_AUTH_FACEBOOK_SECRET = 'your app client secret'
   SOCIAL_AUTH_FACEBOOK_SCOPE = ['email', ]  # optional
   SOCIAL_AUTH_FACEBOOK_PROFILE_EXTRA_PARAMS = {'locale': 'ru_RU'}  # optional
   
   
   AUTHENTICATION_BACKENDS = (
       'social.backends.facebook.FacebookOAuth2',
       # and maybe some others ...
       'django.contrib.auth.backends.ModelBackend',
   )

   Also look optional settings avaliable.

3. Make sure everything is up do date

   python manage.py syncdb

4. Include rest social urls

   4.1 session authentication

   url(r'^api/login/', include('rest_social_auth.urls_session')),

   4.2 token authentication

   url(r'^api/login/', include('rest_social_auth.urls_token')),

5. You are ready to login users.

   5.1 session authentication

   • POST /api/login/social/session/

     input:

     {
         "provider": "faceboook",
         "code": "AQBPBBTjbdnehj51"
     }

     output:

     {
         "username": "Alex",
         "email": "[e-mail]",
         // other user data
     }
     
     + session id in cookies

   5.2 token authentication

   • POST /api/login/social/token/

     input:

     {
         "provider": "faceboook",
         "code": "AQBPBBTjbdnehj51"
     }

     output:

     {
         "token": "68ded41d89f6a28da050f882998b2ea1decebbe0"
     }

   • POST /api/login/social/token_user/

     input:

     {
         "provider": "faceboook",
         "code": "AQBPBBTjbdnehj51"
     }

     output:

     {
         "username": "Alex",
         "email": "[e-mail]",
         // other user data
         "token": "68ded41d89f6a28da050f882998b2ea1decebbe0"
     }

   User model is taken from `settings.AUTH_USER_MODEL <https://docs.djangoproject.com/en/dev/topics/auth/customizing/#substituting-a-custom-user-model>`__.

   At input there is also non-required field redirect_uri. If given, server will use this redirect uri in requests, instead of uri got from settings. This redirect_uri must be equal in front-end request and in back-end request. Back-end will not do any redirect in fact.

OAuth 2.0 workflow with rest-social-auth

1. Front-end need to know follwoing params for each social provider:

   • client_id # id of registered application on social service provider

   • redirect_uri # to this url social provider will redirect with code

   • scope=your_scope # for example email

   • response_type=code # same for all oauth2.0 providers

2. Front-end redirect user to social authorize url with params from previous point.

3. User confirms.

4. Social provider redirects back to redirect_uri with param code.

5. Front-end now ready to login the user. To do it, send POST request with provider name and code:

   POST /api/login/social/session/

   with data (form data or json)

   provider=facebook&code=AQBPBBTjbdnehj51

   Backend will either signin the user, either signup, either return error.

rest-social-auth purpose

As we can see, our backend must implement resource for signin the user (point 5).

Django REST social auth provides means to easily implement such resource.

List of oauth providers

Currently only OAuth 2.0 providers are supported. Look python-social-auth for full list. Name of provider is taken from corresponding backend.name property of particular backed class in python-social-auth.

For example for facebook backend we see:

class FacebookOAuth2(BaseOAuth2):
    name = 'facebook'

Here are some provider names:

Provider	provider name
Facebook	facebook
Google	google-oauth2
Vkontakte	vk-oauth2
Instagram	instagram
Github	github
Yandex	yandex-oauth2

Settings

• REST_SOCIAL_OAUTH_REDIRECT_URI

  Default: '/'

  Defines redirect_uri. This redirect must be the same in both authorize request (made by front-end) and access token request (made by back-end) to OAuth provider.

  To override the relative path (url path or url name are both supported):

  REST_SOCIAL_OAUTH_REDIRECT_URI = '/oauth/redirect/path/'
  # or url name
  REST_SOCIAL_OAUTH_REDIRECT_URI = 'redirect_url_name'

  Note, in case of url name, backend name will be provided to url resolver as argument.

• REST_SOCIAL_DOMAIN_FROM_ORIGIN

  Default: True

  Sometimes front-end and back-end are run on different domains. For example frontend at ‘myproject.com’, and backend at ‘api.myproject.com’.

  If True, domain will be taken from request origin, if origin is defined. So in current example domain will be ‘myproject.com’, not ‘api.myproject.com’. Next, this domain will be joined with path from REST_SOCIAL_OAUTH_REDIRECT_URI settings.

  To be clear, suppose we have following settings (defaults):

  REST_SOCIAL_OAUTH_REDIRECT_URI = '/'
  REST_SOCIAL_DOMAIN_FROM_ORIGIN = True

  Front-end is running on domain ‘myproject.com’, back-end - on ‘api.myproject.com’. Back-end will use following redirect_uri:

  myproject.com/

  And with following settings:

  REST_SOCIAL_OAUTH_REDIRECT_URI = '/'
  REST_SOCIAL_DOMAIN_FROM_ORIGIN = False

  redirect_uri will be:

  api.myproject.com/

  Also look at django-cors-headers if such architecture is your case.

• REST_SOCIAL_OAUTH_ABSOLUTE_REDIRECT_URI

  Default: None

  Full redirect uri (domain and path) can be hardcoded

  REST_SOCIAL_OAUTH_ABSOLUTE_REDIRECT_URI = 'http://myproject.com/'

  This settings has higher priority than REST_SOCIAL_OAUTH_REDIRECT_URI and REST_SOCIAL_DOMAIN_FROM_ORIGIN. I.e. if this settings is defined, other will be ignored. But redirect_uri param from request has higher priority than any setting.

Customization

First of all, customization provided by python-social-auth is also avaliable. For example, use nice mechanism of pipeline to do any action you need during login/signin.

Second, you can override any method from current package. Specify serializer for each view by subclassing the view.

To do it

• define your own url:

  url(r'^api/login/social/$', MySocialView.as_view(), name='social_login'),

• define your serializer

  from rest_framework import serializers
  from django.contrib.auth import get_user_model
  
  class MyUserSerializer(serializers.ModelSerializer):
  
      class Meta:
          model = get_user_model()
          exclude = ('password', 'user_permissions', 'groups')

• define view

  from rest_social_auth.views import SocialSessionAuthView
  from .serializers import MyUserSerializer
  
  class MySocialView(SocialSessionAuthView):
      serializer_class = MyUserSerializer

Check the code of the lib, there is not much of it.

Example

There is an example project.

• make sure you have rest-social-auth installed

  pip install rest-social-auth

• clone repo

  git clone https://github.com/st4lk/django-rest-social-auth.git

• step in example_project/

  cd django-rest-social-auth/example_project

• create database (sqlite3)

  python manage.py syncdb

• run development server

  python manage.py runserver

Example project already contains facebook and google app ids and secrets. These apps are configured to work only with restsocialexample.com domain (localhost is not supported by some providers). So, to play with it, define in your hosts file this domain as localhost:

127.0.0.1       restsocialexample.com

And visit http://restsocialexample.com:8000/