Platform documentation

USS — Unified Security Stack

Unified Security Stack (USS) is a self-hosted platform that combines Security Information and Event Management (SIEM) with Security Orchestration, Automation and Response (SOAR), so you can detect, investigate and respond to threats across servers, endpoints, containers and cloud workloads from one console.

1agent per endpoint
3central components
0–15alert severity levels
5+compliance frameworks

Instead of operating separate tools for log management, file integrity, vulnerability scanning, configuration auditing and incident response, USS provides all of them through one agent, one analysis engine, one data store and one console.

Building blocks

Extended modules

Extended modules add orchestration, case management, threat intelligence, behavioral analytics and central identity. They run on your own infrastructure next to the core components and share one sign-on.

Explore the docs

Feature catalog

All USS capabilities, grouped by area. Core features are part of every deployment. Module features come with an extended module. Integration features connect USS to a specific external system and are set up per deployment.

Data collection

FeatureWhat it lets you doType
Universal endpoint agentOne lightweight agent for Linux, Windows, macOS and Unix servers and workstations.Core
Log file and event-channel collectionRead text, JSON and multi-line logs, Windows event channels (including Sysmon), Linux audit and journald.Core
Syslog receiver (UDP/TCP)Collect logs from network devices, firewalls, IDS/IPS, hypervisors and appliances that cannot run an agent.Core
Command and query monitoringRun commands or queries on a schedule and analyze their output as events.Core
System-call auditingRecord program execution, privileged commands and sensitive file access on Linux.Core
Osquery integrationRun scheduled SQL-style queries on hosts and analyze the results.Core
Agentless monitoringCheck configuration and file changes on devices over SSH, without an agent.Core
Cloud service collectionPull audit and security logs from public-cloud and SaaS APIs.Core
Container monitoringTrack container lifecycle events and collect container logs.Core
Load-balanced agent connectionsSpread agent traffic across server nodes and fail over automatically.Core
Third-party security platform connectorsIngest alerts, events, incidents, process trees and evidence from EDR and other platforms through their REST APIs.Integration
Virtualization inventoryCollect host and virtual-machine inventory and state from virtualization management APIs.Integration

Detection and analytics

FeatureWhat it lets you doType
Decoding and normalizationTurn raw logs from many technologies into structured, searchable fields.Core
Correlation rulesDetect patterns across events: frequency, time windows, same source or user, and rule chains.Core
Custom rules and decodersWrite detections and parsers for in-house applications and devices.Core
MITRE ATT&CK mappingSee the tactic and technique behind each alert, and review coverage by technique.Core
Severity levels 0–15Prioritize alerts consistently and set thresholds for notification and response.Core
Indicator lists (CDB)Match events against lists of known-bad or allowed IPs, domains, hashes and users.Core
Rootkit and anomaly checksFind hidden processes, files and ports, and trojaned system binaries.Core
Malware detectionCombine file monitoring, indicator matching and on-demand YARA scans.Core
Antivirus log analysisCorrelate detections from installed antivirus products with other events.Core
Ruleset testingTest how any log line is decoded and which rule fires before you deploy a change.Core
Behavioral analytics (UEBA)Find unusual user, host and traffic behavior with machine-learning anomaly detectors, per entity, in real time or over history.Module

Endpoint and IT hygiene

FeatureWhat it lets you doType
File integrity monitoringDetect changes to files and Windows registry keys in real time or on a schedule.Core
Who-dataSee which user and process changed a monitored file.Core
Change diffSee the exact content change of monitored text files.Core
Configuration assessmentCheck systems against CIS-based and custom hardening policies, with remediation steps.Core
Vulnerability detectionFind hosts with known CVEs from their software inventory; works with an offline feed.Core
System inventoryTrack hardware, OS, packages, services, ports, processes, users and updates per host.Core

Response and orchestration

FeatureWhat it lets you doType
Active responseRun actions such as blocking an IP or disabling an account automatically when a rule fires.Core
Timed rollbackReverse a response action automatically after a set time.Core
PlaybooksAutomate multi-step workflows across systems: enrich, decide, act, record.Module
Approval stepsRequire an analyst's approval before high-impact actions run.Module
Case managementManage incidents with evidence, timelines, tasks and assignment.Module
Visual workflow editor and app builderBuild playbooks on a canvas and create connectors from any OpenAPI specification.Module
Alert inbox and triageReceive, assign, merge and escalate alerts into cases.Module
Timeline, evidence and reportsBuild attack timelines, register evidence with hashes, and generate case reports.Module
Firewall blocking connectorsBlock and unblock addresses and indicators on firewalls through their management APIs, and verify the result.Integration
EDR response actionsIsolate hosts, kill processes or quarantine files through EDR APIs from playbooks.Integration
Email alerts and daily reportsSend filtered alert emails and scheduled summaries.Core
Alert forwardingForward alerts as syslog, JSON or CEF to other systems.Core
NotificationsSend alerts by email, syslog or webhooks to chat and ticketing systems.Core

Threat intelligence

FeatureWhat it lets you doType
Indicator storeKeep IPs, domains, URLs and hashes with source, confidence and expiry.Module
Standard exchange formatsImport and export indicators as STIX/TAXII, JSON and CSV.Module
Indicator feedsPublish block lists that firewalls, proxies and DNS filters can consume.Module
Correlation and knowledge baseLink related events and attach ATT&CK techniques, threat actors and malware families.Module
Warning lists and decay scoringFilter common false positives and retire stale indicators automatically.Module
Rule and DNS exportsGenerate IDS rules and DNS RPZ zones from indicators.Module
Partner sharingSynchronize intelligence with trusted organizations, with distribution controls.Module
Detection syncPush indicators into USS detection automatically.Module
FeatureWhat it lets you doType
Full-text and field searchSearch alerts and archived events by keyword, field and time range.Core
Scheduled PDF reportsProduce reports from dashboards and module views on a schedule.Core
DashboardsUse built-in dashboards per module and build your own.Core
Reports and exportGenerate PDF reports and export results as CSV.Core
Compliance viewsReview alerts and checks mapped to PCI DSS, GDPR, HIPAA, NIST 800-53 and TSC controls.Core
Tiered retentionKeep recent data searchable and older data in compressed archives, for a year or longer.Core
Archive integrityHash archived logs so you can show they were not altered.Core

Platform, access and integration

FeatureWhat it lets you doType
Self-hosted deploymentRun every component on your own servers or virtual machines.Core
Clustering and high availabilityScale servers and indexers horizontally and survive node failures.Core
Offline updatesUpdate detection content, vulnerability feeds and agents in air-gapped environments from a local mirror.Core
Centralized agent configurationManage agent settings by group and upgrade agents remotely.Core
Role-based access controlLimit what each user and API client can see and do.Core
Directory and single sign-onSign in with LDAP / Active Directory accounts, with one login for all consoles.Core Module
Multi-factor authenticationRequire one-time codes or security keys at sign-in.Module
Fine-grained data securityLimit access by index, document and field.Core
Custom brandingShow your own logos and names in the consoles and reports.Core
Multi-tenancySeparate data and dashboards for different teams or organizations.Core
REST API with OpenAPI specificationAutomate operations: status, agents, rules, indicators, response actions, users and roles.Core
Unified API gatewayReach core and module functions, including cases and playbooks, through one documented API.Integration
Outbound REST integrationCall internal and third-party REST APIs from response actions and playbooks.Integration

Architecture

USS consists of three central components plus a universal endpoint agent. Agents send data to the USS Server, which analyzes it and forwards alerts to the USS Indexer. The USS Dashboard reads from the Indexer and manages the Server through the USS API.

