256 lines
9.3 KiB
Python
256 lines
9.3 KiB
Python
"""
|
|
|
|
AUTHOR:
|
|
|
|
Khushal P Soonderji
|
|
|
|
DATE:
|
|
|
|
Friday, 13th Dec., 2024
|
|
|
|
OBJECTIVE:
|
|
|
|
To receive auth details for various software.
|
|
|
|
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
|
|
|
|
# To work with MongoDB:
|
|
from bson.objectid import ObjectId
|
|
|
|
# Data Models:
|
|
from models.api.software.auth import SoftwareAuthRequestHeaders, SoftwareAuthRequestData
|
|
from models.core.auth_token import CoreAuthTokenModel
|
|
|
|
# For asynchronous activities:
|
|
import asyncio
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** MACROS / ONE-TIME INIT ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# Related to Quart:
|
|
sw_auth_bp = Blueprint("sw_auth", __name__)
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** VARIABLES ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# --- Nothing Yet
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** FUNCTIONS ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
@sw_auth_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
|
|
|
|
|
|
# ---------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
@sw_auth_bp.route("/auth", methods = ["POST"])
|
|
@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 = "smsAuthApi",
|
|
log_input = True,
|
|
log_output = True,
|
|
sensitive_keys = ["sessionToken", "X-Session-Token"]
|
|
)
|
|
@log_chain_to_mongo(attr_name = "logs_mongo")
|
|
@should_not_be_under_maintenance(attr_name = "is_under_maintenance")
|
|
@validate_input(
|
|
header_validator = lambda x: SoftwareAuthRequestHeaders(**x).model_dump(),
|
|
data_validator = lambda x: SoftwareAuthRequestData(**x)
|
|
)
|
|
@handle_cancelled_request()
|
|
async def authorize_software_client(
|
|
inbound_headers: dict | SoftwareAuthRequestHeaders = None,
|
|
inbound_data: dict | SoftwareAuthRequestData = None,
|
|
inbound_files: dict = None,
|
|
**kwargs
|
|
):
|
|
|
|
"""
|
|
God knows. Don't ask.
|
|
: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:
|
|
success = False
|
|
message = None
|
|
|
|
# ┏┳┓┓ ┏┓┏┓ ┏┓┏┏• ┏┓┳
|
|
# ┃ ┣┓┏┓ ┃ ┣┫ ┃┃╋╋┓┏┏┓ ┣┫┃
|
|
# ┻ ┛┗┗ ┗┛┛┗ ┗┛┛┛┗┗┗ ┛┗┻
|
|
|
|
if inbound_data.softwareClient == "theCaOfficeAi":
|
|
|
|
pass
|
|
|
|
# auth_token = CoreAuthTokenModel(
|
|
# serviceType = "software",
|
|
# client = inbound_data.softwareClient,
|
|
# authType = "auth",
|
|
# auth = inbound_data.auth.model_dump(),
|
|
# user = kwargs.get("session_info"),
|
|
# clientUserId = {},
|
|
# status = "active",
|
|
# syncFreq = 60
|
|
# )
|
|
#
|
|
# token_id = await current_app.core_auth_token_controller.get_token_id(
|
|
# db_conn = current_app.sql_writer,
|
|
# mongo_conn = current_app.data_mongo,
|
|
# auth_token = auth_token,
|
|
# token_notes = {},
|
|
# session_token = inbound_headers["X-Session-Token"]
|
|
# )
|
|
#
|
|
# success = await current_app.core_auth_token_controller.set_token(
|
|
# db_conn = current_app.sql_writer,
|
|
# mongo_conn = current_app.data_mongo,
|
|
# token_id = token_id,
|
|
# auth_token = auth_token,
|
|
# token_notes = {},
|
|
# session_token = inbound_headers["X-Session-Token"]
|
|
# )
|
|
|
|
# ┏┓ ┳┳┓•┓ ┏┳┓•┓ ┏┓┏┓┏┓ ┏┓ ┓┏┓┏┓┏┓
|
|
# ┣ ┏┓┏┓ ┃┃┃┓┃┏┏┓┏┓ ┃ ┓┃┏ ┃┃┃┃┃┃┏┓┣ ┃┃┫┃┫┃┫
|
|
# ┻ ┗┛┛ ┛ ┗┗┛┗┛ ┗┛ ┻ ┗┛┗ ┣┛┣┛┣┛┗┛┗┛ ┻┗┛┗┛┗┛
|
|
|
|
elif inbound_data.softwareClient == "mikrotikPPPoE1000":
|
|
|
|
# Make the client controller test and save the auth:
|
|
response = await current_app.mikrotik_pppoe_1000_controller.save_auth(
|
|
sql_conn = current_app.sql_writer,
|
|
mongo_data_conn = current_app.data_mongo,
|
|
mikrotik_auth = inbound_data.auth
|
|
)
|
|
|
|
# Note down the results:
|
|
success = response.success
|
|
message = f"Action Chain '{response.actionChain}': {response.message}"
|
|
|
|
# ┏┓ ┳┳┓•┓ ┏┳┓•┓ ┓┏ ┓┏┓┏┓┏┓
|
|
# ┣ ┏┓┏┓ ┃┃┃┓┃┏┏┓┏┓ ┃ ┓┃┏ ┣┫┏┓╋┏┏┓┏┓╋ ┃┃┫┃┫┃┫
|
|
# ┻ ┗┛┛ ┛ ┗┗┛┗┛ ┗┛ ┻ ┗┛┗ ┛┗┗┛┗┛┣┛┗┛┗ ┻┗┛┗┛┗┛
|
|
# ┛
|
|
|
|
elif inbound_data.softwareClient == "mikrotikHotspot1000":
|
|
|
|
pass
|
|
|
|
# ┳┓
|
|
# ┣┫┏┓┏┏┓┏┓┏┓┏┏┓
|
|
# ┛┗┗ ┛┣┛┗┛┛┗┛┗
|
|
# ┛
|
|
|
|
# Done here:
|
|
return ResponseModel(
|
|
status_code = StatusCodes.OK if success else StatusCodes.FAILED,
|
|
http_code = HttpCodes.SUCCESS if success else HttpCodes.INTERNAL_SERVER_ERROR,
|
|
message = message,
|
|
data = {
|
|
"client": inbound_data.softwareClient,
|
|
"authorized": success
|
|
}
|
|
)
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** MAIN PROGRAM ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
pass
|