Skip to content

Commit a85a5d3

Browse files
committed
Improve README security section
1 parent 7af2085 commit a85a5d3

6 files changed

Lines changed: 24 additions & 26 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Changelog
22

3+
## 0.1.2 - 2026-05-26
4+
5+
- Improved the README security section for clearer ClawHub rendering and operator guidance.
6+
37
## 0.1.1 - 2026-05-26
48

59
- Updated ClawHub release tags for better package discovery.

README.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -59,31 +59,25 @@ Environment fallbacks are also supported: `MAUTIC_BASE_URL`, `MAUTIC_CONSOLE_URL
5959

6060
## Security Model
6161

62-
Production defaults are restrictive:
62+
The plugin ships with conservative production defaults. Installing it does not automatically grant file access or operational Mautic job control.
6363

64-
- Maintenance commands are disabled.
65-
- Automation job commands are disabled.
66-
- Workspace read/write access is disabled.
67-
- API requests are restricted to `/api` and `/api/v2`.
68-
- Workspace file paths must remain inside `allowedWorkspaceRoot`.
69-
- Console commands are intersected with a hardcoded allowlist before execution.
70-
71-
The only console command available without extra capability toggles is `migrations:status`.
72-
73-
`allowMaintenanceCommands` enables:
74-
75-
- `cache:clear`
76-
- `mautic:cache:clear`
77-
- `plugins:reload`
64+
| Area | Default | Guardrail |
65+
| --- | --- | --- |
66+
| Mautic API | Enabled after credentials are provided | Requests are limited to `/api` and `/api/v2`. |
67+
| Console status | Enabled only for `migrations:status` | Useful for health checks without granting maintenance control. |
68+
| Maintenance commands | Disabled | Requires `allowMaintenanceCommands=true`. |
69+
| Automation jobs | Disabled | Requires `allowAutomationJobCommands=true`. |
70+
| Workspace files | Disabled | Read and write require separate opt-in toggles. |
71+
| Path access | Guarded | File paths must stay inside `allowedWorkspaceRoot`. |
7872

79-
`allowAutomationJobCommands` enables:
73+
Enable capabilities only for operators and agents you trust with that scope.
8074

81-
- `webhooks:process`
82-
- `campaigns:rebuild`
83-
- `campaigns:trigger`
84-
- `segments:update`
75+
| Toggle | Commands Enabled | When To Use |
76+
| --- | --- | --- |
77+
| `allowMaintenanceCommands` | `cache:clear`, `mautic:cache:clear`, `plugins:reload` | Routine maintenance after plugin/config/cache changes. |
78+
| `allowAutomationJobCommands` | `webhooks:process`, `campaigns:rebuild`, `campaigns:trigger`, `segments:update` | Intentional campaign, segment, and webhook job execution. |
8579

86-
Use restrictive OpenClaw profiles or explicit tool allowlists for agents that process untrusted input.
80+
Console requests are checked twice: first by the plugin's hardcoded allowlist, then by the optional bridge's allowlist. For agents that process untrusted input, use restrictive OpenClaw profiles or explicit tool allowlists.
8781

8882
## Console Bridge
8983

docs/CLAWHUB_READINESS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Result:
4848
"name": "@completetech/openclaw-mautic-plugin",
4949
"displayName": "Mautic Control",
5050
"family": "bundle-plugin",
51-
"version": "0.1.1"
51+
"version": "0.1.2"
5252
}
5353
```
5454

@@ -67,7 +67,7 @@ Result: passed. ClawHub detected:
6767
"name": "@completetech/openclaw-mautic-plugin",
6868
"displayName": "Mautic Control",
6969
"family": "bundle-plugin",
70-
"version": "0.1.1"
70+
"version": "0.1.2"
7171
}
7272
```
7373

docs/PRIVATE_SOURCE_REVIEW_REQUEST.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Historical/alternate handoff only. The repository is currently public, so this p
66

77
- Package name: `@completetech/openclaw-mautic-plugin`
88
- Plugin id: `mautic-control`
9-
- Version: `0.1.1`
9+
- Version: `0.1.2`
1010
- Source repository: `CompleteTech-LLC-AI-Research/openclaw-mautic-plugin`
1111
- Current source visibility: public
1212
- Branch: `main`

openclaw.plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"id": "mautic-control",
33
"name": "Mautic Control",
44
"description": "Typed tools for controlled Mautic REST API access, webhook inspection, optional console maintenance, and optional workspace file staging.",
5-
"version": "0.1.1",
5+
"version": "0.1.2",
66
"contracts": {
77
"tools": [
88
"mautic_status",

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@completetech/openclaw-mautic-plugin",
3-
"version": "0.1.1",
3+
"version": "0.1.2",
44
"description": "OpenClaw plugin for controlled Mautic API, webhook, console bridge, and workspace operations.",
55
"type": "module",
66
"private": false,

0 commit comments

Comments
 (0)