Custom Django Rest Framework authentication backend for parsing Firebase uid tokens and storing as local users.
Project description
DRF Firebase Auth
Requirements
- Python3
- Django
- Django Rest Framework
Installation
$ pip install drf-firebase-auth
Add the application to your project's INSTALLED_APPS
in settings.py
.
INSTALLED_APPS = [
...
'drf_firebase_auth',
]
In your project's settings.py
, add this to the REST_FRAMEWORK
configuration. Note that if you want to retain access to the browsable API for locally created users, then you will probably want to keep rest_framework.authentication.SessionAuthentication
too.
REST_FRAMEWORK = {
...
'DEFAULT_AUTHENTICATION_CLASSES': [
...
'rest_framework.authentication.SessionAuthentication',
'drf_firebase_auth.authentication.FirebaseAuthentication',
]
}
The drf_firebase_auth
application comes with the following settings as default, which can be overridden in your project's settings.py
file. Make sure to nest them within DRF_FIREBASE_AUTH
as below:
DRF_FIREBASE_AUTH = {
# path to JSON file with firebase secrets
'FIREBASE_SERVICE_ACCOUNT_KEY': '',
# allow creation of new local user in db
'FIREBASE_CREATE_LOCAL_USER': True,
# attempt to split firebase user.display_name and set local user
# first_name and last_name
'FIREBASE_ATTEMPT_CREATE_WITH_DISPLAY_NAME': True,
# commonly JWT or Bearer (e.g. JWT <token>)
'FIREBASE_AUTH_HEADER_PREFIX': 'JWT',
# verify that JWT has not been revoked
'FIREBASE_CHECK_JWT_REVOKED': True,
# require that firebase user.email_verified is True
'FIREBASE_AUTH_EMAIL_VERIFICATION': False
}
You can get away with leaving all the settings as default except for FIREBASE_SERVICE_ACCOUNT_KEY
, which is obviously required. As a minimum, you will need to set this in your project's settings.py
. This must be the JSON service account key that you receive from the Firebase console for your application.
...
DRF_FIREBASE_AUTH = {
'FIREBASE_SERVICE_ACCOUNT_KEY': 'project/config/firebase.json'
}
Now that you have configured the application, run the migrations so that the Firebase data can be stored.
$ ./manage.py migrate drf_firebase_auth
All you need to do now is have your client code handle the Firebase popup/redirect authentication flow, retrieve the idToken from the currentUser (Firebase explains this flow well in their docs: https://firebase.google.com/docs/auth/admin/verify-id-tokens
), and then use the idToken for the user in an Authorization
header in requests to your API.
JWT <token>
Voila!
Contributing
- Trello board created! Please follow this link if you wish to collabrate in the future direction of this package: https://trello.com/invite/b/lkAsvStS/af54d9a94359c042f3bd9afb47f82eab/drf-firebase-auth
- Please raise an issue/feature and name your branch 'feature-n' or 'issue-n', where 'n' is the issue number.
- If you test this code with a Python version not listed above and all is well, please fork and update the README to include the Python version you used :)
- I almost always setup Django with a custom user class inheriting from AbstractUser, where I switch the USERNAME_FIELD to be 'email'. This backend is setup to assign a username still anyway, but if there are any issues, please raise them and/or make a pull request to help the community!
Project details
Release history Release notifications | RSS feed
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
Hashes for drf-firebase-auth-0.0.9.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0db0e5a1dc0a5e4814e3b7acb042680b064efb2c5582dba317cbd88cde5122ae |
|
MD5 | fa6ccb7046204596f08d5c0300b968c4 |
|
BLAKE2b-256 | d21dd711f6b3cca39b61a307acc638f12288cf85260059422cd0470d141d7c8c |
Hashes for drf_firebase_auth-0.0.9.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67534ce0f164d2b39e07186ed040c55c05abbc5f4cdbf7a5a3d5d651da0405f3 |
|
MD5 | ee2db22b2d0dad64385568e884a85953 |
|
BLAKE2b-256 | 7119a8294d8c6be3fac268b4c56423c42e07f07f520a90ed672d2a03f9497780 |