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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: FastAPI-UI-Auth
-Version: 0.1.1
+Version: 0.2.0
 Summary: Python module to add username and password authentication to specific FastAPI routes
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -15,7 +15,7 @@ Requires-Dist: pre-commit==4.2.*; extra == "dev"
 Requires-Dist: uvicorn==0.34.*; extra == "dev"
 Dynamic: license-file
 
-# FastAPIAuthenticator
+# FastAPIUIAuth
 
 Python module to add username and password authentication to specific FastAPI routes
 
@@ -25,20 +25,24 @@ Python module to add username and password authentication to specific FastAPI ro
 
 ![Platform][label-platform]
 
-## Installation
+**Deployments**
 
-```shell
-repo="thevickypedia/FastAPIAuthenticator"
+[![pypi][label-actions-pypi]][gha_pypi]
 
-latest=$(curl -s https://api.github.com/repos/${repo}/tags | jq -r '.[0].name')
+[![Pypi][label-pypi]][pypi]
+[![Pypi-format][label-pypi-format]][pypi-files]
+[![Pypi-status][label-pypi-status]][pypi]
 
-pip install "git+https://github.com/${repo}.git@${latest}"
+## Installation
+
+```shell
+pip install FastAPI-UI-Auth
 ```
 
 ## Usage
 
 ```python
-import fastapiauthenticator as api
+import uiauth
 
 from fastapi import FastAPI
 
@@ -51,16 +55,16 @@ async def public_route():
 async def private_route():
     return {"message": "This is a private route"}
 
