pypomes-iam 0.7.9__tar.gz → 0.8.1__tar.gz

{pypomes_iam-0.7.9 → pypomes_iam-0.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypomes_iam
-Version: 0.7.9
+Version: 0.8.1
 Summary: A collection of Python pomes, penyeach (IAM modules)
 Project-URL: Homepage, https://github.com/TheWiseCoder/PyPomes-IAM
 Project-URL: Bug Tracker, https://github.com/TheWiseCoder/PyPomes-IAM/issues
@@ -12,6 +12,6 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.12
 Requires-Dist: flask>=3.1.2
 Requires-Dist: pyjwt>=2.10.1
-Requires-Dist: pypomes-core>=2.8.4
+Requires-Dist: pypomes-core>=2.8.6
 Requires-Dist: pypomes-crypto>=0.4.8
 Requires-Dist: requests>=2.32.5

{pypomes_iam-0.7.9 → pypomes_iam-0.8.1}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pypomes_iam"
-version = "0.7.9"
+version = "0.8.1"
 authors = [
   { name="GT Nunes", email="wisecoder01@gmail.com" }
 ]
@@ -21,7 +21,7 @@ classifiers = [
 dependencies = [
     "Flask>=3.1.2",
     "PyJWT>=2.10.1",
-    "pypomes-core>=2.8.4",
+    "pypomes-core>=2.8.6",
     "pypomes-crypto>=0.4.8",
     "requests>=2.32.5"
 ]

{pypomes_iam-0.7.9 → pypomes_iam-0.8.1}/src/pypomes_iam/iam_pomes.py

@@ -1,7 +1,8 @@
 from flask import Flask
 from pypomes_core import (
     APP_PREFIX,
-    env_get_int, env_get_str, func_get_defaulted_params
+    env_get_int, env_get_str,
+    func_capture_params, func_defaulted_params
 )
 
 from .iam_common import (
@@ -13,6 +14,7 @@ from .iam_services import (
 )
 
 
+@func_capture_params
 def iam_setup_server(iam_server: IamServer,
                      admin_id: str = None,
                      admin_secret: str = None,
@@ -50,7 +52,7 @@ def iam_setup_server(iam_server: IamServer,
     :param url_base: base URL to request services
     """
     # obtain the defaulted parameters
-    defaulted_params: list[str] = func_get_defaulted_params()
+    defaulted_params: list[str] = func_defaulted_params.get()
 
     # read from the environment variables
     prefix: str = iam_server.name
@@ -92,6 +94,7 @@ def iam_setup_server(iam_server: IamServer,
         }
 
 
+@func_capture_params
 def iam_setup_endpoints(flask_app: Flask,
                         iam_server: IamServer,
                         callback_endpoint: str = None,
@@ -116,7 +119,7 @@ def iam_setup_endpoints(flask_app: Flask,
     :param token_endpoint: endpoint for retrieving authentication token
     """
     # obtain the defaulted parameters
-    defaulted_params: list[str] = func_get_defaulted_params()
+    defaulted_params: list[str] = func_defaulted_params.get()
 
     # read from the environment variables
     prefix: str = iam_server.name

{pypomes_iam-0.7.9 → pypomes_iam-0.8.1}/src/pypomes_iam/iam_services.py

@@ -12,7 +12,6 @@ from .iam_actions import (
     iam_login, iam_logout,
     iam_get_token, iam_exchange, iam_callback
 )
-from .iam_pomes import iam_setup_server
 from .token_pomes import token_get_claims, token_validate
 
 # the logger for IAM service operations
@@ -24,7 +23,10 @@ def jwt_required(func: callable) -> callable:
     """
     Create a decorator to authenticate service endpoints with JWT tokens.
 
+    The decorated function must be a registered endpoint to a *Flask* application.
+
     :param func: the function being decorated
+    :return: the return from the call to *func*, or a *Response NOT AUTHORIZED* if the authentication failed
     """
     # ruff: noqa: ANN003 - Missing type annotation for *{name}
     def wrapper(*args, **kwargs) -> Response:
@@ -45,7 +47,7 @@ def __request_validate(request: Request) -> Response:
     Because this code has a high usage frequency, only authentication failures are logged.
 
     :param request: the *request* to be verified
-    :return: *None* if the *request* is valid, otherwise a *Response* reporting the error
+    :return: *None* if the *request* is valid, otherwise a *Response NOT AUTHORIZED*
     """
     # initialize the return variable
     result: Response | None = None
@@ -151,6 +153,7 @@ def service_setup_server() -> Response:
     args: dict[str, Any] = request.json if request.is_json else request.form
 
     # setup the server
+    from .iam_pomes import iam_setup_server
     iam_setup_server(**args)
     result = Response(status=200)
 

{pypomes_iam-0.7.9 → pypomes_iam-0.8.1}/src/pypomes_iam/provider_pomes.py

@@ -8,8 +8,8 @@ from flask import Flask, Response, request, jsonify
 from logging import Logger
 from pypomes_core import (
     APP_PREFIX, TZ_LOCAL,
-    env_get_str, env_get_strs, env_get_obj,
-    exc_format, func_get_defaulted_params
+    env_get_str, env_get_strs, env_get_obj, exc_format,
+    func_capture_params, func_defaulted_params
 )
 from threading import Lock
 from typing import Any, Final
@@ -53,10 +53,10 @@ def __get_provider_data() -> dict[str, dict[ProviderParam, Any]]:
           - *<APP_PREFIX>_<JWT>_USER_SECRET*          (required)
           - *<APP_PREFIX>_<JWT>_URL_TOKEN*            (required)
 
-    2. The special environment variable *<APP_PREFIX>_IAM_PROVIDER_ENDPOINT* identifies the endpoint from which
-       to obtain JWT tokens. It is not part of the *JWT* providers' setup, but is meant to be used
-       by function *provider_setup_endpoint()*, wherein the value in that variable would represent the
-       default value for its parameter.
+    2. The special environment variable *<APP_PREFIX>_IAM_PROVIDER_ENDPOINT_TOKEN* identifies the endpoint
+       from which to obtain JWT tokens. It is not part of the *JWT* providers' setup, but is meant to be
+       used by function *provider_setup_endpoint()*, wherein the value in that variable would represent
+       the default value for its parameter.
 
     :return: the configuration data for the select *JWT* providers.
     """
@@ -104,6 +104,7 @@ _provider_registry: Final[dict[str, dict[str, Any]]] = __get_provider_data()
 _provider_lock: Final[Lock] = Lock()
 
 
+@func_capture_params
 def provider_setup_server(provider_id: str,
                           user_id: str = None,
                           user_secret: str = None,
@@ -136,7 +137,7 @@ def provider_setup_server(provider_id: str,
     global _provider_registry
 
     # obtain the defaulted parameters
-    defaulted_params: list[str] = func_get_defaulted_params()
+    defaulted_params: list[str] = func_defaulted_params.get()
 
     # read from the environment variables
     prefix: str = provider_id.upper()
@@ -169,6 +170,7 @@ def provider_setup_server(provider_id: str,
         }
 
 
+@func_capture_params
 def provider_setup_endpoint(flask_app: Flask,
                             provider_endpoint: str = None) -> None:
     """
@@ -181,11 +183,11 @@ def provider_setup_endpoint(flask_app: Flask,
     :param provider_endpoint: endpoint for requenting tokens to provider
     """
     # obtain the defaulted parameters
-    defaulted_params: list[str] = func_get_defaulted_params()
+    defaulted_params: list[str] = func_defaulted_params.get()
 
     # read from the environment variable
     if "provider_endpoint" in defaulted_params:
-        provider_endpoint = env_get_str(key=f"{APP_PREFIX}_IAM_PROVIDER_ENDPOINT")
+        provider_endpoint = env_get_str(key=f"{APP_PREFIX}_IAM_PROVIDER_ENDPOINT_TOKEN")
 
     # establish the endpoints
     if provider_endpoint: