sanic-security 1.17.1__py3-none-any.whl → 1.17.2__py3-none-any.whl

sanic_security/authentication.py

@@ -368,12 +368,12 @@ def initialize_security(app: Sanic, create_root: bool = True) -> None:
             await account.roles.add(role)
             logger.info("Initial admin account created.")
 
-        @app.on_response
-        async def session_middleware(request, response):
-            if hasattr(request.ctx, "session"):
-                if getattr(request.ctx.session, "is_refresh", False):
-                    request.ctx.session.encode(response)
-                elif not request.ctx.session.active:
-                    response.delete_cookie(
-                        f"{config.SESSION_PREFIX}_{request.ctx.session.__class__.__name__[:7].lower()}"
-                    )
+    @app.on_response
+    async def session_middleware(request, response):
+        if hasattr(request.ctx, "session"):
+            if getattr(request.ctx.session, "is_refresh", False):
+                request.ctx.session.encode(response)
+            elif not request.ctx.session.active:
+                response.delete_cookie(
+                    f"{config.SESSION_PREFIX}_{request.ctx.session.__class__.__name__[:7].lower()}"
+                )

sanic_security/test/server.py

@@ -218,14 +218,14 @@ async def on_captcha_attempt(request):
 @app.post("api/test/two-step/request")
 async def on_request_verification(request):
     """Request two-step verification with code in the response."""
-    two_step_session = await request_two_step_verification(request)
+    two_step_session = await request_two_step_verification(request, tag="forgot-pass")
     response = json("Verification request successful!", two_step_session.code)
     two_step_session.encode(response)
     return response
 
 
 @app.post("api/test/two-step")
-@requires_two_step_verification
+@requires_two_step_verification("forgot-pass")
 async def on_verification_attempt(request):
     """Attempt two-step verification challenge."""
     return json("Two step verification attempt successful!", request.ctx.session.json)

sanic_security/verification.py

