234 lines
8.4 KiB
Python
234 lines
8.4 KiB
Python
"""
|
|
|
|
AUTHOR:
|
|
|
|
Khushal P Soonderji
|
|
|
|
DATE:
|
|
|
|
Wednesday, 27th Nov., 2024
|
|
|
|
OBJECTIVE:
|
|
|
|
To receive authorization requests (OAuth2.0) for various mail providers and accordingly respond with the
|
|
authorization request URLs.
|
|
|
|
REFERENCES:
|
|
|
|
N/A
|
|
|
|
DOWNLOADS:
|
|
|
|
N/A
|
|
|
|
NOTES:
|
|
|
|
N/A
|
|
|
|
"""
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** IMPORT ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# To make sibling directories accessible for imports:
|
|
import sys
|
|
sys.path.append(".")
|
|
sys.path.append("..")
|
|
|
|
# For using Quart:
|
|
from quart import Blueprint, current_app, request
|
|
|
|
# My utils:
|
|
from utils_v2.string import json
|
|
from utils_v2.api.codes import StatusCodes, HttpCodes
|
|
from utils_v2.api.response import ResponseModel
|
|
from utils_v2.api.async_quart import (
|
|
set_api_version,
|
|
read_input,
|
|
get_session_info,
|
|
log_request_to_mongo,
|
|
log_chain_to_mongo,
|
|
should_not_be_under_maintenance,
|
|
only_whitelisted_ips,
|
|
limit_rate,
|
|
validate_input,
|
|
handle_cancelled_request
|
|
)
|
|
|
|
# Common:
|
|
from shared import constants
|
|
|
|
# Behaviour Models:
|
|
from models.behaviour.mail.oauth import MailOAuthModel
|
|
|
|
# Data Models:
|
|
from models.data.mail.oauth import (
|
|
OAuthMailAuthorizationRequestHeaders,
|
|
OAuthMailAuthorizationRequestData
|
|
)
|
|
|
|
# For asynchronous activities:
|
|
import asyncio
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** MACROS / ONE-TIME INIT ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# Related to Quart:
|
|
mail_oauth_bp = Blueprint("mail_oauth", __name__)
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** VARIABLES ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# --- Nothing Yet
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** FUNCTIONS ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
@mail_oauth_bp.record_once
|
|
def init(blueprint_setup_state):
|
|
|
|
# This gets called when the blueprint is registered.
|
|
# Consider this to be a one-time setup for the whole blueprint:
|
|
pass
|
|
|
|
|
|
# ---------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
@mail_oauth_bp.route("/auth/oauth/url/request", methods = ["GET"])
|
|
@set_api_version(api_version = "1.0.0")
|
|
@read_input(sanitize_headers = False, sanitize_data = False)
|
|
@get_session_info(key = "X-Session-Token", session_coro = "get_session")
|
|
@log_request_to_mongo(
|
|
attr_name = "logs_mongo",
|
|
project = constants.PROJECT_NAME,
|
|
log_type = constants.MODULE_NAME,
|
|
operation = "mailOAuthUrlReqApi",
|
|
log_input = True,
|
|
log_output = True,
|
|
sensitive_keys = ["sessionToken"]
|
|
)
|
|
@log_chain_to_mongo(attr_name = "logs_mongo")
|
|
@should_not_be_under_maintenance(attr_name = "is_under_maintenance")
|
|
@validate_input(
|
|
header_validator = lambda x: OAuthMailAuthorizationRequestHeaders(**x).model_dump(),
|
|
data_validator = lambda x: OAuthMailAuthorizationRequestData(**x)
|
|
)
|
|
@handle_cancelled_request()
|
|
async def request_oauth_authorization_url(
|
|
inbound_headers: dict | OAuthMailAuthorizationRequestHeaders = None,
|
|
inbound_data: dict | OAuthMailAuthorizationRequestData = None,
|
|
inbound_files: dict = None,
|
|
**kwargs
|
|
):
|
|
|
|
"""
|
|
Use this when requesting access to someone's GMail account. This API should be used from the UI. A button click
|
|
"Connect to GMail" should hit this API, which will generate a request to gain access to the user's GMail account.
|
|
When the URL is hit, it opens Google's own UI, and, when the user clicks "Continue", Google hits your 'redirect_url'
|
|
to inform you about the user's action.
|
|
:param inbound_headers: auto-extracted by the decorators.
|
|
:param inbound_data: auto-extracted by the decorators.
|
|
:param inbound_files: auto-extracted by the decorators.
|
|
:param kwargs: Any number of extra inputs supplied by the decorators.
|
|
:return: A standard response structure.
|
|
"""
|
|
|
|
# ┏┓
|
|
# ┃┃┏┓┏┓┏┓┏┓┏┓┏┏┓┏┏
|
|
# ┣┛┛ ┗ ┣┛┛ ┗┛┗┗ ┛┛
|
|
# ┛
|
|
|
|
# If the session token is invalid/expired:
|
|
if kwargs.get("session_info") is None:
|
|
return ResponseModel(
|
|
status_code = StatusCodes.FAILED,
|
|
http_code = HttpCodes.UNAUTHORIZED
|
|
)
|
|
|
|
# Start by assuming failure:
|
|
auth_url = None
|
|
|
|
# ┳ ┓ •┏ ┳┳
|
|
# ┃┏┫┏┓┏┓╋┓╋┓┏ ┃┃┏┏┓┏┓
|
|
# ┻┗┻┗ ┛┗┗┗┛┗┫ ┗┛┛┗ ┛
|
|
# ┛
|
|
|
|
# Make a user identifier from the session info:
|
|
user_identifier = await MailOAuthModel.get_id(
|
|
db_conn = current_app.data_mongo,
|
|
user_info = kwargs["session_info"],
|
|
service_type = "email",
|
|
service_client = inbound_data.mailClient,
|
|
auth_type = "oauth"
|
|
)
|
|
if user_identifier is None:
|
|
return ResponseModel(
|
|
status_code = StatusCodes.FAILED,
|
|
http_code = HttpCodes.INTERNAL_SERVER_ERROR,
|
|
message = "failed to generate user identifier"
|
|
)
|
|
user_identifier = str(user_identifier)
|
|
|
|
# ┏┓ ┏┓┳┳┓ •┓
|
|
# ┣ ┏┓┏┓ ┃┓┃┃┃┏┓┓┃
|
|
# ┻ ┗┛┛ ┗┛┛ ┗┗┻┗┗
|
|
|
|
if inbound_data.mailClient == "gmail":
|
|
|
|
# Get the authorization URL:
|
|
auth_url = await current_app.gmail_client.get_authorization_url(
|
|
state = user_identifier,
|
|
access_type = "offline",
|
|
approval_prompt = "force",
|
|
include_granted_scopes = "true",
|
|
user_email = None
|
|
)
|
|
|
|
# ┳┓
|
|
# ┣┫┏┓┏┏┓┏┓┏┓┏┏┓
|
|
# ┛┗┗ ┛┣┛┗┛┛┗┛┗
|
|
# ┛
|
|
|
|
# Done here:
|
|
return ResponseModel(
|
|
status_code = StatusCodes.OK if auth_url else StatusCodes.FAILED,
|
|
http_code = HttpCodes.SUCCESS if auth_url else HttpCodes.INTERNAL_SERVER_ERROR,
|
|
data = {
|
|
"mailClient": inbound_data.mailClient,
|
|
"authorizationUrl": auth_url
|
|
}
|
|
)
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** MAIN PROGRAM ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
pass
|