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

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

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: sanic-security
-Version: 1.12.5
+Version: 1.12.6
 Summary: An async security library for the Sanic framework.
-Author-email: Aidan Stewart <na.stewart365@gmail.com>
+Author-email: Aidan Stewart <me@na-stewart.com>
 Project-URL: Documentation, https://security.na-stewart.com/
 Project-URL: Repository, https://github.com/na-stewart/sanic-security
 Keywords: security,authentication,authorization,verification,async,sanic
@@ -197,7 +197,7 @@ async def on_register(request):
     account = await register(request)
     two_step_session = await request_two_step_verification(request, account)
     await email_code(
-        account.email, two_step_session.code  # Code = 197251
+        account.email, two_step_session.code  # Code = 24KF19
     )  # Custom method for emailing verification code.
     response = json(
         "Registration successful! Email verification required.",
@@ -213,7 +213,7 @@ Verifies the client's account via two-step session code.
 
 | Key      | Value  |
 |----------|--------|
-| **code** | 197251 |
+| **code** | 24KF19 |
 
 ```python
 @app.post("api/security/verify")
@@ -237,7 +237,7 @@ async def on_login(request):
         request, authentication_session.bearer
     )
     await email_code(
-        authentication_session.bearer.email, two_step_session.code  # Code = 197251
+        authentication_session.bearer.email, two_step_session.code  # Code = XGED2U
     )  # Custom method for emailing verification code.
     response = json(
         "Login successful! Two-factor authentication required.",
@@ -256,7 +256,7 @@ Fulfills client authentication session's second factor requirement via two-step
 
 | Key      | Value  |
 |----------|--------|
-| **code** | 197251 |
+| **code** | XGED2U |
 
 ```python
 @app.post("api/security/fulfill-2fa")
@@ -323,8 +323,8 @@ async def on_authenticate(request):
 
 * Refresh Encoder
 
-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.
+A new/refreshed session is returned during authentication when the client's current session expires and it
+requires encoding. This should be be done automatically via middleware.
 
 ```python
 attach_refresh_encoder(app)
@@ -347,7 +347,7 @@ downloading a .ttf font and defining the file's path in the configuration.
 @app.get("api/security/captcha")
 async def on_captcha_img_request(request):
     captcha_session = await request_captcha(request)
-    response = captcha_session.get_image()  # Captcha: 192731
+    response = captcha_session.get_image()  # Captcha: LJ0F3U
     captcha_session.encode(response)
     return response
 ```
@@ -356,7 +356,7 @@ async def on_captcha_img_request(request):
 
 | Key         | Value  |
 |-------------|--------|
-| **captcha** | 192731 |
+| **captcha** | LJ0F3U |
 
 ```python
 @app.post("api/security/captcha")
@@ -369,7 +369,7 @@ async def on_captcha(request):
 
 | Key         | Value  |
 |-------------|--------|
-| **captcha** | 192731 |
+| **captcha** | LJ0F3U |
 
 ```python
 @app.post("api/security/captcha")
@@ -391,7 +391,7 @@ Two-step verification should be integrated with other custom functionality. For
 ```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 = 197251
+    two_step_session = await request_two_step_verification(request)  # Code = T2I58I
     await email_code(
         two_step_session.bearer.email, two_step_session.code
     )  # Custom method for emailing verification code.
@@ -405,7 +405,7 @@ async def on_two_step_request(request):
 ```python
 @app.post("api/security/two-step/resend")
 async def on_two_step_resend(request):
-    two_step_session = await TwoStepSession.decode(request)  # Code = 197251
+    two_step_session = await TwoStepSession.decode(request)  # Code = T2I58I
     await email_code(
         two_step_session.bearer.email, two_step_session.code
     )  # Custom method for emailing verification code.
@@ -416,7 +416,7 @@ async def on_two_step_resend(request):
 
 | Key      | Value  |
 |----------|--------|
-| **code** | 197251 |
+| **code** | T2I58I |
 
 ```python
 @app.post("api/security/two-step")
@@ -430,7 +430,7 @@ async def on_two_step_verification(request):
 
 | Key      | Value  |
 |----------|--------|
-| **code** | 197251 |
+| **code** | T2I58I |
 
 ```python
 @app.post("api/security/two-step")

{sanic_security-1.12.5 → sanic_security-1.12.6}/README.md

@@ -166,7 +166,7 @@ async def on_register(request):
     account = await register(request)
     two_step_session = await request_two_step_verification(request, account)
     await email_code(
-        account.email, two_step_session.code  # Code = 197251
+        account.email, two_step_session.code  # Code = 24KF19
     )  # Custom method for emailing verification code.
     response = json(
         "Registration successful! Email verification required.",
@@ -182,7 +182,7 @@ Verifies the client's account via two-step session code.
 
 | Key      | Value  |
 |----------|--------|
-| **code** | 197251 |
+| **code** | 24KF19 |
 
 ```python
 @app.post("api/security/verify")
@@ -206,7 +206,7 @@ async def on_login(request):
         request, authentication_session.bearer
     )
     await email_code(
-        authentication_session.bearer.email, two_step_session.code  # Code = 197251
+        authentication_session.bearer.email, two_step_session.code  # Code = XGED2U
     )  # Custom method for emailing verification code.
     response = json(
         "Login successful! Two-factor authentication required.",
@@ -225,7 +225,7 @@ Fulfills client authentication session's second factor requirement via two-step
 
 | Key      | Value  |
 |----------|--------|
-| **code** | 197251 |
+| **code** | XGED2U |
 
 ```python
 @app.post("api/security/fulfill-2fa")
@@ -292,8 +292,8 @@ async def on_authenticate(request):
 
 * Refresh Encoder
 
-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.
+A new/refreshed session is returned during authentication when the client's current session expires and it
+requires encoding. This should be be done automatically via middleware.
 
 ```python
 attach_refresh_encoder(app)
@@ -316,7 +316,7 @@ downloading a .ttf font and defining the file's path in the configuration.
 @app.get("api/security/captcha")
 async def on_captcha_img_request(request):
     captcha_session = await request_captcha(request)
-    response = captcha_session.get_image()  # Captcha: 192731
+    response = captcha_session.get_image()  # Captcha: LJ0F3U
     captcha_session.encode(response)
     return response
 ```
@@ -325,7 +325,7 @@ async def on_captcha_img_request(request):
 
 | Key         | Value  |
 |-------------|--------|
-| **captcha** | 192731 |
+| **captcha** | LJ0F3U |
 
 ```python
 @app.post("api/security/captcha")
@@ -338,7 +338,7 @@ async def on_captcha(request):
 
 | Key         | Value  |
 |-------------|--------|
-| **captcha** | 192731 |
+| **captcha** | LJ0F3U |
 
 ```python
 @app.post("api/security/captcha")
@@ -360,7 +360,7 @@ Two-step verification should be integrated with other custom functionality. For
 ```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 = 197251
+    two_step_session = await request_two_step_verification(request)  # Code = T2I58I
     await email_code(
         two_step_session.bearer.email, two_step_session.code
     )  # Custom method for emailing verification code.
@@ -374,7 +374,7 @@ async def on_two_step_request(request):
 ```python
 @app.post("api/security/two-step/resend")
 async def on_two_step_resend(request):
-    two_step_session = await TwoStepSession.decode(request)  # Code = 197251
+    two_step_session = await TwoStepSession.decode(request)  # Code = T2I58I
     await email_code(
         two_step_session.bearer.email, two_step_session.code
     )  # Custom method for emailing verification code.
@@ -385,7 +385,7 @@ async def on_two_step_resend(request):
 
 | Key      | Value  |
 |----------|--------|
-| **code** | 197251 |
+| **code** | T2I58I |
 
 ```python
 @app.post("api/security/two-step")
@@ -399,7 +399,7 @@ async def on_two_step_verification(request):
 
 | Key      | Value  |
 |----------|--------|
-| **code** | 197251 |
+| **code** | T2I58I |
 
 ```python
 @app.post("api/security/two-step")

{sanic_security-1.12.5 → sanic_security-1.12.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sanic-security"
-version = "1.12.5"
+version = "1.12.6"
 requires-python = ">=3.8"
 dependencies = [
     "tortoise-orm>=0.17.0",
@@ -16,7 +16,7 @@ dependencies = [
 ]
 description = "An async security library for the Sanic framework."
 authors = [
-  { name="Aidan Stewart", email="na.stewart365@gmail.com" },
+  { name="Aidan Stewart", email="me@na-stewart.com" },
 ]
 readme = "README.md"
 keywords = ["security", "authentication", "authorization", "verification", "async", "sanic"]

{sanic_security-1.12.5 → sanic_security-1.12.6}/sanic_security/utils.py

@@ -1,5 +1,6 @@
 import datetime
 import random
+import string
 
 from sanic.request import Request
 from sanic.response import json as sanic_json, HTTPResponse
@@ -47,7 +48,9 @@ def get_code() -> str:
     Returns:
         code
     """
-    return str(random.randint(100000, 999999))
+    return "".join(
+        random.choice(string.ascii_uppercase + string.digits) for _ in range(6)
+    )
 
 
 def json(

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

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: sanic-security
-Version: 1.12.5
+Version: 1.12.6
 Summary: An async security library for the Sanic framework.
-Author-email: Aidan Stewart <na.stewart365@gmail.com>
+Author-email: Aidan Stewart <me@na-stewart.com>
 Project-URL: Documentation, https://security.na-stewart.com/
 Project-URL: Repository, https://github.com/na-stewart/sanic-security
 Keywords: security,authentication,authorization,verification,async,sanic
@@ -197,7 +197,7 @@ async def on_register(request):
     account = await register(request)
     two_step_session = await request_two_step_verification(request, account)
     await email_code(
-        account.email, two_step_session.code  # Code = 197251
+        account.email, two_step_session.code  # Code = 24KF19
     )  # Custom method for emailing verification code.
     response = json(
         "Registration successful! Email verification required.",
@@ -213,7 +213,7 @@ Verifies the client's account via two-step session code.
 
 | Key      | Value  |
 |----------|--------|
-| **code** | 197251 |
+| **code** | 24KF19 |
 
 ```python
 @app.post("api/security/verify")
@@ -237,7 +237,7 @@ async def on_login(request):
         request, authentication_session.bearer
     )
     await email_code(
-        authentication_session.bearer.email, two_step_session.code  # Code = 197251
+        authentication_session.bearer.email, two_step_session.code  # Code = XGED2U
     )  # Custom method for emailing verification code.
     response = json(
         "Login successful! Two-factor authentication required.",
@@ -256,7 +256,7 @@ Fulfills client authentication session's second factor requirement via two-step
 
 | Key      | Value  |
 |----------|--------|
-| **code** | 197251 |
+| **code** | XGED2U |
 
 ```python
 @app.post("api/security/fulfill-2fa")
@@ -323,8 +323,8 @@ async def on_authenticate(request):
 
 * Refresh Encoder
 
-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.
+A new/refreshed session is returned during authentication when the client's current session expires and it
+requires encoding. This should be be done automatically via middleware.
 
 ```python
 attach_refresh_encoder(app)
@@ -347,7 +347,7 @@ downloading a .ttf font and defining the file's path in the configuration.
 @app.get("api/security/captcha")
 async def on_captcha_img_request(request):
     captcha_session = await request_captcha(request)
-    response = captcha_session.get_image()  # Captcha: 192731
+    response = captcha_session.get_image()  # Captcha: LJ0F3U
     captcha_session.encode(response)
     return response
 ```
@@ -356,7 +356,7 @@ async def on_captcha_img_request(request):
 
 | Key         | Value  |
 |-------------|--------|
-| **captcha** | 192731 |
+| **captcha** | LJ0F3U |
 
 ```python
 @app.post("api/security/captcha")
@@ -369,7 +369,7 @@ async def on_captcha(request):
 
 | Key         | Value  |
 |-------------|--------|
-| **captcha** | 192731 |
+| **captcha** | LJ0F3U |
 
 ```python
 @app.post("api/security/captcha")
@@ -391,7 +391,7 @@ Two-step verification should be integrated with other custom functionality. For
 ```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 = 197251
+    two_step_session = await request_two_step_verification(request)  # Code = T2I58I
     await email_code(
         two_step_session.bearer.email, two_step_session.code
     )  # Custom method for emailing verification code.
@@ -405,7 +405,7 @@ async def on_two_step_request(request):
 ```python
 @app.post("api/security/two-step/resend")
 async def on_two_step_resend(request):
-    two_step_session = await TwoStepSession.decode(request)  # Code = 197251
+    two_step_session = await TwoStepSession.decode(request)  # Code = T2I58I
     await email_code(
         two_step_session.bearer.email, two_step_session.code
     )  # Custom method for emailing verification code.
@@ -416,7 +416,7 @@ async def on_two_step_resend(request):
 
 | Key      | Value  |
 |----------|--------|
-| **code** | 197251 |
+| **code** | T2I58I |
 
 ```python
 @app.post("api/security/two-step")
@@ -430,7 +430,7 @@ async def on_two_step_verification(request):
 
 | Key      | Value  |
 |----------|--------|
-| **code** | 197251 |
+| **code** | T2I58I |
 
 ```python
 @app.post("api/security/two-step")