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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypomes_jwt
-Version: 1.1.1
+Version: 1.1.3
 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.8
+Requires-Dist: pypomes-core>=1.9.9
 Requires-Dist: pypomes-db>=2.0.9

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

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

{pypomes_jwt-1.1.1 → pypomes_jwt-1.1.3}/src/pypomes_jwt/jwt_configuration.py

@@ -6,9 +6,8 @@ from pypomes_core import (
     APP_PREFIX,
     env_get_str, env_get_bytes, env_get_int
 )
-from pypomes_db import DbEngine, db_setup
+from pypomes_db import DbEngine
 from secrets import token_bytes
-from sys import stderr
 
 
 # recommended: allow the encode and decode keys to be generated anew when app starts
@@ -57,29 +56,9 @@ class JwtDbConfig(Enum):
     Parameters for JWT databse connection.
     """
     ENGINE: str = DbEngine(env_get_str(key=f"{APP_PREFIX}_JWT_DB_ENGINE"))
-    CLIENT: str = env_get_str(key=f"{APP_PREFIX}_JWT_DB_CLIENT")  # for Oracle, only
-    DRIVER: str = env_get_str(key=f"{APP_PREFIX}_JWT_DB_DRIVER")  # for SQLServer, only
-    NAME: str = env_get_str(key=f"{APP_PREFIX}_JWT_DB_NAME")
-    HOST: str = env_get_str(key=f"{APP_PREFIX}_JWT_DB_HOST")
-    PORT: int = env_get_int(key=f"{APP_PREFIX}_JWT_DB_PORT")
-    USER: str = env_get_str(key=f"{APP_PREFIX}_JWT_DB_USER")
-    PWD: str = env_get_str(key=f"{APP_PREFIX}_JWT_DB_PWD")
     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")
     COL_DECODER: str = env_get_str(key=f"{APP_PREFIX}_JWT_DB_COL_DECODER")
     COL_KID: str = env_get_str(key=f"{APP_PREFIX}_JWT_DB_COL_KID")
     COL_TOKEN: str = env_get_str(key=f"{APP_PREFIX}_JWT_DB_COL_TOKEN")
-
-
-# define and validate the database engine
-# noinspection PyTypeChecker
-if not db_setup(engine=DbEngine(JwtDbConfig.ENGINE),
-                db_name=JwtDbConfig.NAME,
-                db_user=JwtDbConfig.USER,
-                db_pwd=JwtDbConfig.PWD,
-                db_host=JwtDbConfig.HOST,
-                db_port=JwtDbConfig.PORT,
-                db_client=JwtDbConfig.CLIENT,
-                db_driver=JwtDbConfig.DRIVER):
-    stderr.write("Invalid database parameters\n")

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

@@ -75,8 +75,8 @@ def jwt_assert_account(account_id: str) -> bool:
 
 def jwt_set_account(account_id: str,
                     claims: dict[str, Any],
-                    access_max_age: int = JwtConfig.ACCESS_MAX_AGE,
-                    refresh_max_age: int = JwtConfig.REFRESH_MAX_AGE,
+                    access_max_age: int = JwtConfig.ACCESS_MAX_AGE.value,
+                    refresh_max_age: int = JwtConfig.REFRESH_MAX_AGE.value,
                     grace_interval: int = None,
                     logger: Logger = None) -> None:
     """
@@ -177,16 +177,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] = {
-                str(JwtDbConfig.COL_KID): int(token_kid[1:])
-            }
+            where_data: dict[str, Any] = {JwtDbConfig.COL_KID.value: int(token_kid[1:])}
             if account_id:
-                where_data[str(JwtDbConfig.COL_ACCOUNT)] = account_id
+                where_data[JwtDbConfig.COL_ACCOUNT.value] = account_id
             recs: list[tuple[str]] = db_select(errors=op_errors,
-                                               sel_stmt=f"SELECT {JwtDbConfig.COL_ALGORITHM}, "
-                                                        f"{JwtDbConfig.COL_DECODER} "
-                                                        f"FROM {JwtDbConfig.TABLE}",
+                                               sel_stmt=f"SELECT {JwtDbConfig.COL_ALGORITHM.value}, "
+                                                        f"{JwtDbConfig.COL_DECODER.value} "
+                                                        f"FROM {JwtDbConfig.TABLE.value}",
                                                where_data=where_data,
+                                               engine=JwtDbConfig.ENGINE.value,
                                                logger=logger)
             if recs:
                 token_alg = recs[0][0]
