Easily integrate OAuth2 authentication into your Django project using Omni-Authify. This guide covers configuration, view creation, URL setup, and handling user authentication, providing a seamless experience for developers.
Add the Omni-Authify settings to your Django project settings to include Facebook, GitHub, Google and/or any other OAuth providers.
import os
from dotenv import load_dotenv
load_dotenv()
OMNI_AUTHIFY = {
'PROVIDERS': {
'facebook': {
'client_id': os.getenv('FACEBOOK_CLIENT_ID'),
'client_secret': os.getenv('FACEBOOK_CLIENT_SECRET'),
'redirect_uri': os.getenv('FACEBOOK_REDIRECT_URI'),
'state': os.getenv('FACEBOOK_STATE'), # optional
'scope': os.getenv('FACEBOOK_SCOPE'), # by default | add other FB app permissions you have!
'fields': os.getenv('FACEBOOK_FIELDS'),
},
'github':{
'client_id':os.getenv('GITHUB_CLIENT_ID'),
'client_secret':os.getenv('GITHUB_CLIENT_SECRET'),
'redirect_uri':os.getenv('GITHUB_REDIRECT_URI'),
'state': os.getenv('GITHUB_STATE'),
'scope':os.getenv('GITHUB_SCOPE'),
},
'google': {
'client_id': os.getenv('GOOGLE_CLIENT_ID'),
'client_secret': os.getenv('GOOGLE_CLIENT_SECRET'),
'redirect_uri': os.getenv('GOOGLE_REDIRECT_URI'),
'state': os.getenv('GOOGLE_STATE'), # optional
'scope': os.getenv('GOOGLE_SCOPES'),
},
'linkedin': {
'client_id': os.getenv('LINKEDIN_CLIENT_ID'),
'client_secret': os.getenv('LINKEDIN_CLIENT_SECRET'),
'redirect_uri': os.getenv('LINKEDIN_REDIRECT_URI'),
'scope': os.getenv('LINKEDIN_SCOPE'),
},
# Add other providers here if needed
'telegram': {
# Coming....
}
}
}Learn how to create views to handle Facebook,GitHub,Google login and callback in your Django application.
-
Installation: Install Omni-Authify with Django support using the following command:
pip install omni-authify[django]
-
Django 4.2 or higher
-
Omni-Authify installed and configured (see Installation Guide)
Create class based views to handle the login and callback processes.
This version leverages the OmniAuthifyDjango helper class for a simpler implementation over function based views!.
from django.http import HttpResponse
from omni_authify.frameworks.django import OmniAuthifyDjango
# ======== Facebook Login ========
def facebook_login(request):
auth = OmniAuthifyDjango(provider_name='facebook')
return auth.login(request)
def facebook_callback(request):
auth = OmniAuthifyDjango(provider_name='facebook')
user_info = auth.callback(request)
print(f"User info from Facebook: {user_info}")
# Todo: Authenticate/login the user and save the user_info on your own!
return HttpResponse(user_info)
# ======== GitHub Login ========
def github_login(request):
auth = OmniAuthifyDjango(provider_name='github')
return auth.login(request)
def github_callback(request)
auth = OmniAuthifyDjango(provider_name='github')
user_info = auth.callback(request)
print(f"User info from Github: {user_info}")
# Todo: Authenticate/login the user and save the user_info on your own!
return HttpResponse(user_info)
# ======== Google Login ========
def google_login(request):
auth = OmniAuthifyDjango(provider_name='google')
return auth.login(request)
def google_callback(request):
auth = OmniAuthifyDjango(provider_name='google')
user_info = auth.callback(request)
print(f"User info from Github: {user_info}")
# Todo: Authenticate/login the user and save the user_info on your own!
return HttpResponse(user_info)
# ======== LinkedIn Login ========
def linkedin_login(request):
auth = OmniAuthifyDjango(provider_name='linkedin')
return auth.login(request)
def linkedin_callback(request):
auth = OmniAuthifyDjango(provider_name='linkedin')
user_info = auth.callback(request)
print(f"User info from Github: {user_info}")
# Todo: Authenticate/login the user and save the user_info on your own!
return HttpResponse(user_info)Add the login and callback views to your app's urls.py file:
# urls.py
from django.urls import path
from . import views
urlpatterns = [
# ======== Facebook Login ========
path('facebook/login/', views.facebook_login, name='facebook_login'),
path('facebook/callback/', views.facebook_callback, name='facebook_callback'),
# ======== GitHub Login ========
path('github/login/', views.github_login, name='github_login'),
path('github/callback/', views.github_callback, name='github_callback'),
# ======== Google Login ========
path('google/login/', views.google_login, name='google_login'),
path('google/callback/', views.google_callback, name='google_callback'),
# ======== LinkedIn Login ========
path('linkedin/login/', views.linkedin_login, name='linkedin_login'),
path('linkedin/callback/', views.linkedin_callback, name='linkedin_callback')
]Create a template to display user information or login options.
home.html
<!-- templates/home.html -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Welcome</title>
</head>
<body>
{% if user_info %}
<h1>Welcome, {{ user_info.name }}!</h1>
<img src="{{ user_info.picture.data.url }}" alt="Profile Picture">
<p>Email: {{ user_info.email }}</p>
{% else %}
<h1>Welcome to Our Site</h1>
<p>Please log in using one of the options below:</p>
<a href="{% url 'facebook_login' %}">Login with Facebook</a><br>
<a href="{% url 'github_login' %}">Login with GitHub</a>
<a href="{% url 'google_login' %}">Login with Google</a>
<a href="{% url 'linkedin_login' %}">Login with LinkedIn</a>
{% endif %}
</body>
</html>- 🔒 Use Environment Variables: Always use environment variables to store important information like
client_idandclient_secret. This helps keep your credentials safe 🛡️. - 🔗 Match Redirect URI: Make sure the
redirect_uriis consistent between your Provider App settings and your code to avoid errors 🚫. ⚠️ Error Handling: Ensure all potential errors are handled to provide a smooth user experience 🐞.
Omni-Authify makes adding Oauth2 authentication to your Django app straightforward and secure. Follow these steps and best practices to provide your users with a seamless login experience. 🚀✨