Skip to content

Commit 16a75b3

Browse files
leos565claude
andcommitted
docs: update README with protection modules, new rule prefixes, dashboard features
- Add Protection Modules section (Output Scanner, Prompt Injection, Egress Allowlist, Cognitive Integrity Monitor) with rule prefixes and descriptions - Expand Rule System table with OUT-* and INJ-* prefixes - Expand User Customization example with module settings keys - Add Dashboard section describing all tabs and alert filter/dismiss features Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 6f6ebe2 commit 16a75b3

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,19 @@ Alerts → Dashboard (localhost:8477)
3232

3333
**Dashboard:** Web UI on port 8477 for viewing alerts, managing rule exemptions, and adding custom blocking rules. Auto-installed as a system service.
3434

35+
## Protection Modules
36+
37+
Beyond core policy enforcement, ClawEDR includes four additional protection layers:
38+
39+
| Module | Rule Prefix | What It Does |
40+
|--------|-------------|--------------|
41+
| **Output Scanner** | `OUT-*` | Scans agent stdout via eBPF tracepoint for secrets and PII (AWS keys, GitHub tokens, credit cards, SSNs, private keys, and more) before they reach the user |
42+
| **Prompt Injection Detection** | `INJ-*` | Inspects content flowing into the agent for instruction-override, persona-hijack, steganography, and data-exfiltration patterns |
43+
| **Egress Allowlist** || Restricts outbound network connections to an explicit domain allowlist enforced at the eBPF socket layer |
44+
| **Cognitive Integrity Monitor** | `INT-*` | Tracks SHA-256 baselines of OpenClaw config files and alerts on unexpected modifications |
45+
46+
All modules are configurable from the dashboard and can be enabled/disabled independently.
47+
3548
## Rule System
3649

3750
Every rule has a stable ID for traceability and user overrides:
@@ -43,8 +56,10 @@ Every rule has a stable ID for traceability and user overrides:
4356
| `PATH-LIN-*` / `PATH-MAC-*` | Blocked paths | `PATH-LIN-002``/etc/shadow` |
4457
| `LIN-*` / `MAC-*` | OS-specific deny rules | `LIN-050``dd` disk writes |
4558
| `HEU-*` | Heuristic detections | `HEU-NET-001` → DNS exfil pattern |
46-
| `THRT-*` | Threat feed entries | Auto-generated |
59+
| `THRT-*` | Threat feed entries | Auto-generated from ClawSec feed |
4760
| `USR-*` | User custom rules | `USR-DOM-001``evil.com` |
61+
| `OUT-*` | Output scanner patterns | `OUT-001` → AWS Access Key ID |
62+
| `INJ-*` | Injection detection patterns | `INJ-006` → Zero-width unicode steganography |
4863

4964
## User Customization
5065

@@ -62,10 +77,31 @@ custom_rules:
6277
type: path
6378
value: /var/secrets
6479
platform: linux
80+
81+
# Module settings
82+
output_scanner_enabled: true
83+
injection_detection_enabled: true
84+
egress_mode: allowlist
85+
allowed_domains:
86+
- api.openai.com
87+
- api.anthropic.com
88+
integrity_monitor_enabled: true
6589
```
6690
6791
Supported custom rule types: `executable`, `domain`, `hash`, `path`, `argument`. Rules can also be managed from the dashboard UI.
6892

93+
## Dashboard
94+
95+
The web UI at `localhost:8477` provides:
96+
97+
- **Alerts** — filterable by time, severity, and module (Policy Rules / Threat Feed / Heuristics / Output Scanner / Prompt Injection / Custom). Per-alert dismiss and bulk clear.
98+
- **Policy Rules** — toggle enforcement mode per rule, configure the security profile (Hobbyist → Professional → Military slider), add custom rules.
99+
- **Output Scanner** — enable/disable categories, view pattern library with technical examples, inspect recent findings.
100+
- **Prompt Injection** — configure injection detection categories, view triggered patterns.
101+
- **Egress Control** — manage the outbound domain allowlist, switch between allowlist and monitor-only mode.
102+
- **Integrity** — baseline management, per-file status, tamper alerts.
103+
- **Settings** — API token, bind address, notification settings.
104+
69105
## Development
70106

71107
```sh

0 commit comments

Comments
 (0)