pypomes-iam 0.2.1__py3-none-any.whl → 0.2.3__py3-none-any.whl

pypomes_iam/common_pomes.py

@@ -8,6 +8,7 @@ from datetime import datetime
 from flask import Request
 from logging import Logger
 from pypomes_core import TZ_LOCAL, exc_format
+from pypomes_crypto import crypto_jwk_convert
 from typing import Any
 
 # registry structure:
@@ -36,75 +37,6 @@ from typing import Any
 # }
 
 
-def _service_callback(registry: dict[str, Any],
-                      args: dict[str, Any],
-                      errors: list[str],
-                      logger: Logger | None) -> tuple[str, str]:
-    """
-    Entry point for the callback from JusBR on authentication operation.
-
-    :param registry: the registry holding the authentication data
-    :param args: the arguments passed when requesting the service
-    :param errors: incidental errors
-    :param logger: optional logger
-    """
-    from .token_pomes import token_validate
-
-    # initialize the return variable
-    result: tuple[str, str] | None = None
-
-    # retrieve the users authentication data
-    cache: Cache = registry["safe-cache"]
-    users: dict[str, dict[str, Any]] = cache.get("users")
-
-    # validate the OAuth2 state
-    oauth_state: str = args.get("state")
-    user_data: dict[str, Any] | None = None
-    if oauth_state:
-        for user, data in users.items():
-            if user == oauth_state:
-                user_data = data
-                break
-
-    # exchange 'code' for the token
-    if user_data:
-        users.pop(oauth_state)
-        code: str = args.get("code")
-        body_data: dict[str, Any] = {
-            "grant_type": "authorization_code",
-            "code": code,
-            "redirect_uri": registry.get("callback-url"),
-        }
-        token = _post_for_token(registry=registry,
-                                user_data=user_data,
-                                body_data=body_data,
-                                errors=errors,
-                                logger=logger)
-        # retrieve the token's claims
-        if not errors:
-            public_key: bytes = _get_public_key(registry=registry,
-                                                logger=logger)
-            token_claims: dict[str, dict[str, Any]] = token_validate(token=token,
-                                                                     issuer=registry["base-url"],
-                                                                     public_key=public_key,
-                                                                     errors=errors,
-                                                                     logger=logger)
-            if not errors:
-                token_user: str = token_claims["payload"].get("preferred_username")
-                if token_user == oauth_state:
-                    users[token_user] = user_data
-                    result = (token_user, token)
-                else:
-                    errors.append(f"Token was issued to user '{token_user}'")
-    else:
-        msg: str = "Unknown OAuth2 code received"
-        if _get_login_timeout(registry=registry):
-            msg += " - possible operation timeout"
-        errors.append(msg)
-
-    return result
-
-
 def _service_login(registry: dict[str, Any],
                    args: dict[str, Any],
                    logger: Logger | None) -> str:
