257 lines
12 KiB
Python
257 lines
12 KiB
Python
"""
|
|
|
|
AUTHOR:
|
|
|
|
Khushal P Soonderji
|
|
|
|
DATE:
|
|
|
|
Wednesday, 27th Nov., 2024
|
|
|
|
OBJECTIVE:
|
|
|
|
To define the interaction between the UI layer and the database connectivity in one place. Here we shall handle
|
|
all the activities for OAuth2.0 authorization requests for all the users of our service.
|
|
|
|
REFERENCES:
|
|
|
|
N/A
|
|
|
|
DOWNLOADS:
|
|
|
|
N/A
|
|
|
|
"""
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** IMPORT ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# To make sibling directories accessible for imports:
|
|
import sys
|
|
sys.path.append(".")
|
|
sys.path.append("..")
|
|
|
|
# My async utils:
|
|
from utils_v2.string import json
|
|
from utils_v2.date_time import date_time
|
|
from utils_v2.database.async_mysql_v2 import AsyncMySQL
|
|
from utils_v2.database.async_mongo_v2 import AsyncMongo
|
|
|
|
# Base model:
|
|
from models.behaviour.base import BaseModel
|
|
|
|
# To work with MongoDB:
|
|
from bson import ObjectId
|
|
|
|
# To work with datatypes:
|
|
from typing import Literal
|
|
|
|
# To make deep-copies:
|
|
import copy
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** MACROS / ONE-TIME INIT ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# --- Nothing Yet
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** VARIABLES ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# --- Nothing Yet
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** FUNCTIONS ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# --- Nothing Yet
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** CLASSES ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
class MailOAuthModel(BaseModel):
|
|
|
|
AUTH_COLLECTION = "_authTokens"
|
|
|
|
async def get_user_identifier(
|
|
self,
|
|
db_conn: AsyncMySQL,
|
|
mongo_conn: AsyncMongo,
|
|
user_info: dict,
|
|
service_type: Literal["email", "chat"],
|
|
service_client: Literal["gmail"],
|
|
auth_type: Literal["oauth"],
|
|
session_token: str = None
|
|
) -> ObjectId:
|
|
|
|
"""
|
|
Stores params from the session info and gives an identifier to use in the authorization URL. Use this when the
|
|
user requests an authorization URL to link your service to another service (like GMail).
|
|
:param db_conn: The database connection (MariaDB) to use to perform the action.
|
|
:param mongo_conn: The database connection (MongoDB) to use to perform the action.
|
|
:param user_info: The dictionary that has the user's session information.
|
|
:param service_type: The type of service being provided.
|
|
:param service_client: The name of the company or brand that is providing this service that is being integrated.
|
|
:param auth_type: To identify the type of authentication being done here. This could indicate simple password
|
|
authentication, more advance OAuth2.0 authentication, etc.
|
|
:param session_token: The session token of the user who requested this service.
|
|
:return: An ObjectId to later store the granted tokens.
|
|
"""
|
|
|
|
# Note down the timestamp at which this event occurred:
|
|
request_ts = date_time.get_current_utc_date_time(as_string = False)
|
|
|
|
# Get the identifier from the database:
|
|
mongo_json = await mongo_conn.find_one_and_update(
|
|
collection = MailOAuthModel.AUTH_COLLECTION,
|
|
filter = {
|
|
"serviceType": service_type,
|
|
"client": service_client,
|
|
"authType": auth_type,
|
|
"user": user_info,
|
|
},
|
|
update = {
|
|
"$set": {
|
|
"lastRequestTs": request_ts
|
|
},
|
|
"$setOnInsert": {
|
|
"version": "1.0.0",
|
|
"serviceType": service_type,
|
|
"client": service_client,
|
|
"authType": auth_type,
|
|
"user": user_info,
|
|
"token": None,
|
|
"firstRefreshTs": None,
|
|
"lastRefreshTs": None,
|
|
"firstRequestTs": request_ts,
|
|
}
|
|
},
|
|
projection = {
|
|
"_id": True
|
|
},
|
|
upsert = True,
|
|
return_updated = True
|
|
)
|
|
|
|
# Tell MariaDB that an authorization request was initiated:
|
|
db_json = {}
|
|
if mongo_json is not None:
|
|
db_json = await self.call_procedure(
|
|
db_conn = db_conn,
|
|
proc_name = "entity_integration_save",
|
|
proc_args = (
|
|
user_info["entityId"], # ............................................ 'p_entity_id'
|
|
service_client, # ................................................... 'p_provider'
|
|
"Auth Requested", # ................................................. 'p_current_status'
|
|
"Auth URL Generated", # ............................................. 'p_last_action'
|
|
None, # ............................................................. 'p_display_name'
|
|
None, # ............................................................. 'p_display_picture'
|
|
str(mongo_json["_id"]), # ........................................... 'p_token_id'
|
|
json.to_string(python_data = {"email": None}, no_space = True), # ... 'p_notes'
|
|
user_info["userId"] # ............................................... 'p_created_by'
|
|
),
|
|
session_token = session_token
|
|
)
|
|
|
|
# Done here:
|
|
return mongo_json["_id"] if mongo_json and db_json.get("status") == 1 else None
|
|
|
|
async def set_token(
|
|
self,
|
|
db_conn: AsyncMySQL,
|
|
mongo_conn: AsyncMongo,
|
|
user_identifier: ObjectId | str,
|
|
token: dict,
|
|
session_token: str = None
|
|
) -> bool:
|
|
|
|
"""
|
|
This method is to be called when the end user authorizes your service to connect to his third-party account. For
|
|
example, when the end user allows you to access his GMail account.
|
|
:param db_conn: The database connection (MariaDB) to use to perform the action.
|
|
:param mongo_conn: The database connection (MongoDB) to use to perform the action.
|
|
:param user_info: The dictionary that has the user's session information.
|
|
:param user_identifier: The identifier granted by the 'get_user_identifier' method.
|
|
:param token: The token granted by the third-party service.
|
|
:param session_token: The session token of the user who requested this service.
|
|
:return: True if saved, False if failed.
|
|
"""
|
|
|
|
# Start by assuming failure:
|
|
token_saved = False
|
|
|
|
# Note down the timestamp at which this event occurred:
|
|
request_ts = date_time.get_current_utc_date_time(as_string = False)
|
|
|
|
# Save the token to MongoDB:
|
|
mongo_json = await mongo_conn.find_one_and_update(
|
|
collection = MailOAuthModel.AUTH_COLLECTION,
|
|
filter = {"_id": ObjectId(user_identifier)},
|
|
update = {
|
|
"$set": {
|
|
"token": token,
|
|
"firstRefreshTs": request_ts,
|
|
}
|
|
},
|
|
projection = {"token": False},
|
|
return_updated = True,
|
|
upsert = False
|
|
)
|
|
|
|
# Tell MariaDB that the token was saved:
|
|
if mongo_json is not None:
|
|
db_json = await self.call_procedure(
|
|
db_conn = db_conn,
|
|
proc_name = "entity_integration_save",
|
|
proc_args = (
|
|
mongo_json["user"]["entityId"], # ............................................. 'p_entity_id'
|
|
mongo_json["client"], # ....................................................... 'p_provider'
|
|
"Auth Granted", # ............................................................. 'p_current_status'
|
|
"Set Token", # ................................................................ 'p_last_action'
|
|
None, # ....................................................................... 'p_display_name'
|
|
None, # ....................................................................... 'p_display_picture'
|
|
user_identifier, # ............................................................ 'p_token_id'
|
|
json.to_string(python_data = {"email": token["email"]}, no_space = True), # ... 'p_notes'
|
|
mongo_json["user"]["userId"] # ................................................ 'p_created_by'
|
|
),
|
|
session_token = session_token
|
|
)
|
|
if db_json["status"] == 1: token_saved = True
|
|
|
|
# Done here:
|
|
return token_saved
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** MAIN PROGRAM ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
pass
|