FastAPI-UI-Auth 0.2.0__py3-none-any.whl → 0.2.1a0__py3-none-any.whl

{fastapi_ui_auth-0.2.0.dist-info → fastapi_ui_auth-0.2.1a0.dist-info}/METADATA

@@ -1,14 +1,14 @@
 Metadata-Version: 2.4
 Name: FastAPI-UI-Auth
-Version: 0.2.0
+Version: 0.2.1a0
 Summary: Python module to add username and password authentication to specific FastAPI routes
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: fastapi==0.115.*
-Requires-Dist: jinja2==3.1.*
-Requires-Dist: pydantic==2.11.*
-Requires-Dist: python-dotenv==1.1.*
+Requires-Dist: fastapi
+Requires-Dist: jinja2
+Requires-Dist: pydantic
+Requires-Dist: python-dotenv
 Provides-Extra: dev
 Requires-Dist: websockets==15.0.*; extra == "dev"
 Requires-Dist: pre-commit==4.2.*; extra == "dev"

fastapi_ui_auth-0.2.1a0.dist-info/RECORD

@@ -0,0 +1,18 @@
+fastapi_ui_auth-0.2.1a0.dist-info/licenses/LICENSE,sha256=_sOIKJWdD2o1WwwDIwYB2qTP2nlSWqT5Tyg9jr1Xa4w,1070
+uiauth/__init__.py,sha256=s8r2Z0O9w3cuw7GcmRTOWY0NZC0KJXzBS9QsG9wUWsk,264
+uiauth/endpoints.py,sha256=CJteXsGQWfn--U6_VdVN8VhnPsf3HSefYX1NOzAhacM,2837
+uiauth/enums.py,sha256=WO0eBv3l9HHr1I_ZXtAifCgdL-db_tZj9ka7jnjiS5k,547
+uiauth/logger.py,sha256=z67PBMs4zWOfy-Gfm_41dj5Uulm-ChvZxB_jmYKKXeI,391
+uiauth/models.py,sha256=dH207dqVybK_qPzzm2RuMxZBamoFm8zO5tk7jmyGStM,3719
+uiauth/secure.py,sha256=ZOH6kT4BD56VqwaKdKocX7eSE8tqZcu-tK0QOmjY58k,1089
+uiauth/service.py,sha256=DJnK9PsBg9CnWiIqWRt7Aa7ZXncTUm5W8jZmA9UJK5Q,6659
+uiauth/utils.py,sha256=DzXqxLpKHUDy1bxffg1cw0izqxcgmnCybSytywiPgbQ,6625
+uiauth/version.py,sha256=nJo0rYXinOLv3d1ZFH-u19fo0iIADpBZFIy8nNqi3wg,24
+uiauth/templates/index.html,sha256=n8tOiKXEUI4zBh1YOQNlH5MKNMRTQ2adH0QIuvrEcv4,9071
+uiauth/templates/logout.html,sha256=JrWBJCbK1E4NfrNipMsLzfJ_-Fs2C6D4S0B6O7JNoek,3504
+uiauth/templates/session.html,sha256=EL4gajOED3IcOnrALMiJ2SzJl2at8GFfruTuExhgOVI,3040
+uiauth/templates/unauthorized.html,sha256=ahv78zLM04_Lu83LdX0Ua_toKeP5JZkYsTCWCrfCvHA,3002
+fastapi_ui_auth-0.2.1a0.dist-info/METADATA,sha256=1mPPvL2iv9mXJmUBsPmAA7IdXtOQKNggEiR5mBkAKoc,3524
+fastapi_ui_auth-0.2.1a0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fastapi_ui_auth-0.2.1a0.dist-info/top_level.txt,sha256=ra3nGTbDTgQ7eChlkngJ7xGXhSCeFTWMvb_b6q8uPVA,7
+fastapi_ui_auth-0.2.1a0.dist-info/RECORD,,

uiauth/endpoints.py

@@ -1,7 +1,8 @@
+from fastapi.exceptions import HTTPException
 from fastapi.requests import Request
 from fastapi.responses import HTMLResponse
 
-from uiauth import enums, models, utils
+from uiauth import enums, logger, models, utils
 from uiauth.version import version
 
 
@@ -49,6 +50,30 @@ def login(request: Request) -> HTMLResponse:
     )
 
 
+def logout(request: Request) -> HTMLResponse:
+    """Render the logout page with the verification path and version.
+
+    Returns:
+        HTMLResponse:
+        Rendered HTML response for the logout page.
+    """
+    try:
+        utils.verify_session(request)
+    except (models.RedirectException, HTTPException):
+        logger.CUSTOM_LOGGER.warning("Invalid session")
+        return session(request)
+    return utils.deauthorize(
+        models.templates.TemplateResponse(
+            name="logout.html",
+            context={
+                "request": request,
+                "detail": "You have been successfully logged out.",
+                "version": f"v{version}",
+            },
+        ),
+    )
+
+
 def error(request: Request) -> HTMLResponse:
     """Error endpoint for the authenticator.
 

uiauth/models.py

@@ -4,7 +4,7 @@ from typing import Callable, Dict, List, Optional, Type
 
 from fastapi.routing import APIRoute, APIWebSocketRoute
 from fastapi.templating import Jinja2Templates
-from pydantic import BaseModel, Field, ValidationInfo, field_validator
+from pydantic import BaseModel, Field
 
 from uiauth.enums import APIMethods
 
@@ -32,30 +32,17 @@ def get_env(keys: List[str], default: Optional[str] = None) -> Optional[str]:
 
 
 class EnvConfig(BaseModel):
-    """Configuration for environment variables."""
+    """Configuration for environment variables.
 
