Merge pull request #154 from ahopkins/dev

Version 1.3.0 - 2019-04-24

docs/source/conf.py

@@ -46,17 +46,17 @@
 
 # General information about the project.
 project = u"sanic-jwt"
-copyright = u"2018, Adam Hopkins"
+copyright = u"2019, Adam Hopkins"
 author = u"Adam Hopkins"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u"1.2"
+version = u"1.3"
 # The full version, including alpha/beta/rc tags.
-release = u"1.2.2"
+release = u"1.3.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/source/pages/changelog.rst

@@ -4,6 +4,16 @@ Changelog
 
 The format is based on `Keep a Changelog <http://keepachangelog.com/en/1.0.0/>`_ and this project adheres to `Semantic Versioning <http://semver.org/spec/v2.0.0.html>`_.
 
+++++++++++++++++++++++++++
+Version 1.3.0 - 2019-04-24
+++++++++++++++++++++++++++
+
+| **Added**
+| - `#40 <https://github.com/ahopkins/sanic-jwt/issues/40>`_. Page redirection for static page protection
+| - Support to be able to individually protect class-based view methods without the `decorators` property
+|
+
+
 ++++++++++++++++++++++++++
 Version 1.2.2 - 2019-03-14
 ++++++++++++++++++++++++++

docs/source/pages/configuration.rst

@@ -307,6 +307,14 @@ Alias for ``cookie_access_token_name``
 | **Default**: ``60 * 3``, aka 3 minutes
 |
 
+----------
+``login_redirect_url``
+----------
+
+| **Purpose**: Provide a default URL for authentication failure redirections on static pages.
+| **Default**: ``/index.html``
+|
+
 ------------------------
 ``path_to_authenticate``
 ------------------------

example/basic.py

@@ -9,7 +9,6 @@
 
 
 class User:
-
     def __init__(self, id, username, password):
         self.user_id = id
         self.username = username

example/basic_with_certs.py

@@ -5,7 +5,6 @@
 
 
 class User:
-
     def __init__(self, id, username, password):
         self.user_id = id
         self.username = username
@@ -23,12 +22,16 @@ def to_dict(self):
 username_table = {u.username: u for u in users}
 userid_table = {u.user_id: u for u in users}
 
-public_key = Path(
-    __file__
-).parent / ".." / "tests" / "resources" / "rsa-test-public.pem"
-private_key = Path(
-    __file__
-).parent / ".." / "tests" / "resources" / "rsa-test-key.pem"
+public_key = (
+    Path(__file__).parent
+    / ".."
+    / "tests"
+    / "resources"
+    / "rsa-test-public.pem"
+)
+private_key = (
+    Path(__file__).parent / ".." / "tests" / "resources" / "rsa-test-key.pem"
+)
 
 
 async def authenticate(request, *args, **kwargs):

example/cbv.py

@@ -7,7 +7,6 @@
 
 
 class User:
-
     def __init__(self, id, username, password):
         self.user_id = id
         self.username = username
@@ -48,7 +47,6 @@ async def authenticate(request, *args, **kwargs):
 
 
 class PublicView(HTTPMethodView):
-
     def get(self, request):
         return json({"hello": "world"})
 

example/custom_authentication_cls.py

@@ -5,7 +5,6 @@
 
 
 class MyAuthentication(Authentication):
-
     async def authenticate(self, request, *args, **kwargs):
         username = request.json.get("username", None)
         password = request.json.get("password", None)

example/custom_claims.py

@@ -7,7 +7,6 @@
 
 
 class User:
-
     def __init__(self, id, username, password):
         self.user_id = id
         self.username = username

example/custom_endpoint.py

@@ -16,7 +16,6 @@ def retrieve_refresh_token(request, user_id, *args, **kwargs):
 
 
 class Register(BaseEndpoint):
-
     async def post(self, request, *args, **kwargs):
         username = "username"
         email = "email"

example/extended_payload.py

@@ -5,7 +5,6 @@
 
 
 class User:
-
     def __init__(self, id, username, password):
         self.user_id = id
         self.username = username
@@ -25,7 +24,6 @@ def to_dict(self):
 
 
 class MyAuthentication(Authentication):
-
     async def extend_payload(self, payload, *args, **kwargs):
         payload.update({"app_name": self.app.name})
         return payload

example/extra_verifications.py

@@ -6,7 +6,6 @@
 
 
 class User:
-
     def __init__(self, id, username, password):
         self.user_id = id
         self.username = username

example/inject_user.py

@@ -7,7 +7,6 @@
 
 
 class User:
-
     def __init__(self, id, username, password):
         self.user_id = id
         self.username = username

example/main.py

@@ -73,7 +73,6 @@ async def authenticate(request, *args, **kwargs):
 
 
 class User:
