sanic-security 1.10.3__tar.gz → 1.11.0__tar.gz

{sanic-security-1.10.3/sanic_security.egg-info → sanic-security-1.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sanic-security
-Version: 1.10.3
+Version: 1.11.0
 Summary: An effective, simple, and async security library for the Sanic framework.
 Home-page: https://github.com/na-stewart/sanic-security
 Author: Aidan Stewart
@@ -98,6 +98,11 @@ pip3 install sanic-security[crypto]
 pip3 install -e ".[dev]"
 ````
 
+* Update sanic-security if already installed.
+```shell
+pip3 install --upgrade sanic-security
+```
+
 ### Configuration
 
 Sanic Security configuration is merely an object that can be modified either using dot-notation or like a 
@@ -151,7 +156,7 @@ The tables in the below examples represent example [request form-data](https://s
 
 * Initial Administrator Account
 
-This account can be logged into and has complete authoritative access. Login credentials can be modified in config.
+This account can be logged into and has complete authoritative access. Login credentials should be modified in config!
   
   ```python
   create_initial_admin_account(app)
@@ -277,10 +282,10 @@ async def on_authenticate(request):
 ```python
 @app.post("api/security/auth")
 @requires_authentication()
-async def on_authenticate(request, authentication_session):
+async def on_authenticate(request):
     return json(
         "You have been authenticated.",
-        authentication_session.bearer.json,
+        request.ctx.authentication_session.bearer.json,
     )
 ```
 
@@ -330,8 +335,8 @@ async def on_captcha(request):
 ```python
 @app.post("ap/security/captcha")
 @requires_captcha()
-async def on_captcha(request, captcha_session):
-    return json("Captcha attempt successful!", captcha_session.json)
+async def on_captcha(request):
+    return json("Captcha attempt successful!", request.ctx.captcha_session.json)
 ```
 
 ## Two-step Verification
@@ -393,9 +398,10 @@ async def on_two_step_verification(request):
 ```python
 @app.post("api/security/two-step")
 @requires_two_step_verification()
-async def on_two_step_verification(request, two_step_session):
+async def on_two_step_verification(request):
     response = json(
-        "Two-step verification attempt successful!", two_step_session.bearer.json
+        "Two-step verification attempt successful!",
+        request.ctx.two_step_session.bearer.json,
     )
     return response
 ```
@@ -434,13 +440,12 @@ async def on_check_perms(request):
     return text("Account is authorized.")
 ```
 
-
 * Require Permissions (This method is not called directly and instead used as a decorator.)
 
 ```python
 @app.post("api/security/perms")
 @require_permissions("channels:view", "voice:*")
-async def on_check_perms(request, authentication_session):
+async def on_check_perms(request):
     return text("Account is authorized.")
 ```
 
@@ -458,7 +463,7 @@ async def on_check_roles(request):
 ```python
 @app.post("api/security/roles")
 @require_roles("Chat Room Moderator")
-async def on_check_roles(request, authentication_session):
+async def on_check_roles(request):
     return text("Account is authorized.")
 ```
 

{sanic-security-1.10.3 → sanic-security-1.11.0}/README.md

@@ -83,6 +83,11 @@ pip3 install sanic-security[crypto]
 pip3 install -e ".[dev]"
 ````
 
+* Update sanic-security if already installed.
+```shell
+pip3 install --upgrade sanic-security
+```
+
 ### Configuration
 
 Sanic Security configuration is merely an object that can be modified either using dot-notation or like a 
@@ -136,7 +141,7 @@ The tables in the below examples represent example [request form-data](https://s
 
 * Initial Administrator Account
 
-This account can be logged into and has complete authoritative access. Login credentials can be modified in config.
+This account can be logged into and has complete authoritative access. Login credentials should be modified in config!
   
   ```python
   create_initial_admin_account(app)
@@ -262,10 +267,10 @@ async def on_authenticate(request):
 ```python
 @app.post("api/security/auth")
 @requires_authentication()
-async def on_authenticate(request, authentication_session):
+async def on_authenticate(request):
     return json(
         "You have been authenticated.",
-        authentication_session.bearer.json,
+        request.ctx.authentication_session.bearer.json,
     )
 ```
 
@@ -315,8 +320,8 @@ async def on_captcha(request):
 ```python
 @app.post("ap/security/captcha")
 @requires_captcha()
-async def on_captcha(request, captcha_session):
-    return json("Captcha attempt successful!", captcha_session.json)
+async def on_captcha(request):
+    return json("Captcha attempt successful!", request.ctx.captcha_session.json)
 ```
 
 ## Two-step Verification
@@ -378,9 +383,10 @@ async def on_two_step_verification(request):
 ```python
 @app.post("api/security/two-step")
 @requires_two_step_verification()
-async def on_two_step_verification(request, two_step_session):
+async def on_two_step_verification(request):
     response = json(
-        "Two-step verification attempt successful!", two_step_session.bearer.json
+        "Two-step verification attempt successful!",
+        request.ctx.two_step_session.bearer.json,
     )
     return response
 ```
@@ -419,13 +425,12 @@ async def on_check_perms(request):
     return text("Account is authorized.")
 ```
 
-
 * Require Permissions (This method is not called directly and instead used as a decorator.)
 
 ```python
 @app.post("api/security/perms")
 @require_permissions("channels:view", "voice:*")
-async def on_check_perms(request, authentication_session):
+async def on_check_perms(request):
     return text("Account is authorized.")
 ```
 
@@ -443,7 +448,7 @@ async def on_check_roles(request):
 ```python
 @app.post("api/security/roles")
 @require_roles("Chat Room Moderator")
-async def on_check_roles(request, authentication_session):
+async def on_check_roles(request):
     return text("Account is authorized.")
 ```
 

{sanic-security-1.10.3 → sanic-security-1.11.0}/sanic_security/authentication.py

@@ -239,7 +239,7 @@ def requires_authentication():
 
             @app.post('api/authenticate')
             @requires_authentication()
-            async def on_authenticate(request, authentication_session):
+            async def on_authenticate(request):
                 return text('User is authenticated!')
 
     Raises:
@@ -255,8 +255,8 @@ def requires_authentication():
     def wrapper(func):
         @functools.wraps(func)
         async def wrapped(request, *args, **kwargs):
-            authentication_session = await authenticate(request)
-            return await func(request, authentication_session, *args, **kwargs)
+            request.ctx.authentication_session = await authenticate(request)
+            return await func(request, *args, **kwargs)
 
         return wrapped
 

{sanic-security-1.10.3 → sanic-security-1.11.0}/sanic_security/authorization.py

@@ -107,7 +107,7 @@ def require_permissions(*required_permissions: str):
 
             @app.post("api/auth/perms")
             @require_permissions("admin:update", "employee:add")
-            async def on_require_perms(request, authentication_session):
+            async def on_require_perms(request):
                 return text("Account permitted.")
 
     Raises:
@@ -124,10 +124,10 @@ def require_permissions(*required_permissions: str):
     def wrapper(func):
         @functools.wraps(func)
         async def wrapped(request, *args, **kwargs):
-            authentication_session = await check_permissions(
+            request.ctx.authentication_session = await check_permissions(
                 request, *required_permissions
             )
-            return await func(request, authentication_session, *args, **kwargs)
+            return await func(request, *args, **kwargs)
 
         return wrapped
 
@@ -146,7 +146,7 @@ def require_roles(*required_roles: str):
 
             @app.post("api/auth/roles")
             @require_roles("Admin", "Moderator")
-            async def on_require_roles(request, authentication_session):
+            async def on_require_roles(request):
                 return text("Account permitted")
 
     Raises:
@@ -163,8 +163,10 @@ def require_roles(*required_roles: str):
     def wrapper(func):
         @functools.wraps(func)
         async def wrapped(request, *args, **kwargs):
-            authentication_session = await check_roles(request, *required_roles)
-            return await func(request, authentication_session, *args, **kwargs)
+            request.ctx.authentication_session = await check_roles(
+                request, *required_roles
+            )
+            return await func(request, *args, **kwargs)
 
         return wrapped
 
@@ -175,7 +177,7 @@ async def assign_role(
     name: str, account: Account, permissions: str = None, description: str = None
 ) -> Role:
     """
-    Quick creation of a role associated with an account.
+    Easy account role assignment. Role being assigned to an account will be created if it doesn't exist.
 
     Args:
         name (str):  The name of the role associated with the account.
@@ -184,7 +186,7 @@ async def assign_role(
         description (str):  The description of the role associated with the account.
     """
     try:
-        role = await Role.filter(name=name, permissions=permissions).get()
+        role = await Role.filter(name=name).get()
     except DoesNotExist:
         role = await Role.create(
             description=description, permissions=permissions, name=name

{sanic-security-1.10.3 → sanic-security-1.11.0}/sanic_security/exceptions.py

@@ -106,8 +106,8 @@ class JWTDecodeError(SessionError):
     Raised when client JWT is invalid.
     """
 
-    def __init__(self, message):
-        super().__init__(message, 400)
+    def __init__(self, message, code=400):
+        super().__init__(message, code)
 
 
 class DeactivatedError(SessionError):

{sanic-security-1.10.3 → sanic-security-1.11.0}/sanic_security/models.py

@@ -368,7 +368,7 @@ class Session(BaseModel):
         )
         try:
             if not cookie:
-                raise JWTDecodeError("Session token not provided or expired.")
+                raise JWTDecodeError("Session token not provided or expired.", 401)
             else:
                 return jwt.decode(
                     cookie,
@@ -553,7 +553,7 @@ class Role(BaseModel):
         permissions (str): Permissions of the role. Must be separated via comma and in wildcard format (printer:query, printer:query,delete).
     """
 
-    name: str = fields.CharField(max_length=255)
+    name: str = fields.CharField(unique=True, max_length=255)
     description: str = fields.CharField(max_length=255, null=True)
     permissions: str = fields.CharField(max_length=255, null=True)
 

{sanic-security-1.10.3 → sanic-security-1.11.0}/sanic_security/test/server.py

@@ -1,6 +1,5 @@
 from argon2 import PasswordHasher
 from sanic import Sanic, text
-from sanic.utils import str_to_bool
 from tortoise.contrib.sanic import register_tortoise
 
 from sanic_security.authentication import (
@@ -132,23 +131,23 @@ async def on_logout(request):
 
 @app.post("api/test/auth")
 @requires_authentication()
-async def on_authenticate(request, authentication_session):
+async def on_authenticate(request):
     """
     Authenticate client session and account.
     """
-    response = json("Authenticated!", authentication_session.bearer.json)
-    authentication_session.encode(response)
+    response = json("Authenticated!", request.ctx.authentication_session.bearer.json)
+    request.ctx.authentication_session.encode(response)
     return response
 
 
 @app.post("api/test/auth/associated")
 @requires_authentication()
-async def on_get_associated_authentication_sessions(request, authentication_session):
+async def on_get_associated_authentication_sessions(request):
     """
     Retrieves authentication sessions associated with logged in account.
     """
     authentication_sessions = await AuthenticationSession.get_associated(
-        authentication_session.bearer
+        request.ctx.authentication_session.bearer
     )
     return json(
         "Associated authentication sessions retrieved!",
@@ -180,11 +179,11 @@ async def on_captcha_image(request):
 
 @app.post("api/test/capt")
 @requires_captcha()
-async def on_captcha_attempt(request, captcha_session):
+async def on_captcha_attempt(request):
     """
     Attempt captcha challenge.
     """
-    return json("Captcha attempt successful!", captcha_session.json)
+    return json("Captcha attempt successful!", request.ctx.captcha_session.json)
 
 
 @app.post("api/test/two-step/request")
@@ -200,16 +199,18 @@ async def on_request_verification(request):
 
 @app.post("api/test/two-step")
 @requires_two_step_verification()
-async def on_verification_attempt(request, two_step_session):
+async def on_verification_attempt(request):
     """
     Attempt two-step verification challenge.
     """
-    return json("Two step verification attempt successful!", two_step_session.json)
+    return json(
+        "Two step verification attempt successful!", request.ctx.two_step_session.json
+    )
 
 
 @app.post("api/test/auth/roles")
 @requires_authentication()
-async def on_authorization(request, authentication_session):
+async def on_authorization(request):
     """
     Check if client is authorized with sufficient roles and permissions.
     """
@@ -223,13 +224,13 @@ async def on_authorization(request, authentication_session):
 
 @app.post("api/test/auth/roles/assign")
 @requires_authentication()
-async def on_role_assign(request, authentication_session):
+async def on_role_assign(request):
     """
     Assign authenticated account a role.
     """
     await assign_role(
         request.form.get("name"),
-        authentication_session.bearer,
+        request.ctx.authentication_session.bearer,
         request.form.get("permissions"),
         "Role used for testing.",
     )

{sanic-security-1.10.3 → sanic-security-1.11.0}/sanic_security/verification.py

@@ -99,7 +99,7 @@ def requires_two_step_verification():
 
             @app.post("api/verification/attempt")
             @requires_two_step_verification()
-            async def on_verified(request, two_step_session):
+            async def on_verified(request):
                 response = json("Two-step verification attempt successful!", two_step_session.json())
                 return response
 
@@ -118,8 +118,8 @@ def requires_two_step_verification():
     def wrapper(func):
         @functools.wraps(func)
         async def wrapped(request, *args, **kwargs):
-            two_step_session = await two_step_verification(request)
-            return await func(request, two_step_session, *args, **kwargs)
+            request.ctx.two_step_session = await two_step_verification(request)
+            return await func(request, *args, **kwargs)
 
         return wrapped
 
@@ -207,7 +207,7 @@ def requires_captcha():
 
             @app.post("api/captcha/attempt")
             @requires_captcha()
-            async def on_captcha_attempt(request, captcha_session):
+            async def on_captcha_attempt(request):
                 return json("Captcha attempt successful!", captcha_session.json())
 
     Raises:
@@ -223,8 +223,8 @@ def requires_captcha():
     def wrapper(func):
         @functools.wraps(func)
         async def wrapped(request, *args, **kwargs):
-            captcha_session = await captcha(request)
-            return await func(request, captcha_session, *args, **kwargs)
+            request.ctx.captcha_session = await captcha(request)
+            return await func(request, *args, **kwargs)
 
         return wrapped
 

{sanic-security-1.10.3 → sanic-security-1.11.0/sanic_security.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sanic-security
-Version: 1.10.3
+Version: 1.11.0
 Summary: An effective, simple, and async security library for the Sanic framework.
 Home-page: https://github.com/na-stewart/sanic-security
 Author: Aidan Stewart
@@ -98,6 +98,11 @@ pip3 install sanic-security[crypto]
 pip3 install -e ".[dev]"
 ````
 
+* Update sanic-security if already installed.
+```shell
+pip3 install --upgrade sanic-security
+```
+
 ### Configuration
 
 Sanic Security configuration is merely an object that can be modified either using dot-notation or like a 
@@ -151,7 +156,7 @@ The tables in the below examples represent example [request form-data](https://s
 
 * Initial Administrator Account
 
-This account can be logged into and has complete authoritative access. Login credentials can be modified in config.
+This account can be logged into and has complete authoritative access. Login credentials should be modified in config!
   
   ```python
   create_initial_admin_account(app)
@@ -277,10 +282,10 @@ async def on_authenticate(request):
 ```python
 @app.post("api/security/auth")
 @requires_authentication()
-async def on_authenticate(request, authentication_session):
+async def on_authenticate(request):
     return json(
         "You have been authenticated.",
-        authentication_session.bearer.json,
+        request.ctx.authentication_session.bearer.json,
     )
 ```
 
@@ -330,8 +335,8 @@ async def on_captcha(request):
 ```python
 @app.post("ap/security/captcha")
 @requires_captcha()
-async def on_captcha(request, captcha_session):
-    return json("Captcha attempt successful!", captcha_session.json)
+async def on_captcha(request):
+    return json("Captcha attempt successful!", request.ctx.captcha_session.json)
 ```
 
 ## Two-step Verification
@@ -393,9 +398,10 @@ async def on_two_step_verification(request):
 ```python
 @app.post("api/security/two-step")
 @requires_two_step_verification()
-async def on_two_step_verification(request, two_step_session):
+async def on_two_step_verification(request):
     response = json(
-        "Two-step verification attempt successful!", two_step_session.bearer.json
+        "Two-step verification attempt successful!",
+        request.ctx.two_step_session.bearer.json,
     )
     return response
 ```
@@ -434,13 +440,12 @@ async def on_check_perms(request):
     return text("Account is authorized.")
 ```
 
-
 * Require Permissions (This method is not called directly and instead used as a decorator.)
 
 ```python
 @app.post("api/security/perms")
 @require_permissions("channels:view", "voice:*")
-async def on_check_perms(request, authentication_session):
+async def on_check_perms(request):
     return text("Account is authorized.")
 ```
 
@@ -458,7 +463,7 @@ async def on_check_roles(request):
 ```python
 @app.post("api/security/roles")
 @require_roles("Chat Room Moderator")
-async def on_check_roles(request, authentication_session):
+async def on_check_roles(request):
     return text("Account is authorized.")
 ```
 

{sanic-security-1.10.3 → sanic-security-1.11.0}/setup.py

@@ -13,7 +13,7 @@ setup(
     long_description=long_description,
     long_description_content_type="text/markdown",
     license="GNU Affero General Public License v3.0",
-    version="1.10.3",
+    version="1.11.0",
     packages=setuptools.find_packages(),
     python_requires=">=3.6",
     install_requires=[