A flexible Django Rest Framework authentication backend for Firebase Auth
Project description
Django Rest Framework Firebase Authentication
This package provides a base Firebase Authentication backend class for the Django rest framework. Two key methods are not implemented for more flexebility. Let's keep it simple, stupid.
Requirements
- Python 2.7 or 3.4+
- Django (version 1.11+)
- Django Rest Framework
- Firebase Admin Python
Installation
pip install drf-firebase-authentication
Usage
1. Subclass BaseFirebaseAuthentication
and implement its template methods:
Decide by yourself how you want to associate Firebase users with local django users by implementing the .get_django_user()
method accordingly.
Put your code into a authentication.py
file inside an app dedicated to your projects REST Api.
from drf_firebase.authentication import BaseFirebaseAuthentication
from firebase_admin import credentials, initialize_app
from django.contrib.auth import get_user_model
firebase_creds = credentials.Certificate('path/to/firebase/credentials.json')
firebase_app = initialize_app(firebase_creds)
class FirebaseAuthentication(BaseFirebaseAuthentication):
"""
Example implementation of a DRF Firebase Authentication backend class
"""
def get_firebase_app(self):
return firebase_app
def get_django_user(self, firebase_user_record):
return get_user_model().objects.get_or_create(
username=firebase_user_record.uid,
)[0]
2. Add the just created Firebase authentication backend to your settings.py
:
Replace YOUR_RESTAPI_APP
with the app you put your authentication.py
file in.
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': (
'rest_framework.authentication.SessionAuthentication', # default
'rest_framework.authentication.BasicAuthentication', # default
'YOUR_RESTAPI_APP.authentication.FirebaseAuthentication',
),
}
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for drf-firebase-authentication-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4cb13627e40f717222be85e21fb8bec99a20f30934d6f938c27121aa5d8a3408 |
|
MD5 | 04ddbcf13b443f51cc68a7020525c8f5 |
|
BLAKE2b-256 | bae2dc31e9a8b7594331a97808f81b91bd7402612ee8bd793cc14bd8b2e7c40b |
Close
Hashes for drf_firebase_authentication-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d1dcb593a892b9ba2df980c44819368bb5a1fbe84cfcfe2ad8d602cbf09a0bd |
|
MD5 | 48faf8b9b313566aa4e33886cd03d50f |
|
BLAKE2b-256 | f6a0e5097e4112916043c3ea3b93f73da59a8b110632648f62dabed350b7badb |