Components

ComponentRoleKey functions
USS AgentMulti-platform endpoint software (Linux, Windows, macOS, Solaris, AIX, HP-UX).Log collection, file integrity monitoring, configuration assessment, system inventory, malware/rootkit detection, command execution, active response execution, container monitoring, cloud API polling.
USS ServerCentral analysis and management engine.Agent enrollment and connection service, decoding and rule-based analysis, vulnerability correlation, active response orchestration, centralized agent configuration, RESTful USS API, alert forwarding to the Indexer, clustering.
USS IndexerScalable full-text search and analytics engine.Stores alerts, raw archives (optional), system inventory and vulnerability state as JSON documents; supports sharding, replication and index lifecycle policies.
USS DashboardWeb user interface.Security event visualization, threat hunting, MITRE ATT&CK view, compliance dashboards, agent management, RBAC-controlled access, multi-tenancy, custom dashboards and reports.
USS Orchestrator Add-onSecurity orchestration and automation.Playbooks triggered by alerts or analysts; calls USS active response and external APIs (firewalls, EDR, business applications); approval steps.
USS Case Management Add-onIncident and case handling.Cases created from alerts, evidence, timelines, tasks, analyst assignment, case reports and API.
USS Threat Intelligence Add-onIndicator management and sharing.IOC store, STIX/TAXII, JSON and CSV import/export, sync to USS IoC lists, feeds to firewalls.
USS Analytics Add-onBehavioral analytics.Machine-learning anomaly detectors running on the USS Indexer; anomalies raised as alerts.
USS Identity Add-onIdentity and single sign-on.SSO over OpenID Connect / SAML, LDAP / Active Directory federation, MFA, central roles, sign-in audit.

Core components and extended modules share one sign-on through USS Identity and are reached from a single entry point.

Ports & protocols

ComponentPortProtocolPurpose
USS Server1514TCP (default) / UDPAgent connection service (event data)
1515TCPAgent enrollment service
1516TCPServer cluster communication
55000TCPUSS API (HTTPS)
USS Indexer9200TCPIndexer REST API / data ingestion
9300–9400TCPIndexer cluster communication
USS Dashboard443TCPWeb user interface (HTTPS)
Optional514TCP / UDPSyslog collector for agentless devices

Encryption in transit. Agent ↔ Server traffic is encrypted with AES using per-agent keys created at enrollment. Server ↔ Indexer and Dashboard ↔ Indexer use TLS; analysts reach the Dashboard over HTTPS; the USS API is served over HTTPS with JWT authentication.

Deployment models

All-in-one

Server, Indexer and Dashboard on one host. For labs, PoC and small environments.

Single-node distributed

Each central component on its own host. Better isolation and sizing for medium environments.

Multi-node cluster

Server cluster (master + workers behind a load balancer) and Indexer cluster (3+ nodes) for high availability.

In a Server cluster, the master node holds the authoritative configuration (rules, decoders, agent groups, centralized agent configuration) and synchronizes it to worker nodes; workers receive agent traffic and synchronize agent state back to the master. Agents should point to a load balancer (or a list of server addresses) so they can fail over between workers.

Data flow

Every event follows the same pipeline from the endpoint to the analyst's screen.

Collectagent / syslog / API
Transportencrypted, queued
Decodeextract fields
Rule matchlevel, groups, MITRE
AlertJSON, response
IndexUSS Indexer
VisualizeUSS Dashboard
  1. CollectionThe USS Agent reads log files, Windows event channels, journald, command output and module results (FIM, SCA, inventory). Devices without an agent send syslog or are polled through cloud provider APIs.
  2. TransportEvents are buffered on the agent (anti-flooding queue) and sent encrypted to the USS Server on port 1514.
  3. DecodingPre-decoding extracts timestamp, hostname and program name; decoders then normalize the event into structured fields such as srcip, srcuser, url, status.
  4. Rule evaluationRules match decoded fields, apply correlation (frequency, time windows, same source) and assign a severity level 0–15, groups, compliance tags and MITRE ATT&CK techniques.
  5. AlertingEvents at or above the alert threshold (default level 3) become alerts, written to /var/uss/logs/alerts/alerts.json. Optionally all events are archived to /var/uss/logs/archives/. Active response and integrations trigger here.
  6. IndexingThe alert forwarder on the Server ships alerts over TLS into the USS Indexer as daily indices (<alerts-index>-YYYY.MM.DD).
  7. VisualizationThe USS Dashboard queries the Indexer for alerts and state, and the USS API for live agent and management data.

Endpoint security

Capabilities that run on every USS Agent to keep endpoints hardened, intact and patched.

SCAFIMMalware detectionVulnerability detectionSystem inventory

Security Configuration Assessment (SCA)

SCA verifies that endpoints conform to hardening policies. Policies are YAML files containing checks for files, directories, registry keys, running processes and command output. Built-in policies are based on CIS benchmarks; custom policies can be written for organization-specific baselines.

Each check returns passed, failed or not applicable, with rationale and remediation guidance, and is mapped to compliance controls. Default scan interval: 12 hours. See the SCA configuration.

File Integrity Monitoring (FIM)

FIM builds a baseline of checksums and attributes (size, permissions, owner, inode, modification time, hashes) for monitored paths and alerts when files or Windows registry keys are created, modified or deleted.

ModeOptionBehavior
ScheduledfrequencyPeriodic scan — default every 12 h (43200 s).
Real-timerealtime="yes"Immediate detection using inotify (Linux) or native notifications (Windows).
Who-datawhodata="yes"Records who made the change and with which process (Linux audit / Windows SACL).
Report changesreport_changes="yes"Includes a text diff in the alert. Use nodiff to exclude sensitive files.

See the FIM configuration.

Malware detection

USS detects malicious activity through several layers:

  • Rootkit and anomaly detection — hidden files, processes and ports; trojaned binaries.
  • FIM-based detection of suspicious file drops in sensitive directories.
  • Custom rules on indicators of compromise and CDB lists of known-bad hashes and IPs.
  • YARA scanning triggered through active response.
  • Log-based detection of antivirus and EDR events.

Vulnerability detection

Agents report their software inventory (packages, applications, OS and hotfixes) to the Server. The vulnerability detection module correlates this inventory with a continuously updated CVE feed (online threat-intelligence repository or an offline mirror for air-gapped sites) and keeps the per-agent vulnerability state in the Indexer. Alerts are raised when a vulnerability is detected or resolved. See the vulnerability configuration.

System inventory (IT hygiene)

The inventory module collects hardware, operating system, installed packages, network interfaces and addresses, open ports, running processes, services, users and groups, browser extensions and (on Windows) installed updates. It supports asset management and IT hygiene reviews and is the basis for vulnerability detection. Default collection interval: 1 hour.

Log data collection

USS collects logs from endpoints, servers, applications, network devices and cloud services and analyzes them in one place. Collection runs on the USS Agent, on the USS Server's syslog receiver and in cloud modules.

Collection methods

MethodUse it for
Log filesAny text log on an agent; wildcards and date-based file names; plain, JSON, multi-line and syslog formats
Windows event channelsSecurity, System, Application, Sysmon, PowerShell, Defender and any other channel, with XPath query filters
Linux journald and auditsystemd journal with field filters; Linux audit records for system-call monitoring
macOS unified loggingmacOS system logs with predicate filters
Syslog receiverNetwork devices, firewalls, IDS/IPS, hypervisors and appliances over UDP or TCP, restricted to allowed source networks
Command outputOutput of scheduled commands analyzed as log events (see System monitoring)
Cloud APIsPublic cloud and SaaS audit logs (see Cloud sources)

Collection features

  • Agent labels: add custom fields (owner, environment, criticality) to every event from an agent.
  • Output formats: rewrite or enrich collected lines before sending them.
  • Multiple outputs: send the same log to the USS Server and to additional sockets or collectors.
  • Anti-flooding buffer: the agent queues events when the server is unreachable or a burst occurs, and limits events per second.
  • Encrypted transport from agent to server, with automatic failover between servers.

From log to alert

Every event is decoded into fields, checked against the rule set and, if it matches, stored as an alert with severity, groups and MITRE ATT&CK techniques. All events can also be archived for later search. See Data flow and Rules & decoders.

Threat detection & hunting

Centralized log analysis, rule-based correlation and MITRE ATT&CK mapping.

Log data analysis

USS collects logs from operating systems (syslog, journald, Windows Event Log channels including Sysmon), applications (web servers, databases, mail, proxies), security devices (firewalls, IDS) and cloud services, then decodes and correlates them centrally. Thousands of out-of-the-box decoders and rules cover common technologies.

Rule severity levels

LevelMeaning
0Ignored — no action taken.
1–4Low: system notices, successful events, low-relevance errors. Default alert threshold is level 3.
5–9Medium: user-generated errors, failed logins, first-time events, policy violations.
10–11High: repeated failures (e.g. brute force), integrity checksum changes, important anomalies.
12–15Critical: high-importance events, successful attacks, events requiring immediate attention.

Custom rules and decoders

Never edit files in the default ruleset directory — they are overwritten on upgrade. Put custom content in /var/uss/etc/decoders/local_decoder.xml and /var/uss/etc/rules/local_rules.xml, using rule IDs 100000–120000.

<group name="local,sshd,">
  <!-- Raise severity for SSH login failures from outside the corporate range -->
  <rule id="100100" level="10">
    <if_sid>5716</if_sid>
    <srcip>!10.0.0.0/8</srcip>
    <description>sshd: authentication failure from external address $(srcip)</description>
    <mitre><id>T1110</id></mitre>
    <group>authentication_failed,pci_dss_10.2.4,gdpr_IV_35.7.d,</group>
  </rule>
</group>

MITRE ATT&CK & threat hunting

Rules carry MITRE ATT&CK technique IDs, so alerts are automatically categorized by tactic and technique. Analysts hunt in the Dashboard by querying indexed alerts and archives, pivoting on agents, users, IPs, file hashes and techniques. CDB lists (key/value IoC lists) and threat-intelligence integrations enrich detection.

Malware detection

USS detects malware through several independent layers, so a threat missed by one layer can still be caught by another.

LayerHow it works
File integrity + threat rulesAlerts on new or changed executables, scripts and web files in sensitive directories, such as web shells and startup items.
Rootkit and anomaly detectionFinds hidden processes, hidden ports and files, trojaned system binaries, suspicious kernel modules and promiscuous interfaces.
Indicator listsMatches file hashes, IP addresses and domains from events against known-bad lists, which can be synced from USS Threat Intelligence.
YARA scanningScans new or changed files with YARA rules through active response; matches become alerts.
Antivirus log collectionCollects and analyzes detections from ClamAV, Windows Defender and other antivirus products.
Custom IOC rulesDetection rules for specific campaigns, tools or behaviors.
Online reputation lookupOptional hash lookup in an online malware database, only where internet access is allowed.

Detected files can be removed or quarantined automatically with a response script (see Incident response).

System monitoring

Beyond logs and files, USS watches what runs on a system and how it is configured.

Command monitoring

Agents run commands on a schedule and send the output for analysis. Examples: list listening ports, check disk usage, read installed security patches, check that a service is running. Rules alert when the output changes or matches a condition. Remote commands are disabled by default and have to be enabled per agent.

System-call monitoring

On Linux, USS uses the kernel audit system to record selected system calls: program execution, privileged commands, changes to sensitive files, and network connections by specific users. The events are decoded and correlated like any other log.

Agentless monitoring

For devices that cannot run an agent, such as routers, switches and appliances, the USS Server connects over SSH on a schedule. It runs integrity checks on files and directories and compares command output, such as running configurations, to detect changes.

Osquery integration

Agents can run osquery packs on a schedule and send the results to USS. Teams can then use SQL-style queries to examine processes, users, network sockets, browser extensions and other host state across the estate.

Agent anti-tampering

The agent can require a verification code before it can be uninstalled, so a local attacker cannot silently remove monitoring.

Incident response

Automated containment through active response, plus alert delivery to the tools your team already uses.

Active response

Active response executes scripts automatically when specific rules, rule groups or severity levels are triggered.

Stateless

One-time action with no revert — e.g. delete a file, send a notification.

Stateful

Action is reverted after a timeout — e.g. block an IP for 10 minutes.

LocationWhere the action runs
localOn the agent that generated the event
serverOn the USS Server
defined-agentOn a specific agent (by ID)
allOn all agents

Built-in response scripts

ScriptPlatformAction
firewall-dropLinux / UnixBlock an IP address with the host firewall (iptables / nftables)
host-denyLinux / UnixAdd an IP address to /etc/hosts.deny
route-nullLinux, WindowsSend traffic to an IP address into a null route
netshWindowsBlock an IP address with Windows Firewall
disable-accountLinux / UnixLock a user account
restartAllRestart the USS agent or server service (for example after a configuration push)
Firewall-specific scriptsLinux / UnixBlock with ipfw, npf, pf or firewalld
Custom scriptsAllAny executable that reads the alert as JSON from standard input: quarantine a file, kill a process, call an API

Response actions can be limited to specific agents, and they can also be run on demand from the API. See the active response configuration.

Alert delivery

ChannelWhat it does
Email alertsSend alerts by email, filtered by level, rule ID, rule group, agent or location. Also supports grouped digests and a per-hour limit.
Daily reportsEmail scheduled summaries of alerts, filtered by group, level or source.
Syslog outputForward alerts in syslog, JSON or CEF format to other systems.
Integrations (webhooks)Push alerts to chat, paging and ticketing tools, to USS Orchestrator, or to any custom script or HTTP endpoint.
Socket outputsStream events to local sockets or a Fluent Forward collector for further processing.
File-reputation lookupCheck hashes of changed files against an online reputation service. Optional, and only usable where internet access is allowed.

Cloud & container security

The same detection pipeline applied to cloud accounts, cloud workloads and containers.

Cloud provider monitoring

Audit and security logs from AWS (CloudTrail, GuardDuty, VPC Flow, S3), Microsoft Azure / Microsoft 365 / Graph, and Google Cloud (Pub/Sub, storage buckets).

Cloud workload protection

USS Agents on cloud VMs provide the same FIM, SCA, vulnerability and log capabilities as on-premises.

Container security

Docker listener tracks container lifecycle events (start, stop, exec, image pull); agents on hosts and Kubernetes nodes monitor runtime behavior and container logs.

Posture management

SCA policies and cloud audit rules detect misconfigurations in cloud infrastructure and services.

Supported cloud sources

ProviderServices and logs
Amazon Web ServicesCloudTrail, VPC Flow Logs, GuardDuty, Config, KMS, Macie, Inspector, Trusted Advisor, WAF, S3 server access logs, ALB/CLB/NLB logs, CloudWatch Logs, Security Lake
Microsoft AzureLog Analytics workspaces, Microsoft Graph (Entra ID sign-ins and audit), Azure Storage blobs
Microsoft 365Office 365 Management Activity (Exchange, SharePoint, Teams, Entra ID); Microsoft Graph security resources
Google CloudPub/Sub subscriptions (Cloud Audit Logs, DNS, firewall) and Cloud Storage bucket logs
GitHubOrganization audit log

