FastAPI-UI-Auth 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

{fastapi_ui_auth-0.1.0.dist-info → fastapi_ui_auth-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: FastAPI-UI-Auth
-Version: 0.1.0
+Version: 0.1.1
 Summary: Python module to add username and password authentication to specific FastAPI routes
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -10,6 +10,7 @@ Requires-Dist: jinja2==3.1.*
 Requires-Dist: pydantic==2.11.*
 Requires-Dist: python-dotenv==1.1.*
 Provides-Extra: dev
+Requires-Dist: websockets==15.0.*; extra == "dev"
 Requires-Dist: pre-commit==4.2.*; extra == "dev"
 Requires-Dist: uvicorn==0.34.*; extra == "dev"
 Dynamic: license-file
@@ -37,25 +38,31 @@ pip install "git+https://github.com/${repo}.git@${latest}"
 ## Usage
 
 ```python
-import fastapiauthenticator
+import fastapiauthenticator as api
 
 from fastapi import FastAPI
 
 app = FastAPI()
 
-
 @app.get("/public")
-def public_route():
+async def public_route():
     return {"message": "This is a public route"}
 
-
-def private_route():
+async def private_route():
     return {"message": "This is a private route"}
 
-
-fastapiauthenticator.Authenticator(app=app, secure_function=private_route)
+api.protect(
+    app=app,
+    params=api.Parameters(
+        path="/private",
+        function=private_route
+    )
+)
 ```
 
+> `FastAPIAuthenticator` supports both `APIRoute` and `APIWebSocketRoute` routes.<br>
+> Refer [samples] directory for different use-cases.
+
 ## Coding Standards
 Docstring format: [`Google`][google-docs] <br>
 Styling conventions: [`PEP 8`][pep8] and [`isort`][isort]
@@ -96,6 +103,7 @@ Licensed under the [MIT License][license]
 [google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
 [pep8]: https://www.python.org/dev/peps/pep-0008/
 [isort]: https://pycqa.github.io/isort/
+[samples]: https://github.com/thevickypedia/FastAPIAuthenticator/tree/main/samples
 
 [label-pyversion]: https://img.shields.io/badge/python-3.11%20%7C%203.12-blue
 [label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg

{fastapi_ui_auth-0.1.0.dist-info → fastapi_ui_auth-0.1.1.dist-info}/RECORD

@@ -1,16 +1,16 @@
-fastapi_ui_auth-0.1.0.dist-info/licenses/LICENSE,sha256=_sOIKJWdD2o1WwwDIwYB2qTP2nlSWqT5Tyg9jr1Xa4w,1070
+fastapi_ui_auth-0.1.1.dist-info/licenses/LICENSE,sha256=_sOIKJWdD2o1WwwDIwYB2qTP2nlSWqT5Tyg9jr1Xa4w,1070
 fastapiauthenticator/__init__.py,sha256=H1tJUJp4FWweEu2JeMw5vmqjtMhMwR4kUd11ek8UmwQ,320
 fastapiauthenticator/endpoints.py,sha256=PF2qu6XQ3MQStFEprRYYxiS6Dl6ukYaMqEkSlO-F3Ls,2104
 fastapiauthenticator/enums.py,sha256=WO0eBv3l9HHr1I_ZXtAifCgdL-db_tZj9ka7jnjiS5k,547
 fastapiauthenticator/models.py,sha256=GxmQfSvg70OTsvswJ3QFq_lxq-Yz1fIfzW6x8d4Sj40,2726
 fastapiauthenticator/secure.py,sha256=ZOH6kT4BD56VqwaKdKocX7eSE8tqZcu-tK0QOmjY58k,1089
-fastapiauthenticator/service.py,sha256=1UCCUf7yaH11BHB2vlaNYehVn5YyWbGK6bnrN7wJlDM,6485
-fastapiauthenticator/utils.py,sha256=geO78AL-nqv4EANQzQaWI2mGkkZiLZY8wm2LH_EDye0,7145
-fastapiauthenticator/version.py,sha256=aOHawL1zuHMfBWKXqwUkXcW96oXLNCY-CXdHDqkz4g4,18
+fastapiauthenticator/service.py,sha256=7E474kwPIDsbtZPMGJTSo0thKc2FP2n-MUogsH0ZrZI,6247
+fastapiauthenticator/utils.py,sha256=Is7oaaHYsZ97aPmDWTcIqStW693HRIDUKtkGBdfyMVg,6731
+fastapiauthenticator/version.py,sha256=I4WU5JcKZjfggPiNIoGDFxUDB05Ym1xFhbC3J_MjilA,18
 fastapiauthenticator/templates/index.html,sha256=mA2R6gk6lvibq_AmPgGHBFQijYtNUD7IIfeBSJWQrM4,9078
 fastapiauthenticator/templates/session.html,sha256=LUCvcEdQOjfIXjRZ2gPx2s5wyzNuCve4OMge0hXaBLM,3053
 fastapiauthenticator/templates/unauthorized.html,sha256=UZo1Jt64-CFfjwWTGicUMdHVWkYkXCJBRxvit4QTiQM,3015
-fastapi_ui_auth-0.1.0.dist-info/METADATA,sha256=taS1d_w3xCMVJB5ymIbhjlM7GpWIfCPEf8PyR9u4pRQ,2402
-fastapi_ui_auth-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-fastapi_ui_auth-0.1.0.dist-info/top_level.txt,sha256=EpDRP7uLM0f-Vd5rUtLBh4MTMAnpXzw1pr0DSknW_Ds,21
-fastapi_ui_auth-0.1.0.dist-info/RECORD,,
+fastapi_ui_auth-0.1.1.dist-info/METADATA,sha256=cmKRN9LBPNgKnm66iKXZaAkBasddHo2vs5ISjFw9HJE,2733
+fastapi_ui_auth-0.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fastapi_ui_auth-0.1.1.dist-info/top_level.txt,sha256=EpDRP7uLM0f-Vd5rUtLBh4MTMAnpXzw1pr0DSknW_Ds,21
+fastapi_ui_auth-0.1.1.dist-info/RECORD,,

fastapiauthenticator/service.py

@@ -42,7 +42,7 @@ class Authenticator:
 
         Args:
             app: FastAPI application instance to which the authenticator will be added.
-            params: Parameters for the secure routes, can be a single `Parameters` object or a list of `Parameters`.
+            params: Parameters for the secure routes can be a single `Parameters` object or a list of `Parameters`.
             timeout: Session timeout in seconds, default is 300 seconds (5 minutes).
             username: Username for authentication, can be set via environment variable 'USERNAME'.
             password: Password for authentication, can be set via environment variable 'PASSWORD'.
@@ -59,10 +59,6 @@ class Authenticator:
         elif isinstance(params, models.Parameters):
             self.params = [params]
 
-        self.route_map: Dict[str, models.Parameters] = {
-            param.path: param for param in self.params if param.route is APIRoute
-        }
-
         models.fallback.path = fallback_path
         models.fallback.button = fallback_button
 
@@ -95,19 +91,18 @@ class Authenticator:
             Dict[str, str]:
             A dictionary containing the redirect URL to the secure path.
         """
-        utils.verify_login(
+        session_token = utils.verify_login(
             authorization=authorization,
             request=request,
             env_username=self.username,
             env_password=self.password,
         )
-        destination = request.cookies.get("X-Requested-By")
-        if parameter := self.route_map.get(destination):
+        if destination := request.cookies.get("X-Requested-By"):
             LOGGER.info("Setting session timeout for %s seconds", self.timeout)
             # Set session_token cookie with a timeout, to be used for session validation when redirected
             response.set_cookie(
                 key="session_token",
-                value=models.ws_session.client_auth[request.client.host].get("token"),
+                value=session_token,
                 httponly=True,
                 samesite="strict",
                 max_age=self.timeout,
@@ -118,7 +113,7 @@ class Authenticator:
                 args=(request.client.host,),
                 interval=self.timeout,
             ).start()
-            return {"redirect_url": parameter.path}
+            return {"redirect_url": destination}
         raise HTTPException(
             status_code=status.HTTP_417_EXPECTATION_FAILED,
             detail="Unable to find secure route for the requested path.\n"
@@ -154,14 +149,14 @@ class Authenticator:
                 secure_route = APIWebSocketRoute(
                     path=param.path,
                     endpoint=param.function,
-                    dependencies=[Depends(utils.session_check)],
+                    dependencies=[Depends(utils.verify_session)],
                 )
             else:
                 secure_route = APIRoute(
                     path=param.path,
                     endpoint=param.function,
                     methods=["GET"],
-                    dependencies=[Depends(utils.session_check)],
+                    dependencies=[Depends(utils.verify_session)],
                 )
             self.app.routes.append(secure_route)
         self.app.routes.extend([login_route, session_route, verify_route, error_route])

fastapiauthenticator/utils.py

@@ -1,6 +1,6 @@
 import logging
 import secrets
-from typing import Dict, List, NoReturn, Union
+from typing import List, NoReturn
 
 from fastapi import status
 from fastapi.exceptions import HTTPException
@@ -73,17 +73,12 @@ def raise_error(request: Request) -> NoReturn:
     )
 
 
-def extract_credentials(
-    authorization: HTTPAuthorizationCredentials, host: str
-) -> List[str]:
+def extract_credentials(authorization: HTTPAuthorizationCredentials) -> List[str]:
     """Extract the credentials from ``Authorization`` headers and decode it before returning as a list of strings.
 
     Args:
         authorization: Authorization header from the request.
-        host: Host header from the request.
     """
-    if not authorization:
-        raise_error(host)
     decoded_auth = secure.base64_decode(authorization.credentials)
     # convert hex to a string
     auth = secure.hex_decode(decoded_auth)
@@ -95,7 +90,7 @@ def verify_login(
     request: Request,
     env_username: str,
     env_password: str,
-) -> Dict[str, Union[str, int]]:
+) -> str | NoReturn:
     """Verifies authentication and generates session token for each user.
 
     Args:
@@ -105,12 +100,13 @@ def verify_login(
         env_password: Environment variable for the password.
 
     Returns:
-        Dict[str, str]:
-        Returns a dictionary with the payload required to create the session token.
+        str:
+        Returns the session token.
     """
-    username, signature, timestamp = extract_credentials(
-        authorization, request.client.host
-    )
+    if authorization:
+        username, signature, timestamp = extract_credentials(authorization)
+    else:
+        raise_error(request)
     if secrets.compare_digest(username, env_username):
         hex_user = secure.hex_encode(env_username)
         hex_pass = secure.hex_encode(env_password)
@@ -122,15 +118,14 @@ def verify_login(
     if secrets.compare_digest(signature, expected_signature):
         models.ws_session.invalid[request.client.host] = 0
         key = secrets.token_urlsafe(64)
-        # fixme: By setting a path instead of timestamp, this can handle path specific sessions
-        models.ws_session.client_auth[request.client.host] = dict(
-            username=username, token=key, timestamp=int(timestamp)
-        )
-        return models.ws_session.client_auth[request.client.host]
+        models.ws_session.client_auth[request.client.host] = key
+        return key
     raise_error(request)
 
 
-def session_check(api_request: Request = None, api_websocket: WebSocket = None) -> None:
+def verify_session(
+    api_request: Request = None, api_websocket: WebSocket = None
+) -> None:
     """Check if the session is still valid.
 
     Args:
@@ -150,9 +145,7 @@ def session_check(api_request: Request = None, api_websocket: WebSocket = None)
             detail="Request or WebSocket connection is required for session check.",
         )
     session_token = request.cookies.get("session_token")
-    stored_token = models.ws_session.client_auth.get(request.client.host, {}).get(
-        "token"
-    )
+    stored_token = models.ws_session.client_auth.get(request.client.host)
     if (
         stored_token
         and session_token

fastapiauthenticator/version.py

@@ -1 +1 @@
-version = "0.1.0"
+version = "0.1.1"