diff --git a/.env.example b/.env.example
index a9293a0..a297003 100644
--- a/.env.example
+++ b/.env.example
@@ -17,3 +17,14 @@ BV_CHALLENGE_API_PORT=10001
# BV_CHALLENGE_API_DOCS_OPENAPI_URL="{api_prefix}/openapi.json"
# BV_CHALLENGE_API_DOCS_DOCS_URL="{api_prefix}/docs"
# BV_CHALLENGE_API_DOCS_REDOC_URL="{api_prefix}/redoc"
+
+## -- MDM challenge / Simple Bot configs -- ##
+CHALLENGE_HTTPS_PROXY_PORT=10443
+MDM_CHALLENGE_BASE_URL="http://challenge-api:10001"
+# MDM_CHALLENGE_SIMPLE_BOT_URL="https://simplebot.theredteam.io"
+# MDM_CHALLENGE_BOT_DIR="/app/rest.vm-runner/bot"
+# MDM_CHALLENGE_SIMPLE_BOT_NETWORK_NAME="bot-simple-network"
+# MDM_CHALLENGE_CHALLENGE_NETWORK_NAME="bot-challenge-network"
+# MDM_CHALLENGE_MINER_IMAGE_TAG="redteamsubnet/bv-miner:latest"
+# MDM_CHALLENGE_SIMPLE_BOT_POLL_MAX_ATTEMPTS=5
+# MDM_CHALLENGE_SIMPLE_BOT_POLL_INTERVAL_SEC=2
diff --git a/.gitignore b/.gitignore
index 5d6955d..d5bf056 100644
--- a/.gitignore
+++ b/.gitignore
@@ -535,3 +535,16 @@ volumes/configs/**/*.DS_Store
volumes/configs/**/*Thumbs.db
volumes/configs/**/*~
volumes/configs/**/*._*
+
+# Internal design docs (kept local, not published)
+docs/superpowers/
+
+# Internal benchmark/test bot fixtures (reveal scoring expectations — keep local)
+benchmarks/
+tests/fixtures/bots/
+
+# Private detector source (compiled to the rt_bv_score wheel — never publish source)
+private/
+# Rust build artifacts
+target/
+Cargo.lock
diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 0000000..da79764
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "src/modules/rest.mdm-sn-container-runner"]
+ path = src/modules/rest.mdm-sn-container-runner
+ url = git@github.com:RedTeamSubnet/rest.hb-bot-executer.git
diff --git a/compose.yml b/compose.yml
index 4d997da..a5c22c1 100644
--- a/compose.yml
+++ b/compose.yml
@@ -4,10 +4,15 @@ services:
build:
context: ./src/bv_challenge/challenge
restart: unless-stopped
+ networks:
+ - bot-virus-challenge-net
environment:
TERM: ${TERM:-xterm}
TZ: ${TZ:-Asia/Seoul}
BV_CHALLENGE_API_PORT: ${BV_CHALLENGE_API_PORT:-10001}
+ BV_CHALLENGE_API_BOT_RUNNER_URL: ${BV_CHALLENGE_API_BOT_RUNNER_URL:-http://bot-runner:8000}
+ BV_CHALLENGE_API_BOT_RUNNER_SESSION_COUNT: ${BV_CHALLENGE_API_BOT_RUNNER_SESSION_COUNT:-2}
+ BV_CHALLENGE_API_BOT_RUNNER_REQUEST_TIMEOUT_SEC: ${BV_CHALLENGE_API_BOT_RUNNER_REQUEST_TIMEOUT_SEC:-900}
env_file:
- path: .env
required: false
@@ -17,4 +22,50 @@ services:
- "./volumes/storage/rest-bv-challenge/data:${BV_CHALLENGE_API_DATA_DIR:-/var/lib/rest-bv-challenge}"
ports:
- "${BV_CHALLENGE_API_PORT:-10001}:${BV_CHALLENGE_API_PORT:-10001}"
- tty: true
+
+ bot-runner:
+ image: redteamsubnet61/bot_virus_bot_runner:latest
+ build:
+ context: ./src/modules/rest.mdm-sn-container-runner
+ restart: unless-stopped
+ networks:
+ - bot-virus-challenge-net
+ environment:
+ TERM: ${TERM:-xterm}
+ TZ: ${TZ:-UTC}
+ VM_RUNNER_API_PORT: ${VM_RUNNER_API_PORT:-8000}
+ DOCKER_HOST: unix:///docker-socket/docker.sock
+ CHALLENGE_HTTPS_PROXY_PORT: ${CHALLENGE_HTTPS_PROXY_PORT:-10443}
+ env_file:
+ - path: .env
+ required: false
+ volumes:
+ - "./volumes/storage/rest-mdm-sn-container-runner/logs:${VM_RUNNER_API_LOGS_DIR:-/var/log/rest.vm-runner}"
+ - "./volumes/storage/rest-mdm-sn-container-runner/data:${VM_RUNNER_API_DATA_DIR:-/var/lib/rest.vm-runner}"
+ - "bot-runner-dind-socket:/docker-socket"
+ ports:
+ - "${VM_RUNNER_API_PORT:-8000}:${VM_RUNNER_API_PORT:-8000}"
+
+ bot-runner-dind:
+ image: redteamsubnet61/bot_virus_bot_runner_dind:latest
+ build:
+ context: ./src/modules/rest.mdm-sn-container-runner
+ dockerfile: Dockerfile.dind
+ restart: unless-stopped
+ networks:
+ - bot-virus-challenge-net
+ privileged: true
+ environment:
+ DOCKER_TLS_CERTDIR: ""
+ CHALLENGE_HTTPS_PROXY_PORT: ${CHALLENGE_HTTPS_PROXY_PORT:-10443}
+ volumes:
+ - "bot-runner-dind-socket:/docker-socket"
+ - "bot-runner-dind-data:/var/lib/docker"
+
+networks:
+ bot-virus-challenge-net:
+ name: bot-virus-challenge-net
+ driver: bridge
+volumes:
+ bot-runner-dind-socket:
+ bot-runner-dind-data:
diff --git a/pyproject.toml b/pyproject.toml
index 2d25dc6..8dcdea4 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -32,14 +32,16 @@ classifiers = [
]
dynamic = ["version", "dependencies", "optional-dependencies"]
-# [tool.setuptools.packages.find]
-# where = ["src"]
-# include = ["bv_challenge*"]
-# namespaces = false
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["bv_challenge*"]
[tool.setuptools.dynamic]
-version = { attr = "bv_challenge.__version__.__version__" }
-dependencies = { file = "./requirements.txt" }
+version = { attr = "bv_challenge.__version__" }
+dependencies = { file = ["requirements.txt"] }
[tool.setuptools.dynamic.optional-dependencies]
# Options dependencies for DEVELOPMENT
@@ -62,8 +64,8 @@ dev = { file = [
# venv = ".venv"
[project.urls]
-Homepage = "https://github.com/RedTeamSubnet/challenge-template"
+Homepage = "https://github.com/RedTeamSubnet/bot-virus-challenge"
Documentation = "https://docs.theredteam.io"
-Repository = "https://github.com/RedTeamSubnet/challenge-template.git"
-Issues = "https://github.com/RedTeamSubnet/challenge-template/issues"
-Changelog = "https://github.com/RedTeamSubnet/challenge-template/blob/main/CHANGELOG.md"
+Repository = "https://github.com/RedTeamSubnet/bot-virus-challenge.git"
+Issues = "https://github.com/RedTeamSubnet/bot-virus-challenge/issues"
+Changelog = "https://github.com/RedTeamSubnet/bot-virus-challenge/blob/main/CHANGELOG.md"
diff --git a/requirements.txt b/requirements.txt
index c22a8b5..4460077 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,4 +1,5 @@
python-dotenv>=1.0.1,<2.0.0
-pydantic[email,timezone]>=2.0.3,<3.0.0
+pydantic[email,timezone]>=2.13.4,<3.0.0
pydantic-settings>=2.2.1,<3.0.0
-# redteam_core @ git+https://github.com/RedTeamSubnet/RedTeam.git@v4.2.2
+./requirements/rt_bv_score-0.1.0-cp310-abi3-manylinux_2_34_x86_64.whl
+./requirements/vault_unlock-0.1.0-cp310-abi3-manylinux_2_34_x86_64.whl
diff --git a/scripts/bump-version.sh b/scripts/bump-version.sh
index c674dc4..b88bfc9 100755
--- a/scripts/bump-version.sh
+++ b/scripts/bump-version.sh
@@ -26,7 +26,7 @@ fi
## --- Variables --- ##
# Load from environment variables:
-VERSION_FILE_PATH="${VERSION_FILE_PATH:-./VERSION.txt}"
+VERSION_FILE_PATH="${VERSION_FILE_PATH:-./src/bv_challenge/__version__.py}"
_BUMP_TYPE=""
@@ -130,7 +130,7 @@ main()
echo "[INFO]: Bumping version to '${_new_version}'..."
# Update the version file with the new version:
- echo "${_new_version}" > "${VERSION_FILE_PATH}" || exit 2
+ echo -e "__version__ = \"${_new_version}\"" > "${VERSION_FILE_PATH}" || exit 2
echo "[OK]: New version: '${_new_version}'"
./scripts/sync-versions.sh -a || exit 2
diff --git a/scripts/get-version.sh b/scripts/get-version.sh
index 2b59ebe..28bce9c 100755
--- a/scripts/get-version.sh
+++ b/scripts/get-version.sh
@@ -15,12 +15,12 @@ cd "${_PROJECT_DIR}" || exit 2
## --- Variables --- ##
# Load from environment variables:
-VERSION_FILE_PATH="${VERSION_FILE_PATH:-./VERSION.txt}"
+VERSION_FILE_PATH="${VERSION_FILE_PATH:-./src/bv_challenge/__version__.py}"
## --- Variables --- ##
if [ -n "${VERSION_FILE_PATH}" ] && [ -f "${VERSION_FILE_PATH}" ]; then
- _current_version=$(cat "${VERSION_FILE_PATH}") || exit 2
+ _current_version=$(< "${VERSION_FILE_PATH}" grep "__version__ = " | awk -F' = ' '{print $2}' | tr -d '"') || exit 2
else
_current_version="0.0.0"
fi
diff --git a/src/bv_challenge/challenge/.dockerignore b/src/bv_challenge/challenge/.dockerignore
index b088109..ced2d9c 100644
--- a/src/bv_challenge/challenge/.dockerignore
+++ b/src/bv_challenge/challenge/.dockerignore
@@ -551,6 +551,7 @@ README.md
**/compose.sh
**/compose.override.y*ml
**/Dockerfile*
+!bot/Dockerfile
**/Makefile
**/mkdocs.yml
**/pm2-process.json*
diff --git a/src/bv_challenge/challenge/Dockerfile b/src/bv_challenge/challenge/Dockerfile
index c61f2c4..21981fa 100644
--- a/src/bv_challenge/challenge/Dockerfile
+++ b/src/bv_challenge/challenge/Dockerfile
@@ -29,6 +29,7 @@ RUN --mount=type=cache,target=/root/.cache,sharing=locked \
# COPY ./requirements* ./
RUN --mount=type=cache,target=/root/.cache,sharing=locked \
--mount=type=bind,source=requirements.txt,target=requirements.txt \
+ --mount=type=bind,source=requirements,target=requirements \
python3 -m uv pip install --prefix=/install -r ./requirements.txt
@@ -140,6 +141,8 @@ FROM base AS app
WORKDIR "${BV_CHALLENGE_API_DIR}"
COPY --chown=${UID}:${GID} ./api ${BV_CHALLENGE_API_DIR}/api
+COPY --chown=${UID}:${GID} ./bot ${BV_CHALLENGE_API_DIR}/bot
+COPY --chown=${UID}:${GID} ./templates ${BV_CHALLENGE_API_DIR}/templates
COPY --chown=${UID}:${GID} --chmod=770 ./scripts/*.sh /usr/local/bin/
# VOLUME ["${BV_CHALLENGE_API_DATA_DIR}"]
diff --git a/src/bv_challenge/challenge/api/__init__.py b/src/bv_challenge/challenge/api/__init__.py
index 29c6809..5d91ce4 100644
--- a/src/bv_challenge/challenge/api/__init__.py
+++ b/src/bv_challenge/challenge/api/__init__.py
@@ -1,3 +1,6 @@
+# -*- coding: utf-8 -*-
+
from api.__version__ import __version__
+
__all__ = ["__version__"]
diff --git a/src/bv_challenge/challenge/api/__main__.py b/src/bv_challenge/challenge/api/__main__.py
index 4b0807c..4b27dc0 100644
--- a/src/bv_challenge/challenge/api/__main__.py
+++ b/src/bv_challenge/challenge/api/__main__.py
@@ -1,6 +1,25 @@
+# -*- coding: utf-8 -*-
+
+## Third-party libraries
+from fastapi import FastAPI
+
+## Internal modules
+from api.bootstrap import create_app, run_server
from api.logger import logger
-from api.main import main
+
+
+app: FastAPI = create_app()
+
+
+def main() -> None:
+ """Main function."""
+
+ run_server(app="api.__main__:app")
+ return
+
if __name__ == "__main__":
- logger.info("Starting server from '__main__.py'...")
+ logger.info(f"Starting server from '__main__.py'...")
main()
+
+__all__ = ["app"]
diff --git a/src/bv_challenge/challenge/api/__version__.py b/src/bv_challenge/challenge/api/__version__.py
index 6c8e6b9..a0235ce 100644
--- a/src/bv_challenge/challenge/api/__version__.py
+++ b/src/bv_challenge/challenge/api/__version__.py
@@ -1 +1 @@
-__version__ = "0.0.0"
+__version__ = "0.0.2"
\ No newline at end of file
diff --git a/src/bv_challenge/challenge/api/bootstrap.py b/src/bv_challenge/challenge/api/bootstrap.py
index ec71d87..436e770 100644
--- a/src/bv_challenge/challenge/api/bootstrap.py
+++ b/src/bv_challenge/challenge/api/bootstrap.py
@@ -1,17 +1,16 @@
-# Standard libraries
-from typing import Any
-from collections.abc import Callable
+# -*- coding: utf-8 -*-
-# Third-party libraries
+## Standard libraries
+import os
+from typing import Union
+
+## Third-party libraries
import uvicorn
from uvicorn._types import ASGIApplication
from pydantic import validate_call
from fastapi import FastAPI
-from beans_logging_fastapi import add_logger
-
-# Internal modules
-from api.__version__ import __version__
+## Internal modules
from api.config import config
from api.lifespan import lifespan, pre_init
from api.middleware import add_middlewares
@@ -31,19 +30,13 @@ def create_app() -> FastAPI:
pre_init()
app = FastAPI(
- title=config.api.title,
- version=__version__,
+ title=config.api.name,
+ version=config.version,
lifespan=lifespan,
default_response_class=BaseResponse,
**config.api.docs.model_dump(exclude={"enabled"}),
)
- add_logger(
- app=app,
- config=config.api.logger,
- has_proxy_headers=config.api.uvicorn.proxy_headers,
- )
-
add_middlewares(app=app)
add_routers(app=app)
add_mounts(app=app)
@@ -53,21 +46,35 @@ def create_app() -> FastAPI:
@validate_call(config={"arbitrary_types_allowed": True})
-def run_server(app: FastAPI | ASGIApplication | Callable[..., Any] | str) -> None:
+def run_server(app: Union[ASGIApplication, str] = "main:app") -> None:
"""Run uvicorn server.
Args:
- app (FastAPI |
- ASGIApplication |
- Callable[..., Any] |
- str , required): FastAPI application instance or ASGI application or import string.
+ app (Union[ASGIApplication, str], optional): ASGI application instance or module path.
"""
+ _ssl_keyfile: Union[str, None] = None
+ _ssl_certfile: Union[str, None] = None
+
+ if config.api.security.ssl.enabled:
+ _ssl_keyfile = os.path.join(
+ config.api.paths.ssl_dir, config.api.security.ssl.key_fname
+ )
+ _ssl_certfile = os.path.join(
+ config.api.paths.ssl_dir, config.api.security.ssl.cert_fname
+ )
+
uvicorn.run(
app=app,
host=config.api.bind_host,
port=config.api.port,
- **config.api.uvicorn.model_dump(),
+ access_log=False,
+ server_header=False,
+ proxy_headers=config.api.behind_proxy,
+ forwarded_allow_ips=config.api.security.forwarded_allow_ips,
+ ssl_keyfile=_ssl_keyfile,
+ ssl_certfile=_ssl_certfile,
+ **config.api.dev.model_dump(),
)
return
diff --git a/src/bv_challenge/challenge/api/config.py b/src/bv_challenge/challenge/api/config.py
index 50e5cb6..c4045d4 100644
--- a/src/bv_challenge/challenge/api/config.py
+++ b/src/bv_challenge/challenge/api/config.py
@@ -1,46 +1,24 @@
-import os
-from typing import TypeVar, Any
+# -*- coding: utf-8 -*-
-from pydantic import validate_call
+import pathlib
-from potato_util.io import read_all_configs
+from onion_config import ConfigLoader
+from beans_logging import logger
-from api.core.constants import ENV_PREFIX_API, API_SLUG
from api.core.configs import MainConfig
-from api.logger import logger
-ConfigType = TypeVar("ConfigType", bound=MainConfig)
+config: MainConfig
+try:
+ _parent_dir = pathlib.Path(__file__).parent.resolve()
+ _config_loader = ConfigLoader(
+ config_schema=MainConfig, configs_dirs=[str(_parent_dir / "configs")]
+ )
+ # Main config object:
+ config: MainConfig = _config_loader.load()
+except Exception:
+ logger.exception("Failed to load config:")
+ raise SystemExit(1)
-@validate_call
-def load_config(
- configs_dir: str = os.path.join("/etc", API_SLUG),
- env_name: str = f"{ENV_PREFIX_API}CONFIGS_DIR",
- config_schema: type[ConfigType] = MainConfig,
-) -> ConfigType:
- _configs_dir_env = os.getenv(env_name, "")
- if _configs_dir_env:
- configs_dir = _configs_dir_env
- _config_dict: dict[str, Any] = {}
- if os.path.isdir(configs_dir):
- _config_dict = read_all_configs(configs_dir=configs_dir)
-
- _config: ConfigType | None = None
- try:
- _config = config_schema(**_config_dict)
- except Exception:
- logger.exception("Failed to load config:")
- raise SystemExit(1)
-
- return _config
-
-
-config = load_config()
-
-
-__all__ = [
- "MainConfig",
- "load_config",
- "config",
-]
+__all__ = ["config"]
diff --git a/src/bv_challenge/challenge/api/configs/api.yml b/src/bv_challenge/challenge/api/configs/api.yml
new file mode 100644
index 0000000..36b9eba
--- /dev/null
+++ b/src/bv_challenge/challenge/api/configs/api.yml
@@ -0,0 +1,18 @@
+env: "LOCAL"
+debug: false
+
+api:
+ name: "Bot Virus Challenge"
+ slug: "rest-bv-challenge"
+ bind_host: "0.0.0.0"
+ port: 10001
+ version: "1"
+ prefix: ""
+ gzip_min_size: 1024 # Bytes (1KB)
+ behind_proxy: true
+ behind_cf_proxy: true
+ dev:
+ reload: false
+ reload_includes: [".env", "*.json", "*.yml", "*.yaml", "*.md"]
+ reload_excludes:
+ [".*", "~*", ".py[cod]", ".sw.*", "__pycache__", "*.log", "logs"]
diff --git a/src/bv_challenge/challenge/api/configs/challenge.yml b/src/bv_challenge/challenge/api/configs/challenge.yml
new file mode 100644
index 0000000..1b5f135
--- /dev/null
+++ b/src/bv_challenge/challenge/api/configs/challenge.yml
@@ -0,0 +1,15 @@
+challenge:
+ n_ch_per_epoch: 1
+ n_run_per_ch: 10
+ allowed_pip_pkg_dt: "2025-01-01T00:00:00Z"
+ allowed_file_exts: [".py", ".json", ".yaml", ".yml", ".txt", ".pt"]
+ bot_timeout: 200
+ # Layer 1/2 fallback score policy
+ gate_fail_score: 0.0
+ metrics_processor_error_score: 0.5
+ session_timeout_score: 0.0
+ runner_fail_score: 0.0
+ # VM configuration for remote Docker build/run
+ vm_endpoint: "http://bot-runner:8000"
+ vm_timeout: 300
+ vm_ssl_verify: false
diff --git a/src/bv_challenge/challenge/api/configs/docs.yml b/src/bv_challenge/challenge/api/configs/docs.yml
new file mode 100644
index 0000000..b7fe3a1
--- /dev/null
+++ b/src/bv_challenge/challenge/api/configs/docs.yml
@@ -0,0 +1,15 @@
+api:
+ docs:
+ enabled: true
+ openapi_url: "{api_prefix}/openapi.json"
+ docs_url: "{api_prefix}/docs"
+ redoc_url: "{api_prefix}/redoc"
+ swagger_ui_oauth2_redirect_url: "{api_prefix}/docs/oauth2-redirect"
+ summary: "This is the API documentation for the Bot Virus Challenge API."
+ openapi_tags:
+ - name: "Utils"
+ description: "Useful utility endpoints."
+ - name: "Challenge"
+ description: "Endpoints for challenge."
+ swagger_ui_parameters:
+ syntaxHighlight.theme: "nord"
diff --git a/src/bv_challenge/challenge/api/configs/logger.yml b/src/bv_challenge/challenge/api/configs/logger.yml
new file mode 100644
index 0000000..e74f4ee
--- /dev/null
+++ b/src/bv_challenge/challenge/api/configs/logger.yml
@@ -0,0 +1,52 @@
+logger:
+ app_name: "{api_slug}"
+ level: "INFO"
+ use_diagnose: false
+ stream:
+ format_str: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {level_short:<5} | {name}:{line}]: {message}"
+ # format_str: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z:!UTC} | {level_short:<5} | {name}:{line}]: {message}"
+ std_handler:
+ enabled: true
+ file:
+ logs_dir: "../logs"
+ rotate_size: 10000000 # 10MB
+ rotate_time: "00:00:00"
+ backup_count: 90
+ log_handlers:
+ enabled: true
+ format_str: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {level_short:<5} | {name}:{line}]: {message}"
+ # format_str: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z:!UTC} | {level_short:<5} | {name}:{line}]: {message}"
+ log_path: "{app_name}.std.all.log"
+ err_path: "{app_name}.std.err.log"
+ json_handlers:
+ enabled: true
+ use_custom: false
+ log_path: "json/{app_name}.json.all.log"
+ err_path: "json/{app_name}.json.err.log"
+ intercept:
+ auto_load:
+ enabled: true
+ only_base: false
+ ignore_modules: []
+ include_modules: []
+ mute_modules: [
+ "uvicorn.access",
+ # "uvicorn.error",
+ "multipart",
+ "watchfiles",
+ "watchfiles.main",
+ "watchfiles.watcher",
+ ]
+ extra:
+ http_std_msg_format: '[{request_id}] {client_host} {user_id} "{method} {url_path} HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'
+ http_std_error_format: '[{request_id}] {client_host} {user_id} "{method} {url_path} HTTP/{http_version}" {status_code}'
+ http_std_debug_format: '[{request_id}] {client_host} {user_id} "{method} {url_path} HTTP/{http_version}"'
+ http_file_enabled: true
+ http_file_format: '{client_host} {request_id} {user_id} [{datetime}] "{method} {url_path} HTTP/{http_version}" {status_code} {content_length} "{h_referer}" "{h_user_agent}" {response_time}'
+ http_file_tz: "localtime"
+ # http_file_tz: "UTC"
+ http_log_path: "http/{app_name}.http.access.log"
+ http_err_path: "http/{app_name}.http.err.log"
+ http_json_enabled: true
+ http_json_path: "json.http/{app_name}.json.http.access.log"
+ http_json_err_path: "json.http/{app_name}.json.http.err.log"
diff --git a/src/bv_challenge/challenge/api/configs/paths.yml b/src/bv_challenge/challenge/api/configs/paths.yml
new file mode 100644
index 0000000..ea8c232
--- /dev/null
+++ b/src/bv_challenge/challenge/api/configs/paths.yml
@@ -0,0 +1,8 @@
+api:
+ paths:
+ tmp_dir: "../tmp"
+ uploads_dir: "{tmp_dir}/uploads"
+ data_dir: "../data"
+ security_dir: "{data_dir}/security"
+ ssl_dir: "{data_dir}/security/ssl"
+ asymmetric_keys_dir: "{data_dir}/security/asymmetric_keys"
diff --git a/src/bv_challenge/challenge/api/configs/security.yml b/src/bv_challenge/challenge/api/configs/security.yml
new file mode 100644
index 0000000..57c6f72
--- /dev/null
+++ b/src/bv_challenge/challenge/api/configs/security.yml
@@ -0,0 +1,25 @@
+api:
+ security:
+ allowed_hosts: ["*"]
+ forwarded_allow_ips: ["*"]
+ cors:
+ allow_origins: ["*"]
+ allow_origin_regex: null
+ allow_headers: ["*"]
+ allow_methods:
+ ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS", "CONNECT"]
+ allow_credentials: false
+ expose_headers: []
+ max_age: 600 # Seconds (10 minutes)
+ ssl:
+ enabled: false
+ generate: false
+ key_size: 2048
+ key_fname: "key.pem"
+ cert_fname: "cert.pem"
+ asymmetric:
+ generate: false
+ algorithm: "RS256"
+ key_size: 2048
+ private_key_fname: "private_key.pem"
+ public_key_fname: "public_key.pem"
diff --git a/src/bv_challenge/challenge/api/core/configs/__init__.py b/src/bv_challenge/challenge/api/core/configs/__init__.py
index 1c79b70..52c8168 100644
--- a/src/bv_challenge/challenge/api/core/configs/__init__.py
+++ b/src/bv_challenge/challenge/api/core/configs/__init__.py
@@ -1,4 +1,4 @@
-# flake8: noqa
+# -*- coding: utf-8 -*-
from ._base import *
from ._main import *
diff --git a/src/bv_challenge/challenge/api/core/configs/_api.py b/src/bv_challenge/challenge/api/core/configs/_api.py
index 330dc39..03bab1d 100644
--- a/src/bv_challenge/challenge/api/core/configs/_api.py
+++ b/src/bv_challenge/challenge/api/core/configs/_api.py
@@ -1,148 +1,142 @@
+# -*- coding: utf-8 -*-
+
import sys
-from typing import Any
+from typing import Any, Dict
-from pydantic import Field, field_validator, ValidationInfo, model_validator
+from pydantic import Field, constr, field_validator, ValidationInfo, model_validator
from pydantic_settings import SettingsConfigDict
-from potato_util.constants import HTTPSchemeEnum
-
-from api.core.constants import ENV_PREFIX_API, API_SLUG
-from api.core import utils
-
-from ._base import BaseConfig, FrozenBaseConfig
-from ._uvicorn import UvicornConfig
+from api.core.constants import ENV_PREFIX_API, HTTPSchemeEnum
+from ._base import BaseConfig
+from ._dev import DevConfig
from ._security import SecurityConfig
from ._docs import DocsConfig, FrozenDocsConfig
from ._paths import PathsConfig, FrozenPathsConfig
-from ._logger import LoggerConfigPM, FrozenLoggerConfigPM
-
-
-class GZipConfig(FrozenBaseConfig):
- minimum_size: int = Field(default=1024, ge=0, le=10_485_760)
- compresslevel: int = Field(default=9, ge=1, le=9)
-
- model_config = SettingsConfigDict(env_prefix=f"{ENV_PREFIX_API}GZIP_")
class ApiConfig(BaseConfig):
- title: str = Field(
- default="Bot Virus Challenge", min_length=2, max_length=128
- )
- slug: str = Field(default=API_SLUG, min_length=2, max_length=128)
+ name: constr(strip_whitespace=True) = Field(..., min_length=2, max_length=128) # type: ignore
+ slug: constr(strip_whitespace=True) = Field(..., min_length=2, max_length=128) # type: ignore
http_scheme: HTTPSchemeEnum = Field(default=HTTPSchemeEnum.http)
- bind_host: str = Field(
- default="0.0.0.0", min_length=2, max_length=128 # nosec B104
- )
- port: int = Field(default=10001, ge=80, lt=65536)
- version: str = Field(default="1", min_length=1, max_length=16)
- prefix: str = Field(default="", max_length=128)
- gzip: GZipConfig = Field(default_factory=GZipConfig)
- uvicorn: UvicornConfig = Field(default_factory=UvicornConfig)
- security: SecurityConfig = Field(default_factory=SecurityConfig)
- docs: DocsConfig = Field(default_factory=DocsConfig)
- paths: PathsConfig = Field(default_factory=PathsConfig)
- logger: LoggerConfigPM = Field(default_factory=LoggerConfigPM)
-
- @field_validator("prefix", mode="after")
+ bind_host: constr(strip_whitespace=True) = Field(..., min_length=2, max_length=128) # type: ignore
+ port: int = Field(..., ge=80, lt=65536)
+ version: constr(strip_whitespace=True) = Field(..., min_length=1, max_length=16) # type: ignore
+ prefix: constr(strip_whitespace=True) = Field(..., max_length=128) # type: ignore
+ gzip_min_size: int = Field(..., ge=0, le=10_485_760) # 512 bytes
+ behind_proxy: bool = Field(...)
+ behind_cf_proxy: bool = Field(...)
+ dev: DevConfig = Field(...)
+ security: SecurityConfig = Field(...)
+ docs: DocsConfig = Field(...)
+ paths: PathsConfig = Field(...)
+
+ @field_validator("slug")
@classmethod
- def _check_prefix(cls, val: str, info: ValidationInfo) -> str:
- if ("version" in info.data) and val and ("{api_version}" in val):
- val = val.format(api_version=info.data["version"])
+ def _check_slug(cls, val: str, info: ValidationInfo) -> str:
+ if (not val) and ("name" in info.data):
+ val = (
+ info.data["name"]
+ .lower()
+ .strip()
+ .replace(" ", "-")
+ .replace("_", "-")
+ .replace(".", "-")
+ )
return val
- @field_validator("security", mode="after")
+ @field_validator("prefix")
@classmethod
- def _check_security(
- cls, val: SecurityConfig, info: ValidationInfo
- ) -> SecurityConfig:
- if (not utils.is_running_bin()) and val.ssl.enabled:
- info.data["http_scheme"] = HTTPSchemeEnum.https
+ def _check_prefix(cls, val: str, info: ValidationInfo) -> str:
+ if val and ("{api_version}" in val) and ("version" in info.data):
+ val = val.format(api_version=info.data["version"])
return val
- @field_validator("docs", mode="after")
+ @field_validator("docs")
@classmethod
def _check_docs(cls, val: DocsConfig, info: ValidationInfo) -> DocsConfig:
- _docs_dict = val.model_dump()
- if ("prefix" in info.data) and val.enabled:
- for _key, _doc in _docs_dict.items():
- if (
- isinstance(_doc, str)
- and _key.endswith("url")
- and ("{api_prefix}" in _doc)
- ):
- _docs_dict[_key] = _doc.format(api_prefix=info.data["prefix"])
-
- val = FrozenDocsConfig(**_docs_dict)
+ if val.enabled and ("prefix" in info.data):
+ if val.openapi_url and ("{api_prefix}" in val.openapi_url):
+ val.openapi_url = val.openapi_url.format(api_prefix=info.data["prefix"])
+
+ if val.docs_url and ("{api_prefix}" in val.docs_url):
+ val.docs_url = val.docs_url.format(api_prefix=info.data["prefix"])
+
+ if val.redoc_url and ("{api_prefix}" in val.redoc_url):
+ val.redoc_url = val.redoc_url.format(api_prefix=info.data["prefix"])
+
+ if val.swagger_ui_oauth2_redirect_url and (
+ "{api_prefix}" in val.swagger_ui_oauth2_redirect_url
+ ):
+ val.swagger_ui_oauth2_redirect_url = (
+ val.swagger_ui_oauth2_redirect_url.format(
+ api_prefix=info.data["prefix"]
+ )
+ )
+
+ val = FrozenDocsConfig(**val.model_dump())
return val
- @field_validator("paths", mode="after")
+ @field_validator("paths")
@classmethod
def _check_paths(cls, val: PathsConfig, info: ValidationInfo) -> FrozenPathsConfig:
- _paths_dict = val.model_dump()
if "slug" in info.data:
- for _key, _path in _paths_dict.items():
- if isinstance(_path, str) and ("{api_slug}" in _path):
- _paths_dict[_key] = _path.format(api_slug=info.data["slug"])
+ if "{api_slug}" in val.tmp_dir:
+ val.tmp_dir = val.tmp_dir.format(api_slug=info.data["slug"])
- val = FrozenPathsConfig(**_paths_dict)
- return val
+ if "{api_slug}" in val.uploads_dir:
+ val.uploads_dir = val.uploads_dir.format(api_slug=info.data["slug"])
+ elif "{tmp_dir}" in val.uploads_dir:
+ val.uploads_dir = val.uploads_dir.format(tmp_dir=val.tmp_dir)
- @field_validator("logger", mode="after")
- @classmethod
- def _check_logger(cls, val: LoggerConfigPM, info: ValidationInfo) -> LoggerConfigPM:
- if "slug" in info.data:
- if "{api_slug}" in val.app_name:
- val.app_name = val.app_name.format(api_slug=info.data["slug"])
-
- if "{api_slug}" in val.file.logs_dir:
- val.file.logs_dir = val.file.logs_dir.format(api_slug=info.data["slug"])
+ if "{api_slug}" in val.data_dir:
+ val.data_dir = val.data_dir.format(api_slug=info.data["slug"])
- val = FrozenLoggerConfigPM(**val.model_dump())
+ val = FrozenPathsConfig(**val.model_dump())
return val
- model_config = SettingsConfigDict(env_prefix=ENV_PREFIX_API)
-
-
-class FrozenApiConfig(ApiConfig):
@model_validator(mode="before")
@classmethod
- def _check_args(cls, data: Any) -> Any:
- if isinstance(data, dict) and utils.is_running_bin():
- _has_host_arg = False
+ def _check_args(cls, values: Dict[str, Any]) -> Dict[str, Any]:
+ if (
+ sys.argv[0].endswith("uvicorn")
+ or sys.argv[0].endswith("fastapi")
+ or sys.argv[0].endswith("gunicorn")
+ ):
+ _has_host = False
for _i, _arg in enumerate(sys.argv):
- if (
- _arg.startswith("--ssl")
- or _arg.startswith("--keyfile")
- or _arg.startswith("--certfile")
- ):
- data["http_scheme"] = HTTPSchemeEnum.https
+ if _arg.startswith("--ssl"):
+ values["http_scheme"] = HTTPSchemeEnum.https
if _arg.startswith("--host="):
- _has_host_arg = True
- data["bind_host"] = _arg.split("=")[1]
+ _has_host = True
+ values["bind_host"] = _arg.split("=")[1]
elif (_arg == "--host") and (_i + 1 < len(sys.argv)):
- _has_host_arg = True
- data["bind_host"] = sys.argv[_i + 1]
+ _has_host = True
+ values["bind_host"] = sys.argv[_i + 1]
if _arg.startswith("--port="):
- data["port"] = int(_arg.split("=")[1])
+ values["port"] = int(_arg.split("=")[1])
elif (_arg == "--port") and (_i + 1 < len(sys.argv)):
- data["port"] = int(sys.argv[_i + 1])
+ values["port"] = int(sys.argv[_i + 1])
- if not _has_host_arg:
- data["bind_host"] = "127.0.0.1"
+ if not _has_host:
+ values["bind_host"] = "127.0.0.1"
if sys.argv[0].endswith("fastapi") and sys.argv[1] == "run":
- data["bind_host"] = "0.0.0.0" # nosec B104
+ values["bind_host"] = "0.0.0.0"
- return data
+ elif values["security"]["ssl"]["enabled"]:
+ values["http_scheme"] = HTTPSchemeEnum.https
+ return values
+
+ model_config = SettingsConfigDict(env_prefix=ENV_PREFIX_API)
+
+
+class FrozenApiConfig(ApiConfig):
model_config = SettingsConfigDict(frozen=True)
-__all__ = [
- "ApiConfig",
- "FrozenApiConfig",
-]
+__all__ = ["ApiConfig", "FrozenApiConfig"]
diff --git a/src/bv_challenge/challenge/api/core/configs/_base.py b/src/bv_challenge/challenge/api/core/configs/_base.py
index ed31b1f..cb9fb83 100644
--- a/src/bv_challenge/challenge/api/core/configs/_base.py
+++ b/src/bv_challenge/challenge/api/core/configs/_base.py
@@ -1,70 +1,31 @@
+# -*- coding: utf-8 -*-
+
+from typing import Type, Tuple
+
from pydantic_settings import (
BaseSettings,
SettingsConfigDict,
PydanticBaseSettingsSource,
- CliSettingsSource,
- NestedSecretsSettingsSource,
)
-from api.core import utils
-
class BaseConfig(BaseSettings):
- model_config = SettingsConfigDict(
- extra="allow",
- env_file=".env",
- validate_default=True,
- validate_assignment=True,
- arbitrary_types_allowed=True,
- )
-
-
-class FrozenBaseConfig(BaseConfig):
- model_config = SettingsConfigDict(frozen=True)
+ model_config = SettingsConfigDict(extra="allow", arbitrary_types_allowed=True)
@classmethod
def settings_customise_sources(
cls,
- settings_cls: type[BaseSettings],
+ settings_cls: Type[BaseSettings],
init_settings: PydanticBaseSettingsSource,
env_settings: PydanticBaseSettingsSource,
dotenv_settings: PydanticBaseSettingsSource,
file_secret_settings: PydanticBaseSettingsSource,
- ) -> tuple[PydanticBaseSettingsSource, ...]:
- return (
- NestedSecretsSettingsSource(file_secret_settings),
- dotenv_settings,
- env_settings,
- init_settings,
- )
+ ) -> Tuple[PydanticBaseSettingsSource, ...]:
+ return dotenv_settings, env_settings, init_settings, file_secret_settings
-class BaseMainConfig(FrozenBaseConfig):
- @classmethod
- def settings_customise_sources(
- cls,
- settings_cls: type[BaseSettings],
- init_settings: PydanticBaseSettingsSource,
- env_settings: PydanticBaseSettingsSource,
- dotenv_settings: PydanticBaseSettingsSource,
- file_secret_settings: PydanticBaseSettingsSource,
- ) -> tuple[PydanticBaseSettingsSource, ...]:
- _sources = []
- if not utils.is_running_bin():
- _sources.append(CliSettingsSource(settings_cls, cli_parse_args=True))
- _sources.extend(
- [
- NestedSecretsSettingsSource(file_secret_settings),
- dotenv_settings,
- env_settings,
- init_settings,
- ]
- )
- return tuple(_sources)
+class FrozenBaseConfig(BaseConfig):
+ model_config = SettingsConfigDict(frozen=True)
-__all__ = [
- "BaseConfig",
- "FrozenBaseConfig",
- "BaseMainConfig",
-]
+__all__ = ["BaseConfig", "FrozenBaseConfig"]
diff --git a/src/bv_challenge/challenge/api/core/configs/_challenge.py b/src/bv_challenge/challenge/api/core/configs/_challenge.py
new file mode 100644
index 0000000..465ccaa
--- /dev/null
+++ b/src/bv_challenge/challenge/api/core/configs/_challenge.py
@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+
+from datetime import datetime
+from typing import List
+
+from pydantic import Field, constr
+from pydantic_settings import SettingsConfigDict
+
+from api.core.constants import ALPHANUM_HOST_REGEX, ENV_PREFIX
+from ._base import FrozenBaseConfig
+
+
+class ChallengeConfig(FrozenBaseConfig):
+ n_ch_per_epoch: int = Field(...)
+ n_run_per_ch: int = Field(...)
+ allowed_pip_pkg_dt: datetime = Field(...)
+ allowed_file_exts: List[
+ constr(
+ strip_whitespace=True,
+ min_length=2,
+ max_length=16,
+ pattern=ALPHANUM_HOST_REGEX,
+ ) # type: ignore
+ ] = Field(..., min_length=1)
+ bot_timeout: int = Field(..., ge=1)
+ # Layer 1/2 fallback score policy (not detector secrets — just policy).
+ gate_fail_score: float = Field(default=0.0, ge=0.0, le=1.0)
+ metrics_processor_error_score: float = Field(default=0.5, ge=0.0, le=1.0)
+ session_timeout_score: float = Field(default=0.0, ge=0.0, le=1.0)
+ runner_fail_score: float = Field(default=0.0, ge=0.0, le=1.0)
+ # VM configuration for remote Docker build/run
+ vm_endpoint: str = Field(...)
+ vm_timeout: int = Field(default=120, ge=1)
+ vm_ssl_verify: bool = Field(default=True)
+
+ model_config = SettingsConfigDict(env_prefix=f"{ENV_PREFIX}CHALLENGE_")
+
+
+__all__ = ["ChallengeConfig"]
diff --git a/src/bv_challenge/challenge/api/core/configs/_dev.py b/src/bv_challenge/challenge/api/core/configs/_dev.py
new file mode 100644
index 0000000..2012d55
--- /dev/null
+++ b/src/bv_challenge/challenge/api/core/configs/_dev.py
@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+
+from typing import Any, Dict, List, Optional
+
+from pydantic import Field, constr, model_validator
+from pydantic_settings import SettingsConfigDict
+
+from api.core.constants import ENV_PREFIX_API
+from ._base import BaseConfig
+
+
+class DevConfig(BaseConfig):
+ reload: bool = Field(...)
+ reload_includes: Optional[
+ List[constr(strip_whitespace=True, min_length=1, max_length=256)] # type: ignore
+ ] = Field(default=None)
+ reload_excludes: Optional[
+ List[constr(strip_whitespace=True, min_length=1, max_length=256)] # type: ignore
+ ] = Field(default=None)
+
+ model_config = SettingsConfigDict(env_prefix=f"{ENV_PREFIX_API}DEV_")
+
+
+class FrozenDevConfig(DevConfig):
+ @model_validator(mode="before")
+ @classmethod
+ def _check_all(cls, values: Dict[str, Any]) -> Dict[str, Any]:
+ if not values["reload"]:
+ values["reload_includes"] = None
+ values["reload_excludes"] = None
+
+ return values
+
+ model_config = SettingsConfigDict(frozen=True)
+
+
+__all__ = ["DevConfig", "FrozenDevConfig"]
diff --git a/src/bv_challenge/challenge/api/core/configs/_docs.py b/src/bv_challenge/challenge/api/core/configs/_docs.py
index 1fa3484..1db5ba5 100644
--- a/src/bv_challenge/challenge/api/core/configs/_docs.py
+++ b/src/bv_challenge/challenge/api/core/configs/_docs.py
@@ -1,84 +1,69 @@
-from typing import Any
+# -*- coding: utf-8 -*-
-from pydantic import Field, model_validator
-from pydantic_settings import SettingsConfigDict
+from typing import Any, Dict, List, Optional
-from potato_util import validator
+from pydantic import Field, constr, model_validator
+from pydantic_settings import SettingsConfigDict
from api.core.constants import ENV_PREFIX_API
-
+from api.core.utils import validator
from ._base import BaseConfig
class DocsConfig(BaseConfig):
- enabled: bool = Field(default=True)
- openapi_url: str | None = Field(default="{api_prefix}/openapi.json")
- docs_url: str | None = Field(default="{api_prefix}/docs")
- redoc_url: str | None = Field(default="{api_prefix}/redoc")
- swagger_ui_oauth2_redirect_url: str | None = Field(
- default="{api_prefix}/docs/oauth2-redirect"
- )
- summary: str | None = Field(default="This is a RedTeam Subnet's bot virus challenge repository.")
+ enabled: bool = Field(...)
+ openapi_url: Optional[
+ constr(strip_whitespace=True, max_length=128) # type: ignore
+ ] = Field(default=None)
+ docs_url: Optional[
+ constr(strip_whitespace=True, max_length=128) # type: ignore
+ ] = Field(default=None)
+ redoc_url: Optional[
+ constr(strip_whitespace=True, max_length=128) # type: ignore
+ ] = Field(default=None)
+ swagger_ui_oauth2_redirect_url: Optional[
+ constr(strip_whitespace=True, max_length=128) # type: ignore
+ ] = Field(default=None)
+ summary: Optional[
+ constr(strip_whitespace=True, min_length=2, max_length=128) # type: ignore
+ ] = Field(default=None)
description: str = Field(default="", max_length=8192)
- terms_of_service: str | None = Field(
- default="https://theredteam.io/terms"
- )
- contact: dict[str, Any] | None = Field(
- default={
- "name": "Support Team",
- "email": "support@theredteam.io",
- "url": "https://theredteam.io/contact",
- }
- )
- license_info: dict[str, Any] | None = Field(
- default={
- "name": "MIT License",
- "url": "https://opensource.org/licenses/mit",
- }
- )
- openapi_tags: list[dict[str, Any]] | None = Field(
- default=[
- {"name": "Utils", "description": "Useful utility endpoints."},
- {"name": "Challenge", "description": "Endpoints for challenge."},
- {"name": "Default", "description": "Redirection of default endpoints."},
- ]
- )
- swagger_ui_parameters: dict[str, Any] | None = Field(
- default={"syntaxHighlight": {"theme": "nord"}}
- )
+ terms_of_service: Optional[
+ constr(strip_whitespace=True, min_length=1, max_length=256) # type: ignore
+ ] = Field(default=None)
+ contact: Optional[Dict[str, Any]] = Field(default=None)
+ license_info: Optional[Dict[str, Any]] = Field(default=None)
+ openapi_tags: Optional[List[Dict[str, Any]]] = Field(default=None)
+ swagger_ui_parameters: Optional[Dict[str, Any]] = Field(default=None)
model_config = SettingsConfigDict(env_prefix=f"{ENV_PREFIX_API}DOCS_")
class FrozenDocsConfig(DocsConfig):
+
@model_validator(mode="before")
@classmethod
- def _check_all(cls, data: Any) -> Any:
- if isinstance(data, dict):
- if ("openapi_url" in data) and (data["openapi_url"] == ""):
- data["openapi_url"] = None
-
- if ("docs_url" in data) and (data["docs_url"] == ""):
- data["docs_url"] = None
-
- if ("redoc_url" in data) and (data["redoc_url"] == ""):
- data["redoc_url"] = None
-
- if ("swagger_ui_oauth2_redirect_url" in data) and (
- data["swagger_ui_oauth2_redirect_url"] == ""
- ):
- data["swagger_ui_oauth2_redirect_url"] = None
-
- try:
- if ("enabled" in data) and validator.is_falsy(data["enabled"]):
- data["openapi_url"] = None
- data["docs_url"] = None
- data["redoc_url"] = None
- data["swagger_ui_oauth2_redirect_url"] = None
- except ValueError:
- pass
-
- return data
+ def _check_all(cls, values: Dict[str, Any]) -> Dict[str, Any]:
+
+ if values["openapi_url"] == "":
+ values["openapi_url"] = None
+
+ if values["docs_url"] == "":
+ values["docs_url"] = None
+
+ if values["redoc_url"] == "":
+ values["redoc_url"] = None
+
+ if values["swagger_ui_oauth2_redirect_url"] == "":
+ values["swagger_ui_oauth2_redirect_url"] = None
+
+ if validator.is_falsy(values["enabled"]):
+ values["openapi_url"] = None
+ values["docs_url"] = None
+ values["redoc_url"] = None
+ values["swagger_ui_oauth2_redirect_url"] = None
+
+ return values
model_config = SettingsConfigDict(frozen=True)
diff --git a/src/bv_challenge/challenge/api/core/configs/_logger.py b/src/bv_challenge/challenge/api/core/configs/_logger.py
deleted file mode 100644
index 603e579..0000000
--- a/src/bv_challenge/challenge/api/core/configs/_logger.py
+++ /dev/null
@@ -1,42 +0,0 @@
-import os
-
-from pydantic import Field, field_validator
-from pydantic_settings import SettingsConfigDict
-
-from beans_logging.config import FileConfigPM as BaseFileConfigPM
-from beans_logging_fastapi import LoggerConfigPM as BaseLoggerConfigPM
-
-from api.core.constants import ENV_PREFIX_API
-
-from ._base import BaseConfig
-
-
-class FileConfigPM(BaseFileConfigPM, BaseConfig):
- logs_dir: str = Field(default="./logs", min_length=2, max_length=1024)
-
- @field_validator("logs_dir", mode="after")
- @classmethod
- def _check_logger(cls, val: str) -> str:
- _logs_dir = os.getenv(f"{ENV_PREFIX_API}LOGS_DIR", "")
- if _logs_dir:
- val = _logs_dir
-
- return val
-
-
-class LoggerConfigPM(BaseLoggerConfigPM, BaseConfig):
- app_name: str = Field(default="{api_slug}", min_length=1, max_length=128)
- file: FileConfigPM = Field(default_factory=FileConfigPM) # type: ignore
-
- model_config = SettingsConfigDict(env_prefix=f"{ENV_PREFIX_API}LOGGER_")
-
-
-class FrozenLoggerConfigPM(LoggerConfigPM):
- model_config = SettingsConfigDict(frozen=True)
-
-
-__all__ = [
- "FileConfigPM",
- "LoggerConfigPM",
- "FrozenLoggerConfigPM",
-]
diff --git a/src/bv_challenge/challenge/api/core/configs/_main.py b/src/bv_challenge/challenge/api/core/configs/_main.py
index c699916..0f33538 100644
--- a/src/bv_challenge/challenge/api/core/configs/_main.py
+++ b/src/bv_challenge/challenge/api/core/configs/_main.py
@@ -1,56 +1,99 @@
+# -*- coding: utf-8 -*-
+
import os
+from typing_extensions import Self
-from pydantic import Field, field_validator, ValidationInfo
+from pydantic import Field, constr, field_validator, ValidationInfo, model_validator
from pydantic_settings import SettingsConfigDict
-from potato_util.constants import EnvEnum
-
-from api.core.constants import ENV_PREFIX
+from beans_logging import LoggerConfigPM
-from ._base import BaseMainConfig
-from ._uvicorn import UvicornConfig, FrozenUvicornConfig
+from api.__version__ import __version__
+from api.core.constants import EnvEnum, ENV_PREFIX, ENV_PREFIX_API
+from ._base import FrozenBaseConfig
+from ._dev import DevConfig, FrozenDevConfig
from ._api import ApiConfig, FrozenApiConfig
+from ._challenge import ChallengeConfig
# Main config schema:
-class MainConfig(BaseMainConfig):
- env: EnvEnum = Field(default=EnvEnum.LOCAL, alias="env")
- debug: bool = Field(default=False, alias="debug")
- api: ApiConfig = Field(default_factory=ApiConfig)
+class MainConfig(FrozenBaseConfig):
+ env: EnvEnum = Field(...)
+ debug: bool = Field(...)
+ version: constr(strip_whitespace=True) = Field( # type: ignore
+ default=__version__, min_length=3, max_length=32
+ )
+ api: ApiConfig = Field(...)
+ challenge: ChallengeConfig = Field(...)
+ logger: LoggerConfigPM = Field(default_factory=LoggerConfigPM)
+
+ @field_validator("env")
+ @classmethod
+ def _check_env(cls, val: EnvEnum) -> EnvEnum:
+ _env = "ENV"
+ if _env in os.environ:
+ _env = os.getenv(_env).upper()
+ val = EnvEnum(_env)
+
+ return val
+
+ @field_validator("debug")
+ @classmethod
+ def _check_debug(cls, val: str) -> str:
+ _debug_env = "DEBUG"
+ if _debug_env in os.environ:
+ val = os.getenv(_debug_env)
+
+ return val
- @field_validator("api", mode="after")
+ @field_validator("version")
+ @classmethod
+ def _check_version(cls, val: str) -> str:
+ val = __version__
+ return val
+
+ @field_validator("api")
@classmethod
def _check_api(cls, val: ApiConfig, info: ValidationInfo) -> FrozenApiConfig:
- _uvicorn: UvicornConfig = val.uvicorn
+ _dev: DevConfig = val.dev
if ("env" in info.data) and (info.data["env"] == EnvEnum.DEVELOPMENT):
- _uvicorn.reload = True
+ _dev.reload = True
- if val.security.ssl.enabled:
- if not _uvicorn.ssl_keyfile:
- _uvicorn.ssl_keyfile = os.path.join(
- val.paths.ssl_dir, val.security.ssl.key_fname
- )
+ _dev = FrozenDevConfig(**_dev.model_dump())
+ val = FrozenApiConfig(dev=_dev, **val.model_dump(exclude={"dev"}))
+ return val
- if not _uvicorn.ssl_certfile:
- _uvicorn.ssl_certfile = os.path.join(
- val.paths.ssl_dir, val.security.ssl.cert_fname
- )
+ @field_validator("logger")
+ @classmethod
+ def _check_logger(cls, val: LoggerConfigPM, info: ValidationInfo) -> LoggerConfigPM:
+ if "api" in info.data:
+ if not val.app_name:
+ val.app_name = info.data["api"].slug
+ elif "{api_slug}" in val.app_name:
+ val.app_name = val.app_name.format(api_slug=info.data["api"].slug)
+
+ _logs_dir_env = f"{ENV_PREFIX_API}LOGS_DIR"
+ if _logs_dir_env in os.environ:
+ val.file.logs_dir = os.getenv(_logs_dir_env)
- _uvicorn = FrozenUvicornConfig(**_uvicorn.model_dump())
- val = FrozenApiConfig(uvicorn=_uvicorn, **val.model_dump(exclude={"uvicorn"}))
return val
- model_config = SettingsConfigDict(
- env_prefix=ENV_PREFIX,
- env_nested_delimiter="__",
- cli_prefix="",
- secrets_dir="/run/secrets",
- secrets_prefix="",
- secrets_nested_delimiter="_",
- secrets_dir_missing="ok", # pragma: allowlist secret
- ) # type: ignore
+ @model_validator(mode="after")
+ def _check_required_envs(self) -> Self:
+ _required_envs = [
+ # f"{ENV_PREFIX_API}SECURITY_JWT_SECRET",
+ ]
+
+ if (self.env == EnvEnum.STAGING) or (self.env == EnvEnum.PRODUCTION):
+ for _required_env in _required_envs:
+ if _required_env not in os.environ:
+ raise ValueError(
+ f"Missing required '{_required_env}' environment variable for STAGING/PRODUCTION environment!"
+ )
+
+ return self
+
+ model_config = SettingsConfigDict(env_prefix=ENV_PREFIX, env_nested_delimiter="__")
-__all__ = [
- "MainConfig",
-]
+__all__ = ["MainConfig"]
diff --git a/src/bv_challenge/challenge/api/core/configs/_paths.py b/src/bv_challenge/challenge/api/core/configs/_paths.py
index b880b79..30da454 100644
--- a/src/bv_challenge/challenge/api/core/configs/_paths.py
+++ b/src/bv_challenge/challenge/api/core/configs/_paths.py
@@ -1,43 +1,50 @@
+# -*- coding: utf-8 -*-
+
import os
-from typing import Any
+from typing import Any, Dict
-from pydantic import Field, model_validator, field_validator
+from pydantic import Field, constr, model_validator, field_validator
from pydantic_settings import SettingsConfigDict
from api.core.constants import ENV_PREFIX_API
-
from ._base import BaseConfig
class PathsConfig(BaseConfig):
- tmp_dir: str = Field(default="./tmp", min_length=2, max_length=1024) # nosec B108
- uploads_dir: str = Field(default="{tmp_dir}/uploads", min_length=2, max_length=1024)
- data_dir: str = Field(default="./data", min_length=2, max_length=1024)
- security_dir: str = Field(
- default="{data_dir}/security", min_length=2, max_length=1024
+ tmp_dir: constr(strip_whitespace=True) = Field(..., min_length=2, max_length=1024) # type: ignore
+ uploads_dir: constr(strip_whitespace=True) = Field( # type: ignore
+ ..., min_length=2, max_length=1024
)
- ssl_dir: str = Field(
- default="{data_dir}/security/ssl", min_length=2, max_length=1024
+ data_dir: constr(strip_whitespace=True) = Field( # type: ignore
+ ..., min_length=2, max_length=1024
)
- asymmetric_keys_dir: str = Field(
- default="{data_dir}/security/asymmetric_keys", min_length=2, max_length=1024
+ security_dir: constr(strip_whitespace=True) = Field( # type: ignore
+ ..., min_length=2, max_length=1024
)
+ ssl_dir: constr(strip_whitespace=True) = Field(..., min_length=2, max_length=1024) # type: ignore
+ asymmetric_keys_dir: constr(strip_whitespace=True) = Field( # type: ignore
+ ..., min_length=2, max_length=1024
+ )
+ # models_dir: constr(strip_whitespace=True) = Field( # type: ignore
+ # ..., min_length=2, max_length=1024
+ # )
+ # model_dir: constr(strip_whitespace=True) = Field(..., min_length=2, max_length=1024) # type: ignore
- @field_validator("tmp_dir", mode="after")
+ @field_validator("data_dir")
@classmethod
- def _check_tmp_dir(cls, val: str) -> str:
- _tmp_dir = os.getenv(f"{ENV_PREFIX_API}TMP_DIR", "")
- if _tmp_dir:
- val = _tmp_dir
+ def _check_data_dir(cls, val: str) -> str:
+ _data_dir_env = f"{ENV_PREFIX_API}DATA_DIR"
+ if _data_dir_env in os.environ:
+ val = os.getenv(_data_dir_env)
return val
- @field_validator("data_dir", mode="after")
+ @field_validator("tmp_dir")
@classmethod
- def _check_data_dir(cls, val: str) -> str:
- _data_dir = os.getenv(f"{ENV_PREFIX_API}DATA_DIR", "")
- if _data_dir:
- val = _data_dir
+ def _check_tmp_dir(cls, val: str) -> str:
+ _tmp_dir_env = f"{ENV_PREFIX_API}TMP_DIR"
+ if _tmp_dir_env in os.environ:
+ val = os.getenv(_tmp_dir_env)
return val
@@ -47,22 +54,14 @@ def _check_data_dir(cls, val: str) -> str:
class FrozenPathsConfig(PathsConfig):
@model_validator(mode="before")
@classmethod
- def _check_all(cls, data: Any) -> Any:
- if isinstance(data, dict):
- for _key, _val in data.items():
- if isinstance(_val, str):
- if ("data_dir" in data) and ("{data_dir}" in _val):
- data[_key] = _val.format(data_dir=data["data_dir"])
-
- if ("tmp_dir" in data) and ("{tmp_dir}" in _val):
- data[_key] = _val.format(tmp_dir=data["tmp_dir"])
+ def _check_all(cls, values: Dict[str, Any]) -> Dict[str, Any]:
+ for _key, _val in values.items():
+ if isinstance(_val, str) and ("{data_dir}" in _val):
+ values[_key] = _val.format(data_dir=values["data_dir"])
- return data
+ return values
model_config = SettingsConfigDict(frozen=True)
-__all__ = [
- "PathsConfig",
- "FrozenPathsConfig",
-]
+__all__ = ["PathsConfig", "FrozenPathsConfig"]
diff --git a/src/bv_challenge/challenge/api/core/configs/_security.py b/src/bv_challenge/challenge/api/core/configs/_security.py
index fdb16b6..f747b28 100644
--- a/src/bv_challenge/challenge/api/core/configs/_security.py
+++ b/src/bv_challenge/challenge/api/core/configs/_security.py
@@ -1,53 +1,51 @@
-from pydantic import Field, constr, SecretStr
+# -*- coding: utf-8 -*-
+
+from typing import List, Optional
+
+from pydantic import Field, constr
from pydantic_settings import SettingsConfigDict
-from potato_util.constants import (
+from api.core.constants import (
+ ENV_PREFIX_API,
HTTP_METHOD_REGEX,
ASYMMETRIC_ALGORITHM_REGEX,
- JWT_ALGORITHM_REGEX,
)
-
-from api.core.constants import ENV_PREFIX, ENV_PREFIX_API
-
from ._base import FrozenBaseConfig
+
_ENV_PREFIX_SECURITY = f"{ENV_PREFIX_API}SECURITY_"
class CorsConfig(FrozenBaseConfig):
- allow_origins: list[str] = Field(default=["*"])
- allow_origin_regex: str | None = Field(default=None)
- allow_headers: list[str] = Field(default=["*"])
- allow_methods: list[constr(strip_whitespace=True, pattern=HTTP_METHOD_REGEX)] = ( # type: ignore
- Field(
- default=[
- "GET",
- "POST",
- "PUT",
- "PATCH",
- "DELETE",
- "HEAD",
- "OPTIONS",
- "CONNECT",
- ]
- )
+ allow_origins: List[
+ constr(strip_whitespace=True, min_length=1, max_length=256) # type: ignore
+ ] = Field(...)
+ allow_origin_regex: Optional[
+ constr(strip_whitespace=True, min_length=1, max_length=256) # type: ignore
+ ] = Field(default=None)
+ allow_headers: List[
+ constr(strip_whitespace=True, min_length=1, max_length=128) # type: ignore
+ ] = Field(...)
+ allow_methods: List[constr(strip_whitespace=True, pattern=HTTP_METHOD_REGEX)] = ( # type: ignore
+ Field(...)
)
- allow_credentials: bool = Field(default=False)
- allow_private_network: bool = Field(default=False)
- expose_headers: list[str] = Field(default=[])
- max_age: int = Field(default=600, ge=0, le=86_400) # Seconds (10 minutes)
+ allow_credentials: bool = Field(...)
+ expose_headers: List[
+ constr(strip_whitespace=True, min_length=1, max_length=128) # type: ignore
+ ] = Field(...)
+ max_age: int = Field(..., ge=0, le=86_400)
model_config = SettingsConfigDict(env_prefix=f"{_ENV_PREFIX_SECURITY}CORS_")
class X509AttrsConfig(FrozenBaseConfig):
- C: str = Field(default="US", min_length=2, max_length=2)
- ST: str = Field(default="Washington", min_length=2, max_length=256)
- L: str = Field(default="Seattle", min_length=2, max_length=256)
- O: str = Field(default="Organization", min_length=2, max_length=256)
- OU: str = Field(default="Organization Unit", min_length=2, max_length=256)
- CN: str = Field(default="localhost", min_length=2, max_length=256)
- DNS: str = Field(default="localhost", min_length=2, max_length=256)
+ C: constr(strip_whitespace=True, to_upper=True) = Field(default="US", min_length=2, max_length=2) # type: ignore
+ ST: constr(strip_whitespace=True) = Field(default="Washington", min_length=2, max_length=256) # type: ignore
+ L: constr(strip_whitespace=True) = Field(default="Seattle", min_length=2, max_length=256) # type: ignore
+ O: constr(strip_whitespace=True) = Field(default="Organization", min_length=2, max_length=256) # type: ignore
+ OU: constr(strip_whitespace=True) = Field(default="Organization Unit", min_length=2, max_length=256) # type: ignore
+ CN: constr(strip_whitespace=True) = Field(default="localhost", min_length=2, max_length=256) # type: ignore
+ DNS: constr(strip_whitespace=True) = Field(default="localhost", min_length=2, max_length=256) # type: ignore
model_config = SettingsConfigDict(
env_prefix=f"{_ENV_PREFIX_SECURITY}SSL_X509_ATTRS_"
@@ -55,60 +53,40 @@ class X509AttrsConfig(FrozenBaseConfig):
class SSLConfig(FrozenBaseConfig):
- enabled: bool = Field(default=False)
- generate: bool = Field(default=False)
- key_size: int = Field(default=2048, ge=2048, le=8192)
- key_fname: str = Field(default="key.pem", min_length=2, max_length=256)
- cert_fname: str = Field(default="cert.pem", min_length=2, max_length=256)
+ enabled: bool = Field(...)
+ generate: bool = Field(...)
+ key_size: int = Field(..., ge=2048, le=8192)
+ key_fname: constr(strip_whitespace=True) = Field(..., min_length=2, max_length=256) # type: ignore
+ cert_fname: constr(strip_whitespace=True) = Field(..., min_length=2, max_length=256) # type: ignore
x509_attrs: X509AttrsConfig = Field(default_factory=X509AttrsConfig)
model_config = SettingsConfigDict(env_prefix=f"{_ENV_PREFIX_SECURITY}SSL_")
class AsymmetricConfig(FrozenBaseConfig):
- generate: bool = Field(default=False)
- algorithm: str = Field(default="RS256", pattern=ASYMMETRIC_ALGORITHM_REGEX)
- key_size: int = Field(default=2048, ge=2048, le=8192)
- private_key_fname: str = Field(
- default="private_key.pem", min_length=2, max_length=256
+ generate: bool = Field(...)
+ algorithm: constr(strip_whitespace=True) = Field(..., pattern=ASYMMETRIC_ALGORITHM_REGEX) # type: ignore
+ key_size: int = Field(..., ge=2048, le=8192)
+ private_key_fname: constr(strip_whitespace=True) = Field( # type: ignore
+ ..., min_length=2, max_length=256
)
- public_key_fname: str = Field(
- default="public_key.pem", min_length=2, max_length=256
+ public_key_fname: constr(strip_whitespace=True) = Field( # type: ignore
+ ..., min_length=2, max_length=256
)
model_config = SettingsConfigDict(env_prefix=f"{_ENV_PREFIX_SECURITY}ASYMMETRIC_")
-class JWTConfig(FrozenBaseConfig):
- secret: SecretStr = Field(
- default_factory=lambda: SecretStr(f"{ENV_PREFIX}JWT_SECRET123"),
- min_length=8,
- max_length=64,
- )
- algorithm: str = Field(default="HS256", pattern=JWT_ALGORITHM_REGEX)
-
- model_config = SettingsConfigDict(env_prefix=f"{_ENV_PREFIX_SECURITY}JWT_")
-
-
-class PasswordConfig(FrozenBaseConfig):
- pepper: SecretStr = Field(
- default_factory=lambda: SecretStr(f"{ENV_PREFIX}PASSWORD_PEPPER123"),
- min_length=8,
- max_length=32,
- )
- min_length: int = Field(default=8, ge=8, le=128)
- max_length: int = Field(default=128, ge=8, le=128)
-
- model_config = SettingsConfigDict(env_prefix=f"{_ENV_PREFIX_SECURITY}PASSWORD_")
-
-
class SecurityConfig(FrozenBaseConfig):
- allowed_hosts: list[str] = Field(default=["*"])
- cors: CorsConfig = Field(default_factory=CorsConfig)
- ssl: SSLConfig = Field(default_factory=SSLConfig)
- asymmetric: AsymmetricConfig = Field(default_factory=AsymmetricConfig)
- jwt: JWTConfig = Field(default_factory=JWTConfig)
- password: PasswordConfig = Field(default_factory=PasswordConfig)
+ allowed_hosts: List[constr(strip_whitespace=True, min_length=1, max_length=256)] = ( # type: ignore
+ Field(...)
+ )
+ forwarded_allow_ips: List[
+ constr(strip_whitespace=True, min_length=1, max_length=256) # type: ignore
+ ] = Field(...)
+ cors: CorsConfig = Field(...)
+ ssl: SSLConfig = Field(...)
+ asymmetric: AsymmetricConfig = Field(...)
model_config = SettingsConfigDict(env_prefix=_ENV_PREFIX_SECURITY)
@@ -119,6 +97,4 @@ class SecurityConfig(FrozenBaseConfig):
"X509AttrsConfig",
"SSLConfig",
"AsymmetricConfig",
- "JWTConfig",
- "PasswordConfig",
]
diff --git a/src/bv_challenge/challenge/api/core/configs/_uvicorn.py b/src/bv_challenge/challenge/api/core/configs/_uvicorn.py
deleted file mode 100644
index 223faa7..0000000
--- a/src/bv_challenge/challenge/api/core/configs/_uvicorn.py
+++ /dev/null
@@ -1,53 +0,0 @@
-import os
-from typing import Any
-
-from pydantic import Field, model_validator
-from pydantic_settings import SettingsConfigDict
-
-from api.core.constants import ENV_PREFIX_API
-
-from ._base import BaseConfig
-
-
-class UvicornConfig(BaseConfig):
- access_log: bool = Field(default=False)
- server_header: bool = Field(default=False)
- proxy_headers: bool = Field(default=True)
- forwarded_allow_ips: list[str] | str | None = Field(default=["*"])
- ssl_keyfile: str | None = Field(default=None)
- ssl_certfile: str | None = Field(default=None)
- reload: bool = Field(default=False)
- reload_dirs: list[str] | str | None = Field(default=None)
- reload_includes: list[str] | str | None = Field(
- default=["*.json", "*.yml", "*.yaml", "*.toml", "*.md"]
- )
- reload_excludes: list[str] | str | None = Field(
- default=[".*", "~*", ".py[cod]", ".sw.*", "__pycache__", "*.log", "logs"]
- )
-
- model_config = SettingsConfigDict(env_prefix=f"{ENV_PREFIX_API}UVICORN_")
-
-
-class FrozenUvicornConfig(UvicornConfig):
- @model_validator(mode="before")
- @classmethod
- def _check_all(cls, data: Any) -> Any:
- if isinstance(data, dict):
- if "reload" in data:
- if data["reload"]:
- if (not data.get("reload_dirs")) and os.path.isdir("./src"):
- data["reload_dirs"] = ["./src"]
- else:
- data["reload_includes"] = None
- data["reload_excludes"] = None
- data["reload_dirs"] = None
-
- return data
-
- model_config = SettingsConfigDict(frozen=True)
-
-
-__all__ = [
- "UvicornConfig",
- "FrozenUvicornConfig",
-]
diff --git a/src/bv_challenge/challenge/api/core/constants/__init__.py b/src/bv_challenge/challenge/api/core/constants/__init__.py
index f6ecab7..8bd1879 100644
--- a/src/bv_challenge/challenge/api/core/constants/__init__.py
+++ b/src/bv_challenge/challenge/api/core/constants/__init__.py
@@ -1,4 +1,4 @@
-# flake8: noqa
+# -*- coding: utf-8 -*-
from ._base import *
from ._regex import *
diff --git a/src/bv_challenge/challenge/api/core/constants/_base.py b/src/bv_challenge/challenge/api/core/constants/_base.py
index ec418c1..fbe5f32 100644
--- a/src/bv_challenge/challenge/api/core/constants/_base.py
+++ b/src/bv_challenge/challenge/api/core/constants/_base.py
@@ -1,10 +1,62 @@
-ENV_PREFIX = "BV_CHALLENGE_"
-ENV_PREFIX_API = f"{ENV_PREFIX}API_"
+# -*- coding: utf-8 -*-
+
+from enum import Enum
+
+
+ENV_PREFIX = "BV_"
+ENV_PREFIX_API = f"{ENV_PREFIX}CHALLENGE_API_"
+
+
+class EnvEnum(str, Enum):
+ LOCAL = "LOCAL"
+ DEVELOPMENT = "DEVELOPMENT"
+ TEST = "TEST"
+ DEMO = "DEMO"
+ DOCS = "DOCS"
+ STAGING = "STAGING"
+ PRODUCTION = "PRODUCTION"
+
+
+class WarnEnum(str, Enum):
+ ERROR = "ERROR"
+ ALWAYS = "ALWAYS"
+ DEBUG = "DEBUG"
+ IGNORE = "IGNORE"
+
+
+class LanguageEnum(str, Enum):
+ en = "en"
+ ko = "ko"
+ mn = "mn"
+
+
+class CurrencyEnum(str, Enum):
+ USD = "USD"
+ KRW = "KRW"
+ MNT = "MNT"
+
+
+class HashAlgoEnum(str, Enum):
+ md5 = "md5"
+ sha1 = "sha1"
+ sha224 = "sha224"
+ sha256 = "sha256"
+ sha384 = "sha384"
+ sha512 = "sha512"
+
+
+class HTTPSchemeEnum(str, Enum):
+ http = "http"
+ https = "https"
-API_SLUG = "rest-bv-challenge"
__all__ = [
"ENV_PREFIX",
"ENV_PREFIX_API",
- "API_SLUG",
+ "EnvEnum",
+ "WarnEnum",
+ "LanguageEnum",
+ "CurrencyEnum",
+ "HashAlgoEnum",
+ "HTTPSchemeEnum",
]
diff --git a/src/bv_challenge/challenge/api/core/constants/_error_code.py b/src/bv_challenge/challenge/api/core/constants/_error_code.py
index 76d2c9b..8a4c233 100644
--- a/src/bv_challenge/challenge/api/core/constants/_error_code.py
+++ b/src/bv_challenge/challenge/api/core/constants/_error_code.py
@@ -1,16 +1,20 @@
+# -*- coding: utf-8 -*-
+
from enum import Enum
from http import HTTPStatus
-from typing import Union, Any
+from typing import Union, Optional, Any
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, constr
class ErrorCodePM(BaseModel):
- code: str = Field(..., min_length=3, max_length=36)
- name: str = Field(..., min_length=3, max_length=64)
+ code: constr(strip_whitespace=True) = Field(..., min_length=3, max_length=36) # type: ignore
+ name: constr(strip_whitespace=True) = Field(..., min_length=3, max_length=64) # type: ignore
status_code: int = Field(..., ge=100, le=599)
- message: str = Field(..., min_length=1, max_length=256)
- description: str | None = Field(default=None, max_length=1024)
+ message: constr(strip_whitespace=True) = Field(..., min_length=1, max_length=256) # type: ignore
+ description: Optional[constr(strip_whitespace=True)] = Field( # type: ignore
+ default=None, max_length=1024
+ )
detail: Any = Field(default=None)
diff --git a/src/bv_challenge/challenge/api/core/constants/_regex.py b/src/bv_challenge/challenge/api/core/constants/_regex.py
index babab2c..3c4ad87 100644
--- a/src/bv_challenge/challenge/api/core/constants/_regex.py
+++ b/src/bv_challenge/challenge/api/core/constants/_regex.py
@@ -1,5 +1,51 @@
+# -*- coding: utf-8 -*-
+
# Valid characters:
+ALPHANUM_REGEX = r"^[0-9a-zA-Z]+$"
+ALPHANUM_SPACE_REGEX = r"^[0-9a-zA-Z ]+$"
+ALPHANUM_HYPHEN_REGEX = r"^[0-9a-zA-Z_\-]+$"
+ALPHANUM_HOST_REGEX = r"^[0-9a-zA-Z_\-.]+$"
+ALPHANUM_EXTEND_REGEX = r"^[0-9a-zA-Z_\-. ]+$"
+ALPHANUM_PATH_REGEX = r"^[0-9a-zA-Z_\-. \\\/]+$"
+
+REQUEST_ID_REGEX = (
+ r"\b[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\b|"
+ r"\b[0-9a-fA-F]{32}\b"
+)
+
+ALPHANUM_CUSTOM_REGEX = r"^[0-9a-zA-Z_\-:+/=]+$"
+REQUIREMENTS_REGEX = r"^[0-9a-zA-Z_\-.,\[\]!<>=~]+$"
+
+HTTP_METHOD_REGEX = r"^(GET|POST|PUT|PATCH|DELETE|HEAD|OPTIONS|CONNECT|TRACE|\*)$"
+ASYMMETRIC_ALGORITHM_REGEX = r"^(RS256|RS384|RS512)$"
+JWT_ALGORITHM_REGEX = r"^(HS256|HS384|HS512|ES256|ES256K|ES384|ES512|RS256|RS384|RS512|PS256|PS384|PS512|EdDSA)$"
+
# Invalid characters:
+SPECIAL_CHARS_REGEX = r"[&'\"<>]"
+SPECIAL_CHARS_BASE_REGEX = r"[&'\"<>\\\/]"
+SPECIAL_CHARS_LOW_REGEX = r"[&'\"<>\\\/`{}|]"
+SPECIAL_CHARS_MEDIUM_REGEX = r"[&'\"<>\\\/`{}|()\[\]]"
+SPECIAL_CHARS_HIGH_REGEX = r"[&'\"<>\\\/`{}|()\[\]!@#$%^*;:?]"
+SPECIAL_CHARS_STRICT_REGEX = r"[&'\"<>\\\/`{}|()\[\]~!@#$%^*_=\-+;:,.?\t\n ]"
-__all__ = []
+__all__ = [
+ "ALPHANUM_REGEX",
+ "ALPHANUM_SPACE_REGEX",
+ "ALPHANUM_HYPHEN_REGEX",
+ "ALPHANUM_HOST_REGEX",
+ "ALPHANUM_EXTEND_REGEX",
+ "ALPHANUM_PATH_REGEX",
+ "ALPHANUM_CUSTOM_REGEX",
+ "REQUEST_ID_REGEX",
+ "REQUIREMENTS_REGEX",
+ "HTTP_METHOD_REGEX",
+ "ASYMMETRIC_ALGORITHM_REGEX",
+ "JWT_ALGORITHM_REGEX",
+ "SPECIAL_CHARS_REGEX",
+ "SPECIAL_CHARS_BASE_REGEX",
+ "SPECIAL_CHARS_LOW_REGEX",
+ "SPECIAL_CHARS_MEDIUM_REGEX",
+ "SPECIAL_CHARS_HIGH_REGEX",
+ "SPECIAL_CHARS_STRICT_REGEX",
+]
diff --git a/src/bv_challenge/challenge/api/core/dependencies/__init__.py b/src/bv_challenge/challenge/api/core/dependencies/__init__.py
index e69de29..40a96af 100644
--- a/src/bv_challenge/challenge/api/core/dependencies/__init__.py
+++ b/src/bv_challenge/challenge/api/core/dependencies/__init__.py
@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-
diff --git a/src/bv_challenge/challenge/api/core/dependencies/auth.py b/src/bv_challenge/challenge/api/core/dependencies/auth.py
index afe1068..a0e5de1 100644
--- a/src/bv_challenge/challenge/api/core/dependencies/auth.py
+++ b/src/bv_challenge/challenge/api/core/dependencies/auth.py
@@ -1,30 +1,30 @@
-from typing import Any
+# -*- coding: utf-8 -*-
+
+from typing import Any, Dict, Optional, List
from jwt import ExpiredSignatureError, InvalidTokenError
from fastapi import Security, Depends, Request
from fastapi.security import HTTPAuthorizationCredentials, HTTPBearer
-from potato_util.constants import ALPHANUM_HOST_REGEX
-from potato_util import validator
-from potato_util.crypto import jwt as jwt_utils
-
-from api.core.constants import ErrorCodeEnum
+from api.core.constants import ErrorCodeEnum, ALPHANUM_HOST_REGEX
from api.config import config
+from api.core.utils import validator
+from api.helpers.crypto import jwt as jwt_helper
from api.core.exceptions import BaseHTTPException
+
_http_bearer = HTTPBearer(auto_error=False)
def auth_jwt(
request: Request,
- authorization: HTTPAuthorizationCredentials | None = Security(_http_bearer),
-) -> dict[str, Any]:
+ authorization: Optional[HTTPAuthorizationCredentials] = Security(_http_bearer),
+) -> Dict[str, Any]:
"""Dependency function to authenticate the access token (JWT) and get the payload.
Args:
request (Request , required): The FastAPI request object.
- authorization (HTTPAuthorizationCredentials, required): 'Authorization: Bearer '
- header credentials.
+ authorization (HTTPAuthorizationCredentials, required): 'Authorization: Bearer ' header credentials.
Raises:
BaseHTTPException: If the access token is missing.
@@ -32,7 +32,7 @@ def auth_jwt(
BaseHTTPException: If the access token is invalid.
Returns:
- dict[str, Any]: The decoded access token payload.
+ Dict[str, Any]: The decoded access token payload.
"""
if not authorization:
@@ -50,9 +50,9 @@ def auth_jwt(
headers={"WWW-Authenticate": 'Bearer error="invalid_token"'},
)
- _payload: dict[str, Any]
+ _payload: Dict[str, Any] = None
try:
- _payload: dict[str, Any] = jwt_utils.decode(
+ _payload: Dict[str, Any] = jwt_helper.decode(
token=_access_token,
key=config.api.security.jwt.secret,
algorithm=config.api.security.jwt.algorithm,
@@ -74,17 +74,17 @@ def auth_jwt(
return _payload
-def get_user_id(payload: dict[str, Any] = Depends(auth_jwt)) -> str:
+def get_user_id(payload: Dict[str, Any] = Depends(auth_jwt)) -> str:
"""Dependency function to get the user ID from the token payload.
Args:
- payload (dict[str, Any], required): The decoded access token payload.
+ payload (Dict[str, Any], required): The decoded access token payload.
Returns:
str: The user ID.
"""
- _user_id: str = payload.get("sub", "")
+ _user_id: str = payload.get("sub")
return _user_id
@@ -110,39 +110,36 @@ def __init__(self, allow_scope: str, allow_owner: bool = False):
self.allow_owner = allow_owner
def __call__(
- self, request: Request, payload: dict[str, Any] = Depends(auth_jwt)
- ) -> dict[str, Any]:
+ self, request: Request, payload: Dict[str, Any] = Depends(auth_jwt)
+ ) -> Dict[str, Any]:
"""Dependency function to check the scope permissions of the user.
Args:
request (Request , required): The FastAPI request object.
- payload (dict[str, Any], required): The decoded access token (JWT) payload.
+ payload (Dict[str, Any], required): The decoded access token (JWT) payload.
Raises:
BaseHTTPException: If the user has insufficient scope permissions.
Returns:
- dict[str, Any]: The decoded access token payload.
+ Dict[str, Any]: The decoded access token payload.
"""
if self.allow_owner:
- _auth_user_id: str = payload.get("sub", "")
- _path_params: list[str] = list(request.path_params.values())
+ _auth_user_id: str = payload.get("sub")
+ _path_params: List[str] = list(request.path_params.values())
if _path_params and (_path_params[0] == _auth_user_id):
return payload
- _token_all_scope: str = payload.get("scope", "")
- _token_scope_list: list[str] = _token_all_scope.split(" ")
+ _token_all_scope: str = payload.get("scope")
+ _token_scope_list: List[str] = _token_all_scope.split(" ")
if self.allow_scope not in _token_scope_list:
raise BaseHTTPException(
error_enum=ErrorCodeEnum.FORBIDDEN,
message="You do not have enough scope permissions!",
description="The request requires more scope permissions.",
headers={
- "WWW-Authenticate": (
- 'Bearer error="insufficient_scope", '
- 'error_description="The request requires more scope permissions."'
- )
+ "WWW-Authenticate": 'Bearer error="insufficient_scope", error_description="The request requires more scope permissions."'
},
)
diff --git a/src/bv_challenge/challenge/api/core/exceptions/__init__.py b/src/bv_challenge/challenge/api/core/exceptions/__init__.py
index b722c5d..03e9716 100644
--- a/src/bv_challenge/challenge/api/core/exceptions/__init__.py
+++ b/src/bv_challenge/challenge/api/core/exceptions/__init__.py
@@ -1,3 +1,3 @@
-# flake8: noqa
+# -*- coding: utf-8 -*-
from ._base import *
diff --git a/src/bv_challenge/challenge/api/core/exceptions/_base.py b/src/bv_challenge/challenge/api/core/exceptions/_base.py
index f639d22..67918da 100644
--- a/src/bv_challenge/challenge/api/core/exceptions/_base.py
+++ b/src/bv_challenge/challenge/api/core/exceptions/_base.py
@@ -1,6 +1,8 @@
-from typing import Any, cast
+# -*- coding: utf-8 -*-
-from pydantic import validate_call
+from typing import Any, Optional, Dict
+
+from pydantic import conint, constr, validate_call
from fastapi import HTTPException
from api.core.constants import ErrorCodeEnum
@@ -17,36 +19,32 @@ class BaseHTTPException(HTTPException):
def __init__(
self,
error_enum: ErrorCodeEnum,
- status_code: int | None = None,
- message: str | None = None,
- content: Any = None,
- description: str | None = None,
+ status_code: Optional[conint(ge=100, le=599)] = None, # type: ignore
+ message: Optional[
+ constr(strip_whitespace=True, min_length=1, max_length=256) # type: ignore
+ ] = None,
+ description: Optional[constr(strip_whitespace=True, max_length=1024)] = None, # type: ignore
detail: Any = None,
- headers: dict[str, str] | None = None,
+ headers: Optional[Dict[str, str]] = None,
):
"""Constructor method for BaseHTTPException class.
Args:
- error_enum (ErrorCodeEnum , required): Main error code enum.
- status_code (int | None , optional): HTTP status code: [ge=100, le=599]. Defaults to None.
- message (str | None , optional): Error message: [min_length=1, max_length=255].
- Defaults to None.
- content (Any , optional): Any data content for response. Defaults to None.
- description (str | None , optional): Error description: [max_length=511]. Defaults to None.
- detail (Any , optional): Error detail. Defaults to None.
- headers (dict[str, str] | None, optional): Headers. Defaults to None.
+ error_enum (ErrorCodeEnum , required): Main error code enum.
+ status_code (Optional[int] , optional): HTTP status code: [ge=100, le=599]. Defaults to None.
+ message (Optional[str] , optional): Error message: [min_length=1, max_length=255]. Defaults to None.
+ description (Optional[str] , optional): Error description: [max_length=511]. Defaults to None.
+ detail (Any , optional): Error detail. Defaults to None.
+ headers (Optional[Dict[str, str]], optional): Headers. Defaults to None.
"""
_error = error_enum.value.model_dump()
if not status_code:
- status_code = cast(int, _error.get("status_code", 500))
+ status_code: int = _error.get("status_code")
if not message:
- message = _error.get("message", "An error occurred")
-
- if content:
- self.content = content
+ message: str = _error.get("message")
if description:
_error["description"] = description
diff --git a/src/bv_challenge/challenge/api/core/handlers/__init__.py b/src/bv_challenge/challenge/api/core/handlers/__init__.py
index 0c4cade..1059366 100644
--- a/src/bv_challenge/challenge/api/core/handlers/__init__.py
+++ b/src/bv_challenge/challenge/api/core/handlers/__init__.py
@@ -1,4 +1,4 @@
-# flake8: noqa
+# -*- coding: utf-8 -*-
from ._not_found import *
from ._method_not_allowed import *
diff --git a/src/bv_challenge/challenge/api/core/handlers/_http_exception.py b/src/bv_challenge/challenge/api/core/handlers/_http_exception.py
index eb8b89e..8da773b 100644
--- a/src/bv_challenge/challenge/api/core/handlers/_http_exception.py
+++ b/src/bv_challenge/challenge/api/core/handlers/_http_exception.py
@@ -1,15 +1,16 @@
-from fastapi import HTTPException, Request
+# -*- coding: utf-8 -*-
+
+from typing import Union
-from potato_util.http import get_http_status
+from fastapi import HTTPException, Request
from api.core.constants import ErrorCodeEnum
+from api.core import utils
from api.core.responses import BaseResponse
-# For HTTPException error:
-async def http_exception_handler(
- request: Request, exc: HTTPException | Exception
-) -> BaseResponse:
+## For HTTPException error:
+async def http_exception_handler(request: Request, exc: HTTPException) -> BaseResponse:
"""HTTPException handler.
Args:
@@ -20,14 +21,10 @@ async def http_exception_handler(
BaseResponse: Response object.
"""
- assert isinstance(
- exc, HTTPException
- ), f"`exc` argument type is invalid {type(exc)}, expected !"
-
_message: str
- _error: dict | str | None = None
+ _error: Union[dict, str, None] = None
- _http_status, _ = get_http_status(status_code=exc.status_code)
+ _http_status, _ = utils.get_http_status(status_code=exc.status_code)
if isinstance(exc.detail, dict):
_message = str(exc.detail.get("message", _http_status.phrase))
@@ -45,18 +42,12 @@ async def http_exception_handler(
if _error_code_enum:
_error = _error_code_enum.value.model_dump()
- _content = None
- if hasattr(exc, "content"):
- _content = getattr(exc, "content")
-
- _headers = dict(exc.headers) if exc.headers else None
return BaseResponse(
request=request,
- content=_content,
status_code=exc.status_code,
message=_message,
error=_error,
- headers=_headers,
+ headers=exc.headers,
)
diff --git a/src/bv_challenge/challenge/api/core/handlers/_method_not_allowed.py b/src/bv_challenge/challenge/api/core/handlers/_method_not_allowed.py
index 867e31c..80c4bd1 100644
--- a/src/bv_challenge/challenge/api/core/handlers/_method_not_allowed.py
+++ b/src/bv_challenge/challenge/api/core/handlers/_method_not_allowed.py
@@ -1,12 +1,14 @@
+# -*- coding: utf-8 -*-
+
from fastapi import HTTPException, Request
from api.core.constants import ErrorCodeEnum
from api.core.responses import BaseResponse
-# For 405 status code:
+## For 405 status code:
async def method_not_allowed_handler(
- request: Request, exc: HTTPException | Exception
+ request: Request, exc: HTTPException
) -> BaseResponse:
"""405 status code handler.
@@ -19,7 +21,7 @@ async def method_not_allowed_handler(
"""
_error = ErrorCodeEnum.METHOD_NOT_ALLOWED.value.model_dump()
- _message: str = _error.get("message", "Method Not Allowed")
+ _message: str = _error.get("message")
return BaseResponse(
request=request, status_code=405, message=_message, error=_error
diff --git a/src/bv_challenge/challenge/api/core/handlers/_not_found.py b/src/bv_challenge/challenge/api/core/handlers/_not_found.py
index 5158524..29205e9 100644
--- a/src/bv_challenge/challenge/api/core/handlers/_not_found.py
+++ b/src/bv_challenge/challenge/api/core/handlers/_not_found.py
@@ -1,13 +1,13 @@
+# -*- coding: utf-8 -*-
+
from fastapi import HTTPException, Request
from api.core.constants import ErrorCodeEnum
from api.core.responses import BaseResponse
-# For 404 status code:
-async def not_found_handler(
- request: Request, exc: HTTPException | Exception
-) -> BaseResponse:
+## For 404 status code:
+async def not_found_handler(request: Request, exc: HTTPException) -> BaseResponse:
"""404 status code handler.
Args:
@@ -18,11 +18,8 @@ async def not_found_handler(
BaseResponse: Response object.
"""
- if not isinstance(exc, HTTPException):
- exc = HTTPException(status_code=404)
-
_error = ErrorCodeEnum.NOT_FOUND.value.model_dump()
- _message: str = _error.get("message", "Not Found")
+ _message: str = _error.get("message")
if hasattr(exc, "detail") and isinstance(exc.detail, dict):
_message = exc.detail.get("message", _message)
diff --git a/src/bv_challenge/challenge/api/core/handlers/_server_error.py b/src/bv_challenge/challenge/api/core/handlers/_server_error.py
index d350114..e7d8ba8 100644
--- a/src/bv_challenge/challenge/api/core/handlers/_server_error.py
+++ b/src/bv_challenge/challenge/api/core/handlers/_server_error.py
@@ -1,18 +1,17 @@
-from typing import Any
+# -*- coding: utf-8 -*-
from fastapi import Request
-from beans_logging_fastapi import log_http_error
+from beans_logging_fastapi import async_log_http_error
from api.core.constants import ErrorCodeEnum
from api.config import config
from api.core.exceptions import PrimaryKeyError, UniqueKeyError
from api.core.responses import BaseResponse
+from api.logger import logger
-# from api.logger import logger
-
-# For unhandled Exception or 500 internal server error:
+## For unhandled Exception or 500 internal server error:
async def server_error_handler(request: Request, exc: Exception) -> BaseResponse:
"""Error handler for any kind of unhandled Exception or 500 internal server error.
@@ -30,18 +29,18 @@ async def server_error_handler(request: Request, exc: Exception) -> BaseResponse
if isinstance(exc, UniqueKeyError):
_error_enum = ErrorCodeEnum.DB_UQ_ERROR
- # _request_id: str = request.state.request_id
+ _request_id: str = request.state.request_id
_exc_str = str(exc)
_status_code = _error_enum.value.status_code
- _error: dict[str, Any] = _error_enum.value.model_dump()
+ _error = _error_enum.value.model_dump()
_error["detail"] = _exc_str
- _message: str = _error.get("message", "Internal Server Error")
+ _message: str = _error.get("message")
- # logger.exception(f"[{_request_id}] {_error_enum.value.code} - {_exc_str}")
- log_http_error(
+ logger.exception(f"[{_request_id}] {_error_enum.value.code} - {_exc_str}")
+ await async_log_http_error(
request=request,
status_code=_status_code,
- msg_format_str=config.api.logger.http.std.err_msg_format_str,
+ msg_format=config.logger.extra.http_std_error_format,
)
return BaseResponse(
request=request, status_code=_status_code, message=_message, error=_error
diff --git a/src/bv_challenge/challenge/api/core/handlers/_validation_error.py b/src/bv_challenge/challenge/api/core/handlers/_validation_error.py
index a535a07..8735d3c 100644
--- a/src/bv_challenge/challenge/api/core/handlers/_validation_error.py
+++ b/src/bv_challenge/challenge/api/core/handlers/_validation_error.py
@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+
from fastapi import Request
from fastapi.exceptions import RequestValidationError
@@ -5,9 +7,9 @@
from api.core.responses import BaseResponse
-# For RequestValidationError error:
+## For RequestValidationError error:
async def validation_error_handler(
- request: Request, exc: RequestValidationError | Exception
+ request: Request, exc: RequestValidationError
) -> BaseResponse:
"""RequestValidationError handler for validation error.
@@ -19,10 +21,6 @@ async def validation_error_handler(
BaseResponse: Response object.
"""
- assert isinstance(
- exc, RequestValidationError
- ), f"`exc` argument type is invalid {type(exc)}, expected !"
-
_message = "Validation error!"
_error = ErrorCodeEnum.UNPROCESSABLE_ENTITY.value.model_dump()
_error["description"] = str(exc)
diff --git a/src/bv_challenge/challenge/api/core/middlewares/__init__.py b/src/bv_challenge/challenge/api/core/middlewares/__init__.py
index 1be8359..7271d04 100644
--- a/src/bv_challenge/challenge/api/core/middlewares/__init__.py
+++ b/src/bv_challenge/challenge/api/core/middlewares/__init__.py
@@ -1,4 +1,4 @@
-# flake8: noqa
+# -*- coding: utf-8 -*-
from ._process_time import *
from ._request_id import *
diff --git a/src/bv_challenge/challenge/api/core/middlewares/_process_time.py b/src/bv_challenge/challenge/api/core/middlewares/_process_time.py
index bbd08cf..f15fd8e 100644
--- a/src/bv_challenge/challenge/api/core/middlewares/_process_time.py
+++ b/src/bv_challenge/challenge/api/core/middlewares/_process_time.py
@@ -1,5 +1,7 @@
+# -*- coding: utf-8 -*-
+
import time
-from collections.abc import Callable
+from typing import Callable
from starlette.middleware.base import BaseHTTPMiddleware
from fastapi import Request, Response
diff --git a/src/bv_challenge/challenge/api/core/middlewares/_request_id.py b/src/bv_challenge/challenge/api/core/middlewares/_request_id.py
index 30abc14..573fb92 100644
--- a/src/bv_challenge/challenge/api/core/middlewares/_request_id.py
+++ b/src/bv_challenge/challenge/api/core/middlewares/_request_id.py
@@ -1,5 +1,7 @@
+# -*- coding: utf-8 -*-
+
from uuid import uuid4
-from collections.abc import Callable
+from typing import Callable
from starlette.middleware.base import BaseHTTPMiddleware
from fastapi import Request, Response
@@ -16,9 +18,9 @@ class RequestIdMiddleware(BaseHTTPMiddleware):
async def dispatch(self, request: Request, call_next: Callable) -> Response:
_request_id: str = uuid4().hex
if "X-Request-ID" in request.headers:
- _request_id: str = request.headers.get("X-Request-ID", _request_id)
+ _request_id: str = request.headers.get("X-Request-ID")
elif "X-Correlation-ID" in request.headers:
- _request_id: str = request.headers.get("X-Correlation-ID", _request_id)
+ _request_id: str = request.headers.get("X-Correlation-ID")
request.state.request_id = _request_id
response: Response = await call_next(request)
diff --git a/src/bv_challenge/challenge/api/core/models/__init__.py b/src/bv_challenge/challenge/api/core/models/__init__.py
index e69de29..40a96af 100644
--- a/src/bv_challenge/challenge/api/core/models/__init__.py
+++ b/src/bv_challenge/challenge/api/core/models/__init__.py
@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-
diff --git a/src/bv_challenge/challenge/api/core/responses/__init__.py b/src/bv_challenge/challenge/api/core/responses/__init__.py
index b722c5d..03e9716 100644
--- a/src/bv_challenge/challenge/api/core/responses/__init__.py
+++ b/src/bv_challenge/challenge/api/core/responses/__init__.py
@@ -1,3 +1,3 @@
-# flake8: noqa
+# -*- coding: utf-8 -*-
from ._base import *
diff --git a/src/bv_challenge/challenge/api/core/responses/_base.py b/src/bv_challenge/challenge/api/core/responses/_base.py
index d05c268..3d8e9e0 100644
--- a/src/bv_challenge/challenge/api/core/responses/_base.py
+++ b/src/bv_challenge/challenge/api/core/responses/_base.py
@@ -1,17 +1,16 @@
+# -*- coding: utf-8 -*-
+
from http import HTTPStatus
-from typing import Any
+from typing import Any, Optional, Dict, Type
-from pydantic import validate_call
+from pydantic import validate_call, conint, constr
from starlette.background import BackgroundTask
from fastapi import Request
from fastapi.encoders import jsonable_encoder
from fastapi.responses import JSONResponse
-from potato_util.http import get_http_status
-from potato_util.http.fastapi import get_relative_url
-
-from api.__version__ import __version__
from api.config import config
+from api.core import utils
from api.core.schemas import BaseResPM
@@ -27,44 +26,44 @@ class BaseResponse(JSONResponse):
def __init__(
self,
content: Any = None,
- status_code: int = 200,
- headers: dict[str, str] | None = None,
- media_type: str | None = None,
- background: BackgroundTask | None = None,
- request: Request | None = None,
- message: str | None = None,
- links: dict[str, Any] | None = None,
- meta: dict[str, Any] | None = None,
+ status_code: Optional[conint(ge=100, le=599)] = 200, # type: ignore
+ headers: Optional[Dict[str, str]] = None,
+ media_type: Optional[constr(strip_whitespace=True)] = None, # type: ignore
+ background: Optional[BackgroundTask] = None,
+ request: Optional[Request] = None,
+ message: Optional[
+ constr(strip_whitespace=True, min_length=1, max_length=256) # type: ignore
+ ] = None,
+ links: Optional[Dict[str, Any]] = None,
+ meta: Optional[Dict[str, Any]] = None,
error: Any = None,
- response_schema: type[BaseResPM] = BaseResPM,
+ response_schema: Optional[Type[BaseResPM]] = BaseResPM,
) -> None:
"""Constructor method for BaseResponse class.
This will prepare the most response data and pass it to `JSONResponse` parent class constructor.
Args:
- content (Any , optional): Main data content for response. Defaults to None.
- status_code (int | None , optional): HTTP status code: [100 <= status_code <= 599].
- Defaults to 200.
- headers (dict[str, str] | None , optional): HTTP headers. Defaults to None.
- media_type (str | None , optional): Media type for 'Content-Type' header. Defaults to None.
- background (BackgroundTask | None , optional): Background task. Defaults to None.
- request (Request | None , optional): Request object from FastAPI. Defaults to None.
- message (str | None , optional): Message for response: [1 <= len(message) <= 256].
- Defaults to None.
- links (dict[str, Any] | None , optional): Links for response. Defaults to None.
- meta (dict[str, Any] | None , optional): Meta data for response. Defaults to None.
- error (Any , optional): Error data for response. Defaults to None.
- response_schema (type[BaseResPM] | None, optional): Response schema type. Defaults to `Type[BaseResPM]`.
+ content (Any , optional): Main data content for response. Defaults to None.
+ status_code (Optional[int] , optional): HTTP status code: [100 <= status_code <= 599]. Defaults to 200.
+ headers (Optional[Dict[str, str]] , optional): HTTP headers. Defaults to None.
+ media_type (Optional[str] , optional): Media type for 'Content-Type' header. Defaults to None.
+ background (Optional[BackgroundTask] , optional): Background task. Defaults to None.
+ request (Optional[Request] , optional): Request object from FastAPI. Defaults to None.
+ message (Optional[str] , optional): Message for response: [1 <= len(message) <= 256]. Defaults to None.
+ links (Optional[Dict[str, Any]] , optional): Links for response. Defaults to None.
+ meta (Optional[Dict[str, Any]] , optional): Meta data for response. Defaults to None.
+ error (Any , optional): Error data for response. Defaults to None.
+ response_schema (Optional[Type[BaseResPM]], optional): Response schema type. Defaults to `Type[BaseResPM]`.
"""
_http_status: HTTPStatus
- _http_status, _ = get_http_status(status_code=status_code)
+ _http_status, _ = utils.get_http_status(status_code=status_code)
if not message:
if error and isinstance(error, dict) and ("message" in error):
message = str(error["message"])
else:
- message = _http_status.phrase
+ message: str = _http_status.phrase
if not links:
links = {}
@@ -78,19 +77,20 @@ def __init__(
if request:
_request_id: str = request.state.request_id
- links["self"] = f"{get_relative_url(request)}"
+ links["self"] = f"{utils.get_relative_url(request)}"
+ meta["request_id"] = _request_id
meta["method"] = request.method
meta["base_url"] = str(request.base_url)[:-1]
if "X-Request-Id" not in headers:
headers["X-Request-Id"] = _request_id
- headers["X-API-Version"] = config.api.version
- headers["X-System-Version"] = __version__
+ meta["api_version"] = config.api.version
+ meta["version"] = config.version
if error and isinstance(error, dict):
if ("code" in error) and ("X-Error-Code" not in headers):
- headers["X-Error-Code"] = error.get("code", f"{status_code}_00000")
+ headers["X-Error-Code"] = error.get("code")
if (not config.debug) and (500 <= status_code) and ("detail" in error):
error["detail"] = None
@@ -115,7 +115,7 @@ def __init__(
headers["Retry-After"] = "1800"
_response_pm = response_schema(
- message=message, data=content, links=links, meta=meta, error=error # type: ignore
+ message=message, data=content, links=links, meta=meta, error=error
)
_content = jsonable_encoder(obj=_response_pm, by_alias=True)
diff --git a/src/bv_challenge/challenge/api/core/routers/__init__.py b/src/bv_challenge/challenge/api/core/routers/__init__.py
index e69de29..40a96af 100644
--- a/src/bv_challenge/challenge/api/core/routers/__init__.py
+++ b/src/bv_challenge/challenge/api/core/routers/__init__.py
@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-
diff --git a/src/bv_challenge/challenge/api/core/routers/default.py b/src/bv_challenge/challenge/api/core/routers/default.py
index a38c616..dee3054 100644
--- a/src/bv_challenge/challenge/api/core/routers/default.py
+++ b/src/bv_challenge/challenge/api/core/routers/default.py
@@ -1,8 +1,11 @@
+# -*- coding: utf-8 -*-
+
from fastapi import APIRouter
from fastapi.responses import RedirectResponse
from api.config import config
+
router = APIRouter(tags=["Default"])
@@ -17,6 +20,7 @@ async def get_root():
if config.api.docs.enabled:
+
if config.api.docs.openapi_url:
@router.get(
diff --git a/src/bv_challenge/challenge/api/core/routers/utils.py b/src/bv_challenge/challenge/api/core/routers/utils.py
index 06a112b..0d0cf44 100644
--- a/src/bv_challenge/challenge/api/core/routers/utils.py
+++ b/src/bv_challenge/challenge/api/core/routers/utils.py
@@ -1,8 +1,12 @@
-from fastapi import APIRouter, Request
+# -*- coding: utf-8 -*-
-from api.core.schemas import BaseResPM
+from fastapi import APIRouter, Request, Response
+from fastapi.responses import JSONResponse
+
+from api.core.schemas import BaseResPM, HealthResPM
from api.core.responses import BaseResponse
+
router = APIRouter(tags=["Utils"])
@@ -32,22 +36,15 @@ async def get_ping(request: Request):
"/health",
summary="Health",
description="Check health of all related backend services.",
- response_model=BaseResPM,
+ response_class=JSONResponse,
+ response_model=HealthResPM,
)
-async def get_health(request: Request):
- _message = "Everything is OK."
- _data = {"api": {"message": "API is up.", "is_alive": True}}
+async def get_health(response: Response):
+ response.headers["Cache-Control"] = "no-cache, no-store, must-revalidate"
+ response.headers["Pragma"] = "no-cache"
+ response.headers["Expires"] = "0"
- return BaseResponse(
- request=request,
- content=_data,
- message=_message,
- headers={
- "Cache-Control": "no-cache, no-store, must-revalidate",
- "Pragma": "no-cache",
- "Expires": "0",
- },
- )
+ return {"status": "healthy"}
__all__ = ["router"]
diff --git a/src/bv_challenge/challenge/api/core/schemas/__init__.py b/src/bv_challenge/challenge/api/core/schemas/__init__.py
index 6bd70cf..8a20231 100644
--- a/src/bv_challenge/challenge/api/core/schemas/__init__.py
+++ b/src/bv_challenge/challenge/api/core/schemas/__init__.py
@@ -1,4 +1,4 @@
-# flake8: noqa
+# -*- coding: utf-8 -*-
from ._base import *
from ._responses import *
diff --git a/src/bv_challenge/challenge/api/core/schemas/_base.py b/src/bv_challenge/challenge/api/core/schemas/_base.py
index 79a9c4b..c026943 100644
--- a/src/bv_challenge/challenge/api/core/schemas/_base.py
+++ b/src/bv_challenge/challenge/api/core/schemas/_base.py
@@ -1,13 +1,14 @@
+# -*- coding: utf-8 -*-
+
from datetime import datetime
from pydantic import BaseModel, Field, constr, ConfigDict
-from potato_util.dt import now_utc_dt
-from potato_util.generator import gen_unique_id
+from api.core import utils
class BasePM(BaseModel):
- # model_config = ConfigDict(json_encoders={datetime: dt_to_iso})
+ # model_config = ConfigDict(json_encoders={datetime: utils.datetime_to_iso})
pass
@@ -19,7 +20,7 @@ class ExtraBasePM(BaseModel):
class IdPM(BasePM):
id: constr(strip_whitespace=True) = Field( # type: ignore
- default_factory=gen_unique_id,
+ default_factory=utils.gen_unique_id,
min_length=8,
max_length=64,
title="ID",
@@ -30,16 +31,16 @@ class IdPM(BasePM):
class TimestampPM(BasePM):
updated_at: datetime = Field(
- default_factory=now_utc_dt,
+ default_factory=utils.now_utc_dt,
title="Updated datetime",
description="Last updated datetime of the resource.",
- examples=["2026-01-01T00:00:00+00:00"],
+ examples=["2024-12-01T00:00:00+00:00"],
)
created_at: datetime = Field(
- default_factory=now_utc_dt,
+ default_factory=utils.now_utc_dt,
title="Created datetime",
description="Created datetime of the resource.",
- examples=["2026-01-01T00:00:00+00:00"],
+ examples=["2024-12-01T00:00:00+00:00"],
)
diff --git a/src/bv_challenge/challenge/api/core/schemas/_error_responses.py b/src/bv_challenge/challenge/api/core/schemas/_error_responses.py
index 488c34b..e13d6b8 100644
--- a/src/bv_challenge/challenge/api/core/schemas/_error_responses.py
+++ b/src/bv_challenge/challenge/api/core/schemas/_error_responses.py
@@ -1,4 +1,6 @@
-from typing import Any
+# -*- coding: utf-8 -*-
+
+from typing import Any, Union
from pydantic import Field
@@ -14,13 +16,13 @@ class BadBaseResPM(BaseResPM):
description="Response message about the current request.",
examples=["Bad Request!"],
)
- data: Any | dict | list = Field(
+ data: Union[Any, dict, list] = Field(
default=None,
title="Data",
description="Resource data or any response related data.",
examples=[None],
)
- error: ErrorResPM | Any = Field(
+ error: Union[ErrorResPM, Any] = Field(
default=None,
title="Error",
description="Error information about the current request.",
@@ -43,7 +45,7 @@ class UnauthorizedBaseResPM(BadBaseResPM):
description="Response message about the current request.",
examples=["Unauthorized!"],
)
- error: ErrorResPM | Any = Field(
+ error: Union[ErrorResPM, Any] = Field(
default=None,
title="Error",
description="Error information about the current request.",
@@ -66,7 +68,7 @@ class ForbiddenBaseResPM(BadBaseResPM):
description="Response message about the current request.",
examples=["Forbidden!"],
)
- error: ErrorResPM | Any = Field(
+ error: Union[ErrorResPM, Any] = Field(
default=None,
title="Error",
description="Error information about the current request.",
@@ -89,7 +91,7 @@ class NotFoundBaseResPM(BadBaseResPM):
description="Response message about the current request.",
examples=["Not Found!"],
)
- error: ErrorResPM | Any = Field(
+ error: Union[ErrorResPM, Any] = Field(
default=None,
title="Error",
description="Error information about the current request.",
@@ -112,7 +114,7 @@ class MethodNotBaseResPM(BadBaseResPM):
description="Response message about the current request.",
examples=["Method Not Allowed!"],
)
- error: ErrorResPM | Any = Field(
+ error: Union[ErrorResPM, Any] = Field(
default=None,
title="Error",
description="Error information about the current request.",
@@ -135,7 +137,7 @@ class ConflictBaseResPM(BadBaseResPM):
description="Response message about the current request.",
examples=["Conflict!"],
)
- error: ErrorResPM | Any = Field(
+ error: Union[ErrorResPM, Any] = Field(
default=None,
title="Error",
description="Error information about the current request.",
@@ -158,7 +160,7 @@ class InvalidBaseResPM(BadBaseResPM):
description="Response message about the current request.",
examples=["Validation error!"],
)
- error: ErrorResPM | Any = Field(
+ error: Union[ErrorResPM, Any] = Field(
default=None,
title="Error",
description="Error information about the current request.",
@@ -188,7 +190,7 @@ class ErrorBaseResPM(BadBaseResPM):
description="Response message about the current request.",
examples=["Internal Server Error!"],
)
- error: ErrorResPM | Any = Field(
+ error: Union[ErrorResPM, Any] = Field(
default=None,
title="Error",
description="Error information about the current request.",
diff --git a/src/bv_challenge/challenge/api/core/schemas/_responses.py b/src/bv_challenge/challenge/api/core/schemas/_responses.py
index 8c41aa8..fe9cfdd 100644
--- a/src/bv_challenge/challenge/api/core/schemas/_responses.py
+++ b/src/bv_challenge/challenge/api/core/schemas/_responses.py
@@ -1,18 +1,29 @@
-from typing import Any
+# -*- coding: utf-8 -*-
-from pydantic import Field
+from enum import Enum
+from typing import Any, Union, Optional
-from potato_util.constants import HTTPMethodEnum
+from pydantic import Field, constr
from api.config import config
-
from ._base import ExtraBasePM, BasePM
+class MethodEnum(str, Enum):
+ GET = "GET"
+ POST = "POST"
+ PUT = "PUT"
+ PATCH = "PATCH"
+ DELETE = "DELETE"
+ HEAD = "HEAD"
+ OPTIONS = "OPTIONS"
+ CONNECT = "CONNECT"
+ TRACE = "TRACE"
+
+
class LinksResPM(ExtraBasePM):
- self_link: str | None = Field(
+ self_link: Optional[constr(strip_whitespace=True, max_length=2048)] = Field( # type: ignore
default=None,
- max_length=2048,
alias="self",
title="Self link",
description="Link to the current resource.",
@@ -21,33 +32,29 @@ class LinksResPM(ExtraBasePM):
class PageLinksResPM(LinksResPM):
- first_link: str | None = Field(
+ first_link: Optional[constr(strip_whitespace=True, max_length=2048)] = Field( # type: ignore
default=None,
- max_length=2048,
alias="first",
title="First link",
description="Link to the first page of the resource.",
examples=[f"{config.api.prefix}/resources/?skip=0&limit=100"],
)
- prev_link: str | None = Field(
+ prev_link: Optional[constr(strip_whitespace=True, max_length=2048)] = Field( # type: ignore
default=None,
- max_length=2048,
alias="prev",
title="Previous link",
description="Link to the previous page of the resource.",
examples=[f"{config.api.prefix}/resources/?skip=100&limit=100"],
)
- next_link: str | None = Field(
+ next_link: Optional[constr(strip_whitespace=True, max_length=2048)] = Field( # type: ignore
default=None,
- max_length=2048,
alias="next",
title="Next link",
description="Link to the next page of the resource.",
examples=[f"{config.api.prefix}/resources/?skip=300&limit=100"],
)
- last_link: str | None = Field(
+ last_link: Optional[constr(strip_whitespace=True, max_length=2048)] = Field( # type: ignore
default=None,
- max_length=2048,
alias="last",
title="Last link",
description="Link to the last page of the resource.",
@@ -56,24 +63,48 @@ class PageLinksResPM(LinksResPM):
class MetaResPM(ExtraBasePM):
- base_url: str | None = Field(
+ request_id: Optional[
+ constr(strip_whitespace=True, min_length=8, max_length=64) # type: ignore
+ ] = Field(
+ default=None,
+ title="Request ID",
+ description="Current request ID.",
+ examples=["211203afa2844d55b1c9d38b9f8a7063"],
+ )
+ base_url: Optional[
+ constr(strip_whitespace=True, min_length=2, max_length=256) # type: ignore
+ ] = Field(
default=None,
- min_length=2,
- max_length=256,
title="Base URL",
description="Current request base URL.",
examples=["https://api.example.com"],
)
- method: HTTPMethodEnum | None = Field(
+ method: Optional[MethodEnum] = Field(
default=None,
title="Method",
description="Current request method.",
examples=["GET"],
)
+ api_version: constr(strip_whitespace=True) = Field( # type: ignore
+ default=config.api.version,
+ min_length=1,
+ max_length=16,
+ title="API version",
+ description="Current API version.",
+ examples=[config.api.version],
+ )
+ version: constr(strip_whitespace=True) = Field( # type: ignore
+ default=config.version,
+ min_length=5,
+ max_length=32,
+ title="Version",
+ description="Current system version.",
+ examples=[config.version],
+ )
class ErrorResPM(BasePM):
- code: str = Field(
+ code: constr(strip_whitespace=True) = Field( # type: ignore
...,
min_length=3,
max_length=36,
@@ -81,14 +112,14 @@ class ErrorResPM(BasePM):
description="Code that represents the error.",
examples=["400_00000"],
)
- description: str | None = Field(
+ description: Optional[constr(strip_whitespace=True)] = Field( # type: ignore
default=None,
max_length=1024,
title="Error description",
description="Description of the error.",
examples=["Bad request syntax or unsupported method."],
)
- detail: Any | dict | list = Field(
+ detail: Union[Any, dict, list] = Field(
default=None,
title="Error detail",
description="Detail of the error.",
@@ -112,7 +143,7 @@ class BaseResPM(BasePM):
description="Response message about the current request.",
examples=["Successfully processed the request."],
)
- data: Any | dict | list = Field(
+ data: Union[Any, dict, list] = Field(
default=None,
title="Data",
description="Resource data or any data related to response.",
@@ -128,7 +159,7 @@ class BaseResPM(BasePM):
title="Meta",
description="Meta information about the current request.",
)
- error: ErrorResPM | Any = Field(
+ error: Union[ErrorResPM, Any] = Field(
default=None,
title="Error",
description="Error information about the current request.",
@@ -136,10 +167,22 @@ class BaseResPM(BasePM):
)
+class HealthResPM(BasePM):
+ status: str = Field(
+ default="healthy",
+ min_length=2,
+ max_length=32,
+ title="Status",
+ description="Health status of the service.",
+ examples=["healthy"],
+ )
+
+
__all__ = [
"LinksResPM",
"PageLinksResPM",
"MetaResPM",
"ErrorResPM",
"BaseResPM",
+ "HealthResPM",
]
diff --git a/src/bv_challenge/challenge/api/core/services/__init__.py b/src/bv_challenge/challenge/api/core/services/__init__.py
index e69de29..40a96af 100644
--- a/src/bv_challenge/challenge/api/core/services/__init__.py
+++ b/src/bv_challenge/challenge/api/core/services/__init__.py
@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-
diff --git a/src/bv_challenge/challenge/api/core/utils/__init__.py b/src/bv_challenge/challenge/api/core/utils/__init__.py
index b722c5d..3b1b591 100644
--- a/src/bv_challenge/challenge/api/core/utils/__init__.py
+++ b/src/bv_challenge/challenge/api/core/utils/__init__.py
@@ -1,3 +1,9 @@
-# flake8: noqa
+# -*- coding: utf-8 -*-
from ._base import *
+from ._secure import *
+from ._http import *
+from ._dt import *
+from ._io import *
+from . import _validator as validator
+from . import _sanitizer as sanitizer
diff --git a/src/bv_challenge/challenge/api/core/utils/_base.py b/src/bv_challenge/challenge/api/core/utils/_base.py
index c39d6b6..f3fa003 100644
--- a/src/bv_challenge/challenge/api/core/utils/_base.py
+++ b/src/bv_challenge/challenge/api/core/utils/_base.py
@@ -1,36 +1,117 @@
-import sys
-from functools import lru_cache
-
-BINARY_MODULES = [
- "uvicorn",
- "gunicorn",
- "fastapi",
- "pytest",
- "unittest",
- "alembic",
-]
+# -*- coding: utf-8 -*-
+
+import re
+import copy
+
+from pydantic import validate_call
+
+from beans_logging import logger
-@lru_cache
-def is_running_bin() -> bool:
- """Checks if the application is running as a binary environment module (e.g., via uvicorn, fastapi, gunicorn, etc.)
- by inspecting the command-line arguments.
+@validate_call
+def deep_merge(dict1: dict, dict2: dict) -> dict:
+ """Return a new dictionary that's the result of a deep merge of two dictionaries.
+ If there are conflicts, values from `dict2` will overwrite those in `dict1`.
+
+ Args:
+ dict1 (dict, required): The base dictionary that will be merged.
+ dict2 (dict, required): The dictionary to merge into `dict1`.
Returns:
- bool: True if running as a binary environment module, False otherwise.
+ dict: The merged dictionary.
"""
- for _binary_module in BINARY_MODULES:
+ _merged = copy.deepcopy(dict1)
+ for _key, _val in dict2.items():
if (
- sys.argv[0].endswith(_binary_module)
- or sys.argv[0].endswith(f"{_binary_module}.exe")
- or sys.argv[0].endswith(f"{_binary_module}/__main__.py")
+ _key in _merged
+ and isinstance(_merged[_key], dict)
+ and isinstance(_val, dict)
):
- return True
+ _merged[_key] = deep_merge(_merged[_key], _val)
+ else:
+ _merged[_key] = copy.deepcopy(_val)
+
+ return _merged
+
+
+@validate_call
+def camel_to_snake(val: str) -> str:
+ """Convert CamelCase to snake_case.
+
+ Args:
+ val (str): CamelCase string to convert.
+
+ Returns:
+ str: Converted snake_case string.
+ """
+
+ val = re.sub("(.)([A-Z][a-z]+)", r"\1_\2", val)
+ val = re.sub("([a-z0-9])([A-Z])", r"\1_\2", val).lower()
+ return val
+
+
+@validate_call
+def clean_obj_dict(obj_dict: dict, cls_name: str) -> dict:
+ """Clean class name from object.__dict__ for str(object).
+
+ Args:
+ obj_dict (dict, required): Object dictionary by object.__dict__.
+ cls_name (str , required): Class name by cls.__name__.
+
+ Returns:
+ dict: Clean object dictionary.
+ """
+
+ try:
+ if not obj_dict:
+ raise ValueError("'obj_dict' argument value is empty!")
+
+ if not cls_name:
+ raise ValueError("'cls_name' argument value is empty!")
+ except ValueError as err:
+ logger.error(err)
+ raise
+
+ _self_dict = obj_dict.copy()
+ for _key in _self_dict.copy():
+ _class_prefix = f"_{cls_name}__"
+ if _key.startswith(_class_prefix):
+ _new_key = _key.replace(_class_prefix, "")
+ _self_dict[_new_key] = _self_dict.pop(_key)
+ return _self_dict
+
+
+@validate_call(config={"arbitrary_types_allowed": True})
+def obj_to_repr(obj: object) -> str:
+ """Modifying object default repr() to custom info.
+
+ Args:
+ obj (object, required): Any python object.
+
+ Returns:
+ str: String for repr() method.
+ """
+
+ try:
+ if not obj:
+ raise ValueError("'obj' argument value is empty!")
+ except ValueError as err:
+ logger.error(err)
+ raise
- return False
+ _self_repr = (
+ f"<{obj.__class__.__module__}.{obj.__class__.__name__} object at {hex(id(obj))}: "
+ + "{"
+ + f"{str(dir(obj)).replace('[', '').replace(']', '')}"
+ + "}>"
+ )
+ return _self_repr
__all__ = [
- "is_running_bin",
+ "deep_merge",
+ "camel_to_snake",
+ "clean_obj_dict",
+ "obj_to_repr",
]
diff --git a/src/bv_challenge/challenge/api/core/utils/_dt.py b/src/bv_challenge/challenge/api/core/utils/_dt.py
new file mode 100644
index 0000000..88a2648
--- /dev/null
+++ b/src/bv_challenge/challenge/api/core/utils/_dt.py
@@ -0,0 +1,245 @@
+# -*- coding: utf-8 -*-
+
+import time
+from enum import Enum
+from typing import Union, Optional
+from zoneinfo import ZoneInfo
+from datetime import datetime, timezone, tzinfo, timedelta
+
+from pydantic import validate_call, constr, conint
+from beans_logging import logger
+
+from api.core.constants import WarnEnum
+
+
+class TSUnitEnum(str, Enum):
+ SECONDS = "SECONDS"
+ MILLISECONDS = "MILLISECONDS"
+ MICROSECONDS = "MICROSECONDS"
+ NANOSECONDS = "NANOSECONDS"
+
+
+@validate_call(config={"arbitrary_types_allowed": True})
+def add_tzinfo(dt: datetime, tz: Union[ZoneInfo, tzinfo, str]) -> datetime:
+ """Add or replace timezone info to datetime object.
+
+ Args:
+ dt (datetime , required): Datetime object.
+ tz (Union[ZoneInfo, tzinfo, str], required): Timezone info.
+
+ Returns:
+ datetime: Datetime object with timezone info.
+ """
+
+ if isinstance(tz, str):
+ tz = ZoneInfo(tz)
+
+ dt = dt.replace(tzinfo=tz)
+ return dt
+
+
+@validate_call
+def datetime_to_iso(
+ dt: datetime,
+ sep: constr(max_length=8) = "T", # type: ignore
+ warn_mode: WarnEnum = WarnEnum.IGNORE,
+) -> str:
+ """Convert datetime object to ISO 8601 format.
+
+ Args:
+ dt (datetime, required): Datetime object.
+ sep (str , optional): Separator between date and time. Defaults to "T".
+ warn_mode (WarnEnum, optional): Warning mode. Defaults to WarnEnum.IGNORE.
+
+ Raises:
+ ValueError: If `dt` argument doesn't have any timezone info and `warn_mode` is set to WarnEnum.ERROR.
+
+ Returns:
+ str: Datetime string in ISO 8601 format.
+ """
+
+ if not dt.tzinfo:
+ _message = "Not found any timezone info in `dt` argument, assuming it's UTC timezone..."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.warning(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+ elif warn_mode == WarnEnum.ERROR:
+ _message = "Not found any timezone info in `dt` argument!"
+ logger.error(_message)
+ raise ValueError(_message)
+
+ dt = add_tzinfo(dt=dt, tz="UTC")
+
+ _dt_str = dt.isoformat(sep=sep, timespec="milliseconds")
+ return _dt_str
+
+
+@validate_call(config={"arbitrary_types_allowed": True})
+def convert_tz(
+ dt: datetime,
+ tz: Union[ZoneInfo, tzinfo, str],
+ warn_mode: WarnEnum = WarnEnum.ALWAYS,
+) -> datetime:
+ """Convert datetime object to another timezone.
+
+ Args:
+ dt (datetime , required): Datetime object to convert.
+ tz (Union[ZoneInfo, tzinfo, str], required): Timezone info to convert.
+ warn_mode (WarnEnum , optional): Warning mode. Defaults to WarnEnum.ALWAYS.
+
+ Raises:
+ ValueError: If `dt` argument doesn't have any timezone info and `warn_mode` is set to WarnEnum.ERROR.
+
+ Returns:
+ datetime: Datetime object which has been converted to another timezone.
+ """
+
+ if not dt.tzinfo:
+ _message = "Not found any timezone info in `dt` argument, assuming it's UTC timezone..."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.warning(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+ elif warn_mode == WarnEnum.ERROR:
+ _message = "Not found any timezone info in `dt` argument!"
+ logger.error(_message)
+ raise ValueError(_message)
+
+ dt = add_tzinfo(dt=dt, tz="UTC")
+
+ if isinstance(tz, str):
+ tz = ZoneInfo(tz)
+
+ dt = dt.astimezone(tz=tz)
+ return dt
+
+
+def now_utc_dt() -> datetime:
+ """Get current datetime in UTC timezone with tzinfo.
+
+ Returns:
+ datetime: Current datetime in UTC timezone with tzinfo.
+ """
+
+ _utc_dt = datetime.now(tz=timezone.utc)
+ return _utc_dt
+
+
+def now_local_dt() -> datetime:
+ """Get current datetime in local timezone with tzinfo.
+
+ Returns:
+ datetime: Current datetime in local timezone with tzinfo.
+ """
+
+ _local_dt = datetime.now().astimezone()
+ return _local_dt
+
+
+@validate_call(config={"arbitrary_types_allowed": True})
+def now_dt(tz: Union[ZoneInfo, tzinfo, str]) -> datetime:
+ """Get current datetime in specified timezone with tzinfo.
+
+ Args:
+ tz (Union[ZoneInfo, tzinfo, str], required): Timezone info.
+
+ Returns:
+ datetime: Current datetime in specified timezone with tzinfo.
+ """
+
+ _dt = now_utc_dt()
+ _dt = convert_tz(dt=_dt, tz=tz)
+ return _dt
+
+
+@validate_call
+def now_ts(unit: TSUnitEnum = TSUnitEnum.SECONDS) -> int:
+ """Get current timestamp in UTC timezone.
+
+ Args:
+ unit (TSUnitEnum, optional): Type of timestamp unit. Defaults to `TSUnitEnum.SECONDS`.
+
+ Returns:
+ int: Current timestamp.
+ """
+
+ _now_ts: int = None
+ if unit == TSUnitEnum.SECONDS:
+ _now_ts = int(time.time())
+ elif unit == TSUnitEnum.MILLISECONDS:
+ _now_ts = int(_now_ts * 1000)
+ elif unit == TSUnitEnum.MICROSECONDS:
+ _now_ts = int(time.time_ns() / 1000)
+ elif unit == TSUnitEnum.NANOSECONDS:
+ _now_ts = int(time.time_ns())
+
+ return _now_ts
+
+
+@validate_call
+def convert_ts(dt: datetime, unit: TSUnitEnum = TSUnitEnum.SECONDS) -> int:
+ """Convert datetime to timestamp.
+
+ Args:
+ dt (datetime , required): Datetime object to convert.
+ unit (TSUnitEnum, optional): Type of timestamp unit. Defaults to `TSUnitEnum.SECONDS`.
+
+ Returns:
+ int: Converted timestamp.
+ """
+
+ _ts: int = None
+ if unit == TSUnitEnum.SECONDS:
+ _ts = int(dt.timestamp())
+ elif unit == TSUnitEnum.MILLISECONDS:
+ _ts = int(dt.timestamp() * 1000)
+ elif unit == TSUnitEnum.MICROSECONDS:
+ _ts = int(dt.timestamp() * 1000000)
+ elif unit == TSUnitEnum.NANOSECONDS:
+ _ts = int(dt.timestamp() * 1000000000)
+
+ return _ts
+
+
+@validate_call(config={"arbitrary_types_allowed": True})
+def calc_future_dt(
+ delta: Union[timedelta, conint(ge=1)], # type: ignore
+ dt: Optional[datetime] = None,
+ tz: Union[ZoneInfo, tzinfo, str, None] = None,
+) -> datetime:
+ """Calculate future datetime by adding delta time to current or specified datetime.
+
+ Args:
+ delta (Union[timedelta, int] , required): Delta time to add to current or specified datetime.
+ dt (Optional[datetime] , optional): Datetime before adding delta time. Defaults to None.
+ tz (Union[ZoneInfo, tzinfo, str, None], optional): Timezone info. Defaults to None.
+
+ Returns:
+ datetime: Calculated future datetime.
+ """
+
+ if not dt:
+ dt = now_utc_dt()
+
+ if tz:
+ dt = convert_tz(dt=dt, tz=tz)
+
+ if isinstance(delta, int):
+ delta = timedelta(seconds=delta)
+
+ _future_dt = dt + delta
+ return _future_dt
+
+
+__all__ = [
+ "add_tzinfo",
+ "datetime_to_iso",
+ "convert_tz",
+ "now_utc_dt",
+ "now_local_dt",
+ "now_dt",
+ "now_ts",
+ "convert_ts",
+ "calc_future_dt",
+]
diff --git a/src/bv_challenge/challenge/api/core/utils/_http.py b/src/bv_challenge/challenge/api/core/utils/_http.py
new file mode 100644
index 0000000..cf52bd3
--- /dev/null
+++ b/src/bv_challenge/challenge/api/core/utils/_http.py
@@ -0,0 +1,128 @@
+# -*- coding: utf-8 -*-
+
+from typing import Tuple, Union
+from urllib import request
+from http import HTTPStatus
+from http.client import HTTPResponse
+
+import aiohttp
+from pydantic import validate_call, conint, AnyHttpUrl
+from starlette.datastructures import URL
+from fastapi import Request
+
+
+@validate_call
+def get_http_status(status_code: int) -> Tuple[HTTPStatus, bool]:
+ """Get HTTP status code enum from integer value.
+
+ Args:
+ status_code (int, required): Status code for HTTP response: [100 <= status_code <= 599].
+
+ Raises:
+ ValueError: If status code is not in range [100 <= status_code <= 599].
+
+ Returns:
+ Tuple[HTTPStatus, bool]: Tuple of HTTP status code enum and boolean value if status code is known.
+ """
+
+ _http_status: HTTPStatus
+ _is_known_status = False
+ try:
+ _http_status = HTTPStatus(status_code)
+ _is_known_status = True
+ except ValueError:
+ if (100 <= status_code) and (status_code < 200):
+ status_code = 100
+ elif (200 <= status_code) and (status_code < 300):
+ status_code = 200
+ elif (300 <= status_code) and (status_code < 400):
+ status_code = 304
+ elif (400 <= status_code) and (status_code < 500):
+ status_code = 400
+ elif (500 <= status_code) and (status_code < 600):
+ status_code = 500
+ else:
+ raise ValueError(f"Invalid HTTP status code: '{status_code}'!")
+
+ _http_status = HTTPStatus(status_code)
+
+ return (_http_status, _is_known_status)
+
+
+@validate_call(config={"arbitrary_types_allowed": True})
+def get_relative_url(val: Union[Request, URL]) -> str:
+ """Get relative url only path with query params from request object or URL object.
+
+ Args:
+ val (Union[Request, URL]): Request object or URL object to extract relative url.
+
+ Returns:
+ str: Relative url only path with query params.
+ """
+
+ if isinstance(val, Request):
+ val: URL = val.url
+
+ _relative_url = str(val).replace(f"{val.scheme}://{val.netloc}", "")
+ return _relative_url
+
+
+@validate_call
+async def async_is_connectable(
+ url: AnyHttpUrl = "https://www.google.com",
+ timeout: conint(ge=1) = 3, # type: ignore
+ check_status: bool = False,
+) -> bool:
+ """Check if the url is connectable.
+
+ Args:
+ url (AnyHttpUrl, optional): URL to check. Defaults to 'https://www.google.com'.
+ timeout (int , optional): Timeout in seconds. Defaults to 3.
+ check_status (bool , optional): Check HTTP status code (200). Defaults to False.
+
+ Returns:
+ bool: True if connectable, False otherwise.
+ """
+
+ try:
+ async with aiohttp.ClientSession() as _session:
+ async with _session.get(url, timeout=timeout) as _response:
+ if check_status:
+ return _response.status == 200
+ return True
+ except:
+ return False
+
+
+@validate_call
+def is_connectable(
+ url: AnyHttpUrl = "https://www.google.com",
+ timeout: conint(ge=1) = 3, # type: ignore
+ check_status: bool = False,
+) -> bool:
+ """Check if the url is connectable.
+
+ Args:
+ url (AnyHttpUrl, optional): URL to check. Defaults to 'https://www.google.com'.
+ timeout (int , optional): Timeout in seconds. Defaults to 3.
+ check_status (bool , optional): Check HTTP status code (200). Defaults to False.
+
+ Returns:
+ bool: True if connectable, False otherwise.
+ """
+
+ try:
+ _response: HTTPResponse = request.urlopen(url, timeout=timeout)
+ if check_status:
+ return _response.getcode() == 200
+ return True
+ except:
+ return False
+
+
+__all__ = [
+ "get_http_status",
+ "get_relative_url",
+ "async_is_connectable",
+ "is_connectable",
+]
diff --git a/src/bv_challenge/challenge/api/core/utils/_io.py b/src/bv_challenge/challenge/api/core/utils/_io.py
new file mode 100644
index 0000000..06f2ddc
--- /dev/null
+++ b/src/bv_challenge/challenge/api/core/utils/_io.py
@@ -0,0 +1,461 @@
+# -*- coding: utf-8 -*-
+
+import os
+import errno
+import shutil
+import hashlib
+from typing import List
+
+import aioshutil
+import aiofiles.os
+from pydantic import validate_call, conint, constr
+from beans_logging import logger
+
+from api.core.constants import WarnEnum, HashAlgoEnum
+
+
+_path_max_length = 1024
+
+
+## Async:
+@validate_call
+async def async_create_dir(
+ create_dir: constr(strip_whitespace=True, min_length=1, max_length=_path_max_length), # type: ignore
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> None:
+ """Asynchronous create directory if `create_dir` doesn't exist.
+
+ Args:
+ create_dir (str, required): Create directory path.
+ warn_mode (str, optional): Warning message mode, for example: 'ERROR', 'ALWAYS', 'DEBUG', 'IGNORE'. Defaults to 'DEBUG'.
+
+ Raises:
+ OSError: When warning mode is set to ERROR and directory already exists.
+ OSError: If failed to create directory.
+ """
+
+ if not await aiofiles.os.path.isdir(create_dir):
+ try:
+ _message = f"Creating '{create_dir}' directory..."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.info(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ await aiofiles.os.makedirs(create_dir)
+ except OSError as err:
+ if (err.errno == errno.EEXIST) and (warn_mode == WarnEnum.DEBUG):
+ logger.debug(f"'{create_dir}' directory already exists!")
+ else:
+ logger.error(f"Failed to create '{create_dir}' directory!")
+ raise
+
+ _message = f"Successfully created '{create_dir}' directory."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.success(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ elif warn_mode == WarnEnum.ERROR:
+ raise OSError(errno.EEXIST, f"'{create_dir}' directory already exists!")
+
+ return
+
+
+@validate_call
+async def async_remove_dir(
+ remove_dir: constr(strip_whitespace=True, min_length=1, max_length=_path_max_length), # type: ignore
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> None:
+ """Asynchronous remove directory if `remove_dir` exists.
+
+ Args:
+ remove_dir (str, required): Remove directory path.
+ warn_mode (str, optional): Warning message mode, for example: 'ERROR', 'ALWAYS', 'DEBUG', 'IGNORE'. Defaults to 'DEBUG'.
+
+ Raises:
+ OSError: When warning mode is set to ERROR and directory doesn't exist.
+ OSError: If failed to remove directory.
+ """
+
+ if await aiofiles.os.path.isdir(remove_dir):
+ try:
+ _message = f"Removing '{remove_dir}' directory..."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.info(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ await aioshutil.rmtree(remove_dir)
+ except OSError as err:
+ if (err.errno == errno.ENOENT) and (warn_mode == WarnEnum.DEBUG):
+ logger.debug(f"'{remove_dir}' directory doesn't exist!")
+ else:
+ logger.error(f"Failed to remove '{remove_dir}' directory!")
+ raise
+
+ _message = f"Successfully removed '{remove_dir}' directory."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.success(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ elif warn_mode == WarnEnum.ERROR:
+ raise OSError(errno.ENOENT, f"'{create_dir}' directory doesn't exist!")
+
+ return
+
+
+@validate_call
+async def async_remove_dirs(
+ remove_dirs: List[constr(strip_whitespace=True, min_length=1, max_length=_path_max_length)], # type: ignore
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> None:
+ """Asynchronous remove directories if `remove_dirs` exists.
+
+ Args:
+ remove_dirs (List[str], required): Remove directories paths as list.
+ warn_mode (str , optional): Warning message mode, for example: 'ERROR', 'ALWAYS', 'DEBUG', 'IGNORE'. Defaults to 'DEBUG'.
+ """
+
+ for _remove_dir in remove_dirs:
+ await async_remove_dir(remove_dir=_remove_dir, warn_mode=warn_mode)
+
+ return
+
+
+@validate_call
+async def async_remove_file(
+ file_path: constr(strip_whitespace=True, min_length=1, max_length=_path_max_length), # type: ignore
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> None:
+ """Asynchronous remove file if `file_path` exists.
+
+ Args:
+ file_path (str, required): Remove file path.
+ warn_mode (str, optional): Warning message mode, for example: 'ERROR', 'ALWAYS', 'DEBUG', 'IGNORE'. Defaults to 'DEBUG'.
+
+ Raises:
+ OSError: When warning mode is set to ERROR and file doesn't exist.
+ OSError: If failed to remove file.
+ """
+
+ if await aiofiles.os.path.isfile(file_path):
+ try:
+ _message = f"Removing '{file_path}' file..."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.info(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ await aiofiles.os.remove(file_path)
+ except OSError as err:
+ if (err.errno == errno.ENOENT) and (warn_mode == WarnEnum.DEBUG):
+ logger.debug(f"'{file_path}' file doesn't exist!")
+ else:
+ logger.error(f"Failed to remove '{file_path}' file!")
+ raise
+
+ _message = f"Successfully removed '{file_path}' file."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.success(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ elif warn_mode == WarnEnum.ERROR:
+ raise OSError(errno.ENOENT, f"'{file_path}' file doesn't exist!")
+
+ return
+
+
+@validate_call
+async def async_remove_files(
+ file_paths: List[constr(strip_whitespace=True, min_length=1, max_length=_path_max_length)], # type: ignore
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> None:
+ """Asynchronous remove files if `file_paths` exists.
+
+ Args:
+ file_paths (List[str], required): Remove file paths as list.
+ warn_mode (str , optional): Warning message mode, for example: 'ERROR', 'ALWAYS', 'DEBUG', 'IGNORE'. Defaults to 'DEBUG'.
+ """
+
+ for _file_path in file_paths:
+ await async_remove_file(file_path=_file_path, warn_mode=warn_mode)
+
+ return
+
+
+@validate_call
+async def async_get_file_checksum(
+ file_path: constr(strip_whitespace=True, min_length=1, max_length=_path_max_length), # type: ignore
+ hash_method: HashAlgoEnum = HashAlgoEnum.md5,
+ chunk_size: conint(ge=10) = 4096, # type: ignore
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> str:
+ """Asynchronous get file checksum.
+
+ Args:
+ file_path (str , required): Target file path.
+ hash_method (HashAlgoEnum, optional): Hash method. Defaults to `HashAlgoEnum.md5`.
+ chunk_size (int , optional): Chunk size. Defaults to 4096.
+ warn_mode (str , optional): Warning message mode, for example: 'ERROR', 'ALWAYS', 'DEBUG', 'IGNORE'. Defaults to 'DEBUG'.
+
+ Raises:
+ OSError: When warning mode is set to ERROR and file doesn't exist.
+
+ Returns:
+ str: File checksum.
+ """
+
+ _file_checksum: str = None
+ if await aiofiles.os.path.isfile(file_path):
+ _file_hash = hashlib.new(hash_method.value)
+ async with aiofiles.open(file_path, "rb") as _file:
+ while True:
+ _file_chunk = await _file.read(chunk_size)
+ if not _file_chunk:
+ break
+ _file_hash.update(_file_chunk)
+
+ _file_checksum = _file_hash.hexdigest()
+ else:
+ _message = f"'{file_path}' file doesn't exist!"
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.warning(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+ elif warn_mode == WarnEnum.ERROR:
+ raise OSError(errno.ENOENT, _message)
+
+ return _file_checksum
+
+
+## Sync:
+@validate_call
+def create_dir(
+ create_dir: constr(strip_whitespace=True, min_length=1, max_length=_path_max_length), # type: ignore
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> None:
+ """Create directory if `create_dir` doesn't exist.
+
+ Args:
+ create_dir (str, required): Create directory path.
+ warn_mode (str, optional): Warning message mode, for example: 'ERROR', 'ALWAYS', 'DEBUG', 'IGNORE'. Defaults to 'DEBUG'.
+
+ Raises:
+ OSError: When warning mode is set to ERROR and directory already exists.
+ OSError: If failed to create directory.
+ """
+
+ if not os.path.isdir(create_dir):
+ try:
+ _message = f"Creating '{create_dir}' directory..."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.info(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ os.makedirs(create_dir)
+ except OSError as err:
+ if (err.errno == errno.EEXIST) and (warn_mode == WarnEnum.DEBUG):
+ logger.debug(f"'{create_dir}' directory already exists!")
+ else:
+ logger.error(f"Failed to create '{create_dir}' directory!")
+ raise
+
+ _message = f"Successfully created '{create_dir}' directory."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.success(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ elif warn_mode == WarnEnum.ERROR:
+ raise OSError(errno.EEXIST, f"'{create_dir}' directory already exists!")
+
+ return
+
+
+@validate_call
+def remove_dir(
+ remove_dir: constr(strip_whitespace=True, min_length=1, max_length=_path_max_length), # type: ignore
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> None:
+ """Remove directory if `remove_dir` exists.
+
+ Args:
+ remove_dir (str, required): Remove directory path.
+ warn_mode (str, optional): Warning message mode, for example: 'ERROR', 'ALWAYS', 'DEBUG', 'IGNORE'. Defaults to 'DEBUG'.
+
+ Raises:
+ OSError: When warning mode is set to ERROR and directory doesn't exist.
+ OSError: If failed to remove directory.
+ """
+
+ if os.path.isdir(remove_dir):
+ try:
+ _message = f"Removing '{remove_dir}' directory..."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.info(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ shutil.rmtree(remove_dir)
+ except OSError as err:
+ if (err.errno == errno.ENOENT) and (warn_mode == WarnEnum.DEBUG):
+ logger.debug(f"'{remove_dir}' directory doesn't exist!")
+ else:
+ logger.error(f"Failed to remove '{remove_dir}' directory!")
+ raise
+
+ _message = f"Successfully removed '{remove_dir}' directory."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.success(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ elif warn_mode == WarnEnum.ERROR:
+ raise OSError(errno.ENOENT, f"'{create_dir}' directory doesn't exist!")
+
+ return
+
+
+@validate_call
+def remove_dirs(
+ remove_dirs: List[constr(strip_whitespace=True, min_length=1, max_length=_path_max_length)], # type: ignore
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> None:
+ """Remove directories if `remove_dirs` exist.
+
+ Args:
+ remove_dirs (List[str], required): Remove directory paths as list.
+ warn_mode (str , optional): Warning message mode, for example: 'ERROR', 'ALWAYS', 'DEBUG', 'IGNORE'. Defaults to 'DEBUG'.
+ """
+
+ for _remove_dir in remove_dirs:
+ remove_dir(remove_dir=_remove_dir, warn_mode=warn_mode)
+
+ return
+
+
+@validate_call
+def remove_file(
+ file_path: constr(strip_whitespace=True, min_length=1, max_length=_path_max_length), # type: ignore
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> None:
+ """Remove file if `file_path` exists.
+
+ Args:
+ file_path (str, required): Remove file path.
+ warn_mode (str, optional): Warning message mode, for example: 'ERROR', 'ALWAYS', 'DEBUG', 'IGNORE'. Defaults to 'DEBUG'.
+
+ Raises:
+ OSError: When warning mode is set to ERROR and file doesn't exist.
+ OSError: If failed to remove file.
+ """
+
+ if os.path.isfile(file_path):
+ try:
+ _message = f"Removing '{file_path}' file..."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.info(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ os.remove(file_path)
+ except OSError as err:
+ if (err.errno == errno.ENOENT) and (warn_mode == WarnEnum.DEBUG):
+ logger.debug(f"'{file_path}' file doesn't exist!")
+ else:
+ logger.error(f"Failed to remove '{file_path}' file!")
+ raise
+
+ _message = f"Successfully removed '{file_path}' file."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.success(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ elif warn_mode == WarnEnum.ERROR:
+ raise OSError(errno.ENOENT, f"'{file_path}' file doesn't exist!")
+
+ return
+
+
+@validate_call
+def remove_files(
+ file_paths: List[constr(strip_whitespace=True, min_length=1, max_length=_path_max_length)], # type: ignore
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> None:
+ """Remove files if `file_paths` exist.
+
+ Args:
+ file_paths (List[str], required): Remove file paths as list.
+ warn_mode (str , optional): Warning message mode, for example: 'ERROR', 'ALWAYS', 'DEBUG', 'IGNORE'. Defaults to 'DEBUG'.
+ """
+
+ for _file_path in file_paths:
+ remove_file(file_path=_file_path, warn_mode=warn_mode)
+
+ return
+
+
+@validate_call
+def get_file_checksum(
+ file_path: constr(strip_whitespace=True, min_length=1, max_length=_path_max_length), # type: ignore
+ hash_method: HashAlgoEnum = HashAlgoEnum.md5,
+ chunk_size: conint(ge=10) = 4096, # type: ignore
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> str:
+ """Get file checksum.
+
+ Args:
+ file_path (str , required): Target file path.
+ hash_method (HashAlgoEnum, optional): Hash method. Defaults to `HashAlgoEnum.md5`.
+ chunk_size (int , optional): Chunk size. Defaults to 4096.
+ warn_mode (str , optional): Warning message mode, for example: 'ERROR', 'ALWAYS', 'DEBUG', 'IGNORE'. Defaults to 'DEBUG'.
+
+ Raises:
+ OSError: When warning mode is set to ERROR and file doesn't exist.
+
+ Returns:
+ str: File checksum.
+ """
+
+ _file_checksum: str = None
+ if os.path.isfile(file_path):
+ _file_hash = hashlib.new(hash_method.value)
+ with open(file_path, "rb") as _file:
+ while True:
+ _file_chunk = _file.read(chunk_size)
+ if not _file_chunk:
+ break
+ _file_hash.update(_file_chunk)
+
+ _file_checksum = _file_hash.hexdigest()
+ else:
+ _message = f"'{file_path}' file doesn't exist!"
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.warning(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+ elif warn_mode == WarnEnum.ERROR:
+ raise OSError(errno.ENOENT, _message)
+
+ return _file_checksum
+
+
+__all__ = [
+ "async_create_dir",
+ "async_remove_dir",
+ "async_remove_dirs",
+ "async_remove_file",
+ "async_remove_files",
+ "async_get_file_checksum",
+ "create_dir",
+ "remove_dir",
+ "remove_dirs",
+ "remove_file",
+ "remove_files",
+ "get_file_checksum",
+]
diff --git a/src/bv_challenge/challenge/api/core/utils/_sanitizer.py b/src/bv_challenge/challenge/api/core/utils/_sanitizer.py
new file mode 100644
index 0000000..80592a9
--- /dev/null
+++ b/src/bv_challenge/challenge/api/core/utils/_sanitizer.py
@@ -0,0 +1,86 @@
+# -*- coding: utf-8 -*-
+
+import re
+import html
+from urllib.parse import quote
+
+from pydantic import validate_call, constr, AnyHttpUrl
+
+from api.core.constants import (
+ SPECIAL_CHARS_BASE_REGEX,
+ SPECIAL_CHARS_LOW_REGEX,
+ SPECIAL_CHARS_MEDIUM_REGEX,
+ SPECIAL_CHARS_HIGH_REGEX,
+ SPECIAL_CHARS_STRICT_REGEX,
+)
+
+
+@validate_call
+def escape_html(val: constr(strip_whitespace=True)) -> str: # type: ignore
+ """Escape HTML characters.
+
+ Args:
+ val (str, required): String to escape.
+
+ Returns:
+ str: Escaped string.
+ """
+
+ _escaped = html.escape(val)
+ return _escaped
+
+
+@validate_call
+def espace_url(val: AnyHttpUrl) -> str:
+ """Escape URL characters.
+
+ Args:
+ val (AnyHttpUrl, required): String to escape.
+
+ Returns:
+ str: Escaped string.
+ """
+
+ _escaped = quote(val)
+ return _escaped
+
+
+@validate_call
+def clean_special_chars(val: str, mode: str = "LOW") -> str:
+ """Sanitize special characters.
+
+ Args:
+ val (str, required): String to sanitize.
+ mode (str, optional): Sanitization mode. Defaults to "LOW".
+
+ Raises:
+ ValueError: If `mode` is unsupported.
+
+ Returns:
+ str: Sanitized string.
+ """
+
+ _pattern = r""
+ mode = mode.upper()
+ if (mode == "BASE") or (mode == "HTML"):
+ _pattern = SPECIAL_CHARS_BASE_REGEX
+ elif mode == "LOW":
+ _pattern = SPECIAL_CHARS_LOW_REGEX
+ elif mode == "MEDIUM":
+ _pattern = SPECIAL_CHARS_MEDIUM_REGEX
+ elif (mode == "HIGH") or (mode == "SCRIPT") or (mode == "SQL"):
+ _pattern = SPECIAL_CHARS_HIGH_REGEX
+ elif mode == "STRICT":
+ _pattern = SPECIAL_CHARS_STRICT_REGEX
+ else:
+ raise ValueError(f"Unsupported mode: {mode}")
+
+ _sanitized = re.sub(pattern=_pattern, repl="", string=val)
+ return _sanitized
+
+
+__all__ = [
+ "escape_html",
+ "espace_url",
+ "clean_special_chars",
+]
diff --git a/src/bv_challenge/challenge/api/core/utils/_secure.py b/src/bv_challenge/challenge/api/core/utils/_secure.py
new file mode 100644
index 0000000..3680440
--- /dev/null
+++ b/src/bv_challenge/challenge/api/core/utils/_secure.py
@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+
+import uuid
+import string
+import secrets
+import hashlib
+
+from pydantic import validate_call, conint, constr
+
+from api.core.constants import HashAlgoEnum
+from ._dt import now_ts
+
+
+@validate_call
+def gen_unique_id(prefix: constr(strip_whitespace=True, max_length=32) = "") -> str: # type: ignore
+ """Generate unique id.
+
+ Args:
+ prefix (str, optional): Prefix of id. Defaults to ''.
+
+ Returns:
+ str: Unique id.
+ """
+
+ _id = str(f"{prefix}{now_ts()}_{uuid.uuid4().hex}").lower()
+ return _id
+
+
+@validate_call
+def gen_random_string(length: conint(ge=1) = 16, is_alphanum: bool = True) -> str: # type: ignore
+ """Generate secure random string.
+
+ Args:
+ length (int , optional): Length of random string. Defaults to 16.
+ is_alphanum (bool, optional): If True, generate only alphanumeric string. Defaults to True.
+
+ Returns:
+ str: Generated random string.
+ """
+
+ _base_chars = string.ascii_letters + string.digits
+ if not is_alphanum:
+ _base_chars += string.punctuation
+
+ _random_str = "".join(secrets.choice(_base_chars) for _i in range(length))
+ return _random_str
+
+
+@validate_call
+def hash_str(val: str, algorithm: HashAlgoEnum = HashAlgoEnum.sha256) -> str:
+ """Hash a string using a specified hash algorithm.
+
+ Args:
+ val (str , required): The string to hash.
+ algorithm (HashAlgoEnum, required): The hash algorithm to use. Defaults to `HashAlgoEnum.sha256`.
+
+ Returns:
+ str: The hexadecimal representation of the digest.
+ """
+
+ if not isinstance(val, bytes):
+ val = val.encode("utf-8")
+
+ _hash = hashlib.new(algorithm.value)
+ _hash.update(val)
+
+ _hash_val = _hash.hexdigest()
+ return _hash_val
+
+
+__all__ = [
+ "gen_unique_id",
+ "gen_random_string",
+ "hash_str",
+]
diff --git a/src/bv_challenge/challenge/api/core/utils/_validator.py b/src/bv_challenge/challenge/api/core/utils/_validator.py
new file mode 100644
index 0000000..2090990
--- /dev/null
+++ b/src/bv_challenge/challenge/api/core/utils/_validator.py
@@ -0,0 +1,152 @@
+# -*- coding: utf-8 -*-
+
+import re
+from typing import List, Union, Pattern
+
+from pydantic import validate_call
+
+from api.core.constants import (
+ REQUEST_ID_REGEX,
+ SPECIAL_CHARS_BASE_REGEX,
+ SPECIAL_CHARS_LOW_REGEX,
+ SPECIAL_CHARS_MEDIUM_REGEX,
+ SPECIAL_CHARS_HIGH_REGEX,
+ SPECIAL_CHARS_STRICT_REGEX,
+)
+
+
+@validate_call
+def is_truthy(val: Union[str, bool, int, float, None]) -> bool:
+ """Check if the value is truthy.
+
+ Args:
+ val (Union[str, bool, int, float, None], required): Value to check.
+
+ Raises:
+ ValueError: If `val` argument type is string and value is invalid.
+
+ Returns:
+ bool: True if the value is truthy, False otherwise.
+ """
+
+ if isinstance(val, str):
+ val = val.strip().lower()
+
+ if val in ["0", "false", "f", "no", "n", "off"]:
+ return False
+ elif val in ["1", "true", "t", "yes", "y", "on"]:
+ return True
+ else:
+ raise ValueError(f"`val` argument value is invalid: '{val}'!")
+
+ return bool(val)
+
+
+@validate_call
+def is_falsy(val: Union[str, bool, int, float, None]) -> bool:
+ """Check if the value is falsy.
+
+ Args:
+ val (Union[str, bool, int, float, None], required): Value to check.
+
+ Returns:
+ bool: True if the value is falsy, False otherwise.
+ """
+
+ return not is_truthy(val)
+
+
+@validate_call
+def is_request_id(val: str) -> bool:
+ """Check if the string is valid request ID.
+
+ Args:
+ val (str, required): String to check.
+
+ Returns:
+ bool: True if the string is valid request ID, False otherwise.
+ """
+
+ _is_valid = bool(re.match(pattern=REQUEST_ID_REGEX, string=val))
+ return _is_valid
+
+
+@validate_call
+def is_blacklisted(val: str, blacklist: List[str]) -> bool:
+ """Check if the string is blacklisted.
+
+ Args:
+ val (str , required): String to check.
+ blacklist (List[str], required): List of blacklisted strings.
+
+ Returns:
+ bool: True if the string is blacklisted, False otherwise.
+ """
+
+ for _blacklisted in blacklist:
+ if _blacklisted in val:
+ return True
+
+ return False
+
+
+@validate_call
+def is_valid(val: str, pattern: Union[Pattern, str]) -> bool:
+ """Check if the string is valid with given pattern.
+
+ Args:
+ val (str , required): String to check.
+ pattern (Union[Pattern, str], required): Pattern regex to check.
+
+ Returns:
+ bool: True if the string is valid with given pattern, False otherwise.
+ """
+
+ _is_valid = bool(re.match(pattern=pattern, string=val))
+ return _is_valid
+
+
+@validate_call
+def has_special_chars(val: str, mode: str = "LOW") -> bool:
+ """Check if the string has special characters.
+
+ Args:
+ val (str, required): String to check.
+ mode (str, optional): Check mode. Defaults to "LOW".
+
+ Raises:
+ ValueError: If `mode` is unsupported.
+
+ Returns:
+ bool: True if the string has special characters, False otherwise.
+ """
+
+ _has_special_chars = False
+
+ _pattern = r""
+ mode = mode.upper()
+ if (mode == "BASE") or (mode == "HTML"):
+ _pattern = SPECIAL_CHARS_BASE_REGEX
+ elif mode == "LOW":
+ _pattern = SPECIAL_CHARS_LOW_REGEX
+ elif mode == "MEDIUM":
+ _pattern = SPECIAL_CHARS_MEDIUM_REGEX
+ elif (mode == "HIGH") or (mode == "SCRIPT") or (mode == "SQL"):
+ _pattern = SPECIAL_CHARS_HIGH_REGEX
+ elif mode == "STRICT":
+ _pattern = SPECIAL_CHARS_STRICT_REGEX
+ else:
+ raise ValueError(f"Unsupported mode: {mode}")
+
+ _has_special_chars = bool(re.search(pattern=_pattern, string=val))
+ return _has_special_chars
+
+
+__all__ = [
+ "is_truthy",
+ "is_falsy",
+ "is_request_id",
+ "is_blacklisted",
+ "is_valid",
+ "has_special_chars",
+]
diff --git a/src/bv_challenge/challenge/api/databases/__init__.py b/src/bv_challenge/challenge/api/databases/__init__.py
deleted file mode 100644
index e69de29..0000000
diff --git a/src/bv_challenge/challenge/api/endpoints/challenge/__init__.py b/src/bv_challenge/challenge/api/endpoints/challenge/__init__.py
deleted file mode 100644
index e69de29..0000000
diff --git a/src/bv_challenge/challenge/api/endpoints/challenge/payload_manager.py b/src/bv_challenge/challenge/api/endpoints/challenge/payload_manager.py
new file mode 100644
index 0000000..c4bc3c9
--- /dev/null
+++ b/src/bv_challenge/challenge/api/endpoints/challenge/payload_manager.py
@@ -0,0 +1,135 @@
+# -*- coding: utf-8 -*-
+
+import json
+import threading
+from dataclasses import dataclass, field
+from typing import Any, Callable, Dict, List, Optional, Tuple
+
+from api.core import utils
+from api.config import config
+from api.endpoints.challenge import utils as challenge_utils
+from api.helpers.crypto import asymmetric as asymmetric_helper
+from api.endpoints.challenge.schemas import KeyPairPM
+
+
+@dataclass
+class SessionRecord:
+ session_id: str
+ score: Optional[float] = None
+ completed: bool = False
+ timed_out: bool = False
+
+
+@dataclass
+class EvalOutcome:
+ status: str
+ session_id: Optional[str] = None
+ score: Optional[float] = None
+
+
+class PayloadManager:
+ """Own one scoring run's keys, sessions, attribution, and locks."""
+
+ def __init__(self) -> None:
+ self.run_lock = threading.Lock()
+ self.claim_lock = threading.Lock()
+ self.reset()
+
+ def reset(self) -> None:
+ self.key_pairs: List[KeyPairPM] = challenge_utils.gen_key_pairs()
+ self.run_id = utils.gen_random_string(length=16)
+ self.sessions: Dict[str, SessionRecord] = {
+ pair.nonce: SessionRecord(session_id=pair.nonce)
+ for pair in self.key_pairs
+ if pair.nonce
+ }
+ self.private_keys: Dict[str, str] = {
+ pair.nonce: pair.private_key
+ for pair in self.key_pairs
+ if pair.nonce
+ }
+ self.cur_key_pair: Optional[KeyPairPM] = None
+
+ def pop_task(self) -> Optional[KeyPairPM]:
+ if not self.key_pairs:
+ self.cur_key_pair = None
+ return None
+ self.cur_key_pair = self.key_pairs.pop(0)
+ return self.cur_key_pair
+
+ def has_remaining_tasks(self) -> bool:
+ return bool(self.key_pairs)
+
+ def remaining_task_count(self) -> int:
+ return len(self.key_pairs)
+
+ def get_nonce(self) -> str:
+ if not self.cur_key_pair or not self.cur_key_pair.public_key:
+ raise ValueError("No public key is available")
+ public_key = self.cur_key_pair.public_key
+ self.cur_key_pair.public_key = None
+ self.cur_key_pair.nonce = None
+ return public_key
+
+ def claim_web_key(self) -> Tuple[str, str, bool]:
+ with self.claim_lock:
+ if self.cur_key_pair and self.cur_key_pair.public_key:
+ nonce = self.cur_key_pair.nonce
+ public_key = self.cur_key_pair.public_key
+ self.pop_task()
+ return nonce, public_key, True
+
+ nonce = utils.gen_random_string()
+ public_key = asymmetric_helper.gen_key_pair(
+ key_size=config.api.security.asymmetric.key_size,
+ as_str=True,
+ )[1]
+ return nonce, public_key, False
+
+ def completed_count(self) -> int:
+ return sum(record.completed for record in self.sessions.values())
+
+ def process_eval(
+ self,
+ data: str,
+ decrypt_fn: Callable[..., str],
+ score_fn: Callable[[dict], float],
+ ) -> EvalOutcome:
+ for session_id, private_key in list(self.private_keys.items()):
+ try:
+ payload = json.loads(
+ decrypt_fn(ciphertext=data, private_key=private_key)
+ )
+ except Exception:
+ continue
+
+ with self.claim_lock:
+ record = self.sessions.get(session_id)
+ if record is None or record.completed:
+ return EvalOutcome(status="duplicate", session_id=session_id)
+ score = score_fn(payload)
+ record.score = score
+ record.completed = True
+ return EvalOutcome(
+ status="recorded",
+ session_id=session_id,
+ score=score,
+ )
+
+ return EvalOutcome(status="unattributable")
+
+ def finalize(self, timeout_score: float) -> float:
+ if not self.sessions:
+ return 0.0
+ with self.claim_lock:
+ total = 0.0
+ for record in self.sessions.values():
+ if record.completed and record.score is not None:
+ total += record.score
+ else:
+ record.timed_out = True
+ total += timeout_score
+ return total / len(self.sessions)
+
+
+__all__ = ["EvalOutcome", "PayloadManager", "SessionRecord"]
diff --git a/src/bv_challenge/challenge/api/endpoints/challenge/router.py b/src/bv_challenge/challenge/api/endpoints/challenge/router.py
index 98ffc0b..e72278e 100644
--- a/src/bv_challenge/challenge/api/endpoints/challenge/router.py
+++ b/src/bv_challenge/challenge/api/endpoints/challenge/router.py
@@ -1,20 +1,25 @@
-from fastapi import APIRouter, Request, HTTPException
-from fastapi.responses import JSONResponse
+# -*- coding: utf-8 -*-
-from api.core.constants import ErrorCodeEnum
-from api.core.exceptions import BaseHTTPException
+from fastapi import APIRouter, Request, HTTPException
+from fastapi.responses import HTMLResponse, JSONResponse
+
+from api.core.responses import BaseResponse
+from api.endpoints.challenge.schemas import (
+ MinerInput,
+ MinerOutput,
+ EvalPayload,
+ RandomValRequest,
+)
+from api.endpoints.challenge import service
from api.logger import logger
-from .schemas import MinerInput, MinerOutput
-from . import service
-
router = APIRouter(tags=["Challenge"])
@router.get(
"/task",
summary="Get task",
- description="This endpoint returns the task for the miner.",
+ description="This endpoint returns the webpage URL for the challenge.",
response_class=JSONResponse,
response_model=MinerInput,
)
@@ -28,14 +33,14 @@ def get_task(request: Request):
_miner_input = service.get_task()
logger.success(f"[{_request_id}] - Successfully got the task.")
- except HTTPException:
- raise
- except Exception:
- logger.exception(f"[{_request_id}] - Failed to get task!")
- raise BaseHTTPException(
- error_enum=ErrorCodeEnum.INTERNAL_SERVER_ERROR,
- message="Failed to get task!",
+ except Exception as err:
+ if isinstance(err, HTTPException):
+ raise
+
+ logger.error(
+ f"[{_request_id}] - Failed to get task!",
)
+ raise
return _miner_input
@@ -45,29 +50,131 @@ def get_task(request: Request):
summary="Score",
description="This endpoint score miner output.",
response_class=JSONResponse,
- responses={422: {}},
+ responses={400: {}, 422: {}},
)
-def post_score(request: Request, miner_input: MinerInput, miner_output: MinerOutput):
+def post_score(
+ request: Request,
+ miner_input: MinerInput,
+ miner_output: MinerOutput,
+):
_request_id = request.state.request_id
- logger.info(f"[{_request_id}] - Scoring the miner output...")
+ logger.info(f"[{_request_id}] - Evaluating the miner output...")
- _score: float = 0.0
try:
- _score = service.score(request_id=_request_id, miner_output=miner_output)
- logger.success(
- f"[{_request_id}] - Successfully scored the miner output: {_score}"
- )
+ _score = service.score(miner_output=miner_output)
except HTTPException:
+ # Already a well-formed HTTP error (e.g. TOO_MANY_REQUESTS) -- let it
+ # propagate so the client gets the real status, never a 200/null.
+ logger.error(f"[{_request_id}] - Failed to evaluate the miner output!")
raise
- except Exception:
- logger.exception(f"[{_request_id}] - Failed to score the miner output!")
- raise BaseHTTPException(
- error_enum=ErrorCodeEnum.INTERNAL_SERVER_ERROR,
- message="Failed to score the miner output!",
+ except Exception as err:
+ logger.error(
+ f"[{_request_id}] - Unexpected error evaluating the miner output: {err}"
+ )
+ raise HTTPException(
+ status_code=500, detail="Failed to evaluate the miner output."
)
+ logger.success(f"[{_request_id}] - Successfully scored the miner output: {_score}")
return _score
+@router.get(
+ "/result",
+ summary="Latest scoring result",
+ description="Returns the latest global score feedback result.",
+ response_class=JSONResponse,
+)
+def get_result(request: Request):
+ _request_id = request.state.request_id
+ logger.info(f"[{_request_id}] - Getting latest scoring result...")
+ return service.get_result()
+
+
+@router.get(
+ "/_web",
+ summary="Serves the webpage",
+ description="This endpoint serves the webpage for the challenge.",
+ response_class=HTMLResponse,
+ responses={429: {}},
+)
+def _get_web(request: Request):
+
+ _request_id = request.state.request_id
+ logger.info(f"[{_request_id}] - Getting webpage...")
+
+ _html_response: HTMLResponse
+ try:
+ _html_response = service.get_web(request=request)
+
+ logger.success(f"[{_request_id}] - Successfully got the webpage.")
+ except Exception as err:
+ if isinstance(err, HTTPException):
+ raise
+
+ logger.error(
+ f"[{_request_id}] - Failed to get the webpage!",
+ )
+ raise
+
+ return _html_response
+
+
+@router.post(
+ "/_random_val",
+ summary="Random value",
+ responses={401: {}, 422: {}, 429: {}},
+)
+def post_random_val(request: Request, payload: RandomValRequest):
+ _request_id = request.state.request_id
+ logger.info(f"[{_request_id}] - Checking random val...")
+
+ random_val = payload.random_val.strip()
+ nonce_val: str
+ try:
+ nonce_val = service.get_random_val(nonce=random_val)
+ logger.success(f"[{_request_id}] - Successfully checked the random val.")
+ except Exception as err:
+ if isinstance(err, HTTPException):
+ raise
+ logger.error(f"[{_request_id}] - Failed to check the random val!")
+ raise
+
+ _response = {"nonce_val": nonce_val}
+ return _response
+
+
+@router.post(
+ "/_eval",
+ summary="Evaluate",
+ description="This endpoint evaluate.",
+ responses={422: {}, 429: {}},
+)
+def _post_eval_bot(
+ request: Request,
+ payload: EvalPayload,
+):
+ _request_id = request.state.request_id
+ logger.info(f"[{_request_id}] - Evaluating the bot...")
+
+ try:
+ # Extract the data from the nested structure
+ data = payload.error.data
+ service.eval_bot(data=data)
+
+ logger.success(f"[{_request_id}] - Successfully evaluated the bot.")
+ except Exception as err:
+ if isinstance(err, HTTPException):
+ raise
+
+ logger.error(
+ f"[{_request_id}] - Failed to evaluate the bot!",
+ )
+ raise
+
+ _response = BaseResponse(request=request, message="Successfully evaluated the bot.")
+ return _response
+
+
__all__ = ["router"]
diff --git a/src/bv_challenge/challenge/api/endpoints/challenge/schemas.py b/src/bv_challenge/challenge/api/endpoints/challenge/schemas.py
index 6742abf..49acd6e 100644
--- a/src/bv_challenge/challenge/api/endpoints/challenge/schemas.py
+++ b/src/bv_challenge/challenge/api/endpoints/challenge/schemas.py
@@ -1,57 +1,163 @@
-from pydantic import BaseModel, Field, field_validator
+# -*- coding: utf-8 -*-
-from potato_util.generator import gen_random_string
+import os
+from pathlib import Path
+from typing import Optional, Union
+from pydantic import BaseModel, Field, constr, field_validator
-class MinerInput(BaseModel):
- random_val: str | None = Field(
- default_factory=gen_random_string,
- title="Random Value",
- description="Random value to prevent caching.",
- examples=["a1b2c3d4e5f6g7h8"],
+from api.core import utils
+from api.core.constants import ALPHANUM_CUSTOM_REGEX, ALPHANUM_REGEX
+
+MAX_EVAL_PAYLOAD_LENGTH = 128 * 1024
+
+
+_BOT_DIR = Path(
+ os.getenv(
+ "BV_CHALLENGE_API_DIR",
+ str(Path(__file__).resolve().parents[3]),
)
+) / "bot"
+
+
+def _read_example(file_name: str) -> str:
+ try:
+ return (_BOT_DIR / file_name).read_text()
+ except OSError:
+ return ""
+
+
+_BOT_PY_EXAMPLE = _read_example("bot.py")
+_DOCKERFILE_EXAMPLE = _read_example("Dockerfile")
+
+
+class KeyPairPM(BaseModel):
+ private_key: str = Field(..., min_length=32, title="Private Key")
+ public_key: Union[str, None] = Field(default=None, title="Public Key")
+ nonce: Union[
+ constr( # type: ignore
+ strip_whitespace=True,
+ min_length=4,
+ max_length=64,
+ pattern=ALPHANUM_REGEX,
+ ),
+ None,
+ ] = Field(default=None, title="Nonce")
class CommitFilePM(BaseModel):
- file_name: str = Field(
+ file_name: constr(strip_whitespace=True, min_length=4, max_length=64) = Field( # type: ignore
...,
- min_length=4,
- max_length=64,
title="File Name",
- description="Name of the file.",
- examples=["solution.js"],
+ description="Miner file name.",
+ examples=["bot.py", "Dockerfile"],
)
- content: str = Field(
+ content: constr(strip_whitespace=True, min_length=2) = Field( # type: ignore
...,
- min_length=2,
title="File Content",
description="Content of the file as a string.",
- examples=["console.log('Challenge accepted!');"],
+ examples=[_BOT_PY_EXAMPLE, _DOCKERFILE_EXAMPLE],
+ )
+
+ @field_validator("file_name")
+ @classmethod
+ def _check_file_name(cls, val: str) -> str:
+ if val not in {"bot.py", "Dockerfile"}:
+ raise ValueError("Only bot.py and Dockerfile are allowed")
+ return val
+
+
+class MinerInput(BaseModel):
+ random_val: Optional[
+ constr( # type: ignore
+ strip_whitespace=True,
+ min_length=4,
+ max_length=64,
+ pattern=ALPHANUM_REGEX,
+ )
+ ] = Field(
+ default_factory=utils.gen_random_string,
+ title="Random Value",
+ description="Random value to prevent caching.",
+ examples=["a1b2c3d4e5f6g7h8"],
)
class MinerOutput(BaseModel):
commit_files: list[CommitFilePM] = Field(
...,
+ min_length=2,
+ max_length=2,
title="Commit Files",
- description="List of Commit files for the challenge.",
+ description="Exactly bot.py and Dockerfile.",
)
+ model_config = {
+ "json_schema_extra": {
+ "examples": [
+ {
+ "commit_files": [
+ {"file_name": "bot.py", "content": _BOT_PY_EXAMPLE},
+ {
+ "file_name": "Dockerfile",
+ "content": _DOCKERFILE_EXAMPLE,
+ },
+ ]
+ }
+ ]
+ }
+ }
@field_validator("commit_files", mode="after")
@classmethod
def _check_commit_files(cls, val: list[CommitFilePM]) -> list[CommitFilePM]:
- for _miner_file_pm in val:
- _content_lines = _miner_file_pm.content.splitlines()
- if len(_content_lines) > 500:
+ names = [item.file_name for item in val]
+ if set(names) != {"bot.py", "Dockerfile"}:
+ raise ValueError("commit_files must contain bot.py and Dockerfile")
+ for item in val:
+ max_lines = 2000 if item.file_name == "bot.py" else 500
+ if len(item.content.splitlines()) > max_lines:
raise ValueError(
- f"`{_miner_file_pm.file_name}` file contains too many lines, should be <= 500 lines!"
+ f"{item.file_name} content is too long, max {max_lines} lines are allowed"
)
-
return val
+ def get_file(self, file_name: str) -> str:
+ return next(item.content for item in self.commit_files if item.file_name == file_name)
+
+
+class ErrorData(BaseModel):
+ data: str = Field(
+ ...,
+ min_length=2,
+ max_length=MAX_EVAL_PAYLOAD_LENGTH,
+ pattern=ALPHANUM_CUSTOM_REGEX,
+ title="Bot Data",
+ description="Bot data to evaluate.",
+ examples=["data"],
+ )
+
+
+class EvalPayload(BaseModel):
+ error: ErrorData
+
+
+class RandomValRequest(BaseModel):
+ random_val: str = Field(
+ ...,
+ min_length=4,
+ max_length=64,
+ pattern=ALPHANUM_REGEX,
+ title="Random value",
+ description="Random value.",
+ examples=["a1b2c3d4e5f6g7h8"],
+ )
+
__all__ = [
- "MinerInput",
+ "KeyPairPM",
"CommitFilePM",
+ "MinerInput",
"MinerOutput",
+ "EvalPayload",
+ "RandomValRequest",
]
diff --git a/src/bv_challenge/challenge/api/endpoints/challenge/scoring.py b/src/bv_challenge/challenge/api/endpoints/challenge/scoring.py
new file mode 100644
index 0000000..528e204
--- /dev/null
+++ b/src/bv_challenge/challenge/api/endpoints/challenge/scoring.py
@@ -0,0 +1,137 @@
+# -*- coding: utf-8 -*-
+
+"""Public scoring boundary.
+
+The detection logic itself lives in the compiled, private ``rt_bv_score``
+wheel (shipped as a binary ``.so`` like ``vault_unlock``) so the algorithm is
+not readable in this public repo. This module only provides a safe wrapper:
+it calls the detector, validates its result, and falls back to a neutral score
+on any failure.
+"""
+
+import logging
+import math
+from collections.abc import Callable
+from typing import Any
+
+logger = logging.getLogger(__name__)
+
+METRICS_PROCESSOR_ERROR_SCORE = 0.5
+
+try:
+ from rt_bv_score import MetricsProcessor as _default_metrics_processor
+except ImportError: # private detector wheel not installed (local dev / CI)
+ _default_metrics_processor = None
+ logger.warning(
+ "rt_bv_score is not installed; scoring falls back to the error score "
+ "unless a metrics processor is injected."
+ )
+
+
+# --- Public structural shape validation -------------------------------------
+# This is deliberately *basic and non-secret*: it only checks that the decrypted
+# payload has the expected containers and that the (additive) advanced-signal
+# fields, when present, are the right type. It contains NO thresholds, weights,
+# or anti-bot heuristics — all of that lives in the private detector. Keeping a
+# cheap public shape validation here lets us reject obviously malformed /
+# tampered payloads before they ever reach the private wheel.
+
+# Legacy raw series that every well-formed payload must carry as lists.
+_REQUIRED_LIST_FIELDS = (
+ "movements",
+ "clicks",
+ "mouseDowns",
+ "mouseUps",
+ "keydowns",
+ "keyups",
+ "scroll",
+)
+# Advanced raw signals: validated only for *shape* when present (forward/backward
+# compatible — older payloads without them still pass this public validation).
+_OPTIONAL_LIST_FIELDS = ("eventSequence", "targets")
+_OPTIONAL_DICT_FIELDS = ("pageTimings", "trustedEventStats", "taskProgress")
+
+
+def validate_shape(data: Any) -> tuple[bool, str | None]:
+ """Public Layer 1 shape check. Returns (ok, reason).
+
+ Structural only: confirms the payload is a dict, the legacy raw series are
+ lists, and the advanced-signal fields (browserInfo / pageTimings /
+ eventSequence / targets / trustedEventStats / taskProgress) are correctly
+ typed when present. No behavioral judgement is made here.
+ """
+ if not isinstance(data, dict):
+ return False, "payload is not an object"
+
+ for _field in _REQUIRED_LIST_FIELDS:
+ if _field not in data:
+ return False, f"missing required field: {_field}"
+ if not isinstance(data[_field], list):
+ return False, f"field is not a list: {_field}"
+
+ for _field in _OPTIONAL_LIST_FIELDS:
+ if _field in data and not isinstance(data[_field], list):
+ return False, f"field is not a list: {_field}"
+
+ for _field in _OPTIONAL_DICT_FIELDS:
+ if _field in data and not isinstance(data[_field], dict):
+ return False, f"field is not an object: {_field}"
+
+ # browserInfo is an object when present, but may legitimately be null when the
+ # environment snapshot was unavailable in the browser.
+ if "browserInfo" in data and data["browserInfo"] is not None:
+ if not isinstance(data["browserInfo"], dict):
+ return False, "field is not an object: browserInfo"
+
+ return True, None
+
+
+def score_with_metrics_processor(
+ data: dict,
+ metrics_processor: Callable[[dict], dict] | None = None,
+ error_score: float = METRICS_PROCESSOR_ERROR_SCORE,
+) -> float:
+ """Run the detector on a decrypted payload and return a clamped 0..1 score."""
+ processor = metrics_processor or _default_metrics_processor
+ if processor is None:
+ logger.error("No MetricsProcessor available; returning error score.")
+ return error_score
+
+ try:
+ result = processor(data)
+ except Exception as err:
+ logger.exception("MetricsProcessor failed: %s", err)
+ return error_score
+
+ if not isinstance(result, dict):
+ logger.warning("MetricsProcessor returned non-dict result: %r", result)
+ return error_score
+
+ score = _coerce_score(result.get("score"))
+ if score is None:
+ logger.warning("MetricsProcessor returned invalid score: %r", result.get("score"))
+ return error_score
+
+ score_message = result.get("score_message")
+ if score_message:
+ logger.info("MetricsProcessor score_message: %s", score_message)
+
+ return min(max(score, 0.0), 1.0)
+
+
+def _coerce_score(value: Any) -> float | None:
+ if value is None or isinstance(value, bool):
+ return None
+
+ try:
+ score = float(value)
+ except (TypeError, ValueError):
+ return None
+
+ if math.isnan(score) or math.isinf(score):
+ return None
+
+ return score
+
+
+__all__ = ["validate_shape", "score_with_metrics_processor"]
diff --git a/src/bv_challenge/challenge/api/endpoints/challenge/service.py b/src/bv_challenge/challenge/api/endpoints/challenge/service.py
index 488f3bb..91e2fa6 100644
--- a/src/bv_challenge/challenge/api/endpoints/challenge/service.py
+++ b/src/bv_challenge/challenge/api/endpoints/challenge/service.py
@@ -1,8 +1,58 @@
-import random
+# -*- coding: utf-8 -*-
+import hashlib
+import pathlib
+import threading
+import uuid
+from typing import Dict, Union
+
+from fastapi import Request
+from fastapi.responses import HTMLResponse
+from fastapi.templating import Jinja2Templates
from pydantic import validate_call
-from .schemas import MinerInput, MinerOutput
+from api.config import config
+from api.core.constants import ErrorCodeEnum
+from api.core.exceptions import BaseHTTPException
+from api.endpoints.challenge import scoring
+from api.endpoints.challenge import utils as challenge_utils
+from api.endpoints.challenge.payload_manager import PayloadManager
+from api.endpoints.challenge.schemas import MinerInput, MinerOutput
+from api.logger import logger
+
+_SRC_DIR = pathlib.Path(__file__).parent.parent.parent.parent.resolve()
+payload_manager = PayloadManager()
+_latest_result_lock = threading.Lock()
+_latest_result: Dict[str, Union[float, str, bool, None]] = {
+ "score": None,
+ "feedback": "",
+ "phase": "not_started",
+ "simple_bot_passed": None,
+}
+SCHEMA_VERSION = "bv-runtime-1"
+
+
+def _set_latest_result(
+ *,
+ score: float,
+ feedback: str,
+ phase: str,
+ simple_bot_passed: bool | None,
+) -> None:
+ with _latest_result_lock:
+ _latest_result.update(
+ {
+ "score": score,
+ "feedback": feedback,
+ "phase": phase,
+ "simple_bot_passed": simple_bot_passed,
+ }
+ )
+
+
+def get_result() -> Dict[str, Union[float, str, bool, None]]:
+ with _latest_result_lock:
+ return dict(_latest_result)
def get_task() -> MinerInput:
@@ -10,13 +60,167 @@ def get_task() -> MinerInput:
@validate_call
-def score(request_id: str, miner_output: MinerOutput) -> float:
+def score(miner_output: MinerOutput) -> float:
+ """Build, verify, and score one miner submission."""
+ expected_sessions = config.challenge.n_run_per_ch
+ required_tasks = config.challenge.n_ch_per_epoch * expected_sessions
+ score_job_id = uuid.uuid4().hex
+ bot_py = miner_output.get_file("bot.py")
+ dockerfile = miner_output.get_file("Dockerfile")
+
+ with payload_manager.run_lock:
+ try:
+ challenge_utils.send_build_request(bot_py, dockerfile, score_job_id)
+ except Exception as err:
+ logger.error(f"Failed to build miner container: {err}")
+ _set_latest_result(
+ score=0.0,
+ feedback="failed to build miner container",
+ phase="build",
+ simple_bot_passed=None,
+ )
+ return 0.0
+
+ try:
+ simple_result = challenge_utils.send_run_simple_bot_request(score_job_id)
+ except Exception as err:
+ logger.error(f"Simple bot detection phase failed: {err}")
+ _set_latest_result(
+ score=0.0,
+ feedback="failed in simple bot detection phase",
+ phase="simple_bot",
+ simple_bot_passed=False,
+ )
+ return 0.0
+
+ if simple_result.get("passed") is not True:
+ logger.info(f"Simple bot detection rejected miner: {simple_result}")
+ _set_latest_result(
+ score=0.0,
+ feedback="failed in simple bot detection phase",
+ phase="simple_bot",
+ simple_bot_passed=False,
+ )
+ return 0.0
+
+ if (
+ not payload_manager.has_remaining_tasks()
+ or payload_manager.remaining_task_count() < required_tasks
+ ):
+ payload_manager.reset()
+ if payload_manager.pop_task() is None:
+ raise BaseHTTPException(
+ error_enum=ErrorCodeEnum.TOO_MANY_REQUESTS,
+ message="No initialized key pairs, or out of tasks!",
+ )
+
+ runner_failed = challenge_utils.run_web_phase(
+ payload_manager,
+ session_count=expected_sessions,
+ score_job_id=score_job_id,
+ )
+ final_score = payload_manager.finalize(
+ timeout_score=config.challenge.session_timeout_score
+ )
+ logger.info(f"[run {payload_manager.run_id}] Final score: {final_score}")
+ _set_latest_result(
+ score=float(final_score),
+ feedback=(
+ "failed in web scoring phase"
+ if runner_failed
+ else "web scoring completed"
+ ),
+ phase="web",
+ simple_bot_passed=True,
+ )
+ return float(final_score)
+
+
+def _short_digest(*parts: str) -> str:
+ hasher = hashlib.sha256()
+ for part in parts:
+ hasher.update((part or "").encode("utf-8"))
+ hasher.update(b"\x00")
+ return hasher.hexdigest()[:16]
+
+
+@validate_call(config={"arbitrary_types_allowed": True})
+def get_web(request: Request) -> HTMLResponse:
+ nonce, public_key, active = payload_manager.claim_web_key()
+ if not active:
+ logger.warning(
+ "/_web called with no active session key; serving a throwaway key"
+ )
+ templates = Jinja2Templates(directory=_SRC_DIR / "./templates/html")
+ return templates.TemplateResponse(
+ request=request,
+ name="index.html",
+ context={
+ "session_id": nonce,
+ "nonce": nonce,
+ "public_key": public_key,
+ "public_key_id": _short_digest(public_key),
+ "config_hash": _short_digest(
+ SCHEMA_VERSION,
+ str(config.api.security.asymmetric.key_size),
+ ),
+ "schema_version": SCHEMA_VERSION,
+ },
+ )
+
+
+@validate_call
+def get_random_val(nonce: str) -> str:
+ with payload_manager.claim_lock:
+ current = payload_manager.cur_key_pair
+ if not current:
+ raise BaseHTTPException(
+ error_enum=ErrorCodeEnum.BAD_REQUEST,
+ message="No initialized key pair or out of keys.",
+ )
+ if current.nonce != nonce:
+ raise BaseHTTPException(
+ error_enum=ErrorCodeEnum.UNAUTHORIZED,
+ message="Invalid nonce value!",
+ )
+ if not current.public_key:
+ raise BaseHTTPException(
+ error_enum=ErrorCodeEnum.TOO_MANY_REQUESTS,
+ message="Nonce is already retrieved!",
+ )
+ public_key = payload_manager.get_nonce()
+ payload_manager.pop_task()
+ return public_key
+
+
+def _score_payload(plain_data: dict) -> float:
+ try:
+ shape_ok, shape_reason = scoring.validate_shape(plain_data)
+ if not shape_ok:
+ logger.info(f"Layer 1 shape check rejected session: {shape_reason}")
+ return config.challenge.gate_fail_score
+ return scoring.score_with_metrics_processor(
+ data=plain_data,
+ error_score=config.challenge.metrics_processor_error_score,
+ )
+ except Exception as err:
+ logger.error(f"Unexpected scoring error; recording error score: {err}")
+ return config.challenge.metrics_processor_error_score
- _score_result = random.random() # nosec B311
- return _score_result
+
+@validate_call
+def eval_bot(data: str) -> None:
+ outcome = payload_manager.process_eval(
+ data,
+ decrypt_fn=challenge_utils.decrypt,
+ score_fn=_score_payload,
+ )
+ if outcome.status == "recorded":
+ logger.info(f"Recorded session {outcome.session_id} score: {outcome.score}")
+ elif outcome.status == "duplicate":
+ logger.warning(f"Duplicate /_eval for session {outcome.session_id}")
+ else:
+ logger.warning("Unattributable /_eval payload; ignoring")
-__all__ = [
- "get_task",
- "score",
-]
+__all__ = ["get_task", "get_web", "get_random_val", "score", "get_result", "eval_bot"]
diff --git a/src/bv_challenge/challenge/api/endpoints/challenge/utils.py b/src/bv_challenge/challenge/api/endpoints/challenge/utils.py
new file mode 100644
index 0000000..551a0b2
--- /dev/null
+++ b/src/bv_challenge/challenge/api/endpoints/challenge/utils.py
@@ -0,0 +1,126 @@
+# -*- coding: utf-8 -*-
+
+import time
+from typing import TYPE_CHECKING, Any, Dict, List, Tuple
+
+import requests
+import vault_unlock
+from pydantic import validate_call
+
+from api.config import config
+from api.core import utils
+from api.endpoints.challenge.schemas import KeyPairPM
+from api.helpers.crypto import asymmetric as asymmetric_helper
+from api.logger import logger
+
+if TYPE_CHECKING:
+ from api.endpoints.challenge.payload_manager import PayloadManager
+
+
+@validate_call
+def gen_key_pairs() -> List[KeyPairPM]:
+ pairs: List[KeyPairPM] = []
+ for _ in range(config.challenge.n_run_per_ch):
+ private_key, public_key = asymmetric_helper.gen_key_pair(
+ key_size=config.api.security.asymmetric.key_size,
+ as_str=True,
+ )
+ pairs.append(
+ KeyPairPM(
+ private_key=private_key,
+ public_key=public_key,
+ nonce=utils.gen_random_string(length=32),
+ )
+ )
+ return pairs
+
+
+def decrypt(ciphertext: str, private_key: str) -> str:
+ return vault_unlock.decrypt_payload(
+ encrypted_text=ciphertext,
+ private_key_pem=private_key,
+ )
+
+
+def _post_vm_request(path: str, payload: Dict[str, Any]) -> Dict[str, Any]:
+ vm_endpoint = config.challenge.vm_endpoint.rstrip("/")
+ timeout = config.challenge.vm_timeout
+ logger.info(f"Sending VM request to {vm_endpoint}{path}")
+ try:
+ response = requests.post(
+ f"{vm_endpoint}{path}",
+ json=payload,
+ timeout=timeout,
+ verify=config.challenge.vm_ssl_verify,
+ )
+ if response.status_code != 200:
+ raise ValueError(
+ f"VM request failed with status {response.status_code}: {response.text}"
+ )
+ logger.success("Successfully received response from VM")
+ return response.json()
+ except requests.Timeout:
+ logger.error(f"VM request timed out after {timeout} seconds")
+ raise
+ except requests.RequestException as err:
+ logger.error(f"VM request failed: {err}")
+ raise
+
+
+def send_build_request(bot_py: str, dockerfile: str, score_job_id: str) -> Dict[str, Any]:
+ return _post_vm_request(
+ "/build",
+ {
+ "bot_py": bot_py,
+ "dockerfile": dockerfile,
+ "score_job_id": score_job_id,
+ },
+ )
+
+
+def send_run_simple_bot_request(score_job_id: str) -> Dict[str, Any]:
+ return _post_vm_request(
+ "/run-simple-bot",
+ {
+ "score_job_id": score_job_id,
+ "timeout_sec": config.challenge.vm_timeout,
+ },
+ )
+
+
+def send_run_web_request(session_count: int, score_job_id: str) -> Dict[str, Any]:
+ return _post_vm_request(
+ "/run-web",
+ {
+ "session_count": session_count,
+ "score_job_id": score_job_id,
+ },
+ )
+
+
+def run_web_phase(manager: "PayloadManager", session_count: int, score_job_id: str) -> bool:
+ """Run the web phase and return whether the runner failed."""
+ try:
+ logger.info(f"Starting {session_count} bot session(s) via runner")
+ send_run_web_request(session_count=session_count, score_job_id=score_job_id)
+ except Exception as err:
+ logger.error(f"Runner failed: {err}; returning runner_fail_score")
+ return True
+
+ deadline = time.time() + config.challenge.bot_timeout
+ while manager.completed_count() < session_count and time.time() < deadline:
+ logger.info(
+ f"Waiting... {manager.completed_count()}/{session_count} sessions recorded"
+ )
+ time.sleep(1)
+ return False
+
+
+__all__ = [
+ "gen_key_pairs",
+ "decrypt",
+ "send_build_request",
+ "send_run_simple_bot_request",
+ "send_run_web_request",
+ "run_web_phase",
+]
diff --git a/src/bv_challenge/challenge/api/exception.py b/src/bv_challenge/challenge/api/exception.py
index 0089a51..e462e88 100644
--- a/src/bv_challenge/challenge/api/exception.py
+++ b/src/bv_challenge/challenge/api/exception.py
@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+
from pydantic import validate_call
from fastapi import FastAPI, HTTPException
from fastapi.exceptions import RequestValidationError
@@ -24,7 +26,7 @@ def add_exception_handlers(app: FastAPI) -> None:
app.add_exception_handler(500, server_error_handler)
app.add_exception_handler(HTTPException, http_exception_handler)
app.add_exception_handler(RequestValidationError, validation_error_handler)
- # Add more exception handlers here...
+ ## Add more exception handlers here...
return
diff --git a/src/bv_challenge/challenge/api/helpers/__init__.py b/src/bv_challenge/challenge/api/helpers/__init__.py
index e69de29..40a96af 100644
--- a/src/bv_challenge/challenge/api/helpers/__init__.py
+++ b/src/bv_challenge/challenge/api/helpers/__init__.py
@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-
diff --git a/src/bv_challenge/challenge/api/helpers/crypto/__init__.py b/src/bv_challenge/challenge/api/helpers/crypto/__init__.py
new file mode 100644
index 0000000..40a96af
--- /dev/null
+++ b/src/bv_challenge/challenge/api/helpers/crypto/__init__.py
@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-
diff --git a/src/bv_challenge/challenge/api/helpers/crypto/asymmetric.py b/src/bv_challenge/challenge/api/helpers/crypto/asymmetric.py
new file mode 100644
index 0000000..6c4b95a
--- /dev/null
+++ b/src/bv_challenge/challenge/api/helpers/crypto/asymmetric.py
@@ -0,0 +1,626 @@
+# -*- coding: utf-8 -*-
+
+import os
+import errno
+import base64
+from typing import Tuple, Union
+
+import aiofiles
+from cryptography.hazmat.primitives.asymmetric import rsa, padding
+from cryptography.hazmat.primitives import serialization, hashes
+from cryptography.hazmat.primitives.asymmetric.types import (
+ PrivateKeyTypes,
+ PublicKeyTypes,
+)
+from pydantic import validate_call
+from beans_logging import logger
+
+from api.core.constants import WarnEnum
+from api.core import utils
+
+
+@validate_call
+def gen_key_pair(
+ key_size: int,
+ as_str: bool = False,
+) -> Tuple[Union[PrivateKeyTypes, str], Union[PublicKeyTypes, str]]:
+
+ _private_key: PrivateKeyTypes = rsa.generate_private_key(
+ public_exponent=65537, key_size=key_size
+ )
+ _public_key: PublicKeyTypes = _private_key.public_key()
+
+ if as_str:
+ _private_key: bytes = _private_key.private_bytes(
+ encoding=serialization.Encoding.PEM,
+ format=serialization.PrivateFormat.PKCS8,
+ encryption_algorithm=serialization.NoEncryption(),
+ ).decode()
+
+ _public_key: bytes = _public_key.public_bytes(
+ encoding=serialization.Encoding.PEM,
+ format=serialization.PublicFormat.SubjectPublicKeyInfo,
+ ).decode()
+
+ return _private_key, _public_key
+
+
+@validate_call
+async def async_create_keys(
+ asymmetric_keys_dir: str,
+ key_size: int,
+ private_key_fname: str,
+ public_key_fname: str,
+ force: bool = False,
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> None:
+ """Async generate and create asymmetric key files.
+
+ Args:
+ asymmetric_keys_dir (str , required): Asymmetric keys directory.
+ key_size (int , required): Asymmetric key size.
+ private_key_fname (str , required): Asymmetric private key filename.
+ public_key_fname (str , required): Asymmetric public key filename.
+ force (bool , optional): Force to create asymmetric keys. Defaults to False.
+ warn_mode (WarnEnum, optional): Warning mode. Defaults to WarnEnum.DEBUG.
+
+ Raises:
+ FileExistsError: If warning mode is ERROR and asymmetric keys already exist.
+ OSError : If failed to create asymmetric keys.
+ """
+
+ _private_key_path = os.path.join(asymmetric_keys_dir, private_key_fname)
+ _public_key_path = os.path.join(asymmetric_keys_dir, public_key_fname)
+
+ if force:
+ await utils.async_remove_file(file_path=_private_key_path, warn_mode=warn_mode)
+ await utils.async_remove_file(file_path=_public_key_path, warn_mode=warn_mode)
+
+ if (await aiofiles.os.path.isfile(_private_key_path)) and (
+ await aiofiles.os.path.isfile(_public_key_path)
+ ):
+ logger.trace(
+ f"Asymmetric keys already exist: ['{_private_key_path}', '{_public_key_path}']"
+ )
+ return
+
+ _message = (
+ f"Generating asymmetric keys: ['{_private_key_path}', '{_public_key_path}']..."
+ )
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.info(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ _private_key: PrivateKeyTypes
+ if await aiofiles.os.path.isfile(_private_key_path):
+ if warn_mode == WarnEnum.ERROR:
+ raise FileExistsError(f"'{_private_key_path}' private key already exists!")
+
+ _private_key: PrivateKeyTypes = await async_get_private_key(
+ private_key_path=_private_key_path
+ )
+ else:
+ _private_key: PrivateKeyTypes = rsa.generate_private_key(
+ public_exponent=65537, key_size=key_size
+ )
+
+ if await aiofiles.os.path.isfile(_public_key_path):
+ if warn_mode == WarnEnum.ERROR:
+ raise FileExistsError(f"'{_public_key_path}' public key already exists!")
+
+ await utils.async_remove_file(file_path=_public_key_path, warn_mode=warn_mode)
+
+ _public_key = _private_key.public_key()
+
+ _private_pem = _private_key.private_bytes(
+ encoding=serialization.Encoding.PEM,
+ format=serialization.PrivateFormat.PKCS8,
+ encryption_algorithm=serialization.NoEncryption(),
+ )
+
+ _public_pem = _public_key.public_bytes(
+ encoding=serialization.Encoding.PEM,
+ format=serialization.PublicFormat.SubjectPublicKeyInfo,
+ )
+
+ await utils.async_create_dir(create_dir=asymmetric_keys_dir, warn_mode=warn_mode)
+
+ if not await aiofiles.os.path.isfile(_private_key_path):
+ try:
+ async with aiofiles.open(_private_key_path, "wb") as _private_key_file:
+ await _private_key_file.write(_private_pem)
+
+ except OSError as err:
+ if (err.errno == errno.EEXIST) and (warn_mode == WarnEnum.DEBUG):
+ logger.debug(f"'{_private_key_path}' private key already exists!")
+ else:
+ logger.error(f"Failed to create '{_private_key_path}' private key!")
+ raise
+
+ if not await aiofiles.os.path.isfile(_public_key_path):
+ try:
+ async with aiofiles.open(_public_key_path, "wb") as _public_key_file:
+ await _public_key_file.write(_public_pem)
+
+ except OSError as err:
+ if (err.errno == errno.EEXIST) and (warn_mode == WarnEnum.DEBUG):
+ logger.debug(f"'{_public_key_path}' public key already exists!")
+ else:
+ logger.error(f"Failed to create '{_public_key_path}' public key!")
+ raise
+
+ _message = f"Successfully generated asymmetric keys: ['{_private_key_path}', '{_public_key_path}']"
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.success(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ return
+
+
+@validate_call
+async def async_get_private_key(
+ private_key_path: str, as_str: bool = False
+) -> Union[PrivateKeyTypes, str]:
+ """Async read asymmetric private key from file.
+
+ Args:
+ private_key_path (str , required): Asymmetric private key path.
+ as_str (bool, optional): Return private key as string. Defaults to False.
+
+ Raises:
+ FileNotFoundError: If Asymmetric private key file not found.
+
+ Returns:
+ Union[PrivateKeyTypes, str]: Asymmetric private key.
+ """
+
+ if not await aiofiles.os.path.isfile(private_key_path):
+ raise FileNotFoundError(f"Not found '{private_key_path}' private key!")
+
+ logger.debug(f"Reading '{private_key_path}' private key...")
+ _private_key: PrivateKeyTypes
+ async with aiofiles.open(private_key_path, "rb") as _private_key_file:
+ _private_key_bytes: bytes = await _private_key_file.read()
+ _private_key: PrivateKeyTypes = serialization.load_pem_private_key(
+ data=_private_key_bytes, password=None
+ )
+
+ if as_str:
+ _private_key = _private_key.private_bytes(
+ encoding=serialization.Encoding.PEM,
+ format=serialization.PrivateFormat.PKCS8,
+ encryption_algorithm=serialization.NoEncryption(),
+ ).decode()
+
+ logger.debug(f"Successfully read '{private_key_path}' private key.")
+
+ return _private_key
+
+
+@validate_call
+async def async_get_public_key(
+ public_key_path: str, as_str: bool = False
+) -> Union[PublicKeyTypes, str]:
+ """Async read asymmetric public key from file.
+
+ Args:
+ public_key_path (str , required): Asymmetric public key path.
+ as_str (bool, optional): Return public key as string. Defaults to False.
+
+ Raises:
+ FileNotFoundError: If asymmetric public key file not found.
+
+ Returns:
+ Union[PublicKeyTypes, str]: Asymmetric public key.
+ """
+
+ if not await aiofiles.os.path.isfile(public_key_path):
+ raise FileNotFoundError(f"Not found '{public_key_path}' public key!")
+
+ logger.debug(f"Reading '{public_key_path}' public key...")
+ _public_key: PublicKeyTypes
+ async with aiofiles.open(public_key_path, "rb") as _public_key_file:
+ _public_key_bytes: bytes = await _public_key_file.read()
+ _public_key: PublicKeyTypes = serialization.load_pem_public_key(
+ data=_public_key_bytes
+ )
+
+ if as_str:
+ _public_key = _public_key.public_bytes(
+ encoding=serialization.Encoding.PEM,
+ format=serialization.PublicFormat.SubjectPublicKeyInfo,
+ ).decode()
+
+ logger.debug(f"Successfully read '{public_key_path}' public key.")
+
+ return _public_key
+
+
+@validate_call
+async def async_get_keys(
+ private_key_path: str, public_key_path: str, as_str: bool = False
+) -> Tuple[Union[PrivateKeyTypes, str], Union[PublicKeyTypes, str]]:
+ """Async read asymmetric keys from file.
+
+ Args:
+ private_key_path (str , required): Asymmetric private key path.
+ public_key_path (str , required): Asymmetric public key path.
+ as_str (bool, optional): Return keys as strings. Defaults to False.
+
+ Returns:
+ Tuple[Union[PrivateKeyTypes, str], Union[PublicKeyTypes, str]]: Private and public keys.
+ """
+
+ _private_key = await async_get_private_key(
+ private_key_path=private_key_path, as_str=as_str
+ )
+ _public_key = await async_get_public_key(
+ public_key_path=public_key_path, as_str=as_str
+ )
+
+ return _private_key, _public_key
+
+
+@validate_call
+def create_keys(
+ asymmetric_keys_dir: str,
+ key_size: int,
+ private_key_fname: str,
+ public_key_fname: str,
+ force: bool = False,
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> None:
+ """Generate and create asymmetric key files.
+
+ Args:
+ asymmetric_keys_dir (str , required): Asymmetric keys directory.
+ key_size (int , required): Asymmetric key size.
+ private_key_fname (str , required): Asymmetric private key filename.
+ public_key_fname (str , required): Asymmetric public key filename.
+ force (bool , optional): Force to create asymmetric keys. Defaults to False.
+ warn_mode (WarnEnum, optional): Warning mode. Defaults to WarnEnum.DEBUG.
+
+ Raises:
+ FileExistsError: If warning mode is ERROR and asymmetric keys already exist.
+ OSError : If failed to create asymmetric keys.
+ """
+
+ _private_key_path = os.path.join(asymmetric_keys_dir, private_key_fname)
+ _public_key_path = os.path.join(asymmetric_keys_dir, public_key_fname)
+
+ if force:
+ utils.remove_file(file_path=_private_key_path, warn_mode=warn_mode)
+ utils.remove_file(file_path=_public_key_path, warn_mode=warn_mode)
+
+ if os.path.isfile(_private_key_path) and os.path.isfile(_public_key_path):
+ logger.trace(
+ f"Asymmetric keys already exist: ['{_private_key_path}', '{_public_key_path}']"
+ )
+ return
+
+ _message = (
+ f"Generating asymmetric keys: ['{_private_key_path}', '{_public_key_path}']..."
+ )
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.info(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ _private_key: PrivateKeyTypes
+ if os.path.isfile(_private_key_path):
+ if warn_mode == WarnEnum.ERROR:
+ raise FileExistsError(f"'{_private_key_path}' private key already exists!")
+
+ _private_key: PrivateKeyTypes = get_private_key(
+ private_key_path=_private_key_path
+ )
+ else:
+ _private_key = rsa.generate_private_key(
+ public_exponent=65537, key_size=key_size
+ )
+
+ if os.path.isfile(_public_key_path):
+ if warn_mode == WarnEnum.ERROR:
+ raise FileExistsError(f"'{_public_key_path}' public key already exists!")
+
+ utils.remove_file(file_path=_public_key_path, warn_mode=warn_mode)
+
+ _public_key = _private_key.public_key()
+
+ _private_pem = _private_key.private_bytes(
+ encoding=serialization.Encoding.PEM,
+ format=serialization.PrivateFormat.PKCS8,
+ encryption_algorithm=serialization.NoEncryption(),
+ )
+
+ _public_pem = _public_key.public_bytes(
+ encoding=serialization.Encoding.PEM,
+ format=serialization.PublicFormat.SubjectPublicKeyInfo,
+ )
+
+ utils.create_dir(create_dir=asymmetric_keys_dir, warn_mode=warn_mode)
+
+ if not os.path.isfile(_private_key_path):
+ try:
+ with open(_private_key_path, "wb") as _private_key_file:
+ _private_key_file.write(_private_pem)
+
+ except OSError as err:
+ if (err.errno == errno.EEXIST) and (warn_mode == WarnEnum.DEBUG):
+ logger.debug(f"'{_private_key_path}' private key already exists!")
+ else:
+ logger.error(f"Failed to create '{_private_key_path}' private key!")
+ raise
+
+ if not os.path.isfile(_public_key_path):
+ try:
+ with open(_public_key_path, "wb") as _public_key_file:
+ _public_key_file.write(_public_pem)
+
+ except OSError as err:
+ if (err.errno == errno.EEXIST) and (warn_mode == WarnEnum.DEBUG):
+ logger.debug(f"'{_public_key_path}' public key already exists!")
+ else:
+ logger.error(f"Failed to create '{_public_key_path}' public key!")
+ raise
+
+ _message = f"Successfully generated asymmetric keys: ['{_private_key_path}', '{_public_key_path}']"
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.success(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ return
+
+
+@validate_call
+def get_private_key(
+ private_key_path: str, as_str: bool = False
+) -> Union[PrivateKeyTypes, str]:
+ """Read asymmetric private key from file.
+
+ Args:
+ private_key_path (str , required): Asymmetric private key path.
+ as_str (bool, optional): Return private key as string. Defaults to False.
+
+ Raises:
+ FileNotFoundError: If asymmetric private key file not found.
+
+ Returns:
+ Union[PrivateKeyTypes, str]: Asymmetric private key as PrivateKeyTypes or str.
+ """
+
+ if not os.path.isfile(private_key_path):
+ raise FileNotFoundError(f"Not found '{private_key_path}' private key!")
+
+ logger.debug(f"Reading '{private_key_path}' private key...")
+ _private_key: PrivateKeyTypes
+ with open(private_key_path, "rb") as _private_key_file:
+ _private_key_bytes: bytes = _private_key_file.read()
+ _private_key: PrivateKeyTypes = serialization.load_pem_private_key(
+ data=_private_key_bytes, password=None
+ )
+
+ if as_str:
+ _private_key = _private_key.private_bytes(
+ encoding=serialization.Encoding.PEM,
+ format=serialization.PrivateFormat.PKCS8,
+ encryption_algorithm=serialization.NoEncryption(),
+ ).decode()
+
+ logger.debug(f"Successfully read '{private_key_path}' private key.")
+
+ return _private_key
+
+
+@validate_call
+def get_public_key(
+ public_key_path: str, as_str: bool = False
+) -> Union[PublicKeyTypes, str]:
+ """Read asymmetric public key from file.
+
+ Args:
+ public_key_path (str , required): Asymmetric public key path.
+ as_str (bool, optional): Return public key as string. Defaults to False.
+
+ Raises:
+ FileNotFoundError: If asymmetric public key file not found.
+
+ Returns:
+ Union[PublicKeyTypes, str]: Asymmetric public key as PublicKeyTypes or str.
+ """
+
+ if not os.path.isfile(public_key_path):
+ raise FileNotFoundError(f"Not found '{public_key_path}' public key!")
+
+ logger.debug(f"Reading '{public_key_path}' public key...")
+ _public_key: PublicKeyTypes
+ with open(public_key_path, "rb") as _public_key_file:
+ _public_key_bytes: bytes = _public_key_file.read()
+ _public_key: PublicKeyTypes = serialization.load_pem_public_key(
+ data=_public_key_bytes
+ )
+
+ if as_str:
+ _public_key = _public_key.public_bytes(
+ encoding=serialization.Encoding.PEM,
+ format=serialization.PublicFormat.SubjectPublicKeyInfo,
+ ).decode()
+
+ logger.debug(f"Successfully read '{public_key_path}' public key.")
+
+ return _public_key
+
+
+@validate_call
+def get_keys(
+ private_key_path: str, public_key_path: str, as_str: bool = False
+) -> Tuple[Union[PrivateKeyTypes, str], Union[PublicKeyTypes, str]]:
+ """Read asymmetric keys from file.
+
+ Args:
+ private_key_path (str , required): Asymmetric private key path.
+ public_key_path (str , required): Asymmetric public key path.
+ as_str (bool, optional): Return keys as strings. Defaults to False.
+
+ Returns:
+ Tuple[Union[PrivateKeyTypes, str], Union[PublicKeyTypes, str]]: Private and public keys.
+ """
+
+ _private_key = get_private_key(private_key_path=private_key_path, as_str=as_str)
+ _public_key = get_public_key(public_key_path=public_key_path, as_str=as_str)
+
+ return _private_key, _public_key
+
+
+@validate_call(config={"arbitrary_types_allowed": True})
+def encrypt_with_public_key(
+ plaintext: Union[str, bytes],
+ public_key: PublicKeyTypes,
+ base64_encode: bool = False,
+ as_str: bool = False,
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> Union[str, bytes]:
+ """Encrypt plaintext with public key.
+
+ Args:
+ plaintext (Union[str, bytes], required): Plaintext to encrypt.
+ public_key (PublicKeyTypes , required): Public key.
+ base64_encode (bool , optional): Encode ciphertext with base64. Defaults to False.
+ as_str (bool , optional): Return ciphertext as string or bytes. Defaults to False.
+ warn_mode (WarnEnum , optional): Warning mode. Defaults to WarnEnum.DEBUG.
+
+ Raises:
+ Exception: If failed to encrypt plaintext with asymmetric public key.
+
+ Returns:
+ Union[str, bytes]: Encrypted ciphertext as string or bytes.
+ """
+
+ if isinstance(plaintext, str):
+ plaintext = plaintext.encode()
+
+ _ciphertext: Union[str, bytes]
+ try:
+ _message = "Encrypting plaintext with asymmetric public key..."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.info(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ _ciphertext: bytes = public_key.encrypt(
+ plaintext=plaintext,
+ padding=padding.OAEP(
+ mgf=padding.MGF1(algorithm=hashes.SHA256()),
+ algorithm=hashes.SHA256(),
+ label=None,
+ ),
+ )
+
+ _message = "Successfully encrypted plaintext with asymmetric public key."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.success(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ except Exception:
+ _message = "Failed to encrypt plaintext with asymmetric public key!"
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.error(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ raise
+
+ if base64_encode:
+ _ciphertext = base64.b64encode(_ciphertext)
+
+ if as_str:
+ _ciphertext = _ciphertext.decode()
+
+ return _ciphertext
+
+
+@validate_call(config={"arbitrary_types_allowed": True})
+def decrypt_with_private_key(
+ ciphertext: Union[str, bytes],
+ private_key: PrivateKeyTypes,
+ base64_decode: bool = False,
+ as_str: bool = False,
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> Union[str, bytes]:
+ """Decrypt ciphertext with private key.
+
+ Args:
+ ciphertext (Union[str, bytes], required): Ciphertext to decrypt.
+ private_key (PrivateKeyTypes , required): Private key.
+ base64_decode (bool , optional): Decode ciphertext with base64. Defaults to False.
+ as_str (bool , optional): Return plaintext as string or bytes. Defaults to False.
+ warn_mode (WarnEnum , optional): Warning mode. Defaults to WarnEnum.DEBUG.
+
+ Raises:
+ Exception: If failed to decrypt ciphertext with asymmetric private key for any reason.
+
+ Returns:
+ Union[str, bytes]: Decrypted plaintext as string or bytes.
+ """
+
+ if isinstance(ciphertext, str):
+ ciphertext = ciphertext.encode()
+
+ if base64_decode:
+ ciphertext = base64.b64decode(ciphertext)
+
+ _plaintext: Union[str, bytes]
+ try:
+ _message = "Decrypting ciphertext with asymmetric private key..."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.info(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ _plaintext: bytes = private_key.decrypt(
+ ciphertext=ciphertext,
+ padding=padding.OAEP(
+ mgf=padding.MGF1(algorithm=hashes.SHA256()),
+ algorithm=hashes.SHA256(),
+ label=None,
+ ),
+ )
+
+ _message = "Successfully decrypted ciphertext with asymmetric private key."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.success(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ except Exception:
+ _message = "Failed to decrypt ciphertext with asymmetric private key!"
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.error(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ raise
+
+ if as_str:
+ _plaintext = _plaintext.decode()
+
+ return _plaintext
+
+
+__all__ = [
+ "gen_key_pair",
+ "async_create_keys",
+ "async_get_private_key",
+ "async_get_public_key",
+ "async_get_keys",
+ "create_keys",
+ "get_private_key",
+ "get_public_key",
+ "get_keys",
+ "encrypt_with_public_key",
+ "decrypt_with_private_key",
+]
diff --git a/src/bv_challenge/challenge/api/helpers/crypto/ssl.py b/src/bv_challenge/challenge/api/helpers/crypto/ssl.py
new file mode 100644
index 0000000..c232a12
--- /dev/null
+++ b/src/bv_challenge/challenge/api/helpers/crypto/ssl.py
@@ -0,0 +1,301 @@
+# -*- coding: utf-8 -*-
+
+import os
+import errno
+from datetime import timedelta
+from typing import Union
+
+import aiofiles
+import aiofiles.os
+from pydantic import validate_call, BaseModel, Field
+from cryptography import x509
+from cryptography.x509.oid import NameOID
+from cryptography.hazmat.primitives import hashes
+from cryptography.hazmat.primitives import serialization
+from cryptography.hazmat.primitives.asymmetric import rsa
+from cryptography.hazmat.primitives.asymmetric.rsa import RSAPrivateKey
+from cryptography.hazmat.primitives.asymmetric.types import PrivateKeyTypes
+from beans_logging import logger
+
+from api.core.constants import WarnEnum
+from api.core import utils
+
+from . import asymmetric as asymmetric_helper
+
+
+class X509AttrsPM(BaseModel):
+ C: str = Field(default="US", min_length=2, max_length=2)
+ ST: str = Field(default="Washington", min_length=2, max_length=256)
+ L: str = Field(default="Seattle", min_length=2, max_length=256)
+ O: str = Field(default="Organization", min_length=2, max_length=256)
+ OU: str = Field(default="Organization Unit", min_length=2, max_length=256)
+ CN: str = Field(default="localhost", min_length=2, max_length=256)
+ DNS: str = Field(default="localhost", min_length=2, max_length=256)
+
+
+@validate_call
+async def async_create_ssl_certs(
+ ssl_dir: str,
+ cert_fname: str,
+ key_fname: str,
+ key_size: int,
+ x509_attrs: X509AttrsPM = X509AttrsPM(),
+ force: bool = False,
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> None:
+ """Async generate and create SSL key and cert files.
+
+ Args:
+ ssl_dir (str , required): SSL directory path.
+ cert_fname (str , required): Certificate file name.
+ key_fname (str , required): Key file name.
+ key_size (int , required): Key size.
+ x509_attrs (X509AttrsPM, optional): X509 named attributes. Defaults to X509AttrsPM().
+ force (bool , optional): Force to create SSL key and cert files. Defaults to False.
+ warn_mode (WarnEnum , optional): Warning mode. Defaults to WarnEnum.DEBUG.
+
+ Raises:
+ FileExistsError: When warning mode is set to ERROR and SSL key or cert files already exist.
+ OSError : If failed to create SSL key or cert files.
+ """
+
+ _key_path = os.path.join(ssl_dir, key_fname)
+ _cert_path = os.path.join(ssl_dir, cert_fname)
+
+ if force:
+ await utils.async_remove_file(file_path=_key_path, warn_mode=warn_mode)
+ await utils.async_remove_file(file_path=_cert_path, warn_mode=warn_mode)
+
+ if (await aiofiles.os.path.isfile(_key_path)) and (
+ await aiofiles.os.path.isfile(_cert_path)
+ ):
+ logger.trace(
+ f"SSL key and cert files already exist: ['{_key_path}', '{_cert_path}']"
+ )
+ return
+
+ _meesage = f"Generating SSL key and cert files: ['{_key_path}', '{_cert_path}']..."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.info(_meesage)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_meesage)
+
+ _private_key: Union[RSAPrivateKey, PrivateKeyTypes]
+ if await aiofiles.os.path.isfile(_key_path):
+ if warn_mode == WarnEnum.ERROR:
+ raise FileExistsError(f"'{_key_path}' SSL key file already exists!")
+
+ _private_key: PrivateKeyTypes = await asymmetric_helper.async_get_private_key(
+ private_key_path=_key_path
+ )
+ else:
+ _private_key: RSAPrivateKey = rsa.generate_private_key(
+ public_exponent=65537, key_size=key_size
+ )
+
+ if await aiofiles.os.path.isfile(_cert_path):
+ if warn_mode == WarnEnum.ERROR:
+ raise FileExistsError(f"'{_cert_path}' SSL cert file already exists!")
+
+ await utils.async_remove_file(file_path=_cert_path, warn_mode=warn_mode)
+
+ _subject = _issuer = x509.Name(
+ [
+ x509.NameAttribute(NameOID.COUNTRY_NAME, x509_attrs.C),
+ x509.NameAttribute(NameOID.STATE_OR_PROVINCE_NAME, x509_attrs.ST),
+ x509.NameAttribute(NameOID.LOCALITY_NAME, x509_attrs.L),
+ x509.NameAttribute(NameOID.ORGANIZATION_NAME, x509_attrs.O),
+ x509.NameAttribute(NameOID.ORGANIZATIONAL_UNIT_NAME, x509_attrs.OU),
+ x509.NameAttribute(NameOID.COMMON_NAME, x509_attrs.CN),
+ ]
+ )
+ _cert = (
+ x509.CertificateBuilder()
+ .subject_name(name=_subject)
+ .issuer_name(name=_issuer)
+ .public_key(key=_private_key.public_key())
+ .serial_number(number=x509.random_serial_number())
+ .not_valid_before(time=utils.now_utc_dt())
+ .not_valid_after(time=utils.now_utc_dt() + timedelta(days=365))
+ .add_extension(
+ extval=x509.SubjectAlternativeName([x509.DNSName(x509_attrs.DNS)]),
+ critical=False,
+ )
+ .sign(private_key=_private_key, algorithm=hashes.SHA256())
+ )
+
+ await utils.async_create_dir(create_dir=ssl_dir, warn_mode=warn_mode)
+
+ if not await aiofiles.os.path.isfile(_key_path):
+ try:
+ async with aiofiles.open(_key_path, "wb") as _key_file:
+ await _key_file.write(
+ _private_key.private_bytes(
+ encoding=serialization.Encoding.PEM,
+ format=serialization.PrivateFormat.TraditionalOpenSSL,
+ encryption_algorithm=serialization.NoEncryption(),
+ )
+ )
+
+ except OSError as err:
+ if (err.errno == errno.EEXIST) and (warn_mode == WarnEnum.DEBUG):
+ logger.debug(f"'{_key_path}' SSL key file already exists!")
+ else:
+ logger.error(f"Failed to create '{_key_path}' SSL key file!")
+ raise
+
+ if not await aiofiles.os.path.isfile(_cert_path):
+ try:
+ async with aiofiles.open(_cert_path, "wb") as _cert_file:
+ await _cert_file.write(_cert.public_bytes(serialization.Encoding.PEM))
+
+ except OSError as err:
+ if (err.errno == errno.EEXIST) and (warn_mode == WarnEnum.DEBUG):
+ logger.debug(f"'{_cert_path}' SSL cert file already exists!")
+ else:
+ logger.error(f"Failed to create '{_cert_path}' SSL cert file!")
+ raise
+
+ _message = f"Successfully generated SSL key and cert files: ['{_key_path}', '{_cert_path}']"
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.success(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ return
+
+
+@validate_call
+def create_ssl_certs(
+ ssl_dir: str,
+ key_fname: str,
+ cert_fname: str,
+ key_size: int,
+ x509_attrs: X509AttrsPM = X509AttrsPM(),
+ force: bool = False,
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> None:
+ """Generate and create SSL key and cert files.
+
+ Args:
+ ssl_dir (str , required): SSL directory path.
+ key_fname (str , required): Key file name.
+ cert_fname (str , required): Certificate file name.
+ key_size (int , required): Key size.
+ x509_attrs (X509AttrsPM, optional): X509 named attributes. Defaults to X509AttrsPM().
+ force (bool , optional): Force to create SSL key and cert files. Defaults to False.
+ warn_mode (WarnEnum , optional): Warning mode. Defaults to WarnEnum.DEBUG.
+
+ Raises:
+ FileExistsError: When warning mode is set to ERROR and SSL key or cert files already exist.
+ OSError : If failed to create SSL key or cert files.
+ """
+
+ _key_path = os.path.join(ssl_dir, key_fname)
+ _cert_path = os.path.join(ssl_dir, cert_fname)
+
+ if force:
+ utils.remove_file(file_path=_key_path, warn_mode=warn_mode)
+ utils.remove_file(file_path=_cert_path, warn_mode=warn_mode)
+
+ if os.path.isfile(_key_path) and os.path.isfile(_cert_path):
+ logger.trace(
+ f"SSL key and cert files already exist: ['{_key_path}', '{_cert_path}']"
+ )
+ return
+
+ _message = f"Generating SSL key and cert files: ['{_key_path}', '{_cert_path}']..."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.info(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ _private_key: Union[RSAPrivateKey, PrivateKeyTypes]
+ if os.path.isfile(_key_path):
+ if warn_mode == WarnEnum.ERROR:
+ raise FileExistsError(f"'{_key_path}' SSL key file already exists!")
+
+ _private_key: PrivateKeyTypes = asymmetric_helper.get_private_key(
+ private_key_path=_key_path
+ )
+ else:
+ _private_key: RSAPrivateKey = rsa.generate_private_key(
+ public_exponent=65537, key_size=key_size
+ )
+
+ if os.path.isfile(_cert_path):
+ if warn_mode == WarnEnum.ERROR:
+ raise FileExistsError(f"'{_cert_path}' SSL cert file already exists!")
+
+ utils.remove_file(file_path=_cert_path, warn_mode=warn_mode)
+
+ _subject = _issuer = x509.Name(
+ [
+ x509.NameAttribute(NameOID.COUNTRY_NAME, x509_attrs.C),
+ x509.NameAttribute(NameOID.STATE_OR_PROVINCE_NAME, x509_attrs.ST),
+ x509.NameAttribute(NameOID.LOCALITY_NAME, x509_attrs.L),
+ x509.NameAttribute(NameOID.ORGANIZATION_NAME, x509_attrs.O),
+ x509.NameAttribute(NameOID.ORGANIZATIONAL_UNIT_NAME, x509_attrs.OU),
+ x509.NameAttribute(NameOID.COMMON_NAME, x509_attrs.CN),
+ ]
+ )
+ _cert = (
+ x509.CertificateBuilder()
+ .subject_name(name=_subject)
+ .issuer_name(name=_issuer)
+ .public_key(key=_private_key.public_key())
+ .serial_number(number=x509.random_serial_number())
+ .not_valid_before(time=utils.now_utc_dt())
+ .not_valid_after(time=utils.now_utc_dt() + timedelta(days=365))
+ .add_extension(
+ extval=x509.SubjectAlternativeName([x509.DNSName(x509_attrs.DNS)]),
+ critical=False,
+ )
+ .sign(private_key=_private_key, algorithm=hashes.SHA256())
+ )
+
+ utils.create_dir(create_dir=ssl_dir, warn_mode=warn_mode)
+
+ if not os.path.isfile(_key_path):
+ try:
+ with open(_key_path, "wb") as _key_file:
+ _key_file.write(
+ _private_key.private_bytes(
+ encoding=serialization.Encoding.PEM,
+ format=serialization.PrivateFormat.TraditionalOpenSSL,
+ encryption_algorithm=serialization.NoEncryption(),
+ )
+ )
+
+ except OSError as err:
+ if (err.errno == errno.EEXIST) and (warn_mode == WarnEnum.DEBUG):
+ logger.debug(f"'{_key_path}' SSL key file already exists!")
+ else:
+ logger.error(f"Failed to create '{_key_path}' SSL key file!")
+ raise
+
+ if not os.path.isfile(_cert_path):
+ try:
+ with open(_cert_path, "wb") as _cert_file:
+ _cert_file.write(_cert.public_bytes(serialization.Encoding.PEM))
+
+ except OSError as err:
+ if (err.errno == errno.EEXIST) and (warn_mode == WarnEnum.DEBUG):
+ logger.debug(f"'{_cert_path}' SSL cert file already exists!")
+ else:
+ logger.error(f"Failed to create '{_cert_path}' SSL cert file!")
+ raise
+
+ _message = f"Successfully generated SSL key and cert files: ['{_key_path}', '{_cert_path}']"
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.success(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ return
+
+
+__all__ = [
+ "async_create_ssl_certs",
+ "create_ssl_certs",
+]
diff --git a/src/bv_challenge/challenge/api/helpers/crypto/symmetric.py b/src/bv_challenge/challenge/api/helpers/crypto/symmetric.py
new file mode 100644
index 0000000..0209f61
--- /dev/null
+++ b/src/bv_challenge/challenge/api/helpers/crypto/symmetric.py
@@ -0,0 +1,87 @@
+# -*- coding: utf-8 -*-
+
+import base64
+from typing import Union
+
+from cryptography.hazmat.primitives import ciphers
+from cryptography.hazmat.primitives.ciphers import algorithms, modes
+from cryptography.hazmat.primitives import padding
+from pydantic import validate_call
+from beans_logging import logger
+
+from api.core.constants import WarnEnum
+
+
+@validate_call(config={"arbitrary_types_allowed": True})
+def decrypt_aes_cbc(
+ ciphertext: Union[str, bytes],
+ key: bytes,
+ iv: bytes,
+ base64_decode: bool = False,
+ as_str: bool = False,
+ warn_mode: WarnEnum = WarnEnum.DEBUG,
+) -> Union[str, bytes]:
+ """Decrypts a ciphertext using AES-CBC key and iv.
+
+ Args:
+ ciphertext (Union[str, bytes], required): The ciphertext to decrypt.
+ key (bytes , required): The key to use for decryption.
+ iv (bytes , required): The initialization vector to use for decryption.
+ base64_decode (bool , optional): Whether to decode the ciphertext from base64. Defaults to False.
+ as_str (bool , optional): Whether to return the plaintext as a string or bytes. Defaults to False.
+ warn_mode (WarnEnum , optional): The warning mode to use. Defaults to WarnEnum.DEBUG.
+
+ Raises:
+ Exception: If failed to decrypt ciphertext using AES-CBC key and iv for any reason.
+
+ Returns:
+ Union[str, bytes]: The decrypted plaintext as a string or bytes.
+ """
+
+ if isinstance(ciphertext, str):
+ ciphertext = ciphertext.encode()
+
+ if base64_decode:
+ ciphertext = base64.b64decode(ciphertext)
+
+ _plaintext: Union[str, bytes]
+ try:
+ _message = "Decrypting ciphertext using AES-CBC key and iv..."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.info(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ _cipher = ciphers.Cipher(
+ algorithm=algorithms.AES(key=key), mode=modes.CBC(initialization_vector=iv)
+ )
+ _decryptor = _cipher.decryptor()
+ _padded_plaintext = _decryptor.update(data=ciphertext) + _decryptor.finalize()
+
+ _unpadder = padding.PKCS7(block_size=algorithms.AES.block_size).unpadder()
+ _plaintext = _unpadder.update(_padded_plaintext) + _unpadder.finalize()
+
+ _message = "Successfully decrypted ciphertext using AES-CBC key and iv."
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.success(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ except Exception:
+ _message = "Failed to decrypt ciphertext using AES-CBC key and iv!"
+ if warn_mode == WarnEnum.ALWAYS:
+ logger.error(_message)
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(_message)
+
+ raise
+
+ if as_str:
+ _plaintext = _plaintext.decode()
+
+ return _plaintext
+
+
+__all__ = [
+ "decrypt_aes_cbc",
+]
diff --git a/src/bv_challenge/challenge/api/lifespan.py b/src/bv_challenge/challenge/api/lifespan.py
index 5caee29..4ad25f7 100644
--- a/src/bv_challenge/challenge/api/lifespan.py
+++ b/src/bv_challenge/challenge/api/lifespan.py
@@ -1,27 +1,23 @@
+# -*- coding: utf-8 -*-
+
import os
-from collections.abc import AsyncGenerator
+from typing import AsyncGenerator
from contextlib import asynccontextmanager
from fastapi import FastAPI
-from potato_util.io import async_create_dir
-from potato_util.crypto import asymmetric as asymmetric_utils
-from potato_util.crypto import ssl as ssl_utils
-
-from api.__version__ import __version__
+from api.core import utils
from api.config import config
+from api.helpers.crypto import asymmetric as asymmetric_helper
+from api.helpers.crypto import ssl as ssl_helper
from api.logger import logger
-def _check_ssl_certs() -> None:
- """Check if SSL certificates exist when SSL is enabled or set to be generated.
-
- Raises:
- SystemExit: If SSL certificates are missing or cannot be created.
- """
+def pre_init() -> None:
+ """Pre-initialization tasks before creating FastAPI application."""
if config.api.security.ssl.generate:
- ssl_utils.create_ssl_certs(
+ ssl_helper.create_ssl_certs(
ssl_dir=config.api.paths.ssl_dir,
key_fname=config.api.security.ssl.key_fname,
cert_fname=config.api.security.ssl.cert_fname,
@@ -30,31 +26,20 @@ def _check_ssl_certs() -> None:
)
if config.api.security.ssl.enabled:
- _ssl_keyfile_path = os.path.join(
+ _ssl_keyfile = os.path.join(
config.api.paths.ssl_dir, config.api.security.ssl.key_fname
)
- _ssl_certfile_path = os.path.join(
+ _ssl_certfile = os.path.join(
config.api.paths.ssl_dir, config.api.security.ssl.cert_fname
)
- if (not os.path.isfile(_ssl_keyfile_path)) or (
- not os.path.isfile(_ssl_certfile_path)
- ):
+ if (not os.path.isfile(_ssl_keyfile)) or (not os.path.isfile(_ssl_certfile)):
logger.error("SSL key or certificate file not found!")
raise SystemExit(1)
return
-def pre_init() -> None:
- """Pre-initialization tasks before creating FastAPI application."""
-
- _check_ssl_certs()
- # Add more pre-initialization tasks here...
-
- return
-
-
async def _async_create_dirs() -> None:
"""Create directories before starting FastAPI application.
@@ -63,8 +48,8 @@ async def _async_create_dirs() -> None:
"""
try:
- await async_create_dir(config.api.paths.data_dir)
- # Add directories that need to be created here...
+ await utils.async_create_dir(config.api.paths.data_dir)
+ ## Add directories needs to be created here...
except Exception:
logger.exception("Failed to create directories:")
raise SystemExit(1)
@@ -84,16 +69,16 @@ async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]:
logger.info("Preparing to startup...")
# await _async_create_dirs()
if config.api.security.asymmetric.generate:
- await asymmetric_utils.async_create_keys(
+ await asymmetric_helper.async_create_keys(
asymmetric_keys_dir=config.api.paths.asymmetric_keys_dir,
key_size=config.api.security.asymmetric.key_size,
private_key_fname=config.api.security.asymmetric.private_key_fname,
public_key_fname=config.api.security.asymmetric.public_key_fname,
)
- # Add startup code here...
+ ## Add startup code here...
logger.success("Finished preparation to startup.")
- logger.opt(colors=True).info(f"Version: {__version__}")
+ logger.opt(colors=True).info(f"Version: {config.version}")
logger.opt(colors=True).info(f"API version: {config.api.version}")
logger.opt(colors=True).info(f"API prefix: {config.api.prefix}")
logger.opt(colors=True).info(
@@ -103,7 +88,7 @@ async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]:
yield
logger.info("Praparing to shutdown...")
- # Add shutdown code here...
+ ## Add shutdown code here...
logger.success("Finished preparation to shutdown.")
diff --git a/src/bv_challenge/challenge/api/logger.py b/src/bv_challenge/challenge/api/logger.py
index 46da0bd..d2b046b 100644
--- a/src/bv_challenge/challenge/api/logger.py
+++ b/src/bv_challenge/challenge/api/logger.py
@@ -1,5 +1,124 @@
-from beans_logging_fastapi import logger
+# -*- coding: utf-8 -*-
+
+from pydantic import validate_call
+from fastapi.concurrency import run_in_threadpool
+
+from beans_logging import Logger, LoggerLoader
+from beans_logging_fastapi import (
+ add_http_file_handler,
+ add_http_file_json_handler,
+ http_file_format,
+)
+
+from api.core.constants import WarnEnum
+from api.config import config
+
+
+logger_loader = LoggerLoader(config=config.logger, auto_config_file=False)
+logger: Logger = logger_loader.load()
+
+
+def _http_file_format(record: dict) -> str:
+ _format = http_file_format(
+ record=record,
+ msg_format=config.logger.extra.http_file_format,
+ tz=config.logger.extra.http_file_tz,
+ )
+ return _format
+
+
+if config.logger.extra.http_file_enabled:
+ add_http_file_handler(
+ logger_loader=logger_loader,
+ log_path=config.logger.extra.http_log_path,
+ err_path=config.logger.extra.http_err_path,
+ formatter=_http_file_format,
+ )
+
+if config.logger.extra.http_json_enabled:
+ add_http_file_json_handler(
+ logger_loader=logger_loader,
+ log_path=config.logger.extra.http_json_path,
+ err_path=config.logger.extra.http_json_err_path,
+ )
+
+
+@validate_call
+def log_mode(
+ message: str, level: str = "INFO", warn_mode: WarnEnum = WarnEnum.ALWAYS
+) -> None:
+ """Log message with level and warn mode.
+
+ Args:
+ message (str, reqiured): Message to log.
+ level (LogLevelEnum, optional): Log level when warn mode is `WarnEnum.ALWAYS`. Defaults to "INFO".
+ warn_mode (WarnEnum, optional): Warn mode to use. Defaults to `WarnEnum.ALWAYS`.
+
+ Raises:
+ ValueError: If `level` is not a valid log level.
+ """
+
+ level = level.upper()
+ if warn_mode == WarnEnum.ALWAYS:
+ if level == "INFO":
+ logger.info(message)
+ elif level == "SUCCESS":
+ logger.success(message)
+ elif level == "WARNING":
+ logger.warning(message)
+ elif level == "ERROR":
+ logger.error(message)
+ elif level == "CRITICAL":
+ logger.critical(message)
+ elif level == "TRACE":
+ logger.trace(message)
+ else:
+ raise ValueError(f"Unknown log level: '{level}'")
+
+ elif warn_mode == WarnEnum.DEBUG:
+ logger.debug(message)
+
+ return
+
+
+@validate_call
+async def async_log_mode(
+ message: str, level: str = "INFO", warn_mode: WarnEnum = WarnEnum.ALWAYS
+) -> None:
+ """Log message with level and warn mode in async mode.
+
+ Args:
+ message (str , required): Message to log.
+ level (str , optional): Log level when warn mode is `WarnEnum.ALWAYS`. Defaults to "INFO".
+ warn_mode (WarnEnum, optional): Warn mode to use. Defaults to `WarnEnum.ALWAYS`.
+ """
+
+ level = level.upper()
+ if warn_mode == WarnEnum.ALWAYS:
+ if level == "INFO":
+ await run_in_threadpool(logger.info, message)
+ elif level == "SUCCESS":
+ await run_in_threadpool(logger.success, message)
+ elif level == "WARNING":
+ await run_in_threadpool(logger.warning, message)
+ elif level == "ERROR":
+ await run_in_threadpool(logger.error, message)
+ elif level == "CRITICAL":
+ await run_in_threadpool(logger.critical, message)
+ elif level == "TRACE":
+ await run_in_threadpool(logger.trace, message)
+ else:
+ raise ValueError(f"Unknown log level: '{level}'")
+
+ elif warn_mode == WarnEnum.DEBUG:
+ await run_in_threadpool(logger.debug, message)
+
+ return
+
__all__ = [
+ "logger_loader",
"logger",
+ "log_mode",
+ "async_log_mode",
]
diff --git a/src/bv_challenge/challenge/api/main.py b/src/bv_challenge/challenge/api/main.py
index e748463..4b2e097 100644
--- a/src/bv_challenge/challenge/api/main.py
+++ b/src/bv_challenge/challenge/api/main.py
@@ -1,23 +1,5 @@
-# Third-party libraries
-from dotenv import load_dotenv
-from fastapi import FastAPI
+# -*- coding: utf-8 -*-
-load_dotenv(override=True)
+from .__main__ import app, main
-# Internal modules
-from api.bootstrap import create_app, run_server # noqa: E402
-
-app: FastAPI = create_app()
-
-
-def main() -> None:
- """Main function."""
-
- run_server(app="api.main:app")
- return
-
-
-__all__ = [
- "app",
- "main",
-]
+__all__ = ["app", "main"]
diff --git a/src/bv_challenge/challenge/api/middleware.py b/src/bv_challenge/challenge/api/middleware.py
index 1db2285..c238873 100644
--- a/src/bv_challenge/challenge/api/middleware.py
+++ b/src/bv_challenge/challenge/api/middleware.py
@@ -1,9 +1,17 @@
+# -*- coding: utf-8 -*-
+
from pydantic import validate_call
from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware
from fastapi.middleware.gzip import GZipMiddleware
from fastapi.middleware.trustedhost import TrustedHostMiddleware
+from beans_logging_fastapi import (
+ HttpAccessLogMiddleware,
+ RequestHTTPInfoMiddleware,
+ ResponseHTTPInfoMiddleware,
+)
+
from api.config import config
from api.core.middlewares import ProcessTimeMiddleware, RequestIdMiddleware
@@ -16,8 +24,19 @@ def add_middlewares(app: FastAPI) -> None:
app (FastAPI): FastAPI app instance.
"""
- # Add more middlewares here...
- app.add_middleware(GZipMiddleware, **config.api.gzip.model_dump())
+ ## Add more middlewares here...
+ app.add_middleware(ResponseHTTPInfoMiddleware)
+ app.add_middleware(
+ HttpAccessLogMiddleware,
+ debug_format=config.logger.extra.http_std_debug_format,
+ msg_format=config.logger.extra.http_std_msg_format,
+ )
+ app.add_middleware(
+ RequestHTTPInfoMiddleware,
+ has_proxy_headers=config.api.behind_proxy,
+ has_cf_headers=config.api.behind_cf_proxy,
+ )
+ # app.add_middleware(GZipMiddleware, minimum_size=config.api.gzip_min_size)
app.add_middleware(CORSMiddleware, **config.api.security.cors.model_dump())
app.add_middleware(
TrustedHostMiddleware, allowed_hosts=config.api.security.allowed_hosts
diff --git a/src/bv_challenge/challenge/api/mount.py b/src/bv_challenge/challenge/api/mount.py
index 1f1b005..209a265 100644
--- a/src/bv_challenge/challenge/api/mount.py
+++ b/src/bv_challenge/challenge/api/mount.py
@@ -1,9 +1,10 @@
-# import os
+# -*- coding: utf-8 -*-
+
+import pathlib
from pydantic import validate_call
from fastapi import FastAPI
-
-# from fastapi.staticfiles import StaticFiles
+from fastapi.staticfiles import StaticFiles
@validate_call(config={"arbitrary_types_allowed": True})
@@ -14,9 +15,13 @@ def add_mounts(app: FastAPI) -> None:
app (FastAPI): FastAPI app instance.
"""
- # app.mount("/static", StaticFiles(directory=os.path.join("api", "static")), name="static")
- # Add mounts here
+ _src_dir = pathlib.Path(__file__).parent.parent.resolve()
+ app.mount(
+ path="/static",
+ app=StaticFiles(directory=str(_src_dir / "./templates/html/static")),
+ name="static",
+ )
return
diff --git a/src/bv_challenge/challenge/api/router.py b/src/bv_challenge/challenge/api/router.py
index c5e6560..8fd1a8a 100644
--- a/src/bv_challenge/challenge/api/router.py
+++ b/src/bv_challenge/challenge/api/router.py
@@ -1,9 +1,10 @@
+# -*- coding: utf-8 -*-
+
from pydantic import validate_call
from fastapi import FastAPI, APIRouter
from api.config import config
from api.core.routers.utils import router as utils_router
-from api.core.routers.default import router as default_router
from api.endpoints.challenge.router import router as challenge_router
@@ -16,14 +17,11 @@ def add_routers(app: FastAPI) -> None:
"""
_api_router = APIRouter(prefix=config.api.prefix)
- _api_router.include_router(challenge_router)
_api_router.include_router(utils_router)
+ _api_router.include_router(challenge_router)
# Add more API routers here...
- # Add admin API routers here...
-
app.include_router(_api_router)
- app.include_router(default_router)
return
diff --git a/src/bv_challenge/challenge/api/static/fonts/.gitkeep b/src/bv_challenge/challenge/api/static/fonts/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/src/bv_challenge/challenge/api/static/images/favicon.ico b/src/bv_challenge/challenge/api/static/images/favicon.ico
deleted file mode 100644
index 9efd3bf..0000000
Binary files a/src/bv_challenge/challenge/api/static/images/favicon.ico and /dev/null differ
diff --git a/src/bv_challenge/challenge/api/static/index.html b/src/bv_challenge/challenge/api/static/index.html
deleted file mode 100644
index e69de29..0000000
diff --git a/src/bv_challenge/challenge/api/static/js/.gitkeep b/src/bv_challenge/challenge/api/static/js/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/src/bv_challenge/challenge/api/static/media/.gitkeep b/src/bv_challenge/challenge/api/static/media/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/src/bv_challenge/challenge/api/templates/html/.gitkeep b/src/bv_challenge/challenge/api/templates/html/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/src/bv_challenge/challenge/api/templates/mail/.gitkeep b/src/bv_challenge/challenge/api/templates/mail/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/src/bv_challenge/challenge/bot/Dockerfile b/src/bv_challenge/challenge/bot/Dockerfile
new file mode 100644
index 0000000..00a1118
--- /dev/null
+++ b/src/bv_challenge/challenge/bot/Dockerfile
@@ -0,0 +1,27 @@
+# syntax=docker/dockerfile:1
+ARG BASE_IMAGE=selenium/standalone-chromium:latest
+FROM ${BASE_IMAGE}
+
+ARG DEBIAN_FRONTEND=noninteractive
+
+WORKDIR /app
+
+USER root
+RUN apt-get update && \
+ apt-get install -y --no-install-recommends \
+ bash \
+ ca-certificates \
+ curl \
+ dnsutils \
+ iproute2 \
+ iputils-ping \
+ netcat-openbsd \
+ procps && \
+ rm -rf /var/lib/apt/lists/* && \
+ python3 -m pip install --break-system-packages --no-cache-dir selenium
+
+COPY bot.py /app/bot.py
+
+USER seluser
+
+ENTRYPOINT ["python3", "/app/bot.py"]
diff --git a/src/bv_challenge/challenge/bot/bot.py b/src/bv_challenge/challenge/bot/bot.py
new file mode 100644
index 0000000..d435b0d
--- /dev/null
+++ b/src/bv_challenge/challenge/bot/bot.py
@@ -0,0 +1,231 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""Reference bot for the Bot Virus challenge — single-file, two-file contract.
+
+The miner submission is exactly two files: this ``bot.py`` and a ``Dockerfile``.
+This reference bot opens the challenge web page (``/_web``) with a headless
+Chrome and waits for the browser-side SDK to collect the integrity signals and
+POST the encrypted payload to ``/_eval``. It does NOT fill forms, move the
+mouse, scroll, or submit anything from Python — submission must happen from the
+browser context (``window.BV_SUBMITTED === true``).
+
+Endpoint configuration is read from the environment provided by the runner:
+
+ CHALLENGE_WEB_URL e.g. http://challenge-api:10001/_web (preferred)
+ CHALLENGE_BASE_URL e.g. http://challenge-api:10001 (web url derived)
+ BV_SESSION_COUNT number of sessions to run (default: 1)
+
+Only the Selenium Python client is required on top of the base image.
+"""
+
+import os
+import sys
+import logging
+import shutil
+import subprocess
+import tempfile
+from urllib.parse import parse_qsl, urlencode, urlparse, urlunparse
+
+from selenium import webdriver
+from selenium.webdriver.chrome.service import Service as ChromeService
+from selenium.common.exceptions import WebDriverException
+from selenium.webdriver.common.by import By
+from selenium.webdriver.remote.webdriver import WebDriver
+from selenium.webdriver.support import expected_conditions as EC
+from selenium.webdriver.support.ui import WebDriverWait
+
+logger = logging.getLogger(__name__)
+
+_VIEWPORT_WIDTH = 1440
+_VIEWPORT_HEIGHT = 900
+_DEFAULT_PORT = "10001"
+
+
+def first_existing_path(*paths: str) -> str:
+ """Return the first existing executable path from explicit paths or PATH."""
+
+ for path in paths:
+ if not path:
+ continue
+ resolved = shutil.which(path) if "/" not in path else path
+ if resolved and os.path.exists(resolved):
+ return resolved
+ return ""
+
+
+def parse_session_count() -> int:
+ """Read the number of browser sessions requested by the runner."""
+
+ try:
+ session_count = int(os.getenv("BV_SESSION_COUNT", "1"))
+ except (TypeError, ValueError):
+ session_count = 1
+ return max(1, session_count)
+
+
+def session_web_url(web_url: str, session_index: int) -> str:
+ """Return a fresh URL for this session without changing the endpoint."""
+
+ parsed = urlparse(web_url)
+ query = dict(parse_qsl(parsed.query, keep_blank_values=True))
+ # query["bv_session"] = str(session_index + 1)
+ return urlunparse(parsed._replace(query=urlencode(query)))
+
+
+def resolve_web_url() -> str:
+ """Resolve the challenge ``/_web`` URL from the environment.
+
+ Order of preference: CHALLENGE_WEB_URL, then CHALLENGE_BASE_URL + "/_web",
+ then the container's default gateway host, then a sane default.
+ """
+
+ _web_url = os.getenv("CHALLENGE_WEB_URL")
+ if _web_url:
+ return _web_url
+
+ _base_url = os.getenv("CHALLENGE_BASE_URL")
+ if _base_url:
+ return f"{_base_url.rstrip('/')}/_web"
+
+ # Fallback: try to reach the host via the default gateway.
+ try:
+ _host = subprocess.check_output(
+ "ip route | awk '/default/ { print $3 }'", shell=True, text=True
+ ).strip()
+ except Exception:
+ _host = "challenge-api"
+
+ _web_url = f"http://{_host}:{_DEFAULT_PORT}/_web"
+ logger.warning(f"CHALLENGE_WEB_URL not set, using fallback: {_web_url}")
+ return _web_url
+
+
+def setup_driver(web_url: str) -> WebDriver:
+ """Initialize headless Chrome and load the challenge page."""
+
+ _options = webdriver.ChromeOptions()
+ chromium_path = first_existing_path(
+ os.getenv("CHROME_BIN", ""),
+ "chromium",
+ "chromium-browser",
+ "google-chrome",
+ )
+ chromedriver_path = first_existing_path(
+ os.getenv("CHROMEDRIVER_BIN", ""),
+ "chromedriver",
+ )
+
+ if chromium_path:
+ _options.binary_location = chromium_path
+ logger.info(f"Using Chromium binary: {chromium_path}")
+ if not chromedriver_path:
+ raise RuntimeError("chromedriver executable not found in PATH")
+ logger.info(f"Using Chromedriver binary: {chromedriver_path}")
+
+ _options.add_argument("--headless=new")
+ _options.add_argument("--no-sandbox")
+ _options.add_argument("--disable-gpu")
+ _options.add_argument("--disable-dev-shm-usage")
+ _options.add_argument("--ignore-certificate-errors")
+ _options.add_argument("--no-first-run")
+ _options.add_argument("--no-default-browser-check")
+ _options.add_argument("--remote-debugging-port=0")
+
+ # Treat the (HTTP) challenge origin as secure so the SDK gets a secure
+ # context and WebCrypto SubtleCrypto is available for payload encryption.
+ # The flag takes an *origin* and only applies with a dedicated user-data-dir.
+ _parsed = urlparse(web_url)
+ _origin = f"{_parsed.scheme}://{_parsed.netloc}"
+ _options.add_argument(f"--unsafely-treat-insecure-origin-as-secure={_origin}")
+ _options.add_argument(f"--user-data-dir={tempfile.mkdtemp(prefix='bv-chrome-')}")
+ _options.add_argument(f"--window-size={_VIEWPORT_WIDTH},{_VIEWPORT_HEIGHT}")
+
+ service = ChromeService(executable_path=chromedriver_path)
+ driver = webdriver.Chrome(service=service, options=_options)
+ driver.get(web_url)
+
+ # Ensure the minimal verification page has loaded.
+ WebDriverWait(driver, 15).until(EC.presence_of_element_located((By.ID, "status")))
+ return driver
+
+
+def run_session(driver: WebDriver) -> bool:
+ """Wait for the browser-side SDK to submit the payload to /_eval."""
+
+ try:
+ WebDriverWait(driver, 30).until(
+ lambda d: d.execute_script("return window.BV_SUBMITTED === true;")
+ )
+ logger.info("Browser-side SDK submitted the payload to /_eval.")
+
+ # Surface browser console logs for debugging (best effort).
+ try:
+ for entry in driver.get_log("browser"):
+ logger.info(f"[console][{entry.get('level')}] {entry.get('message')}")
+ except Exception as err:
+ logger.warning(f"Could not retrieve browser console logs: {err}")
+
+ return True
+ except Exception as err:
+ logger.error(f"Browser-side submission did not complete: {err}")
+ return False
+
+
+def automate(web_url: str) -> bool:
+ """Run a single automation session against the challenge web page."""
+
+ driver = None
+ try:
+ driver = setup_driver(web_url)
+ return run_session(driver)
+ except WebDriverException as err:
+ logger.error(f"WebDriver setup failed: {err}")
+ return False
+ except Exception as err:
+ logger.error(f"Automation failed: {err}")
+ return False
+ finally:
+ if driver is not None:
+ try:
+ driver.delete_all_cookies()
+ driver.execute_script("window.localStorage.clear();")
+ except Exception:
+ pass
+ driver.quit()
+
+
+def main() -> None:
+ logging.basicConfig(
+ stream=sys.stdout,
+ level=logging.INFO,
+ datefmt="%Y-%m-%d %H:%M:%S %z",
+ format="[%(asctime)s | %(levelname)s | %(filename)s:%(lineno)d]: %(message)s",
+ )
+
+ logger.info("Starting WebUI automation bot...")
+
+ web_url = resolve_web_url()
+ logger.info(f"Challenge web URL: {web_url}")
+
+ session_count = parse_session_count()
+
+ logger.info(f"Running {session_count} session(s)")
+
+ successful_sessions = 0
+ for index in range(session_count):
+ current_web_url = session_web_url(web_url, index)
+ logger.info(f"Session {index + 1}/{session_count}: {current_web_url}")
+ if automate(current_web_url):
+ successful_sessions += 1
+
+ if successful_sessions != session_count:
+ logger.error(
+ f"Completed {successful_sessions}/{session_count} requested session(s)."
+ )
+ sys.exit(1)
+
+ logger.info("Done!\n")
+
+
+if __name__ == "__main__":
+ main()
diff --git a/src/bv_challenge/challenge/requirements.txt b/src/bv_challenge/challenge/requirements.txt
index 4870bad..9be7421 100644
--- a/src/bv_challenge/challenge/requirements.txt
+++ b/src/bv_challenge/challenge/requirements.txt
@@ -1,5 +1,16 @@
-certifi>=2024.2.2,<2030.0.0
-anyio>=4.3.0,<5.0.0
-potato-util[crypto,async]~=0.5.3
-beans-logging-fastapi~=6.0.4
-fastapi[all]~=0.135.1
+pycparser>=2.22,<3.0.0
+certifi>=2024.8.30,<2030.0.0
+Mako>=1.3.6,<2.0.0
+argon2-cffi-bindings>=21.2.0,<22.0.0
+aioshutil~=1.5
+aiofiles~=24.1.0
+PyJWT~=2.10.1
+cryptography>=43.0.0,<50.0.0
+argon2-cffi~=23.1.0
+beans-logging-fastapi~=1.1.1
+onion-config[pydantic-settings]~=5.1.1
+aiohttp~=3.10.2
+fastapi[all]~=0.110.1
+requests>=2.32.3,<3.0.0
+./requirements/vault_unlock-0.1.0-cp310-abi3-manylinux_2_34_x86_64.whl
+./requirements/rt_bv_score-4.3.5-cp310-abi3-manylinux_2_34_x86_64.whl
diff --git a/src/bv_challenge/challenge/requirements/rt_bv_score-0.1.0-cp310-abi3-manylinux_2_34_x86_64.whl b/src/bv_challenge/challenge/requirements/rt_bv_score-0.1.0-cp310-abi3-manylinux_2_34_x86_64.whl
new file mode 100644
index 0000000..bac8601
Binary files /dev/null and b/src/bv_challenge/challenge/requirements/rt_bv_score-0.1.0-cp310-abi3-manylinux_2_34_x86_64.whl differ
diff --git a/src/bv_challenge/challenge/requirements/rt_bv_score-4.3.5-cp310-abi3-macosx_11_0_arm64.whl b/src/bv_challenge/challenge/requirements/rt_bv_score-4.3.5-cp310-abi3-macosx_11_0_arm64.whl
new file mode 100644
index 0000000..36af989
Binary files /dev/null and b/src/bv_challenge/challenge/requirements/rt_bv_score-4.3.5-cp310-abi3-macosx_11_0_arm64.whl differ
diff --git a/src/bv_challenge/challenge/requirements/rt_bv_score-4.3.5-cp310-abi3-manylinux_2_34_x86_64.whl b/src/bv_challenge/challenge/requirements/rt_bv_score-4.3.5-cp310-abi3-manylinux_2_34_x86_64.whl
new file mode 100644
index 0000000..52f76c6
Binary files /dev/null and b/src/bv_challenge/challenge/requirements/rt_bv_score-4.3.5-cp310-abi3-manylinux_2_34_x86_64.whl differ
diff --git a/src/bv_challenge/challenge/requirements/vault_unlock-0.1.0-cp310-abi3-manylinux_2_34_x86_64.whl b/src/bv_challenge/challenge/requirements/vault_unlock-0.1.0-cp310-abi3-manylinux_2_34_x86_64.whl
new file mode 100644
index 0000000..4a4fdc4
Binary files /dev/null and b/src/bv_challenge/challenge/requirements/vault_unlock-0.1.0-cp310-abi3-manylinux_2_34_x86_64.whl differ
diff --git a/src/bv_challenge/challenge/templates/html/asset-manifest.json b/src/bv_challenge/challenge/templates/html/asset-manifest.json
new file mode 100644
index 0000000..fa2e9ee
--- /dev/null
+++ b/src/bv_challenge/challenge/templates/html/asset-manifest.json
@@ -0,0 +1,13 @@
+{
+ "files": {
+ "main.css": "/static/css/main.4e0cb29c.css",
+ "main.js": "/static/js/main.35a65fc2.js",
+ "static/js/221.0fc95064.chunk.js": "/static/js/221.0fc95064.chunk.js",
+ "static/js/810.16fb44d2.chunk.js": "/static/js/810.16fb44d2.chunk.js",
+ "index.html": "/index.html"
+ },
+ "entrypoints": [
+ "static/css/main.4e0cb29c.css",
+ "static/js/main.35a65fc2.js"
+ ]
+}
\ No newline at end of file
diff --git a/src/bv_challenge/challenge/templates/html/index.html b/src/bv_challenge/challenge/templates/html/index.html
new file mode 100644
index 0000000..d4e755a
--- /dev/null
+++ b/src/bv_challenge/challenge/templates/html/index.html
@@ -0,0 +1 @@
+Browser verification
diff --git a/src/bv_challenge/challenge/templates/html/robots.txt b/src/bv_challenge/challenge/templates/html/robots.txt
new file mode 100644
index 0000000..e9e57dc
--- /dev/null
+++ b/src/bv_challenge/challenge/templates/html/robots.txt
@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:
diff --git a/src/bv_challenge/challenge/templates/html/static/css/main.4e0cb29c.css b/src/bv_challenge/challenge/templates/html/static/css/main.4e0cb29c.css
new file mode 100644
index 0000000..f09f8aa
--- /dev/null
+++ b/src/bv_challenge/challenge/templates/html/static/css/main.4e0cb29c.css
@@ -0,0 +1 @@
+:root{--bg:#0f1115;--surface:#1a1d24;--text:#e7e9ee;--muted:#9aa0ad;--accent:#4f7cff}*{box-sizing:border-box}body{background:#0f1115;background:var(--bg);color:#e7e9ee;color:var(--text);font-family:system-ui,-apple-system,Segoe UI,Roboto,sans-serif;margin:0}main{margin:0 auto;max-width:420px;padding:96px 20px 0;text-align:center}h1{font-size:1.5rem;margin:0 0 12px}p{color:#9aa0ad;color:var(--muted);margin:0 0 24px}#status{background:#1a1d24;background:var(--surface);border-radius:8px;color:#4f7cff;color:var(--accent);display:inline-block;font-size:.9rem;padding:8px 14px}
\ No newline at end of file
diff --git a/src/bv_challenge/challenge/templates/html/static/img/favicon.png b/src/bv_challenge/challenge/templates/html/static/img/favicon.png
new file mode 100644
index 0000000..ec02920
Binary files /dev/null and b/src/bv_challenge/challenge/templates/html/static/img/favicon.png differ
diff --git a/src/bv_challenge/challenge/templates/html/static/js/221.0fc95064.chunk.js b/src/bv_challenge/challenge/templates/html/static/js/221.0fc95064.chunk.js
new file mode 100644
index 0000000..0dda501
--- /dev/null
+++ b/src/bv_challenge/challenge/templates/html/static/js/221.0fc95064.chunk.js
@@ -0,0 +1 @@
+(self.webpackChunkbot_virus_browser_verification_page=self.webpackChunkbot_virus_browser_verification_page||[]).push([[221],{221(e){var n,t;n="undefined"!==typeof self?self:this,t=function(){var e={automation:!0,runtimeIntegrity:!0,fingerprint:!0,apiAvailability:!0,navigator:!0,display:!0,correlation:!0,sessionBinding:!0};Object.freeze(e);var n=["movements","clicks","mouseDowns","mouseUps","keydowns","keyups","scroll"];return Object.freeze({createCollector:function(t){for(var r=t||{},o="function"===typeof r.now?r.now:function(){return Date.now()},i={schemaVersion:r.schemaVersion||null,sessionId:r.sessionId||null,startedAt:o(),endedAt:null,browserInfo:null,automation:null,runtimeIntegrity:null,fingerprint:null,apiAvailability:null,navigator:null,display:null,correlation:null,sessionBinding:null,pageTimings:{pageLoadMs:null}},l=0;l>>0;return("00000000"+n.toString(16)).slice(-8)}function m(e){for(var n="",t=new Uint8Array(e),o=0;o=0&&c.setPageTiming("pageLoadMs",e)}(),function(){var e="undefined"!==typeof navigator&&navigator||{},n="undefined"!==typeof screen&&screen||{},t=d(function(){return Intl.DateTimeFormat().resolvedOptions().timeZone||null},null),o=d(function(){return e.userAgentData?{mobile:!!e.userAgentData.mobile,platform:e.userAgentData.platform||null,brands:e.userAgentData.brands||null}:null},null);c.setBrowserInfo({userAgent:"string"===typeof e.userAgent?e.userAgent:null,platform:"string"===typeof e.platform?e.platform:null,vendor:"string"===typeof e.vendor?e.vendor:null,language:"string"===typeof e.language?e.language:null,languages:d(function(){return e.languages?Array.prototype.slice.call(e.languages):null},null),timezone:t,webdriver:!0===e.webdriver,hardwareConcurrency:"number"===typeof e.hardwareConcurrency?e.hardwareConcurrency:null,deviceMemory:"number"===typeof e.deviceMemory?e.deviceMemory:null,maxTouchPoints:"number"===typeof e.maxTouchPoints?e.maxTouchPoints:0,touchSupport:"ontouchstart"in window||"number"===typeof e.maxTouchPoints&&e.maxTouchPoints>0,pluginsLength:e.plugins&&"number"===typeof e.plugins.length?e.plugins.length:0,mimeTypesLength:e.mimeTypes&&"number"===typeof e.mimeTypes.length?e.mimeTypes.length:0,mobile:o?!!o.mobile:null,userAgentData:o,outerWidth:"number"===typeof window.outerWidth?window.outerWidth:0,outerHeight:"number"===typeof window.outerHeight?window.outerHeight:0,width:n.width||0,height:n.height||0,availWidth:n.availWidth||0,availHeight:n.availHeight||0,colorDepth:"number"===typeof n.colorDepth?n.colorDepth:null,pixelDepth:"number"===typeof n.pixelDepth?n.pixelDepth:null,devicePixelRatio:"number"===typeof window.devicePixelRatio?window.devicePixelRatio:null,viewport:{width:window.innerWidth||0,height:window.innerHeight||0},screen:{width:n.width||0,height:n.height||0},windowProps:d(function(){for(var e=["callPhantom","_phantom","__nightmare","domAutomation","domAutomationController","__webdriver_evaluate","__selenium_evaluate","__driver_evaluate","_Selenium_IDE_Recorder","__webdriverFunc","__playwright","__puppeteer_evaluation_script__"],n=[],t=0;t=0)},!1),serviceWorker:"serviceWorker"in navigator,webAssembly:"WebAssembly"in window,indexedDb:"indexedDB"in window}),function(){var e=d(function(){var e=p();if(!e)return null;var n=e.getExtension("WEBGL_debug_renderer_info"),t=n?e.getParameter(n.UNMASKED_VENDOR_WEBGL):null,o=n?e.getParameter(n.UNMASKED_RENDERER_WEBGL):null,r=(o||"").toLowerCase();return{vendor:t||null,renderer:o||null,maxTextureSize:e.getParameter(e.MAX_TEXTURE_SIZE)||0,extensionsCount:d(function(){var n=e.getSupportedExtensions();return n?n.length:0},0),software:-1!==r.indexOf("swiftshader")||-1!==r.indexOf("llvmpipe")||-1!==r.indexOf("software"),swiftshader:-1!==r.indexOf("swiftshader")}},null),n=d(function(){var e=document.createElement("canvas");e.width=64,e.height=24;var n=e.getContext("2d");n.textBaseline="top",n.font="14px 'Arial'",n.fillStyle="#069",n.fillText("bv-runtime",2,2);var t=e.toDataURL();return{toDataURLNative:w(HTMLCanvasElement.prototype.toDataURL),hash:f(t),length:t.length}},null),t=d(function(){var e=window.AudioContext||window.webkitAudioContext;return e?{available:!0,sampleRate:d(function(){var n=new e,t=n.sampleRate;return n.close&&n.close(),t},null)}:null},null);c.setSection("fingerprint",{webgl:e,canvas:n,audio:t})}(),function(){var e="undefined"!==typeof navigator&&navigator||{};c.setSection("navigator",{userAgent:"string"===typeof e.userAgent?e.userAgent:null,vendor:"string"===typeof e.vendor?e.vendor:null,platform:"string"===typeof e.platform?e.platform:null,language:"string"===typeof e.language?e.language:null,hardwareConcurrency:"number"===typeof e.hardwareConcurrency?e.hardwareConcurrency:null})}(),function(){var e="undefined"!==typeof screen&&screen||{};c.setSection("display",{width:e.width||0,height:e.height||0,availWidth:e.availWidth||0,availHeight:e.availHeight||0,colorDepth:"number"===typeof e.colorDepth?e.colorDepth:null,pixelDepth:"number"===typeof e.pixelDepth?e.pixelDepth:null,devicePixelRatio:"number"===typeof window.devicePixelRatio?window.devicePixelRatio:null,innerWidth:window.innerWidth||0,innerHeight:window.innerHeight||0,outerWidth:"number"===typeof window.outerWidth?window.outerWidth:0,outerHeight:"number"===typeof window.outerHeight?window.outerHeight:0})}(),function(){var e="undefined"!==typeof navigator&&navigator||{},n=d(function(){return e.userAgentData&&e.userAgentData.platform?e.userAgentData.platform:null},null);c.setSection("correlation",{uaHasLinux:d(function(){return-1!==(e.userAgent||"").toLowerCase().indexOf("linux")},!1),platform:"string"===typeof e.platform?e.platform:null,uaDataPlatform:n,touchVsMaxTouchPoints:d(function(){return{hasTouchApi:"ontouchstart"in window,maxTouchPoints:"number"===typeof e.maxTouchPoints?e.maxTouchPoints:0}},null)})}(),c.setSection("sessionBinding",{sessionId:n.sessionId||null,nonce:n.nonce||null,publicKeyId:n.publicKeyId||null,configHash:n.configHash||null,schemaVersion:n.schemaVersion||null,href:d(function(){return window.location?window.location.href:null},null),origin:d(function(){return window.location?window.location.origin:null},null)}),c.finalize();var e=a.jsonStringify(c.toJSON());if(d(function(){window.localStorage.setItem(o,e)}),!r)return Promise.resolve(!1);var t=window.PUBLIC_KEY;return t?g(e,t).then(h).catch(function(e){return s("Verification could not be submitted"),d(function(){console.error("[BV-SDK] submit failed:",e&&e.message)}),!1}):(s("Verification unavailable"),Promise.resolve(!1))}}()}}]);
\ No newline at end of file
diff --git a/src/bv_challenge/challenge/templates/html/static/js/main.35a65fc2.js b/src/bv_challenge/challenge/templates/html/static/js/main.35a65fc2.js
new file mode 100644
index 0000000..a8a47f5
--- /dev/null
+++ b/src/bv_challenge/challenge/templates/html/static/js/main.35a65fc2.js
@@ -0,0 +1,2 @@
+/*! For license information please see main.35a65fc2.js.LICENSE.txt */
+(()=>{"use strict";var e={345(e,n,t){var r=t(950),l=t(340);function a(e){for(var n="https://reactjs.org/docs/error-decoder.html?invariant="+e,t=1;tn}return!1}(n,t,l,r)&&(t=null),r||null===l?function(e){return!!f.call(m,e)||!f.call(p,e)&&(d.test(e)?m[e]=!0:(p[e]=!0,!1))}(n)&&(null===t?e.removeAttribute(n):e.setAttribute(n,""+t)):l.mustUseProperty?e[l.propertyName]=null===t?3!==l.type&&"":t:(n=l.attributeName,r=l.attributeNamespace,null===t?e.removeAttribute(n):(t=3===(l=l.type)||4===l&&!0===t?"":""+t,r?e.setAttributeNS(r,n,t):e.setAttribute(n,t))))}"accent-height alignment-baseline arabic-form baseline-shift cap-height clip-path clip-rule color-interpolation color-interpolation-filters color-profile color-rendering dominant-baseline enable-background fill-opacity fill-rule flood-color flood-opacity font-family font-size font-size-adjust font-stretch font-style font-variant font-weight glyph-name glyph-orientation-horizontal glyph-orientation-vertical horiz-adv-x horiz-origin-x image-rendering letter-spacing lighting-color marker-end marker-mid marker-start overline-position overline-thickness paint-order panose-1 pointer-events rendering-intent shape-rendering stop-color stop-opacity strikethrough-position strikethrough-thickness stroke-dasharray stroke-dashoffset stroke-linecap stroke-linejoin stroke-miterlimit stroke-opacity stroke-width text-anchor text-decoration text-rendering underline-position underline-thickness unicode-bidi unicode-range units-per-em v-alphabetic v-hanging v-ideographic v-mathematical vector-effect vert-adv-y vert-origin-x vert-origin-y word-spacing writing-mode xmlns:xlink x-height".split(" ").forEach(function(e){var n=e.replace(g,y);v[n]=new h(n,1,!1,e,null,!1,!1)}),"xlink:actuate xlink:arcrole xlink:role xlink:show xlink:title xlink:type".split(" ").forEach(function(e){var n=e.replace(g,y);v[n]=new h(n,1,!1,e,"http://www.w3.org/1999/xlink",!1,!1)}),["xml:base","xml:lang","xml:space"].forEach(function(e){var n=e.replace(g,y);v[n]=new h(n,1,!1,e,"http://www.w3.org/XML/1998/namespace",!1,!1)}),["tabIndex","crossOrigin"].forEach(function(e){v[e]=new h(e,1,!1,e.toLowerCase(),null,!1,!1)}),v.xlinkHref=new h("xlinkHref",1,!1,"xlink:href","http://www.w3.org/1999/xlink",!0,!1),["src","href","action","formAction"].forEach(function(e){v[e]=new h(e,1,!1,e.toLowerCase(),null,!0,!0)});var k=r.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED,w=Symbol.for("react.element"),S=Symbol.for("react.portal"),x=Symbol.for("react.fragment"),E=Symbol.for("react.strict_mode"),_=Symbol.for("react.profiler"),C=Symbol.for("react.provider"),P=Symbol.for("react.context"),N=Symbol.for("react.forward_ref"),z=Symbol.for("react.suspense"),T=Symbol.for("react.suspense_list"),L=Symbol.for("react.memo"),O=Symbol.for("react.lazy");Symbol.for("react.scope"),Symbol.for("react.debug_trace_mode");var R=Symbol.for("react.offscreen");Symbol.for("react.legacy_hidden"),Symbol.for("react.cache"),Symbol.for("react.tracing_marker");var M=Symbol.iterator;function F(e){return null===e||"object"!==typeof e?null:"function"===typeof(e=M&&e[M]||e["@@iterator"])?e:null}var D,I=Object.assign;function U(e){if(void 0===D)try{throw Error()}catch(t){var n=t.stack.trim().match(/\n( *(at )?)/);D=n&&n[1]||""}return"\n"+D+e}var j=!1;function A(e,n){if(!e||j)return"";j=!0;var t=Error.prepareStackTrace;Error.prepareStackTrace=void 0;try{if(n)if(n=function(){throw Error()},Object.defineProperty(n.prototype,"props",{set:function(){throw Error()}}),"object"===typeof Reflect&&Reflect.construct){try{Reflect.construct(n,[])}catch(s){var r=s}Reflect.construct(e,[],n)}else{try{n.call()}catch(s){r=s}e.call(n.prototype)}else{try{throw Error()}catch(s){r=s}e()}}catch(s){if(s&&r&&"string"===typeof s.stack){for(var l=s.stack.split("\n"),a=r.stack.split("\n"),o=l.length-1,u=a.length-1;1<=o&&0<=u&&l[o]!==a[u];)u--;for(;1<=o&&0<=u;o--,u--)if(l[o]!==a[u]){if(1!==o||1!==u)do{if(o--,0>--u||l[o]!==a[u]){var i="\n"+l[o].replace(" at new "," at ");return e.displayName&&i.includes("")&&(i=i.replace("",e.displayName)),i}}while(1<=o&&0<=u);break}}}finally{j=!1,Error.prepareStackTrace=t}return(e=e?e.displayName||e.name:"")?U(e):""}function V(e){switch(e.tag){case 5:return U(e.type);case 16:return U("Lazy");case 13:return U("Suspense");case 19:return U("SuspenseList");case 0:case 2:case 15:return e=A(e.type,!1);case 11:return e=A(e.type.render,!1);case 1:return e=A(e.type,!0);default:return""}}function $(e){if(null==e)return null;if("function"===typeof e)return e.displayName||e.name||null;if("string"===typeof e)return e;switch(e){case x:return"Fragment";case S:return"Portal";case _:return"Profiler";case E:return"StrictMode";case z:return"Suspense";case T:return"SuspenseList"}if("object"===typeof e)switch(e.$$typeof){case P:return(e.displayName||"Context")+".Consumer";case C:return(e._context.displayName||"Context")+".Provider";case N:var n=e.render;return(e=e.displayName)||(e=""!==(e=n.displayName||n.name||"")?"ForwardRef("+e+")":"ForwardRef"),e;case L:return null!==(n=e.displayName||null)?n:$(e.type)||"Memo";case O:n=e._payload,e=e._init;try{return $(e(n))}catch(t){}}return null}function B(e){var n=e.type;switch(e.tag){case 24:return"Cache";case 9:return(n.displayName||"Context")+".Consumer";case 10:return(n._context.displayName||"Context")+".Provider";case 18:return"DehydratedFragment";case 11:return e=(e=n.render).displayName||e.name||"",n.displayName||(""!==e?"ForwardRef("+e+")":"ForwardRef");case 7:return"Fragment";case 5:return n;case 4:return"Portal";case 3:return"Root";case 6:return"Text";case 16:return $(n);case 8:return n===E?"StrictMode":"Mode";case 22:return"Offscreen";case 12:return"Profiler";case 21:return"Scope";case 13:return"Suspense";case 19:return"SuspenseList";case 25:return"TracingMarker";case 1:case 0:case 17:case 2:case 14:case 15:if("function"===typeof n)return n.displayName||n.name||null;if("string"===typeof n)return n}return null}function H(e){switch(typeof e){case"boolean":case"number":case"string":case"undefined":case"object":return e;default:return""}}function W(e){var n=e.type;return(e=e.nodeName)&&"input"===e.toLowerCase()&&("checkbox"===n||"radio"===n)}function Q(e){e._valueTracker||(e._valueTracker=function(e){var n=W(e)?"checked":"value",t=Object.getOwnPropertyDescriptor(e.constructor.prototype,n),r=""+e[n];if(!e.hasOwnProperty(n)&&"undefined"!==typeof t&&"function"===typeof t.get&&"function"===typeof t.set){var l=t.get,a=t.set;return Object.defineProperty(e,n,{configurable:!0,get:function(){return l.call(this)},set:function(e){r=""+e,a.call(this,e)}}),Object.defineProperty(e,n,{enumerable:t.enumerable}),{getValue:function(){return r},setValue:function(e){r=""+e},stopTracking:function(){e._valueTracker=null,delete e[n]}}}}(e))}function q(e){if(!e)return!1;var n=e._valueTracker;if(!n)return!0;var t=n.getValue(),r="";return e&&(r=W(e)?e.checked?"true":"false":e.value),(e=r)!==t&&(n.setValue(e),!0)}function K(e){if("undefined"===typeof(e=e||("undefined"!==typeof document?document:void 0)))return null;try{return e.activeElement||e.body}catch(n){return e.body}}function Y(e,n){var t=n.checked;return I({},n,{defaultChecked:void 0,defaultValue:void 0,value:void 0,checked:null!=t?t:e._wrapperState.initialChecked})}function X(e,n){var t=null==n.defaultValue?"":n.defaultValue,r=null!=n.checked?n.checked:n.defaultChecked;t=H(null!=n.value?n.value:t),e._wrapperState={initialChecked:r,initialValue:t,controlled:"checkbox"===n.type||"radio"===n.type?null!=n.checked:null!=n.value}}function G(e,n){null!=(n=n.checked)&&b(e,"checked",n,!1)}function Z(e,n){G(e,n);var t=H(n.value),r=n.type;if(null!=t)"number"===r?(0===t&&""===e.value||e.value!=t)&&(e.value=""+t):e.value!==""+t&&(e.value=""+t);else if("submit"===r||"reset"===r)return void e.removeAttribute("value");n.hasOwnProperty("value")?ee(e,n.type,t):n.hasOwnProperty("defaultValue")&&ee(e,n.type,H(n.defaultValue)),null==n.checked&&null!=n.defaultChecked&&(e.defaultChecked=!!n.defaultChecked)}function J(e,n,t){if(n.hasOwnProperty("value")||n.hasOwnProperty("defaultValue")){var r=n.type;if(!("submit"!==r&&"reset"!==r||void 0!==n.value&&null!==n.value))return;n=""+e._wrapperState.initialValue,t||n===e.value||(e.value=n),e.defaultValue=n}""!==(t=e.name)&&(e.name=""),e.defaultChecked=!!e._wrapperState.initialChecked,""!==t&&(e.name=t)}function ee(e,n,t){"number"===n&&K(e.ownerDocument)===e||(null==t?e.defaultValue=""+e._wrapperState.initialValue:e.defaultValue!==""+t&&(e.defaultValue=""+t))}var ne=Array.isArray;function te(e,n,t,r){if(e=e.options,n){n={};for(var l=0;l"+n.valueOf().toString()+"",n=se.firstChild;e.firstChild;)e.removeChild(e.firstChild);for(;n.firstChild;)e.appendChild(n.firstChild)}},"undefined"!==typeof MSApp&&MSApp.execUnsafeLocalFunction?function(e,n,t,r){MSApp.execUnsafeLocalFunction(function(){return ce(e,n)})}:ce);function de(e,n){if(n){var t=e.firstChild;if(t&&t===e.lastChild&&3===t.nodeType)return void(t.nodeValue=n)}e.textContent=n}var pe={animationIterationCount:!0,aspectRatio:!0,borderImageOutset:!0,borderImageSlice:!0,borderImageWidth:!0,boxFlex:!0,boxFlexGroup:!0,boxOrdinalGroup:!0,columnCount:!0,columns:!0,flex:!0,flexGrow:!0,flexPositive:!0,flexShrink:!0,flexNegative:!0,flexOrder:!0,gridArea:!0,gridRow:!0,gridRowEnd:!0,gridRowSpan:!0,gridRowStart:!0,gridColumn:!0,gridColumnEnd:!0,gridColumnSpan:!0,gridColumnStart:!0,fontWeight:!0,lineClamp:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,tabSize:!0,widows:!0,zIndex:!0,zoom:!0,fillOpacity:!0,floodOpacity:!0,stopOpacity:!0,strokeDasharray:!0,strokeDashoffset:!0,strokeMiterlimit:!0,strokeOpacity:!0,strokeWidth:!0},me=["Webkit","ms","Moz","O"];function he(e,n,t){return null==n||"boolean"===typeof n||""===n?"":t||"number"!==typeof n||0===n||pe.hasOwnProperty(e)&&pe[e]?(""+n).trim():n+"px"}function ve(e,n){for(var t in e=e.style,n)if(n.hasOwnProperty(t)){var r=0===t.indexOf("--"),l=he(t,n[t],r);"float"===t&&(t="cssFloat"),r?e.setProperty(t,l):e[t]=l}}Object.keys(pe).forEach(function(e){me.forEach(function(n){n=n+e.charAt(0).toUpperCase()+e.substring(1),pe[n]=pe[e]})});var ge=I({menuitem:!0},{area:!0,base:!0,br:!0,col:!0,embed:!0,hr:!0,img:!0,input:!0,keygen:!0,link:!0,meta:!0,param:!0,source:!0,track:!0,wbr:!0});function ye(e,n){if(n){if(ge[e]&&(null!=n.children||null!=n.dangerouslySetInnerHTML))throw Error(a(137,e));if(null!=n.dangerouslySetInnerHTML){if(null!=n.children)throw Error(a(60));if("object"!==typeof n.dangerouslySetInnerHTML||!("__html"in n.dangerouslySetInnerHTML))throw Error(a(61))}if(null!=n.style&&"object"!==typeof n.style)throw Error(a(62))}}function be(e,n){if(-1===e.indexOf("-"))return"string"===typeof n.is;switch(e){case"annotation-xml":case"color-profile":case"font-face":case"font-face-src":case"font-face-uri":case"font-face-format":case"font-face-name":case"missing-glyph":return!1;default:return!0}}var ke=null;function we(e){return(e=e.target||e.srcElement||window).correspondingUseElement&&(e=e.correspondingUseElement),3===e.nodeType?e.parentNode:e}var Se=null,xe=null,Ee=null;function _e(e){if(e=bl(e)){if("function"!==typeof Se)throw Error(a(280));var n=e.stateNode;n&&(n=wl(n),Se(e.stateNode,e.type,n))}}function Ce(e){xe?Ee?Ee.push(e):Ee=[e]:xe=e}function Pe(){if(xe){var e=xe,n=Ee;if(Ee=xe=null,_e(e),n)for(e=0;e>>=0,0===e?32:31-(un(e)/sn|0)|0},un=Math.log,sn=Math.LN2;var cn=64,fn=4194304;function dn(e){switch(e&-e){case 1:return 1;case 2:return 2;case 4:return 4;case 8:return 8;case 16:return 16;case 32:return 32;case 64:case 128:case 256:case 512:case 1024:case 2048:case 4096:case 8192:case 16384:case 32768:case 65536:case 131072:case 262144:case 524288:case 1048576:case 2097152:return 4194240&e;case 4194304:case 8388608:case 16777216:case 33554432:case 67108864:return 130023424&e;case 134217728:return 134217728;case 268435456:return 268435456;case 536870912:return 536870912;case 1073741824:return 1073741824;default:return e}}function pn(e,n){var t=e.pendingLanes;if(0===t)return 0;var r=0,l=e.suspendedLanes,a=e.pingedLanes,o=268435455&t;if(0!==o){var u=o&~l;0!==u?r=dn(u):0!==(a&=o)&&(r=dn(a))}else 0!==(o=t&~l)?r=dn(o):0!==a&&(r=dn(a));if(0===r)return 0;if(0!==n&&n!==r&&0===(n&l)&&((l=r&-r)>=(a=n&-n)||16===l&&0!==(4194240&a)))return n;if(0!==(4&r)&&(r|=16&t),0!==(n=e.entangledLanes))for(e=e.entanglements,n&=r;0t;t++)n.push(e);return n}function yn(e,n,t){e.pendingLanes|=n,536870912!==n&&(e.suspendedLanes=0,e.pingedLanes=0),(e=e.eventTimes)[n=31-on(n)]=t}function bn(e,n){var t=e.entangledLanes|=n;for(e=e.entanglements;t;){var r=31-on(t),l=1<=Ft),Ut=String.fromCharCode(32),jt=!1;function At(e,n){switch(e){case"keyup":return-1!==Rt.indexOf(n.keyCode);case"keydown":return 229!==n.keyCode;case"keypress":case"mousedown":case"focusout":return!0;default:return!1}}function Vt(e){return"object"===typeof(e=e.detail)&&"data"in e?e.data:null}var $t=!1;var Bt={color:!0,date:!0,datetime:!0,"datetime-local":!0,email:!0,month:!0,number:!0,password:!0,range:!0,search:!0,tel:!0,text:!0,time:!0,url:!0,week:!0};function Ht(e){var n=e&&e.nodeName&&e.nodeName.toLowerCase();return"input"===n?!!Bt[e.type]:"textarea"===n}function Wt(e,n,t,r){Ce(r),0<(n=Qr(n,"onChange")).length&&(t=new ct("onChange","change",null,t,r),e.push({event:t,listeners:n}))}var Qt=null,qt=null;function Kt(e){Ur(e,0)}function Yt(e){if(q(kl(e)))return e}function Xt(e,n){if("change"===e)return n}var Gt=!1;if(c){var Zt;if(c){var Jt="oninput"in document;if(!Jt){var er=document.createElement("div");er.setAttribute("oninput","return;"),Jt="function"===typeof er.oninput}Zt=Jt}else Zt=!1;Gt=Zt&&(!document.documentMode||9=n)return{node:r,offset:n-e};e=t}e:{for(;r;){if(r.nextSibling){r=r.nextSibling;break e}r=r.parentNode}r=void 0}r=sr(r)}}function fr(e,n){return!(!e||!n)&&(e===n||(!e||3!==e.nodeType)&&(n&&3===n.nodeType?fr(e,n.parentNode):"contains"in e?e.contains(n):!!e.compareDocumentPosition&&!!(16&e.compareDocumentPosition(n))))}function dr(){for(var e=window,n=K();n instanceof e.HTMLIFrameElement;){try{var t="string"===typeof n.contentWindow.location.href}catch(r){t=!1}if(!t)break;n=K((e=n.contentWindow).document)}return n}function pr(e){var n=e&&e.nodeName&&e.nodeName.toLowerCase();return n&&("input"===n&&("text"===e.type||"search"===e.type||"tel"===e.type||"url"===e.type||"password"===e.type)||"textarea"===n||"true"===e.contentEditable)}function mr(e){var n=dr(),t=e.focusedElem,r=e.selectionRange;if(n!==t&&t&&t.ownerDocument&&fr(t.ownerDocument.documentElement,t)){if(null!==r&&pr(t))if(n=r.start,void 0===(e=r.end)&&(e=n),"selectionStart"in t)t.selectionStart=n,t.selectionEnd=Math.min(e,t.value.length);else if((e=(n=t.ownerDocument||document)&&n.defaultView||window).getSelection){e=e.getSelection();var l=t.textContent.length,a=Math.min(r.start,l);r=void 0===r.end?a:Math.min(r.end,l),!e.extend&&a>r&&(l=r,r=a,a=l),l=cr(t,a);var o=cr(t,r);l&&o&&(1!==e.rangeCount||e.anchorNode!==l.node||e.anchorOffset!==l.offset||e.focusNode!==o.node||e.focusOffset!==o.offset)&&((n=n.createRange()).setStart(l.node,l.offset),e.removeAllRanges(),a>r?(e.addRange(n),e.extend(o.node,o.offset)):(n.setEnd(o.node,o.offset),e.addRange(n)))}for(n=[],e=t;e=e.parentNode;)1===e.nodeType&&n.push({element:e,left:e.scrollLeft,top:e.scrollTop});for("function"===typeof t.focus&&t.focus(),t=0;t=document.documentMode,vr=null,gr=null,yr=null,br=!1;function kr(e,n,t){var r=t.window===t?t.document:9===t.nodeType?t:t.ownerDocument;br||null==vr||vr!==K(r)||("selectionStart"in(r=vr)&&pr(r)?r={start:r.selectionStart,end:r.selectionEnd}:r={anchorNode:(r=(r.ownerDocument&&r.ownerDocument.defaultView||window).getSelection()).anchorNode,anchorOffset:r.anchorOffset,focusNode:r.focusNode,focusOffset:r.focusOffset},yr&&ir(yr,r)||(yr=r,0<(r=Qr(gr,"onSelect")).length&&(n=new ct("onSelect","select",null,n,t),e.push({event:n,listeners:r}),n.target=vr)))}function wr(e,n){var t={};return t[e.toLowerCase()]=n.toLowerCase(),t["Webkit"+e]="webkit"+n,t["Moz"+e]="moz"+n,t}var Sr={animationend:wr("Animation","AnimationEnd"),animationiteration:wr("Animation","AnimationIteration"),animationstart:wr("Animation","AnimationStart"),transitionend:wr("Transition","TransitionEnd")},xr={},Er={};function _r(e){if(xr[e])return xr[e];if(!Sr[e])return e;var n,t=Sr[e];for(n in t)if(t.hasOwnProperty(n)&&n in Er)return xr[e]=t[n];return e}c&&(Er=document.createElement("div").style,"AnimationEvent"in window||(delete Sr.animationend.animation,delete Sr.animationiteration.animation,delete Sr.animationstart.animation),"TransitionEvent"in window||delete Sr.transitionend.transition);var Cr=_r("animationend"),Pr=_r("animationiteration"),Nr=_r("animationstart"),zr=_r("transitionend"),Tr=new Map,Lr="abort auxClick cancel canPlay canPlayThrough click close contextMenu copy cut drag dragEnd dragEnter dragExit dragLeave dragOver dragStart drop durationChange emptied encrypted ended error gotPointerCapture input invalid keyDown keyPress keyUp load loadedData loadedMetadata loadStart lostPointerCapture mouseDown mouseMove mouseOut mouseOver mouseUp paste pause play playing pointerCancel pointerDown pointerMove pointerOut pointerOver pointerUp progress rateChange reset resize seeked seeking stalled submit suspend timeUpdate touchCancel touchEnd touchStart volumeChange scroll toggle touchMove waiting wheel".split(" ");function Or(e,n){Tr.set(e,n),i(n,[e])}for(var Rr=0;Rrxl||(e.current=Sl[xl],Sl[xl]=null,xl--)}function Cl(e,n){xl++,Sl[xl]=e.current,e.current=n}var Pl={},Nl=El(Pl),zl=El(!1),Tl=Pl;function Ll(e,n){var t=e.type.contextTypes;if(!t)return Pl;var r=e.stateNode;if(r&&r.__reactInternalMemoizedUnmaskedChildContext===n)return r.__reactInternalMemoizedMaskedChildContext;var l,a={};for(l in t)a[l]=n[l];return r&&((e=e.stateNode).__reactInternalMemoizedUnmaskedChildContext=n,e.__reactInternalMemoizedMaskedChildContext=a),a}function Ol(e){return null!==(e=e.childContextTypes)&&void 0!==e}function Rl(){_l(zl),_l(Nl)}function Ml(e,n,t){if(Nl.current!==Pl)throw Error(a(168));Cl(Nl,n),Cl(zl,t)}function Fl(e,n,t){var r=e.stateNode;if(n=n.childContextTypes,"function"!==typeof r.getChildContext)return t;for(var l in r=r.getChildContext())if(!(l in n))throw Error(a(108,B(e)||"Unknown",l));return I({},t,r)}function Dl(e){return e=(e=e.stateNode)&&e.__reactInternalMemoizedMergedChildContext||Pl,Tl=Nl.current,Cl(Nl,e),Cl(zl,zl.current),!0}function Il(e,n,t){var r=e.stateNode;if(!r)throw Error(a(169));t?(e=Fl(e,n,Tl),r.__reactInternalMemoizedMergedChildContext=e,_l(zl),_l(Nl),Cl(Nl,e)):_l(zl),Cl(zl,t)}var Ul=null,jl=!1,Al=!1;function Vl(e){null===Ul?Ul=[e]:Ul.push(e)}function $l(){if(!Al&&null!==Ul){Al=!0;var e=0,n=kn;try{var t=Ul;for(kn=1;e>=o,l-=o,Xl=1<<32-on(n)+l|t<h?(v=f,f=null):v=f.sibling;var g=p(l,f,u[h],i);if(null===g){null===f&&(f=v);break}e&&f&&null===g.alternate&&n(l,f),a=o(g,a,h),null===c?s=g:c.sibling=g,c=g,f=v}if(h===u.length)return t(l,f),la&&Zl(l,h),s;if(null===f){for(;hv?(g=h,h=null):g=h.sibling;var b=p(l,h,y.value,s);if(null===b){null===h&&(h=g);break}e&&h&&null===b.alternate&&n(l,h),u=o(b,u,v),null===f?c=b:f.sibling=b,f=b,h=g}if(y.done)return t(l,h),la&&Zl(l,v),c;if(null===h){for(;!y.done;v++,y=i.next())null!==(y=d(l,y.value,s))&&(u=o(y,u,v),null===f?c=y:f.sibling=y,f=y);return la&&Zl(l,v),c}for(h=r(l,h);!y.done;v++,y=i.next())null!==(y=m(h,l,v,y.value,s))&&(e&&null!==y.alternate&&h.delete(null===y.key?v:y.key),u=o(y,u,v),null===f?c=y:f.sibling=y,f=y);return e&&h.forEach(function(e){return n(l,e)}),la&&Zl(l,v),c}return function e(r,a,o,i){if("object"===typeof o&&null!==o&&o.type===x&&null===o.key&&(o=o.props.children),"object"===typeof o&&null!==o){switch(o.$$typeof){case w:e:{for(var s=o.key,c=a;null!==c;){if(c.key===s){if((s=o.type)===x){if(7===c.tag){t(r,c.sibling),(a=l(c,o.props.children)).return=r,r=a;break e}}else if(c.elementType===s||"object"===typeof s&&null!==s&&s.$$typeof===O&&ya(s)===c.type){t(r,c.sibling),(a=l(c,o.props)).ref=va(r,c,o),a.return=r,r=a;break e}t(r,c);break}n(r,c),c=c.sibling}o.type===x?((a=Ms(o.props.children,r.mode,i,o.key)).return=r,r=a):((i=Rs(o.type,o.key,o.props,null,r.mode,i)).ref=va(r,a,o),i.return=r,r=i)}return u(r);case S:e:{for(c=o.key;null!==a;){if(a.key===c){if(4===a.tag&&a.stateNode.containerInfo===o.containerInfo&&a.stateNode.implementation===o.implementation){t(r,a.sibling),(a=l(a,o.children||[])).return=r,r=a;break e}t(r,a);break}n(r,a),a=a.sibling}(a=Is(o,r.mode,i)).return=r,r=a}return u(r);case O:return e(r,a,(c=o._init)(o._payload),i)}if(ne(o))return h(r,a,o,i);if(F(o))return v(r,a,o,i);ga(r,o)}return"string"===typeof o&&""!==o||"number"===typeof o?(o=""+o,null!==a&&6===a.tag?(t(r,a.sibling),(a=l(a,o)).return=r,r=a):(t(r,a),(a=Ds(o,r.mode,i)).return=r,r=a),u(r)):t(r,a)}}var ka=ba(!0),wa=ba(!1),Sa=El(null),xa=null,Ea=null,_a=null;function Ca(){_a=Ea=xa=null}function Pa(e){var n=Sa.current;_l(Sa),e._currentValue=n}function Na(e,n,t){for(;null!==e;){var r=e.alternate;if((e.childLanes&n)!==n?(e.childLanes|=n,null!==r&&(r.childLanes|=n)):null!==r&&(r.childLanes&n)!==n&&(r.childLanes|=n),e===t)break;e=e.return}}function za(e,n){xa=e,_a=Ea=null,null!==(e=e.dependencies)&&null!==e.firstContext&&(0!==(e.lanes&n)&&(bu=!0),e.firstContext=null)}function Ta(e){var n=e._currentValue;if(_a!==e)if(e={context:e,memoizedValue:n,next:null},null===Ea){if(null===xa)throw Error(a(308));Ea=e,xa.dependencies={lanes:0,firstContext:e}}else Ea=Ea.next=e;return n}var La=null;function Oa(e){null===La?La=[e]:La.push(e)}function Ra(e,n,t,r){var l=n.interleaved;return null===l?(t.next=t,Oa(n)):(t.next=l.next,l.next=t),n.interleaved=t,Ma(e,r)}function Ma(e,n){e.lanes|=n;var t=e.alternate;for(null!==t&&(t.lanes|=n),t=e,e=e.return;null!==e;)e.childLanes|=n,null!==(t=e.alternate)&&(t.childLanes|=n),t=e,e=e.return;return 3===t.tag?t.stateNode:null}var Fa=!1;function Da(e){e.updateQueue={baseState:e.memoizedState,firstBaseUpdate:null,lastBaseUpdate:null,shared:{pending:null,interleaved:null,lanes:0},effects:null}}function Ia(e,n){e=e.updateQueue,n.updateQueue===e&&(n.updateQueue={baseState:e.baseState,firstBaseUpdate:e.firstBaseUpdate,lastBaseUpdate:e.lastBaseUpdate,shared:e.shared,effects:e.effects})}function Ua(e,n){return{eventTime:e,lane:n,tag:0,payload:null,callback:null,next:null}}function ja(e,n,t){var r=e.updateQueue;if(null===r)return null;if(r=r.shared,0!==(2&Pi)){var l=r.pending;return null===l?n.next=n:(n.next=l.next,l.next=n),r.pending=n,Ma(e,t)}return null===(l=r.interleaved)?(n.next=n,Oa(r)):(n.next=l.next,l.next=n),r.interleaved=n,Ma(e,t)}function Aa(e,n,t){if(null!==(n=n.updateQueue)&&(n=n.shared,0!==(4194240&t))){var r=n.lanes;t|=r&=e.pendingLanes,n.lanes=t,bn(e,t)}}function Va(e,n){var t=e.updateQueue,r=e.alternate;if(null!==r&&t===(r=r.updateQueue)){var l=null,a=null;if(null!==(t=t.firstBaseUpdate)){do{var o={eventTime:t.eventTime,lane:t.lane,tag:t.tag,payload:t.payload,callback:t.callback,next:null};null===a?l=a=o:a=a.next=o,t=t.next}while(null!==t);null===a?l=a=n:a=a.next=n}else l=a=n;return t={baseState:r.baseState,firstBaseUpdate:l,lastBaseUpdate:a,shared:r.shared,effects:r.effects},void(e.updateQueue=t)}null===(e=t.lastBaseUpdate)?t.firstBaseUpdate=n:e.next=n,t.lastBaseUpdate=n}function $a(e,n,t,r){var l=e.updateQueue;Fa=!1;var a=l.firstBaseUpdate,o=l.lastBaseUpdate,u=l.shared.pending;if(null!==u){l.shared.pending=null;var i=u,s=i.next;i.next=null,null===o?a=s:o.next=s,o=i;var c=e.alternate;null!==c&&((u=(c=c.updateQueue).lastBaseUpdate)!==o&&(null===u?c.firstBaseUpdate=s:u.next=s,c.lastBaseUpdate=i))}if(null!==a){var f=l.baseState;for(o=0,c=s=i=null,u=a;;){var d=u.lane,p=u.eventTime;if((r&d)===d){null!==c&&(c=c.next={eventTime:p,lane:0,tag:u.tag,payload:u.payload,callback:u.callback,next:null});e:{var m=e,h=u;switch(d=n,p=t,h.tag){case 1:if("function"===typeof(m=h.payload)){f=m.call(p,f,d);break e}f=m;break e;case 3:m.flags=-65537&m.flags|128;case 0:if(null===(d="function"===typeof(m=h.payload)?m.call(p,f,d):m)||void 0===d)break e;f=I({},f,d);break e;case 2:Fa=!0}}null!==u.callback&&0!==u.lane&&(e.flags|=64,null===(d=l.effects)?l.effects=[u]:d.push(u))}else p={eventTime:p,lane:d,tag:u.tag,payload:u.payload,callback:u.callback,next:null},null===c?(s=c=p,i=f):c=c.next=p,o|=d;if(null===(u=u.next)){if(null===(u=l.shared.pending))break;u=(d=u).next,d.next=null,l.lastBaseUpdate=d,l.shared.pending=null}}if(null===c&&(i=f),l.baseState=i,l.firstBaseUpdate=s,l.lastBaseUpdate=c,null!==(n=l.shared.interleaved)){l=n;do{o|=l.lane,l=l.next}while(l!==n)}else null===a&&(l.shared.lanes=0);Fi|=o,e.lanes=o,e.memoizedState=f}}function Ba(e,n,t){if(e=n.effects,n.effects=null,null!==e)for(n=0;nt?t:4,e(!0);var r=lo.transition;lo.transition={};try{e(!1),n()}finally{kn=t,lo.transition=r}}function Qo(){return bo().memoizedState}function qo(e,n,t){var r=es(e);if(t={lane:r,action:t,hasEagerState:!1,eagerState:null,next:null},Yo(e))Xo(n,t);else if(null!==(t=Ra(e,n,t,r))){ns(t,e,r,Ji()),Go(t,n,r)}}function Ko(e,n,t){var r=es(e),l={lane:r,action:t,hasEagerState:!1,eagerState:null,next:null};if(Yo(e))Xo(n,l);else{var a=e.alternate;if(0===e.lanes&&(null===a||0===a.lanes)&&null!==(a=n.lastRenderedReducer))try{var o=n.lastRenderedState,u=a(o,t);if(l.hasEagerState=!0,l.eagerState=u,ur(u,o)){var i=n.interleaved;return null===i?(l.next=l,Oa(n)):(l.next=i.next,i.next=l),void(n.interleaved=l)}}catch(s){}null!==(t=Ra(e,n,l,r))&&(ns(t,e,r,l=Ji()),Go(t,n,r))}}function Yo(e){var n=e.alternate;return e===oo||null!==n&&n===oo}function Xo(e,n){co=so=!0;var t=e.pending;null===t?n.next=n:(n.next=t.next,t.next=n),e.pending=n}function Go(e,n,t){if(0!==(4194240&t)){var r=n.lanes;t|=r&=e.pendingLanes,n.lanes=t,bn(e,t)}}var Zo={readContext:Ta,useCallback:mo,useContext:mo,useEffect:mo,useImperativeHandle:mo,useInsertionEffect:mo,useLayoutEffect:mo,useMemo:mo,useReducer:mo,useRef:mo,useState:mo,useDebugValue:mo,useDeferredValue:mo,useTransition:mo,useMutableSource:mo,useSyncExternalStore:mo,useId:mo,unstable_isNewReconciler:!1},Jo={readContext:Ta,useCallback:function(e,n){return yo().memoizedState=[e,void 0===n?null:n],e},useContext:Ta,useEffect:Fo,useImperativeHandle:function(e,n,t){return t=null!==t&&void 0!==t?t.concat([e]):null,Ro(4194308,4,jo.bind(null,n,e),t)},useLayoutEffect:function(e,n){return Ro(4194308,4,e,n)},useInsertionEffect:function(e,n){return Ro(4,2,e,n)},useMemo:function(e,n){var t=yo();return n=void 0===n?null:n,e=e(),t.memoizedState=[e,n],e},useReducer:function(e,n,t){var r=yo();return n=void 0!==t?t(n):n,r.memoizedState=r.baseState=n,e={pending:null,interleaved:null,lanes:0,dispatch:null,lastRenderedReducer:e,lastRenderedState:n},r.queue=e,e=e.dispatch=qo.bind(null,oo,e),[r.memoizedState,e]},useRef:function(e){return e={current:e},yo().memoizedState=e},useState:To,useDebugValue:Vo,useDeferredValue:function(e){return yo().memoizedState=e},useTransition:function(){var e=To(!1),n=e[0];return e=Wo.bind(null,e[1]),yo().memoizedState=e,[n,e]},useMutableSource:function(){},useSyncExternalStore:function(e,n,t){var r=oo,l=yo();if(la){if(void 0===t)throw Error(a(407));t=t()}else{if(t=n(),null===Ni)throw Error(a(349));0!==(30&ao)||_o(r,n,t)}l.memoizedState=t;var o={value:t,getSnapshot:n};return l.queue=o,Fo(Po.bind(null,r,o,e),[e]),r.flags|=2048,Lo(9,Co.bind(null,r,o,t,n),void 0,null),t},useId:function(){var e=yo(),n=Ni.identifierPrefix;if(la){var t=Gl;n=":"+n+"R"+(t=(Xl&~(1<<32-on(Xl)-1)).toString(32)+t),0<(t=fo++)&&(n+="H"+t.toString(32)),n+=":"}else n=":"+n+"r"+(t=po++).toString(32)+":";return e.memoizedState=n},unstable_isNewReconciler:!1},eu={readContext:Ta,useCallback:$o,useContext:Ta,useEffect:Do,useImperativeHandle:Ao,useInsertionEffect:Io,useLayoutEffect:Uo,useMemo:Bo,useReducer:wo,useRef:Oo,useState:function(){return wo(ko)},useDebugValue:Vo,useDeferredValue:function(e){return Ho(bo(),uo.memoizedState,e)},useTransition:function(){return[wo(ko)[0],bo().memoizedState]},useMutableSource:xo,useSyncExternalStore:Eo,useId:Qo,unstable_isNewReconciler:!1},nu={readContext:Ta,useCallback:$o,useContext:Ta,useEffect:Do,useImperativeHandle:Ao,useInsertionEffect:Io,useLayoutEffect:Uo,useMemo:Bo,useReducer:So,useRef:Oo,useState:function(){return So(ko)},useDebugValue:Vo,useDeferredValue:function(e){var n=bo();return null===uo?n.memoizedState=e:Ho(n,uo.memoizedState,e)},useTransition:function(){return[So(ko)[0],bo().memoizedState]},useMutableSource:xo,useSyncExternalStore:Eo,useId:Qo,unstable_isNewReconciler:!1};function tu(e,n){if(e&&e.defaultProps){for(var t in n=I({},n),e=e.defaultProps)void 0===n[t]&&(n[t]=e[t]);return n}return n}function ru(e,n,t,r){t=null===(t=t(r,n=e.memoizedState))||void 0===t?n:I({},n,t),e.memoizedState=t,0===e.lanes&&(e.updateQueue.baseState=t)}var lu={isMounted:function(e){return!!(e=e._reactInternals)&&$e(e)===e},enqueueSetState:function(e,n,t){e=e._reactInternals;var r=Ji(),l=es(e),a=Ua(r,l);a.payload=n,void 0!==t&&null!==t&&(a.callback=t),null!==(n=ja(e,a,l))&&(ns(n,e,l,r),Aa(n,e,l))},enqueueReplaceState:function(e,n,t){e=e._reactInternals;var r=Ji(),l=es(e),a=Ua(r,l);a.tag=1,a.payload=n,void 0!==t&&null!==t&&(a.callback=t),null!==(n=ja(e,a,l))&&(ns(n,e,l,r),Aa(n,e,l))},enqueueForceUpdate:function(e,n){e=e._reactInternals;var t=Ji(),r=es(e),l=Ua(t,r);l.tag=2,void 0!==n&&null!==n&&(l.callback=n),null!==(n=ja(e,l,r))&&(ns(n,e,r,t),Aa(n,e,r))}};function au(e,n,t,r,l,a,o){return"function"===typeof(e=e.stateNode).shouldComponentUpdate?e.shouldComponentUpdate(r,a,o):!n.prototype||!n.prototype.isPureReactComponent||(!ir(t,r)||!ir(l,a))}function ou(e,n,t){var r=!1,l=Pl,a=n.contextType;return"object"===typeof a&&null!==a?a=Ta(a):(l=Ol(n)?Tl:Nl.current,a=(r=null!==(r=n.contextTypes)&&void 0!==r)?Ll(e,l):Pl),n=new n(t,a),e.memoizedState=null!==n.state&&void 0!==n.state?n.state:null,n.updater=lu,e.stateNode=n,n._reactInternals=e,r&&((e=e.stateNode).__reactInternalMemoizedUnmaskedChildContext=l,e.__reactInternalMemoizedMaskedChildContext=a),n}function uu(e,n,t,r){e=n.state,"function"===typeof n.componentWillReceiveProps&&n.componentWillReceiveProps(t,r),"function"===typeof n.UNSAFE_componentWillReceiveProps&&n.UNSAFE_componentWillReceiveProps(t,r),n.state!==e&&lu.enqueueReplaceState(n,n.state,null)}function iu(e,n,t,r){var l=e.stateNode;l.props=t,l.state=e.memoizedState,l.refs={},Da(e);var a=n.contextType;"object"===typeof a&&null!==a?l.context=Ta(a):(a=Ol(n)?Tl:Nl.current,l.context=Ll(e,a)),l.state=e.memoizedState,"function"===typeof(a=n.getDerivedStateFromProps)&&(ru(e,n,a,t),l.state=e.memoizedState),"function"===typeof n.getDerivedStateFromProps||"function"===typeof l.getSnapshotBeforeUpdate||"function"!==typeof l.UNSAFE_componentWillMount&&"function"!==typeof l.componentWillMount||(n=l.state,"function"===typeof l.componentWillMount&&l.componentWillMount(),"function"===typeof l.UNSAFE_componentWillMount&&l.UNSAFE_componentWillMount(),n!==l.state&&lu.enqueueReplaceState(l,l.state,null),$a(e,t,l,r),l.state=e.memoizedState),"function"===typeof l.componentDidMount&&(e.flags|=4194308)}function su(e,n){try{var t="",r=n;do{t+=V(r),r=r.return}while(r);var l=t}catch(a){l="\nError generating stack: "+a.message+"\n"+a.stack}return{value:e,source:n,stack:l,digest:null}}function cu(e,n,t){return{value:e,source:null,stack:null!=t?t:null,digest:null!=n?n:null}}function fu(e,n){try{console.error(n.value)}catch(t){setTimeout(function(){throw t})}}var du="function"===typeof WeakMap?WeakMap:Map;function pu(e,n,t){(t=Ua(-1,t)).tag=3,t.payload={element:null};var r=n.value;return t.callback=function(){Bi||(Bi=!0,Hi=r),fu(0,n)},t}function mu(e,n,t){(t=Ua(-1,t)).tag=3;var r=e.type.getDerivedStateFromError;if("function"===typeof r){var l=n.value;t.payload=function(){return r(l)},t.callback=function(){fu(0,n)}}var a=e.stateNode;return null!==a&&"function"===typeof a.componentDidCatch&&(t.callback=function(){fu(0,n),"function"!==typeof r&&(null===Wi?Wi=new Set([this]):Wi.add(this));var e=n.stack;this.componentDidCatch(n.value,{componentStack:null!==e?e:""})}),t}function hu(e,n,t){var r=e.pingCache;if(null===r){r=e.pingCache=new du;var l=new Set;r.set(n,l)}else void 0===(l=r.get(n))&&(l=new Set,r.set(n,l));l.has(t)||(l.add(t),e=Es.bind(null,e,n,t),n.then(e,e))}function vu(e){do{var n;if((n=13===e.tag)&&(n=null===(n=e.memoizedState)||null!==n.dehydrated),n)return e;e=e.return}while(null!==e);return null}function gu(e,n,t,r,l){return 0===(1&e.mode)?(e===n?e.flags|=65536:(e.flags|=128,t.flags|=131072,t.flags&=-52805,1===t.tag&&(null===t.alternate?t.tag=17:((n=Ua(-1,1)).tag=2,ja(t,n,1))),t.lanes|=1),e):(e.flags|=65536,e.lanes=l,e)}var yu=k.ReactCurrentOwner,bu=!1;function ku(e,n,t,r){n.child=null===e?wa(n,null,t,r):ka(n,e.child,t,r)}function wu(e,n,t,r,l){t=t.render;var a=n.ref;return za(n,l),r=vo(e,n,t,r,a,l),t=go(),null===e||bu?(la&&t&&ea(n),n.flags|=1,ku(e,n,r,l),n.child):(n.updateQueue=e.updateQueue,n.flags&=-2053,e.lanes&=~l,Bu(e,n,l))}function Su(e,n,t,r,l){if(null===e){var a=t.type;return"function"!==typeof a||Ls(a)||void 0!==a.defaultProps||null!==t.compare||void 0!==t.defaultProps?((e=Rs(t.type,null,r,n,n.mode,l)).ref=n.ref,e.return=n,n.child=e):(n.tag=15,n.type=a,xu(e,n,a,r,l))}if(a=e.child,0===(e.lanes&l)){var o=a.memoizedProps;if((t=null!==(t=t.compare)?t:ir)(o,r)&&e.ref===n.ref)return Bu(e,n,l)}return n.flags|=1,(e=Os(a,r)).ref=n.ref,e.return=n,n.child=e}function xu(e,n,t,r,l){if(null!==e){var a=e.memoizedProps;if(ir(a,r)&&e.ref===n.ref){if(bu=!1,n.pendingProps=r=a,0===(e.lanes&l))return n.lanes=e.lanes,Bu(e,n,l);0!==(131072&e.flags)&&(bu=!0)}}return Cu(e,n,t,r,l)}function Eu(e,n,t){var r=n.pendingProps,l=r.children,a=null!==e?e.memoizedState:null;if("hidden"===r.mode)if(0===(1&n.mode))n.memoizedState={baseLanes:0,cachePool:null,transitions:null},Cl(Oi,Li),Li|=t;else{if(0===(1073741824&t))return e=null!==a?a.baseLanes|t:t,n.lanes=n.childLanes=1073741824,n.memoizedState={baseLanes:e,cachePool:null,transitions:null},n.updateQueue=null,Cl(Oi,Li),Li|=e,null;n.memoizedState={baseLanes:0,cachePool:null,transitions:null},r=null!==a?a.baseLanes:t,Cl(Oi,Li),Li|=r}else null!==a?(r=a.baseLanes|t,n.memoizedState=null):r=t,Cl(Oi,Li),Li|=r;return ku(e,n,l,t),n.child}function _u(e,n){var t=n.ref;(null===e&&null!==t||null!==e&&e.ref!==t)&&(n.flags|=512,n.flags|=2097152)}function Cu(e,n,t,r,l){var a=Ol(t)?Tl:Nl.current;return a=Ll(n,a),za(n,l),t=vo(e,n,t,r,a,l),r=go(),null===e||bu?(la&&r&&ea(n),n.flags|=1,ku(e,n,t,l),n.child):(n.updateQueue=e.updateQueue,n.flags&=-2053,e.lanes&=~l,Bu(e,n,l))}function Pu(e,n,t,r,l){if(Ol(t)){var a=!0;Dl(n)}else a=!1;if(za(n,l),null===n.stateNode)$u(e,n),ou(n,t,r),iu(n,t,r,l),r=!0;else if(null===e){var o=n.stateNode,u=n.memoizedProps;o.props=u;var i=o.context,s=t.contextType;"object"===typeof s&&null!==s?s=Ta(s):s=Ll(n,s=Ol(t)?Tl:Nl.current);var c=t.getDerivedStateFromProps,f="function"===typeof c||"function"===typeof o.getSnapshotBeforeUpdate;f||"function"!==typeof o.UNSAFE_componentWillReceiveProps&&"function"!==typeof o.componentWillReceiveProps||(u!==r||i!==s)&&uu(n,o,r,s),Fa=!1;var d=n.memoizedState;o.state=d,$a(n,r,o,l),i=n.memoizedState,u!==r||d!==i||zl.current||Fa?("function"===typeof c&&(ru(n,t,c,r),i=n.memoizedState),(u=Fa||au(n,t,u,r,d,i,s))?(f||"function"!==typeof o.UNSAFE_componentWillMount&&"function"!==typeof o.componentWillMount||("function"===typeof o.componentWillMount&&o.componentWillMount(),"function"===typeof o.UNSAFE_componentWillMount&&o.UNSAFE_componentWillMount()),"function"===typeof o.componentDidMount&&(n.flags|=4194308)):("function"===typeof o.componentDidMount&&(n.flags|=4194308),n.memoizedProps=r,n.memoizedState=i),o.props=r,o.state=i,o.context=s,r=u):("function"===typeof o.componentDidMount&&(n.flags|=4194308),r=!1)}else{o=n.stateNode,Ia(e,n),u=n.memoizedProps,s=n.type===n.elementType?u:tu(n.type,u),o.props=s,f=n.pendingProps,d=o.context,"object"===typeof(i=t.contextType)&&null!==i?i=Ta(i):i=Ll(n,i=Ol(t)?Tl:Nl.current);var p=t.getDerivedStateFromProps;(c="function"===typeof p||"function"===typeof o.getSnapshotBeforeUpdate)||"function"!==typeof o.UNSAFE_componentWillReceiveProps&&"function"!==typeof o.componentWillReceiveProps||(u!==f||d!==i)&&uu(n,o,r,i),Fa=!1,d=n.memoizedState,o.state=d,$a(n,r,o,l);var m=n.memoizedState;u!==f||d!==m||zl.current||Fa?("function"===typeof p&&(ru(n,t,p,r),m=n.memoizedState),(s=Fa||au(n,t,s,r,d,m,i)||!1)?(c||"function"!==typeof o.UNSAFE_componentWillUpdate&&"function"!==typeof o.componentWillUpdate||("function"===typeof o.componentWillUpdate&&o.componentWillUpdate(r,m,i),"function"===typeof o.UNSAFE_componentWillUpdate&&o.UNSAFE_componentWillUpdate(r,m,i)),"function"===typeof o.componentDidUpdate&&(n.flags|=4),"function"===typeof o.getSnapshotBeforeUpdate&&(n.flags|=1024)):("function"!==typeof o.componentDidUpdate||u===e.memoizedProps&&d===e.memoizedState||(n.flags|=4),"function"!==typeof o.getSnapshotBeforeUpdate||u===e.memoizedProps&&d===e.memoizedState||(n.flags|=1024),n.memoizedProps=r,n.memoizedState=m),o.props=r,o.state=m,o.context=i,r=s):("function"!==typeof o.componentDidUpdate||u===e.memoizedProps&&d===e.memoizedState||(n.flags|=4),"function"!==typeof o.getSnapshotBeforeUpdate||u===e.memoizedProps&&d===e.memoizedState||(n.flags|=1024),r=!1)}return Nu(e,n,t,r,a,l)}function Nu(e,n,t,r,l,a){_u(e,n);var o=0!==(128&n.flags);if(!r&&!o)return l&&Il(n,t,!1),Bu(e,n,a);r=n.stateNode,yu.current=n;var u=o&&"function"!==typeof t.getDerivedStateFromError?null:r.render();return n.flags|=1,null!==e&&o?(n.child=ka(n,e.child,null,a),n.child=ka(n,null,u,a)):ku(e,n,u,a),n.memoizedState=r.state,l&&Il(n,t,!0),n.child}function zu(e){var n=e.stateNode;n.pendingContext?Ml(0,n.pendingContext,n.pendingContext!==n.context):n.context&&Ml(0,n.context,!1),Ya(e,n.containerInfo)}function Tu(e,n,t,r,l){return pa(),ma(l),n.flags|=256,ku(e,n,t,r),n.child}var Lu,Ou,Ru,Mu={dehydrated:null,treeContext:null,retryLane:0};function Fu(e){return{baseLanes:e,cachePool:null,transitions:null}}function Du(e,n,t){var r,l=n.pendingProps,o=Ja.current,u=!1,i=0!==(128&n.flags);if((r=i)||(r=(null===e||null!==e.memoizedState)&&0!==(2&o)),r?(u=!0,n.flags&=-129):null!==e&&null===e.memoizedState||(o|=1),Cl(Ja,1&o),null===e)return sa(n),null!==(e=n.memoizedState)&&null!==(e=e.dehydrated)?(0===(1&n.mode)?n.lanes=1:"$!"===e.data?n.lanes=8:n.lanes=1073741824,null):(i=l.children,e=l.fallback,u?(l=n.mode,u=n.child,i={mode:"hidden",children:i},0===(1&l)&&null!==u?(u.childLanes=0,u.pendingProps=i):u=Fs(i,l,0,null),e=Ms(e,l,t,null),u.return=n,e.return=n,u.sibling=e,n.child=u,n.child.memoizedState=Fu(t),n.memoizedState=Mu,e):Iu(n,i));if(null!==(o=e.memoizedState)&&null!==(r=o.dehydrated))return function(e,n,t,r,l,o,u){if(t)return 256&n.flags?(n.flags&=-257,Uu(e,n,u,r=cu(Error(a(422))))):null!==n.memoizedState?(n.child=e.child,n.flags|=128,null):(o=r.fallback,l=n.mode,r=Fs({mode:"visible",children:r.children},l,0,null),(o=Ms(o,l,u,null)).flags|=2,r.return=n,o.return=n,r.sibling=o,n.child=r,0!==(1&n.mode)&&ka(n,e.child,null,u),n.child.memoizedState=Fu(u),n.memoizedState=Mu,o);if(0===(1&n.mode))return Uu(e,n,u,null);if("$!"===l.data){if(r=l.nextSibling&&l.nextSibling.dataset)var i=r.dgst;return r=i,Uu(e,n,u,r=cu(o=Error(a(419)),r,void 0))}if(i=0!==(u&e.childLanes),bu||i){if(null!==(r=Ni)){switch(u&-u){case 4:l=2;break;case 16:l=8;break;case 64:case 128:case 256:case 512:case 1024:case 2048:case 4096:case 8192:case 16384:case 32768:case 65536:case 131072:case 262144:case 524288:case 1048576:case 2097152:case 4194304:case 8388608:case 16777216:case 33554432:case 67108864:l=32;break;case 536870912:l=268435456;break;default:l=0}0!==(l=0!==(l&(r.suspendedLanes|u))?0:l)&&l!==o.retryLane&&(o.retryLane=l,Ma(e,l),ns(r,e,l,-1))}return ms(),Uu(e,n,u,r=cu(Error(a(421))))}return"$?"===l.data?(n.flags|=128,n.child=e.child,n=Cs.bind(null,e),l._reactRetry=n,null):(e=o.treeContext,ra=sl(l.nextSibling),ta=n,la=!0,aa=null,null!==e&&(ql[Kl++]=Xl,ql[Kl++]=Gl,ql[Kl++]=Yl,Xl=e.id,Gl=e.overflow,Yl=n),n=Iu(n,r.children),n.flags|=4096,n)}(e,n,i,l,r,o,t);if(u){u=l.fallback,i=n.mode,r=(o=e.child).sibling;var s={mode:"hidden",children:l.children};return 0===(1&i)&&n.child!==o?((l=n.child).childLanes=0,l.pendingProps=s,n.deletions=null):(l=Os(o,s)).subtreeFlags=14680064&o.subtreeFlags,null!==r?u=Os(r,u):(u=Ms(u,i,t,null)).flags|=2,u.return=n,l.return=n,l.sibling=u,n.child=l,l=u,u=n.child,i=null===(i=e.child.memoizedState)?Fu(t):{baseLanes:i.baseLanes|t,cachePool:null,transitions:i.transitions},u.memoizedState=i,u.childLanes=e.childLanes&~t,n.memoizedState=Mu,l}return e=(u=e.child).sibling,l=Os(u,{mode:"visible",children:l.children}),0===(1&n.mode)&&(l.lanes=t),l.return=n,l.sibling=null,null!==e&&(null===(t=n.deletions)?(n.deletions=[e],n.flags|=16):t.push(e)),n.child=l,n.memoizedState=null,l}function Iu(e,n){return(n=Fs({mode:"visible",children:n},e.mode,0,null)).return=e,e.child=n}function Uu(e,n,t,r){return null!==r&&ma(r),ka(n,e.child,null,t),(e=Iu(n,n.pendingProps.children)).flags|=2,n.memoizedState=null,e}function ju(e,n,t){e.lanes|=n;var r=e.alternate;null!==r&&(r.lanes|=n),Na(e.return,n,t)}function Au(e,n,t,r,l){var a=e.memoizedState;null===a?e.memoizedState={isBackwards:n,rendering:null,renderingStartTime:0,last:r,tail:t,tailMode:l}:(a.isBackwards=n,a.rendering=null,a.renderingStartTime=0,a.last=r,a.tail=t,a.tailMode=l)}function Vu(e,n,t){var r=n.pendingProps,l=r.revealOrder,a=r.tail;if(ku(e,n,r.children,t),0!==(2&(r=Ja.current)))r=1&r|2,n.flags|=128;else{if(null!==e&&0!==(128&e.flags))e:for(e=n.child;null!==e;){if(13===e.tag)null!==e.memoizedState&&ju(e,t,n);else if(19===e.tag)ju(e,t,n);else if(null!==e.child){e.child.return=e,e=e.child;continue}if(e===n)break e;for(;null===e.sibling;){if(null===e.return||e.return===n)break e;e=e.return}e.sibling.return=e.return,e=e.sibling}r&=1}if(Cl(Ja,r),0===(1&n.mode))n.memoizedState=null;else switch(l){case"forwards":for(t=n.child,l=null;null!==t;)null!==(e=t.alternate)&&null===eo(e)&&(l=t),t=t.sibling;null===(t=l)?(l=n.child,n.child=null):(l=t.sibling,t.sibling=null),Au(n,!1,l,t,a);break;case"backwards":for(t=null,l=n.child,n.child=null;null!==l;){if(null!==(e=l.alternate)&&null===eo(e)){n.child=l;break}e=l.sibling,l.sibling=t,t=l,l=e}Au(n,!0,t,null,a);break;case"together":Au(n,!1,null,null,void 0);break;default:n.memoizedState=null}return n.child}function $u(e,n){0===(1&n.mode)&&null!==e&&(e.alternate=null,n.alternate=null,n.flags|=2)}function Bu(e,n,t){if(null!==e&&(n.dependencies=e.dependencies),Fi|=n.lanes,0===(t&n.childLanes))return null;if(null!==e&&n.child!==e.child)throw Error(a(153));if(null!==n.child){for(t=Os(e=n.child,e.pendingProps),n.child=t,t.return=n;null!==e.sibling;)e=e.sibling,(t=t.sibling=Os(e,e.pendingProps)).return=n;t.sibling=null}return n.child}function Hu(e,n){if(!la)switch(e.tailMode){case"hidden":n=e.tail;for(var t=null;null!==n;)null!==n.alternate&&(t=n),n=n.sibling;null===t?e.tail=null:t.sibling=null;break;case"collapsed":t=e.tail;for(var r=null;null!==t;)null!==t.alternate&&(r=t),t=t.sibling;null===r?n||null===e.tail?e.tail=null:e.tail.sibling=null:r.sibling=null}}function Wu(e){var n=null!==e.alternate&&e.alternate.child===e.child,t=0,r=0;if(n)for(var l=e.child;null!==l;)t|=l.lanes|l.childLanes,r|=14680064&l.subtreeFlags,r|=14680064&l.flags,l.return=e,l=l.sibling;else for(l=e.child;null!==l;)t|=l.lanes|l.childLanes,r|=l.subtreeFlags,r|=l.flags,l.return=e,l=l.sibling;return e.subtreeFlags|=r,e.childLanes=t,n}function Qu(e,n,t){var r=n.pendingProps;switch(na(n),n.tag){case 2:case 16:case 15:case 0:case 11:case 7:case 8:case 12:case 9:case 14:return Wu(n),null;case 1:case 17:return Ol(n.type)&&Rl(),Wu(n),null;case 3:return r=n.stateNode,Xa(),_l(zl),_l(Nl),to(),r.pendingContext&&(r.context=r.pendingContext,r.pendingContext=null),null!==e&&null!==e.child||(fa(n)?n.flags|=4:null===e||e.memoizedState.isDehydrated&&0===(256&n.flags)||(n.flags|=1024,null!==aa&&(as(aa),aa=null))),Wu(n),null;case 5:Za(n);var l=Ka(qa.current);if(t=n.type,null!==e&&null!=n.stateNode)Ou(e,n,t,r),e.ref!==n.ref&&(n.flags|=512,n.flags|=2097152);else{if(!r){if(null===n.stateNode)throw Error(a(166));return Wu(n),null}if(e=Ka(Wa.current),fa(n)){r=n.stateNode,t=n.type;var o=n.memoizedProps;switch(r[dl]=n,r[pl]=o,e=0!==(1&n.mode),t){case"dialog":jr("cancel",r),jr("close",r);break;case"iframe":case"object":case"embed":jr("load",r);break;case"video":case"audio":for(l=0;l<\/script>",e=e.removeChild(e.firstChild)):"string"===typeof r.is?e=i.createElement(t,{is:r.is}):(e=i.createElement(t),"select"===t&&(i=e,r.multiple?i.multiple=!0:r.size&&(i.size=r.size))):e=i.createElementNS(e,t),e[dl]=n,e[pl]=r,Lu(e,n),n.stateNode=e;e:{switch(i=be(t,r),t){case"dialog":jr("cancel",e),jr("close",e),l=r;break;case"iframe":case"object":case"embed":jr("load",e),l=r;break;case"video":case"audio":for(l=0;lVi&&(n.flags|=128,r=!0,Hu(o,!1),n.lanes=4194304)}else{if(!r)if(null!==(e=eo(i))){if(n.flags|=128,r=!0,null!==(t=e.updateQueue)&&(n.updateQueue=t,n.flags|=4),Hu(o,!0),null===o.tail&&"hidden"===o.tailMode&&!i.alternate&&!la)return Wu(n),null}else 2*Ge()-o.renderingStartTime>Vi&&1073741824!==t&&(n.flags|=128,r=!0,Hu(o,!1),n.lanes=4194304);o.isBackwards?(i.sibling=n.child,n.child=i):(null!==(t=o.last)?t.sibling=i:n.child=i,o.last=i)}return null!==o.tail?(n=o.tail,o.rendering=n,o.tail=n.sibling,o.renderingStartTime=Ge(),n.sibling=null,t=Ja.current,Cl(Ja,r?1&t|2:1&t),n):(Wu(n),null);case 22:case 23:return cs(),r=null!==n.memoizedState,null!==e&&null!==e.memoizedState!==r&&(n.flags|=8192),r&&0!==(1&n.mode)?0!==(1073741824&Li)&&(Wu(n),6&n.subtreeFlags&&(n.flags|=8192)):Wu(n),null;case 24:case 25:return null}throw Error(a(156,n.tag))}function qu(e,n){switch(na(n),n.tag){case 1:return Ol(n.type)&&Rl(),65536&(e=n.flags)?(n.flags=-65537&e|128,n):null;case 3:return Xa(),_l(zl),_l(Nl),to(),0!==(65536&(e=n.flags))&&0===(128&e)?(n.flags=-65537&e|128,n):null;case 5:return Za(n),null;case 13:if(_l(Ja),null!==(e=n.memoizedState)&&null!==e.dehydrated){if(null===n.alternate)throw Error(a(340));pa()}return 65536&(e=n.flags)?(n.flags=-65537&e|128,n):null;case 19:return _l(Ja),null;case 4:return Xa(),null;case 10:return Pa(n.type._context),null;case 22:case 23:return cs(),null;default:return null}}Lu=function(e,n){for(var t=n.child;null!==t;){if(5===t.tag||6===t.tag)e.appendChild(t.stateNode);else if(4!==t.tag&&null!==t.child){t.child.return=t,t=t.child;continue}if(t===n)break;for(;null===t.sibling;){if(null===t.return||t.return===n)return;t=t.return}t.sibling.return=t.return,t=t.sibling}},Ou=function(e,n,t,r){var l=e.memoizedProps;if(l!==r){e=n.stateNode,Ka(Wa.current);var a,o=null;switch(t){case"input":l=Y(e,l),r=Y(e,r),o=[];break;case"select":l=I({},l,{value:void 0}),r=I({},r,{value:void 0}),o=[];break;case"textarea":l=re(e,l),r=re(e,r),o=[];break;default:"function"!==typeof l.onClick&&"function"===typeof r.onClick&&(e.onclick=Jr)}for(c in ye(t,r),t=null,l)if(!r.hasOwnProperty(c)&&l.hasOwnProperty(c)&&null!=l[c])if("style"===c){var i=l[c];for(a in i)i.hasOwnProperty(a)&&(t||(t={}),t[a]="")}else"dangerouslySetInnerHTML"!==c&&"children"!==c&&"suppressContentEditableWarning"!==c&&"suppressHydrationWarning"!==c&&"autoFocus"!==c&&(u.hasOwnProperty(c)?o||(o=[]):(o=o||[]).push(c,null));for(c in r){var s=r[c];if(i=null!=l?l[c]:void 0,r.hasOwnProperty(c)&&s!==i&&(null!=s||null!=i))if("style"===c)if(i){for(a in i)!i.hasOwnProperty(a)||s&&s.hasOwnProperty(a)||(t||(t={}),t[a]="");for(a in s)s.hasOwnProperty(a)&&i[a]!==s[a]&&(t||(t={}),t[a]=s[a])}else t||(o||(o=[]),o.push(c,t)),t=s;else"dangerouslySetInnerHTML"===c?(s=s?s.__html:void 0,i=i?i.__html:void 0,null!=s&&i!==s&&(o=o||[]).push(c,s)):"children"===c?"string"!==typeof s&&"number"!==typeof s||(o=o||[]).push(c,""+s):"suppressContentEditableWarning"!==c&&"suppressHydrationWarning"!==c&&(u.hasOwnProperty(c)?(null!=s&&"onScroll"===c&&jr("scroll",e),o||i===s||(o=[])):(o=o||[]).push(c,s))}t&&(o=o||[]).push("style",t);var c=o;(n.updateQueue=c)&&(n.flags|=4)}},Ru=function(e,n,t,r){t!==r&&(n.flags|=4)};var Ku=!1,Yu=!1,Xu="function"===typeof WeakSet?WeakSet:Set,Gu=null;function Zu(e,n){var t=e.ref;if(null!==t)if("function"===typeof t)try{t(null)}catch(r){xs(e,n,r)}else t.current=null}function Ju(e,n,t){try{t()}catch(r){xs(e,n,r)}}var ei=!1;function ni(e,n,t){var r=n.updateQueue;if(null!==(r=null!==r?r.lastEffect:null)){var l=r=r.next;do{if((l.tag&e)===e){var a=l.destroy;l.destroy=void 0,void 0!==a&&Ju(n,t,a)}l=l.next}while(l!==r)}}function ti(e,n){if(null!==(n=null!==(n=n.updateQueue)?n.lastEffect:null)){var t=n=n.next;do{if((t.tag&e)===e){var r=t.create;t.destroy=r()}t=t.next}while(t!==n)}}function ri(e){var n=e.ref;if(null!==n){var t=e.stateNode;e.tag,e=t,"function"===typeof n?n(e):n.current=e}}function li(e){var n=e.alternate;null!==n&&(e.alternate=null,li(n)),e.child=null,e.deletions=null,e.sibling=null,5===e.tag&&(null!==(n=e.stateNode)&&(delete n[dl],delete n[pl],delete n[hl],delete n[vl],delete n[gl])),e.stateNode=null,e.return=null,e.dependencies=null,e.memoizedProps=null,e.memoizedState=null,e.pendingProps=null,e.stateNode=null,e.updateQueue=null}function ai(e){return 5===e.tag||3===e.tag||4===e.tag}function oi(e){e:for(;;){for(;null===e.sibling;){if(null===e.return||ai(e.return))return null;e=e.return}for(e.sibling.return=e.return,e=e.sibling;5!==e.tag&&6!==e.tag&&18!==e.tag;){if(2&e.flags)continue e;if(null===e.child||4===e.tag)continue e;e.child.return=e,e=e.child}if(!(2&e.flags))return e.stateNode}}function ui(e,n,t){var r=e.tag;if(5===r||6===r)e=e.stateNode,n?8===t.nodeType?t.parentNode.insertBefore(e,n):t.insertBefore(e,n):(8===t.nodeType?(n=t.parentNode).insertBefore(e,t):(n=t).appendChild(e),null!==(t=t._reactRootContainer)&&void 0!==t||null!==n.onclick||(n.onclick=Jr));else if(4!==r&&null!==(e=e.child))for(ui(e,n,t),e=e.sibling;null!==e;)ui(e,n,t),e=e.sibling}function ii(e,n,t){var r=e.tag;if(5===r||6===r)e=e.stateNode,n?t.insertBefore(e,n):t.appendChild(e);else if(4!==r&&null!==(e=e.child))for(ii(e,n,t),e=e.sibling;null!==e;)ii(e,n,t),e=e.sibling}var si=null,ci=!1;function fi(e,n,t){for(t=t.child;null!==t;)di(e,n,t),t=t.sibling}function di(e,n,t){if(an&&"function"===typeof an.onCommitFiberUnmount)try{an.onCommitFiberUnmount(ln,t)}catch(u){}switch(t.tag){case 5:Yu||Zu(t,n);case 6:var r=si,l=ci;si=null,fi(e,n,t),ci=l,null!==(si=r)&&(ci?(e=si,t=t.stateNode,8===e.nodeType?e.parentNode.removeChild(t):e.removeChild(t)):si.removeChild(t.stateNode));break;case 18:null!==si&&(ci?(e=si,t=t.stateNode,8===e.nodeType?il(e.parentNode,t):1===e.nodeType&&il(e,t),Bn(e)):il(si,t.stateNode));break;case 4:r=si,l=ci,si=t.stateNode.containerInfo,ci=!0,fi(e,n,t),si=r,ci=l;break;case 0:case 11:case 14:case 15:if(!Yu&&(null!==(r=t.updateQueue)&&null!==(r=r.lastEffect))){l=r=r.next;do{var a=l,o=a.destroy;a=a.tag,void 0!==o&&(0!==(2&a)||0!==(4&a))&&Ju(t,n,o),l=l.next}while(l!==r)}fi(e,n,t);break;case 1:if(!Yu&&(Zu(t,n),"function"===typeof(r=t.stateNode).componentWillUnmount))try{r.props=t.memoizedProps,r.state=t.memoizedState,r.componentWillUnmount()}catch(u){xs(t,n,u)}fi(e,n,t);break;case 21:fi(e,n,t);break;case 22:1&t.mode?(Yu=(r=Yu)||null!==t.memoizedState,fi(e,n,t),Yu=r):fi(e,n,t);break;default:fi(e,n,t)}}function pi(e){var n=e.updateQueue;if(null!==n){e.updateQueue=null;var t=e.stateNode;null===t&&(t=e.stateNode=new Xu),n.forEach(function(n){var r=Ps.bind(null,e,n);t.has(n)||(t.add(n),n.then(r,r))})}}function mi(e,n){var t=n.deletions;if(null!==t)for(var r=0;rl&&(l=u),r&=~o}if(r=l,10<(r=(120>(r=Ge()-r)?120:480>r?480:1080>r?1080:1920>r?1920:3e3>r?3e3:4320>r?4320:1960*xi(r/1960))-r)){e.timeoutHandle=rl(ks.bind(null,e,ji,$i),r);break}ks(e,ji,$i);break;default:throw Error(a(329))}}}return ts(e,Ge()),e.callbackNode===t?rs.bind(null,e):null}function ls(e,n){var t=Ui;return e.current.memoizedState.isDehydrated&&(fs(e,n).flags|=256),2!==(e=hs(e,n))&&(n=ji,ji=t,null!==n&&as(n)),e}function as(e){null===ji?ji=e:ji.push.apply(ji,e)}function os(e,n){for(n&=~Ii,n&=~Di,e.suspendedLanes|=n,e.pingedLanes&=~n,e=e.expirationTimes;0e?16:e,null===qi)var r=!1;else{if(e=qi,qi=null,Ki=0,0!==(6&Pi))throw Error(a(331));var l=Pi;for(Pi|=4,Gu=e.current;null!==Gu;){var o=Gu,u=o.child;if(0!==(16&Gu.flags)){var i=o.deletions;if(null!==i){for(var s=0;sGe()-Ai?fs(e,0):Ii|=t),ts(e,n)}function _s(e,n){0===n&&(0===(1&e.mode)?n=1:(n=fn,0===(130023424&(fn<<=1))&&(fn=4194304)));var t=Ji();null!==(e=Ma(e,n))&&(yn(e,n,t),ts(e,t))}function Cs(e){var n=e.memoizedState,t=0;null!==n&&(t=n.retryLane),_s(e,t)}function Ps(e,n){var t=0;switch(e.tag){case 13:var r=e.stateNode,l=e.memoizedState;null!==l&&(t=l.retryLane);break;case 19:r=e.stateNode;break;default:throw Error(a(314))}null!==r&&r.delete(n),_s(e,t)}function Ns(e,n){return qe(e,n)}function zs(e,n,t,r){this.tag=e,this.key=t,this.sibling=this.child=this.return=this.stateNode=this.type=this.elementType=null,this.index=0,this.ref=null,this.pendingProps=n,this.dependencies=this.memoizedState=this.updateQueue=this.memoizedProps=null,this.mode=r,this.subtreeFlags=this.flags=0,this.deletions=null,this.childLanes=this.lanes=0,this.alternate=null}function Ts(e,n,t,r){return new zs(e,n,t,r)}function Ls(e){return!(!(e=e.prototype)||!e.isReactComponent)}function Os(e,n){var t=e.alternate;return null===t?((t=Ts(e.tag,n,e.key,e.mode)).elementType=e.elementType,t.type=e.type,t.stateNode=e.stateNode,t.alternate=e,e.alternate=t):(t.pendingProps=n,t.type=e.type,t.flags=0,t.subtreeFlags=0,t.deletions=null),t.flags=14680064&e.flags,t.childLanes=e.childLanes,t.lanes=e.lanes,t.child=e.child,t.memoizedProps=e.memoizedProps,t.memoizedState=e.memoizedState,t.updateQueue=e.updateQueue,n=e.dependencies,t.dependencies=null===n?null:{lanes:n.lanes,firstContext:n.firstContext},t.sibling=e.sibling,t.index=e.index,t.ref=e.ref,t}function Rs(e,n,t,r,l,o){var u=2;if(r=e,"function"===typeof e)Ls(e)&&(u=1);else if("string"===typeof e)u=5;else e:switch(e){case x:return Ms(t.children,l,o,n);case E:u=8,l|=8;break;case _:return(e=Ts(12,t,n,2|l)).elementType=_,e.lanes=o,e;case z:return(e=Ts(13,t,n,l)).elementType=z,e.lanes=o,e;case T:return(e=Ts(19,t,n,l)).elementType=T,e.lanes=o,e;case R:return Fs(t,l,o,n);default:if("object"===typeof e&&null!==e)switch(e.$$typeof){case C:u=10;break e;case P:u=9;break e;case N:u=11;break e;case L:u=14;break e;case O:u=16,r=null;break e}throw Error(a(130,null==e?e:typeof e,""))}return(n=Ts(u,t,n,l)).elementType=e,n.type=r,n.lanes=o,n}function Ms(e,n,t,r){return(e=Ts(7,e,r,n)).lanes=t,e}function Fs(e,n,t,r){return(e=Ts(22,e,r,n)).elementType=R,e.lanes=t,e.stateNode={isHidden:!1},e}function Ds(e,n,t){return(e=Ts(6,e,null,n)).lanes=t,e}function Is(e,n,t){return(n=Ts(4,null!==e.children?e.children:[],e.key,n)).lanes=t,n.stateNode={containerInfo:e.containerInfo,pendingChildren:null,implementation:e.implementation},n}function Us(e,n,t,r,l){this.tag=n,this.containerInfo=e,this.finishedWork=this.pingCache=this.current=this.pendingChildren=null,this.timeoutHandle=-1,this.callbackNode=this.pendingContext=this.context=null,this.callbackPriority=0,this.eventTimes=gn(0),this.expirationTimes=gn(-1),this.entangledLanes=this.finishedLanes=this.mutableReadLanes=this.expiredLanes=this.pingedLanes=this.suspendedLanes=this.pendingLanes=0,this.entanglements=gn(0),this.identifierPrefix=r,this.onRecoverableError=l,this.mutableSourceEagerHydrationData=null}function js(e,n,t,r,l,a,o,u,i){return e=new Us(e,n,t,u,i),1===n?(n=1,!0===a&&(n|=8)):n=0,a=Ts(3,null,null,n),e.current=a,a.stateNode=e,a.memoizedState={element:r,isDehydrated:t,cache:null,transitions:null,pendingSuspenseBoundaries:null},Da(a),e}function As(e){if(!e)return Pl;e:{if($e(e=e._reactInternals)!==e||1!==e.tag)throw Error(a(170));var n=e;do{switch(n.tag){case 3:n=n.stateNode.context;break e;case 1:if(Ol(n.type)){n=n.stateNode.__reactInternalMemoizedMergedChildContext;break e}}n=n.return}while(null!==n);throw Error(a(171))}if(1===e.tag){var t=e.type;if(Ol(t))return Fl(e,t,n)}return n}function Vs(e,n,t,r,l,a,o,u,i){return(e=js(t,r,!0,e,0,a,0,u,i)).context=As(null),t=e.current,(a=Ua(r=Ji(),l=es(t))).callback=void 0!==n&&null!==n?n:null,ja(t,a,l),e.current.lanes=l,yn(e,l,r),ts(e,r),e}function $s(e,n,t,r){var l=n.current,a=Ji(),o=es(l);return t=As(t),null===n.context?n.context=t:n.pendingContext=t,(n=Ua(a,o)).payload={element:e},null!==(r=void 0===r?null:r)&&(n.callback=r),null!==(e=ja(l,n,o))&&(ns(e,l,o,a),Aa(e,l,o)),o}function Bs(e){return(e=e.current).child?(e.child.tag,e.child.stateNode):null}function Hs(e,n){if(null!==(e=e.memoizedState)&&null!==e.dehydrated){var t=e.retryLane;e.retryLane=0!==t&&t>>1,l=e[r];if(!(0>>1;ra(i,t))sa(c,i)?(e[r]=c,e[s]=t,r=s):(e[r]=i,e[u]=t,r=u);else{if(!(sa(c,t)))break e;e[r]=c,e[s]=t,r=s}}}return n}function a(e,n){var t=e.sortIndex-n.sortIndex;return 0!==t?t:e.id-n.id}if("object"===typeof performance&&"function"===typeof performance.now){var o=performance;n.unstable_now=function(){return o.now()}}else{var u=Date,i=u.now();n.unstable_now=function(){return u.now()-i}}var s=[],c=[],f=1,d=null,p=3,m=!1,h=!1,v=!1,g="function"===typeof setTimeout?setTimeout:null,y="function"===typeof clearTimeout?clearTimeout:null,b="undefined"!==typeof setImmediate?setImmediate:null;function k(e){for(var n=r(c);null!==n;){if(null===n.callback)l(c);else{if(!(n.startTime<=e))break;l(c),n.sortIndex=n.expirationTime,t(s,n)}n=r(c)}}function w(e){if(v=!1,k(e),!h)if(null!==r(s))h=!0,R(S);else{var n=r(c);null!==n&&M(w,n.startTime-e)}}function S(e,t){h=!1,v&&(v=!1,y(C),C=-1),m=!0;var a=p;try{for(k(t),d=r(s);null!==d&&(!(d.expirationTime>t)||e&&!z());){var o=d.callback;if("function"===typeof o){d.callback=null,p=d.priorityLevel;var u=o(d.expirationTime<=t);t=n.unstable_now(),"function"===typeof u?d.callback=u:d===r(s)&&l(s),k(t)}else l(s);d=r(s)}if(null!==d)var i=!0;else{var f=r(c);null!==f&&M(w,f.startTime-t),i=!1}return i}finally{d=null,p=a,m=!1}}"undefined"!==typeof navigator&&void 0!==navigator.scheduling&&void 0!==navigator.scheduling.isInputPending&&navigator.scheduling.isInputPending.bind(navigator.scheduling);var x,E=!1,_=null,C=-1,P=5,N=-1;function z(){return!(n.unstable_now()-Ne||125o?(e.sortIndex=a,t(c,e),null===r(s)&&e===r(c)&&(v?(y(C),C=-1):v=!0,M(w,a-o))):(e.sortIndex=u,t(s,e),h||m||(h=!0,R(S))),e},n.unstable_shouldYield=z,n.unstable_wrapCallback=function(e){var n=p;return function(){var t=p;p=n;try{return e.apply(this,arguments)}finally{p=t}}}},340(e,n,t){e.exports=t(761)}};const n={};function t(r){const l=n[r];if(void 0!==l)return l.exports;const a=n[r]={exports:{}};return e[r].call(a.exports,a,a.exports,t),a.exports}t.m=e,(()=>{const e=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__;let n;t.t=function(r,l){if(1&l&&(r=this(r)),8&l)return r;if("object"===typeof r&&r){if(4&l&&r.__esModule)return r;if(16&l&&"function"===typeof r.then)return r}const a=Object.create(null);t.r(a);const o={};n=n||[null,e({}),e([]),e(e)];for(var u=2&l&&r;("object"==typeof u||"function"==typeof u)&&!~n.indexOf(u);u=e(u))Object.getOwnPropertyNames(u).forEach(e=>o[e]=()=>r[e]);return o.default=()=>r,t.d(a,o),a}})(),t.d=(e,n)=>{if(Array.isArray(n))for(var r=0;rPromise.all(Object.keys(t.f).reduce((n,r)=>(t.f[r](e,n),n),[])),t.u=e=>"static/js/"+e+"."+{221:"0fc95064",810:"16fb44d2"}[e]+".chunk.js",t.miniCssF=e=>{},t.o=(e,n)=>Object.prototype.hasOwnProperty.call(e,n),(()=>{const e={},n="bot-virus-browser-verification-page:";t.l=(r,l,a,o)=>{if(e[r])return void e[r].push(l);let u,i;if(void 0!==a){const e=document.getElementsByTagName("script");for(var s=0;s{u.onerror=u.onload=null,clearTimeout(f);const l=e[r];if(delete e[r],u.parentNode&&u.parentNode.removeChild(u),l&&l.forEach(e=>e(t)),n)return n(t)},f=setTimeout(c.bind(null,void 0,{type:"timeout",target:u}),12e4);u.onerror=c.bind(null,u.onerror),u.onload=c.bind(null,u.onload),i&&document.head.appendChild(u)}})(),t.r=e=>{Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.p="/",(()=>{const e={792:0};t.f.j=(n,r)=>{let l=t.o(e,n)?e[n]:void 0;if(0!==l)if(l)r.push(l[2]);else{const a=new Promise((t,r)=>l=e[n]=[t,r]);r.push(l[2]=a);const o=t.p+t.u(n),u=new Error,i=r=>{if(t.o(e,n)&&(l=e[n],0!==l&&(e[n]=void 0),l)){const e=r&&("load"===r.type?"missing":r.type),t=r&&r.target&&r.target.src;u.message="Loading chunk "+n+" failed.\n("+e+": "+t+")",u.name="ChunkLoadError",u.type=e,u.request=t,l[1](u)}};t.l(o,i,"chunk-"+n,n)}};const n=(n,r)=>{let[l,a,o]=r;var u,i,s=0;if(l.some(n=>0!==e[n])){for(u in a)t.o(a,u)&&(t.m[u]=a[u]);if(o)o(t)}for(n&&n(r);s(window.BVCollector=e.default||e,t.e(810).then(t.t.bind(t,810,23)))).catch(e=>{const n=document.getElementById("status");n&&(n.textContent="Verification unavailable"),console.error("[BV] runtime failed to load:",e)})})();
\ No newline at end of file
diff --git a/src/bv_challenge/challenge/templates/html/static/js/main.35a65fc2.js.LICENSE.txt b/src/bv_challenge/challenge/templates/html/static/js/main.35a65fc2.js.LICENSE.txt
new file mode 100644
index 0000000..a253b5a
--- /dev/null
+++ b/src/bv_challenge/challenge/templates/html/static/js/main.35a65fc2.js.LICENSE.txt
@@ -0,0 +1,39 @@
+/**
+ * @license React
+ * react-dom.production.min.js
+ *
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * @license React
+ * react-jsx-runtime.production.min.js
+ *
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * @license React
+ * react.production.min.js
+ *
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * @license React
+ * scheduler.production.min.js
+ *
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
diff --git a/src/modules/__init__.py b/src/modules/__init__.py
deleted file mode 100644
index e69de29..0000000
diff --git a/src/modules/rest.mdm-sn-container-runner b/src/modules/rest.mdm-sn-container-runner
new file mode 160000
index 0000000..f724a1a
--- /dev/null
+++ b/src/modules/rest.mdm-sn-container-runner
@@ -0,0 +1 @@
+Subproject commit f724a1a94d4618f3bac712770bb328fa61d8e9f0
diff --git a/tests/test_eval_crypto.py b/tests/test_eval_crypto.py
new file mode 100644
index 0000000..78b55ba
--- /dev/null
+++ b/tests/test_eval_crypto.py
@@ -0,0 +1,130 @@
+"""Wire-format contract for the browser-side /_eval submission.
+
+The SDK encrypts the payload in the browser with a hybrid scheme and POSTs it to
+/_eval as ``{"error": {"data": "::::"}}``. The server
+decrypts it with the private ``vault_unlock`` wheel. This test pins that wire
+format: it builds a blob exactly the way the JS SDK does (RSA-OAEP-SHA256 for the
+AES key and IV, AES-256-CBC/PKCS7 for the body, base64 parts joined by ``::``)
+and asserts the real decryptor recovers the plaintext.
+
+If ``vault_unlock`` is not installed (local dev / CI without the private wheel),
+the round trip is verified against the public ``cryptography`` decryptor instead,
+so the format contract is still enforced.
+"""
+
+import os
+import json
+import base64
+
+import pytest
+from cryptography.hazmat.primitives.asymmetric import rsa, padding
+from cryptography.hazmat.primitives import serialization, hashes
+from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
+from cryptography.hazmat.primitives.padding import PKCS7
+
+import re
+
+# Must match api/core/constants/_regex.py ALPHANUM_CUSTOM_REGEX.
+_DATA_REGEX = re.compile(r"^[0-9a-zA-Z_\-:+/=]+$")
+
+
+def _gen_keypair():
+ priv = rsa.generate_private_key(public_exponent=65537, key_size=2048)
+ priv_pem = priv.private_bytes(
+ serialization.Encoding.PEM,
+ serialization.PrivateFormat.PKCS8,
+ serialization.NoEncryption(),
+ ).decode()
+ return priv, priv_pem
+
+
+def _sdk_style_encrypt(plaintext: str, public_key) -> str:
+ """Replicate the JS SDK's hybrid encryption -> '::::'."""
+ aes_key = os.urandom(32)
+ iv = os.urandom(16)
+
+ _padder = PKCS7(128).padder()
+ _padded = _padder.update(plaintext.encode()) + _padder.finalize()
+ _enc = Cipher(algorithms.AES(aes_key), modes.CBC(iv)).encryptor()
+ _ct = _enc.update(_padded) + _enc.finalize()
+
+ def _rsa(data: bytes) -> bytes:
+ return public_key.encrypt(
+ data,
+ padding.OAEP(
+ mgf=padding.MGF1(algorithm=hashes.SHA256()),
+ algorithm=hashes.SHA256(),
+ label=None,
+ ),
+ )
+
+ _b64 = lambda b: base64.b64encode(b).decode()
+ return "::".join((_b64(_rsa(aes_key)), _b64(_rsa(iv)), _b64(_ct)))
+
+
+def _payload() -> dict:
+ return {
+ "schemaVersion": "bv-runtime-1",
+ "sessionId": "sess-1",
+ "movements": [],
+ "clicks": [],
+ "mouseDowns": [],
+ "mouseUps": [],
+ "keydowns": [],
+ "keyups": [],
+ "scroll": [],
+ "browserInfo": {"userAgent": "Chrome", "webdriver": False},
+ "automation": {"webdriver": False},
+ "sessionBinding": {"nonce": "nonce-abc123"},
+ }
+
+
+def test_blob_charset_is_eval_compatible() -> None:
+ priv, _ = _gen_keypair()
+ blob = _sdk_style_encrypt(json.dumps(_payload()), priv.public_key())
+ assert _DATA_REGEX.match(blob), "blob must match the /_eval data charset"
+ assert blob.count("::") == 2, "blob must be encKey::encIv::cipherText"
+
+
+def test_vault_unlock_decrypts_sdk_style_blob() -> None:
+ vault_unlock = pytest.importorskip(
+ "vault_unlock", reason="private vault_unlock wheel not installed"
+ )
+ priv, priv_pem = _gen_keypair()
+ original = _payload()
+ blob = _sdk_style_encrypt(json.dumps(original), priv.public_key())
+
+ plaintext = vault_unlock.decrypt_payload(
+ encrypted_text=blob, private_key_pem=priv_pem
+ )
+ assert json.loads(plaintext) == original
+
+
+def test_public_crypto_round_trip_matches() -> None:
+ # Format contract enforced even without the private wheel.
+ priv, _ = _gen_keypair()
+ original = _payload()
+ blob = _sdk_style_encrypt(json.dumps(original), priv.public_key())
+
+ enc_key_b64, enc_iv_b64, ct_b64 = blob.split("::")
+
+ def _rsa_dec(data: bytes) -> bytes:
+ return priv.decrypt(
+ data,
+ padding.OAEP(
+ mgf=padding.MGF1(algorithm=hashes.SHA256()),
+ algorithm=hashes.SHA256(),
+ label=None,
+ ),
+ )
+
+ aes_key = _rsa_dec(base64.b64decode(enc_key_b64))
+ iv = _rsa_dec(base64.b64decode(enc_iv_b64))
+ assert len(aes_key) == 32 and len(iv) == 16
+
+ _dec = Cipher(algorithms.AES(aes_key), modes.CBC(iv)).decryptor()
+ _padded = _dec.update(base64.b64decode(ct_b64)) + _dec.finalize()
+ _unpadder = PKCS7(128).unpadder()
+ plaintext = (_unpadder.update(_padded) + _unpadder.finalize()).decode()
+
+ assert json.loads(plaintext) == original
diff --git a/tests/test_eval_runner.py b/tests/test_eval_runner.py
new file mode 100644
index 0000000..fea2fc8
--- /dev/null
+++ b/tests/test_eval_runner.py
@@ -0,0 +1,251 @@
+"""Service-level tests for /_eval attribution + /score orchestration.
+
+These exercise the framework-free core extracted into ``eval_runner`` together
+with the real ``RunStore``, so the concurrency/attribution behavior is covered
+without the global TaskManager, FastAPI, config, or the crypto/detector wheels.
+
+Covered: duplicate callbacks, out-of-order callbacks, unattributable payloads,
+stale/late callbacks from a previous run, runner failure, timeout padding, and
+score aggregation.
+"""
+
+import pytest
+
+from src.bv_challenge.challenge.api.endpoints.challenge import eval_runner
+from src.bv_challenge.challenge.api.endpoints.challenge.eval_runner import (
+ EvalOutcome,
+ process_eval,
+ run_scoring,
+)
+from src.bv_challenge.challenge.api.endpoints.challenge.session_store import RunStore
+
+
+# --------------------------------------------------------------------------- #
+# Test crypto stub: a payload "encrypted" for a session is "|".
+# Only the matching private key decrypts it; every other key raises -- mirroring
+# real per-session RSA trial-decryption without the wheel.
+# --------------------------------------------------------------------------- #
+def _encrypt(private_key: str, body: str = '{"ok": true}') -> str:
+ return f"{private_key}|{body}"
+
+
+def _decrypt(ciphertext: str, private_key: str) -> str:
+ tag, sep, body = ciphertext.partition("|")
+ if not sep or tag != private_key:
+ raise ValueError("wrong key")
+ return body
+
+
+def _const_score(value: float):
+ return lambda _data: value
+
+
+def _make_store(*sessions) -> RunStore:
+ # sessions: (session_id, private_key) pairs.
+ return RunStore.create("run", list(sessions))
+
+
+# ----------------------------- process_eval -------------------------------- #
+def test_attributes_and_records_by_trial_decryption() -> None:
+ store = _make_store(("a", "ka"), ("b", "kb"))
+
+ outcome = process_eval(
+ store, _encrypt("kb"), decrypt_fn=_decrypt, score_fn=_const_score(0.7)
+ )
+
+ assert outcome == EvalOutcome(status="recorded", session_id="b", score=0.7)
+ assert store.get_score("b") == 0.7
+ assert store.get_score("a") is None # untouched
+
+
+def test_out_of_order_callbacks_each_attributed_correctly() -> None:
+ store = _make_store(("a", "ka"), ("b", "kb"), ("c", "kc"))
+
+ # Arrive c, a, b -- order independent.
+ for sid, score in (("kc", 0.3), ("ka", 0.9), ("kb", 0.6)):
+ process_eval(
+ store, _encrypt(sid), decrypt_fn=_decrypt, score_fn=_const_score(score)
+ )
+
+ assert store.get_score("a") == 0.9
+ assert store.get_score("b") == 0.6
+ assert store.get_score("c") == 0.3
+ assert store.completed_count() == 3
+
+
+def test_duplicate_callback_is_ignored_and_not_recounted() -> None:
+ store = _make_store(("a", "ka"))
+ first = process_eval(
+ store, _encrypt("ka"), decrypt_fn=_decrypt, score_fn=_const_score(0.8)
+ )
+ assert first.status == "recorded"
+
+ # Same session reports again with a different score -> ignored, original kept.
+ second = process_eval(
+ store, _encrypt("ka"), decrypt_fn=_decrypt, score_fn=_const_score(0.1)
+ )
+ assert second == EvalOutcome(status="duplicate", session_id="a")
+ assert store.get_score("a") == 0.8
+ assert store.completed_count() == 1
+
+
+def test_duplicate_does_not_invoke_scorer() -> None:
+ store = _make_store(("a", "ka"))
+ process_eval(store, _encrypt("ka"), decrypt_fn=_decrypt, score_fn=_const_score(0.5))
+
+ def _boom(_data):
+ raise AssertionError("scorer must not run for a duplicate callback")
+
+ outcome = process_eval(store, _encrypt("ka"), decrypt_fn=_decrypt, score_fn=_boom)
+ assert outcome.status == "duplicate"
+
+
+def test_unattributable_payload_is_ignored_and_consumes_nothing() -> None:
+ store = _make_store(("a", "ka"), ("b", "kb"))
+
+ # Encrypted for a key not in this run (garbage/tampered/wrong key).
+ outcome = process_eval(
+ store, _encrypt("kZ"), decrypt_fn=_decrypt, score_fn=_const_score(0.9)
+ )
+
+ assert outcome == EvalOutcome(status="unattributable")
+ # No session was consumed or charged.
+ assert store.completed_count() == 0
+ assert store.get_score("a") is None
+ assert store.get_score("b") is None
+
+
+def test_malformed_ciphertext_is_unattributable() -> None:
+ store = _make_store(("a", "ka"))
+ outcome = process_eval(
+ store, "not-a-valid-ciphertext", decrypt_fn=_decrypt, score_fn=_const_score(1.0)
+ )
+ assert outcome.status == "unattributable"
+ assert store.completed_count() == 0
+
+
+def test_stale_callback_from_previous_run_is_ignored() -> None:
+ # Run 1 completes.
+ run1 = _make_store(("a", "k1a"), ("b", "k1b"))
+ process_eval(run1, _encrypt("k1a"), decrypt_fn=_decrypt, score_fn=_const_score(1.0))
+ run1.finalize(timeout_score=0.0)
+
+ # Run 2 starts with fresh keys; a late callback from run 1 arrives.
+ run2 = _make_store(("a", "k2a"), ("b", "k2b"))
+ outcome = process_eval(
+ run2, _encrypt("k1a"), decrypt_fn=_decrypt, score_fn=_const_score(1.0)
+ )
+
+ # run1's key does not exist in run2 -> unattributable -> ignored.
+ assert outcome.status == "unattributable"
+ assert run2.completed_count() == 0
+
+
+def test_record_race_collapses_to_duplicate() -> None:
+ # A store whose session looks open (is_completed False) but record() loses the
+ # race (returns False) -- the concurrent-callback branch must report duplicate.
+ class _RacyStore:
+ private_keys = {"a": "ka"}
+
+ def is_completed(self, _sid):
+ return False
+
+ def record(self, _sid, _score):
+ return False
+
+ def finalize(self, timeout_score):
+ return 0.0
+
+ outcome = process_eval(
+ _RacyStore(), _encrypt("ka"), decrypt_fn=_decrypt, score_fn=_const_score(0.5)
+ )
+ assert outcome == EvalOutcome(status="duplicate", session_id="a")
+
+
+# ----------------------------- run_scoring --------------------------------- #
+def test_run_scoring_returns_runner_fail_score_and_skips_wait() -> None:
+ store = _make_store(("a", "ka"), ("b", "kb"))
+ waited = []
+
+ def _start():
+ raise RuntimeError("runner down")
+
+ def _wait():
+ waited.append(True)
+
+ score = run_scoring(
+ store=store,
+ start_runner=_start,
+ wait_for_completion=_wait,
+ timeout_score=0.0,
+ runner_fail_score=-1.0,
+ )
+
+ assert score == -1.0
+ assert waited == [] # never waited
+ assert store.completed_count() == 0 # store untouched
+
+
+def test_run_scoring_invokes_on_runner_error() -> None:
+ store = _make_store(("a", "ka"))
+ seen = {}
+
+ run_scoring(
+ store=store,
+ start_runner=lambda: (_ for _ in ()).throw(RuntimeError("boom")),
+ wait_for_completion=lambda: None,
+ timeout_score=0.0,
+ runner_fail_score=0.0,
+ on_runner_error=lambda err: seen.setdefault("err", str(err)),
+ )
+
+ assert seen["err"] == "boom"
+
+
+def test_run_scoring_aggregates_over_expected_with_timeout_padding() -> None:
+ store = _make_store(("a", "ka"), ("b", "kb"), ("c", "kc"))
+
+ def _start():
+ return None
+
+ def _wait():
+ # Two of three sessions report during the wait; "c" never does.
+ process_eval(
+ store, _encrypt("ka"), decrypt_fn=_decrypt, score_fn=_const_score(1.0)
+ )
+ process_eval(
+ store, _encrypt("kb"), decrypt_fn=_decrypt, score_fn=_const_score(0.4)
+ )
+
+ score = run_scoring(
+ store=store,
+ start_runner=_start,
+ wait_for_completion=_wait,
+ timeout_score=0.0,
+ runner_fail_score=0.0,
+ )
+
+ # (1.0 + 0.4 + timeout 0.0) / expected 3
+ assert score == pytest.approx((1.0 + 0.4 + 0.0) / 3)
+ assert store.sessions["c"].timed_out is True
+
+
+def test_run_scoring_full_completion_averages_all() -> None:
+ store = _make_store(("a", "ka"), ("b", "kb"))
+
+ def _wait():
+ process_eval(
+ store, _encrypt("ka"), decrypt_fn=_decrypt, score_fn=_const_score(0.6)
+ )
+ process_eval(
+ store, _encrypt("kb"), decrypt_fn=_decrypt, score_fn=_const_score(0.8)
+ )
+
+ score = run_scoring(
+ store=store,
+ start_runner=lambda: None,
+ wait_for_completion=_wait,
+ timeout_score=0.0,
+ runner_fail_score=0.0,
+ )
+ assert score == pytest.approx((0.6 + 0.8) / 2)
diff --git a/tests/test_scoring.py b/tests/test_scoring.py
new file mode 100644
index 0000000..fad3f87
--- /dev/null
+++ b/tests/test_scoring.py
@@ -0,0 +1,53 @@
+import math
+
+from src.bv_challenge.challenge.api.endpoints.challenge import scoring
+from src.bv_challenge.challenge.api.endpoints.challenge.scoring import (
+ score_with_metrics_processor,
+)
+
+
+def test_score_with_metrics_processor_returns_valid_score() -> None:
+ score = score_with_metrics_processor(
+ {},
+ metrics_processor=lambda data: {"score": "0.72", "score_message": "internal"},
+ )
+
+ assert score == 0.72
+
+
+def test_score_with_metrics_processor_falls_back_on_bad_values() -> None:
+ bad_processors = [
+ lambda data: {},
+ lambda data: {"score": "not-a-number"},
+ lambda data: {"score": math.nan},
+ lambda data: {"score": math.inf},
+ ]
+
+ for processor in bad_processors:
+ assert score_with_metrics_processor({}, metrics_processor=processor) == 0.5
+
+
+def test_score_with_metrics_processor_falls_back_on_exception() -> None:
+ def raises(data: dict) -> dict:
+ raise RuntimeError("boom")
+
+ assert score_with_metrics_processor({}, metrics_processor=raises) == 0.5
+
+
+def test_score_with_metrics_processor_clamps_out_of_range_scores() -> None:
+ assert (
+ score_with_metrics_processor({}, metrics_processor=lambda data: {"score": 1.4})
+ == 1.0
+ )
+ assert (
+ score_with_metrics_processor({}, metrics_processor=lambda data: {"score": -0.2})
+ == 0.0
+ )
+
+
+def test_returns_error_score_when_no_processor_available(monkeypatch) -> None:
+ # Simulates the rt_bv_score wheel being absent: default processor is None,
+ # so the wrapper must fall back to the configured error score.
+ monkeypatch.setattr(scoring, "_default_metrics_processor", None)
+ assert scoring.score_with_metrics_processor({}, error_score=0.5) == 0.5
+
diff --git a/tests/test_scoring_shape.py b/tests/test_scoring_shape.py
new file mode 100644
index 0000000..50fae29
--- /dev/null
+++ b/tests/test_scoring_shape.py
@@ -0,0 +1,93 @@
+"""Tests for the public Layer 1 shape validator.
+
+The validator is intentionally structural only (no thresholds / weights / secret
+heuristics — those live in the private detector). It must accept well-formed
+payloads and reject malformed / tampered ones before they reach the wheel.
+"""
+
+from src.bv_challenge.challenge.api.endpoints.challenge import scoring
+
+
+def _valid_payload() -> dict:
+ return {
+ "movements": [{"x": 1, "y": 2, "t": 3}],
+ "clicks": [],
+ "mouseDowns": [],
+ "mouseUps": [],
+ "keydowns": [{"t": 1}],
+ "keyups": [{"t": 2}],
+ "scroll": [],
+ "browserInfo": {"userAgent": "x", "webdriver": False},
+ "pageTimings": {"pageLoadMs": 800},
+ "eventSequence": [{"type": "click", "t": 1, "pt": 0.5, "trusted": True}],
+ "targets": [],
+ "trustedEventStats": {"click": {"trusted": 1, "untrusted": 0}},
+ "taskProgress": {"usernameFocused": True},
+ }
+
+
+def test_accepts_well_formed_payload() -> None:
+ ok, reason = scoring.validate_shape(_valid_payload())
+ assert ok is True
+ assert reason is None
+
+
+def test_accepts_legacy_counts_only_payload() -> None:
+ # Older payloads without the advanced fields still pass (forward/backward compat).
+ legacy = {k: [] for k in ("movements", "clicks", "mouseDowns", "mouseUps", "keydowns", "keyups", "scroll")}
+ ok, _ = scoring.validate_shape(legacy)
+ assert ok is True
+
+
+def test_accepts_null_browser_info() -> None:
+ payload = _valid_payload()
+ payload["browserInfo"] = None # environment snapshot may be unavailable
+ ok, _ = scoring.validate_shape(payload)
+ assert ok is True
+
+
+def test_rejects_non_dict() -> None:
+ for _bad in ([], "x", 5, None):
+ ok, reason = scoring.validate_shape(_bad)
+ assert ok is False
+ assert reason
+
+
+def test_rejects_missing_required_field() -> None:
+ payload = _valid_payload()
+ del payload["movements"]
+ ok, reason = scoring.validate_shape(payload)
+ assert ok is False
+ assert "movements" in reason
+
+
+def test_rejects_required_field_wrong_type() -> None:
+ payload = _valid_payload()
+ payload["clicks"] = {"not": "a list"}
+ ok, reason = scoring.validate_shape(payload)
+ assert ok is False
+ assert "clicks" in reason
+
+
+def test_rejects_optional_list_field_wrong_type() -> None:
+ payload = _valid_payload()
+ payload["eventSequence"] = "tampered"
+ ok, reason = scoring.validate_shape(payload)
+ assert ok is False
+ assert "eventSequence" in reason
+
+
+def test_rejects_optional_dict_field_wrong_type() -> None:
+ payload = _valid_payload()
+ payload["taskProgress"] = ["nope"]
+ ok, reason = scoring.validate_shape(payload)
+ assert ok is False
+ assert "taskProgress" in reason
+
+
+def test_rejects_non_dict_browser_info() -> None:
+ payload = _valid_payload()
+ payload["browserInfo"] = "tampered"
+ ok, reason = scoring.validate_shape(payload)
+ assert ok is False
+ assert "browserInfo" in reason
diff --git a/tests/test_session_store.py b/tests/test_session_store.py
new file mode 100644
index 0000000..f2cdd10
--- /dev/null
+++ b/tests/test_session_store.py
@@ -0,0 +1,41 @@
+from src.bv_challenge.challenge.api.endpoints.challenge.session_store import RunStore
+
+
+def test_record_once_and_dedup() -> None:
+ store = RunStore.create("run1", [("a", "ka"), ("b", "kb")])
+ assert store.record("a", 0.8) is True
+ assert store.is_completed("a") is True
+ assert store.get_score("a") == 0.8
+
+ # Duplicate: not recorded again, original score preserved.
+ assert store.record("a", 0.1) is False
+ assert store.get_score("a") == 0.8
+ assert store.completed_count() == 1
+
+
+def test_record_unknown_session_is_rejected() -> None:
+ store = RunStore.create("run1", [("a", "ka")])
+ assert store.record("does-not-exist", 0.5) is False
+
+
+def test_finalize_pads_missing_with_timeout_score() -> None:
+ store = RunStore.create("run1", [("a", "ka"), ("b", "kb"), ("c", "kc")])
+ store.record("a", 1.0)
+ store.record("b", 0.5)
+
+ # c never reported -> counts as timeout (0.0), averaged over expected 3.
+ final = store.finalize(timeout_score=0.0)
+ assert final == (1.0 + 0.5 + 0.0) / 3
+ assert store.sessions["c"].timed_out is True
+
+
+def test_finalize_averages_over_expected_not_completed() -> None:
+ store = RunStore.create("run1", [("a", "ka"), ("b", "kb")])
+ store.record("a", 1.0)
+ # 1 of 2 completed -> average over the expected 2, not the 1 completed.
+ assert store.finalize(timeout_score=0.0) == 0.5
+
+
+def test_expected_sessions_tracks_creation() -> None:
+ store = RunStore.create("run1", [("a", "ka"), ("b", "kb")])
+ assert store.expected_sessions == 2
diff --git a/tests/test_web_page.py b/tests/test_web_page.py
new file mode 100644
index 0000000..8d5a563
--- /dev/null
+++ b/tests/test_web_page.py
@@ -0,0 +1,155 @@
+"""Tests for the /_web challenge page and the browser SDK (HBv6 non-behavioral).
+
+HBv6 scores non-behavioral browser/runtime/session integrity only. The page is
+deliberately minimal: it loads the SDK, which collects integrity signals and
+submits the encrypted payload to /_eval from the browser. There are no form
+fields, no verify button, no scroll content, and no behavioral collection.
+
+Two layers:
+ * Python: the /_web route serves the minimal verification page with the
+ config/session globals the SDK needs, and the SDK assets are served by the
+ static mount.
+ * Node: the SDK behaviour (auto-collect + encrypt + submit) is proven by the
+ standalone JS suites under tests/web/, shelled out here so a single
+ `pytest` run covers the whole browser-side flow. Skipped if node is absent.
+"""
+
+import shutil
+import pathlib
+import subprocess
+
+import pytest
+from fastapi.testclient import TestClient
+
+from src.bv_challenge.challenge.api.main import app
+
+client = TestClient(app)
+
+_WEB_DIR = pathlib.Path(__file__).resolve().parents[1] / "tests" / "web"
+
+
+def test_web_page_loads() -> None:
+ _response = client.get("/_web")
+ assert _response.status_code == 200
+ assert "text/html" in _response.headers["content-type"]
+
+
+def test_web_page_is_minimal_verification_page() -> None:
+ _html = client.get("/_web").text
+ # Minimal status page only.
+ assert "Browser verification" in _html
+ assert "Checking browser environment" in _html
+ assert 'id="status"' in _html
+
+
+def test_web_page_has_no_form_or_behavioral_elements() -> None:
+ _html = client.get("/_web").text
+ # No username/password fields, verify button, scroll content, or end button.
+ for _needle in (
+ 'name="username"',
+ 'name="password"',
+ 'id="login-button"',
+ 'id="content"',
+ "end-session",
+ "ACTIONS_LIST",
+ ):
+ assert _needle not in _html, _needle
+
+
+def test_web_page_exposes_minimal_task_config() -> None:
+ _html = client.get("/_web").text
+ assert "window.TASK_CONFIG" in _html
+ # Auto-submit is available and enabled.
+ assert '"/_eval"' in _html
+ assert "autoSubmit: true" in _html
+ assert '"data"' in _html
+ # Behavioral selector contract from the old page must be gone.
+ for _key in (
+ "usernameInput",
+ "passwordInput",
+ "verifyButton",
+ "scrollContainer",
+ "endSessionButton",
+ ):
+ assert _key not in _html, _key
+
+
+def test_web_page_exposes_session_binding_globals() -> None:
+ _html = client.get("/_web").text
+ assert "window.BV_SESSION" in _html
+ for _key in ("sessionId", "nonce", "publicKeyId", "configHash", "schemaVersion"):
+ assert _key in _html, _key
+ # Encryption key material the SDK needs for the browser-side submit.
+ assert "window.PUBLIC_KEY" in _html
+
+
+def test_web_page_wires_sdk() -> None:
+ _html = client.get("/_web").text
+ # SDK is wired in (collector before sdk).
+ assert "/static/js/collector.js" in _html
+ assert "/static/js/sdk.js" in _html
+
+
+def test_web_page_does_not_leak_scoring_internals() -> None:
+ _html = client.get("/_web").text.lower()
+ for _needle in (
+ "rt_bv_score",
+ "metricsprocessor",
+ "passes_gate",
+ "threshold",
+ "score_message",
+ "self_consistency",
+ "weighted_average",
+ "gate_fail",
+ "penalty",
+ ):
+ assert _needle not in _html
+
+
+def test_sdk_assets_do_not_leak_scoring_internals() -> None:
+ # The collected raw signals are public, but no scoring math/thresholds may
+ # appear in the shipped JS either.
+ for _path in ("/static/js/collector.js", "/static/js/sdk.js"):
+ _js = client.get(_path).text.lower()
+ for _needle in (
+ "rt_bv_score",
+ "metricsprocessor",
+ "threshold",
+ "weight",
+ "penalty",
+ "score_message",
+ "self_consistency",
+ ):
+ assert _needle not in _js, f"{_needle} leaked into {_path}"
+
+
+def test_sdk_does_not_collect_behavior() -> None:
+ # The active flow must not wire mouse/keyboard/scroll/click behavior.
+ _js = client.get("/static/js/sdk.js").text
+ for _needle in (
+ "mousemove",
+ "mousedown",
+ "mouseup",
+ "keydown",
+ "keyup",
+ "addEventListener",
+ ):
+ assert _needle not in _js, _needle
+
+
+def test_sdk_assets_are_served() -> None:
+ for _path in ("/static/js/collector.js", "/static/js/sdk.js"):
+ _response = client.get(_path)
+ assert _response.status_code == 200, _path
+ assert "javascript" in _response.headers["content-type"].lower()
+
+
+@pytest.mark.skipif(shutil.which("node") is None, reason="node not available")
+@pytest.mark.parametrize("script", ["collector.test.js", "sdk.test.js"])
+def test_sdk_node_suites(script: str) -> None:
+ _result = subprocess.run(
+ ["node", str(_WEB_DIR / script)],
+ capture_output=True,
+ text=True,
+ )
+ assert _result.returncode == 0, _result.stdout + _result.stderr
diff --git a/tests/web/collector.test.js b/tests/web/collector.test.js
new file mode 100644
index 0000000..429734a
--- /dev/null
+++ b/tests/web/collector.test.js
@@ -0,0 +1,128 @@
+"use strict";
+
+/**
+ * Unit tests for the pure browser/runtime-integrity collector. No DOM, no deps —
+ * runs under plain `node tests/web/collector.test.js`.
+ *
+ * HBv6 is non-behavioral: the collector accumulates raw integrity sections
+ * (browserInfo + automation / runtimeIntegrity / fingerprint / apiAvailability /
+ * navigator / display / correlation / sessionBinding) and keeps the legacy raw
+ * behavior series only as EMPTY lists for shape back-compat.
+ */
+
+const assert = require("assert");
+const path = require("path");
+
+const { createCollector, SECTION_KEYS } = require(path.join(
+ __dirname,
+ "..",
+ "..",
+ "src",
+ "bv_challenge",
+ "challenge",
+ "templates",
+ "html",
+ "static",
+ "js",
+ "collector.js"
+));
+
+let passed = 0;
+function test(name, fn) {
+ fn();
+ passed += 1;
+ console.log(" ok - " + name);
+}
+
+const LEGACY = ["movements", "clicks", "mouseDowns", "mouseUps", "keydowns", "keyups", "scroll"];
+const SECTIONS = [
+ "automation",
+ "runtimeIntegrity",
+ "fingerprint",
+ "apiAvailability",
+ "navigator",
+ "display",
+ "correlation",
+ "sessionBinding"
+];
+
+test("starts with legacy behavior series present and EMPTY (shape back-compat)", () => {
+ const d = createCollector({ sessionId: "s1" }).toJSON();
+ for (const k of LEGACY) {
+ assert.deepStrictEqual(d[k], [], k + " should start empty");
+ }
+});
+
+test("starts with all integrity sections null and a pageTimings container", () => {
+ const d = createCollector().toJSON();
+ assert.strictEqual(d.browserInfo, null);
+ for (const k of SECTIONS) {
+ assert.strictEqual(d[k], null, k + " should start null");
+ }
+ assert.deepStrictEqual(d.pageTimings, { pageLoadMs: null });
+});
+
+test("carries sessionId and schemaVersion through to the payload", () => {
+ const d = createCollector({ sessionId: "abc", schemaVersion: "bv-runtime-1" }).toJSON();
+ assert.strictEqual(d.sessionId, "abc");
+ assert.strictEqual(d.schemaVersion, "bv-runtime-1");
+});
+
+test("setBrowserInfo is first-write-wins", () => {
+ const c = createCollector();
+ c.setBrowserInfo({ userAgent: "ua-1" });
+ c.setBrowserInfo({ userAgent: "ua-2" });
+ assert.strictEqual(c.toJSON().browserInfo.userAgent, "ua-1");
+});
+
+test("setSection stores a known section once (first-write-wins)", () => {
+ const c = createCollector();
+ c.setSection("automation", { webdriver: false });
+ c.setSection("automation", { webdriver: true });
+ assert.deepStrictEqual(c.toJSON().automation, { webdriver: false });
+});
+
+test("setSection accepts every advertised section key", () => {
+ const c = createCollector();
+ for (const k of SECTIONS) {
+ c.setSection(k, { ok: true });
+ }
+ const d = c.toJSON();
+ for (const k of SECTIONS) {
+ assert.deepStrictEqual(d[k], { ok: true }, k);
+ }
+});
+
+test("setSection ignores unknown section names", () => {
+ const c = createCollector();
+ c.setSection("bogusSection", { x: 1 });
+ assert.ok(!("bogusSection" in c.toJSON()), "unknown sections must not be injected");
+});
+
+test("setSection ignores non-object values", () => {
+ const c = createCollector();
+ c.setSection("automation", "nope");
+ c.setSection("automation", 5);
+ assert.strictEqual(c.toJSON().automation, null);
+});
+
+test("setPageTiming sets pageLoadMs once", () => {
+ const c = createCollector();
+ c.setPageTiming("pageLoadMs", 800);
+ c.setPageTiming("pageLoadMs", 999);
+ assert.strictEqual(c.toJSON().pageTimings.pageLoadMs, 800);
+});
+
+test("finalize sets endedAt once and is idempotent", () => {
+ let n = 0;
+ const c = createCollector({ now: () => ++n });
+ const first = c.finalize().endedAt;
+ const second = c.finalize().endedAt;
+ assert.strictEqual(first, second);
+});
+
+test("SECTION_KEYS exposes exactly the known sections", () => {
+ assert.deepStrictEqual(Object.keys(SECTION_KEYS).sort(), SECTIONS.slice().sort());
+});
+
+console.log("\ncollector.test.js: " + passed + " passed");
diff --git a/tests/web/sdk.test.js b/tests/web/sdk.test.js
new file mode 100644
index 0000000..78c3099
--- /dev/null
+++ b/tests/web/sdk.test.js
@@ -0,0 +1,243 @@
+"use strict";
+
+/**
+ * Integration test for the HBv6 browser SDK against a minimal hand-rolled DOM +
+ * WebCrypto + fetch shim (no jsdom/playwright needed). Proves the requirements:
+ * - on load the SDK auto-collects NON-behavioral integrity signals
+ * (browserInfo + automation/runtimeIntegrity/apiAvailability/fingerprint/
+ * navigator/display/correlation/sessionBinding),
+ * - it submits the encrypted payload to TASK_CONFIG.evalUrl via fetch(),
+ * - window.BV_SUBMITTED flips true after a successful submit,
+ * - submission happens with NO behavioral input (no mouse/keyboard/scroll),
+ * - the encrypted blob is the hybrid wire format the server decryptor expects
+ * (key "::" iv "::" text) and round-trips back to the exact payload,
+ * - the payload carries no behavioral fields beyond the empty legacy arrays.
+ *
+ * node tests/web/sdk.test.js
+ */
+
+const assert = require("assert");
+const path = require("path");
+const { webcrypto } = require("crypto");
+
+const subtle = webcrypto.subtle;
+const JS_DIR = path.join(
+ __dirname, "..", "..", "src", "bv_challenge", "challenge",
+ "templates", "html", "static", "js"
+);
+
+// ALPHANUM_CUSTOM_REGEX from the server (api/core/constants/_regex.py).
+const DATA_REGEX = /^[0-9a-zA-Z_\-:+/=]+$/;
+
+function b64ToBytes(b64) {
+ return new Uint8Array(Buffer.from(b64, "base64"));
+}
+function bytesToPemSpki(buf) {
+ const b64 = Buffer.from(buf).toString("base64");
+ const lines = b64.match(/.{1,64}/g).join("\n");
+ return `-----BEGIN PUBLIC KEY-----\n${lines}\n-----END PUBLIC KEY-----`;
+}
+
+async function decryptBlob(blob, privateKey) {
+ const [encKeyB64, encIvB64, ctB64] = blob.split("::");
+ const rawKey = await subtle.decrypt({ name: "RSA-OAEP" }, privateKey, b64ToBytes(encKeyB64));
+ const iv = await subtle.decrypt({ name: "RSA-OAEP" }, privateKey, b64ToBytes(encIvB64));
+ const aesKey = await subtle.importKey("raw", rawKey, { name: "AES-CBC" }, false, ["decrypt"]);
+ const ptBuf = await subtle.decrypt(
+ { name: "AES-CBC", iv: new Uint8Array(iv) }, aesKey, b64ToBytes(ctB64)
+ );
+ return {
+ rawKey: new Uint8Array(rawKey),
+ iv: new Uint8Array(iv),
+ plaintext: Buffer.from(ptBuf).toString("utf-8")
+ };
+}
+
+async function main() {
+ // --- generate the session RSA keypair (RSA-OAEP / SHA-256), as the server does
+ const keyPair = await subtle.generateKey(
+ { name: "RSA-OAEP", modulusLength: 2048, publicExponent: new Uint8Array([1, 0, 1]), hash: "SHA-256" },
+ true,
+ ["encrypt", "decrypt"]
+ );
+ const spki = await subtle.exportKey("spki", keyPair.publicKey);
+ const publicKeyPem = bytesToPemSpki(spki);
+
+ // --- minimal DOM / element shim -----------------------------------------
+ const statusEl = { textContent: "Checking…" };
+ const doc = {
+ getElementById(id) {
+ return id === "status" ? statusEl : null;
+ },
+ createElement() {
+ // Canvas-like: no real 2d/webgl context in the shim.
+ return { width: 0, height: 0, getContext() { return null; }, toDataURL() { return ""; } };
+ }
+ };
+
+ const store = {};
+ const localStorage = {
+ setItem(k, v) { store[k] = String(v); },
+ getItem(k) { return Object.prototype.hasOwnProperty.call(store, k) ? store[k] : null; }
+ };
+
+ const fetchCalls = [];
+ function fakeFetch(url, init) {
+ fetchCalls.push({ url, init });
+ return Promise.resolve({ ok: true, status: 200, json: () => Promise.resolve({}) });
+ }
+
+ const win = {
+ PUBLIC_KEY: publicKeyPem,
+ TASK_CONFIG: { evalUrl: "/_eval", payloadKey: "data", autoSubmit: true },
+ BV_SESSION: {
+ sessionId: "sess-1",
+ nonce: "nonce-abc123",
+ publicKeyId: "pk-deadbeef",
+ configHash: "cfg-1234",
+ schemaVersion: "bv-runtime-1"
+ },
+ crypto: webcrypto,
+ btoa: (s) => Buffer.from(s, "binary").toString("base64"),
+ atob: (s) => Buffer.from(s, "base64").toString("binary"),
+ fetch: fakeFetch,
+ localStorage,
+ location: { href: "https://challenge/_web", origin: "https://challenge" },
+ innerWidth: 1440,
+ innerHeight: 812,
+ outerWidth: 1440,
+ outerHeight: 900,
+ devicePixelRatio: 1
+ // AudioContext / RTCPeerConnection / WebAssembly / indexedDB intentionally absent.
+ };
+
+ global.window = win;
+ global.document = doc;
+ Object.defineProperty(global, "navigator", {
+ configurable: true,
+ value: {
+ userAgent:
+ "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36",
+ platform: "Linux x86_64",
+ vendor: "Google Inc.",
+ language: "en-US",
+ languages: ["en-US", "en"],
+ webdriver: false,
+ hardwareConcurrency: 8,
+ maxTouchPoints: 0,
+ plugins: { length: 3 },
+ mimeTypes: { length: 2 },
+ userAgentData: { mobile: false, platform: "Linux", brands: [{ brand: "Chromium" }] }
+ }
+ });
+ global.screen = {
+ width: 1920, height: 1080, availWidth: 1920, availHeight: 1040, colorDepth: 24, pixelDepth: 24
+ };
+ Object.defineProperty(global, "performance", {
+ configurable: true,
+ value: { getEntriesByType: (k) => (k === "navigation" ? [{ duration: 800 }] : []) }
+ });
+
+ // Wire the collector factory, then run the SDK IIFE against the shim.
+ win.BVCollector = require(path.join(JS_DIR, "collector.js"));
+ require(path.join(JS_DIR, "sdk.js"));
+
+ // The IIFE auto-runs on load; await an explicit run for a deterministic result.
+ const submitted = await win.BV_SDK.submitNow();
+
+ // Do all async crypto up front so the assertions below can stay synchronous.
+ const lastBody = JSON.parse(fetchCalls[fetchCalls.length - 1].init.body);
+ const blob = lastBody.error.data;
+ const decoded = await decryptBlob(blob, keyPair.privateKey);
+ const payload = JSON.parse(decoded.plaintext);
+
+ let passed = 0;
+ function test(name, fn) {
+ fn();
+ passed += 1;
+ console.log(" ok - " + name);
+ }
+
+ test("auto-submit resolves true and flips window.BV_SUBMITTED", () => {
+ assert.strictEqual(submitted, true);
+ assert.strictEqual(win.BV_SUBMITTED, true);
+ });
+
+ test("updates #status to 'Verification complete'", () => {
+ assert.strictEqual(statusEl.textContent, "Verification complete");
+ });
+
+ test("POSTs to TASK_CONFIG.evalUrl with the {error:{data}} envelope", () => {
+ const call = fetchCalls[fetchCalls.length - 1];
+ assert.strictEqual(call.url, "/_eval");
+ assert.strictEqual(call.init.method, "POST");
+ assert.ok(typeof blob === "string" && blob.length > 0, "blob must be a string");
+ assert.ok(DATA_REGEX.test(blob), "blob must match the server data charset");
+ });
+
+ test("blob is the hybrid key::iv::text wire format (3 parts)", () => {
+ assert.strictEqual(blob.split("::").length, 3, "expected encKey::encIv::cipherText");
+ });
+
+ test("blob round-trips: RSA-OAEP(key,iv) + AES-256-CBC(text) -> original payload", () => {
+ assert.strictEqual(decoded.rawKey.length, 32, "AES-256 key");
+ assert.strictEqual(decoded.iv.length, 16, "16-byte IV");
+ // Must equal what the SDK stashed locally too.
+ assert.strictEqual(decoded.plaintext, localStorage.getItem("data"));
+ });
+
+ test("collected payload carries the non-behavioral integrity sections", () => {
+ assert.ok(payload.browserInfo, "browserInfo present");
+ assert.strictEqual(payload.browserInfo.webdriver, false);
+ assert.ok(payload.browserInfo.userAgent.indexOf("Chrome") !== -1);
+ for (const k of [
+ "automation", "runtimeIntegrity", "apiAvailability", "fingerprint",
+ "navigator", "display", "correlation", "sessionBinding"
+ ]) {
+ assert.ok(payload[k] && typeof payload[k] === "object", k + " section present");
+ }
+ });
+
+ test("automation indicators reflect a clean (non-automated) shim", () => {
+ assert.strictEqual(payload.automation.webdriver, false);
+ assert.strictEqual(payload.automation.headlesschrome, false);
+ });
+
+ test("apiAvailability reports real capability booleans", () => {
+ assert.strictEqual(payload.apiAvailability.serviceWorker, false); // absent in shim navigator
+ assert.strictEqual(typeof payload.apiAvailability.indexedDb, "boolean");
+ });
+
+ test("sessionBinding echoes the injected BV_SESSION fields", () => {
+ assert.strictEqual(payload.sessionBinding.nonce, "nonce-abc123");
+ assert.strictEqual(payload.sessionBinding.sessionId, "sess-1");
+ assert.strictEqual(payload.sessionBinding.publicKeyId, "pk-deadbeef");
+ assert.strictEqual(payload.sessionBinding.schemaVersion, "bv-runtime-1");
+ });
+
+ test("legacy behavior series are present but EMPTY (no behavior collected)", () => {
+ for (const k of ["movements", "clicks", "mouseDowns", "mouseUps", "keydowns", "keyups", "scroll"]) {
+ assert.deepStrictEqual(payload[k], [], k + " must be empty");
+ }
+ });
+
+ test("NO behavioral fields leak into the payload", () => {
+ const banned = ["eventSequence", "targets", "taskProgress", "trustedEventStats", "buttonHoverToClickTime"];
+ const raw = localStorage.getItem("data");
+ for (const k of banned) {
+ assert.ok(raw.indexOf('"' + k + '"') === -1, "payload must not contain " + k);
+ }
+ });
+
+ test("submission required NO behavioral input (no events were dispatched)", () => {
+ // We never dispatched a mouse/key/scroll event; the SDK submitted anyway.
+ assert.strictEqual(win.BV_SUBMITTED, true);
+ });
+
+ console.log("\nsdk.test.js: " + passed + " passed");
+}
+
+main().catch((err) => {
+ console.error(err && err.stack ? err.stack : err);
+ process.exitCode = 1;
+});
diff --git a/src/bv_challenge/challenge/api/static/css/.gitkeep b/volumes/configs/simple-bot-backend/key/.gitkeep
similarity index 100%
rename from src/bv_challenge/challenge/api/static/css/.gitkeep
rename to volumes/configs/simple-bot-backend/key/.gitkeep
diff --git a/volumes/storage/rest-mdm-sn-container-runner/data/.gitkeep b/volumes/storage/rest-mdm-sn-container-runner/data/.gitkeep
new file mode 100644
index 0000000..8b13789
--- /dev/null
+++ b/volumes/storage/rest-mdm-sn-container-runner/data/.gitkeep
@@ -0,0 +1 @@
+
diff --git a/volumes/storage/rest-mdm-sn-container-runner/logs/.gitkeep b/volumes/storage/rest-mdm-sn-container-runner/logs/.gitkeep
new file mode 100644
index 0000000..8b13789
--- /dev/null
+++ b/volumes/storage/rest-mdm-sn-container-runner/logs/.gitkeep
@@ -0,0 +1 @@
+