pypomes-jwt 0.5.5__py3-none-any.whl → 0.5.7__py3-none-any.whl

pypomes_jwt/jwt_data.py

@@ -63,14 +63,10 @@ class JwtData:
                         private_key: bytes,
                         public_key: bytes,
                         request_timeout: float,
-                        local_provider: bool,
                         logger: Logger = None) -> None:
         """
         Add to storage the parameters needed to obtain and validate JWT tokens.
 
-        Protocol indication in *service_url* (typically *http:* or *https:*), is disregarded, to guarantee
-        that processing herein will not be affected by in-transit protocol changes.
-
         Presently, the *refresh_max_age* data is not relevant, as the authorization parameters in *claims*
         (typically, an acess-key/secret-key pair), have been previously validated elsewhere.
         This situation might change in the future.
@@ -84,7 +80,6 @@ class JwtData:
         :param private_key: private key for RSA authentication
         :param public_key: public key for RSA authentication
         :param request_timeout: timeout for the requests to the service URL
-        :param local_provider: whether 'service_url' is a local endpoint
         :param logger: optional logger
         """
         # obtain the item in storage
@@ -97,7 +92,6 @@ class JwtData:
                 "algorithm": algorithm,
                 "access-max-age": access_max_age,
                 "request-timeout": request_timeout,
-                "local-provider": local_provider,
                 "refresh-exp": datetime.now(tz=timezone.utc) + timedelta(seconds=refresh_max_age)
             }
             if algorithm in ["HS256", "HS512"]:
@@ -176,7 +170,7 @@ class JwtData:
         :raises InvalidIssuerError: 'iss' claim does not match the expected issuer
         :raises InvalidIssuedAtError: 'iat' claim is non-numeric
         :raises MissingRequiredClaimError: a required claim is not contained in the claimset
-        :raises RuntimeError: access data not found for the given 'service_url', or
+        :raises RuntimeError: access data not found for the given *service_url*, or
                               the remote JWT provider failed to return a token
         """
         # declare the return variable
@@ -253,7 +247,7 @@ class JwtData:
 
         :param token: the token to be inspected for claims
         :param logger: optional logger
-        :return: the token's claimset, or 'None' if error
+        :return: the token's claimset, or *None* if error
         :raises InvalidTokenError: token is not valid
         :raises ExpiredSignatureError: token has expired
         """
@@ -283,16 +277,18 @@ class JwtData:
     def retrieve_access_data(self,
                              service_url: str,
                              logger: Logger = None) -> dict[str, dict[str, Any]]:
+        # noinspection HttpUrlsUsage
         """
-        Retrieve and return the access data in storage corresponding to *service_url*.
+                Retrieve and return the access data in storage corresponding to *service_url*.
 
-        Protocol indication in *service_url* (typically *http:* or *https:*), is disregarded, to guarantee
-        that processing herein will not be affected by in-transit protocol changes.
+                For the purpose of retrieving access data, Protocol indication in *service_url*
+                (typically, *http://* or *https://*), is disregarded. This guarantees
+                that processing herein will not be affected by in-transit protocol changes.
 
-        :param service_url: the reference URL for obtaining JWT tokens
-        :param logger: optional logger
-        :return: the corresponding item in storage, or 'None' if not found
-        """
+                :param service_url: the reference URL for obtaining JWT tokens
+                :param logger: optional logger
+                :return: the corresponding item in storage, or *None* if not found
+                """
         # initialize the return variable
         result: dict[str, dict[str, Any]] | None = None
 
@@ -333,7 +329,7 @@ def jwt_request_token(errors: list[str],
     :param errors: incidental errors
     :param service_url: the reference URL for obtaining JWT tokens
     :param claims: the JWT claimset, as expected by the issuing server
-    :param timeout: request timeout, in seconds (defaults to 'None')
+    :param timeout: request timeout, in seconds (defaults to *None*)
     :param logger: optional logger
     """
     # initialize the return variable

pypomes_jwt/jwt_pomes.py

@@ -16,7 +16,7 @@ JWT_REFRESH_MAX_AGE: Final[int] = env_get_int(key=f"{APP_PREFIX}_JWT_REFRESH_MAX
                                               def_value=43200)
 JWT_HS_SECRET_KEY: Final[bytes] = env_get_bytes(key=f"{APP_PREFIX}_JWT_HS_SECRET_KEY",
                                                 def_value=token_bytes(32))
-# must point to 'jwt_service()' below
+# must invoke 'jwt_service()' below
 JWT_ENDPOINT_URL: Final[str] = env_get_str(key=f"{APP_PREFIX}_JWT_ENDPOINT_URL")
 
 __priv_key: bytes = env_get_bytes(key=f"{APP_PREFIX}_JWT_RSA_PRIVATE_KEY")
@@ -58,14 +58,10 @@ def jwt_set_service_access(service_url: str,
                            private_key: bytes = JWT_RSA_PRIVATE_KEY,
                            public_key: bytes = JWT_RSA_PUBLIC_KEY,
                            request_timeout: int = None,
-                           local_provider: bool = False,
                            logger: Logger = None) -> None:
     """
     Set the data needed to obtain JWT tokens from *service_url*.
 
-    Protocol indication in *service_url* (typically *http:* or *https:*), is disregarded, to guarantee
-    that processing herein will not be affected by in-transit protocol changes.
-
     :param service_url: the reference URL
     :param claims: the JWT claimset, as key-value pairs
     :param algorithm: the authentication type
@@ -75,16 +71,14 @@ def jwt_set_service_access(service_url: str,
     :param private_key: private key for RSA authentication
     :param public_key: public key for RSA authentication
     :param request_timeout: timeout for the requests to the service URL
-    :param local_provider: whether 'service_url' is a local endpoint
     :param logger: optional logger
     """
     # extract the extra claims
     pos: int = service_url.find("?")
     if pos > 0:
