pypomes-jwt 1.1.5__py3-none-any.whl → 1.1.6__py3-none-any.whl

pypomes_jwt/jwt_pomes.py

@@ -78,7 +78,7 @@ def jwt_set_account(account_id: str,
                     claims: dict[str, Any],
                     access_max_age: int = JwtConfig.ACCESS_MAX_AGE.value,
                     refresh_max_age: int = JwtConfig.REFRESH_MAX_AGE.value,
-                    grace_interval: int = None,
+                    lead_interval: int = None,
                     logger: Logger = None) -> None:
     """
     Establish the data needed to obtain JWT tokens for *account_id*.
@@ -92,7 +92,7 @@ def jwt_set_account(account_id: str,
     :param claims: the JWT claimset, as key-value pairs
     :param access_max_age: access token duration, in seconds
     :param refresh_max_age: refresh token duration, in seconds
-    :param grace_interval: optional time to wait for token to be valid, in seconds
+    :param lead_interval: optional time to wait for token to be valid, in seconds
     :param logger: optional logger
     """
     if logger:
@@ -103,7 +103,7 @@ def jwt_set_account(account_id: str,
                                claims=claims,
                                access_max_age=access_max_age,
                                refresh_max_age=max(refresh_max_age, access_max_age + 300),
-                               grace_interval=grace_interval,
+                               lead_interval=lead_interval,
                                logger=logger)
 
 
@@ -302,7 +302,7 @@ def jwt_issue_token(errors: list[str] | None,
                     account_id: str,
                     nature: str,
                     duration: int,
-                    grace_interval: int = None,
+                    lead_interval: int = None,
                     claims: dict[str, Any] = None,
                     logger: Logger = None) -> str:
     """
@@ -318,7 +318,7 @@ def jwt_issue_token(errors: list[str] | None,
     :param nature: the token's nature, must be a single letter in the range *[B-Z]*, less *R*
     :param duration: the number of seconds for the token to remain valid (at least 60 seconds)
     :param claims: optional token's claims
-    :param grace_interval: optional interval for the token to become active (in seconds)
+    :param lead_interval: optional interval for the token to become active (in seconds)
     :param logger: optional logger
     :return: the JWT token data, or *None* if error
     """
@@ -334,7 +334,7 @@ def jwt_issue_token(errors: list[str] | None,
                                             nature=nature,
                                             duration=duration,
                                             claims=claims,
-                                            grace_interval=grace_interval,
+                                            lead_interval=lead_interval,
                                             logger=logger)
         if logger:
             logger.debug(msg=f"Token is '{result}'")

pypomes_jwt/jwt_registry.py

@@ -26,7 +26,7 @@ class JwtRegistry:
          <account-id>: {
            "access-max-age": <int>,         # defaults to JWT_ACCESS_MAX_AGE (in seconds)
            "refresh-max-age": <int>,        # defaults to JWT_REFRESH_MAX_AGE (in seconds)
-           "grace-interval": <int>,         # time to wait for token to be valid, in seconds
+           "lead-interval": <int>,          # time to wait for token to be valid, in seconds
            "claims": {
              "iss": <string>,               # token'ss issuer
              "birthdate": <string>,         # subject's birth date
@@ -35,9 +35,6 @@ class JwtRegistry:
              "name": <string>,              # subject's name
              "roles": <List[str]>,          # subject roles
              "nonce": <string>,             # used to associate a Client session with a token
-             # output, only
-             "valid-from": <string>,        # token's start (<YYYY-MM-DDThh:mm:ss+00:00>)
-             "valid-until": <string>,       # token's finish (<YYYY-MM-DDThh:mm:ss+00:00>)
              ...
            }
          },
@@ -63,8 +60,6 @@ class JwtRegistry:
 
     Account-related claims are optional claims, and convey information about the registered account they belong to.
     Alhough they can be freely specified, these are some of the most commonly used claims:
-       "valid-from": <string>   token's start (<YYYY-MM-DDThh:mm:ss+00:00>)
-       "valid-until": <string>  token's finish (<YYYY-MM-DDThh:mm:ss+00.00>)
        "birthdate": <string>    subject's birth date
        "email": <string>        subject's email
        "gender": <string>       subject's gender
@@ -92,7 +87,7 @@ class JwtRegistry:
                     claims: dict[str, Any],
                     access_max_age: int,
                     refresh_max_age: int,
-                    grace_interval: int | None,
+                    lead_interval: int | None,
                     logger: Logger = None) -> None:
         """
         Add to storage the parameters needed to produce and validate JWT tokens for *account_id*.
@@ -105,7 +100,7 @@ class JwtRegistry:
         :param claims: the JWT claimset, as key-value pairs
         :param access_max_age: access token duration, in seconds (at least 60 seconds)
         :param refresh_max_age: refresh token duration, in seconds (greater than *access_max_age*)
-        :param grace_interval: time to wait for token to be valid, in seconds
+        :param lead_interval: time to wait for token to be valid, in seconds
         :param logger: optional logger
         """
         # build and store the access data for the account