Container monitoring

  • Docker listener: records container create, start, stop, pause, exec, delete and image pull events with the user and image.
  • Container logs: collects logs written by containers through the host agent.
  • Host hardening: CIS policies for container hosts, with FIM on container configuration files.
  • Kubernetes: agents on nodes, plus collection of Kubernetes audit logs for API-level activity.

Regulatory compliance

Rules and SCA checks are tagged with control identifiers, so the Dashboard can produce per-standard compliance views and audit evidence.

StandardHow USS helps
PCI DSSLog collection and retention, FIM, vulnerability management, configuration assessment, access monitoring.
GDPRMonitoring access to personal data, breach detection and notification support.
HIPAAAudit controls, integrity controls, access monitoring for ePHI systems.
NIST SP 800-53Audit and accountability (AU), configuration management (CM), system integrity (SI), incident response (IR).
TSC (SOC 2)Evidence for security, availability and confidentiality criteria.

USS Orchestrator

Delivery: Add-on module

USS Orchestrator is the security orchestration, automation and response (SOAR) engine of USS. Analysts build workflows (playbooks) in a visual editor. A workflow chains enrichment, decisions, approvals and actions across USS and the other systems in your environment.

Capabilities

FeatureWhat it lets you do
Visual workflow editorBuild workflows by connecting actions on a canvas, without writing code
TriggersStart workflows from USS alerts (webhook), on a schedule, from another workflow, from a form, or manually
User input and approvalsPause a workflow until an analyst approves, rejects or adds information (by web link or email)
Conditions, loops and variablesBranch on alert fields or results, iterate over lists, and pass data between steps
App libraryUse ready-made connectors for security, IT and messaging tools, and HTTP and SSH actions for anything else
App builderCreate a connector for any REST API from its OpenAPI specification, or write a custom app in Python
Code stepsRun small Python or shell steps to transform data inside a workflow
Sub-workflowsReuse common logic, such as "enrich an IP" or "block an IP", across many workflows
Execution historySee every run step by step with inputs, outputs and errors, and re-run it
DatastoreKeep state between runs (for example, already-handled alerts or block expiry times)
Workflow templatesImport, export and share workflows as files
Organizations and rolesSeparate teams or tenants and control who can edit and run workflows
On-premises workersRun workflow actions on worker nodes inside isolated network zones, and scale them out for load
REST APICreate, run and manage workflows and read execution results from other systems

Example workflow: brute-force attack

  1. TriggerA USS alert for repeated authentication failures from one source address.
  2. EnrichCheck the address against USS Threat Intelligence and internal allow lists.
  3. DecideIf the address is internal or allow-listed, notify only. Otherwise continue.
  4. RespondBlock the address on the perimeter firewall through its management API, for a set time (see Integrations).
  5. RecordCreate or update a case in USS Case Management with the alert, enrichment results and the action taken.
  6. RevertWhen the block period ends, remove the block and add the result to the case.

Typical workflows

  • Phishing triage: extract URLs and attachments, check them, and block the sender and domains.
  • Malware on endpoint: isolate the host through the EDR, collect evidence and open a case.
  • Compromised account: disable the account, revoke sessions and notify the user's manager.
  • Vulnerability follow-up: open tickets for hosts with critical CVEs and track remediation.
  • Alert enrichment: add asset owner, geolocation and indicator reputation to every high-severity alert.

How it connects to USS

  • Receives alerts from the USS Server by webhook, filtered by rule level, rule group or rule ID.
  • Calls the USS API to run active response, read agent data and manage IoC lists.
  • Creates cases and indicators in USS Case Management and USS Threat Intelligence.
  • Signs users in through USS Identity and runs fully on-premises.

USS Case Management

Delivery: Add-on module

USS Case Management is the incident-response workspace. Analysts triage incoming alerts, open cases, and record everything about an investigation in one place: affected assets, indicators, timeline, evidence, tasks, notes and the final report.

Capabilities

FeatureWhat it lets you do
Alert inboxReceive alerts from USS and USS Orchestrator, then triage, assign, merge related alerts and escalate them into cases
CasesTrack incidents with severity, status, owner, classification and the affected organization or unit
Case templatesStart new cases with predefined tasks and notes for each incident type
AssetsList affected hosts, accounts and services, with their compromise status
Indicators (IOCs)Record IPs, domains, hashes and other indicators with TLP labels, and share them with USS Threat Intelligence
TimelineBuild the attack timeline from events, link events to assets and indicators, and view it as a graph
Evidence registryRegister files and data with hashes and chain-of-custody details
TasksAssign investigation and remediation steps and track their progress
NotesWrite collaborative Markdown notes organized by topic
ReportsGenerate investigation and activity reports from customizable templates
Enrichment modulesLook up indicators automatically and run custom processing when objects are created or updated
Access controlSet group- and case-level permissions so sensitive cases are visible only to the right people
Activity logKeep a full audit trail of who changed what in each case
Dashboards and statisticsSee open cases, workload and response times
REST APICreate and update alerts, cases, assets, indicators and evidence from other systems

How it connects to USS

  • USS alerts arrive through USS Orchestrator, so related alerts are grouped into one case.
  • Indicators in a case can be pushed to USS Threat Intelligence, and from there to detection and firewalls.
  • Users sign in through USS Identity, with roles aligned to USS roles.

USS Threat Intelligence

Delivery: Add-on module

USS Threat Intelligence is the platform for collecting, correlating, scoring and sharing indicators of compromise and threat information. It feeds USS detection, playbooks and network security devices.

Capabilities

FeatureWhat it lets you do
Events, attributes and objectsStore threat information as structured events containing indicators (IP, domain, URL, hash, email, file and more) and richer objects
Automatic correlationLink events that share indicators, to reveal related campaigns and infrastructure
Taxonomies and tagsClassify information with TLP, PAP, confidence and custom tag vocabularies
Threat knowledge baseAttach MITRE ATT&CK techniques, threat actors, malware families and tools to events
Warning listsFlag common false positives, such as public DNS resolvers and major cloud ranges, before they become blocks
Indicator scoring and expiryLower the score of indicators over time with decay models, so stale data is removed from block lists
SightingsRecord when an indicator was seen in your environment, to show which ones are relevant
FeedsSubscribe to external or internal feeds, or load feed files offline
Synchronization and sharingExchange intelligence with partner organizations, controlled by distribution levels and sharing groups
Import formatsSTIX 1/2, TAXII, CSV, JSON, OpenIOC and free text
Export formatsSTIX 2, CSV, JSON, plain-text block lists, DNS RPZ zones, and IDS rules (Suricata, Snort, Zeek)
TAXII 2.1 serverPublish collections that other platforms can pull in a standard way
REST API and event streamsSearch and manage intelligence from scripts and playbooks, and subscribe to real-time change notifications

Distribution to USS and network devices

  • USS detection: indicators are synced to USS IoC lists, so matching events raise alerts.
  • Firewalls and network security devices: indicator lists published as feeds that devices poll, or pushed through the devices' management APIs (see Integrations).
  • Web proxies and DNS filters: domain and URL indicators published as block lists or RPZ zones.
  • IDS/IPS: generated rule files for network sensors.

Isolated networks

