docs(security): explain DM pairing
This commit is contained in:
11
README.md
11
README.md
@@ -87,6 +87,17 @@ Upgrading? `clawdbot doctor`.
|
|||||||
|
|
||||||
If you run from source, prefer `bun run clawdbot …` or `pnpm clawdbot …` (not global `clawdbot`).
|
If you run from source, prefer `bun run clawdbot …` or `pnpm clawdbot …` (not global `clawdbot`).
|
||||||
|
|
||||||
|
## Security defaults (DM access)
|
||||||
|
|
||||||
|
Clawdbot connects to real messaging surfaces. Treat inbound DMs as **untrusted input**.
|
||||||
|
|
||||||
|
Default behavior on Telegram/WhatsApp/Signal/iMessage/Discord/Slack:
|
||||||
|
- **DM pairing** (`dmPolicy="pairing"` / `discord.dm.policy="pairing"` / `slack.dm.policy="pairing"`): unknown senders receive a short pairing code and the bot does not process their message.
|
||||||
|
- Approve with: `clawdbot pairing approve --provider <provider> <code>` (then the sender is added to a local allowlist store).
|
||||||
|
- Public inbound DMs require an explicit opt-in: set `dmPolicy="open"` and include `"*"` in the provider allowlist (`allowFrom` / `discord.dm.allowFrom` / `slack.dm.allowFrom`).
|
||||||
|
|
||||||
|
Run `clawdbot doctor` to surface risky/misconfigured DM policies.
|
||||||
|
|
||||||
## Highlights
|
## Highlights
|
||||||
|
|
||||||
- **[Local-first Gateway](https://github.com/clawdbot/clawdbot/blob/main/docs/gateway.md)** — single control plane for sessions, providers, tools, and events.
|
- **[Local-first Gateway](https://github.com/clawdbot/clawdbot/blob/main/docs/gateway.md)** — single control plane for sessions, providers, tools, and events.
|
||||||
|
|||||||
@@ -52,7 +52,7 @@ Use the group chat command:
|
|||||||
- `/activation mention`
|
- `/activation mention`
|
||||||
- `/activation always`
|
- `/activation always`
|
||||||
|
|
||||||
Only the owner number (from `whatsapp.allowFrom`, defaulting to the bot’s own E.164 when unset) can change this. `/status` in the group shows the current activation mode.
|
Only the owner number (from `whatsapp.allowFrom`, or the bot’s own E.164 when unset) can change this. `/status` in the group shows the current activation mode.
|
||||||
|
|
||||||
## How to use
|
## How to use
|
||||||
1) Add Clawd UK (`+447700900123`) to the group.
|
1) Add Clawd UK (`+447700900123`) to the group.
|
||||||
|
|||||||
@@ -71,6 +71,7 @@ It does **not** install or change anything on the remote host.
|
|||||||
- Discord: bot token.
|
- Discord: bot token.
|
||||||
- Signal: optional `signal-cli` install + account config.
|
- Signal: optional `signal-cli` install + account config.
|
||||||
- iMessage: local `imsg` CLI path + DB access.
|
- iMessage: local `imsg` CLI path + DB access.
|
||||||
|
- DM security: default is pairing (unknown DMs get a pairing code). Approve via `clawdbot pairing approve --provider <provider> <code>`.
|
||||||
|
|
||||||
6) **Daemon install**
|
6) **Daemon install**
|
||||||
- macOS: LaunchAgent
|
- macOS: LaunchAgent
|
||||||
|
|||||||
Reference in New Issue
Block a user