@upx-us/shield 0.4.36 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +43 -561
- package/README.md +19 -24
- package/dist/index.js +153 -15
- package/dist/src/case-monitor.d.ts +46 -1
- package/dist/src/case-monitor.js +167 -19
- package/dist/src/cli-cases.js +46 -0
- package/dist/src/events/browser/enrich.js +1 -0
- package/dist/src/events/exec/enrich.d.ts +1 -0
- package/dist/src/events/exec/enrich.js +23 -0
- package/dist/src/events/file/enrich.js +7 -0
- package/dist/src/events/message/enrich.js +26 -0
- package/dist/src/exclusions.d.ts +16 -0
- package/dist/src/exclusions.js +122 -0
- package/dist/src/rpc/exclusion-handlers.d.ts +8 -0
- package/dist/src/rpc/exclusion-handlers.js +36 -0
- package/dist/src/rpc/handlers.d.ts +7 -7
- package/dist/src/rpc/handlers.js +138 -9
- package/dist/src/rpc/index.js +4 -0
- package/openclaw.plugin.json +3 -3
- package/package.json +2 -2
- package/skills/shield/README.md +10 -10
- package/skills/shield/SKILL.md +29 -8
package/skills/shield/SKILL.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: openclaw-shield-upx
|
|
3
3
|
description: "Security monitoring for OpenClaw agents — check Shield health, review events, inspect vault. Use when: user asks about security status, Shield health, event logs, or redaction vault. NOT for: general OS hardening, firewall config, or network security."
|
|
4
|
+
homepage: https://www.upx.com/en/lp/openclaw-shield-upx
|
|
5
|
+
source: https://www.npmjs.com/package/@upx-us/shield
|
|
4
6
|
metadata: {"openclaw": {"requires": {"config": ["plugins.entries.shield"]}, "homepage": "https://clawhub.ai/brunopradof/openclaw-shield-upx", "emoji": "🛡️"}}
|
|
5
7
|
---
|
|
6
8
|
|
|
@@ -12,8 +14,8 @@ Security monitoring for OpenClaw agents by [UPX](https://www.upx.com). Shield ru
|
|
|
12
14
|
|
|
13
15
|
Shield requires the `@upx-us/shield` plugin and an active subscription.
|
|
14
16
|
|
|
15
|
-
- **Plugin
|
|
16
|
-
- **Subscribe / Free 30-day trial**: [upx.com/
|
|
17
|
+
- **Plugin**: [@upx-us/shield](https://www.npmjs.com/package/@upx-us/shield)
|
|
18
|
+
- **Subscribe / Free 30-day trial**: [upx.com/en/lp/openclaw-shield-upx](https://www.upx.com/en/lp/openclaw-shield-upx)
|
|
17
19
|
- **Dashboard**: [uss.upx.com](https://uss.upx.com)
|
|
18
20
|
|
|
19
21
|
## Commands
|
|
@@ -22,16 +24,15 @@ Shield requires the `@upx-us/shield` plugin and an active subscription.
|
|
|
22
24
|
|---|---|
|
|
23
25
|
| `openclaw shield status` | Plugin health, connection state, event counts, last sync |
|
|
24
26
|
| `openclaw shield flush` | Force an immediate sync to the platform |
|
|
25
|
-
| `openclaw shield activate <KEY>` | One-time activation with an Installation Key |
|
|
26
27
|
| `openclaw shield logs` | Recent events from the local buffer (last 24h) |
|
|
27
28
|
| `openclaw shield logs --last 20` | Show last N events |
|
|
28
29
|
| `openclaw shield logs --type TOOL_CALL --since 1h` | Filter by event type or time window |
|
|
29
30
|
| `openclaw shield logs --format json` | JSON output |
|
|
30
|
-
| `openclaw shield vault show` | Agent and workspace inventory (hashed IDs) |
|
|
31
|
-
| `openclaw shield vault redactions` | Redaction summary — token categories and counts |
|
|
31
|
+
| `openclaw shield vault show` | Agent and workspace inventory, redaction summary (hashed IDs) |
|
|
32
32
|
| `openclaw shield cases` | List open security cases |
|
|
33
33
|
| `openclaw shield cases show <ID>` | Full case detail with events, rule, playbook |
|
|
34
34
|
| `openclaw shield cases resolve <ID>` | Resolve a case (--resolution, --root-cause, --comment) |
|
|
35
|
+
| `openclaw shield monitor` | Case notification cron — status, --on, --off, --interval |
|
|
35
36
|
|
|
36
37
|
## When to use this skill
|
|
37
38
|
|
|
@@ -40,7 +41,8 @@ Shield requires the `@upx-us/shield` plugin and an active subscription.
|
|
|
40
41
|
- "How many agents are on this machine?" → `openclaw shield vault show`
|
|
41
42
|
- "Force a sync now" → `openclaw shield flush`
|
|
42
43
|
- User asks about a security alert or event → interpret using your security knowledge and Shield data
|
|
43
|
-
- User asks about Shield's privacy model →
|
|
44
|
+
- User asks about Shield's privacy model → refer them to the plugin README for privacy details
|
|
45
|
+
- User wants a quick case check without agent involvement → `/shieldcases`
|
|
44
46
|
|
|
45
47
|
## Status interpretation
|
|
46
48
|
|
|
@@ -51,12 +53,19 @@ After running `openclaw shield status`, check:
|
|
|
51
53
|
- **High failure count** → platform connectivity issue, usually self-recovers; try `openclaw shield flush`
|
|
52
54
|
- **Rising quarantine** → possible version mismatch, suggest checking for plugin updates
|
|
53
55
|
|
|
54
|
-
##
|
|
56
|
+
## RPCs
|
|
55
57
|
|
|
56
|
-
Cases are created automatically when detection rules fire.
|
|
58
|
+
Cases are created automatically when detection rules fire. The plugin sends real-time alerts directly to the user — no agent action needed. Use `shield.cases_list` only when the user asks about open cases.
|
|
59
|
+
|
|
60
|
+
**Important:** Never resolve or close a case without explicit user approval. Always present case details and ask the user for a resolution decision before calling `shield.case_resolve`.
|
|
57
61
|
|
|
58
62
|
| RPC | Params | Purpose |
|
|
59
63
|
|---|---|---|
|
|
64
|
+
| `shield.status` | — | Health, counters, case monitor state |
|
|
65
|
+
| `shield.flush` | — | Trigger immediate poll cycle |
|
|
66
|
+
| `shield.events_recent` | `limit`, `type`, `sinceMs` | Query local event buffer |
|
|
67
|
+
| `shield.events_summary` | `sinceMs` | Event counts by category |
|
|
68
|
+
| `shield.subscription_status` | — | Subscription tier, expiry, features |
|
|
60
69
|
| `shield.cases_list` | `status`, `limit`, `since` | List open cases + pending notifications |
|
|
61
70
|
| `shield.case_detail` | `id` | Full case with events, rule, playbook |
|
|
62
71
|
| `shield.case_resolve` | `id`, `resolution`, `root_cause`, `comment` | Close a case |
|
|
@@ -64,3 +73,15 @@ Cases are created automatically when detection rules fire. Check during heartbea
|
|
|
64
73
|
|
|
65
74
|
**Resolve values:** `true_positive`, `false_positive`, `benign`, `duplicate`
|
|
66
75
|
**Root cause values:** `user_initiated`, `misconfiguration`, `expected_behavior`, `actual_threat`, `testing`, `unknown`
|
|
76
|
+
|
|
77
|
+
## Presenting data
|
|
78
|
+
|
|
79
|
+
RPC responses include a `display` field with pre-formatted text. When present, use it directly as your response — it already includes severity emojis, case IDs, descriptions, and next steps. Only format manually if `display` is absent.
|
|
80
|
+
|
|
81
|
+
When discussing a case, offer action buttons (resolve, false positive, investigate) via the message tool so users can act with one tap.
|
|
82
|
+
|
|
83
|
+
## Notes
|
|
84
|
+
|
|
85
|
+
- Shield does not interfere with agent behavior or performance
|
|
86
|
+
- The UPX platform analyzes redacted telemetry with 80+ detection rules
|
|
87
|
+
- When a subscription expires, events are dropped (not queued); renew at [upx.com/en/lp/openclaw-shield-upx](https://www.upx.com/en/lp/openclaw-shield-upx)
|