pypomes-jwt 1.0.4__tar.gz → 1.4.1__tar.gz

{pypomes_jwt-1.0.4 → pypomes_jwt-1.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypomes_jwt
-Version: 1.0.4
+Version: 1.4.1
 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
@@ -10,7 +10,9 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.12
-Requires-Dist: cryptography>=44.0.2
+Requires-Dist: cryptography>=46.0.3
+Requires-Dist: flask>=3.1.2
 Requires-Dist: pyjwt>=2.10.1
-Requires-Dist: pypomes-core>=1.8.7
-Requires-Dist: pypomes-db>=2.0.0
+Requires-Dist: pypomes-core>=2.8.6
+Requires-Dist: pypomes-crypto>=0.4.9
+Requires-Dist: pypomes-db>=2.8.1

{pypomes_jwt-1.0.4 → pypomes_jwt-1.4.1}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pypomes_jwt"
-version = "1.0.4"
+version = "1.4.1"
 authors = [
   { name="GT Nunes", email="wisecoder01@gmail.com" }
 ]
@@ -19,10 +19,12 @@ classifiers = [
     "Operating System :: OS Independent"
 ]
 dependencies = [
+    "cryptography>=46.0.3",
+    "Flask>=3.1.2",
     "PyJWT>=2.10.1",
-    "cryptography>=44.0.2",
-    "pypomes_core>=1.8.7",
-    "pypomes_db>=2.0.0"
+    "pypomes_core>=2.8.6",
+    "pypomes_crypto>=0.4.9",
+    "pypomes_db>=2.8.1"
 ]
 
 [project.urls]

pypomes_jwt-1.4.1/src/pypomes_jwt/__init__.py

@@ -0,0 +1,23 @@
+from .jwt_config import (
+    JwtConfig, JwtDbConfig, JwtAlgorithm
+)
+from .jwt_pomes import (
+    jwt_needed, jwt_verify_request,
+    jwt_assert_account, jwt_set_account, jwt_remove_account,
+    jwt_issue_token, jwt_issue_tokens, jwt_refresh_tokens,
+    jwt_validate_token, jwt_revoke_token
+)
+
+__all__ = [
+    # jwt_config
+    "JwtConfig", "JwtDbConfig", "JwtAlgorithm",
+    # jwt_pomes
+    "jwt_needed", "jwt_verify_request",
+    "jwt_assert_account", "jwt_set_account", "jwt_remove_account",
+    "jwt_issue_token", "jwt_issue_tokens", "jwt_refresh_tokens",
+    "jwt_validate_token", "jwt_revoke_token"
+]
+
+from importlib.metadata import version
+__version__ = version("pypomes_jwt")
+__version_info__ = tuple(int(i) for i in __version__.split(".") if i.isdigit())

pypomes_jwt-1.4.1/src/pypomes_jwt/jwt_config.py

@@ -0,0 +1,87 @@
+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, StrEnum
+from pypomes_core import (
+    APP_PREFIX,
+    env_get_str, env_get_bytes, env_get_int, env_get_enum
+)
+from secrets import token_bytes
+
+
+class JwtAlgorithm(StrEnum):
+    """
+    Supported decoding algorithms.
+    """
+    HS256 = "HS256"
+    HS512 = "HS512"
+    RS256 = "RS256"
+    RS512 = "RS512"
+
+
+# recommended: allow the encode and decode keys to be generated anew when app starts
+_encoding_key: bytes = env_get_bytes(key=f"{APP_PREFIX}_JWT_ENCODING_KEY",
+                                     encoding="base64")
+_decoding_key: bytes = env_get_bytes(key=f"{APP_PREFIX}_JWT_DECODING_KEY")
+# default algorithm may cause encode and decode keys to be overriden
+_default_algorithm: JwtAlgorithm = env_get_enum(key=f"{APP_PREFIX}_JWT_DEFAULT_ALGORITHM",
+                                                enum_class=JwtAlgorithm,
+                                                def_value=JwtAlgorithm.RS256)
+if _default_algorithm in [JwtAlgorithm.HS256, JwtAlgorithm.HS512]:
+    if not _encoding_key:
+        _encoding_key = token_bytes(nbytes=32)
+    _decoding_key = _encoding_key
+elif not _encoding_key or not _decoding_key:
+    __priv_key: RSAPrivateKey = rsa.generate_private_key(public_exponent=65537,
+                                                         key_size=2048
+                                                         if _default_algorithm == JwtAlgorithm.RS256 else 4096)
+    _encoding_key = __priv_key.private_bytes(encoding=serialization.Encoding.PEM,
+                                             format=serialization.PrivateFormat.PKCS8,
+                                             encryption_algorithm=serialization.NoEncryption())
+    __pub_key: RSAPublicKey = __priv_key.public_key()
+    _decoding_key = __pub_key.public_bytes(encoding=serialization.Encoding.PEM,
+                                           format=serialization.PublicFormat.SubjectPublicKeyInfo)
+
+
+# HAZARD: instances uses must be '.value' qualified, as this is not a subclass of either 'StrEnum' or 'IntEnum'
+class JwtConfig(Enum):
+    """
+    Parameters for JWT token issuance.
+    """
+    # recommended: between 5 min and 1 hour (set to 5 min)
+    ACCESS_MAX_AGE: int = env_get_int(key=f"{APP_PREFIX}_JWT_ACCESS_MAX_AGE",
+                                      def_value=300)
+    ACCOUNT_LIMIT: int = env_get_int(key=f"{APP_PREFIX}_JWT_ACCOUNT_LIMIT",
+                                     def_value=5)
+    DEFAULT_ALGORITHM: JwtAlgorithm = _default_algorithm
+    ENCODING_KEY: bytes = _encoding_key
+    DECODING_KEY: bytes = _decoding_key
+    # recommended: at least 2 hours (set to 24 hours)
+    REFRESH_MAX_AGE: int = env_get_int(key=f"{APP_PREFIX}_JWT_REFRESH_MAX_AGE",
+                                       def_value=86400)
+
+
+del _decoding_key
+del _encoding_key
+del _default_algorithm
+
+
+# database access is not be necessary, if only handling externally provided JWT tokens
+class JwtDbConfig(StrEnum):
+    """
+    Parameters for JWT database connection.
+    """
+    ENGINE = env_get_str(key=f"{APP_PREFIX}_JWT_DB_ENGINE",
+                         def_value="")
+    TABLE = env_get_str(key=f"{APP_PREFIX}_JWT_DB_TABLE",
+                        def_value="")
+    COL_ACCOUNT = env_get_str(key=f"{APP_PREFIX}_JWT_DB_COL_ACCOUNT",
+                              def_value="")
+    COL_ALGORITHM = env_get_str(key=f"{APP_PREFIX}_JWT_DB_COL_ALGORITHM",
+                                def_value="")
+    COL_DECODER = env_get_str(key=f"{APP_PREFIX}_JWT_DB_COL_DECODER",
+                              def_value="")
+    COL_KID = env_get_str(key=f"{APP_PREFIX}_JWT_DB_COL_KID",
+                          def_value="")
+    COL_TOKEN = env_get_str(key=f"{APP_PREFIX}_JWT_DB_COL_TOKEN",
+                            def_value="")