square-authentication 10.0.1__tar.gz → 10.0.3__tar.gz

{square_authentication-10.0.1 → square_authentication-10.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: square_authentication
-Version: 10.0.1
+Version: 10.0.3
 Summary: authentication layer for my personal server.
 Home-page: https://github.com/thepmsquare/square_authentication
 Author: Parth Mukesh Mangtani
@@ -27,7 +27,7 @@ Requires-Dist: pyjwt>=2.8.0
 Requires-Dist: requests>=2.32.3
 Requires-Dist: cryptography>=42.0.7
 Requires-Dist: square_commons>=3.0.0
-Requires-Dist: square_logger>=2.0.0
+Requires-Dist: square_logger>=3.0.0
 Requires-Dist: square_database_helper>=2.6.1
 Requires-Dist: square_database_structure>=2.6.0
 Requires-Dist: square_file_store_helper>=3.0.0
@@ -54,7 +54,12 @@ authentication layer for my personal server.
 
 ## goals
 
-(wip)
+- integration with square_*
+- unified authentication api across all projects
+- jwt token support
+- simple user and user profile management
+- oauth support
+- future extensibility
 
 ## Installation
 

{square_authentication-10.0.1 → square_authentication-10.0.3}/README.md

@@ -8,7 +8,12 @@ authentication layer for my personal server.
 
 ## goals
 
-(wip)
+- integration with square_*
+- unified authentication api across all projects
+- jwt token support
+- simple user and user profile management
+- oauth support
+- future extensibility
 
 ## Installation
 

{square_authentication-10.0.1 → square_authentication-10.0.3}/setup.py

@@ -4,7 +4,7 @@ package_name = "square_authentication"
 
 setup(
     name=package_name,
-    version="10.0.1",
+    version="10.0.3",
     packages=find_packages(),
     package_data={
         package_name: ["data/*"],
@@ -19,7 +19,7 @@ setup(
         "requests>=2.32.3",
         "cryptography>=42.0.7",
         "square_commons>=3.0.0",
-        "square_logger>=2.0.0",
+        "square_logger>=3.0.0",
         "square_database_helper>=2.6.1",
         "square_database_structure>=2.6.0",
         "square_file_store_helper>=3.0.0",

{square_authentication-10.0.1 → square_authentication-10.0.3}/square_authentication/configuration.py

@@ -93,6 +93,12 @@ try:
     config_int_square_file_store_port = int(
         ldict_configuration["SQUARE_FILE_STORE_HELPER"]["SQUARE_FILE_STORE_PORT"]
     )
+    config_formatter_choice = ldict_configuration["SQUARE_LOGGER"]["FORMATTER_CHOICE"]
+    if config_formatter_choice not in ("human_readable", "json"):
+        raise ValueError(f"Invalid formatter choice: {config_formatter_choice}")
+    config_bool_enable_redaction = eval(
+        ldict_configuration["SQUARE_LOGGER"]["ENABLE_REDACTION"]
+    )
     # ===========================================
 
     # ===========================================
@@ -143,10 +149,12 @@ try:
 
     # Initialize logger
     global_object_square_logger = SquareLogger(
-        pstr_log_file_name=config_str_log_file_name,
-        pint_log_level=config_int_log_level,
-        pstr_log_path=config_str_log_path,
-        pint_log_backup_count=config_int_log_backup_count,
+        log_file_name=config_str_log_file_name,
+        log_level=config_int_log_level,
+        log_path=config_str_log_path,
+        log_backup_count=config_int_log_backup_count,
+        formatter_choice=config_formatter_choice,
+        enable_redaction=config_bool_enable_redaction,
     )
     global_object_square_database_helper = SquareDatabaseHelper(
         param_str_square_database_ip=config_str_square_database_ip,

{square_authentication-10.0.1 → square_authentication-10.0.3}/square_authentication/data/config.sample.ini

@@ -40,6 +40,9 @@ LOG_PATH = logs
 # number of backup log files to keep during rotation
 # if backupCount is zero, rollover never occurs.
 LOG_BACKUP_COUNT = 3
+# json or human_readable
+FORMATTER_CHOICE = json
+ENABLE_REDACTION = True
 
 [SQUARE_DATABASE_HELPER]
 

{square_authentication-10.0.1 → square_authentication-10.0.3}/square_authentication/data/config.testing.sample.ini

@@ -40,6 +40,9 @@ LOG_PATH = logs
 # number of backup log files to keep during rotation
 # if backupCount is zero, rollover never occurs.
 LOG_BACKUP_COUNT = 3
+# json or human_readable
+FORMATTER_CHOICE = json
+ENABLE_REDACTION = True
 
 [SQUARE_DATABASE_HELPER]
 

square_authentication-10.0.3/square_authentication/routes/core.py

@@ -0,0 +1,494 @@
+from typing import Annotated, List
+
+from fastapi import APIRouter, Header, HTTPException, status
+from fastapi.params import Query
+from fastapi.responses import JSONResponse
+from square_commons import get_api_output_in_standard_format
+from square_database_structure.square.authentication.enums import (
+    RecoveryMethodEnum,
+)
+
+from square_authentication.configuration import (
+    global_object_square_logger,
+)
+from square_authentication.messages import messages
+from square_authentication.pydantic_models.core import (
+    DeleteUserV0,
+    LoginUsernameV0,
+    LogoutAppsV0,
+    RegisterUsernameV0,
+    TokenType,
+    UpdatePasswordV0,
+    ResetPasswordAndLoginUsingBackupCodeV0,
+    SendResetPasswordEmailV0,
+    ResetPasswordAndLoginUsingResetEmailCodeV0,
+    RegisterLoginGoogleV0,
+)
+from square_authentication.utils.routes.core import (
+    util_register_username_v0,
+    util_register_login_google_v0,
+    util_get_user_details_v0,
+    util_update_user_app_ids_v0,
+    util_login_username_v0,
+    util_generate_access_token_v0,
+    util_logout_v0,
+    util_logout_apps_v0,
+    util_logout_all_v0,
+    util_update_username_v0,
+    util_delete_user_v0,
+    util_update_password_v0,
+    util_validate_and_get_payload_from_token_v0,
+    util_update_user_recovery_methods_v0,
+    util_generate_account_backup_codes_v0,
+    util_reset_password_and_login_using_backup_code_v0,
+    util_send_reset_password_email_v0,
+    util_reset_password_and_login_using_reset_email_code_v0,
+)
+
+router = APIRouter(
+    tags=["core"],
+)
+
+
+@router.post("/register_username/v0")
+@global_object_square_logger.auto_logger()
+async def register_username_v0(
+    body: RegisterUsernameV0,
+):
+    try:
+        return util_register_username_v0(
+            username=body.username,
+            password=body.password,
+            app_id=body.app_id,
+        )
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.post("/register_login_google/v0")
+async def register_login_google_v0(body: RegisterLoginGoogleV0):
+    try:
+        return util_register_login_google_v0(
+            app_id=body.app_id,
+            google_id=body.google_id,
+            assign_app_id_if_missing=body.assign_app_id_if_missing,
+        )
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.get("/get_user_details/v0")
+@global_object_square_logger.auto_logger()
+async def get_user_details_v0(
+    access_token: Annotated[str, Header()],
+):
+    try:
+        return util_get_user_details_v0(access_token=access_token)
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.patch("/update_user_app_ids/v0")
+@global_object_square_logger.auto_logger()
+async def update_user_app_ids_v0(
+    access_token: Annotated[str, Header()],
+    app_ids_to_add: List[int],
+    app_ids_to_remove: List[int],
+):
+    try:
+        return util_update_user_app_ids_v0(
+            access_token=access_token,
+            app_ids_to_add=app_ids_to_add,
+            app_ids_to_remove=app_ids_to_remove,
+        )
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.post("/login_username/v0")
+@global_object_square_logger.auto_logger()
+async def login_username_v0(body: LoginUsernameV0):
+    username = body.username
+    password = body.password
+    app_id = body.app_id
+    assign_app_id_if_missing = body.assign_app_id_if_missing
+    username = username.lower()
+    try:
+        return util_login_username_v0(
+            username=username,
+            password=password,
+            app_id=app_id,
+            assign_app_id_if_missing=assign_app_id_if_missing,
+        )
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.get("/generate_access_token/v0")
+@global_object_square_logger.auto_logger()
+async def generate_access_token_v0(
+    refresh_token: Annotated[str, Header()],
+):
+    try:
+        return util_generate_access_token_v0(
+            refresh_token=refresh_token,
+        )
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.delete("/logout/v0")
+@global_object_square_logger.auto_logger()
+async def logout_v0(
+    refresh_token: Annotated[str, Header()],
+):
+    try:
+        return util_logout_v0(
+            refresh_token=refresh_token,
+        )
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.post("/logout/apps/v0")
+@global_object_square_logger.auto_logger()
+async def logout_apps_v0(
+    access_token: Annotated[str, Header()],
+    body: LogoutAppsV0,
+):
+    app_ids = body.app_ids
+    try:
+        return util_logout_apps_v0(access_token=access_token, app_ids=app_ids)
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.delete("/logout/all/v0")
+@global_object_square_logger.auto_logger()
+async def logout_all_v0(
+    access_token: Annotated[str, Header()],
+):
+    try:
+        return util_logout_all_v0(access_token=access_token)
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.patch("/update_username/v0")
+@global_object_square_logger.auto_logger()
+async def update_username_v0(
+    new_username: str,
+    access_token: Annotated[str, Header()],
+):
+    try:
+        return util_update_username_v0(
+            new_username=new_username, access_token=access_token
+        )
+
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.post("/delete_user/v0")
+@global_object_square_logger.auto_logger()
+async def delete_user_v0(
+    body: DeleteUserV0,
+    access_token: Annotated[str, Header()],
+):
+    password = body.password
+    try:
+        return util_delete_user_v0(
+            password=password,
+            access_token=access_token,
+        )
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.patch("/update_password/v0")
+@global_object_square_logger.auto_logger()
+async def update_password_v0(
+    body: UpdatePasswordV0,
+    access_token: Annotated[str, Header()],
+):
+    old_password = body.old_password
+    new_password = body.new_password
+    logout_other_sessions = body.logout_other_sessions
+    preserve_session_refresh_token = body.preserve_session_refresh_token
+    try:
+        return util_update_password_v0(
+            old_password=old_password,
+            new_password=new_password,
+            logout_other_sessions=logout_other_sessions,
+            preserve_session_refresh_token=preserve_session_refresh_token,
+            access_token=access_token,
+        )
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.get("/validate_and_get_payload_from_token/v0")
+@global_object_square_logger.auto_logger()
+async def validate_and_get_payload_from_token_v0(
+    app_id: int,
+    token: Annotated[str, Header()],
+    token_type: TokenType = Query(...),
+):
+    try:
+        return util_validate_and_get_payload_from_token_v0(
+            app_id=app_id,
+            token=token,
+            token_type=token_type,
+        )
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.patch("/update_user_recovery_methods/v0")
+@global_object_square_logger.auto_logger()
+async def update_user_recovery_methods_v0(
+    access_token: Annotated[str, Header()],
+    recovery_methods_to_add: List[RecoveryMethodEnum] = None,
+    recovery_methods_to_remove: List[RecoveryMethodEnum] = None,
+):
+    try:
+        return util_update_user_recovery_methods_v0(
+            access_token=access_token,
+            recovery_methods_to_add=recovery_methods_to_add,
+            recovery_methods_to_remove=recovery_methods_to_remove,
+        )
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.post("/generate_account_backup_codes/v0")
+@global_object_square_logger.auto_logger()
+async def generate_account_backup_codes_v0(
+    access_token: Annotated[str, Header()],
+):
+    try:
+        return util_generate_account_backup_codes_v0(
+            access_token=access_token,
+        )
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.post("/reset_password_and_login_using_backup_code/v0")
+@global_object_square_logger.auto_logger()
+async def reset_password_and_login_using_backup_code_v0(
+    body: ResetPasswordAndLoginUsingBackupCodeV0,
+):
+    backup_code = body.backup_code
+    username = body.username
+    new_password = body.new_password
+    app_id = body.app_id
+    logout_other_sessions = body.logout_other_sessions
+    try:
+        return util_reset_password_and_login_using_backup_code_v0(
+            backup_code=backup_code,
+            username=username,
+            new_password=new_password,
+            app_id=app_id,
+            logout_other_sessions=logout_other_sessions,
+        )
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.post("/send_reset_password_email/v0")
+@global_object_square_logger.auto_logger()
+async def send_reset_password_email_v0(
+    body: SendResetPasswordEmailV0,
+):
+    username = body.username
+    try:
+        return util_send_reset_password_email_v0(
+            username=username,
+        )
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.post("/reset_password_and_login_using_reset_email_code/v0")
+@global_object_square_logger.auto_logger()
+async def reset_password_and_login_using_reset_email_code_v0(
+    body: ResetPasswordAndLoginUsingResetEmailCodeV0,
+):
+    reset_email_code = body.reset_email_code
+    username = body.username
+    new_password = body.new_password
+    app_id = body.app_id
+    logout_other_sessions = body.logout_other_sessions
+    try:
+        return util_reset_password_and_login_using_reset_email_code_v0(
+            reset_email_code=reset_email_code,
+            username=username,
+            new_password=new_password,
+            app_id=app_id,
+            logout_other_sessions=logout_other_sessions,
+        )
+    except HTTPException as he:
+        global_object_square_logger.logger.error(he, exc_info=True)
+        return JSONResponse(status_code=he.status_code, content=he.detail)
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"], log=str(e)
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )