zrb 1.7.4__py3-none-any.whl → 1.8.0__py3-none-any.whl

zrb/runner/web_auth_config.py

@@ -0,0 +1,189 @@
+from typing import Callable
+
+from zrb.config import CFG
+from zrb.runner.web_schema.user import User
+from zrb.task.any_task import AnyTask
+
+
+class WebAuthConfig:
+    def __init__(
+        self,
+        port: int | None = None,
+        secret_key: str | None = None,
+        access_token_expire_minutes: int | None = None,
+        refresh_token_expire_minutes: int | None = None,
+        access_token_cookie_name: str | None = None,
+        refresh_token_cookie_name: str | None = None,
+        enable_auth: bool | None = None,
+        super_admin_username: str | None = None,
+        super_admin_password: str | None = None,
+        guest_username: str | None = None,
+        guest_accessible_tasks: list[AnyTask | str] = [],
+        find_user_by_username: Callable[[str], User | None] | None = None,
+    ):
+        self._port = port
+        self._secret_key = secret_key
+        self._access_token_expire_minutes = access_token_expire_minutes
+        self._refresh_token_expire_minutes = refresh_token_expire_minutes
+        self._access_token_cookie_name = access_token_cookie_name
+        self._refresh_token_cookie_name = refresh_token_cookie_name
+        self._enable_auth = enable_auth
+        self._super_admin_username = super_admin_username
+        self._super_admin_password = super_admin_password
+        self._guest_username = guest_username
+        self._user_list = []
+        self._guest_accessible_tasks = guest_accessible_tasks
+        self._find_user_by_username = find_user_by_username
+
+    @property
+    def port(self) -> int:
+        if self._port is not None:
+            return self._port
+        return CFG.WEB_HTTP_PORT
+
+    @property
+    def secret_key(self) -> str:
+        if self._secret_key is not None:
+            return self._secret_key
+        return CFG.WEB_SECRET_KEY
+
+    @property
+    def access_token_expire_minutes(self) -> int:
+        if self._access_token_expire_minutes is not None:
+            return self._access_token_expire_minutes
+        return CFG.WEB_AUTH_ACCESS_TOKEN_EXPIRE_MINUTES
+
+    @property
+    def refresh_token_expire_minutes(self) -> int:
+        if self._refresh_token_expire_minutes is not None:
+            return self._refresh_token_expire_minutes
+        return CFG.WEB_AUTH_REFRESH_TOKEN_EXPIRE_MINUTES
+
+    @property
+    def access_token_cookie_name(self) -> str:
+        if self._access_token_cookie_name is not None:
+            return self._access_token_cookie_name
+        return CFG.WEB_ACCESS_TOKEN_COOKIE_NAME
+
+    @property
+    def refresh_token_cookie_name(self) -> str:
+        if self._refresh_token_cookie_name is not None:
+            return self._refresh_token_cookie_name
+        return CFG.WEB_REFRESH_TOKEN_COOKIE_NAME
+
+    @property
+    def enable_auth(self) -> bool:
+        if self._enable_auth is not None:
+            return self._enable_auth
+        return CFG.WEB_ENABLE_AUTH
+
+    @property
+    def super_admin_username(self) -> str:
+        if self._super_admin_username is not None:
+            return self._super_admin_username
+        return CFG.WEB_SUPER_ADMIN_USERNAME
+
+    @property
+    def super_admin_password(self) -> str:
+        if self._super_admin_password is not None:
+            return self._super_admin_password
+        return CFG.WEB_SUPER_ADMIN_PASSWORD
+
+    @property
+    def guest_username(self) -> str:
+        if self._guest_username is not None:
+            return self._guest_username
+        return CFG.WEB_GUEST_USERNAME
+
+    @property
+    def guest_accessible_tasks(self) -> list[AnyTask | str]:
+        return self._guest_accessible_tasks
+
+    @property
+    def default_user(self) -> User:
+        if self.enable_auth:
+            return User(
+                username=self.guest_username,
+                password="",
+                is_guest=True,
+                accessible_tasks=self.guest_accessible_tasks,
+            )
+        return User(
+            username=self.guest_username,
+            password="",
+            is_guest=True,
+            is_super_admin=True,
+        )
+
+    @property
+    def super_admin(self) -> User:
+        return User(
+            username=self.super_admin_username,
+            password=self.super_admin_password,
+            is_super_admin=True,
+        )
+
+    @property
+    def user_list(self) -> list[User]:
+        if not self.enable_auth:
+            return [self.default_user]
+        return self._user_list + [self.super_admin, self.default_user]
+
+    def set_port(self, port: int):
+        self._port = port
+
+    def set_secret_key(self, secret_key: str):
+        self._secret_key = secret_key
+
+    def set_access_token_expire_minutes(self, minutes: int):
+        self._access_token_expire_minutes = minutes
+
+    def set_refresh_token_expire_minutes(self, minutes: int):
+        self._refresh_token_expire_minutes = minutes
+
+    def set_access_token_cookie_name(self, name: str):
+        self._access_token_cookie_name = name
+
+    def set_refresh_token_cookie_name(self, name: str):
+        self._refresh_token_cookie_name = name
+
+    def set_enable_auth(self, enable: bool):
+        self._enable_auth = enable
+
+    def set_super_admin_username(self, username: str):
+        self._super_admin_username = username
+
+    def set_super_admin_password(self, password: str):
+        self._super_admin_password = password
+
+    def set_guest_username(self, username: str):
+        self._guest_username = username
+
+    def set_guest_accessible_tasks(self, tasks: list[AnyTask | str]):
+        self._guest_accessible_tasks = tasks
+
+    def set_find_user_by_username(
+        self, find_user_by_username: Callable[[str], User | None]
+    ):
+        self._find_user_by_username = find_user_by_username
+
+    def append_user(self, user: User):
+        duplicates = [
+            existing_user
+            for existing_user in self.user_list
+            if existing_user.username == user.username
+        ]
+        if len(duplicates) > 0:
+            raise ValueError(f"User already exists {user.username}")
+        self._user_list.append(user)
+
+    def find_user_by_username(self, username: str) -> User | None:
+        user = None
+        if self._find_user_by_username is not None:
+            user = self._find_user_by_username(username)
+        if user is None:
+            user = next((u for u in self.user_list if u.username == username), None)
+        return user
+
+
+web_auth_config = WebAuthConfig()

