# plugins/syslog/routes.py """The Syslog page: whether the listener is open, the sources whose lines are kept, and the senders offered to be added. Every GET reads Steward's own rows and the listener's state in memory; nothing here contacts a device (System 178's ruling). Adding, ignoring, editing and removing a source are an admin's, and audited.""" from __future__ import annotations from datetime import datetime, timezone from quart import Blueprint, abort, current_app, redirect, render_template, request, session from sqlalchemy import select from steward.auth.middleware import require_role from steward.core.audit import log_audit from steward.core.time_range import RANGES from steward.models.users import UserRole from .models import SyslogLine, SyslogSource from .parse import facility_name, severity_name from .receiver import LISTENER, MAX_SENDERS, settings from .service import PANEL_LINES, PANEL_SPAN, SEVERITY_CHOICES, apps_of, filtered, line_filter, rates, sources_for syslog_bp = Blueprint("syslog", __name__, template_folder="templates") INDEX = "/plugins/syslog/" def _actor() -> tuple[str | None, str]: return session.get("user_id"), session.get("username", "") async def _hosts(db) -> list: from steward.models.hosts import Host return list((await db.execute(select(Host.id, Host.name, Host.address).order_by(Host.name))).all()) def listener_view(port: int, udp: bool, tcp: bool) -> dict: """What the page says about the listener: open on which protocols, or why not.""" protocols = [p for p, on in (("UDP", udp), ("TCP", tcp)) if on] return {"port": port, "protocols": protocols, "listening": LISTENER.listening, "error": LISTENER.error, "bound_at": LISTENER.bound_at, "received": LISTENER.received, "dropped": LISTENER.dropped, "unoffered": LISTENER.unoffered, "connections": LISTENER.connections, "senders_full": False, "max_senders": MAX_SENDERS} def source_view(s: SyslogSource, hosts: dict, rate: int | None = None) -> dict: host = hosts.get(s.host_id) if s.host_id else None return {"id": s.id, "address": s.address, "state": s.state, "rate": rate, "name": s.name or s.hostname_seen or s.address, "hostname_seen": s.hostname_seen, "host": host, "first_seen_at": s.first_seen_at, "last_seen_at": s.last_seen_at, "lines_total": s.lines_total or 0, "severity": severity_name(s.last_severity) if s.last_severity is not None else None, "level": s.last_severity, "last_line": s.last_line} def suggested_host(source: SyslogSource, hosts: list) -> str | None: """The host whose address is the sender's, if one is.""" return next((h.id for h in hosts if h.address == source.address), None) @syslog_bp.get("/") @require_role(UserRole.viewer) async def index(): async with current_app.db_sessionmaker() as db: rows = list((await db.execute( select(SyslogSource).order_by(SyslogSource.last_seen_at.desc()))).scalars()) hosts = await _hosts(db) per_hour = await rates(db, [r.id for r in rows if r.state == "accepted"]) by_id = {h.id: h for h in hosts} views = {state: [] for state in ("accepted", "offered", "ignored")} for row in rows: v = source_view(row, by_id, per_hour.get(row.id, 0) if row.state == "accepted" else None) if row.state == "offered": v["suggested_host"] = suggested_host(row, hosts) views.setdefault(row.state, []).append(v) views["accepted"].sort(key=lambda v: v["name"].lower()) listener = listener_view(*settings(current_app)) listener["senders_full"] = len(rows) >= MAX_SENDERS return await render_template("syslog/index.html", listener=listener, sources=views["accepted"], offered=views["offered"], ignored=views["ignored"], hosts=hosts, now=datetime.now(timezone.utc)) async def _source_or_404(db, source_id: str) -> SyslogSource: source = await db.get(SyslogSource, source_id) if source is None: abort(404) return source async def _host_id(db, value: str | None) -> str | None: from steward.models.hosts import Host if not value: return None return value if await db.get(Host, value) is not None else None @syslog_bp.post("/sources//add") @require_role(UserRole.admin) async def add_source(source_id: str): """Keep an offered sender's lines from now on, under the name given.""" form = await request.form async with current_app.db_sessionmaker() as db: async with db.begin(): source = await _source_or_404(db, source_id) source.name = (form.get("name") or "").strip()[:100] or source.hostname_seen or source.address source.host_id = await _host_id(db, form.get("host_id")) source.state = "accepted" detail = {"name": source.name, "address": source.address} await log_audit(current_app, *_actor(), "syslog.source_added", entity_type="syslog_source", entity_id=source_id, detail=detail) return redirect(INDEX) @syslog_bp.post("/sources//ignore") @require_role(UserRole.admin) async def ignore_source(source_id: str): """Stop offering a sender: it is still counted, never kept.""" return await _set_state(source_id, "ignored", "syslog.source_ignored") @syslog_bp.post("/sources//offer") @require_role(UserRole.admin) async def offer_source(source_id: str): """Offer an ignored sender again.""" return await _set_state(source_id, "offered", "syslog.source_offered") async def _set_state(source_id: str, state: str, action: str): async with current_app.db_sessionmaker() as db: async with db.begin(): source = await _source_or_404(db, source_id) source.state = state detail = {"address": source.address} await log_audit(current_app, *_actor(), action, entity_type="syslog_source", entity_id=source_id, detail=detail) return redirect(INDEX) @syslog_bp.get("/sources//edit") @require_role(UserRole.admin) async def edit_source(source_id: str): async with current_app.db_sessionmaker() as db: source = await _source_or_404(db, source_id) hosts = await _hosts(db) return await render_template("syslog/edit.html", source=source, hosts=hosts, label=source.name or source.hostname_seen or source.address) @syslog_bp.post("/sources//edit") @require_role(UserRole.admin) async def save_source(source_id: str): form = await request.form async with current_app.db_sessionmaker() as db: async with db.begin(): source = await _source_or_404(db, source_id) old_name = source.name source.name = (form.get("name") or "").strip()[:100] or source.hostname_seen or source.address source.host_id = await _host_id(db, form.get("host_id")) detail = {"name": source.name} if old_name != source.name: detail["old_name"] = old_name await log_audit(current_app, *_actor(), "syslog.source_updated", entity_type="syslog_source", entity_id=source_id, detail=detail) return redirect(f"/plugins/syslog/sources/{source_id}") @syslog_bp.post("/sources//delete") @require_role(UserRole.admin) async def delete_source(source_id: str): """Remove a source and the lines kept from it. A device still sending is offered again.""" async with current_app.db_sessionmaker() as db: async with db.begin(): source = await _source_or_404(db, source_id) detail = {"name": source.name, "address": source.address} await db.delete(source) await log_audit(current_app, *_actor(), "syslog.source_removed", entity_type="syslog_source", entity_id=source_id, detail=detail) return redirect(INDEX) # ── A source's lines, and the panel on a host's or an SNMP device's page ───── def line_view(line) -> dict: return {"id": line.id, "received_at": line.received_at, "sent_at": line.sent_at, "level": line.severity, "severity": severity_name(line.severity), "facility": facility_name(line.facility), "hostname": line.hostname, "app": line.app, "message": line.message} @syslog_bp.get("/sources/") @require_role(UserRole.viewer) async def source_detail(source_id: str): """One source's kept lines, newest first, a page at a time as the reader scrolls (core.paging), under a filter bar: severity and worse, app, text and time. ?before= is the next page's rows alone; a request from the filter bar is the table alone.""" from urllib.parse import urlencode from steward.audit.service import mark_day_groups from steward.core import formatting as fmt from steward.core.paging import keyset, next_page f = line_filter(request.args) before = request.args.get("before") now = datetime.now(timezone.utc) async with current_app.db_sessionmaker() as db: source = await _source_or_404(db, source_id) stmt = keyset(filtered(select(SyslogLine).where(SyslogLine.source_id == source.id), f, now), SyslogLine.received_at, SyslogLine.id, before) lines, after = next_page((await db.execute(stmt)).scalars().all(), lambda ln: (ln.received_at, ln.id)) page_only = bool(before) or bool(request.headers.get("HX-Request")) hosts = {} if page_only else {h.id: h for h in await _hosts(db)} apps = [] if page_only else await apps_of(db, source.id, f.since(now)) per_hour = {} if page_only else await rates(db, [source.id], now) rows = [line_view(ln) for ln in lines] last_group = mark_day_groups(rows, fmt.zone(session.get("tz")), request.args.get("group", ""), at=lambda r: r["received_at"]) base = f"/plugins/syslog/sources/{source_id}?" ctx = {"source": source_view(source, hosts, per_hour.get(source.id, 0)), "lines": rows, "more_url": base + urlencode({**f.args(), "before": after, "group": last_group}) if after else None, "f": f, "filtered": bool({k: v for k, v in f.args().items() if k != "range"}), "severities": SEVERITY_CHOICES, "apps": apps, "ranges": list(RANGES)} if before: return await render_template("syslog/_lines_page.html", **ctx) template = "syslog/_lines_table.html" if request.headers.get("HX-Request") else "syslog/source.html" resp = await current_app.make_response(await render_template(template, **ctx)) resp.vary.add("HX-Request") return resp @syslog_bp.get("/panel") @require_role(UserRole.viewer) async def lines_panel(): """The syslog panel on a host's page (?host_id=) or an SNMP device's (?address=, and ?host_id= when it is bound): the newest lines of the sources that map to it. Nothing when no added source does.""" from steward.models.hosts import Host host_id = request.args.get("host_id") or None address = request.args.get("address") or None async with current_app.db_sessionmaker() as db: if host_id and not address: host = await db.get(Host, host_id) address = host.address if host is not None else None matched = sources_for(list((await db.execute( select(SyslogSource).where(SyslogSource.state == "accepted"))).scalars()), host_id, address) if not matched: return "" names = {s.id: s.name or s.hostname_seen or s.address for s in matched} since = datetime.now(timezone.utc) - PANEL_SPAN lines = (await db.execute( select(SyslogLine).where(SyslogLine.source_id.in_(list(names)), SyslogLine.received_at >= since) .order_by(SyslogLine.received_at.desc(), SyslogLine.id.desc()).limit(PANEL_LINES))).scalars().all() rows = [{**line_view(ln), "source": names[ln.source_id], "source_id": ln.source_id} for ln in lines] return await render_template("syslog/panel.html", lines=rows, sources=[{"id": sid, "name": name} for sid, name in names.items()])