Web UI
HTTPS dashboard that updates live from the finding event stream (see Live updates). Dark/light theme toggle.
Static assets use content-versioned URLs. Only a URL matching the served file receives immutable caching; older or unversioned URLs must revalidate. Replacing a file changes its version even when its size and modification time are preserved. Text assets use gzip when accepted by the client, except for byte-range requests.
Navigation
The sidebar groups pages by operator workflow. URLs are stable; the groups only reorder visibility:
- Overview - Dashboard
- Triage - Incidents, Findings (Active and History tabs)
- Response - Firewall, Quarantine, Cleanup History, Email Security, ModSecurity, Threat Intelligence
- Operations - Performance, Server Hardening, Audit Log
- Configuration - Rules, ModSecurity Rules, Verified Bots, Settings
A page has the same name in the sidebar, the browser tab and its heading.
The old /blocked address redirects to /firewall.
Sidebar group expand/collapse state is saved in the browser. On
viewports under 992px the sidebar collapses into a top-bar drawer
toggled from the hamburger button. Account detail (/account?name=<account>) is
not in the sidebar; the finding detail, account groups on Findings, incident
detail, the accounts targeted in a Threat Intel lookup and the dashboard’s
accounts-at-risk card link to it, and the command palette opens an account
typed by name. The palette also lists Sessions. Browser logins require administrator
scope. The header links to session management.
Pages
| Page | URL | Purpose |
|---|---|---|
| Dashboard | /dashboard | Triage queue, daemon status strip, Components matrix, system posture, 24h stats, accounts at risk, auto-response summary, brute-force summary, timeline charts. A queued finding opens its own detail, and each 24h severity count opens the History tab for the last 24 hours at that severity |
| Findings | /findings | Active findings with search, check/account filters, header grouping toggle, detail panel, fix/dismiss/suppress actions, a permanent Block for findings that report an attacker address, sticky bulk operations (fix, dismiss, suppress), modal account scan. The open finding is kept in the URL as ?key=<finding key>, so the link reopens it |
| Findings > History | /findings?tab=history | Paginated archive of all findings, newest first, with date range and severity filters, 25 to 200 rows per page (hperpage), CSV export; window=24h (1 to 720 hours) shows a rolling window instead of calendar days |
| Quarantine | /quarantine | Every file backup: quarantined files and cleaners’ pre-clean backups, with type, live state of the original path, content preview, restore and delete; filters by account, detector, type and date |
| Cleanup History | /cleanup-history | DB-object backups with preview and restore controls; file backups are on the Quarantine page |
| Firewall | /firewall | Subview-tabbed page (?view=overview/blocks/allow/config/audit/danger; ?ip=<address> opens the lookup for that address): blocked IPs/subnets with GeoIP, bulk unblock of selected rows (with undo), the whitelist and allow rules (Allow Rules tab), search, audit log; the lookup links to Threat Intel for the same address; destructive actions live under the Danger tab |
| ModSecurity | /modsec | WAF workbench: status strip, Active WAF pressure summary list (top attackers by hits), top rules / domains side panel, Blocked IPs / Events tabs, and a Manage Rules link to ModSecurity Rules. Block detail panels show first-seen, top URIs, sample events, and direct links to Threat Intel, Firewall lookup, and rule management |
| ModSecurity Rules | /modsec/rules | Enable or disable CSM rules (applied with one reload) and firewall escalation exclusions; the exclusion list works even when rule management is not configured |
| Email Security | /email | Headline numbers for the selected range, each opening the tab that explains it, then job tabs with counts: Overview (mail decisions chart, rspamd, groups needing attention, protection), Queue (why each message is stuck, with retry, return to sender, delete and thaw), Held mail (quarantined malware and held forward copies, to release or delete), Suspended (mailboxes and accounts CSM suspended, with live status and Release; releasing never changes the password), Rejects, Sending accounts (mail per hosting account, or per mailbox login on a Postfix host, and abuse events), Forwarders (each forwarder and where it sends, with delete per destination; a domain’s default address is changed in cPanel), Provider delays (providers and sending IPs deferring mail, and why) and Findings. ?tab= names the open tab. |
| Verified Bots | /verified-bots | Editor for the verified-crawler allowlist (reputation.verified_bots): UA, reverse-DNS suffix, and IP-range identities, plus auto-update posture, with apply-and-reload. Admin scope |
| Threat Intelligence | /threat | IP lookup with scoring/GeoIP/ASN (?ip=<address> runs it on load), 24 hour and permanent block and whitelist actions (single and bulk), top attackers, attack type charts, trends; the lookup links to Firewall for the same address, and the whitelist itself is kept under Firewall > Allow Rules |
| Server Hardening | /hardening | On-demand hardening audit, stored report, score, and remediation guidance. Web server directive checks follow Apache quoting, section comments, continuations, and shell include patterns. Quotes in ignored section suffixes do not cause warnings. Malformed section endings, unreadable includes, unresolved directive names, and unsupported wildcard classes produce warnings. On Apache or cPanel hosts, a configured Apache root takes precedence over default locations; a missing selected main configuration never falls back to another tree. Other servers skip the Apache audit when that main file is absent. |
| Incidents | /incident | Correlated incident list and grouped view, both filterable by every status, with detail panel and bulk status changes (contained, resolved, dismissed) for the selected incidents on the page, plus forensic timeline search by IP or account |
| Rules | /rules | YAML/YARA rule management, suppressions, state export/import, test alerts |
| Account | /account | Per-account analysis: findings, quarantine and history. An on-demand account scan runs from the Findings page |
| Audit Log | /audit | Every operator action in the Web UI and API, including logins, logouts and session revocations, with the credential that acted, search, action and date filters, URL state, and export. Failed logins go to the daemon log instead |
| Performance | /performance | Server load, PHP processes, MySQL, Redis, WordPress metrics |
| Settings | /settings | Searchable config editor with grouped large sections, field-level validation errors, restart notices, redacted secret updates, and firewall tentative apply with rollback timer. Commands, file paths, sockets and environment variable names are shown read-only and change only in csm.yaml; changing the rspamd or upstream address requires entering its credential again |
| Sessions | /sessions | Active browser logins, individual revocation and logout of every session (confirmed first) |
Audit attribution is captured when the action is authorized and remains available if the browser session expires or is revoked while the action runs.
Account views use the recorded finding owner when available, with account paths as a fallback. They also recognize resolved paths under linked account roots, including files already moved into quarantine.
Threat intelligence spam evidence
The Spam column shows spam and ham verdict counts and the current spam score. Click its heading to sort by score. The Spam evidence only filter requests senders with spam verdicts, including those with no attack events. The filter is kept in the URL for bookmarks and history navigation. When switching filters, previous rows stay unavailable for actions and export until a load succeeds.
Spam evidence about IPv6 senders is listed per /64 network. Such a row is named by the network and carries a Network badge. It has no checkbox and no block or whitelist buttons, and clicking it does not open the IP lookup. Looking up an address inside the network shows whichever spam evidence is stronger: the address’s own or the network’s. Ties use the network, which is named whenever its evidence is shown.
The Listing threshold badge means the spam score qualifies for the CSM IP map. It does not confirm an active listing: the feed must be configured and working, and address exclusions still apply. Spam scores remain separate from the unified threat score and firewall block status.
Dates and time zones
Every page shows dates in the time zone chosen under Preferences: the browser’s, the server’s, or a named zone. Date filters pick whole days in that zone. Changing the zone reloads the page so dates already on screen follow it, provided the browser can save and read back the preference. If browser storage is unavailable, new renders use the preference without forcing a reload. Days with a midnight clock change start at the first valid time of that day; a repeated midnight uses its first occurrence.
Email chart hours also follow partial-hour daylight saving changes. Custom date links include both selected days, even when supplied in reverse order. Long custom ranges group adjacent days into labeled spans without dropping counts. Changing the range discards pending results for the previous range.
Live updates
The Web UI keeps an event stream open (/api/v1/events) and shows a Live
indicator while it is connected. Findings are batched for up to a couple
of seconds before pages update:
- Findings shows the “new findings” banner at once instead of on its next check
- Dashboard sends desktop notifications and refreshes the 24h counts and the triage queue
- Incidents reloads the current list, unless incidents are selected for a bulk change
While the stream is connected, the checks those pages run on a timer slow down to once a minute as a safety net; when it drops they return to their normal pace. Pausing auto-refresh also pauses live updates.
Desktop notifications handle findings that arrive out of order within a batch or share a timestamp, without repeating them on the next history poll.
Refresh
The header shows when the page’s data was last loaded (“Updated N ago”). It moves when the page loads its data, on each automatic refresh and on the Refresh button; an action or a detail lookup does not change it. The pause button appears only on pages that refresh on a timer, and pauses that refreshing in this browser.
Refresh reloads the page’s data in place, keeping filters, scroll and open panels. On a page with unsaved edits (Settings, Verified Bots, staged ModSec rule changes) it asks before discarding them. Hardening’s Refresh reloads the stored report and does not run a new audit. Pages rendered by the server, such as Sessions, reload.
A panel that fails to load says what failed and why, with a Retry button that loads only that panel again. The panel’s earlier content returns once a later load succeeds.
The dashboard shows only what the host supports. Email Security appears when Exim, Postfix or Stalwart is detected; a mail server started after CSM shows up within five minutes. Its Queue, Held mail, Forwarders and Provider delays tabs, the antivirus lines of the Protection card, cPHulk actions on the Firewall page, the dashboard’s Email AV chip, and the Email AV, cPanel and webmail login, and known API token settings need cPanel and are not shown elsewhere.
On a host with no PHP interpreter, the PHP Shield, WordPress, WP-Cron, XML-RPC
and PHP process settings and the Performance page’s PHP cards are hidden; PHP
installed after CSM starts shows them within five minutes. PHP-FPM or lsphp in a
container counts as PHP. A container running only Apache with mod_php has no
separate PHP process and is not found. The PHP Shield settings show for
container PHP only when that container has the shield script at its usual
path. Hidden settings keep their values in csm.yaml, including when you save
another field in the same section.
The Suspended tab shows on cPanel and Stalwart hosts. On a Stalwart host it lists the mailboxes whose sign-ins CSM stopped, and Release allows them again. On a Stalwart host the first three Email Security cards show the mail Stalwart’s spam filter did not file to Junk, the mail it rejected or discarded, and the mail it filed to the Junk folder. The state line and mail decisions chart use Stalwart’s filter verdicts, independently of CSM’s antispam mode. The Spam rejected card opens Overview and has no mode badge. It shows a dash and “none logged yet” until CSM has a retained rejection or discard, including events outside the selected range. After that, it shows the range’s rejection count and the discarded count below it. The Mail delivered card also names unmatched verdicts. Missing verdict counts from an older daemon display as zero; they never fall back to rspamd counts. Large card counts are shortened, with the full count available in the value’s tooltip. The rspamd card and the Antispam line of the Protection card are not shown, as they describe CSM’s own antispam.
Rejects and Sending accounts read the Exim main log, or the Postfix mail log on a host without Exim. On Postfix a send is mail accepted from a client that logged in, counted under that login; mail relayed for a trusted host without a login is not counted. A Postfix reject whose reason cannot be told apart from text the client sent is listed under Other. Both tabs stay empty on a Stalwart host.
On Email Security, failed refreshes mark protection status as unavailable and hide stale chart data. An older response cannot overwrite newer health status or the selected outbound abuse range. Headline counts refresh every 30 seconds. Queue messages and composition, held mail, rejects, sending accounts, provider delays and Findings refresh every minute while their tab is open. Hidden tabs do not poll their lists; the Held mail, Sending accounts and Provider delays counts refresh every minute on any tab. On hosts without Stalwart’s filter, the rspamd state in the header also refreshes every minute on any tab. Unchanged results keep their rows; changed results retain paging, sorting, selection, open details and focus for items still present. Pending message, bulk and firewall actions stay disabled across refreshes. Queue actions wait up to a minute; an unreadable outcome is reported as unknown. Held mail custom ranges include only items held during the selected days; the summary also identifies held items outside that range. The other ranges have no end, so a server clock ahead of the browser cannot hide mail just held. Rejects, Sending accounts and Suspended use the Held mail layout, with a search box, a row count and 25 rows per page. Search rejects by sender, recipient, IP or detail, sending accounts by name, and suspensions by mailbox, owner account or reason. The address keeps the search. A new search starts on the first page. A refresh keeps the current page while the search and filters stay the same. Rejects lists up to the newest 200 rejects in the range and says when the list reaches that limit.
The visible History tab refreshes with its current filters and page size. Editors wait for an ongoing save or load before accepting another refresh; Verified Bots keeps edits made while a reload is pending. ModSecurity exclusion controls wait for the exclusion list to load, and a failed load stays visible instead of appearing as an empty list. Late responses cannot replace a newer account tab, settings section, history page, or finding detail, or reopen a finding detail that was closed.
Notifications
Success and information notices fade after five seconds. An error stays until you close it, and the same error is not shown twice while it is on screen.
Confirmations
A confirmation for an action that deletes data, blocks traffic, turns protection off or ends sessions names the action on a red button, such as Delete or Block, and starts with Cancel focused, so pressing Enter does not carry it out. Logging out every browser session asks first. Cancel keeps focus after the dialog finishes opening. A later text prompt uses its own normal OK button, and bulk actions keep one confirmation open at a time.
Bulk file actions
Select-all and every bulk action reach only the rows the table currently shows. Rows on other pages or hidden by a search or filter are never selected or acted on; set the page size to All to act on every row. Quarantine selection counts and buttons are refreshed whenever the visible rows change.
A failed file restore cleans up its own destination copy while retaining the quarantined evidence. A replacement created by another writer is preserved.
A mail message quarantined from a phishing finding is listed as two files, its header and its body. Restoring either one returns the whole message to the mail queue, and Exim delivers it on its next queue run. The complete body is returned before the header becomes visible to Exim. Restore refuses an incomplete message or a conflicting queue entry and keeps the quarantine copy. If restore or quarantine cleanup fails, retry the same entry. Progress survives a daemon restart, and a cleanup retry does not requeue an already delivered message. A header quarantined on its own can be restored if its body remains in the queue.
Quarantine deletes large file selections in sequential batches. If a request fails, later batches are not sent; the page reports the confirmed deletion count and refreshes the list. File restore and delete controls stay disabled until the operation and refresh finish, and Refresh waits for them.
Threat Intel bulk block and whitelist actions accept up to 100 selected IPs and retain one undo action. Larger selections must be narrowed before sending. Findings bulk fix also asks for a smaller selection when the request would exceed the API body-size limit, which includes finding details.
Findings bulk suppress creates one path rule per selected file, up to 100 files, with the file name matched literally. Selected findings that name no file are skipped; a rule for a whole check is made from one finding. Rules are saved one at a time, and a failure stops the rest and reports how many were saved.
Security
- Authentication - API bearer tokens in the header; opaque server-side browser sessions in HttpOnly/Secure/SameSite=Strict cookies
- CSRF - HMAC-derived token bound to the browser session on cookie-authenticated POST, PUT, PATCH, and DELETE requests; a form sends it in the body, never the query string
- Headers - X-Frame-Options DENY, Content-Security-Policy (scripts, styles and forms from the Web UI only; no plugins,
<base>or framing), HSTS, nosniff, and the legacy XSS auditor turned off - TLS - Auto-generated self-signed certificate, renewed automatically within 30 days of expiry and picked up without a restart; a certificate you install is never replaced, and replacing its files takes effect on the next connection. Renewal keeps the existing private key, so a failed certificate write leaves the working pair intact; explicitly configured certificate and key files must already exist
- Rate limiting - 5 credential attempts/min per IPv4 address or IPv6 /64, shared by login submissions and unknown bearer tokens on all authentication routes, including login GETs and unknown API paths. Concurrent requests share the limit; valid UI and metrics tokens used outside their scope do not consume it. Once exhausted, the budget rejects bearer requests before checking credentials. API and
/metricstraffic also has a 600 requests/min limit. - Token expiry - dashboard, API and metrics credentials expire at their configured
expires_atand never expire without one; expired credentials, malformed dates and future issue times are refused - Token sources - a token with
allowed_ipsis accepted only from those addresses and CIDR ranges, matched against the TCP peer - Token length - tokens shorter than 32 characters are reported as warnings at startup and by
csm validateandcsm doctor; they keep working - Bearer auth skips CSRF (for API-to-API calls)
Credential rotation
A credential expires only at its expires_at, a UTC RFC3339 time: set it
on a webui.tokens entry, or use webui.auth_token_expires_at and
webui.metrics_token_expires_at for the legacy and metrics tokens. A
credential without expires_at never expires, so configurations written
before these settings existed keep working. The optional issued_at
(webui.auth_token_issued_at, webui.metrics_token_issued_at) records when
the token was generated; expires_at must be later. Integrations should
narrow the scope (unban for customer self-unblock), list their source
addresses in allowed_ips, and set an expires_at that matches how often
they rotate. Reloads and restarts preserve the deadline. Active event
streams recheck the credential before sending each event or heartbeat.
Browser sessions and their form tokens use the credential that created the
session. Expiry of another administrator’s credential does not interrupt them.
To rotate, replace the token with a fresh random value of at least 32 characters, update its dates and distribute it to clients through your secret manager. Restart CSM after changing login or API credentials. Metrics token and date changes can be applied together with SIGHUP. Changing a date alone is not rotation.
Package installation keeps newly generated credentials out of subprocess arguments. Rotate credentials generated by earlier packages because local users could have observed them in process listings during installation.
An expired credential or an invalid date disables that credential and
produces a warning at startup and through csm validate and csm doctor. Detection and
alerting continue. If all admin credentials expire, update the root-owned
configuration locally and restart CSM to recover dashboard access. Use
token.expires_at.v1 in the capabilities API to detect this policy.
Browser sessions
Log in with an administrator credential from webui.tokens (or the migrated
legacy webui.auth_token). The cookie contains a new random session secret;
the reusable API credential never appears in it. Old token-valued cookies are
rejected, so an upgrade requires a fresh login. Read-scope API tokens cannot
create browser sessions.
Use Sessions in the header (/sessions) to see login names, client address,
browser, creation time, last activity and absolute expiry. Revoke one session
or log out every browser, including your own. These operations do not rotate
API credentials. Logout uses a CSRF-protected POST. Logout and revocation
accept the same browser origins as API writes (webui.allowed_origins); the
login form does not check the origin.
webui:
session_lifetime: "24h"
session_idle_timeout: "30m"
Both durations require a restart. Lifetime must be between one second and 30 days; idle timeout must be at least one second and no longer than lifetime. Zero does not disable expiry. Idle time means time without operator activity: page loads and API requests made within a minute of keyboard, pointer or scroll input. Background polling by an open page does not count, including metrics scrapes, HTML page fetches and event-stream connections. Browser navigation to a page counts as a page load; fetching that page on a timer does not. The activity marker is recalculated when each API request is sent, so a dashboard left open still logs out after the idle timeout. Activity is committed at bounded intervals, so idle expiry can occur slightly early, never late. Passive event-stream heartbeats do not extend the session; streams check revocation and expiry before each event and heartbeat.
A browser session also loses access when its login credential expires. Every daemon restart invalidates all browser sessions. Token removal, rotation, name or scope changes take effect after the required restart; log in again with a current administrator credential. Reauthentication creates a new session and revokes the previous one. Operator preferences remain tied to the login credential, so a new session does not reset them.
The local transactional store keeps session verifiers, never raw cookie secrets.
Failed persistence cannot issue a login or claim successful revocation. If the
previous session cannot be read during reauthentication, login fails without
issuing a replacement cookie or changing that session. Concurrent requests
preserve the latest committed activity even when they arrive out of order.
If the session store is unavailable, browser authentication fails closed; API bearer
authentication remains independent. Session admission is bounded and refuses new
logins at capacity instead of evicting active sessions. The login response says
so; wait for idle sessions to expire, or revoke sessions from a logged-in
browser or with an admin API token (DELETE /api/v1/sessions). Expired sessions are removed during admission, and startup clears
the session records. Backup exports exclude live session records, and full
restores discard any session records from older archives.
MFA is a separate planned feature. See the session management guidance for the security principles behind opaque identifiers, expiry and revocation.
Keyboard Shortcuts
General
| Key | Action |
|---|---|
? | Show shortcut help |
/ | Focus search input |
Ctrl-K / Cmd-K | Open command palette |
Navigate
| Key | Action |
|---|---|
g d | Go to Dashboard |
g f | Go to Findings |
g h | Go to Findings > History tab |
g t | Go to Threat Intel |
g r | Go to Rules |
g b | Go to Blocked IPs (Firewall) |
Findings page
| Key | Action |
|---|---|
j / k | Move selection down/up (focus moves to the row) |
o / Enter | Open selected finding |
d | Dismiss selected finding |
f | Fix selected finding |
Finding and incident rows, finding group headers and sortable table headers also work from the keyboard: Tab to them and press Enter or Space. A sorted header reports its order to screen readers. Closing the detail panel or a dialog returns focus to what opened it, and a dialog opened from the detail panel keeps Tab and Escape to itself. If a refresh removes the opener, focus returns to the open detail panel or main content. Shortcuts act on the focused finding and stay inactive while a dialog or detail panel is open.
Each finding row offers up to four actions: Fix (apply the automated remediation, shown only when one exists), Re-check (re-evaluate the finding against the live filesystem and clear it if the condition is gone, useful after fixing something by hand instead of waiting for the next scan), Dismiss (stop alerts for it while it stays unchanged; a later scan that still finds it lists it again, and undo is offered for 30 seconds), and Suppress (create a rule to hide similar findings for good). A finding cleared by Fix or Re-check is new again when a later scan finds it, so a reinfection alerts. A detection or dismissal that arrives while Fix or Re-check runs stays in place.
Dismissing a finding about a file’s content, such as a malware match, covers that content only. When the file changes, the finding alerts again as a new detection, and automatic responses can act on it. A scan that could not read the file does not end its dismissal. The “new findings” banner appears when a listed file’s content changes. If the file changed after the page loaded, the dismissal is refused and the list refreshes with a warning. A bulk dismissal still dismisses the unchanged findings, and undo covers only those.
Dismissal undo preserves later dismissals, successful re-checks and baseline resets. Findings first received in real time stop alerting when dismissed, even before the next scheduled scan records them.
Re-check appears only when CSM can test a current condition again. Supported
targets include file permissions and content, phishing and .htaccess files,
selected accounts and system integrity checks, WordPress core/plugins, CMS
database rows, administrator accounts, and database objects. Re-check uses the
stored finding identity and current host state; the browser cannot substitute a
different path, row, account, or object.
YARA Re-check compares the complete scanned content with the finding’s recorded
fingerprint, including large files admitted by thresholds.full_scan_max_file_mb.
If the content is unchanged and YARA no longer flags it, the finding clears.
The operation fails closed. Missing or unreadable evidence, package-manager errors, failed CMS discovery, and failed database queries leave the finding active. A file whose bytes changed since detection is never cleared either, because a partial clean and an evasion edit look alike. When the replacement can be proven inert, an empty file or a comment-only stub, the finding drops to Warning instead of clearing, and the original severity comes back if the file stops being inert. Historical events such as login attempts, WAF blocks, and IP reputation cannot be re-evaluated and therefore have no Re-check action. Broad aggregates and dependency findings require a new account or full scan.
WHM Plugin
CSM installs a WHM plugin (addon_csm.cgi) that redirects operators from WHM to the daemon Web UI. After the redirect, API calls are same-origin requests to the daemon.
API requests that carry a browser Origin header are accepted from https://<hostname>:<port> (the configured hostname and webui.listen port), from an https loopback origin such as https://localhost:9443 over an SSH tunnel on any local port, and from every origin listed in webui.allowed_origins (bare https://host[:port] entries, hot-reloadable). A loopback origin is accepted only when it is the origin the request was sent to (its Host): another local service in the same browser shares the Web UI’s cookies, which ignore the port, and is refused. Any other origin gets 403 Cross-origin request blocked, which shows up as a read-only UI: pages load but every action fails. The Host header is used only for this loopback comparison; it never admits a non-loopback origin. A preflight (OPTIONS) from an accepted origin is answered with the methods and request headers the API takes, so a credentialed JSON write from a listed origin goes through.