In a network without internet access, feed files are brought in through the internal update server and imported on a schedule. No outbound connection is needed (see Offline updates).

USS Analytics

Delivery: Add-on module

USS Analytics adds machine-learning anomaly detection to the USS Indexer. Detectors learn the normal pattern of a metric and flag significant deviations in near real time, including behavior that no fixed rule describes. It runs inside your network; no data leaves the environment.

Capabilities

FeatureWhat it lets you do
DetectorsDefine what to watch (an index and a filter) and how often to evaluate it
FeaturesModel one or more metrics per detector: counts, sums, averages, minimums, maximums or custom aggregations
Per-entity detectionLearn a separate baseline for each user, host or source address, so unusual behavior of one entity is not hidden by the average
Real-time and historical analysisDetect anomalies as data arrives, or analyze past periods to find earlier incidents
Anomaly grade and confidenceRank each anomaly by how unusual it is and how certain the model is
Unsupervised learningNo labeled training data needed: models adapt to seasonal and changing patterns
Result visualizationSee anomalies over time and drill into the contributing features and entities
AlertingTurn anomalies above a grade threshold into USS alerts or workflow triggers
APICreate, start, stop and query detectors programmatically

Example detectors

DetectorFinds
Authentication behavior per userUnusual login volume, time of day or failure rate
Host activitySudden changes in process, service or file-change activity
Network volumeUnexpected spikes in traffic or connections that may indicate exfiltration or scanning
Privileged accountsRare administrative actions or access from unusual sources
Alert volumeBursts of alerts of one type, such as a worm spreading or a misconfigured system

Detectors are tuned during deployment against a baseline period of your own data.

USS Identity

Delivery: Add-on module

USS Identity provides single sign-on and central identity management for all USS consoles: Dashboard, Orchestrator, Case Management and Threat Intelligence. Users sign in once with their directory account, and roles are managed in one place.

Capabilities

FeatureWhat it lets you do
Single sign-onOne login for every USS console, over OpenID Connect and SAML 2.0
Directory federationUse existing LDAP and Active Directory accounts and groups, with scheduled synchronization; Kerberos sign-in on domain-joined machines
Identity brokeringAccept sign-in from other identity providers when needed
Multi-factor authenticationRequire one-time codes (TOTP) or security keys and passkeys (WebAuthn) for some or all users
Central roles and groupsMap directory groups to USS roles, such as administrator, analyst or read-only, in one place
Password and session policiesEnforce password rules, session lifetimes and idle timeouts
Brute-force protectionLock out accounts temporarily after repeated failed sign-ins
RealmsSeparate users and settings for different organizations or environments
Self-service account consoleLet users manage their own MFA devices and sessions
Audit eventsLog every sign-in, failure and administrative change, and forward these logs to USS for monitoring
BrandingShow the USS look and feel on sign-in pages
High availabilityRun in a cluster with shared state
Admin REST APIAutomate user, group and role management

Integrations

USS connects to the security and IT systems around it: it collects their data, sends them alerts and indicators, and triggers actions in them. Collection by agent or syslog is part of the core. Integrations marked Custom integration use the external system's API and are built and configured for each deployment.

Integration categories

CategoryData into USSActions from USS
Firewalls and network securityTraffic, threat and admin logs (syslog)Block / unblock addresses and indicators; publish indicator feeds
EDR and endpoint protectionAlerts, incidents, process trees, evidence (API)Isolate host, kill process, quarantine file
Directory and identityAuthentication and directory-change eventsDisable account; user sign-in to USS (LDAP / AD)
Virtualization platformsHypervisor and management logs (syslog); inventory and state (API)Read VM and host state
Cloud and SaaSAudit and security logs (provider APIs)—
Web proxies, DNS and email securityAccess and filtering logs (syslog)Domain and URL block lists
Ticketing and messaging—Create tickets; send chat and email notifications (webhooks)
Threat-intelligence sourcesIndicator feeds (STIX/TAXII, JSON, CSV)Share indicators
Business applicationsApplication logs; data from REST APIsCall REST APIs from response actions and playbooks

Firewall management: automated blocking

Delivery: Core detection and timed response · Custom integration firewall management API connector

USS detects attacks such as password guessing and network scanning from server, application and network logs. It then blocks the attacking address, or a known-bad IOC, on next-generation firewalls through the firewall management server's API. When the configured time ends, the block is removed automatically. Connectors follow the same pattern for any firewall platform with a management API.

  1. DetectA USS rule fires (e.g. repeated authentication failures, port scan).
  2. BlockThe response script signs in to the management API, adds the address as a host object to a dedicated block group used by a drop rule, publishes the change and installs the policy.
  3. VerifyThe script checks the object and the policy-installation task status, and records the result in the alert and case. Failed API calls are retried. If the policy installation fails, the change is rolled back and an alert is raised.
  4. UnblockWhen the timeout expires, USS runs the reverse action: it removes the address from the block group, publishes and installs the policy.
  5. AuditEvery block and unblock is logged in USS and in the firewall's audit log.

EDR platforms

Delivery: Custom integration · response through USS Orchestrator
  • Collect alerts, events, incidents, process trees and evidence from the EDR REST API on a schedule, and index them in USS.
  • Correlate EDR data with other logs through shared fields such as host, user, hash and IP.
  • Run EDR response actions (isolate host, kill process, quarantine file) from USS Orchestrator playbooks.

Virtualization platforms

Delivery: Core syslog · Custom integration API
  • Hypervisor and virtualization-management logs collected through syslog and analyzed by USS rules.
  • Inventory and state (hosts, VMs, power state, configuration changes) collected through the virtualization management API.

Business applications (REST API)

Delivery: Core inbound API · Custom integration outbound calls

Connect USS to any application that exposes a REST API, such as ERP, finance, HR, ticketing or in-house applications.

  • Inbound: applications use the USS API to pull alerts and inventory into their own workflows, or to start a response within their permissions.
  • Outbound: USS calls an application's REST API from response actions and Orchestrator playbooks, for example to open a ticket or look up a user.

Unified API

Delivery: Core USS API · Custom integration unified gateway

A single API gateway, described by an OpenAPI (Swagger) specification, exposes USS and module functions with endpoint lists, authentication, and request and response definitions:

FunctionProvided by
System status and statisticsUSS API
Devices, servers and agentsUSS API
Log search and exportUSS Indexer API
AlertsUSS Indexer API
Incidents and evidenceUSS Case Management API
IOCs and threat intelligenceUSS API (IoC lists), USS Threat Intelligence API
Response actionsUSS API, USS Orchestrator API
Rules and playbooksUSS API (rules), USS Orchestrator API (playbooks)
Users, roles and audit logsUSS API, USS Identity API, audit logging

Single sign-on and entry portal

Delivery: USS Identity · Custom integration per-console configuration

USS Identity, connected to LDAP / Active Directory, provides a single login for the USS Dashboard and all extended modules. A start page links every console, and roles are managed centrally.

USS Server & API

The USS Server receives data from agents and other sources, analyzes it, and manages agents, configuration and response. It scales horizontally as a cluster and exposes a REST API for automation.

Server services

ServiceFunction
Agent connection serviceEncrypted, authenticated channel for events from agents and for configuration sent to them
Enrollment serviceRegisters new agents and issues their keys, with optional password and certificate checks
Analysis engineDecodes events, evaluates rules, and writes alerts and archives
Vulnerability engineMatches the software inventory against vulnerability data and keeps per-agent vulnerability state
Active response managerSends response commands to agents and runs server-side responses
Alert forwarderShips alerts, archives and state data to the USS Indexer
Integrator and outputsEmail, syslog, webhook and socket outputs
Agentless and cloud modulesSSH-based checks and cloud/SaaS log collection run from the server

