pypomes-jwt 0.5.4__tar.gz → 0.5.6__tar.gz

{pypomes_jwt-0.5.4 → pypomes_jwt-0.5.6}/PKG-INFO

@@ -1,16 +1,15 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: pypomes_jwt
-Version: 0.5.4
+Version: 0.5.6
 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
 Author-email: GT Nunes <wisecoder01@gmail.com>
+License-File: LICENSE
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.12
-Requires-Dist: pip>=24.3.1
-Requires-Dist: pyjwt>=2.10.0
-Requires-Dist: pypomes-core>=1.6.2
-Requires-Dist: setuptools>=75.5.0
-Requires-Dist: wheel>=0.45.0
+Requires-Dist: pyjwt>=2.10.1
+Requires-Dist: pyopenssl>=25.0.0
+Requires-Dist: pypomes-core>=1.7.1

{pypomes_jwt-0.5.4 → pypomes_jwt-0.5.6}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pypomes_jwt"
-version = "0.5.4"
+version = "0.5.6"
 authors = [
   { name="GT Nunes", email="wisecoder01@gmail.com" }
 ]
@@ -19,12 +19,9 @@ classifiers = [
     "Operating System :: OS Independent"
 ]
 dependencies = [
-    "pip>=24.3.1",
-    "PyJWT>=2.10.0",
- #  "PyOpenSSL>=24.2.1", - pending fixing runtime error in jwt_data.py
-    "pypomes_core>=1.6.2",
-    "setuptools>=75.5.0",
-    "wheel>=0.45.0"
+    "PyJWT>=2.10.1",
+    "PyOpenSSL>=25.0.0",
+    "pypomes_core>=1.7.1"
 ]
 
 [project.urls]

{pypomes_jwt-0.5.4 → pypomes_jwt-0.5.6}/src/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-0.5.4 → pypomes_jwt-0.5.6}/src/pypomes_jwt/jwt_pomes.py

@@ -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)
 
 
@@ -233,11 +226,12 @@ def jwt_verify_request(request: Request,
 
 # @flask_app.route(rule="/jwt-service",
 #                  methods=["POST"])
-def jwt_service(service_url: str = None) -> Response:
+def jwt_service(service_url: str = None,
+                service_params: dict[str, Any] = None) -> Response:
     """
     Entry point for obtaining JWT tokens.
 
-    In order to be serviced, the invoker must send, in the body of the request,
+    In order to be serviced, the invoker must send, as parameter *service_params* or in the body of the request,
     a JSON containing:
     {
       "service-url": "<url>",                               - the JWT reference URL (if not as parameter)
@@ -252,7 +246,8 @@ def jwt_service(service_url: str = None) -> Response:
       "expires_in": <seconds-to-expiration>
     }
 
-    :param service_url: the JWT reference URL, alternatively passed in the body's JSON
+    :param service_url: the JWT reference URL, alternatively passed in JSON
+    :param service_params: the optional JSON containing the request parameters (defaults to JSON in body)
     :return: the requested JWT token, along with its duration.
     """
     # declare the return variable
@@ -260,9 +255,10 @@ def jwt_service(service_url: str = None) -> Response:
 
     # obtain the parameters
     # noinspection PyUnusedLocal
-    params: dict[str, Any] = {}
-    with contextlib.suppress(Exception):
-        params = request.get_json()
+    params: dict[str, Any] = service_params or {}
+    if not params:
+        with contextlib.suppress(Exception):
+            params = request.get_json()
 
     # validate the parameters
     valid: bool = False