-
     def __init__(self, id, username, password):
         setattr(self, "user_id", id)
         self.username = username

example/scopes.py

@@ -7,7 +7,6 @@
 
 
 class User:
-
     def __init__(self, id, username, password, scopes):
         self.user_id = id
         self.username = username

sanic_jwt/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.2.2"
+__version__ = "1.3.0"
 __author__ = "Adam Hopkins"
 __credits__ = "Richard Kuesters"
 

sanic_jwt/authentication.py

@@ -18,7 +18,6 @@
 
 
 class BaseAuthentication:
-
     def __init__(self, app, config):
         self.app = app
         self.claims = ["exp"]
@@ -115,7 +114,6 @@ async def retrieve_user(self, *args, **kwargs):
 
 
 class Authentication(BaseAuthentication):
-
     def _check_authentication(self, request, request_args, request_kwargs):
         """
         Checks a request object to determine if that request contains a valid,
@@ -374,10 +372,14 @@ def _verify(
             except jwt.exceptions.DecodeError as e:
                 self._reasons = e.args
                 # Make sure that the reasons all end with '.' for consistency
-                reason = [
-                    x if x.endswith(".") else "{}.".format(x)
-                    for x in list(e.args)
-                ] if self.config.debug() else "Auth required."
+                reason = (
+                    [
+                        x if x.endswith(".") else "{}.".format(x)
+                        for x in list(e.args)
+                    ]
+                    if self.config.debug()
+                    else "Auth required."
+                )
                 logger.debug(e.args)
                 is_valid = False
                 payload = None

sanic_jwt/base.py

@@ -1,5 +1,4 @@
 class BaseDerivative:
-
     def __init__(self, config, instance, *args, **kwargs):
         self.config = config
         self.instance = instance

sanic_jwt/claim.py

@@ -2,7 +2,6 @@
 
 
 class Claim:
-
     @classmethod
     def _register(cls, sanicjwt):
         required = ("key", "setup", "verify")

sanic_jwt/configuration.py

@@ -32,6 +32,7 @@
     "expiration_delta": 60 * 5 * 6,
     "generate_refresh_token": utils.generate_token,
     "leeway": 60 * 3,
+    "login_redirect_url": "/index.html",
     "path_to_authenticate": "/",
     "path_to_refresh": "/refresh",
     "path_to_retrieve_user": "/me",
@@ -50,11 +51,13 @@
     "url_prefix": "/auth",
     "user_id": "user_id",
     "blueprint_name": "auth_bp",
-    "verify_exp": True
+    "verify_exp": True,
+    "login_redirect_url": None,
 }
 
 aliases = {
-    "cookie_access_token_name": "cookie_token_name", "secret": "public_key"
+    "cookie_access_token_name": "cookie_token_name",
+    "secret": "public_key",
 }
 
 ignore_keys = (
@@ -95,7 +98,6 @@ def _update_config_item(key, item_aliases, instance):
 
 
 class ConfigItem:
-
     def __init__(
         self,
         value,
@@ -150,7 +152,6 @@ def aliases(self):
 
 
 class Configuration:
-
     def __iter__(self):  # noqa
         for key in self.config_keys:
             yield getattr(self, key)
@@ -181,9 +182,8 @@ def __new__(cls, *args, **kwargs):
 
             # check if a configuration key is set
             # and is an instance of ConfigItem
-            if (
-                hasattr(instance, key)
-                and isinstance(getattr(instance, key), ConfigItem)
+            if hasattr(instance, key) and isinstance(
+                getattr(instance, key), ConfigItem
             ):
                 _update_config_item(key, item_aliases, instance)
             # check if a configuration key is set with a value
@@ -285,9 +285,8 @@ def _merge(self, key, value):
 
     def _validate_secret(self):
         logger.debug("validating provided secret")
-        if (
-            self.secret() is None
-            or (isinstance(self.secret(), str) and self.secret().strip() == "")
+        if self.secret() is None or (
+            isinstance(self.secret(), str) and self.secret().strip() == ""
         ):
             raise exceptions.InvalidConfiguration(
                 "the SANIC_JWT_SECRET parameter cannot be None nor an empty "
@@ -296,14 +295,11 @@ def _validate_secret(self):
 
     def _validate_keys(self):
         logger.debug("validating keys (if needed)")
-        if (
-            utils.algorithm_is_asymmetric(self.algorithm())
-            and (
-                self.private_key() is None
-                or (
-                    isinstance(self.private_key(), str)
-                    and self.private_key().strip() == ""
-                )
+        if utils.algorithm_is_asymmetric(self.algorithm()) and (
+            self.private_key() is None
+            or (
+                isinstance(self.private_key(), str)
+                and self.private_key().strip() == ""
             )
         ):
             raise exceptions.RequiredKeysNotFound