@@ -165,6 +97,76 @@ def _service_logout(registry: dict[str, Any],
                 logger.debug(msg=f"User '{user_id}' removed from the registry")
 
 
+def _service_callback(registry: dict[str, Any],
+                      args: dict[str, Any],
+                      errors: list[str],
+                      logger: Logger | None) -> tuple[str, str]:
+    """
+    Entry point for the callback from JusBR on authentication operation.
+
+    :param registry: the registry holding the authentication data
+    :param args: the arguments passed when requesting the service
+    :param errors: incidental errors
+    :param logger: optional logger
+    """
+    from .token_pomes import token_validate
+
+    # initialize the return variable
+    result: tuple[str, str] | None = None
+
+    # retrieve the users authentication data
+    cache: Cache = registry["safe-cache"]
+    users: dict[str, dict[str, Any]] = cache.get("users")
+
+    # validate the OAuth2 state
+    oauth_state: str = args.get("state")
+    user_data: dict[str, Any] | None = None
+    if oauth_state:
+        for user, data in users.items():
+            if user == oauth_state:
+                user_data = data
+                break
+
+    # exchange 'code' for the token
+    if user_data:
+        expiration: int = user_data["login-expiration"] or sys.maxsize
+        if int(datetime.now(tz=TZ_LOCAL).timestamp()) > expiration:
+            errors.append("Operation timeout")
+        else:
+            users.pop(oauth_state)
+            code: str = args.get("code")
+            body_data: dict[str, Any] = {
+                "grant_type": "authorization_code",
+                "code": code,
+                "redirect_uri": registry.get("callback-url"),
+            }
+            token = _post_for_token(registry=registry,
+                                    user_data=user_data,
+                                    body_data=body_data,
+                                    errors=errors,
+                                    logger=logger)
+            # retrieve the token's claims
+            if not errors:
+                public_key: bytes = _get_public_key(registry=registry,
+                                                    logger=logger)
+                token_claims: dict[str, dict[str, Any]] = token_validate(token=token,
+                                                                         issuer=registry["base-url"],
+                                                                         public_key=public_key,
+                                                                         errors=errors,
+                                                                         logger=logger)
+                if not errors:
+                    token_user: str = token_claims["payload"].get("preferred_username")
+                    if token_user == oauth_state:
+                        users[token_user] = user_data
+                        result = (token_user, token)
+                    else:
+                        errors.append(f"Token was issued to user '{token_user}'")
+    else:
+        errors.append("Unknown state received")
+
+    return result
+
+
 def _service_token(registry: dict[str, Any],
                    args: dict[str, Any],
                    errors: list[str] = None,
@@ -225,8 +227,6 @@ def _get_public_key(registry: dict[str, Any],
     :param registry: the registry holding the authentication data
     :return: the public key, in *DER* format
     """
-    from pypomes_crypto import crypto_jwk_convert
-
     # initialize the return variable
     result: bytes | None = None
 

pypomes_iam/iam_pomes.py

@@ -6,8 +6,8 @@ from .common_pomes import (
     _service_login, _service_logout,
     _service_callback, _service_token, _log_init
 )
-from .jusbr_pomes import _jusbr_logger, _jusbr_registry
-from .keycloak_pomes import _keycloak_logger, _keycloak_registry
+from .jusbr_pomes import _jusbr_get_logger, _jusbr_get_registry
+from .keycloak_pomes import _keycloak_get_logger, _keycloak_get_registry
 
 
 # @flask_app.route(rule=<login_endpoint>,  # JUSBR_LOGIN_ENDPOINT: /iam/jusbr:login
@@ -25,11 +25,11 @@ def service_login() -> Response:
     logger: Logger
     registry: dict[str, Any]
     if request.endpoint == "jusbr-login":
-        logger = _jusbr_logger
-        registry = _jusbr_registry
+        logger = _jusbr_get_logger()
+        registry = _jusbr_get_registry()
     else:
-        logger = _keycloak_logger
-        registry = _keycloak_registry
+        logger = _keycloak_get_logger()
+        registry = _keycloak_get_registry()
 
     # log the request
     if logger:
@@ -64,11 +64,11 @@ def service_logout() -> Response:
     logger: Logger
     registry: dict[str, Any]
     if request.endpoint == "jusbr-logout":
-        logger = _jusbr_logger
-        registry = _jusbr_registry
+        logger = _jusbr_get_logger()
+        registry = _jusbr_get_registry()
     else:
-        logger = _keycloak_logger
-        registry = _keycloak_registry
+        logger = _keycloak_get_logger()
+        registry = _keycloak_get_registry()
 
     # log the request
     if logger:
@@ -101,11 +101,11 @@ def service_callback() -> Response:
     logger: Logger
     registry: dict[str, Any]
     if request.endpoint == "jusbr-callback":
-        logger = _jusbr_logger
-        registry = _jusbr_registry
+        logger = _jusbr_get_logger()
+        registry = _jusbr_get_registry()
     else:
-        logger = _keycloak_logger
-        registry = _keycloak_registry
+        logger = _keycloak_get_logger()
+        registry = _keycloak_get_registry()
 
     # log the request
     if logger:
@@ -146,11 +146,11 @@ def service_token() -> Response:
     logger: Logger
     registry: dict[str, Any]
     if request.endpoint == "jusbr-token":
-        logger = _jusbr_logger
-        registry = _jusbr_registry
+        logger = _jusbr_get_logger()
+        registry = _jusbr_get_registry()
     else:
-        logger = _keycloak_logger
-        registry = _keycloak_registry
+        logger = _keycloak_get_logger()
+        registry = _keycloak_get_registry()
 
     # log the request
     if logger:

pypomes_iam/jusbr_pomes.py

@@ -1,4 +1,4 @@
-from cachetools import FIFOCache
+from cachetools import Cache, FIFOCache
 from datetime import datetime
 from flask import Flask
 from logging import Logger
@@ -37,9 +37,9 @@ JUSBR_URL_AUTH_CALLBACK: Final[str] = env_get_str(key=f"{APP_PREFIX}_JUSBR_URL_A
 #    "key-expiration": <int>,
 #    "base-url": <str>,
 #    "callback-url": <str>,
-#    "cache-obj": <FIFOCache>
+#    "safe-cache": <FIFOCache>
 # }
-# data in "cache-obj":
+# data in "safe-cache":
 # {
 #    "users": {
 #       "<user-id>": {
@@ -94,6 +94,8 @@ def jusbr_setup(flask_app: Flask,
     _logger = logger
 
     # configure the JusBR registry
+    safe_cache: Cache = FIFOCache(maxsize=1048576)
+    safe_cache["users"] = {}
     _jusbr_registry = {
         "client-id": client_id,
         "client-secret": client_secret,
@@ -102,7 +104,7 @@ def jusbr_setup(flask_app: Flask,
         "callback-url": callback_url,
         "key-expiration": int(datetime.now(tz=TZ_LOCAL).timestamp()),
         "key-lifetime": public_key_lifetime,
-        "cache-obj": FIFOCache(maxsize=1048576)
+        "safe-cache": safe_cache
     }
 
     # establish the endpoints
@@ -147,3 +149,19 @@ def jusbr_get_token(user_id: str,
                           args=args,
                           errors=errors,
                           logger=logger)
+
+
+def _jusbr_get_logger() -> Logger:
+    """
+    Retrieve the logger for JusBR operations.
+    :return: the Keycloak logger
+    """
+    return _jusbr_logger
+
+
+def _jusbr_get_registry() -> dict[str, Any]:
+    """
+    Retrieve the registry holding user authentication data related to JusBR operations.
+    :return: the Keycloak registry
+    """
+    return _jusbr_registry

pypomes_iam/keycloak_pomes.py

@@ -1,4 +1,4 @@
-from cachetools import FIFOCache
+from cachetools import Cache, FIFOCache
 from datetime import datetime
 from flask import Flask
 from logging import Logger
@@ -97,6 +97,8 @@ def keycloak_setup(flask_app: Flask,
     _keycloak_logger = logger
 
     # configure the JusBR registry
+    safe_cache: Cache = FIFOCache(maxsize=1048576)
+    safe_cache["users"] = {}
     _keycloak_registry = {
         "client-id": client_id,
         "client-secret": client_secret,
@@ -105,7 +107,7 @@ def keycloak_setup(flask_app: Flask,
         "callback-url": callback_url,
         "key-expiration": int(datetime.now(tz=TZ_LOCAL).timestamp()),
         "key-lifetime": public_key_lifetime,
-        "safe-cache": FIFOCache(maxsize=1048576)
+        "safe-cache": safe_cache
     }
 
     # establish the endpoints
@@ -150,3 +152,19 @@ def keycloak_get_token(user_id: str,
                           args=args,
                           errors=errors,
                           logger=logger)
+
+
+def _keycloak_get_logger() -> Logger:
+    """
+    Retrieve the logger for Keycloak operations.
+    :return: the Keycloak logger
+    """
+    return _keycloak_logger
+
+
+def _keycloak_get_registry() -> dict[str, Any]:
+    """
+    Retrieve the registry holding user authentication data related to Keycloak operations.
+    :return: the Keycloak registry
+    """
+    return _keycloak_registry

{pypomes_iam-0.2.1.dist-info → pypomes_iam-0.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypomes_iam
-Version: 0.2.1
+Version: 0.2.3
 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

pypomes_iam-0.2.3.dist-info/RECORD

@@ -0,0 +1,11 @@
+pypomes_iam/__init__.py,sha256=u-gNGbsayMf-2SWTB8VcoTCADoczZuwNEH50BPxTZZ8,682
+pypomes_iam/common_pomes.py,sha256=08G8-Rcpuld4JxciEEhzORMt575kErHGEVk8_QC1uC4,15710
+pypomes_iam/iam_pomes.py,sha256=-2XppbAAuY58jYKd4ZN2MMjQd7wh6n9I8cofgAt0_9s,5639
+pypomes_iam/jusbr_pomes.py,sha256=FFTzhpxB4Y7T_JKYC1xvYIcb-ca-Frtl-7LK7dDkIXQ,6723
+pypomes_iam/keycloak_pomes.py,sha256=_hR1nZhk-ejZpYrwijIcEm_GyfrtQkWtNdqJI7hcZuY,7129
+pypomes_iam/provider_pomes.py,sha256=eP8XzjTUEpwejTkO0wmDiqKjqbIEOzRNCR2ju5E15og,5856
+pypomes_iam/token_pomes.py,sha256=McjKB8omCjuicenwvDVPiWYu3-7gQeLg1AzgAVKK32M,4309
+pypomes_iam-0.2.3.dist-info/METADATA,sha256=IzheEi4k7zb4WSewyRmLbQvJ83kKZq1OfqL7TlVEp3s,694
+pypomes_iam-0.2.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pypomes_iam-0.2.3.dist-info/licenses/LICENSE,sha256=YvUELgV8qvXlaYsy9hXG5EW3Bmsrkw-OJmmILZnonAc,1086
+pypomes_iam-0.2.3.dist-info/RECORD,,

pypomes_iam-0.2.1.dist-info/RECORD

@@ -1,11 +0,0 @@
-pypomes_iam/__init__.py,sha256=u-gNGbsayMf-2SWTB8VcoTCADoczZuwNEH50BPxTZZ8,682
-pypomes_iam/common_pomes.py,sha256=wzyXM0lK7eXuUaGow88872wxbYpJ8DcXjVAVKZnTkmU,15533
-pypomes_iam/iam_pomes.py,sha256=THztlEWObDY4_L8GHQem2uX5J8_44XEP-mUg2Fi_Gx0,5527
-pypomes_iam/jusbr_pomes.py,sha256=ioJSZhuPR5xMzomT2zomNH90uIdbwT6GoracIClgsh0,6261
-pypomes_iam/keycloak_pomes.py,sha256=UpHSr4bhNdDl7sr8GSCIDTdPsXEgX3N11qOiR48TvjA,6652
-pypomes_iam/provider_pomes.py,sha256=eP8XzjTUEpwejTkO0wmDiqKjqbIEOzRNCR2ju5E15og,5856
-pypomes_iam/token_pomes.py,sha256=McjKB8omCjuicenwvDVPiWYu3-7gQeLg1AzgAVKK32M,4309
-pypomes_iam-0.2.1.dist-info/METADATA,sha256=XkLYRIQ6OK6TUGH2SKUsrWIG_zwZHQ9tm0ud_YEEef0,694
-pypomes_iam-0.2.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pypomes_iam-0.2.1.dist-info/licenses/LICENSE,sha256=YvUELgV8qvXlaYsy9hXG5EW3Bmsrkw-OJmmILZnonAc,1086
-pypomes_iam-0.2.1.dist-info/RECORD,,