added AUTH__EXCLUDED_PATHS to allow a number of requests to not be authenticated (for example the one that sets the auth cookie value)

Author: DinisCruz

osbot_fast_api/api/middlewares/Middleware__Check_API_Key.py

@@ -1,15 +1,18 @@
-from fastapi                    import Request, status
-from starlette.middleware.base  import BaseHTTPMiddleware
-from starlette.responses        import Response
-from osbot_utils.utils.Env      import get_env
-from osbot_utils.utils.Json     import to_json_str
-from osbot_utils.utils.Status   import status_error
+from fastapi                                 import Request, status
+from starlette.middleware.base               import BaseHTTPMiddleware
+from starlette.responses                     import Response
+from osbot_utils.utils.Env                   import get_env
+from osbot_utils.utils.Json                  import to_json_str
+from osbot_utils.utils.Status                import status_error
+from osbot_fast_api.schemas.consts__Fast_API import AUTH__EXCLUDED_PATHS
 
 ERROR_MESSAGE__NO_KEY_NAME_SETUP   = f"Server does not have API key name setup"
 ERROR_MESSAGE__NO_KEY_VALUE_SETUP  = f"Server does not have API key value setup"
 ERROR_MESSAGE__API_KEY_MISSING     = f"Client API key is missing, you need to set it on a header or cookie"
 ERROR_MESSAGE__API_KEY_INVALID     = "Invalid API key value"
 
+
+
 class Middleware__Check_API_Key(BaseHTTPMiddleware):
 
     def __init__(self, app, env_var__api_key__name, env_var__api_key__value):
@@ -24,6 +27,10 @@ def return_error(self, error_message):
                         media_type  = "application/json"            )
 
     async def dispatch(self, request: Request, call_next) -> Response:
+
+        if request.url.path in AUTH__EXCLUDED_PATHS:                                                 # allow for the seeing the docs and accessing the methods to set the cookie
+            return await call_next(request)
+
         if not self.api_key__name:
             return self.return_error(ERROR_MESSAGE__NO_KEY_NAME_SETUP)
         api_key_header = request.headers.get(self.api_key__name)                                     # Check for API key in headers

osbot_fast_api/api/routes/Routes__Set_Cookie.py

@@ -10,7 +10,7 @@ class Schema__Set_Cookie(Type_Safe):
 class Routes__Set_Cookie(Fast_API__Routes):
     tag: str = 'auth'
 
-    def auth_cookie_form(self, request: Request):   # Display form to edit auth cookie with JSON submission
+    def set_cookie_form(self, request: Request):   # Display form to edit auth cookie with JSON submission
         current_cookie = request.cookies.get(ENV_VAR__FAST_API__AUTH__API_KEY__NAME, '')
 
         html_content = f"""
@@ -125,5 +125,5 @@ def set_auth_cookie(self, set_cookie: Schema__Set_Cookie, response: Response):
         }
 
     def setup_routes(self):
-        self.add_route_get(self.auth_cookie_form)
+        self.add_route_get (self.set_cookie_form)
         self.add_route_post(self.set_auth_cookie)

osbot_fast_api/schemas/consts__Fast_API.py

@@ -2,6 +2,12 @@
 
 # todo: the names of these variables need a bit of refactoring and normalising
 
+AUTH__EXCLUDED_PATHS = [  '/auth/auth-cookie-form',
+                          '/auth/set-auth-cookie' ,
+                          '/docs'                 ,           # Maybe also exclude docs
+                          '/openapi.json'         ,
+                          '/config/status'        ] # Health check endpoint
+
 REGEX__SAFE__STR__FAST_API__TITLE       = re.compile(r'[^a-zA-Z0-9 _()-]')
 
 DEFAULT_ROUTES_PATHS                    = ['/', '/config/status', '/config/version']
@@ -17,17 +23,17 @@
                                             { 'http_methods': ['GET'       ], 'http_path': '/redoc'                , 'method_name': 'redoc_html'           }]
 
 
-EXPECTED_ROUTES_METHODS                 = ['auth_cookie_form',
-                                           'info'            ,
+EXPECTED_ROUTES_METHODS                 = ['info'            ,
                                            'redirect_to_docs',
                                            'routes__html'    ,
                                            'routes__json'    ,
                                            'set_auth_cookie' ,
+                                           'set_cookie_form' ,
                                            'status'          ,
                                            'version'         ]
 EXPECTED_ROUTES_PATHS                   = ['/'                     ,
-                                           '/auth/auth-cookie-form',
                                            '/auth/set-auth-cookie' ,
+                                           '/auth/set-cookie-form',
                                            '/config/info'          ,
                                            '/config/routes/html'   ,
                                            '/config/routes/json'   ,
@@ -41,7 +47,7 @@
                                            { 'http_methods': ['GET'       ], 'http_path': '/config/version'       , 'method_name': 'version'            },
                                            { 'http_methods': ['GET'       ], 'http_path': '/config/routes/json'   , 'method_name': 'routes__json'       },
                                            { 'http_methods': ['GET'       ], 'http_path': '/config/routes/html'   , 'method_name': 'routes__html'       },
-                                           { 'http_methods': ['GET'       ], 'http_path': '/auth/auth-cookie-form', 'method_name': 'auth_cookie_form'   },
+                                           { 'http_methods': ['GET'       ], 'http_path': '/auth/set-cookie-form' , 'method_name': 'set_cookie_form'    },
                                            { 'http_methods': ['POST'      ], 'http_path': '/auth/set-auth-cookie' , 'method_name': 'set_auth_cookie'    },]
 ROUTES__STATIC_DOCS                     = [{'http_methods': ['GET', 'HEAD'], 'http_path': '/static-docs'          , 'method_name': 'static-docs'        }]
 ROUTES_PATHS__CONFIG                    = ['/config/status', '/config/version']

tests/unit/api/test_Fast_API.py

@@ -1,5 +1,4 @@
 import re
-
 import pytest
 from unittest                                                        import TestCase
 from fastapi                                                         import FastAPI