Files
openclaw/docs/start/pairing.md

82 lines
2.5 KiB
Markdown
Raw Normal View History

2026-01-06 19:30:30 +01:00
---
summary: "Pairing overview: approve who can DM you + which nodes can join"
read_when:
- Setting up DM access control
- Pairing a new iOS/Android node
- Reviewing Clawdbot security posture
---
# Pairing
“Pairing” is Clawdbots explicit **owner approval** step.
It is used in two places:
1) **DM pairing** (who is allowed to talk to the bot)
2) **Node pairing** (which devices/nodes are allowed to join the gateway network)
2026-01-07 02:04:02 +01:00
Security context: [Security](/gateway/security)
2026-01-06 19:30:30 +01:00
## 1) DM pairing (inbound chat access)
When a provider is configured with DM policy `pairing`, unknown senders get a short code and their message is **not processed** until you approve.
2026-01-07 02:04:02 +01:00
Default DM policies are documented in: [Security](/gateway/security)
2026-01-06 19:30:30 +01:00
2026-01-07 05:06:04 +01:00
Pairing codes:
- 8 characters, uppercase, no ambiguous chars (`0O1I`).
- **Expire after 1 hour**. The bot only sends the pairing message when a new request is created (roughly once per hour per sender).
- Pending DM pairing requests are capped at **3 per provider** by default; additional requests are ignored until one expires or is approved.
2026-01-07 05:06:04 +01:00
2026-01-06 19:30:30 +01:00
### Approve a sender
```bash
clawdbot pairing list telegram
clawdbot pairing approve telegram <CODE>
2026-01-06 19:30:30 +01:00
```
Supported providers: `telegram`, `whatsapp`, `signal`, `imessage`, `discord`, `slack`.
### Where the state lives
Stored under `~/.clawdbot/credentials/`:
- Pending requests: `<provider>-pairing.json`
- Approved allowlist store: `<provider>-allowFrom.json`
Treat these as sensitive (they gate access to your assistant).
## 2) Node pairing (iOS/Android nodes joining the gateway)
Nodes (iOS/Android, future hardware, etc.) connect to the Gateway and request to join.
The Gateway keeps an authoritative allowlist; new nodes require explicit approve/reject.
### Approve a node
```bash
clawdbot nodes pending
clawdbot nodes approve <requestId>
```
### Where the state lives
Stored under `~/.clawdbot/nodes/`:
- `pending.json` (short-lived; pending requests expire)
- `paired.json` (paired nodes + tokens)
### Details
2026-01-06 23:32:12 +00:00
Full protocol + design notes: [Gateway pairing](/gateway/pairing)
2026-01-06 19:30:30 +01:00
## Related docs
2026-01-07 02:04:02 +01:00
- Security model + prompt injection: [Security](/gateway/security)
- Updating safely (run doctor): [Updating](/install/updating)
2026-01-06 19:30:30 +01:00
- Provider configs:
2026-01-07 02:04:02 +01:00
- Telegram: [Telegram](/providers/telegram)
- WhatsApp: [WhatsApp](/providers/whatsapp)
- Signal: [Signal](/providers/signal)
- iMessage: [iMessage](/providers/imessage)
- Discord: [Discord](/providers/discord)
- Slack: [Slack](/providers/slack)