iitkgp-erp-login-pypi icon indicating copy to clipboard operation
iitkgp-erp-login-pypi copied to clipboard

verified publisher icon metakgp
→

Metadata

The only python package you will ever need to implement login process in ERP for IIT-KGP

ERP Login Module

Tired of the tedious ERP login process? Wanted to automate some ERP workflow but stuck at login?
🚀 Introducing iitkgp-erp-login: Your Ultimate ERP Login Automation Module for IIT-KGP ! 🚀

Key Features:

  • Seamless Credentials & OTP Handling
  • Effortless Session & ssoToken Management
  • Smart Token Storage for Efficiency
  • Supports both CLI & WebApps

Note This package is not officially affiliated with IIT Kharagpur.

https://github.com/proffapt/iitkgp-erp-login-pypi/assets/86282911/c0401f6a-80af-46ae-8a8f-ac735f0e67b5

Guess the number of lines of python code it will take you to achieve this.

Reading this doc will give you the answer.

Table of Contents
  • Endpoints
    • About
    • Usage
  • Login
    • Input
    • Output
    • Usage
  • Session status check
    • Input
    • Output
    • Usage
  • Using in WebApps
    • Get Session Token
    • Get Secret Question
    • Get Login Details
    • Is OTP Required
    • Request OTP
    • Sign In
    • Implementing Login workflow
  • Example

Endpoints

The endpoints.py file includes all the necessary endpoints for the ERP login workflow.

About

  • HOMEPAGE_URL: The URL of the ERP homepage/loginpage.
  • SECRET_QUESTION_URL: The URL for retrieving the secret question for authentication.
  • OTP_URL: The URL for requesting the OTP (One-Time Password) for authentication.
  • LOGIN_URL: The URL for ERP login.
  • WELCOMEPAGE_URL: The URL of the welcome page, which is accessible only when the user is NOT logged in, and behaves exactly like the HOMEPAGE_URL. However, when the user is logged in, it returns a 404 error.

Usage

from iitkgp_erp_login.endpoints import *

print(HOMEPAGE_URL)
# Output: https://erp.iitkgp.ac.in/IIT_ERP3/

print(LOGIN_URL)
# Output: https://erp.iitkgp.ac.in/SSOAdministration/auth.htm

Login

ERP login workflow is implemented in login(headers, session, ERPCREDS=None, OTP_CHECK_INTERVAL=None, LOGGING=False, SESSION_STORAGE_FILE=None) function in erp.py.

Note This function currently compiles the login workflow "ONLY for the CLI", not for web apps.

Input

The function requires following compulsory arguments:

  1. headers: Headers for the post requests.

    headers = {
   'timeout': '20',
   'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/51.0.2704.79 Chrome/51.0.2704.79 Safari/537.36',
}

  2. session: A requests.Session() object, to persist the session parameters throughout the workflow.

    import requests

session = requests.Session()