Server cluster

  • Master node: the authoritative source for rules, decoders, indicator lists, agent groups and agent keys. It synchronizes them to workers automatically.
  • Worker nodes: receive agent traffic and run analysis. Add workers to scale out.
  • Load balancing: agents connect through a load balancer or a list of servers and fail over automatically.
  • Cluster status and per-node statistics are visible in the Dashboard and through the API.

USS API

AspectDetails
InterfaceRESTful HTTPS API with JSON responses
DocumentationOpenAPI specification with every endpoint, parameter and response schema, downloadable as JSON or YAML
AuthenticationUser credentials exchanged for JWT tokens with a configurable lifetime. Integrations use dedicated service accounts with limited roles.
AuthorizationRole-based access control: policies of actions, resources and effect (see Users & access)
ProtectionRequest rate limits, login-attempt blocking, configurable TLS and allowed origins
CoverageAgents and groups, inventory, rules, decoders and lists, configuration, active response, vulnerability and SCA results, cluster and server status, users, roles, security events, logtest

Ruleset testing

Paste a log line into the Dashboard or send it to the API to see exactly how it is decoded and which rule matches. This lets you test new rules safely before deploying them.

USS Indexer

The USS Indexer is a distributed search and analytics engine that stores alerts, archived events and state data as JSON documents and makes them searchable in near real time.

What it stores

DataContent
AlertsEvery event that matched a rule, in daily indices
ArchivesAll events, when full archiving is enabled
State dataCurrent vulnerability and inventory state per agent
Monitoring and statisticsAgent status history and server performance statistics
Module dataAnomaly-detection results and other module output

Features

  • Clustering: shards and replicas spread across nodes for scale and fault tolerance; node roles can be split (cluster manager, data).
  • Search: keyword, full-text, field, wildcard (substring) and range queries, plus SQL-style queries for analysts who prefer them, and aggregations for dashboards and reports.
  • Index lifecycle management: roll over, shrink, force-merge, change replicas, move between tiers and delete indices by age or size (see Retention).
  • Snapshots to shared file systems or S3-compatible storage, with restore of single indices.
  • Security: TLS on all interfaces, internal users and roles, index- and document-level permissions, and audit logging of access.
  • REST API for search, export and administration.
  • Health monitoring: cluster status, disk watermarks and node statistics. Disk watermarks (for example 85% high and 95% flood stage) protect nodes from filling up, and lifecycle policies delete old data before the limits are reached.

USS Dashboard

The USS Dashboard is the web console for analysts and administrators. It covers monitoring, hunting, reporting and management of the whole platform.

Security views

ViewShows
OverviewAlert trends, top agents, top rules and severity distribution
Threat huntingInteractive search across alerts and archives, with filters and pivots
MITRE ATT&CKAlerts by tactic and technique, with a framework matrix and technique details
File integrity monitoringChanged files and registry keys, with who-data and diffs
Configuration assessmentPolicy scores, and passed and failed checks per agent
Vulnerability detectionVulnerabilities by severity, package, CVE and agent
IT hygiene / inventoryHardware, software, processes, ports and users per agent
Malware and rootkitsMalware-related alerts and rootkit findings
Cloud and containersDedicated views per cloud provider and for Docker
Regulatory complianceAlerts mapped to PCI DSS, GDPR, HIPAA, NIST 800-53 and TSC requirements

Management

  • Agents: inventory and status of every agent, group assignment, a deployment wizard, and remote upgrade.
  • Ruleset editor: view and edit rules, decoders and indicator lists in the browser, and test them with logtest.
  • Server management: configuration editor, cluster status, logs and statistics.
  • API console: run USS API requests from the browser.
  • Index management: lifecycle policies, snapshots and index health.
  • Security: users, roles and role mappings.

Dashboards and reporting

  • Build custom visualizations and dashboards from any indexed field.
  • Generate PDF reports from module views and dashboards on demand or on a schedule, either in the console or through the reporting API.
  • Export search results as CSV.
  • Use multi-tenancy to keep separate saved objects and dashboards per team.
  • Apply custom branding: logos and names in the header, sign-in page and reports.

USS Agents

The USS Agent is a lightweight, multi-platform program that collects security data on an endpoint and carries out response actions.

Supported platforms

FamilyCoverage
LinuxMajor enterprise and community distributions (RPM and DEB based), on x86_64 and ARM
WindowsDesktop and Server editions
macOSIntel and Apple silicon
UnixSolaris, AIX and HP-UX

The exact supported versions are listed in the installation guide for each release.

Agent features

  • Modules: log collection, file integrity, configuration assessment, inventory, rootkit checks, command monitoring, cloud and container collection, and active response, all in one agent.
  • Automatic enrollment on first start, with optional password or certificate verification.
  • Mass deployment with installer variables, group policy or configuration-management tools.
  • Groups and centralized configuration: an agent can belong to several groups, each with its own configuration, policies and lists.
  • Labels: tag agents with metadata that appears in every alert.
  • Event buffer with rate limiting, so bursts and server outages do not lose events.
  • Server failover across several servers or through a load balancer.
  • Remote upgrade from the server, using an internal package repository if needed.
  • Anti-tampering: uninstall protection with a verification code.
  • Status tracking: active, disconnected, pending or never connected, with history.

Rules & decoders

USS ships with thousands of decoders and rules for operating systems, applications, network devices, cloud services and security tools. Every rule and decoder is readable, and you can add your own without changing the built-in set.

Decoders

  • Pre-decoding of common headers: timestamp, host and program name.
  • Parent and child decoders: a parent selects a log family and children extract the fields.
  • Pattern extraction with regular expressions into standard fields (source IP, user, URL, action) or any custom field.
  • A native JSON decoder for structured logs, plus special decoders for specific formats.

Rules

CapabilityExamples
Field matchingMatch on any decoded field with plain text, simple patterns or full PCRE2 regular expressions
Rule chainingRefine a parent rule (for example, only failed logins from outside the corporate network)
CorrelationN events within a time window; same or different source, user, URL or field values
List lookupsMatch a field against indicator lists (IPs, domains, hashes, users)
Time conditionsApply rules only outside business hours or on specific weekdays
ClassificationSeverity 0–15, groups, MITRE ATT&CK techniques and compliance controls
TuningOverwrite or silence built-in rules, ignore noisy sources, and control email per rule

Managing content

  • Custom rules and decoders live in their own files and are never overwritten by updates.
  • Edit and test content in the Dashboard ruleset editor or through the API.
  • In a cluster, content edited on the master is synchronized to all workers.
  • Built-in content updates arrive with platform updates and can be installed offline.

Users & access

USS controls who can see and change what, in the consoles and in the APIs.

Console and data access

  • Internal users and roles for the Dashboard and Indexer, with cluster-, index- and document-level permissions.
  • Role mapping from directory groups (LDAP / Active Directory) or from single-sign-on claims.
  • Single sign-on and MFA through USS Identity (OpenID Connect or SAML).
  • Multi-tenancy: separate saved searches, visualizations and dashboards per tenant.
  • Password management: tools to change and rotate built-in user passwords.

API access control

ObjectPurpose
PoliciesAllow or deny actions (for example read agents, run active response) on resources (all agents, a group, one agent)
RolesSets of policies, such as administrator, analyst, read-only or group-limited operator
RulesAssign roles automatically from user attributes or SSO claims
UsersAPI accounts, which can also act on behalf of signed-in console users

