feat(backend): add file-config CRUD service and router
- file_config_service.py: service layer for reading, writing, and validating fail2ban conf files (jail.local, action.d/*, filter.d/*) - file_config.py: REST router exposing GET/PUT endpoints for conf-file contents, sections, and key-value pairs; supports jails, actions, and filters
This commit is contained in:
@@ -11,10 +11,14 @@ Endpoints:
|
||||
* ``GET /api/config/filters/{name}`` — get one filter file (with content)
|
||||
* ``PUT /api/config/filters/{name}`` — update a filter file
|
||||
* ``POST /api/config/filters`` — create a new filter file
|
||||
* ``GET /api/config/filters/{name}/parsed`` — parse a filter file into a structured model
|
||||
* ``PUT /api/config/filters/{name}/parsed`` — update a filter file from a structured model
|
||||
* ``GET /api/config/actions`` — list all action files
|
||||
* ``GET /api/config/actions/{name}`` — get one action file (with content)
|
||||
* ``PUT /api/config/actions/{name}`` — update an action file
|
||||
* ``POST /api/config/actions`` — create a new action file
|
||||
* ``GET /api/config/actions/{name}/parsed`` — parse an action file into a structured model
|
||||
* ``PUT /api/config/actions/{name}/parsed`` — update an action file from a structured model
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
@@ -24,6 +28,14 @@ from typing import Annotated
|
||||
from fastapi import APIRouter, HTTPException, Path, Request, status
|
||||
|
||||
from app.dependencies import AuthDep
|
||||
from app.models.config import (
|
||||
ActionConfig,
|
||||
ActionConfigUpdate,
|
||||
FilterConfig,
|
||||
FilterConfigUpdate,
|
||||
JailFileConfig,
|
||||
JailFileConfigUpdate,
|
||||
)
|
||||
from app.models.file_config import (
|
||||
ConfFileContent,
|
||||
ConfFileCreateRequest,
|
||||
@@ -199,6 +211,51 @@ async def set_jail_config_file_enabled(
|
||||
raise _service_unavailable(str(exc)) from exc
|
||||
|
||||
|
||||
@router.post(
|
||||
"/jail-files",
|
||||
response_model=ConfFileContent,
|
||||
status_code=status.HTTP_201_CREATED,
|
||||
summary="Create a new jail.d config file",
|
||||
)
|
||||
async def create_jail_config_file(
|
||||
request: Request,
|
||||
_auth: AuthDep,
|
||||
body: ConfFileCreateRequest,
|
||||
) -> ConfFileContent:
|
||||
"""Create a new ``.conf`` file in ``jail.d/``.
|
||||
|
||||
Args:
|
||||
request: Incoming request.
|
||||
_auth: Validated session.
|
||||
body: :class:`~app.models.file_config.ConfFileCreateRequest` with name and content.
|
||||
|
||||
Returns:
|
||||
:class:`~app.models.file_config.ConfFileContent` with the created file metadata.
|
||||
|
||||
Raises:
|
||||
HTTPException: 400 if the name is unsafe or the content exceeds the size limit.
|
||||
HTTPException: 409 if a file with that name already exists.
|
||||
HTTPException: 503 if the config directory is unavailable.
|
||||
"""
|
||||
config_dir: str = request.app.state.settings.fail2ban_config_dir
|
||||
try:
|
||||
filename = await file_config_service.create_jail_config_file(config_dir, body)
|
||||
except ConfigFileNameError as exc:
|
||||
raise _bad_request(str(exc)) from exc
|
||||
except ConfigFileExistsError:
|
||||
raise _conflict(body.name) from None
|
||||
except ConfigFileWriteError as exc:
|
||||
raise _bad_request(str(exc)) from exc
|
||||
except ConfigDirError as exc:
|
||||
raise _service_unavailable(str(exc)) from exc
|
||||
|
||||
return ConfFileContent(
|
||||
name=body.name,
|
||||
filename=filename,
|
||||
content=body.content,
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Filter file endpoints (Task 4d)
|
||||
# ---------------------------------------------------------------------------
|
||||
@@ -493,3 +550,258 @@ async def create_action_file(
|
||||
filename=filename,
|
||||
content=body.content,
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Parsed filter endpoints (Task 2.1)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
@router.get(
|
||||
"/filters/{name}/parsed",
|
||||
response_model=FilterConfig,
|
||||
summary="Return a filter file parsed into a structured model",
|
||||
)
|
||||
async def get_parsed_filter(
|
||||
request: Request,
|
||||
_auth: AuthDep,
|
||||
name: _NamePath,
|
||||
) -> FilterConfig:
|
||||
"""Parse a filter definition file and return its structured fields.
|
||||
|
||||
The file is read from ``filter.d/``, parsed as fail2ban INI format, and
|
||||
returned as a :class:`~app.models.config.FilterConfig` JSON object. This
|
||||
is the input model for the form-based filter editor (Task 2.3).
|
||||
|
||||
Args:
|
||||
request: Incoming request.
|
||||
_auth: Validated session.
|
||||
name: Base name (e.g. ``sshd`` or ``sshd.conf``).
|
||||
|
||||
Returns:
|
||||
:class:`~app.models.config.FilterConfig`.
|
||||
|
||||
Raises:
|
||||
HTTPException: 400 if *name* is unsafe.
|
||||
HTTPException: 404 if the file does not exist.
|
||||
HTTPException: 503 if the config directory is unavailable.
|
||||
"""
|
||||
config_dir: str = request.app.state.settings.fail2ban_config_dir
|
||||
try:
|
||||
return await file_config_service.get_parsed_filter_file(config_dir, name)
|
||||
except ConfigFileNameError as exc:
|
||||
raise _bad_request(str(exc)) from exc
|
||||
except ConfigFileNotFoundError:
|
||||
raise _not_found(name) from None
|
||||
except ConfigDirError as exc:
|
||||
raise _service_unavailable(str(exc)) from exc
|
||||
|
||||
|
||||
@router.put(
|
||||
"/filters/{name}/parsed",
|
||||
status_code=status.HTTP_204_NO_CONTENT,
|
||||
summary="Update a filter file from a structured model",
|
||||
)
|
||||
async def update_parsed_filter(
|
||||
request: Request,
|
||||
_auth: AuthDep,
|
||||
name: _NamePath,
|
||||
body: FilterConfigUpdate,
|
||||
) -> None:
|
||||
"""Apply a partial structured update to a filter definition file.
|
||||
|
||||
Fields set to ``null`` in the request body are left unchanged. The file is
|
||||
re-serialized to fail2ban INI format after merging.
|
||||
|
||||
Args:
|
||||
request: Incoming request.
|
||||
_auth: Validated session.
|
||||
name: Base name of the filter to update.
|
||||
body: Partial :class:`~app.models.config.FilterConfigUpdate`.
|
||||
|
||||
Raises:
|
||||
HTTPException: 400 if *name* is unsafe or content exceeds the size limit.
|
||||
HTTPException: 404 if the file does not exist.
|
||||
HTTPException: 503 if the config directory is unavailable.
|
||||
"""
|
||||
config_dir: str = request.app.state.settings.fail2ban_config_dir
|
||||
try:
|
||||
await file_config_service.update_parsed_filter_file(config_dir, name, body)
|
||||
except ConfigFileNameError as exc:
|
||||
raise _bad_request(str(exc)) from exc
|
||||
except ConfigFileNotFoundError:
|
||||
raise _not_found(name) from None
|
||||
except ConfigFileWriteError as exc:
|
||||
raise _bad_request(str(exc)) from exc
|
||||
except ConfigDirError as exc:
|
||||
raise _service_unavailable(str(exc)) from exc
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Parsed action endpoints (Task 3.1)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
@router.get(
|
||||
"/actions/{name}/parsed",
|
||||
response_model=ActionConfig,
|
||||
summary="Return an action file parsed into a structured model",
|
||||
)
|
||||
async def get_parsed_action(
|
||||
request: Request,
|
||||
_auth: AuthDep,
|
||||
name: _NamePath,
|
||||
) -> ActionConfig:
|
||||
"""Parse an action definition file and return its structured fields.
|
||||
|
||||
The file is read from ``action.d/``, parsed as fail2ban INI format, and
|
||||
returned as a :class:`~app.models.config.ActionConfig` JSON object. This
|
||||
is the input model for the form-based action editor (Task 3.3).
|
||||
|
||||
Args:
|
||||
request: Incoming request.
|
||||
_auth: Validated session.
|
||||
name: Base name (e.g. ``iptables`` or ``iptables.conf``).
|
||||
|
||||
Returns:
|
||||
:class:`~app.models.config.ActionConfig`.
|
||||
|
||||
Raises:
|
||||
HTTPException: 400 if *name* is unsafe.
|
||||
HTTPException: 404 if the file does not exist.
|
||||
HTTPException: 503 if the config directory is unavailable.
|
||||
"""
|
||||
config_dir: str = request.app.state.settings.fail2ban_config_dir
|
||||
try:
|
||||
return await file_config_service.get_parsed_action_file(config_dir, name)
|
||||
except ConfigFileNameError as exc:
|
||||
raise _bad_request(str(exc)) from exc
|
||||
except ConfigFileNotFoundError:
|
||||
raise _not_found(name) from None
|
||||
except ConfigDirError as exc:
|
||||
raise _service_unavailable(str(exc)) from exc
|
||||
|
||||
|
||||
@router.put(
|
||||
"/actions/{name}/parsed",
|
||||
status_code=status.HTTP_204_NO_CONTENT,
|
||||
summary="Update an action file from a structured model",
|
||||
)
|
||||
async def update_parsed_action(
|
||||
request: Request,
|
||||
_auth: AuthDep,
|
||||
name: _NamePath,
|
||||
body: ActionConfigUpdate,
|
||||
) -> None:
|
||||
"""Apply a partial structured update to an action definition file.
|
||||
|
||||
Fields set to ``null`` in the request body are left unchanged. The file is
|
||||
re-serialized to fail2ban INI format after merging.
|
||||
|
||||
Args:
|
||||
request: Incoming request.
|
||||
_auth: Validated session.
|
||||
name: Base name of the action to update.
|
||||
body: Partial :class:`~app.models.config.ActionConfigUpdate`.
|
||||
|
||||
Raises:
|
||||
HTTPException: 400 if *name* is unsafe or content exceeds the size limit.
|
||||
HTTPException: 404 if the file does not exist.
|
||||
HTTPException: 503 if the config directory is unavailable.
|
||||
"""
|
||||
config_dir: str = request.app.state.settings.fail2ban_config_dir
|
||||
try:
|
||||
await file_config_service.update_parsed_action_file(config_dir, name, body)
|
||||
except ConfigFileNameError as exc:
|
||||
raise _bad_request(str(exc)) from exc
|
||||
except ConfigFileNotFoundError:
|
||||
raise _not_found(name) from None
|
||||
except ConfigFileWriteError as exc:
|
||||
raise _bad_request(str(exc)) from exc
|
||||
except ConfigDirError as exc:
|
||||
raise _service_unavailable(str(exc)) from exc
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Parsed jail file endpoints (Task 6.1)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
@router.get(
|
||||
"/jail-files/{filename}/parsed",
|
||||
response_model=JailFileConfig,
|
||||
summary="Return a jail.d file parsed into a structured model",
|
||||
)
|
||||
async def get_parsed_jail_file(
|
||||
request: Request,
|
||||
_auth: AuthDep,
|
||||
filename: _NamePath,
|
||||
) -> JailFileConfig:
|
||||
"""Parse a jail.d config file and return its structured fields.
|
||||
|
||||
The file is read from ``jail.d/``, parsed as fail2ban INI format, and
|
||||
returned as a :class:`~app.models.config.JailFileConfig` JSON object. This
|
||||
is the input model for the form-based jail file editor (Task 6.2).
|
||||
|
||||
Args:
|
||||
request: Incoming request.
|
||||
_auth: Validated session.
|
||||
filename: Filename including extension (e.g. ``sshd.conf``).
|
||||
|
||||
Returns:
|
||||
:class:`~app.models.config.JailFileConfig`.
|
||||
|
||||
Raises:
|
||||
HTTPException: 400 if *filename* is unsafe.
|
||||
HTTPException: 404 if the file does not exist.
|
||||
HTTPException: 503 if the config directory is unavailable.
|
||||
"""
|
||||
config_dir: str = request.app.state.settings.fail2ban_config_dir
|
||||
try:
|
||||
return await file_config_service.get_parsed_jail_file(config_dir, filename)
|
||||
except ConfigFileNameError as exc:
|
||||
raise _bad_request(str(exc)) from exc
|
||||
except ConfigFileNotFoundError:
|
||||
raise _not_found(filename) from None
|
||||
except ConfigDirError as exc:
|
||||
raise _service_unavailable(str(exc)) from exc
|
||||
|
||||
|
||||
@router.put(
|
||||
"/jail-files/{filename}/parsed",
|
||||
status_code=status.HTTP_204_NO_CONTENT,
|
||||
summary="Update a jail.d file from a structured model",
|
||||
)
|
||||
async def update_parsed_jail_file(
|
||||
request: Request,
|
||||
_auth: AuthDep,
|
||||
filename: _NamePath,
|
||||
body: JailFileConfigUpdate,
|
||||
) -> None:
|
||||
"""Apply a partial structured update to a jail.d config file.
|
||||
|
||||
Fields set to ``null`` in the request body are left unchanged. The file is
|
||||
re-serialized to fail2ban INI format after merging.
|
||||
|
||||
Args:
|
||||
request: Incoming request.
|
||||
_auth: Validated session.
|
||||
filename: Filename including extension (e.g. ``sshd.conf``).
|
||||
body: Partial :class:`~app.models.config.JailFileConfigUpdate`.
|
||||
|
||||
Raises:
|
||||
HTTPException: 400 if *filename* is unsafe or content exceeds size limit.
|
||||
HTTPException: 404 if the file does not exist.
|
||||
HTTPException: 503 if the config directory is unavailable.
|
||||
"""
|
||||
config_dir: str = request.app.state.settings.fail2ban_config_dir
|
||||
try:
|
||||
await file_config_service.update_parsed_jail_file(config_dir, filename, body)
|
||||
except ConfigFileNameError as exc:
|
||||
raise _bad_request(str(exc)) from exc
|
||||
except ConfigFileNotFoundError:
|
||||
raise _not_found(filename) from None
|
||||
except ConfigFileWriteError as exc:
|
||||
raise _bad_request(str(exc)) from exc
|
||||
except ConfigDirError as exc:
|
||||
raise _service_unavailable(str(exc)) from exc
|
||||
|
||||
Reference in New Issue
Block a user