-        if not local_provider:
-            params: list[str] = service_url[pos+1:].split(sep="&")
-            for param in params:
-                claims[param.split("=")[0]] = param.split("=")[1]
+        params: list[str] = service_url[pos+1:].split(sep="&")
+        for param in params:
+            claims[param.split("=")[0]] = param.split("=")[1]
         service_url = service_url[:pos]
 
     # register the JWT service
@@ -97,7 +91,6 @@ def jwt_set_service_access(service_url: str,
                                private_key=private_key,
                                public_key=public_key,
                                request_timeout=request_timeout,
-                               local_provider=local_provider,
                                logger=logger)
 
 
@@ -231,10 +224,9 @@ def jwt_verify_request(request: Request,
     return result
 
 
-# @flask_app.route(rule="/jwt-service",
-#                  methods=["POST"])
 def jwt_service(service_url: str = None,
-                service_params: dict[str, Any] = None) -> Response:
+                service_params: dict[str, Any] = None,
+                logger: Logger = None) -> Response:
     """
     Entry point for obtaining JWT tokens.
 
@@ -254,7 +246,8 @@ def jwt_service(service_url: str = None,
     }
 
     :param service_url: the JWT reference URL, alternatively passed in JSON
-    :param service_params: the optional JSON containing the request parameters (defaults to body's JSON)
+    :param service_params: the optional JSON containing the request parameters (defaults to JSON in body)
+    :param logger: optional logger
     :return: the requested JWT token, along with its duration.
     """
     # declare the return variable
@@ -272,7 +265,8 @@ def jwt_service(service_url: str = None,
     if not service_url:
         service_url = params.get("service-url")
     if service_url:
-        item_data: dict[str, dict[str, Any]] = __jwt_data.retrieve_access_data(service_url=service_url)
+        item_data: dict[str, dict[str, Any]] = __jwt_data.retrieve_access_data(service_url=service_url,
+                                                                               logger=logger)
         if item_data:
             valid = True
             custom_claims: dict[str, Any] = item_data.get("custom-claims")
@@ -284,9 +278,13 @@ def jwt_service(service_url: str = None,
     # obtain the token data
     if valid:
         try:
-            token_data: dict[str, Any] = __jwt_data.get_token_data(service_url=service_url)
+            token_data: dict[str, Any] = __jwt_data.get_token_data(service_url=service_url,
+                                                                   logger=logger)
             result = jsonify(token_data)
         except Exception as e:
+            # validation failed
+            if logger:
+                logger.error(msg=str(e))
             result = Response(response=str(e),
                               status=401)
     else:

{pypomes_jwt-0.5.5.dist-info → pypomes_jwt-0.5.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypomes_jwt
-Version: 0.5.5
+Version: 0.5.7
 Summary: A collection of Python pomes, penyeach (JWT module)
 Project-URL: Homepage, https://github.com/TheWiseCoder/PyPomes-JWT
 Project-URL: Bug Tracker, https://github.com/TheWiseCoder/PyPomes-JWT/issues
@@ -11,4 +11,5 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.12
 Requires-Dist: pyjwt>=2.10.1
-Requires-Dist: pypomes-core>=1.6.6
+Requires-Dist: pyopenssl>=25.0.0
+Requires-Dist: pypomes-core>=1.7.1

pypomes_jwt-0.5.7.dist-info/RECORD

@@ -0,0 +1,7 @@
+pypomes_jwt/__init__.py,sha256=1IyBb94cZjkXMibHrH_vh043b06QFh5UQ6HTYSDau28,978
+pypomes_jwt/jwt_data.py,sha256=5W8HjdX5lVHvDkaDmOEARgwmp7GFPCX-c_iYjB6eUrQ,17397
+pypomes_jwt/jwt_pomes.py,sha256=sSYfgrh3Mnz3bddTjCvA-_FZWAaeqiHA9yMKkoPVO7M,11255
+pypomes_jwt-0.5.7.dist-info/METADATA,sha256=859iRwQR97JIEQ85PGQOieETPdcHOSUcr5hDhNX34HM,596
+pypomes_jwt-0.5.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pypomes_jwt-0.5.7.dist-info/licenses/LICENSE,sha256=NdakochSXm_H_-DSL_x2JlRCkYikj3snYYvTwgR5d_c,1086
+pypomes_jwt-0.5.7.dist-info/RECORD,,

pypomes_jwt-0.5.5.dist-info/RECORD

@@ -1,7 +0,0 @@
-pypomes_jwt/__init__.py,sha256=1IyBb94cZjkXMibHrH_vh043b06QFh5UQ6HTYSDau28,978
-pypomes_jwt/jwt_data.py,sha256=dIRkXvEfM0aWXqJVeeeeGVLH2G5qGnhrpVygCoKj7ws,17602
-pypomes_jwt/jwt_pomes.py,sha256=tKZd3eVMNsNNSJyQv0401JCwq_CPbwv8LxCnwiBBltM,11404
-pypomes_jwt-0.5.5.dist-info/METADATA,sha256=afC2ceWYURWZtUNTzUkCgsL3gUdjBUbHdlKBAj79OVA,563
-pypomes_jwt-0.5.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pypomes_jwt-0.5.5.dist-info/licenses/LICENSE,sha256=NdakochSXm_H_-DSL_x2JlRCkYikj3snYYvTwgR5d_c,1086
-pypomes_jwt-0.5.5.dist-info/RECORD,,