pypomes-iam 0.4.8__tar.gz → 0.5.0__tar.gz

{pypomes_iam-0.4.8 → pypomes_iam-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypomes_iam
-Version: 0.4.8
+Version: 0.5.0
 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.4.8 → pypomes_iam-0.5.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pypomes_iam"
-version = "0.4.8"
+version = "0.5.0"
 authors = [
   { name="GT Nunes", email="wisecoder01@gmail.com" }
 ]

{pypomes_iam-0.4.8 → pypomes_iam-0.5.0}/src/pypomes_iam/iam_common.py

@@ -20,14 +20,14 @@ class IamServer(StrEnum):
 # registry structure:
 # { <IamServer>:
 #    {
+#       "base-url": <str>,
 #       "client-id": <str>,
 #       "client-secret": <str>,
 #       "client-timeout": <int>,
 #       "recipient-attr": <str>,
-#       "public_key": <str>,
+#       "public-key": <str>,
 #       "pk-lifetime": <int>,
 #       "pk-expiration": <int>,
-#       "base-url": <str>,
 #       "cache": <FIFOCache>
 #    },
 #    ...
@@ -80,7 +80,7 @@ def _get_public_key(iam_server: IamServer,
             # obtain a new public key
             url: str = f"{registry["base-url"]}/protocol/openid-connect/certs"
             if logger:
-                logger.debug(msg=f"GET '{url}'")
+                logger.debug(msg=f"GET {url}")
             try:
                 response: requests.Response = requests.get(url=url)
                 if response.status_code == 200:
@@ -96,7 +96,7 @@ def _get_public_key(iam_server: IamServer,
                 elif logger:
                     msg: str = f"GET failure, status {response.status_code}, reason '{response.reason}'"
                     if hasattr(response, "content") and response.content:
-                        msg += f", content '{response.content}'"
+                        msg += f", content {response.content}"
                     logger.error(msg=msg)
                     if isinstance(errors, list):
                         errors.append(msg)
@@ -198,7 +198,7 @@ def _get_iam_server(endpoint: str,
         result = IamServer.IAM_KEYCLOAK
     else:
         result = None
-        msg: str = f"Unknown endpoind {endpoint}"
+        msg: str = f"Unable to find a IAM server to service endpoint '{endpoint}'"
         if logger:
             logger.error(msg=msg)
         if isinstance(errors, list):

{pypomes_iam-0.4.8 → pypomes_iam-0.5.0}/src/pypomes_iam/iam_pomes.py

@@ -11,7 +11,7 @@ from typing import Any
 from .iam_common import (
     IamServer, _iam_lock,
     _get_iam_users, _get_iam_registry,
-    _get_login_timeout, _get_user_data, _get_public_key
+    _get_login_timeout, _get_user_data,  # _get_public_key
 )
 from .token_pomes import token_validate
 
@@ -404,8 +404,8 @@ def __post_for_token(iam_server: IamServer,
 
             # log the POST ('client_secret' data must not be shown in log)
             if logger:
-                logger.debug(msg=f"POST '{url}', data {json.dumps(obj=body_data,
-                                                                  ensure_ascii=False)}")
+                logger.debug(msg=f"POST {url}, {json.dumps(obj=body_data,
+                                                           ensure_ascii=False)}")
             if client_secret:
                 body_data["client_secret"] = client_secret
             try:
@@ -421,12 +421,13 @@ def __post_for_token(iam_server: IamServer,
                                                             data=body_data)
                 if response.status_code == 200:
                     # request succeeded
-                    if logger:
-                        logger.debug(msg=f"POST success, status {response.status_code}")
                     result = response.json()
+                    if logger:
+                        logger.debug(msg=f"POST success, {json.dumps(obj=result,
+                                                                     ensure_ascii=False)}")
                 else:
                     # request resulted in error
-                    err_msg = f"POST failure, status {response.status_code}, reason '{response.reason}'"
+                    err_msg = f"POST failure, status {response.status_code}, reason {response.reason}"
                     if hasattr(response, "content") and response.content:
                         err_msg += f", content '{response.content}'"
                     if logger:
@@ -486,25 +487,25 @@ def __validate_and_store(iam_server: IamServer,
             user_data["access-expiration"] = now + token_data.get("expires_in")
             refresh_exp: int = user_data.get("refresh_expires_in")
             user_data["refresh-expiration"] = (now + refresh_exp) if refresh_exp else sys.maxsize
-            public_key: str = _get_public_key(iam_server=iam_server,
-                                              errors=errors,
-                                              logger=logger)
-            if public_key:
-                recipient_attr = registry["recipient-attr"]
-                login_id = user_data.pop("login-id", None)
-                claims: dict[str, dict[str, Any]] = token_validate(token=token,
-                                                                   issuer=registry["base-url"],
-                                                                   recipient_id=login_id,
-                                                                   recipient_attr=recipient_attr,
-                                                                   public_key=public_key,
-                                                                   errors=errors,
-                                                                   logger=logger)
-                if claims:
-                    users: dict[str, dict[str, Any]] = _get_iam_users(iam_server=iam_server,
-                                                                      errors=errors,
-                                                                      logger=logger)
-                    if users:
-                        user_id: str = login_id if login_id else claims["payload"][recipient_attr]
-                        users[user_id] = user_data
-                        result = (user_id, token)
+            # public_key: str = _get_public_key(iam_server=iam_server,
+            #                                   errors=errors,
+            #                                   logger=logger)
+            recipient_attr = registry["recipient-attr"]
+            login_id = user_data.pop("login-id", None)
+            claims: dict[str, dict[str, Any]] = token_validate(token=token,
+                                                               issuer=registry["base-url"],
+                                                               recipient_id=login_id,
+                                                               recipient_attr=recipient_attr,
+                                                               # public_key=public_key,
+                                                               errors=errors,
+                                                               logger=logger)
+            if claims:
+                users: dict[str, dict[str, Any]] = _get_iam_users(iam_server=iam_server,
+                                                                  errors=errors,
+                                                                  logger=logger)
+                # must test with 'not errors'
+                if not errors:
+                    user_id: str = login_id if login_id else claims["payload"][recipient_attr]
+                    users[user_id] = user_data
+                    result = (user_id, token)
     return result

{pypomes_iam-0.4.8 → pypomes_iam-0.5.0}/src/pypomes_iam/provider_pomes.py

@@ -1,3 +1,4 @@
+import json
 import requests
 import sys
 from base64 import b64encode
@@ -16,8 +17,8 @@ from typing import Any, Final
 #      "basic-auth": <bool>,
 #      "headers-data": <dict[str, str]>,
 #      "body-data": <dict[str, str],
-#      "token": <str>,
-#      "expiration": <timestamp>
+#      "access-token": <str>,
+#      "access-expiration": <timestamp>
 #    }
 # }
 _provider_registry: Final[dict[str, dict[str, Any]]] = {}
@@ -63,8 +64,10 @@ def provider_register(provider_id: str,
             "custom-auth": custom_auth,
             "headers-data": headers_data,
             "body-data": body_data,
-            "token": None,
-            "expiration": datetime.now(tz=TZ_LOCAL).timestamp()
+            "access-token": None,
+            "access-expiration": 0,
+            "refresh-token": None,
+            "refresh-expiration": 0
         }
 
 
@@ -88,7 +91,7 @@ def provider_get_token(provider_id: str,
         provider: dict[str, Any] = _provider_registry.get(provider_id)
         if provider:
             now: float = datetime.now(tz=TZ_LOCAL).timestamp()
-            if now > provider.get("expiration"):
+            if now > provider.get("access-expiration"):
                 user: str = provider.get("user")
                 pwd: str = provider.get("pwd")
                 headers_data: dict[str, str] = provider.get("headers-data") or {}
@@ -101,6 +104,9 @@ def provider_get_token(provider_id: str,
                     enc_bytes: bytes = b64encode(f"{user}:{pwd}".encode())
                     headers_data["Authorization"] = f"Basic {enc_bytes.decode()}"
                 url: str = provider.get("url")
+            if logger:
+                logger.debug(msg=f"POST {url}, {json.dumps(obj=body_data,
+                                                           ensure_ascii=False)}")
                 try:
                     # typical return on a token request:
                     # {
@@ -117,19 +123,28 @@ def provider_get_token(provider_id: str,
                                                                 timeout=None)
                     if response.status_code < 200 or response.status_code >= 300:
                         # request resulted in error, report the problem
-                        err_msg = (f"POST '{url}': failed, "
-                                   f"status {response.status_code}, reason '{response.reason}'")
+                        err_msg = (f"POST failure, "
+                                   f"status {response.status_code}, reason {response.reason}")
                     else:
+                        # request succeeded
+                        if logger:
+                            logger.debug(msg=f"POST success, status {response.status_code}")
                         reply: dict[str, Any] = response.json()
-                        provider["token"] = reply.get("access_token")
-                        provider["expiration"] = now + int(reply.get("expires_in"))
+                        provider["access-token"] = reply.get("access_token")
+                        provider["access-expiration"] = now + int(reply.get("expires_in"))
+                        if reply.get("refresh_token"):
+                            provider["refresh-token"] = reply["refesh_token"]
+                            if reply.get("refresh_expires_in"):
+                                provider["refresh-expiration"] = now + int(reply.get("refresh_expires_in"))
+                            else:
+                                provider["refresh-expiration"] = sys.maxsize
                         if logger:
-                            logger.debug(msg=f"POST '{url}': status {response.status_code}")
+                            logger.debug(msg=f"POST {url}: status {response.status_code}")
                 except Exception as e:
                     # the operation raised an exception
                     err_msg = exc_format(exc=e,
                                          exc_info=sys.exc_info())
-                    err_msg = f"POST '{url}': error, '{err_msg}'"
+                    err_msg = f"POST error, '{err_msg}'"
         else:
             err_msg: str = f"Provider '{provider_id}' not registered"
 
@@ -139,7 +154,7 @@ def provider_get_token(provider_id: str,
         if logger:
             logger.error(msg=err_msg)
     else:
-        result = provider.get("token")
+        result = provider.get("access-token")
 
     return result