zrb/runner/web_route/docs_route.py

@@ -1,5 +1,7 @@
 from typing import TYPE_CHECKING
 
+from zrb.config import CFG
+
 if TYPE_CHECKING:
     # We want fastapi to only be loaded when necessary to decrease footprint
     from fastapi import FastAPI
@@ -12,6 +14,6 @@ def serve_docs(app: "FastAPI") -> None:
     async def swagger_ui_html():
         return get_swagger_ui_html(
             openapi_url="/openapi.json",
-            title="Zrb",
-            swagger_favicon_url="/static/favicon-32x32.png",
+            title=CFG.WEB_TITLE,
+            swagger_favicon_url=CFG.WEB_FAVICON_PATH,
         )

zrb/runner/web_route/error_page/serve_default_404.py

@@ -1,7 +1,7 @@
 from typing import TYPE_CHECKING
 
 from zrb.group.any_group import AnyGroup
-from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_auth_config import WebAuthConfig
 from zrb.runner.web_route.error_page.show_error_page import show_error_page
 from zrb.runner.web_util.user import get_user_from_request
 
@@ -13,7 +13,7 @@ if TYPE_CHECKING:
 def serve_default_404(
     app: "FastAPI",
     root_group: AnyGroup,
-    web_config: WebConfig,
+    web_auth_config: WebAuthConfig,
 ) -> None:
     from fastapi import Request
     from fastapi.exception_handlers import http_exception_handler