-    username: str
-    password: str
+    >>> EnvConfig
 
-    # 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.
+    See Also:
+        - Tries to resolve username and password through kwargs.
+        - Uses environment variables as fallback.
+    """
 
-        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]])
+    username: str = Field(default_factory=lambda: get_env(("username", "user")))
+    password: str = Field(default_factory=lambda: get_env(("password", "pass")))
 
 
 env = EnvConfig

uiauth/service.py

@@ -132,6 +132,11 @@ class FastAPIUIAuth:
             endpoint=endpoints.login,
             methods=["GET"],
         )
+        logout_route = APIRoute(
+            path=enums.APIEndpoints.fastapi_logout,
+            endpoint=endpoints.logout,
+            methods=["GET"],
+        )
         error_route = APIRoute(
             path=enums.APIEndpoints.fastapi_error,
             endpoint=endpoints.error,
@@ -163,4 +168,6 @@ class FastAPIUIAuth:
                     dependencies=[Depends(utils.verify_session)],
                 )
             self.app.routes.append(secure_route)
-        self.app.routes.extend([login_route, session_route, verify_route, error_route])
+        self.app.routes.extend(
+            [login_route, logout_route, session_route, verify_route, error_route]
+        )

uiauth/templates/index.html

@@ -239,8 +239,8 @@
 </script>
 <footer>
     <div class="footer">
-        PyAPIAuthenticator - {{ version }}<br>
-        <a href="https://github.com/thevickypedia/pyapiauthenticator">https://github.com/thevickypedia/pyapiauthenticator</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>
 <script>

uiauth/templates/logout.html

@@ -0,0 +1,94 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <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">
+    <meta content="width=device-width, initial-scale=1" name="viewport">
+    <script src="https://code.jquery.com/jquery-3.6.4.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/crypto-js/3.1.9-1/crypto-js.js"></script>
+    <!-- Favicon.ico and Apple Touch Icon -->
+    <link property="og:image" rel="icon" href="https://thevickypedia.github.io/open-source/images/logo/fastapi.ico">
+    <link property="og:image" rel="apple-touch-icon"
+          href="https://thevickypedia.github.io/open-source/images/logo/fastapi.png">
+    <!-- Font Awesome icons -->
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/fontawesome.min.css">
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/solid.min.css">
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/regular.min.css">
+    <style>
+        img {
+            display: block;
+            margin-left: auto;
+            margin-right: auto;
+        }
+
+        :is(h1, h2, h3, h4, h5, h6) {
+            text-align: center;
+            color: #F0F0F0;
+            font-family: 'Courier New', sans-serif;
+        }
+
+        button {
+            width: 100px;
+            margin: 0 auto;
+            display: block;
+        }
+
+        body {
+            background-color: #151515;
+        }
+
+        footer {
+            bottom: 20px;
+            position: fixed;
+            width: 100%;
+            color: #fff;
+            text-align: center;
+            font-family: 'Courier New', monospace;
+            font-size: small;
+        }
+    </style>
+    <noscript>
+        <style>
+            body {
+                width: 100%;
+                height: 100%;
+                overflow: hidden;
+            }
+        </style>
+        <div style="position: fixed; text-align:center; height: 100%; width: 100%; background-color: #151515;">
+            <h2 style="margin-top:5%">This page requires JavaScript
+                to be enabled.
+                <br><br>
+                Please refer <a href="https://www.enable-javascript.com/">enable-javascript</a> for how to.
+            </h2>
+            <form>
+                <button type="submit" onClick="<meta httpEquiv='refresh' content='0'>">RETRY</button>
+            </form>
+        </div>
+    </noscript>
+</head>
+<body>
+<h2 style="margin-top:5%">LOGOUT</h2>
+<h3>{{ detail }}</h3>
+<p>
+    <img src="https://thevickypedia.github.io/open-source/images/gif/blended_fusion.gif"
+         onerror="this.src='https://vigneshrao.com/open-source/images/gif/blended_fusion.gif'"
+         width="200" height="200" alt="Image" class="center">
+</p>
+{% if show_login %}
+<button style="text-align:center" onClick="window.location.href = '/monitor';">LOGIN</button>
+{% else %}
+<h3>Please close the session window</h3>
+{% endif %}
+<h4>Click <a href="https://vigneshrao.com/contact">HERE</a> to reach out.</h4>
+</body>
+<footer>
+    <div class="footer">
+        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>

uiauth/version.py

@@ -1 +1 @@
-version = "0.2.0"
+version = "0.2.1-alpha"

fastapi_ui_auth-0.2.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-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,,