@@ -114,7 +109,7 @@ class JwtRegistry:
                 self.access_registry[account_id] = {
                     "access-max-age": access_max_age,
                     "refresh-max-age": refresh_max_age,
-                    "grace-interval": grace_interval,
+                    "lead-interval": lead_interval,
                     "claims": claims or {}
                 }
                 if logger:
@@ -155,7 +150,7 @@ class JwtRegistry:
                     account_id: str,
                     nature: str,
                     duration: int,
-                    grace_interval: int = None,
+                    lead_interval: int = None,
                     claims: dict[str, Any] = None,
                     logger: Logger = None) -> str:
         """
@@ -170,7 +165,7 @@ class JwtRegistry:
         :param nature: the token's nature, must be a single letter in the range *[B-Z]*, less *R*
         :param duration: the number of seconds for the token to remain valid (at least 60 seconds)
         :param claims: optional token's claims
-        :param grace_interval: optional interval for the token to become active (in seconds)
+        :param lead_interval: optional interval for the token to become active (in seconds)
         :param logger: optional logger
         :return: the JWT token
         :raises RuntimeError: invalid parameter
@@ -203,8 +198,8 @@ class JwtRegistry:
         current_claims["sub"] = account_id
         just_now: int = int(datetime.now(tz=timezone.utc).timestamp())
         current_claims["iat"] = just_now
-        if grace_interval:
-            current_claims["nbf"] = just_now + grace_interval
+        if lead_interval:
+            current_claims["nbf"] = just_now + lead_interval
         current_claims["exp"] = just_now + duration
 
         # may raise an exception
@@ -256,9 +251,9 @@ class JwtRegistry:
 
             just_now: int = int(datetime.now(tz=timezone.utc).timestamp())
             current_claims["iat"] = just_now
-            grace_interval = account_data.get("grace-interval")
-            if grace_interval:
-                current_claims["nbf"] = just_now + grace_interval
+            lead_interval = account_data.get("lead-interval")
+            if lead_interval:
+                current_claims["nbf"] = just_now + lead_interval
 
             # issue a candidate refresh token first, and persist it
             current_claims["exp"] = just_now + account_data.get("refresh-max-age")

{pypomes_jwt-1.1.5.dist-info → pypomes_jwt-1.1.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypomes_jwt
-Version: 1.1.5
+Version: 1.1.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

pypomes_jwt-1.1.6.dist-info/RECORD

@@ -0,0 +1,8 @@
+pypomes_jwt/__init__.py,sha256=NZzjWKnhjxNuoE32V6soKo9sG5ypmt25V0mBAh3rAIs,793
+pypomes_jwt/jwt_config.py,sha256=mtihd58_O00FuFXcNBKsabftG6UHu3Cj24i6cZXoskc,3096
+pypomes_jwt/jwt_pomes.py,sha256=5d7xd0mCRbBZ65k0pMNeiF_UaZu5sfAojZDEs_wOT8Y,23509
+pypomes_jwt/jwt_registry.py,sha256=Zfhv5bn53UcSPuPSHns4AVMv7izrzd75HPp5eId2dck,21993
+pypomes_jwt-1.1.6.dist-info/METADATA,sha256=eTbk1Zi0snGQA9NAmmOW_pS0LwTWC5QFPNAYbu2LGNg,632
+pypomes_jwt-1.1.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pypomes_jwt-1.1.6.dist-info/licenses/LICENSE,sha256=NdakochSXm_H_-DSL_x2JlRCkYikj3snYYvTwgR5d_c,1086
+pypomes_jwt-1.1.6.dist-info/RECORD,,

pypomes_jwt-1.1.5.dist-info/RECORD

@@ -1,8 +0,0 @@
-pypomes_jwt/__init__.py,sha256=NZzjWKnhjxNuoE32V6soKo9sG5ypmt25V0mBAh3rAIs,793
-pypomes_jwt/jwt_config.py,sha256=mtihd58_O00FuFXcNBKsabftG6UHu3Cj24i6cZXoskc,3096
-pypomes_jwt/jwt_pomes.py,sha256=5B5xYA6Z3zJvYwYTZoqD1sH1mraSwdYQVKEvVx2fCSY,23517
-pypomes_jwt/jwt_registry.py,sha256=gMnximiWagh7OkoXEM6msvdXdrXIqosolbyajTIbhTs,22372
-pypomes_jwt-1.1.5.dist-info/METADATA,sha256=tzzNQQ4bebsCN_N7qgDkuoI0D82IMKCnNsubQn_Vw_k,632
-pypomes_jwt-1.1.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pypomes_jwt-1.1.5.dist-info/licenses/LICENSE,sha256=NdakochSXm_H_-DSL_x2JlRCkYikj3snYYvTwgR5d_c,1086
-pypomes_jwt-1.1.5.dist-info/RECORD,,