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
|
2026-01-30 03:15:10 +01:00
|
|
|
|
- Reviewing OpenClaw security posture
|
2026-01-31 16:04:03 -05:00
|
|
|
|
title: "Pairing"
|
2026-01-06 19:30:30 +01:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
# Pairing
|
|
|
|
|
|
|
2026-01-30 03:15:10 +01:00
|
|
|
|
“Pairing” is OpenClaw’s explicit **owner approval** step.
|
2026-01-06 19:30:30 +01:00
|
|
|
|
It is used in two places:
|
|
|
|
|
|
|
2026-01-31 21:13:13 +09:00
|
|
|
|
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-06 19:30:30 +01:00
|
|
|
|
|
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)
|
|
|
|
|
|
|
2026-01-13 07:15:57 +00:00
|
|
|
|
When a channel is configured with DM policy `pairing`, unknown senders get a short code and their message is **not processed** until you approve.
|
2026-01-06 19:30:30 +01:00
|
|
|
|
|
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:
|
2026-01-31 21:13:13 +09:00
|
|
|
|
|
2026-01-07 05:06:04 +01:00
|
|
|
|
- 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).
|
2026-01-13 07:15:57 +00:00
|
|
|
|
- Pending DM pairing requests are capped at **3 per channel** 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
|
2026-01-30 03:15:10 +01:00
|
|
|
|
openclaw pairing list telegram
|
|
|
|
|
|
openclaw pairing approve telegram <CODE>
|
2026-01-06 19:30:30 +01:00
|
|
|
|
```
|
|
|
|
|
|
|
2026-02-13 05:43:30 +01:00
|
|
|
|
Supported channels: `telegram`, `whatsapp`, `signal`, `imessage`, `discord`, `slack`, `feishu`.
|
2026-01-06 19:30:30 +01:00
|
|
|
|
|
|
|
|
|
|
### Where the state lives
|
|
|
|
|
|
|
2026-01-30 03:15:10 +01:00
|
|
|
|
Stored under `~/.openclaw/credentials/`:
|
2026-01-31 21:13:13 +09:00
|
|
|
|
|
2026-01-13 07:15:57 +00:00
|
|
|
|
- Pending requests: `<channel>-pairing.json`
|
|
|
|
|
|
- Approved allowlist store: `<channel>-allowFrom.json`
|
2026-01-06 19:30:30 +01:00
|
|
|
|
|
|
|
|
|
|
Treat these as sensitive (they gate access to your assistant).
|
|
|
|
|
|
|
2026-01-22 22:02:00 +00:00
|
|
|
|
## 2) Node device pairing (iOS/Android/macOS/headless nodes)
|
2026-01-06 19:30:30 +01:00
|
|
|
|
|
2026-01-22 22:02:00 +00:00
|
|
|
|
Nodes connect to the Gateway as **devices** with `role: node`. The Gateway
|
|
|
|
|
|
creates a device pairing request that must be approved.
|
2026-01-06 19:30:30 +01:00
|
|
|
|
|
2026-02-08 18:07:13 +01:00
|
|
|
|
### Pair via Telegram (recommended for iOS)
|
|
|
|
|
|
|
|
|
|
|
|
If you use the `device-pair` plugin, you can do first-time device pairing entirely from Telegram:
|
|
|
|
|
|
|
|
|
|
|
|
1. In Telegram, message your bot: `/pair`
|
|
|
|
|
|
2. The bot replies with two messages: an instruction message and a separate **setup code** message (easy to copy/paste in Telegram).
|
|
|
|
|
|
3. On your phone, open the OpenClaw iOS app → Settings → Gateway.
|
|
|
|
|
|
4. Paste the setup code and connect.
|
|
|
|
|
|
5. Back in Telegram: `/pair approve`
|
|
|
|
|
|
|
|
|
|
|
|
The setup code is a base64-encoded JSON payload that contains:
|
|
|
|
|
|
|
|
|
|
|
|
- `url`: the Gateway WebSocket URL (`ws://...` or `wss://...`)
|
|
|
|
|
|
- `token`: a short-lived pairing token
|
|
|
|
|
|
|
|
|
|
|
|
Treat the setup code like a password while it is valid.
|
|
|
|
|
|
|
2026-01-22 22:02:00 +00:00
|
|
|
|
### Approve a node device
|
2026-01-06 19:30:30 +01:00
|
|
|
|
|
|
|
|
|
|
```bash
|
2026-01-30 03:15:10 +01:00
|
|
|
|
openclaw devices list
|
|
|
|
|
|
openclaw devices approve <requestId>
|
|
|
|
|
|
openclaw devices reject <requestId>
|
2026-01-06 19:30:30 +01:00
|
|
|
|
```
|
|
|
|
|
|
|
2026-02-06 09:35:57 -05:00
|
|
|
|
### Node pairing state storage
|
2026-01-06 19:30:30 +01:00
|
|
|
|
|
2026-01-30 03:15:10 +01:00
|
|
|
|
Stored under `~/.openclaw/devices/`:
|
2026-01-31 21:13:13 +09:00
|
|
|
|
|
2026-01-06 19:30:30 +01:00
|
|
|
|
- `pending.json` (short-lived; pending requests expire)
|
2026-01-22 22:02:00 +00:00
|
|
|
|
- `paired.json` (paired devices + tokens)
|
2026-01-06 19:30:30 +01:00
|
|
|
|
|
2026-01-22 22:02:00 +00:00
|
|
|
|
### Notes
|
2026-01-06 19:30:30 +01:00
|
|
|
|
|
2026-01-30 03:15:10 +01:00
|
|
|
|
- The legacy `node.pair.*` API (CLI: `openclaw nodes pending/approve`) is a
|
2026-01-22 22:02:00 +00:00
|
|
|
|
separate gateway-owned pairing store. WS nodes still require device 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-13 07:15:57 +00:00
|
|
|
|
- Channel configs:
|
2026-01-13 06:16:43 +00:00
|
|
|
|
- Telegram: [Telegram](/channels/telegram)
|
|
|
|
|
|
- WhatsApp: [WhatsApp](/channels/whatsapp)
|
|
|
|
|
|
- Signal: [Signal](/channels/signal)
|
2026-02-03 18:06:54 -08:00
|
|
|
|
- BlueBubbles (iMessage): [BlueBubbles](/channels/bluebubbles)
|
|
|
|
|
|
- iMessage (legacy): [iMessage](/channels/imessage)
|
2026-01-13 06:16:43 +00:00
|
|
|
|
- Discord: [Discord](/channels/discord)
|
|
|
|
|
|
- Slack: [Slack](/channels/slack)
|