Audit

Sign-ins, API requests, configuration changes and data access are logged. These logs can be fed back into USS, so administrator activity is monitored like any other activity.

Configuration essentials

The main configuration file on both Server and Agent is /var/uss/etc/uss.conf (Windows agent: C:\Program Files (x86)\uss-agent\uss.conf). Agent settings can also be pushed centrally through agent groups. Restart the corresponding USS service after local changes.

Log collection

<localfile>
  <log_format>syslog</log_format>
  <location>/var/log/auth.log</location>
</localfile>

<localfile>
  <log_format>json</log_format>
  <location>/var/log/app/*.json</location>
</localfile>

<!-- Windows -->
<localfile>
  <location>Microsoft-Windows-Sysmon/Operational</location>
  <log_format>eventchannel</log_format>
</localfile>

File integrity monitoring

<syscheck>
  <disabled>no</disabled>
  <frequency>43200</frequency>  <!-- 12 h scheduled scan -->
  <scan_on_start>yes</scan_on_start>
  <alert_new_files>yes</alert_new_files>
  <directories>/etc,/usr/bin,/usr/sbin</directories>
  <directories>/bin,/sbin,/boot</directories>
  <directories realtime="yes" report_changes="yes">/var/www/html</directories>
  <directories whodata="yes">/etc/ssh</directories>
  <ignore>/etc/mtab</ignore>
  <ignore type="sregex">.log$|.swp$</ignore>
  <nodiff>/etc/ssl/private.key</nodiff>
  <skip_nfs>yes</skip_nfs>
</syscheck>

Security configuration assessment

<sca>
  <enabled>yes</enabled>
  <scan_on_start>yes</scan_on_start>
  <interval>12h</interval>
  <skip_nfs>yes</skip_nfs>
  <policies>
    <policy>etc/shared/custom_baseline.yml</policy>
  </policies>
</sca>

Vulnerability detection

<vulnerability-detection>
  <enabled>yes</enabled>
  <index-status>yes</index-status>
  <feed-update-interval>60m</feed-update-interval>  <!-- minimum 60m -->
  <!-- Air-gapped: <offline-url>file:///path/to/cves.zip</offline-url> -->
</vulnerability-detection>

Active response

<command>
  <name>firewall-drop</name>
  <executable>firewall-drop</executable>
  <timeout_allowed>yes</timeout_allowed>
</command>

<active-response>
  <command>firewall-drop</command>
  <location>local</location>
  <rules_id>5710,5711</rules_id>  <!-- or rules_group / level -->
  <timeout>600</timeout>          <!-- stateful: revert after 10 min -->
</active-response>

Key file locations

PathContents
/var/uss/etc/uss.confMain configuration (Server and Agent)
/var/uss/etc/rules/ · /var/uss/etc/decoders/Custom rules and decoders
/var/uss/etc/lists/CDB lists (IoCs, allow/deny lists)
/var/uss/etc/shared/<group>/agent.confCentralized configuration per agent group
/var/uss/etc/client.keysAgent keys — sensitive, protect
/var/uss/logs/alerts/Alerts (alerts.json, alerts.log)
/var/uss/logs/archives/All events (when archiving is enabled)
/var/uss/logs/uss.logService log — first place to troubleshoot
/var/uss/active-response/bin/Active response scripts

Operations

Day-to-day administration: onboarding agents, distributing configuration, managing access, retaining data and upgrading.

Agent enrollment

Each agent must be enrolled to receive a unique client key that encrypts its traffic and authenticates it to the Server.

Via agent configuration

Set the Server address (plus optional enrollment password and group) in the agent configuration or installer variables; the agent enrolls on first start over port 1515.

Via the USS API

Request a client key from the API and import it on the agent — useful when port 1515 is not reachable.

Hardened enrollment

Password authentication, Server identity verification (CA-signed certificate) and agent identity verification.

Agent groups & centralized configuration

Agents are organized into groups (e.g. linux-web, windows-dc, db). Each group has a shared directory on the Server, /var/uss/etc/shared/<group>/, containing agent.conf, SCA policies and CDB lists. Changes are distributed automatically to member agents; an agent can belong to several groups and settings are merged in order.

<agent_config os="Linux">
  <localfile>
    <log_format>apache</log_format>
    <location>/var/log/nginx/access.log</location>
  </localfile>
</agent_config>

User administration & RBAC

  • Dashboard / Indexer users — internal users, roles and role mappings; LDAP / Active Directory and SSO (SAML / OIDC).
  • USS API RBAC — policies (actions + resources + effect), roles and rules map API users to permissions, e.g. read-only analysts limited to specific agent groups.
  • Change all default passwords immediately after installation and keep them in a secret manager.

Data retention & storage tiers

Keeping a full year of logs as searchable, replicated indices is expensive. For example, 15 GB/day × 365 days is about 6.7 TB of indexed data, or about 13.5 TB with one replica. USS combines retention tiers, index compression and compressed raw-log archives to cut this to roughly 2.3–3 TB.

TierAgeFormSearchExample size (15 GB/day)
Hot0–30 daysCompressed index, SSD, 1 replicaInstant≈ 720 GB
Warm31–90 daysForce-merged, read-only index, HDD, no replicaInstant≈ 540 GB
Alerts365 daysAlert indices only (≈ 5–10% of events)Instant≈ 300–600 GB
Archive365 daysRaw logs, zstd-compressed, SHA-256 hashedAfter restore≈ 450–750 GB
Snapshots—Incremental, compressed backup of hot/warmAfter restore≈ 300–450 GB
Total≈ 2.3–3 TB

Techniques and their effect

TechniqueSavingNotes
Index compression (best_compression / zstd codec)15–40%One index setting; check zstd codec availability for your Indexer version.
Force merge + read-only (warm)+10–20%Merges old indices into one segment.
Drop replicas on warm50%Only when snapshots protect the data.
Compressed raw-log archive8–15×Log text compresses very well; the largest single saving.
Filesystem compression (ZFS / Btrfs compression=zstd)High on archivesLittle extra on already-compressed indices.
Block deduplication (ZFS dedup, VDO)≈ 0–10%Log lines carry unique timestamps, so duplicate blocks are rare. ZFS dedup needs 1–5 GB RAM per TB. Use it only for backup repositories.

Index compression

{ "index.codec": "best_compression" }

Lifecycle policy: hot → warm → delete

{
  "policy": {
    "default_state": "hot",
    "states": [
      { "name": "hot",
        "actions": [],
        "transitions": [{ "state_name": "warm", "conditions": { "min_index_age": "30d" } }] },
      { "name": "warm",
        "actions": [
          { "replica_count": { "number_of_replicas": 0 } },
          { "force_merge": { "max_num_segments": 1 } },
          { "read_only": {} }
        ],
        "transitions": [{ "state_name": "delete", "conditions": { "min_index_age": "90d" } }] },
      { "name": "delete",
        "actions": [{ "delete": {} }] }
    ]
  }
}

Raw-log archive

  • Enable archiving of all events to /var/uss/logs/archives/; files rotate daily.
  • Compress each rotated file with zstd -19 (or gzip), store a SHA-256 hash next to it, and move both to archive storage (NAS / S3-compatible, ideally write-once).
  • To investigate old data, decompress the needed days and re-ingest them, or search them with command-line tools. Plan minutes to hours for this and reflect it in the SLA.

Backup

  • Configure Indexer snapshots to a filesystem or S3-compatible repository.
  • Back up Server configuration: uss.conf, custom rules / decoders / lists, client.keys, shared group directories and certificates.
  • Monitor Indexer disk watermarks; compression ratios depend on log types, so measure them on real data during sizing.

To keep every log instantly searchable for the whole retention period, extend the warm tier instead of archiving. Storage is then about 1.5–2 times the tiered design.

System requirements

Size the core platform by the number of data sources (agents and syslog or API sources) that send logs. The tiers below assume 30 days of hot, instantly searchable storage. Use the formula after the table for longer retention.

TierData sourcesLogs / dayEPSDeploymentServers (vCPU / RAM / SSD)
Small100~15 GB~150All-in-one1 × 8 vCPU / 16 GB / 500 GB
Medium250~35 GB~350All-in-one1 × 16 vCPU / 32 GB / 1.2 TB
Large500~65 GB~650DistributedServer 8 vCPU / 16 GB
Indexer 16 vCPU / 32 GB / 2 TB
Dashboard 4 vCPU / 8 GB
Enterprise1,000~125 GB~1,250ClusterServer 2 × 8 vCPU / 16 GB (master + worker)
Indexer 3 × 16 vCPU / 64 GB / 2 TB
Dashboard 1 × 8 vCPU / 16 GB
Load balancer 2 × 2 vCPU / 4 GB

More than 1,000 data sources need additional nodes for horizontal scaling: add one USS Server worker node for about every 1,000 more data sources, and one USS Indexer node for about every 100 GB/day more logs, or when indexer disks pass 70% use.

Longer retention

Searchable storage ≈ logs per day × days × 0.8 × (1 + replicas). Compressed raw-log archives need about one tenth of the raw volume. For example, the Medium tier with 30 days hot and 365 days archived needs about 0.8 TB hot and 1.3 TB of archive storage. See Data retention & storage tiers.

Extended modules

ModuleServer (vCPU / RAM / disk)
USS Orchestrator8 vCPU / 16 GB / 200 GB; add workers for high playbook volume
USS Case Management + USS Identity8 vCPU / 16 GB / 500 GB
USS Threat Intelligence8 vCPU / 16 GB / 500 GB
USS AnalyticsRuns on the USS Indexer nodes; add about 25% indexer CPU and RAM
Internal update server (isolated networks)4 vCPU / 8 GB / 1 TB

General requirements

  • Operating system: 64-bit Linux (RHEL-compatible or Ubuntu LTS) for all server roles.
  • Storage: SSD for hot data (NVMe for the Enterprise tier); at least 3,000 IOPS, or 10,000+ IOPS for Large and Enterprise. HDD is acceptable for warm and archive tiers.
  • Network: 1 Gbps between nodes; 10 Gbps recommended between Enterprise indexer nodes.
  • Time: NTP / chrony synchronization on all nodes and sources.
  • Browser: current Chrome, Edge or Firefox.
  • Headroom: keep 20–30% spare CPU and disk for growth and peak load.

All figures are guidance. Confirm the final sizing by measuring event volume and compression on your own data sources.

Offline updates

All USS updates can be delivered without internet access from inside the network. An internal update server receives update packages through a controlled transfer process (for example, verified removable media or a one-way gateway) and serves them on the internal network.

ContentOffline delivery
Detection rules and decodersRuleset packages installed from the internal repository; custom rules are kept in /var/uss/etc/rules/ and are not overwritten.
Vulnerability (CVE) dataOffline feed file loaded from a local path or internal URL.
Agent packages and upgradesAgents install and upgrade from the internal repository; remote upgrades are pushed from the USS Server.
Threat intelligence and IOCsFeed files (STIX, JSON, CSV) imported into USS Threat Intelligence and synced to USS IoC lists.
Platform softwarePackages mirrored to the internal repository and installed in the documented upgrade order.

Verify each package with its checksum or signature before you import it, and record the import in the change log.

Installation & support

Delivery: Service
  • Installation and configuration: architecture and sizing, cluster installation, agent rollout, integration setup, initial rule tuning and acceptance testing.
  • 24×7 technical support: a contracted support line with defined response times by severity, an on-call escalation path and remote assistance.
  • Training for administrators and analysts.
  • Maintenance: planned upgrades, detection-content updates and periodic health checks.

Exact response times and service levels are set in the support agreement.

Upgrades & health

Upgrade order: Indexer → Server → Dashboard → Agents. Keep all central components on the same version.

  • Agents can be upgraded remotely from the Server (API or Dashboard) once the Server is upgraded.
  • Monitor agent connection status (active / disconnected / never connected), event queue usage, dropped events and Indexer cluster status (green / yellow / red).

Hardening checklist

Secure the USS platform itself. Complete these steps after installation and review them periodically.

  • Replace demo / self-signed certificates with internal-CA certificates for Indexer, Server and Dashboard.
  • Change every default password (Indexer admin, Dashboard users, USS API users) and rotate periodically.
  • Restrict ports: 1514/1515 only from agent networks; 1516 and 9300–9400 only between cluster nodes; 9200 only from Server and Dashboard; 55000 only from Dashboard/admin hosts; 443 only from analyst networks.
  • Enable enrollment password and certificate-based identity verification for agents.
  • Apply least-privilege RBAC for Dashboard and USS API users; separate admin and analyst roles.
  • Protect client.keys, private keys and API credentials (file permissions, secret manager, no plaintext in tickets).
  • Enable SCA and FIM on the USS hosts themselves and send their own logs into the stack.
  • Define ISM retention and snapshot backups; test restore regularly.
  • Keep components patched; follow release notes and security advisories.
  • Document custom rules (ID range 100000–120000), active responses and owners; review false positives periodically.
  • Enforce sign-in through USS Identity for all consoles; disable local accounts that are no longer needed and require MFA for administrators.
  • Use dedicated, least-privilege service accounts for the firewall, EDR, virtualization and internal-system integrations; store their API keys in a secret manager and rotate them.
  • Review and approve every Orchestrator playbook that performs blocking or account actions; keep approval steps for high-impact actions.
  • Verify the checksum or signature of every imported threat-intelligence and update package before use.

Glossary

Active response
Automated script executed on an agent or server when a rule fires.
Agent group
Set of agents sharing centralized configuration, policies and lists.
CDB list
Constant key/value database used in rules for IoC and allow/deny lookups.
Decoder
Parser that extracts structured fields from raw log data.
FIM
File Integrity Monitoring — detects changes to files and registry keys.
ISM
Index State Management — lifecycle policies for Indexer indices.
MITRE ATT&CK
Knowledge base of adversary tactics and techniques used to classify alerts.
Rule level
Severity 0–15 assigned by a rule; drives alerting and response.
SCA
Security Configuration Assessment — policy-based hardening checks (e.g. CIS).
SIEM / XDR
Security Information & Event Management / Extended Detection & Response — both provided by USS.
System inventory
Hardware, software, network, process and user data collected per endpoint.
Who-data
FIM mode that records the user and process responsible for a file change.
Anomaly detector
USS Analytics model that learns the normal pattern of a metric and flags deviations.
Case
A managed incident record in USS Case Management, with evidence, timeline and tasks.
IOC feed
A published list of indicators that firewalls or other systems poll and enforce.
Playbook
A USS Orchestrator workflow of enrichment, decision, approval and response steps.
SOAR
Security Orchestration, Automation and Response, provided by USS Orchestrator and USS Case Management.
STIX / TAXII
Standard format (STIX) and transport protocol (TAXII) for exchanging threat intelligence.
UEBA
User and Entity Behavior Analytics, provided by USS Analytics anomaly detection.
USS — Unified Security Stack · Internal platform documentation