Lukas
5480dce221
All routers now let domain exceptions propagate to the global handlers in main.py instead of catching and converting them to HTTPException. This eliminates: - Duplicate exception-to-HTTP-status mappings across 8 routers - Duplicate helper functions (_bad_gateway, _not_found, _conflict, etc.) - Inconsistent error response formats Changes: - Removed all try/except blocks from routers that catch domain exceptions - Removed duplicate helper functions from all routers - Added missing exception handlers to main.py for: * ActionNameError * FilterNameError * JailNameError * JailNotFoundInConfigError * FilterInvalidRegexError - Removed unused imports from affected routers All domain exceptions now propagate to the single authoritative mapping in main.py, ensuring consistent error codes, messages, and logging across the API. Affected routers: - action_config.py: Removed _action_not_found, _bad_request, _not_found helpers - bans.py: Removed try/except in ban/unban endpoints - config_misc.py: Removed try/except blocks - file_config.py: Removed 6 try/except blocks and _service_unavailable helper - filter_config.py: Removed try/except blocks - geo.py: Removed try/except in lookup_ip endpoint - jail_config.py: Removed try/except blocks - jails.py: Removed try/except blocks - server.py: Removed try/except blocks Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
112 lines
3.2 KiB
Python
112 lines
3.2 KiB
Python
"""Server settings router.
|
|
|
|
Provides endpoints to view and update fail2ban server-level settings and
|
|
to flush log files.
|
|
|
|
* ``GET /api/server/settings`` — current log level, target, and DB config
|
|
* ``PUT /api/server/settings`` — update server-level settings
|
|
* ``POST /api/server/flush-logs`` — flush and re-open log files
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from fastapi import APIRouter, HTTPException, Request, status
|
|
|
|
from app.dependencies import AuthDep, Fail2BanSocketDep
|
|
from app.models.server import ServerSettingsResponse, ServerSettingsUpdate
|
|
from app.services import server_service
|
|
from app.exceptions import ServerOperationError, Fail2BanConnectionError
|
|
|
|
router: APIRouter = APIRouter(prefix="/api/server", tags=["Server"])
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Endpoints
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
@router.get(
|
|
"/settings",
|
|
response_model=ServerSettingsResponse,
|
|
summary="Return fail2ban server-level settings",
|
|
)
|
|
async def get_server_settings(
|
|
request: Request,
|
|
_auth: AuthDep,
|
|
socket_path: Fail2BanSocketDep,
|
|
) -> ServerSettingsResponse:
|
|
"""Return the current fail2ban server-level settings.
|
|
|
|
Includes log level, log target, syslog socket, database file path,
|
|
database purge age, and maximum stored matches per record.
|
|
|
|
Args:
|
|
request: Incoming request (used to access ``app.state``).
|
|
_auth: Validated session — enforces authentication.
|
|
|
|
Returns:
|
|
:class:`~app.models.server.ServerSettingsResponse`.
|
|
|
|
Raises:
|
|
HTTPException: 502 when fail2ban is unreachable.
|
|
"""
|
|
return await server_service.get_settings(socket_path)
|
|
|
|
|
|
@router.put(
|
|
"/settings",
|
|
status_code=status.HTTP_204_NO_CONTENT,
|
|
summary="Update fail2ban server-level settings",
|
|
)
|
|
async def update_server_settings(
|
|
request: Request,
|
|
_auth: AuthDep,
|
|
body: ServerSettingsUpdate,
|
|
socket_path: Fail2BanSocketDep,
|
|
) -> None:
|
|
"""Update fail2ban server-level settings.
|
|
|
|
Only non-None fields in the request body are written. Changes take
|
|
effect immediately without a daemon restart.
|
|
|
|
Args:
|
|
request: Incoming request.
|
|
_auth: Validated session.
|
|
body: Partial settings update.
|
|
|
|
Raises:
|
|
HTTPException: 400 when a set command is rejected by fail2ban.
|
|
HTTPException: 502 when fail2ban is unreachable.
|
|
"""
|
|
await server_service.update_settings(socket_path, body)
|
|
|
|
|
|
@router.post(
|
|
"/flush-logs",
|
|
status_code=status.HTTP_200_OK,
|
|
summary="Flush and re-open fail2ban log files",
|
|
)
|
|
async def flush_logs(
|
|
request: Request,
|
|
_auth: AuthDep,
|
|
socket_path: Fail2BanSocketDep,
|
|
) -> dict[str, str]:
|
|
"""Flush and re-open fail2ban log files.
|
|
|
|
Useful after log rotation so the daemon writes to the newly created
|
|
log file rather than continuing to append to the rotated one.
|
|
|
|
Args:
|
|
request: Incoming request.
|
|
_auth: Validated session.
|
|
|
|
Returns:
|
|
``{"message": "<response from fail2ban>"}``
|
|
|
|
Raises:
|
|
HTTPException: 400 when the command is rejected.
|
|
HTTPException: 502 when fail2ban is unreachable.
|
|
"""
|
|
result = await server_service.flush_logs(socket_path)
|
|
return {"message": result}
|