sanic-security 1.12.4__py3-none-any.whl → 1.12.5__py3-none-any.whl

sanic_security/authentication.py

@@ -249,6 +249,22 @@ def requires_authentication(arg=None):
     return decorator(arg) if callable(arg) else decorator
 
 
+def attach_refresh_encoder(app: Sanic):
+    """
+    Automatically encodes the new/refreshed session returned during authentication when client's current session expires.
+
+    Args:
+        app: (Sanic): The main Sanic application instance.
+    """
+
+    @app.on_response
+    async def refresh_encoder_middleware(request, response):
+        if hasattr(request.ctx, "authentication_session"):
+            authentication_session = request.ctx.authentication_session
+            if authentication_session.is_refresh:
+                authentication_session.encode(response)
+
+
 def create_initial_admin_account(app: Sanic) -> None:
     """
     Creates the initial admin account that can be logged into and has complete authoritative access.

sanic_security/exceptions.py

@@ -130,7 +130,7 @@ class DeactivatedError(SessionError):
 
     def __init__(
         self,
-        message: str = "Session has been deactivated or refreshed.",
+        message: str = "Session has been deactivated.",
         code: int = 401,
     ):
         super().__init__(message, code)

sanic_security/test/server.py

@@ -12,6 +12,7 @@ from sanic_security.authentication import (
     logout,
     create_initial_admin_account,
     fulfill_second_factor,
+    attach_refresh_encoder,
 )
 from sanic_security.authorization import (
     assign_role,
@@ -173,14 +174,6 @@ async def on_authenticate(request):
     return response
 
 
-@app.on_response
-async def authentication_refresh_encoder(request, response):
-    if hasattr(request.ctx, "authentication_session"):
-        authentication_session = request.ctx.authentication_session
-        if authentication_session.is_refresh:
-            authentication_session.encode(response)
-
-
 @app.post("api/test/auth/expire")
 @requires_authentication
 async def on_authentication_expire(request):
@@ -351,6 +344,7 @@ register_tortoise(
     modules={"models": ["sanic_security.models"]},
     generate_schemas=True,
 )
+attach_refresh_encoder(app)
 create_initial_admin_account(app)
 if __name__ == "__main__":
     app.run(host="127.0.0.1", port=8000, workers=1, debug=True)

sanic_security/test/tests.py

@@ -576,6 +576,4 @@ class MiscTest(TestCase):
         authenticate_response = self.client.post(
             "http://127.0.0.1:8000/api/test/auth",
         )  # Since session refresh handling is complete, it will be returned as a regular session now.
-        assert (
-            json.loads(authenticate_response.text)["data"]["refresh"] is False
-        ), authenticate_response.text
+        assert authenticate_response.status_code == 200, authenticate_response.text

{sanic_security-1.12.4.dist-info → sanic_security-1.12.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sanic-security
-Version: 1.12.4
+Version: 1.12.5
 Summary: An async security library for the Sanic framework.
 Author-email: Aidan Stewart <na.stewart365@gmail.com>
 Project-URL: Documentation, https://security.na-stewart.com/
@@ -248,7 +248,7 @@ async def on_login(request):
     return response
 ```
 
-If this isn't desired, you can pass an account and password attempt directly into the login instead.
+If this isn't desired, you can pass an account and password attempt directly into the login method instead.
 
 * Fulfill Second Factor
 
@@ -321,19 +321,15 @@ async def on_authenticate(request):
     return response
 ```
 
-* Authentication Middleware
+* Refresh Encoder
 
-New/Refreshed session returned if client's session expired during authentication, requires encoding.
-
-Middleware is recommended to automatically encode the refreshed session.
+A new/refreshed session is returned during authentication if the client's session expired during authentication and
+requires encoding. Rather than doing so manually, it can be done automatically via middleware.
 
 ```python
-@app.on_response
-async def authentication_refresh_encoder(request, response):
-    if hasattr(request.ctx, "authentication_session"):
-        authentication_session = request.ctx.authentication_session
-        if authentication_session.is_refresh:
-            authentication_session.encode(response)
+attach_refresh_encoder(app)
+if __name__ == "__main__":
+    app.run(host="127.0.0.1", port=8000)
 ```
 
 ## Captcha

{sanic_security-1.12.4.dist-info → sanic_security-1.12.5.dist-info}/RECORD

@@ -1,16 +1,16 @@
 sanic_security/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sanic_security/authentication.py,sha256=j_V-XEx8op5fYcszIE6PoeBDId0OJA8KlJW7FDXKr6s,12012
+sanic_security/authentication.py,sha256=obMKNnJXleeBGXqmsm1y5jFNI-FrW9krdO5SD6yOstE,12598
 sanic_security/authorization.py,sha256=aQztMiZG9LDctr_C6QEzO5qScwbxpiLk96XVxwdCChM,6921
 sanic_security/configuration.py,sha256=p44nTSrBQQSJZYN6qJEod_Ettf90rRNlmPxmNzxqQ9A,5514
-sanic_security/exceptions.py,sha256=8c3xoQSiIKfSiOQOtw49RG8Qdlc3vZDzqjrEnPad4Ds,5411
+sanic_security/exceptions.py,sha256=MTPF4tm_68Nmf_z06RHH_6DTiC_CNiLER1jzEoW1dFk,5398
 sanic_security/models.py,sha256=nj5iYHzPZzdLs5dc3j6kdeScSk1SASizfK58Sa5YN8E,22527
 sanic_security/utils.py,sha256=Zgde7W69ixwv_H8eTs7indO5_U2Jvq62YUpG6ipN768,2629
 sanic_security/verification.py,sha256=vrxYborEOBKEirOHczul9WYub5j6T2ldXE1gsoA8iyY,7503
 sanic_security/test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sanic_security/test/server.py,sha256=G5q7mzTUxOpKlhbzNbzTZYSWd6g8a0toOFX9qTA_nVg,12631
-sanic_security/test/tests.py,sha256=Hg40wlZfC-CDZX6lIjeT6uXy-3BJMc4ChJsnCRCBIu8,22459
-sanic_security-1.12.4.dist-info/LICENSE,sha256=sXlJs9_mG-dCkPfWsDnuzydJWagS82E2gYtkVH9enHA,1100
-sanic_security-1.12.4.dist-info/METADATA,sha256=jBOYc-2TvLy6eFKw9FpiFoXe4toejAPeiw7eVlm0Gi0,23594
-sanic_security-1.12.4.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
-sanic_security-1.12.4.dist-info/top_level.txt,sha256=ZybkhHXSjfzhmv8XeqLvnNmLmv21Z0oPX6Ep4DJN8b0,15
-sanic_security-1.12.4.dist-info/RECORD,,
+sanic_security/test/server.py,sha256=pwqsDS81joMdxIynivaNPCCMamv9qzAjknfZ01ZxQHc,12380
+sanic_security/test/tests.py,sha256=6TUp5GVYIR27qCzwIw2qt7DvW7ohxj-seYpnpeMbuno,22407
+sanic_security-1.12.5.dist-info/LICENSE,sha256=sXlJs9_mG-dCkPfWsDnuzydJWagS82E2gYtkVH9enHA,1100
+sanic_security-1.12.5.dist-info/METADATA,sha256=n8CLfkmnR8lcAn9ZO8tMQDC0H_TjWT1U0ITo3JCkWHs,23420
+sanic_security-1.12.5.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
+sanic_security-1.12.5.dist-info/top_level.txt,sha256=ZybkhHXSjfzhmv8XeqLvnNmLmv21Z0oPX6Ep4DJN8b0,15
+sanic_security-1.12.5.dist-info/RECORD,,