pypomes-jwt 1.1.3__tar.gz → 1.1.5__tar.gz

{pypomes_jwt-1.1.3 → pypomes_jwt-1.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypomes_jwt
-Version: 1.1.3
+Version: 1.1.5
 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
@@ -12,5 +12,5 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.12
 Requires-Dist: cryptography>=44.0.2
 Requires-Dist: pyjwt>=2.10.1
-Requires-Dist: pypomes-core>=1.9.9
-Requires-Dist: pypomes-db>=2.0.9
+Requires-Dist: pypomes-core>=2.0.4
+Requires-Dist: pypomes-db>=2.1.1

{pypomes_jwt-1.1.3 → pypomes_jwt-1.1.5}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pypomes_jwt"
-version = "1.1.3"
+version = "1.1.5"
 authors = [
   { name="GT Nunes", email="wisecoder01@gmail.com" }
 ]
@@ -21,8 +21,8 @@ classifiers = [
 dependencies = [
     "PyJWT>=2.10.1",
     "cryptography>=44.0.2",
-    "pypomes_core>=1.9.9",
-    "pypomes_db>=2.0.9"
+    "pypomes_core>=2.0.4",
+    "pypomes_db>=2.1.1"
 ]
 
 [project.urls]

{pypomes_jwt-1.1.3 → pypomes_jwt-1.1.5}/src/pypomes_jwt/__init__.py

@@ -1,4 +1,4 @@
-from .jwt_configuration import (
+from .jwt_config import (
     JwtConfig, JwtDbConfig
 )
 from .jwt_pomes import (

pypomes_jwt-1.1.3/src/pypomes_jwt/jwt_configuration.py → pypomes_jwt-1.1.5/src/pypomes_jwt/jwt_config.py

@@ -1,12 +1,11 @@
 from cryptography.hazmat.primitives import serialization
 from cryptography.hazmat.primitives.asymmetric import rsa
 from cryptography.hazmat.primitives.asymmetric.rsa import RSAPrivateKey, RSAPublicKey
-from enum import Enum
+from enum import Enum, StrEnum
 from pypomes_core import (
     APP_PREFIX,
     env_get_str, env_get_bytes, env_get_int
 )
-from pypomes_db import DbEngine
 from secrets import token_bytes
 
 
@@ -51,11 +50,11 @@ class JwtConfig(Enum):
                                        def_value=86400)
 
 
-class JwtDbConfig(Enum):
+class JwtDbConfig(StrEnum):
     """
     Parameters for JWT databse connection.
     """
-    ENGINE: str = DbEngine(env_get_str(key=f"{APP_PREFIX}_JWT_DB_ENGINE"))
+    ENGINE: str = env_get_str(key=f"{APP_PREFIX}_JWT_DB_ENGINE")
     TABLE: str = env_get_str(key=f"{APP_PREFIX}_JWT_DB_TABLE")
     COL_ACCOUNT: str = env_get_str(key=f"{APP_PREFIX}_JWT_DB_COL_ACCOUNT")
     COL_ALGORITHM: str = env_get_str(key=f"{APP_PREFIX}_JWT_DB_COL_ALGORITHM")

{pypomes_jwt-1.1.3 → pypomes_jwt-1.1.5}/src/pypomes_jwt/jwt_pomes.py

@@ -5,11 +5,12 @@ from flask import Request, Response, request
 from logging import Logger
 from pypomes_core import exc_format
 from pypomes_db import (
-    db_connect, db_commit, db_rollback, db_select, db_delete
+    DbEngine, db_connect, db_commit,
+    db_rollback, db_select, db_delete
 )
 from typing import Any
 
-from .jwt_configuration import JwtConfig, JwtDbConfig
+from .jwt_config import JwtConfig, JwtDbConfig
 from .jwt_registry import JwtRegistry
 
 # the JWT registry
@@ -177,15 +178,15 @@ def jwt_validate_token(errors: list[str] | None,
         elif token_kid and len(token_kid) > 1 and \
                 token_kid[0:1] in ["A", "R"] and token_kid[1:].isdigit():
             # token was likely issued locally
-            where_data: dict[str, Any] = {JwtDbConfig.COL_KID.value: int(token_kid[1:])}
+            where_data: dict[str, Any] = {JwtDbConfig.COL_KID: int(token_kid[1:])}
             if account_id:
-                where_data[JwtDbConfig.COL_ACCOUNT.value] = account_id
+                where_data[JwtDbConfig.COL_ACCOUNT] = account_id
             recs: list[tuple[str]] = db_select(errors=op_errors,
-                                               sel_stmt=f"SELECT {JwtDbConfig.COL_ALGORITHM.value}, "
-                                                        f"{JwtDbConfig.COL_DECODER.value} "
-                                                        f"FROM {JwtDbConfig.TABLE.value}",
+                                               sel_stmt=f"SELECT {JwtDbConfig.COL_ALGORITHM}, "
+                                                        f"{JwtDbConfig.COL_DECODER} "
+                                                        f"FROM {JwtDbConfig.TABLE}",
                                                where_data=where_data,
-                                               engine=JwtDbConfig.ENGINE.value,
+                                               engine=DbEngine(JwtDbConfig.ENGINE),
                                                logger=logger)
             if recs:
                 token_alg = recs[0][0]
@@ -279,12 +280,12 @@ def jwt_revoke_token(errors: list[str] | None,
             op_errors.append("Invalid token")
         else:
             db_delete(errors=op_errors,
-                      delete_stmt=f"DELETE FROM {JwtDbConfig.TABLE.value}",
+                      delete_stmt=f"DELETE FROM {JwtDbConfig.TABLE}",
                       where_data={
-                          JwtDbConfig.COL_KID.value: int(token_kid[1:]),
-                          JwtDbConfig.COL_ACCOUNT.value: account_id
+                          JwtDbConfig.COL_KID: int(token_kid[1:]),
+                          JwtDbConfig.COL_ACCOUNT: account_id
                       },
-                      engine=JwtDbConfig.ENGINE.value,
+                      engine=DbEngine(JwtDbConfig.ENGINE),
                       logger=logger)
     if op_errors:
         if logger:
@@ -450,17 +451,17 @@ def jwt_refresh_tokens(errors: list[str] | None,
             # start the database transaction
             db_conn: Any = db_connect(errors=op_errors,
                                       autocommit=False,
-                                      engine=JwtDbConfig.ENGINE.value,
+                                      engine=DbEngine(JwtDbConfig.ENGINE),
                                       logger=logger)
             if db_conn:
                 # delete current refresh token
                 db_delete(errors=op_errors,
-                          delete_stmt=f"DELETE FROM {JwtDbConfig.TABLE.value}",
+                          delete_stmt=f"DELETE FROM {JwtDbConfig.TABLE}",
                           where_data={
-                              JwtDbConfig.COL_KID.value: int(token_kid[1:]),
-                              JwtDbConfig.COL_ACCOUNT.value: account_id
+                              JwtDbConfig.COL_KID: int(token_kid[1:]),
+                              JwtDbConfig.COL_ACCOUNT: account_id
                           },
-                          engine=JwtDbConfig.ENGINE.value,
+                          engine=DbEngine(JwtDbConfig.ENGINE),
                           connection=db_conn,
                           committable=False,
                           logger=logger)
@@ -510,8 +511,8 @@ def jwt_get_claims(errors: list[str] | None,
     """
     Retrieve and return the claims set of a JWT *token*.
 
-    Any well-constructed JWT token may be provided in *token*, as this operation is not restricted to
-    locally issued tokens. Note that neither the token's signature nor its expiration is verified.
+    Any well-constructed JWT token may be provided in *token*, as this operation is not restricted
+    to locally issued tokens. Note that neither the token's signature nor its expiration is verified.
 
     Structure of the returned data, for locally issued tokens:
       {

{pypomes_jwt-1.1.3 → pypomes_jwt-1.1.5}/src/pypomes_jwt/jwt_registry.py

@@ -6,13 +6,13 @@ from datetime import datetime, timezone
 from logging import Logger
 from pypomes_core import str_random
 from pypomes_db import (
-    db_connect, db_commit, db_rollback,
+    DbEngine, db_connect, db_commit, db_rollback,
     db_select, db_insert, db_update, db_delete
 )
 from threading import Lock
 from typing import Any
 
-from .jwt_configuration import JwtConfig, JwtDbConfig
+from .jwt_config import JwtConfig, JwtDbConfig
 
 
 class JwtRegistry:
@@ -139,9 +139,9 @@ class JwtRegistry:
 
         # remove from database
         db_delete(errors=None,
-                  delete_stmt=f"DELETE FROM {JwtDbConfig.value}",
-                  where_data={JwtDbConfig.COL_ACCOUNT.value: account_id},
-                  engine=JwtDbConfig.ENGINE.value,
+                  delete_stmt=f"DELETE FROM {JwtDbConfig}",
+                  where_data={JwtDbConfig.COL_ACCOUNT: account_id},
+                  engine=DbEngine(JwtDbConfig.ENGINE),
                   logger=logger)
         if logger:
             if account_data:
@@ -205,14 +205,8 @@ class JwtRegistry:
         current_claims["iat"] = just_now
         if grace_interval:
             current_claims["nbf"] = just_now + grace_interval
-            current_claims["valid-from"] = datetime.fromtimestamp(timestamp=current_claims["nbf"],
-                                                                  tz=timezone.utc).isoformat()
-        else:
-            current_claims["valid-from"] = datetime.fromtimestamp(timestamp=current_claims["iat"],
-                                                                  tz=timezone.utc).isoformat()
         current_claims["exp"] = just_now + duration
-        current_claims["valid-until"] = datetime.fromtimestamp(timestamp=current_claims["exp"],
-                                                               tz=timezone.utc).isoformat()
+
         # may raise an exception
         return jwt.encode(payload=current_claims,
                           key=JwtConfig.ENCODING_KEY.value,
@@ -265,15 +259,9 @@ class JwtRegistry:
             grace_interval = account_data.get("grace-interval")
             if grace_interval:
                 current_claims["nbf"] = just_now + grace_interval
-                current_claims["valid-from"] = datetime.fromtimestamp(timestamp=current_claims["nbf"],
-                                                                      tz=timezone.utc).isoformat()
-            else:
-                current_claims["valid-from"] = datetime.fromtimestamp(timestamp=current_claims["iat"],
-                                                                      tz=timezone.utc).isoformat()
+
             # issue a candidate refresh token first, and persist it
             current_claims["exp"] = just_now + account_data.get("refresh-max-age")
-            current_claims["valid-until"] = datetime.fromtimestamp(timestamp=current_claims["exp"],
-                                                                   tz=timezone.utc).isoformat()
             # may raise an exception
             refresh_token: str = jwt.encode(payload=current_claims,
                                             key=JwtConfig.ENCODING_KEY.value,
@@ -283,7 +271,7 @@ class JwtRegistry:
             # make sure to have a database connection
             curr_conn: Any = db_conn or db_connect(errors=errors,
                                                    autocommit=False,
-                                                   engine=JwtDbConfig.ENGINE.value,
+                                                   engine=DbEngine(JwtDbConfig.ENGINE),
                                                    logger=logger)
             if curr_conn:
                 # persist the candidate token (may raise an exception)
@@ -298,10 +286,10 @@ class JwtRegistry:
                                            headers={"kid": f"R{token_id}"})
                 # persist it
                 db_update(errors=errors,
-                          update_stmt=f"UPDATE {JwtDbConfig.TABLE.value}",
-                          update_data={JwtDbConfig.COL_TOKEN.value: refresh_token},
-                          where_data={JwtDbConfig.COL_KID.value: token_id},
-                          engine=JwtDbConfig.ENGINE.value,
+                          update_stmt=f"UPDATE {JwtDbConfig.TABLE}",
+                          update_data={JwtDbConfig.COL_TOKEN: refresh_token},
+                          where_data={JwtDbConfig.COL_KID: token_id},
+                          engine=DbEngine(JwtDbConfig.ENGINE),
                           connection=curr_conn,
                           committable=False,
                           logger=logger)
@@ -382,10 +370,10 @@ def _jwt_persist_token(account_id: str,
     # noinspection PyTypeChecker
     recs: list[tuple[int, str, str, str]] = \
         db_select(errors=errors,
-                  sel_stmt=f"SELECT {JwtDbConfig.COL_KID.value}, {JwtDbConfig.COL_TOKEN.value} "
-                           f"FROM {JwtDbConfig.TABLE.value}",
-                  where_data={JwtDbConfig.COL_ACCOUNT.value: account_id},
-                  engine=JwtDbConfig.ENGINE.value,
+                  sel_stmt=f"SELECT {JwtDbConfig.COL_KID}, {JwtDbConfig.COL_TOKEN} "
+                           f"FROM {JwtDbConfig.TABLE}",
+                  where_data={JwtDbConfig.COL_ACCOUNT: account_id},
+                  engine=DbEngine(JwtDbConfig.ENGINE),
                   connection=db_conn,
                   committable=False,
                   logger=logger)
@@ -426,9 +414,9 @@ def _jwt_persist_token(account_id: str,
     # remove expired tokens from persistence
     if expired:
         db_delete(errors=errors,
-                  delete_stmt=f"DELETE FROM {JwtDbConfig.TABLE.value}",
-                  where_data={JwtDbConfig.COL_KID.value: expired},
-                  engine=JwtDbConfig.ENGINE.value,
+                  delete_stmt=f"DELETE FROM {JwtDbConfig.TABLE}",
+                  where_data={JwtDbConfig.COL_KID: expired},
+                  engine=DbEngine(JwtDbConfig.ENGINE),
                   connection=db_conn,
                   committable=False,
                   logger=logger)
@@ -441,9 +429,9 @@ def _jwt_persist_token(account_id: str,
     if 0 < JwtConfig.ACCOUNT_LIMIT.value <= len(recs) - len(expired):
         # delete the oldest token to make way for the new one
         db_delete(errors=errors,
-                  delete_stmt=f"DELETE FROM {JwtDbConfig.TABLE.value}",
-                  where_data={JwtDbConfig.COL_KID.value: oldest_id},
-                  engine=JwtDbConfig.ENGINE.value,
+                  delete_stmt=f"DELETE FROM {JwtDbConfig.TABLE}",
+                  where_data={JwtDbConfig.COL_KID: oldest_id},
+                  engine=DbEngine(JwtDbConfig.ENGINE),
                   connection=db_conn,
                   committable=False,
                   logger=logger)
@@ -454,14 +442,14 @@ def _jwt_persist_token(account_id: str,
                              f"'{account_id}' removed from storage")
     # persist token
     db_insert(errors=errors,
-              insert_stmt=f"INSERT INTO {JwtDbConfig.TABLE.value}",
+              insert_stmt=f"INSERT INTO {JwtDbConfig.TABLE}",
               insert_data={
-                  JwtDbConfig.COL_ACCOUNT.value: account_id,
-                  JwtDbConfig.COL_TOKEN.value: jwt_token,
-                  JwtDbConfig.COL_ALGORITHM.value: JwtConfig.DEFAULT_ALGORITHM.value,
-                  JwtDbConfig.COL_DECODER.value: urlsafe_b64encode(s=JwtConfig.DECODING_KEY.value).decode()
+                  JwtDbConfig.COL_ACCOUNT: account_id,
+                  JwtDbConfig.COL_TOKEN: jwt_token,
+                  JwtDbConfig.COL_ALGORITHM: JwtConfig.DEFAULT_ALGORITHM.value,
+                  JwtDbConfig.COL_DECODER: urlsafe_b64encode(s=JwtConfig.DECODING_KEY.value).decode()
               },
-              engine=JwtDbConfig.ENGINE.value,
+              engine=DbEngine(JwtDbConfig.ENGINE),
               connection=db_conn,
               committable=False,
               logger=logger)
@@ -472,15 +460,15 @@ def _jwt_persist_token(account_id: str,
     # HAZARD: JWT_DB_COL_TOKEN's column type might prevent it for being used in a WHERE clause
     where_clause: str | None = None
     if existing_ids:
-        where_clause = f"{JwtDbConfig.COL_KID.value} NOT IN {existing_ids}"
+        where_clause = f"{JwtDbConfig.COL_KID} NOT IN {existing_ids}"
         where_clause = where_clause.replace("[", "(", 1).replace("]", ")", 1)
     reply: list[tuple[int]] = db_select(errors=errors,
-                                        sel_stmt=f"SELECT {JwtDbConfig.COL_KID.value} "
-                                                 f"FROM {JwtDbConfig.TABLE.value}",
+                                        sel_stmt=f"SELECT {JwtDbConfig.COL_KID} "
+                                                 f"FROM {JwtDbConfig.TABLE}",
                                         where_clause=where_clause,
-                                        where_data={JwtDbConfig.COL_ACCOUNT.value: account_id},
+                                        where_data={JwtDbConfig.COL_ACCOUNT: account_id},
                                         require_count=1,
-                                        engine=JwtDbConfig.ENGINE.value,
+                                        engine=DbEngine(JwtDbConfig.ENGINE),
                                         connection=db_conn,
                                         committable=False,
                                         logger=logger)