@@ -199,10 +198,8 @@ def jwt_validate_token(errors: list[str] | None,
                     logger.error(msg="Token not in the database")
                 op_errors.append("Invalid token")
         else:
-            # noinspection PyTypeChecker
-            token_alg = JwtConfig.DEFAULT_ALGORITHM
-            # noinspection PyTypeChecker
-            token_decoder = JwtConfig.DECODING_KEY
+            token_alg = JwtConfig.DEFAULT_ALGORITHM.value
+            token_decoder = JwtConfig.DECODING_KEY.value
 
         # validate the token
         if not op_errors:
@@ -282,11 +279,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}",
+                      delete_stmt=f"DELETE FROM {JwtDbConfig.TABLE.value}",
                       where_data={
-                          str(JwtDbConfig.COL_KID): int(token_kid[1:]),
-                          str(JwtDbConfig.COL_ACCOUNT): account_id
+                          JwtDbConfig.COL_KID.value: int(token_kid[1:]),
+                          JwtDbConfig.COL_ACCOUNT.value: account_id
                       },
+                      engine=JwtDbConfig.ENGINE.value,
                       logger=logger)
     if op_errors:
         if logger:
@@ -452,15 +450,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,
                                       logger=logger)
             if db_conn:
                 # delete current refresh token
                 db_delete(errors=op_errors,
-                          delete_stmt=f"DELETE FROM {JwtDbConfig.TABLE}",
+                          delete_stmt=f"DELETE FROM {JwtDbConfig.TABLE.value}",
                           where_data={
-                              str(JwtDbConfig.COL_KID): int(token_kid[1:]),
-                              str(JwtDbConfig.COL_ACCOUNT): account_id
+                              JwtDbConfig.COL_KID.value: int(token_kid[1:]),
+                              JwtDbConfig.COL_ACCOUNT.value: account_id
                           },
+                          engine=JwtDbConfig.ENGINE.value,
                           connection=db_conn,
                           committable=False,
                           logger=logger)

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

@@ -139,8 +139,9 @@ class JwtRegistry:
 
         # remove from database
         db_delete(errors=None,
-                  delete_stmt=f"DELETE FROM {JwtDbConfig.TABLE}",
-                  where_data={str(JwtDbConfig.COL_ACCOUNT): account_id},
+                  delete_stmt=f"DELETE FROM {JwtDbConfig.value}",
+                  where_data={JwtDbConfig.COL_ACCOUNT.value: account_id},
+                  engine=JwtDbConfig.ENGINE.value,
                   logger=logger)
         if logger:
             if account_data:
@@ -214,8 +215,8 @@ class JwtRegistry:
                                                                tz=timezone.utc).isoformat()
         # may raise an exception
         return jwt.encode(payload=current_claims,
-                          key=JwtConfig.ENCODING_KEY,
-                          algorithm=JwtConfig.DEFAULT_ALGORITHM,
+                          key=JwtConfig.ENCODING_KEY.value,
+                          algorithm=JwtConfig.DEFAULT_ALGORITHM.value,
                           headers={"kid": nature})
 
     def issue_tokens(self,
@@ -275,13 +276,14 @@ class JwtRegistry:
                                                                    tz=timezone.utc).isoformat()
             # may raise an exception
             refresh_token: str = jwt.encode(payload=current_claims,
-                                            key=JwtConfig.ENCODING_KEY,
-                                            algorithm=JwtConfig.DEFAULT_ALGORITHM,
+                                            key=JwtConfig.ENCODING_KEY.value,
+                                            algorithm=JwtConfig.DEFAULT_ALGORITHM.value,
                                             headers={"kid": "R0"})
 
             # make sure to have a database connection
             curr_conn: Any = db_conn or db_connect(errors=errors,
                                                    autocommit=False,
+                                                   engine=JwtDbConfig.ENGINE.value,
                                                    logger=logger)
             if curr_conn:
                 # persist the candidate token (may raise an exception)