-api.protect(
+uiauth.protect(
     app=app,
-    params=api.Parameters(
+    params=uiauth.Parameters(
         path="/private",
         function=private_route
     )
 )
 ```
 
-> `FastAPIAuthenticator` supports both `APIRoute` and `APIWebSocketRoute` routes.<br>
+> `FastAPI-UI-Auth` supports both `APIRoute` and `APIWebSocketRoute` routes.<br>
 > Refer [samples] directory for different use-cases.
 
 ## Coding Standards
@@ -90,6 +94,11 @@ python -m pip install sphinx==5.1.1 pre-commit recommonmark
 pre-commit run --all-files
 ```
 
+## Pypi Package
+[![pypi-module][label-pypi-package]][pypi-repo]
+
+[https://pypi.org/project/FastAPI-UI-Auth/][pypi]
+
 ## License & copyright
 
 &copy; Vignesh Rao
@@ -99,12 +108,23 @@ Licensed under the [MIT License][license]
 [//]: # (Labels)
 
 [3.11]: https://docs.python.org/3/whatsnew/3.11.html
-[license]: https://github.com/thevickypedia/FastAPIAuthenticator/blob/main/LICENSE
+[license]: https://github.com/thevickypedia/FastAPI-UI-Auth/blob/main/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
+[samples]: https://github.com/thevickypedia/FastAPI-UI-Auth/tree/main/samples
 
+[label-actions-pypi]: https://github.com/thevickypedia/FastAPI-UI-Auth/actions/workflows/python-publish.yml/badge.svg
+[label-pypi]: https://img.shields.io/pypi/v/FastAPI-UI-Auth
+[label-pypi-format]: https://img.shields.io/pypi/format/FastAPI-UI-Auth
+[label-pypi-status]: https://img.shields.io/pypi/status/FastAPI_UI_Auth
+[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-FastAPI_UI_Auth-blue?style=for-the-badge&logo=Python
 [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
-[release-notes]: https://github.com/thevickypedia/FastAPIAuthenticator/blob/main/release_notes.rst
+[release-notes]: https://github.com/thevickypedia/FastAPI-UI-Auth/blob/main/release_notes.rst
+
+[gha_pypi]: https://github.com/thevickypedia/FastAPI-UI-Auth/actions/workflows/python-publish.yml
+
+[pypi]: https://pypi.org/project/FastAPI-UI-Auth
+[pypi-files]: https://pypi.org/project/FastAPI-UI-Auth/#files
+[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/

fastapi_ui_auth-0.2.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+fastapi_ui_auth-0.2.0.dist-info/licenses/LICENSE,sha256=_sOIKJWdD2o1WwwDIwYB2qTP2nlSWqT5Tyg9jr1Xa4w,1070
+uiauth/__init__.py,sha256=s8r2Z0O9w3cuw7GcmRTOWY0NZC0KJXzBS9QsG9wUWsk,264
+uiauth/endpoints.py,sha256=4RtabYwlNSHAqpU89zfRH8RD_ATH1AAf-lJKg4HA1RQ,2076
+uiauth/enums.py,sha256=WO0eBv3l9HHr1I_ZXtAifCgdL-db_tZj9ka7jnjiS5k,547
+uiauth/logger.py,sha256=z67PBMs4zWOfy-Gfm_41dj5Uulm-ChvZxB_jmYKKXeI,391
+uiauth/models.py,sha256=lcJyy99c-VeSeUj3LahXisQZ4g3wRqdGtBVdL1oyaZI,4255
+uiauth/secure.py,sha256=ZOH6kT4BD56VqwaKdKocX7eSE8tqZcu-tK0QOmjY58k,1089
+uiauth/service.py,sha256=6CN3Rg8m3f83sJuLdswVzwkxkwkjptHgWa5uugxIccE,6460
+uiauth/utils.py,sha256=DzXqxLpKHUDy1bxffg1cw0izqxcgmnCybSytywiPgbQ,6625
+uiauth/version.py,sha256=XQVhijSHeIVMVzY2S4fY9BKxV2XHSTr9VVHsYltGPvQ,18
+uiauth/templates/index.html,sha256=8vbONgCdhBmwe12ITeuBSjwwjp309kDS9cu2lRrrG88,9080
+uiauth/templates/session.html,sha256=EL4gajOED3IcOnrALMiJ2SzJl2at8GFfruTuExhgOVI,3040
+uiauth/templates/unauthorized.html,sha256=ahv78zLM04_Lu83LdX0Ua_toKeP5JZkYsTCWCrfCvHA,3002
+fastapi_ui_auth-0.2.0.dist-info/METADATA,sha256=L10c3aWSYOwNnAQIcbVO4SzBVH7Xa6DhueQViFlmW_o,3553
+fastapi_ui_auth-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fastapi_ui_auth-0.2.0.dist-info/top_level.txt,sha256=ra3nGTbDTgQ7eChlkngJ7xGXhSCeFTWMvb_b6q8uPVA,7
+fastapi_ui_auth-0.2.0.dist-info/RECORD,,

fastapi_ui_auth-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+uiauth

uiauth/__init__.py

@@ -0,0 +1,6 @@
+from uiauth.enums import APIEndpoints, APIMethods  # noqa: F401,E402
+from uiauth.models import Parameters  # noqa: F401,E402
+from uiauth.service import FastAPIUIAuth  # noqa: F401,E402
+from uiauth.version import version  # noqa: F401,E402
+
+protect = FastAPIUIAuth

{fastapiauthenticator → uiauth}/endpoints.py

@@ -1,8 +1,8 @@
 from fastapi.requests import Request
 from fastapi.responses import HTMLResponse
 
-from fastapiauthenticator import enums, models, utils
-from fastapiauthenticator.version import version
+from uiauth import enums, models, utils
+from uiauth.version import version
 
 
 def session(request: Request) -> HTMLResponse:

uiauth/logger.py

@@ -0,0 +1,13 @@
+"""Default logger for FastAPI-UI-Auth package."""
+
+import logging
+import sys
+
+CUSTOM_LOGGER = logging.getLogger(__name__)
+CUSTOM_LOGGER.setLevel(logging.DEBUG)
+CONSOLE_HANDLER = logging.StreamHandler(sys.stdout)
+CONSOLE_FORMATTER = logging.Formatter(
+    fmt="%(levelname)-9s %(message)s",
+)
+CONSOLE_HANDLER.setFormatter(fmt=CONSOLE_FORMATTER)
+CUSTOM_LOGGER.addHandler(hdlr=CONSOLE_HANDLER)

{fastapiauthenticator → uiauth}/models.py

@@ -1,15 +1,66 @@
+import os
 import pathlib
 from typing import Callable, Dict, List, Optional, Type
 
 from fastapi.routing import APIRoute, APIWebSocketRoute
 from fastapi.templating import Jinja2Templates
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, ValidationInfo, field_validator
 
-from fastapiauthenticator.enums import APIMethods
+from uiauth.enums import APIMethods
 
 templates = Jinja2Templates(directory=pathlib.Path(__file__).parent / "templates")
 
 
+def get_env(keys: List[str], default: Optional[str] = None) -> Optional[str]:
+    """Get environment variable value.
+
+    Args:
+        keys: List of environment variable names to check.
+        default: Default value if the environment variable is not set.
+
+    Returns:
+        Value of the environment variable or default value.
+    """
+    for key in keys:
+        if value := os.getenv(key):
+            return value
+        if value := os.getenv(key.upper()):
+            return value
+        if value := os.getenv(key.lower()):
+            return value
+    return default
+
+
+class EnvConfig(BaseModel):
+    """Configuration for environment variables."""
+
+    username: str
+    password: str
+
+    # noinspection PyMethodParameters
+    @field_validator("username", "password", mode="before")
+    def load_user(cls, key: str, field: ValidationInfo) -> str | None:
+        """Load environment variables into the configuration.
+
+        Args:
+            key: Environment variable key to check.
+            field: Field information for validation.
+
+        See Also:
+            - This method checks if the environment variable is set and returns its value.
+            - If the key is not set, it attempts to get the value from the environment using a helper function.
+
+        Returns:
+            str | None:
+            Value of the environment variable or None if not set.
+        """
+        if not key:
+            return get_env([field.field_name, field.field_name[:4]])
+
+
+env = EnvConfig
+
+
 class Parameters(BaseModel):
     """Parameters for the Authenticator class.
 

{fastapiauthenticator → uiauth}/service.py

@@ -1,5 +1,4 @@
 import logging
-import os
 from threading import Timer
 from typing import Dict, List
 
@@ -13,18 +12,17 @@ from fastapi.responses import Response
 from fastapi.routing import APIRoute, APIWebSocketRoute
 from fastapi.security import HTTPAuthorizationCredentials, HTTPBearer
 
-from fastapiauthenticator import endpoints, enums, models, utils
+from uiauth import endpoints, enums, logger, models, utils
 
 dotenv.load_dotenv(dotenv_path=dotenv.find_dotenv(), override=True)
-LOGGER = logging.getLogger("uvicorn.default")
 BEARER_AUTH = HTTPBearer()
 
 
 # noinspection PyDefaultArgument
-class Authenticator:
-    """Authenticator is a FastAPI integration that provides authentication for secure routes.
+class FastAPIUIAuth:
+    """FastAPIUIAuth is a FastAPI integration that provides authentication for secure routes.
 
-    >>> Authenticator
+    >>> FastAPIUIAuth
 
     """
 
@@ -33,10 +31,11 @@ class Authenticator:
         app: FastAPI,
         params: models.Parameters | List[models.Parameters],
         timeout: int = 300,
-        username: str = os.environ.get("USERNAME"),
-        password: str = os.environ.get("PASSWORD"),
+        username: str = None,
+        password: str = None,
         fallback_button: str = models.fallback.button,
         fallback_path: str = models.fallback.path,
+        custom_logger: logging.Logger = None,
     ):
         """Initialize the APIAuthenticator with the FastAPI app and secure function.
 
@@ -48,8 +47,9 @@ class Authenticator:
             password: Password for authentication, can be set via environment variable 'PASSWORD'.
             fallback_button: Title for the fallback button, defaults to "LOGIN".
             fallback_path: Fallback path to redirect to in case of session timeout or invalid session.
+            custom_logger: Custom logger instance, defaults to the custom logger.
         """
-        assert all((username, password)), "'username' and 'password' are mandatory."
+        models.env = models.EnvConfig(username=username, password=password)
         assert fallback_path.startswith("/"), "Fallback path must start with '/'"
 
         self.app = app
@@ -68,11 +68,15 @@ class Authenticator:
             handler=utils.redirect_exception_handler,
         )
 
-        self.username = username
-        self.password = password
+        if custom_logger:
+            assert isinstance(
+                custom_logger, logging.Logger
+            ), "Custom logger must be an instance of logging.Logger"
+            logger.CUSTOM_LOGGER = custom_logger
         self.timeout = timeout
 
         self._secure()
+        logger.CUSTOM_LOGGER.debug("Endpoints registered: %s", len(self.params))
 
     def _verify_auth(
         self,
@@ -94,11 +98,11 @@ class Authenticator:
         session_token = utils.verify_login(
             authorization=authorization,
             request=request,
-            env_username=self.username,
-            env_password=self.password,
         )
         if destination := request.cookies.get("X-Requested-By"):
-            LOGGER.info("Setting session timeout for %s seconds", self.timeout)
+            logger.CUSTOM_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",

{fastapiauthenticator → uiauth}/templates/index.html

@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-    <title>FastAPI - Authenticator</title>
+    <title>FastAPI UI Authentication</title>
     <meta property="og:type" content="Authenticator">
     <meta name="keywords" content="Python, fastapi, JavaScript, HTML, CSS">
     <meta name="author" content="Vignesh Rao">

{fastapiauthenticator → uiauth}/templates/session.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-    <title>FastAPI - Authenticator</title>
+    <title>FastAPI UI Authentication</title>
     <meta property="og:type" content="Authenticator">
     <meta name="keywords" content="Python, fastapi, JavaScript, HTML, CSS">
     <meta name="author" content="Vignesh Rao">
@@ -79,8 +79,8 @@
 </body>
 <footer>
     <div class="footer">
-        FastAPIAuthenticator - {{ version }}<br>
-        <a href="https://github.com/thevickypedia/FastAPIAuthenticator">https://github.com/thevickypedia/FastAPIAuthenticator</a>
+        FastAPI-UI-Auth - {{ version }}<br>
+        <a href="https://github.com/thevickypedia/FastAPI-UI-Auth">https://github.com/thevickypedia/FastAPI-UI-Auth</a>
     </div>
 </footer>
 </html>

{fastapiauthenticator → uiauth}/templates/unauthorized.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-    <title>FastAPI - Authenticator</title>
+    <title>FastAPI UI Authentication</title>
     <meta property="og:type" content="Authenticator">
     <meta name="keywords" content="Python, fastapi, JavaScript, HTML, CSS">
     <meta name="author" content="Vignesh Rao">
@@ -79,8 +79,8 @@
 </body>
 <footer>
     <div class="footer">
-        FastAPIAuthenticator - {{ version }}<br>
-        <a href="https://github.com/thevickypedia/FastAPIAuthenticator">https://github.com/thevickypedia/FastAPIAuthenticator</a>
+        FastAPI-UI-Auth - {{ version }}<br>
+        <a href="https://github.com/thevickypedia/FastAPI-UI-Auth">https://github.com/thevickypedia/FastAPI-UI-Auth</a>
     </div>
 </footer>
 </html>

{fastapiauthenticator → uiauth}/utils.py

@@ -1,4 +1,3 @@
-import logging
 import secrets
 from typing import List, NoReturn
 
@@ -9,9 +8,7 @@ from fastapi.responses import HTMLResponse, JSONResponse, RedirectResponse
 from fastapi.security import HTTPAuthorizationCredentials
 from fastapi.websockets import WebSocket
 
-from fastapiauthenticator import enums, models, secure
-
-LOGGER = logging.getLogger("uvicorn.default")
+from uiauth import enums, logger, models, secure
 
 
 def failed_auth_counter(request: Request) -> None:
@@ -62,7 +59,7 @@ def raise_error(request: Request) -> NoReturn:
         request: Request object containing client information.
     """
     failed_auth_counter(request)
-    LOGGER.error(
+    logger.CUSTOM_LOGGER.error(
         "Incorrect username or password: %d",
         models.ws_session.invalid[request.client.host],
     )
@@ -88,16 +85,12 @@ def extract_credentials(authorization: HTTPAuthorizationCredentials) -> List[str
 def verify_login(
     authorization: HTTPAuthorizationCredentials,
     request: Request,
-    env_username: str,
-    env_password: str,
 ) -> str | NoReturn:
     """Verifies authentication and generates session token for each user.
 
     Args:
         authorization: Authorization header from the request.
         request: Request object containing client information.
-        env_username: Environment variable for the username.
-        env_password: Environment variable for the password.
 
     Returns:
         str:
@@ -107,11 +100,11 @@ def verify_login(
         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)
+    if secrets.compare_digest(username, models.env.username):
+        hex_user = secure.hex_encode(models.env.username)
+        hex_pass = secure.hex_encode(models.env.password)
     else:
-        LOGGER.warning("User '%s' not allowed", username)
+        logger.CUSTOM_LOGGER.warning("User '%s' not allowed", models.env.username)
         raise_error(request)
     message = f"{hex_user}{hex_pass}{timestamp}"
     expected_signature = secure.calculate_hash(message)
@@ -151,10 +144,10 @@ def verify_session(
         and session_token
         and secrets.compare_digest(session_token, stored_token)
     ):
-        LOGGER.info("Session is valid for host: %s", request.client.host)
+        logger.CUSTOM_LOGGER.info("Session is valid for host: %s", request.client.host)
         return
     elif not session_token:
-        LOGGER.warning(
+        logger.CUSTOM_LOGGER.warning(
             "Session is invalid or expired for host: %s", request.client.host
         )
         raise models.RedirectException(
@@ -162,7 +155,7 @@ def verify_session(
             destination=enums.APIEndpoints.fastapi_login,
         )
     else:
-        LOGGER.warning(
+        logger.CUSTOM_LOGGER.warning(
             "Session token mismatch for host: %s. Expected: %s, Received: %s",
             request.client.host,
             stored_token,
@@ -198,6 +191,6 @@ def clear_session(host: str) -> None:
     """
     if models.ws_session.client_auth.get(host):
         models.ws_session.client_auth.pop(host)
-        LOGGER.info("Session cleared for host: %s", host)
+        logger.CUSTOM_LOGGER.info("Session cleared for host: %s", host)
     else:
-        LOGGER.warning("No session found for host: %s", host)
+        logger.CUSTOM_LOGGER.warning("No session found for host: %s", host)

uiauth/version.py

@@ -0,0 +1 @@
+version = "0.2.0"

fastapi_ui_auth-0.1.1.dist-info/RECORD

@@ -1,16 +0,0 @@
-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=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.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,,

fastapi_ui_auth-0.1.1.dist-info/top_level.txt

@@ -1 +0,0 @@
-fastapiauthenticator

fastapiauthenticator/__init__.py

@@ -1,6 +0,0 @@
-from fastapiauthenticator.enums import APIEndpoints, APIMethods  # noqa: F401,E402
-from fastapiauthenticator.models import Parameters  # noqa: F401,E402
-from fastapiauthenticator.service import Authenticator  # noqa: F401,E402
-from fastapiauthenticator.version import version  # noqa: F401,E402
-
-protect = Authenticator

fastapiauthenticator/version.py

@@ -1 +0,0 @@
-version = "0.1.1"