The function can also be provided with these optional arguments:

  1. ERPCREDS: ERP Login Credentials python file, which is imported into main python file.

    Default Value None
    NOT Specified The user is prompted to enter their credentials manually
    Specified (ERPCREDS=erpcreds) The credentials are retrieved from the erpcreds.py file

    Note Here, credentials refer to the roll number, password, and security question.

    Prerequisites - ERP credentials file
    • This file MUST be present in the same directory as the script where iitkgp_erp_login module is being imported.
    • Create a .py file with your ERP credentials stored in it. Please follow the instructions below to create this file:

      • You can choose any valid name for the file, adhering to Python's naming conventions.

      • Do not change the variable names. Copy the format provided below & update the values inside the double quotes (").

        # ERP Credentials
ROLL_NUMBER = "XXYYXXXXX"
PASSWORD = "**********"
SECURITY_QUESTIONS_ANSWERS = {
    "Q1" : "A1",
    "Q2" : "A2",
    "Q3" : "A3",
}

  1. OTP_CHECK_INTERVAL: The interval (in seconds) after which the API continuously checks for new OTP emails.

    Default Value None
    NOT Specified The user will be prompted to manually enter the received OTP
    Specified (OTP_CHECKINTERVAL=2) The OTP will be automatically fetched and checked every 2 seconds
    Prerequisites - Token for GMail enabled googleapi

    The token file MUST be present in the same directory as the script where iitkgp_erp_login module is being imported.

    1. Follow the steps in the Gmail API - Python Quickstart guide to obtain credentials.json file.

      Note The credentials.json file is permanent unless you manually delete its reference in your Google Cloud Console.

    2. To generate the token.json file, follow the steps below:

      • Import this module

        pip install iitkgp-erp-login

      • Execute following command:

        python3 -c "from iitkgp_erp_login.utils import generate_token; generate_token()"

      • A browser window will open, prompting you to select the Google account associated with receiving OTP for login.

      • Grant permission to the selected email address to utilize the newly enabled Gmail API.

        • Click on Continue instead of Back To Safety
        • Then, press Continue again

      • The token.json file will be generated in the same folder as the credentials.json file

      Warning The token.json file has an expiration time, so it's important to periodically check and refresh it in your projects to ensure uninterrupted access.

  2. LOGGING: Toggles comprehensive logging.

    Default value False
    NOT Specified No Logging
    Specified (LOGGING=True) Logs every step in an exhaustive manner

  3. SESSION_STORAGE_FILE: A file where sessionToken and ssoToken - collectively referred to as "session tokens" here - are stored for direct usage.

    Default value None
    NOT Specified The session tokens will not be stored in a file
    Specified (SESSION_STORAGE_FILE=".session") The session tokens will be stored in .session file for later direct usage

    Note The approximate expiry time for ssoToken is ~30 minutes and that of session object is ~2.5 hours

Output

  1. The function returns the following, in the order of occurrence as here (return sessionToken, ssoToken):
    1. sessionToken
    2. ssoToken
  2. It also modifies the session object, which now includes parameters for the logged-in session. This session object can be utilized for further navigation within the ERP system.
  3. ROLL_NUMBER is made available for further usage in the following manner. 
     import iitkgp_erp_login.erp as erp
 sessionToken, ssoToken = erp.login(headers, session)

 print('Roll Number =', erp.ROLL_NUMBER)

Usage

It is recommended to use the login function in the following manner (optional arguments are your choice):

# Importing the erp.py file
import iitkgp_erp_login.erp as erp

# Using the login function inside erp.py
sessionToken, ssoToken = erp.login(headers, session, ERPCREDS=erpcreds, OTP_CHECK_INTERVAL=2, LOGGING=True, SESSION_STORAGE_FILE=".session")

Here are some examples combining all the aspects we have discussed so far about the login function:

import requests
import erpcreds
import iitkgp_erp_login.erp as erp

headers = {
   'timeout': '20',
    'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/51.0.2704.79 Chrome/51.0.2704.79 Safari/537.36',
}
session = requests.Session()

sessionToken, ssoToken = erp.login(headers, session)
# Credentials: Manual | OTP: Manual | Logging: No | TokenStorage: No

sessionToken, ssoToken = erp.login(headers, session, ERPCREDS=erpcreds)
# Credentials: Automatic - from erpcreds.py | OTP: Manual | Logging: No | TokenStorage: No

sessionToken, ssoToken = erp.login(headers, session, OTP_CHECK_INTERVAL=2)
# Credentials: Manual | OTP: Automatic - checked every 2 seconds | Logging: No | TokenStorage: No

sessionToken, ssoToken = erp.login(headers, session, LOGGING=True)
# Credentials: Manual | OTP: Manual | Logging: Yes | TokenStorage: No

sessionToken, ssoToken = erp.login(headers, session, ERPCREDS=erpcreds, OTP_CHECK_INTERVAL=5)
# Credentials: Automatic - from erpcreds.py | OTP: Automatic - checked every 5 seconds | Logging: No | TokenStorage: No

sessionToken, ssoToken = erp.login(headers, session, ERPCREDS=erpcreds, OTP_CHECK_INTERVAL=2, LOGGING=True)
# Credentials: Automatic - from erpcreds.py | OTP: Automatic - checked every 2 seconds | Logging: Yes | TokenStorage: No

sessionToken, ssoToken = erp.login(headers, session, ERPCREDS=erpcreds, OTP_CHECK_INTERVAL=2, SESSION_STORAGE_FILE='.session')
# Credentials: Automatic - from erpcreds.py | OTP: Automatic - checked every 2 seconds | Logging: No | TokenStorage: in .session file

sessionToken, ssoToken = erp.login(headers, session, ERPCREDS=erpcreds, OTP_CHECK_INTERVAL=2, LOGGING=True, SESSION_STORAGE_FILE='.session')
# Credentials: Automatic - from erpcreds.py | OTP: Automatic - checked every 2 seconds | Logging: Yes | TokenStorage: in .session file

Note These are just examples of how to use the login function, not satisfying the prerequisites.

Some arguments of login() have their own prerequisites that must be satisfied in order to use them. See "Input" section of login for complete details.

Session status check

The logic for checking the status of the session is implemented in the session_alive(session) function in erp.py. This function determines whether the given session is valid/alive or not.

Input

The function requires following argument:

  • session: requests.Session() object, to persist the session parameters throughout the workflow.

    import requests

session = requests.Session()

Output

The session_alive(session) function returns the status of the session as a boolean value:

Status Return Value
Valid (Alive) True
Not Valid (Dead) False

Usage

It is recommended to use the session_alive function in the following manner:

# Importing the erp.py file
import iitkgp_erp_login.erp as erp

# Using the session_alive function inside erp.py
print(erp.session_alive(session))

Here's an example combining all the aspects we have discussed so far about the login function and session_alive function:

import requests
import time

import erpcreds
# Importing erpcreds.py, which contains ERP credentials

import iitkgp_erp_login.erp as erp

headers = {
    'timeout': '20',
    'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/51.0.2704.79 Chrome/51.0.2704.79 Safari/537.36',
}
session = requests.Session()

print("Logging into ERP for:", creds.ROLL_NUMBER)

while True:
    if not erp.session_alive(session):
        _, ssoToken = erp.login(headers, session, ERPCREDS=erpcreds, LOGGING=True)
    else:
        print("Session is alive.")
        ssoToken = session.cookies.get('ssoToken')
        sessionToken = session.cookies.get('JSID#/IIT_ERP3')

    # Traverse ERP further using ssoToken

    time.sleep(2)

Note This is merely a Proof of Concept example; this exact functionality has been integrated into the login function itself from version 2.3.1 onwards.

Using in WebApps

To implement the login workflow for web applications and backend systems, utilize the following modularized steps in the form of functions.

Get Session Token

Gets session token from homepage response.

Input

session (requests.Session): Session object
log (bool, optional): Whether to enable logging
Output

(str): Session token value

Get Secret Question

Fetches the secret question for a roll number.

Input

headers (dict[str, str]): Request headers
session (requests.Session): Session object
roll_number (str): Roll number
log (bool, optional): Whether to enable logging
Output

(str): The secret question text

Get Login Details

Creates login details dictionary.

Input

roll_number (str): User roll number password (str): User password secret_answer (str): Answer to secret question session_token (str): Session token
Output

(LoginDetails): Dictionary with login credentials

Is OTP Required

Checks if OTP is required for login based on network.

Input

None
Output

(bool): True if OTP required, False otherwise

Request OTP

Requests an OTP to be sent to the user.

Input

headers (dict[str, str]): Request headers
session (requests.Session): Session object
login_details (LoginDetails): Dictionary with credentials
log (bool, optional): Whether to enable logging
Output

None
Raises

ErpLoginError: If OTP request fails

SignIn

Signs in into the ERP for the given session.

Input

headers (dict[str, str]): Request headers
session (requests.Session): Session object
login_details (LoginDetails): Dictionary with credentials
log (bool, optional): Whether to enable logging
Output

(str): ssoToken extracted from the login response

Implementing login workflow for webapps

Following is a proof of concept example to achieve the login workflow:

import requests
from flask import Flask
import iitkgp_erp_login.erp as erp

app = Flask(__name__)
session = requests.Session()
headers = {
   'timeout': '20',
   'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/51.0.2704.79 Chrome/51.0.2704.79 Safari/537.36',
}

@app.route("/login")
def login():
    roll = # 1. Get roll number from form inputs
    passw = # 2. Get password from form inputs
    sessionToken = erp.get_sessiontoken(session) # 3
    secret_question = erp.get_secret_question(headers, session, roll) # 4
    # 5. Display the question on the frontend
    secret_answer = # 6. Get password from the form input
    loginDetails = erp.get_login_details(roll, passw, secret_answer, sessionToken) # 7

    # 8. Handle OTP
    if erp.is_otp_required(): 
        request_otp(headers=headers, session=session, login_details=login_details, log=False) # 8.1 Request OTP
        login_details["email_otp"] = # 8.2 Get otp from form inputs
    else:
        print("OTP not required :yay")

    ssoToken = erp.signin(headers, session, loginDetails) # 9

    # ...

Example

Now, we will create a script that opens the ERP Homepage on your default browser with a logged-in session.

  1. Install the package.

    pip install iitkgp-erp-login

  2. Make sure that erpcreds.py & token.json files exist in the same directory as the script we are about to create.

  3. Create a file named open_erp.py and include the following code:

    import requests
import webbrowser
import erpcreds
import iitkgp_erp_login.erp as erp
from iitkgp_erp_login.endpoints import HOMEPAGE_URL

headers = {
    'timeout': '20',
    'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/51.0.2704.79 Chrome/51.0.2704.79 Safari/537.36',
}
session = requests.Session()

_, ssoToken = erp.login(headers, session, ERPCREDS=erpcreds, OTP_CHECK_INTERVAL=2, LOGGING=True, SESSION_STORAGE_FILE=".session")

logged_in_url = f"{HOMEPAGE_URL}?ssoToken={ssoToken}"
webbrowser.open(logged_in_url)

  4. Run the script.

    python3 open_erp.py

← Metadata

26
Stars
7
Forks
Watchers

Owner

verified publisher icon metakgp

Metadata

The only python package you will ever need to implement login process in ERP for IIT-KGP

Back