Added Token authentication method

Author: michalpokusa

adafruit_httpserver/__init__.py

@@ -25,6 +25,7 @@
 
 from .authentication import (
     Basic,
+    Token,
     Bearer,
     check_authentication,
     require_authentication,

adafruit_httpserver/authentication.py

@@ -28,17 +28,27 @@ def __str__(self) -> str:
         return f"Basic {self._value}"
 
 
-class Bearer:
-    """Represents HTTP Bearer Token Authentication."""
+class Token:
+    """Represents HTTP Token Authentication."""
+
+    prefix = "Token"
 
     def __init__(self, token: str) -> None:
         self._value = token
 
     def __str__(self) -> str:
-        return f"Bearer {self._value}"
+        return f"{self.prefix} {self._value}"
+
+
+class Bearer(Token):  # pylint: disable=too-few-public-methods
+    """Represents HTTP Bearer Token Authentication."""
+
+    prefix = "Bearer"
 
 
-def check_authentication(request: Request, auths: List[Union[Basic, Bearer]]) -> bool:
+def check_authentication(
+    request: Request, auths: List[Union[Basic, Token, Bearer]]
+) -> bool:
     """
     Returns ``True`` if request is authorized by any of the authentications, ``False`` otherwise.
 
@@ -47,15 +57,17 @@ def check_authentication(request: Request, auths: List[Union[Basic, Bearer]]) ->
         check_authentication(request, [Basic("username", "password")])
     """
 
-    auth_header = request.headers.get("Authorization")
+    auth_header = request.headers.get_directive("Authorization")
 
     if auth_header is None:
         return False
 
     return any(auth_header == str(auth) for auth in auths)
 
 
-def require_authentication(request: Request, auths: List[Union[Basic, Bearer]]) -> None:
+def require_authentication(
+    request: Request, auths: List[Union[Basic, Token, Bearer]]
+) -> None:
     """
     Checks if the request is authorized and raises ``AuthenticationError`` if not.
 

adafruit_httpserver/server.py

@@ -17,7 +17,7 @@
 from errno import EAGAIN, ECONNRESET, ETIMEDOUT
 from traceback import print_exception
 
-from .authentication import Basic, Bearer, require_authentication
+from .authentication import Basic, Token, Bearer, require_authentication
 from .exceptions import (
     ServerStoppedError,
     AuthenticationError,
@@ -398,7 +398,7 @@ def poll(self) -> str:
             conn.close()
             raise error  # Raise the exception again to be handled by the user.
 
-    def require_authentication(self, auths: List[Union[Basic, Bearer]]) -> None:
+    def require_authentication(self, auths: List[Union[Basic, Token, Bearer]]) -> None:
         """
         Requires authentication for all routes and files in ``root_path``.
         Any non-authenticated request will be rejected with a 401 status code.

docs/examples.rst

@@ -243,15 +243,15 @@ If you want to apply authentication to the whole server, you need to call ``.req
 
 .. literalinclude:: ../examples/httpserver_authentication_server.py
     :caption: examples/httpserver_authentication_server.py
-    :emphasize-lines: 8,11-15,19
+    :emphasize-lines: 8,11-16,20
     :linenos:
 
 On the other hand, if you want to apply authentication to a set of routes, you need to call ``require_authentication`` function.
 In both cases you can check if ``request`` is authenticated by calling ``check_authentication`` on it.
 
 .. literalinclude:: ../examples/httpserver_authentication_handlers.py
     :caption: examples/httpserver_authentication_handlers.py
-    :emphasize-lines: 9-15,21-25,33,47,59
+    :emphasize-lines: 9-16,22-27,35,49,61
     :linenos:
 
 Redirects

examples/httpserver_authentication_handlers.py

@@ -9,6 +9,7 @@
 from adafruit_httpserver.authentication import (
     AuthenticationError,
     Basic,
+    Token,
     Bearer,
     check_authentication,
     require_authentication,
@@ -21,6 +22,7 @@
 # Create a list of available authentication methods.
 auths = [
     Basic("user", "password"),
+    Token("2db53340-4f9c-4f70-9037-d25bee77eca6"),
     Bearer("642ec696-2a79-4d60-be3a-7c9a3164d766"),
 ]
 

examples/httpserver_authentication_server.py

@@ -5,12 +5,13 @@
 import socketpool
 import wifi
 
-from adafruit_httpserver import Server, Request, Response, Basic, Bearer
+from adafruit_httpserver import Server, Request, Response, Basic, Token, Bearer
 
 
 # Create a list of available authentication methods.
 auths = [
     Basic("user", "password"),
+    Token("2db53340-4f9c-4f70-9037-d25bee77eca6"),
     Bearer("642ec696-2a79-4d60-be3a-7c9a3164d766"),
 ]