@@ -24,5 +24,5 @@ def serve_default_404(
         if request.url.path.startswith("/api"):
             # Re-raise the exception to let FastAPI handle it
             return await http_exception_handler(request, exc)
-        user = await get_user_from_request(web_config, request)
+        user = await get_user_from_request(web_auth_config, request)
         return show_error_page(user, root_group, 404, "Not found")

zrb/runner/web_route/error_page/show_error_page.py

@@ -21,7 +21,8 @@ def show_error_page(user: User, root_group: AnyGroup, status_code: int, message:
         fstring_format(
             _GLOBAL_TEMPLATE,
             {
-                "web_title": CFG.WEB_TITLE,
+                "CFG": CFG,
+                "root_group": root_group,
                 "content": fstring_format(
                     _VIEW_TEMPLATE,
                     {

zrb/runner/web_route/error_page/view.html

@@ -1,39 +1,22 @@
-<!doctype html>
-<html lang="en">
-
-    <head>
-        <meta charset="utf-8">
-        <meta name="viewport" content="width=device-width, initial-scale=1">
-        <meta name="color-scheme" content="light dark">
-        <link rel="stylesheet" href="/static/pico.min.css">
-        <link rel="icon" href="/static/favicon-32x32.png" sizes="32x32" type="image/png">
-        <title>Zrb</title>
-        <link rel="stylesheet" href="/static/common.css">
-    </head>
-
-    <body>
-        <header class="container">
-            <hgroup>
-                <h1>{name}</h1>
-                <p>{description}</p>
-                <nav>
-                    <ul>
-                        <li><a href="/">🏠 Home</a></li>
-                        <li><a href="/docs">💻 API Documentation</a></li>
-                    </ul>
-                    <ul>
-                        <li>{auth_link}</li>
-                    </ul>
-                </nav>
-            </hgroup>
-        </header>
-        <main class="container">
-            <article>
-                <h2>{error_status_code}</h2>
-                <p>{error_message}</p>
-            </article>
-        </main>
-    </body>
-    <script src="/refresh-token.js"></script>
-
-</html>
+<header class="container">
+    <hgroup>
+        <h1>{name}</h1>
+        <p>{description}</p>
+        <nav>
+            <ul>
+                <li><a href="/">🏠 Home</a></li>
+                <li><a href="/docs">💻 API Documentation</a></li>
+            </ul>
+            <ul>
+                <li>{auth_link}</li>
+            </ul>
+        </nav>
+    </hgroup>
+</header>
+<main class="container">
+    <article>
+        <h2>{error_status_code}</h2>
+        <p>{error_message}</p>
+    </article>
+</main>
+<script src="/refresh-token.js"></script>

zrb/runner/web_route/home_page/home_page_route.py

@@ -3,7 +3,7 @@ from typing import TYPE_CHECKING
 
 from zrb.config import CFG
 from zrb.group.any_group import AnyGroup
-from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_auth_config import WebAuthConfig
 from zrb.runner.web_util.html import (
     get_html_auth_link,
     get_html_subgroup_info,
@@ -21,7 +21,7 @@ if TYPE_CHECKING:
 def serve_home_page(
     app: "FastAPI",
     root_group: AnyGroup,
-    web_config: WebConfig,
+    web_auth_config: WebAuthConfig,
 ) -> None:
     from fastapi import Request
     from fastapi.responses import HTMLResponse
@@ -40,7 +40,7 @@ def serve_home_page(
         web_jargon = (
             CFG.WEB_JARGON if CFG.WEB_JARGON.strip() != "" else root_group.description
         )
-        user = await get_user_from_request(web_config, request)
+        user = await get_user_from_request(web_auth_config, request)
         group_info = get_html_subgroup_info(user, "/ui/", root_group)
         task_info = get_html_subtask_info(user, "/ui/", root_group)
         auth_link = get_html_auth_link(user)
@@ -48,7 +48,8 @@ def serve_home_page(
             fstring_format(
                 _GLOBAL_TEMPLATE,
                 {
-                    "web_title": web_title,
+                    "CFG": CFG,
+                    "root_group": root_group,
                     "content": fstring_format(
                         _VIEW_TEMPLATE,
                         {

zrb/runner/web_route/login_api_route.py

@@ -1,6 +1,6 @@
 from typing import TYPE_CHECKING, Annotated
 
-from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_auth_config import WebAuthConfig
 from zrb.runner.web_util.cookie import set_auth_cookie
 from zrb.runner.web_util.token import generate_tokens_by_credentials
 
@@ -9,7 +9,7 @@ if TYPE_CHECKING:
     from fastapi import FastAPI
 
 
-def serve_login_api(app: "FastAPI", web_config: WebConfig) -> None:
+def serve_login_api(app: "FastAPI", web_auth_config: WebAuthConfig) -> None:
     from fastapi import Depends, Response
     from fastapi.responses import JSONResponse
     from fastapi.security import OAuth2PasswordRequestForm
@@ -19,7 +19,7 @@ def serve_login_api(app: "FastAPI", web_config: WebConfig) -> None:
         response: Response, form_data: Annotated[OAuth2PasswordRequestForm, Depends()]
     ):
         token = generate_tokens_by_credentials(
-            web_config=web_config,
+            web_auth_config=web_auth_config,
             username=form_data.username,
             password=form_data.password,
         )
@@ -27,5 +27,5 @@ def serve_login_api(app: "FastAPI", web_config: WebConfig) -> None:
             return JSONResponse(
                 content={"detail": "Incorrect username or password"}, status_code=400
             )
-        set_auth_cookie(web_config, response, token)
+        set_auth_cookie(web_auth_config, response, token)
         return token

zrb/runner/web_route/login_page/login_page_route.py

@@ -3,7 +3,7 @@ from typing import TYPE_CHECKING
 
 from zrb.config import CFG
 from zrb.group.any_group import AnyGroup
-from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_auth_config import WebAuthConfig
 from zrb.runner.web_util.html import get_html_auth_link
 from zrb.runner.web_util.user import get_user_from_request
 from zrb.util.file import read_file
@@ -17,7 +17,7 @@ if TYPE_CHECKING:
 def serve_login_page(
     app: "FastAPI",
     root_group: AnyGroup,
-    web_config: WebConfig,
+    web_auth_config: WebAuthConfig,
 ) -> None:
     from fastapi import Request
     from fastapi.responses import HTMLResponse
@@ -29,18 +29,23 @@ def serve_login_page(
             os.path.join(os.path.dirname(_DIR), "static", "global_template.html")
         )
         _VIEW_TEMPLATE = read_file(os.path.join(_DIR, "view.html"))
-        user = await get_user_from_request(web_config, request)
+        user = await get_user_from_request(web_auth_config, request)
+        web_title = CFG.WEB_TITLE if CFG.WEB_TITLE.strip() != "" else root_group.name
+        web_jargon = (
+            CFG.WEB_JARGON if CFG.WEB_JARGON.strip() != "" else root_group.description
+        )
         auth_link = get_html_auth_link(user)
         return HTMLResponse(
             fstring_format(
                 _GLOBAL_TEMPLATE,
                 {
-                    "web_title": CFG.WEB_TITLE,
+                    "CFG": CFG,
+                    "root_group": root_group,
                     "content": fstring_format(
                         _VIEW_TEMPLATE,
                         {
-                            "name": root_group.name,
-                            "description": root_group.description,
+                            "name": web_title,
+                            "description": web_jargon,
                             "auth_link": auth_link,
                         },
                     ),

zrb/runner/web_route/logout_api_route.py

@@ -1,18 +1,18 @@
 from typing import TYPE_CHECKING
 
-from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_auth_config import WebAuthConfig
 
 if TYPE_CHECKING:
     # We want fastapi to only be loaded when necessary to decrease footprint
     from fastapi import FastAPI
 
 
-def serve_logout_api(app: "FastAPI", web_config: WebConfig) -> None:
+def serve_logout_api(app: "FastAPI", web_auth_config: WebAuthConfig) -> None:
     from fastapi import Response
 
     @app.get("/api/v1/logout")
     @app.post("/api/v1/logout")
     async def logout_api(response: Response):
-        response.delete_cookie(web_config.access_token_cookie_name)
-        response.delete_cookie(web_config.refresh_token_cookie_name)
+        response.delete_cookie(web_auth_config.access_token_cookie_name)
+        response.delete_cookie(web_auth_config.refresh_token_cookie_name)
         return {"message": "Logout successful"}

zrb/runner/web_route/logout_page/logout_page_route.py

@@ -3,7 +3,7 @@ from typing import TYPE_CHECKING
 
 from zrb.config import CFG
 from zrb.group.any_group import AnyGroup
-from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_auth_config import WebAuthConfig
 from zrb.runner.web_util.html import get_html_auth_link
 from zrb.runner.web_util.user import get_user_from_request
 from zrb.util.file import read_file
@@ -17,7 +17,7 @@ if TYPE_CHECKING:
 def serve_logout_page(
     app: "FastAPI",
     root_group: AnyGroup,
-    web_config: WebConfig,
+    web_auth_config: WebAuthConfig,
 ) -> None:
     from fastapi import Request
     from fastapi.responses import HTMLResponse
@@ -29,18 +29,23 @@ def serve_logout_page(
             os.path.join(os.path.dirname(_DIR), "static", "global_template.html")
         )
         _VIEW_TEMPLATE = read_file(os.path.join(_DIR, "view.html"))
-        user = await get_user_from_request(web_config, request)
+        user = await get_user_from_request(web_auth_config, request)
+        web_title = CFG.WEB_TITLE if CFG.WEB_TITLE.strip() != "" else root_group.name
+        web_jargon = (
+            CFG.WEB_JARGON if CFG.WEB_JARGON.strip() != "" else root_group.description
+        )
         auth_link = get_html_auth_link(user)
         return HTMLResponse(
             fstring_format(
                 _GLOBAL_TEMPLATE,
                 {
-                    "web_title": CFG.WEB_TITLE,
+                    "CFG": CFG,
+                    "root_group": root_group,
                     "content": fstring_format(
                         _VIEW_TEMPLATE,
                         {
-                            "name": root_group.name,
-                            "description": root_group.description,
+                            "name": web_title,
+                            "description": web_jargon,
                             "auth_link": auth_link,
                             "user": user,
                         },

zrb/runner/web_route/node_page/group/show_group_page.py

@@ -36,7 +36,8 @@ def show_group_page(user: User, root_group: AnyGroup, group: AnyGroup, url: str)
         fstring_format(
             _GLOBAL_TEMPLATE,
             {
-                "web_title": f"{web_title} | {group.name}",
+                "CFG": CFG,
+                "root_group": root_group,
                 "content": fstring_format(
                     _VIEW_TEMPLATE,
                     {

zrb/runner/web_route/node_page/node_page_route.py

@@ -3,7 +3,7 @@ from typing import TYPE_CHECKING
 
 from zrb.context.shared_context import SharedContext
 from zrb.group.any_group import AnyGroup
-from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_auth_config import WebAuthConfig
 from zrb.runner.web_route.error_page.show_error_page import show_error_page
 from zrb.runner.web_route.node_page.group.show_group_page import show_group_page
 from zrb.runner.web_route.node_page.task.show_task_page import show_task_page
@@ -20,14 +20,14 @@ if TYPE_CHECKING:
 def serve_node_page(
     app: "FastAPI",
     root_group: AnyGroup,
-    web_config: WebConfig,
+    web_auth_config: WebAuthConfig,
 ) -> None:
     from fastapi import Request
     from fastapi.responses import HTMLResponse
 
     @app.get("/ui/{path:path}", response_class=HTMLResponse, include_in_schema=False)
     async def ui_page(path: str, request: Request) -> HTMLResponse:
-        user = await get_user_from_request(web_config, request)
+        user = await get_user_from_request(web_auth_config, request)
         # Avoid capturing '/ui' itself
         if not path:
             return show_error_page(user, root_group, 422, "Undefined path")

zrb/runner/web_route/node_page/task/show_task_page.py

@@ -64,7 +64,8 @@ def show_task_page(
         fstring_format(
             _GLOBAL_TEMPLATE,
             {
-                "web_title": f"{web_title} | {task.name}",
+                "CFG": CFG,
+                "root_group": root_group,
                 "content": fstring_format(
                     _VIEW_TEMPLATE,
                     {

zrb/runner/web_route/refresh_token_api_route.py

@@ -1,6 +1,6 @@
 from typing import TYPE_CHECKING
 
-from zrb.runner.web_config.config import WebConfig
+from zrb.runner.web_auth_config import WebAuthConfig
 from zrb.runner.web_schema.token import RefreshTokenRequest
 from zrb.runner.web_util.cookie import set_auth_cookie
 from zrb.runner.web_util.token import regenerate_tokens
@@ -10,7 +10,7 @@ if TYPE_CHECKING:
     from fastapi import FastAPI
 
 
-def serve_refresh_token_api(app: "FastAPI", web_config: WebConfig) -> None:
+def serve_refresh_token_api(app: "FastAPI", web_auth_config: WebAuthConfig) -> None:
     from fastapi import Cookie, Response
     from fastapi.responses import JSONResponse
 
@@ -19,7 +19,7 @@ def serve_refresh_token_api(app: "FastAPI", web_config: WebConfig) -> None:
         response: Response,
         body: RefreshTokenRequest = None,
         refresh_token_cookie: str = Cookie(
-            None, alias=web_config.refresh_token_cookie_name
+            None, alias=web_auth_config.refresh_token_cookie_name
         ),
     ):
         # Try to get the refresh token from the request body first
@@ -33,6 +33,6 @@ def serve_refresh_token_api(app: "FastAPI", web_config: WebConfig) -> None:
                 content={"detail": "Refresh token not provided"}, status_code=401
             )
         # Get token
-        new_token = regenerate_tokens(web_config, refresh_token)
-        set_auth_cookie(web_config, response, new_token)
+        new_token = regenerate_tokens(web_auth_config, refresh_token)
+        set_auth_cookie(web_auth_config, response, new_token)
         return new_token

zrb/runner/web_route/static/global_template.html

@@ -4,10 +4,11 @@
         <meta charset="utf-8">
         <meta name="viewport" content="width=device-width, initial-scale=1">
         <meta name="color-scheme" content="light dark">
-        <link rel="stylesheet" href="/static/pico.min.css">
-        <link rel="icon" href="/static/favicon-32x32.png" sizes="32x32" type="image/png">
-        <title>{web_title}</title>
+        <link rel="stylesheet" href="/static/pico-css/pico{'.' + CFG.WEB_COLOR if CFG.WEB_COLOR != '' else ''}.min.css">
+        <link rel="icon" href="{CFG.WEB_FAVICON_PATH}" sizes="32x32" type="image/png">
+        <title>{CFG.WEB_TITLE if CFG.WEB_TITLE.strip() != "" else root_group.name}</title>
         <link rel="stylesheet" href="/static/common.css">
+        {'\n'.join(['<link rel="stylesheet" href="' + path + '">' for path in CFG.WEB_CSS_PATH])}
     </head>
     <body>
         <div class="theme-switcher">
@@ -24,4 +25,6 @@
     </body>
     <script src="/refresh-token.js"></script>
     <script src="/static/common.js"></script>
+    {'\n'.join(['<script src="' + path + '"></script>' for path in CFG.WEB_JS_PATH])}
+
 </html>