django-gauth 0.2.1

A Django app for providing the Google's discovery based Oauth2 authentication mechanism is HTTP/HTTPS oriented Django Servers/Projects.

Google Auth ^{[ Django ]}

Official Documentation

Installation

Source	Command
GitHub	pip install -e git+https://github.com/masterPiece93/django-gauth.git#egg=django_gauth
PyPi	pip install django-gauth

Quickstart

1. add the app name : django_gauth in INSTALLED_APPS entry of you project ( in settings.py file )

2. add required configuration variables ( in settings.py file )

   # settings.py
   GOOGLE_CLIENT_ID= env("GOOGLE_CLIENT_ID")           # << set according to your oauth2 client
   GOOGLE_CLIENT_SECRET= env("GOOGLE_CLIENT_SECRET")   # << set according to your oauth2 client
   GOOGLE_AUTH_FINAL_REDIRECT_URL= None        # defaults to `<host>/gauth/`
   CREDENTIALS_SESSION_KEY_NAME= "credentials" # defaults to `credentials`
   STATE_KEY_NAME= "oauth_state"               # defaults to `oauth_state`
   SCOPE= [
       "https://www.googleapis.com/auth/userinfo.email"    # always preffered
       ,"https://www.googleapis.com/auth/userinfo.profile" # always preffered
       ,"openid"                                           # always preffered
       ,"https://www.googleapis.com/auth/drive"            # based on your usage
   ]
   os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1'         # strictly for local-development only
   

   • os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1' directs the server to accept in-secure (http) connections .

3. configure auth urls ( in urls.py file of root )

   # urls.py
   from django.contrib import admin
   from django.urls import path, include
   
   urlpatterns = [
       path('admin/', admin.site.urls),
       path('gauth/', include('django_gauth.urls')),
       
       # add your other app's urls
       # ...
   
   ]
   

4. now run your project server

   • once your server is up & running , navigate to .../gauth, this is the master interface ( default landing page )
   • click on Authenticate button to launch Google Oauth2 Login .
   • just follow the flow you are directed to .
   • post authentication , you'll be redirected back to .../gauth

• NOTE : useually all servers ( wsgi, asgi, uWsgi) runs default on http://127.0.0.1:PORT/ , hence always take care to set the redirect endpoints in your google oauth2 client app in accordance with 127.0.0.1 , don't mistake to consider localhost , 0.0.0.0 and 127.0.0.1 as the same thing while dealing with redirect uri's .
  • For example : suppose you have set http://localhost:PORT/gauth/google-callback as your redirect uri , then take note of running your django app on localhost:PORT only !!

---