Custom DRF authentication backend.
Project description
DRF Firebase Auth (Forked from drf-firebase-auth by garyburgman)
Requirements
- Python (tested with 2.7, 3.6)
- Django
- Django Rest Framework
Installation
$ pip install drf-firebase-auth-cavoke
Add the application to your project's INSTALLED_APPS
in settings.py
.
INSTALLED_APPS = [
...
'drf_firebase_auth_cavoke',
]
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_cavoke.authentication.FirebaseAuthentication',
]
}
The drf_firebase_auth_cavoke
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_cavoke
as below:
drf_firebase_auth_cavoke = {
# 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_cavoke = {
'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_cavoke
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
- 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-cavoke-0.0.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51f811146ca47266361dc4c5806aeedce85f64ae8d3981f515dbd454d5cd180b |
|
MD5 | 109fa4e252d33266e9a1e1b659e25349 |
|
BLAKE2b-256 | 9cc8d2170127a4e5fb82d5b874a68b267bbca42b11aef7534ba51db1e430363a |
Hashes for drf_firebase_auth_cavoke-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4f5924a872cacb3eb639d81fb7388b0764ddf0e55340e8792cb1806b0970315 |
|
MD5 | 563374f04b659386654e648239fcf2e2 |
|
BLAKE2b-256 | 57e809010eded10ab2adc49bf1e407ebbbd831d110d2cdfb131240ae2a7b9fba |