@@ -135,12 +135,15 @@ def requires_two_step_verification(func=None, *, tag="2sv"):
         ChallengeError
         MaxedOutChallengeError
     """
+    if isinstance(func, str):
+        tag = func
+        func = None
 
-    def decorator(func):
-        @functools.wraps(func)
+    def decorator(inner_func):
+        @functools.wraps(inner_func)
         async def wrapper(request, *args, **kwargs):
             await two_step_verification(request, tag)
-            return await func(request, *args, **kwargs)
+            return await inner_func(request, *args, **kwargs)
 
         return wrapper
 

{sanic_security-1.17.1.dist-info → sanic_security-1.17.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sanic-security
-Version: 1.17.1
+Version: 1.17.2
 Summary: An async security library for the Sanic framework.
 Author-email: Aidan Stewart <me@na-stewart.com>
 Project-URL: Documentation, https://security.na-stewart.com/
@@ -70,8 +70,8 @@ Dynamic: license-file
 <!-- ABOUT THE PROJECT -->
 ## About The Project
 
-Sanic Security is an authentication, authorization, and verification library designed for use with the 
-[Sanic](https://github.com/huge-success/sanic) web app framework.
+Sanic Security is a suite of authentication, authorization, and verification tools designed for use with the 
+[Sanic](https://github.com/sanic-org/sanic) web app framework.
 
 * OAuth2 integration
 * Login, registration, and authentication with refresh mechanisms
@@ -463,7 +463,7 @@ Two-step verification should be integrated with other custom functionalities, su
 ```python
 @app.post("api/security/two-step/request")
 async def on_two_step_request(request):
-    two_step_session = await request_two_step_verification(request)  # Code = T2I58I
+    two_step_session = await request_two_step_verification(request, tag="forgot-pass")  # Code = T2I58I
     await email_code(
         two_step_session.bearer.email, two_step_session.code
     )  # Custom method for emailing verification code.
@@ -493,7 +493,7 @@ async def on_two_step_resend(request):
 ```python
 @app.post("api/security/two-step")
 async def on_two_step_verification(request):
-    two_step_session = await two_step_verification(request)
+    two_step_session = await two_step_verification(request, "forgot-pass")
     response = json("Two-step verification attempt successful!", two_step_session.json)
     return response
 ```
@@ -506,7 +506,7 @@ async def on_two_step_verification(request):
 
 ```python
 @app.post("api/security/two-step")
-@requires_two_step_verification
+@requires_two_step_verification("forgot-pass")
 async def on_two_step_verification(request):
     response = json(
         "Two-step verification attempt successful!", request.ctx.session.json
@@ -551,7 +551,7 @@ async def on_check_perms(request):
     return json("Account is authorized.", authentication_session.json)
 ```
 
-* Require Permissions (this method is not called directly and instead used as a decorator.)
+* Requires Permission (this method is not called directly and instead used as a decorator.)
 
 ```python
 @app.post("api/security/perms")
@@ -569,7 +569,7 @@ async def on_check_roles(request):
     return json("Account is authorized.", authentication_session.json)
 ```
 
-* Require Roles (This method is not called directly and instead used as a decorator)
+* Requires Role (This method is not called directly and instead used as a decorator)
 
 ```python
 @app.post("api/security/roles")

{sanic_security-1.17.1.dist-info → sanic_security-1.17.2.dist-info}/RECORD

@@ -1,17 +1,17 @@
 sanic_security/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sanic_security/authentication.py,sha256=kRcxddITe7FrfXCV_71DRGq8U39wJNmXwG1bfnuw-p0,13528
+sanic_security/authentication.py,sha256=TUGLQKVEH6WkXE82rh-ZY6k77-6cWfREXaNNf4MjLzU,13492
 sanic_security/authorization.py,sha256=JY3vIG_zlTNaTZ9xyExTADhlLLnfzYZ5FLOePovhzVA,7992
 sanic_security/configuration.py,sha256=2_XdxFcmMq4UNl1NUon1zBIKMfYCeMN3ixBZTgrNQRM,6039
 sanic_security/exceptions.py,sha256=CiH4M2bXZpGyh--eGG0TQdZjOu_mjKQiqnalpCLHLGM,4791
 sanic_security/models.py,sha256=c7j2RxuwA0PEWzoClplNROK9HWAw7-qATHMsaviqYLM,22133
 sanic_security/oauth.py,sha256=1aYPr5QGFv-mQYhSoExP7eszn7us0AOy2QJZiQPkptU,8403
 sanic_security/utils.py,sha256=B-nSBwP2sClkXfJHs5g7t9jmMHnl4LXJPUAeraDBQ7Y,3641
-sanic_security/verification.py,sha256=qQGc-vn22NM3JkYVERl-1SvG4tv1XN8agTWvuKPKNBE,8193
+sanic_security/verification.py,sha256=6YMfO5lTAhfTkkp4uUwJPuCDY_NOZlwaUjrOZq4CsoI,8280
 sanic_security/test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sanic_security/test/server.py,sha256=cmRHXyONBY5RZkIgfz6__dMKTr-LGZBFThz0Tp0272o,13363
+sanic_security/test/server.py,sha256=-vzpbLE2NkmBfsHkPv2d9-QGL1x2uYSrYwaq95FyvW8,13397
 sanic_security/test/tests.py,sha256=AbFCyK7Fg8FjI_Iisi4vAr-ebWsPdKWauZQuyBkAMEo,22071
-sanic_security-1.17.1.dist-info/licenses/LICENSE,sha256=DlJ21DRx8S4vaYJPBIDT3Rik4FaxXVYNottjE7oBZio,1079
-sanic_security-1.17.1.dist-info/METADATA,sha256=Jibu09vjT3-TMrViVC2-GddmhRwb4GE8lFZ0usCRmK0,24753
-sanic_security-1.17.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-sanic_security-1.17.1.dist-info/top_level.txt,sha256=ZybkhHXSjfzhmv8XeqLvnNmLmv21Z0oPX6Ep4DJN8b0,15
-sanic_security-1.17.1.dist-info/RECORD,,
+sanic_security-1.17.2.dist-info/licenses/LICENSE,sha256=DlJ21DRx8S4vaYJPBIDT3Rik4FaxXVYNottjE7oBZio,1079
+sanic_security-1.17.2.dist-info/METADATA,sha256=fTcvfKa4hHNDZSdxYClhtY8VUEDcAVnDoJB9q0mwHQ0,24805
+sanic_security-1.17.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sanic_security-1.17.2.dist-info/top_level.txt,sha256=ZybkhHXSjfzhmv8XeqLvnNmLmv21Z0oPX6Ep4DJN8b0,15
+sanic_security-1.17.2.dist-info/RECORD,,