ridi-django-oauth2

RIDI Django OAuth2 Library


Keywords
oauth2, oauth2-resource, ridi, ridibooks
License
MIT
Install
pip install ridi-django-oauth2==1.0.3

Documentation

django-oauth2

Build Status

Introduction

  • OAuth2 Resource 서버를 구현하기 위한 Django용 라이브러리입니다.
    • 해당 라이브러리는 리디의 OAuth2 Resource 서버 규칙에 따라 작성 되었습니다.

Requirement

  • Django 2.0.0 or higher
  • Python 3.6 or higher

Usage

INSTALLED_APPS = [
    # ...
    'ridi_django_oauth2',
]

# Middleware Setting
MIDDLEWARE_CLASSES = (
    # ...
    'ridi_django_oauth2.middlewares.AuthenticationMiddleware',
)

AUTH_USER_MODEL = 'ridi_django_oauth2.RidiUser'


# RIDI Setting
RIDI_OAUTH2_KEY_URL = 'https://{auth_server_host}/oauth2/keys/public'
RIDI_OAUTH2_CLIENT_ID = 'this-is-client-id'
RIDI_OAUTH2_CLIENT_SECRET = 'this-is-client-secret'

RIDI_OAUTH2_AUTHORIZATION_URL = 'https://{auth_server_host}/oauth2/authorize/'
RIDI_OAUTH2_TOKEN_URL: 'https://{auth_server_host}/oauth2/token/'

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'ridi_django_oauth2.rest_framework.authentication.OAuth2Authentication',
    )
}

# OPTIONAL

# RIDI_OAUTH2_GET_USER_FROM_TOKEN_INFO 는 user model이 `u_idx` col과 호환되지 않을시 사용합니다.

def _get_user_from_token_info(token_info):
    user, _ = get_user_model().objects.get_or_create(idx=token_info.u_idx)
    return user
     
RIDI_OAUTH2_GET_USER_FROM_TOKEN_INFO = _get_user_from_token_info

TODO

  • Write Docs
  • MySQL Test