Google Auth ^{[ Django ]}

• Official Documentation

Developer Zone

Developer README

Installation

from GitHub :

# Editable Installation (for Development)
pip install -e git+https://github.com/xavient/django-gauth.git#egg=django_gauth

# Main Branch (Latest Version)
pip install git+https://github.com/xavient/django-gauth.git

from PyPi

pip install django-gauth

from test PyPi

pip install -i https://test.pypi.org/simple/ 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 : usually 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 same 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 only !!

NOTE :

---

Important Points ^{To Be Noted}

#1.

for production applications , that are working on https , must ensure the following settings for django to be https aware :

USE_X_FORWARDED_HOST = True
SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')

Your reverse proxy should add the X-Forwarded-Proto: https header to requests forwarded to Django. Configure your reverse proxy to set X-Forwarded-Proto header ( Nginx Example ):

server {
    listen 80;
    server_name yourdomain.com;
    return 301 https://$host$request_uri;
}

server {
    listen 443 ssl;
    server_name yourdomain.com;

    # ... SSL configuration ...

    location / {
        proxy_pass http://your_django_app_server;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto https; # Crucial line
    }
}

#2.

django_gauth app package serves a landing page for authentication , which will be served from within your application server when you include django_gauth in your project and use . Hence you have to take care of the static content rendring in your django project when you are deploying it on server .

• although no extra javascript or html file is included as static content , but there are two logo images that are displayed on navbar of landing page

  1. Organisation logo on the left
  2. placeholder image in case of no profile picture

  For these two , your project must manage the static content stratagy on production environments

  The steps for managing static content in a django project - Refer the documentation for collecting the static files to a central folder - Then you'll have to mount the folder path for static files folder staticfiles to a volume location in your docker container - Then you'll have to whitelist this path on /static/ route publicly on either your ingress file or nginx.conf file if you are using Nginx .

  Although , if you don't want the defaut logo ( which is very likely ) and placeholder image or you don't want to do the above mentioned arrangement for staticfile in your project, you can also configure them to your own via your settings . There is a settings variable which is set in following fashion :

  Setting own static content

  DJANGO_GAUTH_UI_CONFIG={
      "index":{
          "navbar":{
              "logo":"<hosted-url-for-your-organisation-logo>",
              "profile_picture_absence":"<hosted-url-for-the-placeholder-image>"
          }
      }
  }