sanic-security 1.12.4__tar.gz → 1.12.5__tar.gz

{sanic_security-1.12.4/sanic_security.egg-info → sanic_security-1.12.5}/PKG-INFO

@@ -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 → sanic_security-1.12.5}/README.md

@@ -217,7 +217,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
 
@@ -290,19 +290,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 → sanic_security-1.12.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sanic-security"
-version = "1.12.4"
+version = "1.12.5"
 requires-python = ">=3.8"
 dependencies = [
     "tortoise-orm>=0.17.0",

{sanic_security-1.12.4 → sanic_security-1.12.5}/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-1.12.4 → sanic_security-1.12.5}/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-1.12.4 → sanic_security-1.12.5}/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-1.12.4 → sanic_security-1.12.5}/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 → sanic_security-1.12.5/sanic_security.egg-info}/PKG-INFO

@@ -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