@@ -291,14 +293,15 @@ class JwtRegistry:
                                                    logger=logger)
                 # issue the definitive refresh token
                 refresh_token = jwt.encode(payload=current_claims,
-                                           key=JwtConfig.ENCODING_KEY,
-                                           algorithm=JwtConfig.DEFAULT_ALGORITHM,
+                                           key=JwtConfig.ENCODING_KEY.value,
+                                           algorithm=JwtConfig.DEFAULT_ALGORITHM.value,
                                            headers={"kid": f"R{token_id}"})
                 # persist it
                 db_update(errors=errors,
-                          update_stmt=f"UPDATE {JwtDbConfig.TABLE}",
-                          update_data={str(JwtDbConfig.COL_TOKEN): refresh_token},
-                          where_data={str(JwtDbConfig.COL_KID): token_id},
+                          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,
                           connection=curr_conn,
                           committable=False,
                           logger=logger)
@@ -320,8 +323,8 @@ class JwtRegistry:
             current_claims["exp"] = just_now + account_data.get("access-max-age")
             # may raise an exception
             access_token: str = jwt.encode(payload=current_claims,
-                                           key=JwtConfig.ENCODING_KEY,
-                                           algorithm=JwtConfig.DEFAULT_ALGORITHM,
+                                           key=JwtConfig.ENCODING_KEY.value,
+                                           algorithm=JwtConfig.DEFAULT_ALGORITHM.value,
                                            headers={"kid": f"A{token_id}"})
             # return the token data
             return {
@@ -379,9 +382,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}, {JwtDbConfig.COL_TOKEN} "
-                           f"FROM {JwtDbConfig.TABLE}",
-                  where_data={str(JwtDbConfig.COL_ACCOUNT): account_id},
+                  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,
                   connection=db_conn,
                   committable=False,
                   logger=logger)
@@ -422,8 +426,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}",
-                  where_data={str(JwtDbConfig.COL_KID): expired},
+                  delete_stmt=f"DELETE FROM {JwtDbConfig.TABLE.value}",
+                  where_data={JwtDbConfig.COL_KID.value: expired},
+                  engine=JwtDbConfig.ENGINE.value,
                   connection=db_conn,
                   committable=False,
                   logger=logger)
@@ -433,12 +438,12 @@ def _jwt_persist_token(account_id: str,
             logger.debug(msg=f"{len(expired)} tokens of account "
                              f"'{account_id}' removed from storage")
 
-    # noinspection PyTypeChecker
-    if 0 < JwtConfig.ACCOUNT_LIMIT <= len(recs) - len(expired):
+    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}",
-                  where_data={str(JwtDbConfig.COL_KID): oldest_id},
+                  delete_stmt=f"DELETE FROM {JwtDbConfig.TABLE.value}",
+                  where_data={JwtDbConfig.COL_KID.value: oldest_id},
+                  engine=JwtDbConfig.ENGINE.value,
                   connection=db_conn,
                   committable=False,
                   logger=logger)
@@ -448,15 +453,15 @@ def _jwt_persist_token(account_id: str,
             logger.debug(msg="Oldest active token of account "
                              f"'{account_id}' removed from storage")
     # persist token
-    # noinspection PyTypeChecker
     db_insert(errors=errors,
-              insert_stmt=f"INSERT INTO {JwtDbConfig.TABLE}",
+              insert_stmt=f"INSERT INTO {JwtDbConfig.TABLE.value}",
               insert_data={
-                  str(JwtDbConfig.COL_ACCOUNT): account_id,
-                  str(JwtDbConfig.COL_TOKEN): jwt_token,
-                  str(JwtDbConfig.COL_ALGORITHM): JwtConfig.DEFAULT_ALGORITHM,
-                  str(JwtDbConfig.COL_DECODER): urlsafe_b64encode(s=JwtConfig.DECODING_KEY).decode()
+                  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()
               },
+              engine=JwtDbConfig.ENGINE.value,
               connection=db_conn,
               committable=False,
               logger=logger)
@@ -467,14 +472,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} NOT IN {existing_ids}"
+        where_clause = f"{JwtDbConfig.COL_KID.value} 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} "
-                                                 f"FROM {JwtDbConfig.TABLE}",
+                                        sel_stmt=f"SELECT {JwtDbConfig.COL_KID.value} "
+                                                 f"FROM {JwtDbConfig.TABLE.value}",
                                         where_clause=where_clause,
-                                        where_data={str(JwtDbConfig.COL_ACCOUNT): account_id},
+                                        where_data={JwtDbConfig.COL_ACCOUNT.value: account_id},
                                         require_count=1,
+                                        engine=JwtDbConfig.ENGINE.value,
                                         connection=db_conn,
                                         committable=False,
                                         logger=logger)