diff --git a/.agent/.DS_Store b/.agent/.DS_Store deleted file mode 100644 index 1f2c43e08..000000000 Binary files a/.agent/.DS_Store and /dev/null differ diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 000000000..f6fca8c5e --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +custom: ['https://github.com/sponsors/steipete'] diff --git a/CHANGELOG.md b/CHANGELOG.md index d8cd54aac..4ce49a181 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,8 +6,10 @@ Docs: https://docs.clawd.bot Status: unreleased. ### Changes +- Agents: honor tools.exec.safeBins in exec allowlist checks. (#2281) - Docs: tighten Fly private deployment steps. (#2289) Thanks @dguido. - Gateway: warn on hook tokens via query params; document header auth preference. (#2200) Thanks @YuriNachos. +- Gateway: add dangerous Control UI device auth bypass flag + audit warnings. (#2248) - Doctor: warn on gateway exposure without auth. (#2016) Thanks @Alex-Alaniz. - Discord: add configurable privileged gateway intents for presences/members. (#2266) Thanks @kentaro. - Docs: add Vercel AI Gateway to providers sidebar. (#1901) Thanks @jerilynzheng. @@ -16,6 +18,7 @@ Status: unreleased. - Docs: add Render deployment guide. (#1975) Thanks @anurag. - Docs: add Claude Max API Proxy guide. (#1875) Thanks @atalovesyou. - Docs: add DigitalOcean deployment guide. (#1870) Thanks @0xJonHoldsCrypto. +- Docs: add Oracle Cloud (OCI) platform guide + cross-links. (#2333) Thanks @hirefrank. - Docs: add Raspberry Pi install guide. (#1871) Thanks @0xJonHoldsCrypto. - Docs: add GCP Compute Engine deployment guide. (#1848) Thanks @hougangdev. - Docs: add LINE channel guide. Thanks @thewilloftheshadow. @@ -32,6 +35,7 @@ Status: unreleased. - Telegram: allow caption param for media sends. (#1888) Thanks @mguellsegarra. - Telegram: support plugin sendPayload channelData (media/buttons) and validate plugin commands. (#1917) Thanks @JoshuaLelon. - Telegram: avoid block replies when streaming is disabled. (#1885) Thanks @ivancasco. +- Security: use Windows ACLs for permission audits and fixes on Windows. (#1957) - Auth: show copyable Google auth URL after ASCII prompt. (#1787) Thanks @robbyczgw-cla. - Routing: precompile session key regexes. (#1697) Thanks @Ray0907. - TUI: avoid width overflow when rendering selection lists. (#1686) Thanks @mossein. @@ -40,7 +44,11 @@ Status: unreleased. - Slack: clear ack reaction after streamed replies. (#2044) Thanks @fancyboi999. - macOS: keep custom SSH usernames in remote target. (#2046) Thanks @algal. +### Breaking +- **BREAKING:** Gateway auth mode "none" is removed; gateway now requires token/password (Tailscale Serve identity still allowed). + ### Fixes +- Agents: include memory.md when bootstrapping memory context. (#2318) Thanks @czekaj. - Telegram: wrap reasoning italics per line to avoid raw underscores. (#2181) Thanks @YuriNachos. - Voice Call: enforce Twilio webhook signature verification for ngrok URLs; disable ngrok free tier bypass by default. - Security: harden Tailscale Serve auth by validating identity via local tailscaled before trusting headers. @@ -50,6 +58,8 @@ Status: unreleased. - Web UI: improve WebChat image paste previews and allow image-only sends. (#1925) Thanks @smartprogrammer93. - Security: wrap external hook content by default with a per-hook opt-out. (#1827) Thanks @mertcicekci0. - Gateway: default auth now fail-closed (token/password required; Tailscale Serve identity remains allowed). +- Gateway: treat loopback + non-local Host connections as remote unless trusted proxy headers are present. +- Onboarding: remove unsupported gateway auth "off" choice from onboarding/configure flows and CLI flags. ## 2026.1.24-3 diff --git a/docs/channels/discord.md b/docs/channels/discord.md index 12dd28084..395f13c6a 100644 --- a/docs/channels/discord.md +++ b/docs/channels/discord.md @@ -10,13 +10,14 @@ Status: ready for DM and guild text channels via the official Discord bot gatewa ## Quick setup (beginner) 1) Create a Discord bot and copy the bot token. -2) Set the token for Clawdbot: +2) In the Discord app settings, enable **Message Content Intent** (and **Server Members Intent** if you plan to use allowlists or name lookups). +3) Set the token for Clawdbot: - Env: `DISCORD_BOT_TOKEN=...` - Or config: `channels.discord.token: "..."`. - If both are set, config takes precedence (env fallback is default-account only). -3) Invite the bot to your server with message permissions. -4) Start the gateway. -5) DM access is pairing by default; approve the pairing code on first contact. +4) Invite the bot to your server with message permissions (create a private server if you just want DMs). +5) Start the gateway. +6) DM access is pairing by default; approve the pairing code on first contact. Minimal config: ```json5 diff --git a/docs/channels/index.md b/docs/channels/index.md index a67c5ac1e..4c2f77581 100644 --- a/docs/channels/index.md +++ b/docs/channels/index.md @@ -26,6 +26,7 @@ Text is supported everywhere; media and reactions vary by channel. - [Matrix](/channels/matrix) — Matrix protocol (plugin, installed separately). - [Nostr](/channels/nostr) — Decentralized DMs via NIP-04 (plugin, installed separately). - [Tlon](/channels/tlon) — Urbit-based messenger (plugin, installed separately). +- [Twitch](/channels/twitch) — Twitch chat via IRC connection (plugin, installed separately). - [Zalo](/channels/zalo) — Zalo Bot API; Vietnam's popular messenger (plugin, installed separately). - [Zalo Personal](/channels/zalouser) — Zalo personal account via QR login (plugin, installed separately). - [WebChat](/web/webchat) — Gateway WebChat UI over WebSocket. diff --git a/docs/channels/twitch.md b/docs/channels/twitch.md new file mode 100644 index 000000000..e92a6c255 --- /dev/null +++ b/docs/channels/twitch.md @@ -0,0 +1,366 @@ +--- +summary: "Twitch chat bot configuration and setup" +read_when: + - Setting up Twitch chat integration for Clawdbot +--- +# Twitch (plugin) + +Twitch chat support via IRC connection. Clawdbot connects as a Twitch user (bot account) to receive and send messages in channels. + +## Plugin required + +Twitch ships as a plugin and is not bundled with the core install. + +Install via CLI (npm registry): + +```bash +clawdbot plugins install @clawdbot/twitch +``` + +Local checkout (when running from a git repo): + +```bash +clawdbot plugins install ./extensions/twitch +``` + +Details: [Plugins](/plugin) + +## Quick setup (beginner) + +1) Create a dedicated Twitch account for the bot (or use an existing account). +2) Generate credentials: [Twitch Token Generator](https://twitchtokengenerator.com/) + - Select **Bot Token** + - Verify scopes `chat:read` and `chat:write` are selected + - Copy the **Client ID** and **Access Token** +3) Find your Twitch user ID: https://www.streamweasels.com/tools/convert-twitch-username-to-user-id/ +4) Configure the token: + - Env: `CLAWDBOT_TWITCH_ACCESS_TOKEN=...` (default account only) + - Or config: `channels.twitch.accessToken` + - If both are set, config takes precedence (env fallback is default-account only). +5) Start the gateway. + +**⚠️ Important:** Add access control (`allowFrom` or `allowedRoles`) to prevent unauthorized users from triggering the bot. `requireMention` defaults to `true`. + +Minimal config: + +```json5 +{ + channels: { + twitch: { + enabled: true, + username: "clawdbot", // Bot's Twitch account + accessToken: "oauth:abc123...", // OAuth Access Token (or use CLAWDBOT_TWITCH_ACCESS_TOKEN env var) + clientId: "xyz789...", // Client ID from Token Generator + channel: "vevisk", // Which Twitch channel's chat to join (required) + allowFrom: ["123456789"] // (recommended) Your Twitch user ID only - get it from https://www.streamweasels.com/tools/convert-twitch-username-to-user-id/ + } + } +} +``` + +## What it is + +- A Twitch channel owned by the Gateway. +- Deterministic routing: replies always go back to Twitch. +- Each account maps to an isolated session key `agent::twitch:`. +- `username` is the bot's account (who authenticates), `channel` is which chat room to join. + +## Setup (detailed) + +### Generate credentials + +Use [Twitch Token Generator](https://twitchtokengenerator.com/): +- Select **Bot Token** +- Verify scopes `chat:read` and `chat:write` are selected +- Copy the **Client ID** and **Access Token** + +No manual app registration needed. Tokens expire after several hours. + +### Configure the bot + +**Env var (default account only):** +```bash +CLAWDBOT_TWITCH_ACCESS_TOKEN=oauth:abc123... +``` + +**Or config:** +```json5 +{ + channels: { + twitch: { + enabled: true, + username: "clawdbot", + accessToken: "oauth:abc123...", + clientId: "xyz789...", + channel: "vevisk" + } + } +} +``` + +If both env and config are set, config takes precedence. + +### Access control (recommended) + +```json5 +{ + channels: { + twitch: { + allowFrom: ["123456789"], // (recommended) Your Twitch user ID only + allowedRoles: ["moderator"] // Or restrict to roles + } + } +} +``` + +**Available roles:** `"moderator"`, `"owner"`, `"vip"`, `"subscriber"`, `"all"`. + +**Why user IDs?** Usernames can change, allowing impersonation. User IDs are permanent. + +Find your Twitch user ID: https://www.streamweasels.com/tools/convert-twitch-username-%20to-user-id/ (Convert your Twitch username to ID) + +## Token refresh (optional) + +Tokens from [Twitch Token Generator](https://twitchtokengenerator.com/) cannot be automatically refreshed - regenerate when expired. + +For automatic token refresh, create your own Twitch application at [Twitch Developer Console](https://dev.twitch.tv/console) and add to config: + +```json5 +{ + channels: { + twitch: { + clientSecret: "your_client_secret", + refreshToken: "your_refresh_token" + } + } +} +``` + +The bot automatically refreshes tokens before expiration and logs refresh events. + +## Multi-account support + +Use `channels.twitch.accounts` with per-account tokens. See [`gateway/configuration`](/gateway/configuration) for the shared pattern. + +Example (one bot account in two channels): + +```json5 +{ + channels: { + twitch: { + accounts: { + channel1: { + username: "clawdbot", + accessToken: "oauth:abc123...", + clientId: "xyz789...", + channel: "vevisk" + }, + channel2: { + username: "clawdbot", + accessToken: "oauth:def456...", + clientId: "uvw012...", + channel: "secondchannel" + } + } + } + } +} +``` + +**Note:** Each account needs its own token (one token per channel). + +## Access control + +### Role-based restrictions + +```json5 +{ + channels: { + twitch: { + accounts: { + default: { + allowedRoles: ["moderator", "vip"] + } + } + } + } +} +``` + +### Allowlist by User ID (most secure) + +```json5 +{ + channels: { + twitch: { + accounts: { + default: { + allowFrom: ["123456789", "987654321"] + } + } + } + } +} +``` + +### Combined allowlist + roles + +Users in `allowFrom` bypass role checks: + +```json5 +{ + channels: { + twitch: { + accounts: { + default: { + allowFrom: ["123456789"], + allowedRoles: ["moderator"] + } + } + } + } +} +``` + +### Disable @mention requirement + +By default, `requireMention` is `true`. To disable and respond to all messages: + +```json5 +{ + channels: { + twitch: { + accounts: { + default: { + requireMention: false + } + } + } + } +} +``` + +## Troubleshooting + +First, run diagnostic commands: + +```bash +clawdbot doctor +clawdbot channels status --probe +``` + +### Bot doesn't respond to messages + +**Check access control:** Temporarily set `allowedRoles: ["all"]` to test. + +**Check the bot is in the channel:** The bot must join the channel specified in `channel`. + +### Token issues + +**"Failed to connect" or authentication errors:** +- Verify `accessToken` is the OAuth access token value (typically starts with `oauth:` prefix) +- Check token has `chat:read` and `chat:write` scopes +- If using token refresh, verify `clientSecret` and `refreshToken` are set + +### Token refresh not working + +**Check logs for refresh events:** +``` +Using env token source for mybot +Access token refreshed for user 123456 (expires in 14400s) +``` + +If you see "token refresh disabled (no refresh token)": +- Ensure `clientSecret` is provided +- Ensure `refreshToken` is provided + +## Config + +**Account config:** +- `username` - Bot username +- `accessToken` - OAuth access token with `chat:read` and `chat:write` +- `clientId` - Twitch Client ID (from Token Generator or your app) +- `channel` - Channel to join (required) +- `enabled` - Enable this account (default: `true`) +- `clientSecret` - Optional: For automatic token refresh +- `refreshToken` - Optional: For automatic token refresh +- `expiresIn` - Token expiry in seconds +- `obtainmentTimestamp` - Token obtained timestamp +- `allowFrom` - User ID allowlist +- `allowedRoles` - Role-based access control (`"moderator" | "owner" | "vip" | "subscriber" | "all"`) +- `requireMention` - Require @mention (default: `true`) + +**Provider options:** +- `channels.twitch.enabled` - Enable/disable channel startup +- `channels.twitch.username` - Bot username (simplified single-account config) +- `channels.twitch.accessToken` - OAuth access token (simplified single-account config) +- `channels.twitch.clientId` - Twitch Client ID (simplified single-account config) +- `channels.twitch.channel` - Channel to join (simplified single-account config) +- `channels.twitch.accounts.` - Multi-account config (all account fields above) + +Full example: + +```json5 +{ + channels: { + twitch: { + enabled: true, + username: "clawdbot", + accessToken: "oauth:abc123...", + clientId: "xyz789...", + channel: "vevisk", + clientSecret: "secret123...", + refreshToken: "refresh456...", + allowFrom: ["123456789"], + allowedRoles: ["moderator", "vip"], + accounts: { + default: { + username: "mybot", + accessToken: "oauth:abc123...", + clientId: "xyz789...", + channel: "your_channel", + enabled: true, + clientSecret: "secret123...", + refreshToken: "refresh456...", + expiresIn: 14400, + obtainmentTimestamp: 1706092800000, + allowFrom: ["123456789", "987654321"], + allowedRoles: ["moderator"] + } + } + } + } +} +``` + +## Tool actions + +The agent can call `twitch` with action: +- `send` - Send a message to a channel + +Example: + +```json5 +{ + "action": "twitch", + "params": { + "message": "Hello Twitch!", + "to": "#mychannel" + } +} +``` + +## Safety & ops + +- **Treat tokens like passwords** - Never commit tokens to git +- **Use automatic token refresh** for long-running bots +- **Use user ID allowlists** instead of usernames for access control +- **Monitor logs** for token refresh events and connection status +- **Scope tokens minimally** - Only request `chat:read` and `chat:write` +- **If stuck**: Restart the gateway after confirming no other process owns the session + +## Limits + +- **500 characters** per message (auto-chunked at word boundaries) +- Markdown is stripped before chunking +- No rate limiting (uses Twitch's built-in rate limits) diff --git a/docs/cli/index.md b/docs/cli/index.md index d23ee3a5e..c49677cbf 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -297,7 +297,7 @@ Options: - `--non-interactive` - `--mode ` - `--flow ` (manual is an alias for advanced) -- `--auth-choice ` +- `--auth-choice ` - `--token-provider ` (non-interactive; used with `--auth-choice token`) - `--token ` (non-interactive; used with `--auth-choice token`) - `--token-profile-id ` (non-interactive; default: `:manual`) @@ -314,7 +314,7 @@ Options: - `--opencode-zen-api-key ` - `--gateway-port ` - `--gateway-bind ` -- `--gateway-auth ` +- `--gateway-auth ` - `--gateway-token ` - `--gateway-password ` - `--remote-url ` @@ -358,7 +358,7 @@ Options: Manage chat channel accounts (WhatsApp/Telegram/Discord/Google Chat/Slack/Mattermost (plugin)/Signal/iMessage/MS Teams). Subcommands: -- `channels list`: show configured channels and auth profiles (Claude Code + Codex CLI OAuth sync included). +- `channels list`: show configured channels and auth profiles. - `channels status`: check gateway reachability and channel health (`--probe` runs extra checks; use `clawdbot health` or `clawdbot status --deep` for gateway health probes). - Tip: `channels status` prints warnings with suggested fixes when it can detect common misconfigurations (then points you to `clawdbot doctor`). - `channels logs`: show recent channel logs from the gateway log file. @@ -390,12 +390,6 @@ Common options: - `--lines ` (default `200`) - `--json` -OAuth sync sources: -- Claude Code → `anthropic:claude-cli` - - macOS: Keychain item "Claude Code-credentials" (choose "Always Allow" to avoid launchd prompts) - - Linux/Windows: `~/.claude/.credentials.json` -- `~/.codex/auth.json` → `openai-codex:codex-cli` - More detail: [/concepts/oauth](/concepts/oauth) Examples: @@ -676,10 +670,11 @@ Tip: when calling `config.set`/`config.apply`/`config.patch` directly, pass `bas See [/concepts/models](/concepts/models) for fallback behavior and scanning strategy. -Preferred Anthropic auth (CLI token, not API key): +Preferred Anthropic auth (setup-token): ```bash claude setup-token +clawdbot models auth setup-token --provider anthropic clawdbot models status ``` diff --git a/docs/cli/models.md b/docs/cli/models.md index ba4600ce4..cb0992121 100644 --- a/docs/cli/models.md +++ b/docs/cli/models.md @@ -64,5 +64,5 @@ clawdbot models auth paste-token `clawdbot plugins list` to see which providers are installed. Notes: -- `setup-token` runs `claude setup-token` on the current machine (requires the Claude Code CLI). -- `paste-token` accepts a token string generated elsewhere. +- `setup-token` prompts for a setup-token value (generate it with `claude setup-token` on any machine). +- `paste-token` accepts a token string generated elsewhere or from automation. diff --git a/docs/concepts/model-providers.md b/docs/concepts/model-providers.md index acbca6461..46dc4f749 100644 --- a/docs/concepts/model-providers.md +++ b/docs/concepts/model-providers.md @@ -49,9 +49,9 @@ Clawdbot ships with the pi‑ai catalog. These providers require **no** ### OpenAI Code (Codex) - Provider: `openai-codex` -- Auth: OAuth or Codex CLI (`~/.codex/auth.json`) +- Auth: OAuth (ChatGPT) - Example model: `openai-codex/gpt-5.2` -- CLI: `clawdbot onboard --auth-choice openai-codex` or `codex-cli` +- CLI: `clawdbot onboard --auth-choice openai-codex` or `clawdbot models auth login --provider openai-codex` ```json5 { diff --git a/docs/concepts/oauth.md b/docs/concepts/oauth.md index 8b2f54d1d..00fe3d656 100644 --- a/docs/concepts/oauth.md +++ b/docs/concepts/oauth.md @@ -1,18 +1,17 @@ --- -summary: "OAuth in Clawdbot: token exchange, storage, CLI sync, and multi-account patterns" +summary: "OAuth in Clawdbot: token exchange, storage, and multi-account patterns" read_when: - You want to understand Clawdbot OAuth end-to-end - You hit token invalidation / logout issues - - You want to reuse Claude Code / Codex CLI OAuth tokens + - You want setup-token or OAuth auth flows - You want multiple accounts or profile routing --- # OAuth -Clawdbot supports “subscription auth” via OAuth for providers that offer it (notably **Anthropic (Claude Pro/Max)** and **OpenAI Codex (ChatGPT OAuth)**). This page explains: +Clawdbot supports “subscription auth” via OAuth for providers that offer it (notably **OpenAI Codex (ChatGPT OAuth)**). For Anthropic subscriptions, use the **setup-token** flow. This page explains: - how the OAuth **token exchange** works (PKCE) - where tokens are **stored** (and why) -- how we **reuse external CLI tokens** (Claude Code / Codex CLI) - how to handle **multiple accounts** (profiles + per-session overrides) Clawdbot also supports **provider plugins** that ship their own OAuth or API‑key @@ -31,7 +30,6 @@ Practical symptom: To reduce that, Clawdbot treats `auth-profiles.json` as a **token sink**: - the runtime reads credentials from **one place** -- we can **sync in** credentials from external CLIs instead of doing a second login - we can keep multiple profiles and route them deterministically ## Storage (where tokens live) @@ -46,47 +44,39 @@ Legacy import-only file (still supported, but not the main store): All of the above also respect `$CLAWDBOT_STATE_DIR` (state dir override). Full reference: [/gateway/configuration](/gateway/configuration#auth-storage-oauth--api-keys) -## Reusing Claude Code / Codex CLI OAuth tokens (recommended) +## Anthropic setup-token (subscription auth) -If you already signed in with the external CLIs *on the gateway host*, Clawdbot can reuse those tokens without starting a separate OAuth flow: +Run `claude setup-token` on any machine, then paste it into Clawdbot: -- Claude Code: `anthropic:claude-cli` - - macOS: Keychain item "Claude Code-credentials" (choose "Always Allow" to avoid launchd prompts) - - Linux/Windows: `~/.claude/.credentials.json` -- Codex CLI: reads `~/.codex/auth.json` → profile `openai-codex:codex-cli` +```bash +clawdbot models auth setup-token --provider anthropic +``` -Sync happens when Clawdbot loads the auth store (so it stays up-to-date when the CLIs refresh tokens). -On macOS, the first read may trigger a Keychain prompt; run `clawdbot models status` -in a terminal once if the Gateway runs headless and can’t access the entry. +If you generated the token elsewhere, paste it manually: -How to verify: +```bash +clawdbot models auth paste-token --provider anthropic +``` + +Verify: ```bash clawdbot models status -clawdbot channels list -``` - -Or JSON: - -```bash -clawdbot channels list --json ``` ## OAuth exchange (how login works) Clawdbot’s interactive login flows are implemented in `@mariozechner/pi-ai` and wired into the wizards/commands. -### Anthropic (Claude Pro/Max) +### Anthropic (Claude Pro/Max) setup-token -Flow shape (PKCE): +Flow shape: -1) generate PKCE verifier/challenge -2) open `https://claude.ai/oauth/authorize?...` -3) user pastes `code#state` -4) exchange at `https://console.anthropic.com/v1/oauth/token` -5) store `{ access, refresh, expires }` under an auth profile +1) run `claude setup-token` +2) paste the token into Clawdbot +3) store as a token auth profile (no refresh) -The wizard path is `clawdbot onboard` → auth choice `oauth` (Anthropic). +The wizard path is `clawdbot onboard` → auth choice `setup-token` (Anthropic). ### OpenAI Codex (ChatGPT OAuth) @@ -99,7 +89,7 @@ Flow shape (PKCE): 5) exchange at `https://auth.openai.com/oauth/token` 6) extract `accountId` from the access token and store `{ access, refresh, expires, accountId }` -Wizard path is `clawdbot onboard` → auth choice `openai-codex` (or `codex-cli` to reuse an existing Codex CLI login). +Wizard path is `clawdbot onboard` → auth choice `openai-codex`. ## Refresh + expiry @@ -111,23 +101,6 @@ At runtime: The refresh flow is automatic; you generally don't need to manage tokens manually. -### Bidirectional sync with Claude Code - -When Clawdbot refreshes an Anthropic OAuth token (profile `anthropic:claude-cli`), it **writes the new credentials back** to Claude Code's storage: - -- **Linux/Windows**: updates `~/.claude/.credentials.json` -- **macOS**: updates Keychain item "Claude Code-credentials" - -This ensures both tools stay in sync and neither gets "logged out" after the other refreshes. - -**Why this matters for long-running agents:** - -Anthropic OAuth tokens expire after a few hours. Without bidirectional sync: -1. Clawdbot refreshes the token → gets new access token -2. Claude Code still has the old token → gets logged out - -With bidirectional sync, both tools always have the latest valid token, enabling autonomous operation for days or weeks without manual intervention. - ## Multiple accounts (profiles) + routing Two patterns: diff --git a/docs/gateway/authentication.md b/docs/gateway/authentication.md index 5f6aa3723..e350242d4 100644 --- a/docs/gateway/authentication.md +++ b/docs/gateway/authentication.md @@ -1,5 +1,5 @@ --- -summary: "Model authentication: OAuth, API keys, and Claude Code token reuse" +summary: "Model authentication: OAuth, API keys, and setup-token" read_when: - Debugging model auth or OAuth expiry - Documenting authentication or credential storage @@ -7,8 +7,8 @@ read_when: # Authentication Clawdbot supports OAuth and API keys for model providers. For Anthropic -accounts, we recommend using an **API key**. Clawdbot can also reuse Claude Code -credentials, including the long‑lived token created by `claude setup-token`. +accounts, we recommend using an **API key**. For Claude subscription access, +use the long‑lived token created by `claude setup-token`. See [/concepts/oauth](/concepts/oauth) for the full OAuth flow and storage layout. @@ -47,29 +47,26 @@ API keys for daemon use: `clawdbot onboard`. See [Help](/help) for details on env inheritance (`env.shellEnv`, `~/.clawdbot/.env`, systemd/launchd). -## Anthropic: Claude Code CLI setup-token (supported) +## Anthropic: setup-token (subscription auth) -For Anthropic, the recommended path is an **API key**. If you’re already using -Claude Code CLI, the setup-token flow is also supported. -Run it on the **gateway host**: +For Anthropic, the recommended path is an **API key**. If you’re using a Claude +subscription, the setup-token flow is also supported. Run it on the **gateway host**: ```bash claude setup-token ``` -Then verify and sync into Clawdbot: +Then paste it into Clawdbot: ```bash -clawdbot models status -clawdbot doctor +clawdbot models auth setup-token --provider anthropic ``` -This should create (or refresh) an auth profile like `anthropic:claude-cli` in -the agent auth store. +If the token was created on another machine, paste it manually: -Clawdbot config sets `auth.profiles["anthropic:claude-cli"].mode` to `"oauth"` so -the profile accepts both OAuth and setup-token credentials. Older configs that -used `"token"` are auto-migrated on load. +```bash +clawdbot models auth paste-token --provider anthropic +``` If you see an Anthropic error like: @@ -79,12 +76,6 @@ This credential is only authorized for use with Claude Code and cannot be used f …use an Anthropic API key instead. -Alternative: run the wrapper (also updates Clawdbot config): - -```bash -clawdbot models auth setup-token --provider anthropic -``` - Manual token entry (any provider; writes `auth-profiles.json` + updates config): ```bash @@ -101,10 +92,6 @@ clawdbot models status --check Optional ops scripts (systemd/Termux) are documented here: [/automation/auth-monitoring](/automation/auth-monitoring) -`clawdbot models status` loads Claude Code credentials into Clawdbot’s -`auth-profiles.json` and shows expiry (warns within 24h by default). -`clawdbot doctor` also performs the sync when it runs. - > `claude setup-token` requires an interactive TTY. ## Checking model auth status @@ -118,7 +105,7 @@ clawdbot doctor ### Per-session (chat command) -Use `/model @` to pin a specific provider credential for the current session (example profile ids: `anthropic:claude-cli`, `anthropic:default`). +Use `/model @` to pin a specific provider credential for the current session (example profile ids: `anthropic:default`, `anthropic:work`). Use `/model` (or `/model list`) for a compact picker; use `/model status` for the full view (candidates + next auth profile, plus provider endpoint details when configured). @@ -128,23 +115,12 @@ Set an explicit auth profile order override for an agent (stored in that agent ```bash clawdbot models auth order get --provider anthropic -clawdbot models auth order set --provider anthropic anthropic:claude-cli +clawdbot models auth order set --provider anthropic anthropic:default clawdbot models auth order clear --provider anthropic ``` Use `--agent ` to target a specific agent; omit it to use the configured default agent. -## How sync works - -1. **Claude Code** stores credentials in `~/.claude/.credentials.json` (or - Keychain on macOS). -2. **Clawdbot** syncs those into - `~/.clawdbot/agents//agent/auth-profiles.json` when the auth store is - loaded. -3. Refreshable OAuth profiles can be refreshed automatically on use. Static - token profiles (including Claude Code CLI setup-token) are not refreshable by - Clawdbot. - ## Troubleshooting ### “No credentials found” @@ -159,7 +135,7 @@ clawdbot models status ### Token expiring/expired Run `clawdbot models status` to confirm which profile is expiring. If the profile -is `anthropic:claude-cli`, rerun `claude setup-token`. +is missing, rerun `claude setup-token` and paste the token again. ## Requirements diff --git a/docs/gateway/configuration.md b/docs/gateway/configuration.md index 024c0b1c5..eaba866b1 100644 --- a/docs/gateway/configuration.md +++ b/docs/gateway/configuration.md @@ -374,12 +374,6 @@ Overrides: On first use, Clawdbot imports `oauth.json` entries into `auth-profiles.json`. -Clawdbot also auto-syncs OAuth tokens from external CLIs into `auth-profiles.json` (when present on the gateway host): -- Claude Code → `anthropic:claude-cli` - - macOS: Keychain item "Claude Code-credentials" (choose "Always Allow" to avoid launchd prompts) - - Linux/Windows: `~/.claude/.credentials.json` -- `~/.codex/auth.json` (Codex CLI) → `openai-codex:codex-cli` - ### `auth` Optional metadata for auth profiles. This does **not** store secrets; it maps @@ -400,10 +394,6 @@ rotation order used for failover. } ``` -Note: `anthropic:claude-cli` should use `mode: "oauth"` even when the stored -credential is a setup-token. Clawdbot auto-migrates older configs that used -`mode: "token"`. - ### `agents.list[].identity` Optional per-agent identity used for defaults and UX. This is written by the macOS onboarding assistant. @@ -2847,9 +2837,11 @@ Control UI base path: - `gateway.controlUi.basePath` sets the URL prefix where the Control UI is served. - Examples: `"/ui"`, `"/clawdbot"`, `"/apps/clawdbot"`. - Default: root (`/`) (unchanged). -- `gateway.controlUi.allowInsecureAuth` allows token-only auth for the Control UI and skips - device identity + pairing (even on HTTPS). Default: `false`. Prefer HTTPS +- `gateway.controlUi.allowInsecureAuth` allows token-only auth for the Control UI when + device identity is omitted (typically over HTTP). Default: `false`. Prefer HTTPS (Tailscale Serve) or `127.0.0.1`. +- `gateway.controlUi.dangerouslyDisableDeviceAuth` disables device identity checks for the + Control UI (token/password only). Default: `false`. Break-glass only. Related docs: - [Control UI](/web/control-ui) diff --git a/docs/gateway/protocol.md b/docs/gateway/protocol.md index fc6682708..279b37614 100644 --- a/docs/gateway/protocol.md +++ b/docs/gateway/protocol.md @@ -198,7 +198,8 @@ The Gateway treats these as **claims** and enforces server-side allowlists. - **Local** connects include loopback and the gateway host’s own tailnet address (so same‑host tailnet binds can still auto‑approve). - All WS clients must include `device` identity during `connect` (operator + node). - Control UI can omit it **only** when `gateway.controlUi.allowInsecureAuth` is enabled. + Control UI can omit it **only** when `gateway.controlUi.allowInsecureAuth` is enabled + (or `gateway.controlUi.dangerouslyDisableDeviceAuth` for break-glass use). - Non-local connections must sign the server-provided `connect.challenge` nonce. ## TLS + pinning diff --git a/docs/gateway/security.md b/docs/gateway/security.md index f5526ca73..3b8f9f036 100644 --- a/docs/gateway/security.md +++ b/docs/gateway/security.md @@ -58,9 +58,13 @@ When the audit prints findings, treat this as a priority order: The Control UI needs a **secure context** (HTTPS or localhost) to generate device identity. If you enable `gateway.controlUi.allowInsecureAuth`, the UI falls back -to **token-only auth** and skips device pairing (even on HTTPS). This is a security +to **token-only auth** and skips device pairing when device identity is omitted. This is a security downgrade—prefer HTTPS (Tailscale Serve) or open the UI on `127.0.0.1`. +For break-glass scenarios only, `gateway.controlUi.dangerouslyDisableDeviceAuth` +disables device identity checks entirely. This is a severe security downgrade; +keep it off unless you are actively debugging and can revert quickly. + `clawdbot security audit` warns when this setting is enabled. ## Reverse Proxy Configuration @@ -195,6 +199,7 @@ Even with strong system prompts, **prompt injection is not solved**. What helps - Prefer mention gating in groups; avoid “always-on” bots in public rooms. - Treat links, attachments, and pasted instructions as hostile by default. - Run sensitive tool execution in a sandbox; keep secrets out of the agent’s reachable filesystem. +- Note: sandboxing is opt-in; if sandbox mode is off, exec runs on the gateway host even though tools.exec.host defaults to sandbox. - Limit high-risk tools (`exec`, `browser`, `web_fetch`, `web_search`) to trusted agents or explicit allowlists. - **Model choice matters:** older/legacy models can be less robust against prompt injection and tool misuse. Prefer modern, instruction-hardened models for any bot with tools. We recommend Anthropic Opus 4.5 because it’s quite good at recognizing prompt injections (see [“A step forward on safety”](https://www.anthropic.com/news/claude-opus-4-5)). diff --git a/docs/gateway/troubleshooting.md b/docs/gateway/troubleshooting.md index 24815e258..697654b80 100644 --- a/docs/gateway/troubleshooting.md +++ b/docs/gateway/troubleshooting.md @@ -53,13 +53,12 @@ clawdbot models status This means the stored Anthropic OAuth token expired and the refresh failed. If you’re on a Claude subscription (no API key), the most reliable fix is to -switch to a **Claude Code setup-token** or re-sync Claude Code CLI OAuth on the -**gateway host**. +switch to a **Claude Code setup-token** and paste it on the **gateway host**. **Recommended (setup-token):** ```bash -# Run on the gateway host (runs Claude Code CLI) +# Run on the gateway host (paste the setup-token) clawdbot models auth setup-token --provider anthropic clawdbot models status ``` @@ -71,10 +70,6 @@ clawdbot models auth paste-token --provider anthropic clawdbot models status ``` -**If you want to keep OAuth reuse:** -log in with Claude Code CLI on the gateway host, then run `clawdbot models status` -to sync the refreshed token into Clawdbot’s auth store. - More detail: [Anthropic](/providers/anthropic) and [OAuth](/concepts/oauth). ### Control UI fails on HTTP ("device identity required" / "connect failed") @@ -214,7 +209,7 @@ the Gateway likely refused to bind. - Fix: run `clawdbot doctor` to update it (or `clawdbot gateway install --force` for a full rewrite). **If `Last gateway error:` mentions “refusing to bind … without auth”** -- You set `gateway.bind` to a non-loopback mode (`lan`/`tailnet`/`custom`, or `auto` when loopback is unavailable) but left auth off. +- You set `gateway.bind` to a non-loopback mode (`lan`/`tailnet`/`custom`, or `auto` when loopback is unavailable) but didn’t configure auth. - Fix: set `gateway.auth.mode` + `gateway.auth.token` (or export `CLAWDBOT_GATEWAY_TOKEN`) and restart the service. **If `clawdbot gateway status` says `bind=tailnet` but no tailnet interface was found** diff --git a/docs/help/faq.md b/docs/help/faq.md index aadbda9de..f4e177f8d 100644 --- a/docs/help/faq.md +++ b/docs/help/faq.md @@ -630,7 +630,7 @@ Docs: [Anthropic](/providers/anthropic), [OpenAI](/providers/openai), ### Can I use Claude Max subscription without an API key -Yes. You can authenticate with **Claude Code CLI OAuth** or a **setup-token** +Yes. You can authenticate with a **setup-token** instead of an API key. This is the subscription path. Claude Pro/Max subscriptions **do not include an API key**, so this is the @@ -640,11 +640,7 @@ If you want the most explicit, supported path, use an Anthropic API key. ### How does Anthropic setuptoken auth work -`claude setup-token` generates a **token string** via the Claude Code CLI (it is not available in the web console). You can run it on **any machine**. If Claude Code CLI credentials are present on the gateway host, Clawdbot can reuse them; otherwise choose **Anthropic token (paste setup-token)** and paste the string. The token is stored as an auth profile for the **anthropic** provider and used like an API key or OAuth profile. More detail: [OAuth](/concepts/oauth). - -Clawdbot keeps `auth.profiles["anthropic:claude-cli"].mode` set to `"oauth"` so -the profile accepts both OAuth and setup-token credentials; older `"token"` mode -entries auto-migrate. +`claude setup-token` generates a **token string** via the Claude Code CLI (it is not available in the web console). You can run it on **any machine**. Choose **Anthropic token (paste setup-token)** in the wizard or paste it with `clawdbot models auth paste-token --provider anthropic`. The token is stored as an auth profile for the **anthropic** provider and used like an API key (no auto-refresh). More detail: [OAuth](/concepts/oauth). ### Where do I find an Anthropic setuptoken @@ -656,9 +652,9 @@ claude setup-token Copy the token it prints, then choose **Anthropic token (paste setup-token)** in the wizard. If you want to run it on the gateway host, use `clawdbot models auth setup-token --provider anthropic`. If you ran `claude setup-token` elsewhere, paste it on the gateway host with `clawdbot models auth paste-token --provider anthropic`. See [Anthropic](/providers/anthropic). -### Do you support Claude subscription auth Claude Code OAuth +### Do you support Claude subscription auth (Claude Pro/Max) -Yes. Clawdbot can **reuse Claude Code CLI credentials** (OAuth) and also supports **setup-token**. If you have a Claude subscription, we recommend **setup-token** for long‑running setups (requires Claude Pro/Max + the `claude` CLI). You can generate it anywhere and paste it on the gateway host. OAuth reuse is supported, but avoid logging in separately via Clawdbot and Claude Code to prevent token conflicts. See [Anthropic](/providers/anthropic) and [OAuth](/concepts/oauth). +Yes — via **setup-token**. Clawdbot no longer reuses Claude Code CLI OAuth tokens; use a setup-token or an Anthropic API key. Generate the token anywhere and paste it on the gateway host. See [Anthropic](/providers/anthropic) and [OAuth](/concepts/oauth). Note: Claude subscription access is governed by Anthropic’s terms. For production or multi‑user workloads, API keys are usually the safer choice. @@ -678,13 +674,12 @@ Yes - via pi‑ai’s **Amazon Bedrock (Converse)** provider with **manual confi ### How does Codex auth work -Clawdbot supports **OpenAI Code (Codex)** via OAuth or by reusing your Codex CLI login (`~/.codex/auth.json`). The wizard can import the CLI login or run the OAuth flow and will set the default model to `openai-codex/gpt-5.2` when appropriate. See [Model providers](/concepts/model-providers) and [Wizard](/start/wizard). +Clawdbot supports **OpenAI Code (Codex)** via OAuth (ChatGPT sign-in). The wizard can run the OAuth flow and will set the default model to `openai-codex/gpt-5.2` when appropriate. See [Model providers](/concepts/model-providers) and [Wizard](/start/wizard). ### Do you support OpenAI subscription auth Codex OAuth -Yes. Clawdbot fully supports **OpenAI Code (Codex) subscription OAuth** and can also reuse an -existing Codex CLI login (`~/.codex/auth.json`) on the gateway host. The onboarding wizard -can import the CLI login or run the OAuth flow for you. +Yes. Clawdbot fully supports **OpenAI Code (Codex) subscription OAuth**. The onboarding wizard +can run the OAuth flow for you. See [OAuth](/concepts/oauth), [Model providers](/concepts/model-providers), and [Wizard](/start/wizard). @@ -1940,8 +1935,8 @@ You can list available models with `/model`, `/model list`, or `/model status`. You can also force a specific auth profile for the provider (per session): ``` -/model opus@anthropic:claude-cli /model opus@anthropic:default +/model opus@anthropic:work ``` Tip: `/model status` shows which agent is active, which `auth-profiles.json` file is being used, and which auth profile will be tried next. @@ -2145,21 +2140,17 @@ It means the system attempted to use the auth profile ID `anthropic:default`, bu - **Sanity‑check model/auth status** - Use `clawdbot models status` to see configured models and whether providers are authenticated. -**Fix checklist for No credentials found for profile anthropic claude cli** +**Fix checklist for No credentials found for profile anthropic** -This means the run is pinned to the **Claude Code CLI** profile, but the Gateway -can’t find that profile in its auth store. +This means the run is pinned to an Anthropic auth profile, but the Gateway +can’t find it in its auth store. -- **Sync the Claude Code CLI token on the gateway host** - - Run `clawdbot models status` (it loads + syncs Claude Code CLI credentials). - - If it still says missing: run `claude setup-token` (or `clawdbot models auth setup-token --provider anthropic`) and retry. -- **If the token was created on another machine** - - Paste it into the gateway host with `clawdbot models auth paste-token --provider anthropic`. -- **Check the profile mode** - - `auth.profiles["anthropic:claude-cli"].mode` must be `"oauth"` (token mode rejects OAuth credentials). +- **Use a setup-token** + - Run `claude setup-token`, then paste it with `clawdbot models auth setup-token --provider anthropic`. + - If the token was created on another machine, use `clawdbot models auth paste-token --provider anthropic`. - **If you want to use an API key instead** - Put `ANTHROPIC_API_KEY` in `~/.clawdbot/.env` on the **gateway host**. - - Clear any pinned order that forces `anthropic:claude-cli`: + - Clear any pinned order that forces a missing profile: ```bash clawdbot models auth order clear --provider anthropic ``` @@ -2181,7 +2172,7 @@ Fix: Clawdbot now strips unsigned thinking blocks for Google Antigravity Claude. ## Auth profiles: what they are and how to manage them -Related: [/concepts/oauth](/concepts/oauth) (OAuth flows, token storage, multi-account patterns, CLI sync) +Related: [/concepts/oauth](/concepts/oauth) (OAuth flows, token storage, multi-account patterns) ### What is an auth profile @@ -2212,10 +2203,10 @@ You can also set a **per-agent** order override (stored in that agent’s `auth- clawdbot models auth order get --provider anthropic # Lock rotation to a single profile (only try this one) -clawdbot models auth order set --provider anthropic anthropic:claude-cli +clawdbot models auth order set --provider anthropic anthropic:default # Or set an explicit order (fallback within provider) -clawdbot models auth order set --provider anthropic anthropic:claude-cli anthropic:default +clawdbot models auth order set --provider anthropic anthropic:work anthropic:default # Clear override (fall back to config auth.order / round-robin) clawdbot models auth order clear --provider anthropic @@ -2224,7 +2215,7 @@ clawdbot models auth order clear --provider anthropic To target a specific agent: ```bash -clawdbot models auth order set --provider anthropic --agent main anthropic:claude-cli +clawdbot models auth order set --provider anthropic --agent main anthropic:default ``` ### OAuth vs API key whats the difference @@ -2234,7 +2225,7 @@ Clawdbot supports both: - **OAuth** often leverages subscription access (where applicable). - **API keys** use pay‑per‑token billing. -The wizard explicitly supports Anthropic OAuth and OpenAI Codex OAuth and can store API keys for you. +The wizard explicitly supports Anthropic setup-token and OpenAI Codex OAuth and can store API keys for you. ## Gateway: ports, “already running”, and remote mode diff --git a/docs/platforms/digitalocean.md b/docs/platforms/digitalocean.md index 632057c84..afefe3676 100644 --- a/docs/platforms/digitalocean.md +++ b/docs/platforms/digitalocean.md @@ -1,5 +1,5 @@ --- -summary: "Clawdbot on DigitalOcean (cheapest paid VPS option)" +summary: "Clawdbot on DigitalOcean (simple paid VPS option)" read_when: - Setting up Clawdbot on DigitalOcean - Looking for cheap VPS hosting for Clawdbot @@ -11,22 +11,22 @@ read_when: Run a persistent Clawdbot Gateway on DigitalOcean for **$6/month** (or $4/mo with reserved pricing). -If you want something even cheaper, see [Oracle Cloud (Free Tier)](#oracle-cloud-free-alternative) at the bottom — it's **actually free forever**. +If you want a $0/month option and don’t mind ARM + provider-specific setup, see the [Oracle Cloud guide](/platforms/oracle). ## Cost Comparison (2026) | Provider | Plan | Specs | Price/mo | Notes | |----------|------|-------|----------|-------| -| **Oracle Cloud** | Always Free ARM | 4 OCPU, 24GB RAM | **$0** | Best value, requires ARM-compatible setup | -| **Hetzner** | CX22 | 2 vCPU, 4GB RAM | €3.79 (~$4) | Cheapest paid, EU datacenters | -| **DigitalOcean** | Basic | 1 vCPU, 1GB RAM | $6 | Easy UI, good docs | -| **Vultr** | Cloud Compute | 1 vCPU, 1GB RAM | $6 | Many locations | -| **Linode** | Nanode | 1 vCPU, 1GB RAM | $5 | Now part of Akamai | +| Oracle Cloud | Always Free ARM | up to 4 OCPU, 24GB RAM | $0 | ARM, limited capacity / signup quirks | +| Hetzner | CX22 | 2 vCPU, 4GB RAM | €3.79 (~$4) | Cheapest paid option | +| DigitalOcean | Basic | 1 vCPU, 1GB RAM | $6 | Easy UI, good docs | +| Vultr | Cloud Compute | 1 vCPU, 1GB RAM | $6 | Many locations | +| Linode | Nanode | 1 vCPU, 1GB RAM | $5 | Now part of Akamai | -**Recommendation:** -- **Free:** Oracle Cloud ARM (if you can handle the signup process) -- **Paid:** Hetzner CX22 (best specs per dollar) — see [Hetzner guide](/platforms/hetzner) -- **Easy:** DigitalOcean (this guide) — beginner-friendly UI +**Picking a provider:** +- DigitalOcean: simplest UX + predictable setup (this guide) +- Hetzner: good price/perf (see [Hetzner guide](/platforms/hetzner)) +- Oracle Cloud: can be $0/month, but is more finicky and ARM-only (see [Oracle guide](/platforms/oracle)) --- @@ -192,7 +192,7 @@ tar -czvf clawdbot-backup.tar.gz ~/.clawdbot ~/clawd ## Oracle Cloud Free Alternative -Oracle Cloud offers **Always Free** ARM instances that are significantly more powerful: +Oracle Cloud offers **Always Free** ARM instances that are significantly more powerful than any paid option here — for $0/month. | What you get | Specs | |--------------|-------| @@ -201,19 +201,11 @@ Oracle Cloud offers **Always Free** ARM instances that are significantly more po | **200GB storage** | Block volume | | **Forever free** | No credit card charges | -### Quick setup: -1. Sign up at [oracle.com/cloud/free](https://www.oracle.com/cloud/free/) -2. Create a VM.Standard.A1.Flex instance (ARM) -3. Choose Oracle Linux or Ubuntu -4. Allocate up to 4 OCPU / 24GB RAM within free tier -5. Follow the same Clawdbot install steps above - **Caveats:** - Signup can be finicky (retry if it fails) - ARM architecture — most things work, but some binaries need ARM builds -- Oracle may reclaim idle instances (keep them active) -For the full Oracle guide, see the [community docs](https://gist.github.com/rssnyder/51e3cfedd730e7dd5f4a816143b25dbd). +For the full setup guide, see [Oracle Cloud](/platforms/oracle). For signup tips and troubleshooting the enrollment process, see this [community guide](https://gist.github.com/rssnyder/51e3cfedd730e7dd5f4a816143b25dbd). --- diff --git a/docs/platforms/oracle.md b/docs/platforms/oracle.md new file mode 100644 index 000000000..d8006754b --- /dev/null +++ b/docs/platforms/oracle.md @@ -0,0 +1,291 @@ +--- +summary: "Clawdbot on Oracle Cloud (Always Free ARM)" +read_when: + - Setting up Clawdbot on Oracle Cloud + - Looking for low-cost VPS hosting for Clawdbot + - Want 24/7 Clawdbot on a small server +--- + +# Clawdbot on Oracle Cloud (OCI) + +## Goal + +Run a persistent Clawdbot Gateway on Oracle Cloud's **Always Free** ARM tier. + +Oracle’s free tier can be a great fit for Clawdbot (especially if you already have an OCI account), but it comes with tradeoffs: + +- ARM architecture (most things work, but some binaries may be x86-only) +- Capacity and signup can be finicky + +## Cost Comparison (2026) + +| Provider | Plan | Specs | Price/mo | Notes | +|----------|------|-------|----------|-------| +| Oracle Cloud | Always Free ARM | up to 4 OCPU, 24GB RAM | $0 | ARM, limited capacity | +| Hetzner | CX22 | 2 vCPU, 4GB RAM | ~ $4 | Cheapest paid option | +| DigitalOcean | Basic | 1 vCPU, 1GB RAM | $6 | Easy UI, good docs | +| Vultr | Cloud Compute | 1 vCPU, 1GB RAM | $6 | Many locations | +| Linode | Nanode | 1 vCPU, 1GB RAM | $5 | Now part of Akamai | + +--- + +## Prerequisites + +- Oracle Cloud account ([signup](https://www.oracle.com/cloud/free/)) — see [community signup guide](https://gist.github.com/rssnyder/51e3cfedd730e7dd5f4a816143b25dbd) if you hit issues +- Tailscale account (free at [tailscale.com](https://tailscale.com)) +- ~30 minutes + +## 1) Create an OCI Instance + +1. Log into [Oracle Cloud Console](https://cloud.oracle.com/) +2. Navigate to **Compute → Instances → Create Instance** +3. Configure: + - **Name:** `clawdbot` + - **Image:** Ubuntu 24.04 (aarch64) + - **Shape:** `VM.Standard.A1.Flex` (Ampere ARM) + - **OCPUs:** 2 (or up to 4) + - **Memory:** 12 GB (or up to 24 GB) + - **Boot volume:** 50 GB (up to 200 GB free) + - **SSH key:** Add your public key +4. Click **Create** +5. Note the public IP address + +**Tip:** If instance creation fails with "Out of capacity", try a different availability domain or retry later. Free tier capacity is limited. + +## 2) Connect and Update + +```bash +# Connect via public IP +ssh ubuntu@YOUR_PUBLIC_IP + +# Update system +sudo apt update && sudo apt upgrade -y +sudo apt install -y build-essential +``` + +**Note:** `build-essential` is required for ARM compilation of some dependencies. + +## 3) Configure User and Hostname + +```bash +# Set hostname +sudo hostnamectl set-hostname clawdbot + +# Set password for ubuntu user +sudo passwd ubuntu + +# Enable lingering (keeps user services running after logout) +sudo loginctl enable-linger ubuntu +``` + +## 4) Install Tailscale + +```bash +curl -fsSL https://tailscale.com/install.sh | sh +sudo tailscale up --ssh --hostname=clawdbot +``` + +This enables Tailscale SSH, so you can connect via `ssh clawdbot` from any device on your tailnet — no public IP needed. + +Verify: +```bash +tailscale status +``` + +**From now on, connect via Tailscale:** `ssh ubuntu@clawdbot` (or use the Tailscale IP). + +## 5) Install Clawdbot + +```bash +curl -fsSL https://clawd.bot/install.sh | bash +source ~/.bashrc +``` + +When prompted "How do you want to hatch your bot?", select **"Do this later"**. + +> Note: If you hit ARM-native build issues, start with system packages (e.g. `sudo apt install -y build-essential`) before reaching for Homebrew. + +## 6) Configure Gateway (loopback + token auth) and enable Tailscale Serve + +Use token auth as the default. It’s predictable and avoids needing any “insecure auth” Control UI flags. + +```bash +# Keep the Gateway private on the VM +clawdbot config set gateway.bind loopback + +# Require auth for the Gateway + Control UI +clawdbot config set gateway.auth.mode token +clawdbot doctor --generate-gateway-token + +# Expose over Tailscale Serve (HTTPS + tailnet access) +clawdbot config set gateway.tailscale.mode serve +clawdbot config set gateway.trustedProxies '["127.0.0.1"]' + +systemctl --user restart clawdbot-gateway +``` + +## 7) Verify + +```bash +# Check version +clawdbot --version + +# Check daemon status +systemctl --user status clawdbot-gateway + +# Check Tailscale Serve +tailscale serve status + +# Test local response +curl http://localhost:18789 +``` + +## 8) Lock Down VCN Security + +Now that everything is working, lock down the VCN to block all traffic except Tailscale. OCI's Virtual Cloud Network acts as a firewall at the network edge — traffic is blocked before it reaches your instance. + +1. Go to **Networking → Virtual Cloud Networks** in the OCI Console +2. Click your VCN → **Security Lists** → Default Security List +3. **Remove** all ingress rules except: + - `0.0.0.0/0 UDP 41641` (Tailscale) +4. Keep default egress rules (allow all outbound) + +This blocks SSH on port 22, HTTP, HTTPS, and everything else at the network edge. From now on, you can only connect via Tailscale. + +--- + +## Access the Control UI + +From any device on your Tailscale network: + +``` +https://clawdbot..ts.net/ +``` + +Replace `` with your tailnet name (visible in `tailscale status`). + +No SSH tunnel needed. Tailscale provides: +- HTTPS encryption (automatic certs) +- Authentication via Tailscale identity +- Access from any device on your tailnet (laptop, phone, etc.) + +--- + +## Security: VCN + Tailscale (recommended baseline) + +With the VCN locked down (only UDP 41641 open) and the Gateway bound to loopback, you get strong defense-in-depth: public traffic is blocked at the network edge, and admin access happens over your tailnet. + +This setup often removes the *need* for extra host-based firewall rules purely to stop Internet-wide SSH brute force — but you should still keep the OS updated, run `clawdbot security audit`, and verify you aren’t accidentally listening on public interfaces. + +### What's Already Protected + +| Traditional Step | Needed? | Why | +|------------------|---------|-----| +| UFW firewall | No | VCN blocks before traffic reaches instance | +| fail2ban | No | No brute force if port 22 blocked at VCN | +| sshd hardening | No | Tailscale SSH doesn't use sshd | +| Disable root login | No | Tailscale uses Tailscale identity, not system users | +| SSH key-only auth | No | Tailscale authenticates via your tailnet | +| IPv6 hardening | Usually not | Depends on your VCN/subnet settings; verify what’s actually assigned/exposed | + +### Still Recommended + +- **Credential permissions:** `chmod 700 ~/.clawdbot` +- **Security audit:** `clawdbot security audit` +- **System updates:** `sudo apt update && sudo apt upgrade` regularly +- **Monitor Tailscale:** Review devices in [Tailscale admin console](https://login.tailscale.com/admin) + +### Verify Security Posture + +```bash +# Confirm no public ports listening +sudo ss -tlnp | grep -v '127.0.0.1\|::1' + +# Verify Tailscale SSH is active +tailscale status | grep -q 'offers: ssh' && echo "Tailscale SSH active" + +# Optional: disable sshd entirely +sudo systemctl disable --now ssh +``` + +--- + +## Fallback: SSH Tunnel + +If Tailscale Serve isn't working, use an SSH tunnel: + +```bash +# From your local machine (via Tailscale) +ssh -L 18789:127.0.0.1:18789 ubuntu@clawdbot +``` + +Then open `http://localhost:18789`. + +--- + +## Troubleshooting + +### Instance creation fails ("Out of capacity") +Free tier ARM instances are popular. Try: +- Different availability domain +- Retry during off-peak hours (early morning) +- Use the "Always Free" filter when selecting shape + +### Tailscale won't connect +```bash +# Check status +sudo tailscale status + +# Re-authenticate +sudo tailscale up --ssh --hostname=clawdbot --reset +``` + +### Gateway won't start +```bash +clawdbot gateway status +clawdbot doctor --non-interactive +journalctl --user -u clawdbot-gateway -n 50 +``` + +### Can't reach Control UI +```bash +# Verify Tailscale Serve is running +tailscale serve status + +# Check gateway is listening +curl http://localhost:18789 + +# Restart if needed +systemctl --user restart clawdbot-gateway +``` + +### ARM binary issues +Some tools may not have ARM builds. Check: +```bash +uname -m # Should show aarch64 +``` + +Most npm packages work fine. For binaries, look for `linux-arm64` or `aarch64` releases. + +--- + +## Persistence + +All state lives in: +- `~/.clawdbot/` — config, credentials, session data +- `~/clawd/` — workspace (SOUL.md, memory, artifacts) + +Back up periodically: +```bash +tar -czvf clawdbot-backup.tar.gz ~/.clawdbot ~/clawd +``` + +--- + +## See Also + +- [Gateway remote access](/gateway/remote) — other remote access patterns +- [Tailscale integration](/gateway/tailscale) — full Tailscale docs +- [Gateway configuration](/gateway/configuration) — all config options +- [DigitalOcean guide](/platforms/digitalocean) — if you want paid + easier signup +- [Hetzner guide](/platforms/hetzner) — Docker-based alternative diff --git a/docs/providers/anthropic.md b/docs/providers/anthropic.md index 7876c4ae9..018e130dd 100644 --- a/docs/providers/anthropic.md +++ b/docs/providers/anthropic.md @@ -1,14 +1,13 @@ --- -summary: "Use Anthropic Claude via API keys or Claude Code CLI auth in Clawdbot" +summary: "Use Anthropic Claude via API keys or setup-token in Clawdbot" read_when: - You want to use Anthropic models in Clawdbot - - You want setup-token or Claude Code CLI auth instead of API keys + - You want setup-token instead of API keys --- # Anthropic (Claude) Anthropic builds the **Claude** model family and provides access via an API. -In Clawdbot you can authenticate with an API key or reuse **Claude Code CLI** credentials -(setup-token or OAuth). +In Clawdbot you can authenticate with an API key or a **setup-token**. ## Option A: Anthropic API key @@ -37,7 +36,7 @@ clawdbot onboard --anthropic-api-key "$ANTHROPIC_API_KEY" ## Prompt caching (Anthropic API) Clawdbot does **not** override Anthropic’s default cache TTL unless you set it. -This is **API-only**; Claude Code CLI OAuth ignores TTL settings. +This is **API-only**; subscription auth does not honor TTL settings. To set the TTL per model, use `cacheControlTtl` in the model `params`: @@ -58,9 +57,9 @@ To set the TTL per model, use `cacheControlTtl` in the model `params`: Clawdbot includes the `extended-cache-ttl-2025-04-11` beta flag for Anthropic API requests; keep it if you override provider headers (see [/gateway/configuration](/gateway/configuration)). -## Option B: Claude Code CLI (setup-token or OAuth) +## Option B: Claude setup-token -**Best for:** using your Claude subscription or existing Claude Code CLI login. +**Best for:** using your Claude subscription. ### Where to get a setup-token @@ -85,8 +84,8 @@ clawdbot models auth paste-token --provider anthropic ### CLI setup ```bash -# Reuse Claude Code CLI OAuth credentials if already logged in -clawdbot onboard --auth-choice claude-cli +# Paste a setup-token during onboarding +clawdbot onboard --auth-choice setup-token ``` ### Config snippet @@ -100,10 +99,7 @@ clawdbot onboard --auth-choice claude-cli ## Notes - Generate the setup-token with `claude setup-token` and paste it, or run `clawdbot models auth setup-token` on the gateway host. -- If you see “OAuth token refresh failed …” on a Claude subscription, re-auth with a setup-token or resync Claude Code CLI OAuth on the gateway host. See [/gateway/troubleshooting#oauth-token-refresh-failed-anthropic-claude-subscription](/gateway/troubleshooting#oauth-token-refresh-failed-anthropic-claude-subscription). -- Clawdbot writes `auth.profiles["anthropic:claude-cli"].mode` as `"oauth"` so the profile - accepts both OAuth and setup-token credentials. Older configs using `"token"` are - auto-migrated on load. +- If you see “OAuth token refresh failed …” on a Claude subscription, re-auth with a setup-token. See [/gateway/troubleshooting#oauth-token-refresh-failed-anthropic-claude-subscription](/gateway/troubleshooting#oauth-token-refresh-failed-anthropic-claude-subscription). - Auth details + reuse rules are in [/concepts/oauth](/concepts/oauth). ## Troubleshooting @@ -119,7 +115,7 @@ clawdbot onboard --auth-choice claude-cli - Re-run onboarding for that agent, or paste a setup-token / API key on the gateway host, then verify with `clawdbot models status`. -**No credentials found for profile `anthropic:default` or `anthropic:claude-cli`** +**No credentials found for profile `anthropic:default`** - Run `clawdbot models status` to see which auth profile is active. - Re-run onboarding, or paste a setup-token / API key for that profile. diff --git a/docs/providers/claude-max-api-proxy.md b/docs/providers/claude-max-api-proxy.md index 255be62fc..d2bb6cde8 100644 --- a/docs/providers/claude-max-api-proxy.md +++ b/docs/providers/claude-max-api-proxy.md @@ -141,5 +141,5 @@ launchctl bootstrap gui/$(id -u) ~/Library/LaunchAgents/com.claude-max-api.plist ## See Also -- [Anthropic provider](/providers/anthropic) - Native Clawdbot integration with Claude Code CLI OAuth +- [Anthropic provider](/providers/anthropic) - Native Clawdbot integration with Claude setup-token or API keys - [OpenAI provider](/providers/openai) - For OpenAI/Codex subscriptions diff --git a/docs/providers/openai.md b/docs/providers/openai.md index 442d7f3ae..c877d59ff 100644 --- a/docs/providers/openai.md +++ b/docs/providers/openai.md @@ -7,9 +7,7 @@ read_when: # OpenAI OpenAI provides developer APIs for GPT models. Codex supports **ChatGPT sign-in** for subscription -access or **API key** sign-in for usage-based access. Codex cloud requires ChatGPT sign-in, while -the Codex CLI supports either sign-in method. The Codex CLI caches login details in -`~/.codex/auth.json` (or your OS credential store), which Clawdbot can reuse. +access or **API key** sign-in for usage-based access. Codex cloud requires ChatGPT sign-in. ## Option A: OpenAI API key (OpenAI Platform) @@ -38,16 +36,14 @@ clawdbot onboard --openai-api-key "$OPENAI_API_KEY" **Best for:** using ChatGPT/Codex subscription access instead of an API key. Codex cloud requires ChatGPT sign-in, while the Codex CLI supports ChatGPT or API key sign-in. -Clawdbot can reuse your **Codex CLI** login (`~/.codex/auth.json`) or run the OAuth flow. - ### CLI setup ```bash -# Reuse existing Codex CLI login -clawdbot onboard --auth-choice codex-cli - -# Or run Codex OAuth in the wizard +# Run Codex OAuth in the wizard clawdbot onboard --auth-choice openai-codex + +# Or run OAuth directly +clawdbot models auth login --provider openai-codex ``` ### Config snippet diff --git a/docs/start/getting-started.md b/docs/start/getting-started.md index dd68b8f55..00bc00efb 100644 --- a/docs/start/getting-started.md +++ b/docs/start/getting-started.md @@ -9,6 +9,10 @@ read_when: Goal: go from **zero** → **first working chat** (with sane defaults) as quickly as possible. +Fastest chat: open the Control UI (no channel setup needed). Run `clawdbot dashboard` +and chat in the browser, or open `http://127.0.0.1:18789/` on the gateway host. +Docs: [Dashboard](/web/dashboard) and [Control UI](/web/control-ui). + Recommended path: use the **CLI onboarding wizard** (`clawdbot onboard`). It sets up: - model/auth (OAuth recommended) - gateway settings @@ -121,6 +125,7 @@ channels. If you use WhatsApp or Telegram, run the Gateway with **Node**. ```bash clawdbot status clawdbot health +clawdbot security audit --deep ``` ## 4) Pair + connect your first chat surface diff --git a/docs/start/setup.md b/docs/start/setup.md index 587b7fd6b..f4024a50d 100644 --- a/docs/start/setup.md +++ b/docs/start/setup.md @@ -104,6 +104,18 @@ clawdbot health - Sessions: `~/.clawdbot/agents//sessions/` - Logs: `/tmp/clawdbot/` +## Credential storage map + +Use this when debugging auth or deciding what to back up: + +- **WhatsApp**: `~/.clawdbot/credentials/whatsapp//creds.json` +- **Telegram bot token**: config/env or `channels.telegram.tokenFile` +- **Discord bot token**: config/env (token file not yet supported) +- **Slack tokens**: config/env (`channels.slack.*`) +- **Pairing allowlists**: `~/.clawdbot/credentials/-allowFrom.json` +- **Model auth profiles**: `~/.clawdbot/agents//agent/auth-profiles.json` +- **Legacy OAuth import**: `~/.clawdbot/credentials/oauth.json` + ## Updating (without wrecking your setup) - Keep `~/clawd` and `~/.clawdbot/` as “your stuff”; don’t put personal prompts/config into the `clawdbot` repo. diff --git a/docs/tools/skills.md b/docs/tools/skills.md index 289118bae..d9c840d73 100644 --- a/docs/tools/skills.md +++ b/docs/tools/skills.md @@ -64,6 +64,14 @@ By default, `clawdhub` installs into `./skills` under your current working directory (or falls back to the configured Clawdbot workspace). Clawdbot picks that up as `/skills` on the next session. +## Security notes + +- Treat third-party skills as **trusted code**. Read them before enabling. +- Prefer sandboxed runs for untrusted inputs and risky tools. See [Sandboxing](/gateway/sandboxing). +- `skills.entries.*.env` and `skills.entries.*.apiKey` inject secrets into the **host** process + for that agent turn (not the sandbox). Keep secrets out of prompts and logs. +- For a broader threat model and checklists, see [Security](/gateway/security). + ## Format (AgentSkills + Pi-compatible) `SKILL.md` must include at least: diff --git a/docs/tools/slash-commands.md b/docs/tools/slash-commands.md index 84a087dba..93b51d5ae 100644 --- a/docs/tools/slash-commands.md +++ b/docs/tools/slash-commands.md @@ -132,7 +132,7 @@ Examples: /model list /model 3 /model openai/gpt-5.2 -/model opus@anthropic:claude-cli +/model opus@anthropic:default /model status ``` diff --git a/docs/vps.md b/docs/vps.md index d57205922..192ab830e 100644 --- a/docs/vps.md +++ b/docs/vps.md @@ -1,5 +1,5 @@ --- -summary: "VPS hosting hub for Clawdbot (Fly/Hetzner/GCP/exe.dev)" +summary: "VPS hosting hub for Clawdbot (Oracle/Fly/Hetzner/GCP/exe.dev)" read_when: - You want to run the Gateway in the cloud - You need a quick map of VPS/hosting guides @@ -11,6 +11,7 @@ deployments work at a high level. ## Pick a provider +- **Oracle Cloud (Always Free)**: [Oracle](/platforms/oracle) — $0/month (Always Free, ARM; capacity/signup can be finicky) - **Fly.io**: [Fly.io](/platforms/fly) - **Hetzner (Docker)**: [Hetzner](/platforms/hetzner) - **GCP (Compute Engine)**: [GCP](/platforms/gcp) diff --git a/docs/web/dashboard.md b/docs/web/dashboard.md index 81d0aacc4..fdbf209be 100644 --- a/docs/web/dashboard.md +++ b/docs/web/dashboard.md @@ -19,6 +19,10 @@ Key references: Authentication is enforced at the WebSocket handshake via `connect.params.auth` (token or password). See `gateway.auth` in [Gateway configuration](/gateway/configuration). +Security note: the Control UI is an **admin surface** (chat, config, exec approvals). +Do not expose it publicly. The UI stores the token in `localStorage` after first load. +Prefer localhost, Tailscale Serve, or an SSH tunnel. + ## Fast path (recommended) - After onboarding, the CLI now auto-opens the dashboard with your token and prints the same tokenized link. diff --git a/extensions/twitch/CHANGELOG.md b/extensions/twitch/CHANGELOG.md new file mode 100644 index 000000000..9573d58ae --- /dev/null +++ b/extensions/twitch/CHANGELOG.md @@ -0,0 +1,21 @@ +# Changelog + +## 2026.1.23 + +### Features + +- Initial Twitch plugin release +- Twitch chat integration via @twurple (IRC connection) +- Multi-account support with per-channel configuration +- Access control via user ID allowlists and role-based restrictions +- Automatic token refresh with RefreshingAuthProvider +- Environment variable fallback for default account token +- Message actions support +- Status monitoring and probing +- Outbound message delivery with markdown stripping + +### Improvements + +- Added proper configuration schema with Zod validation +- Added plugin descriptor (clawdbot.plugin.json) +- Added comprehensive README and documentation diff --git a/extensions/twitch/README.md b/extensions/twitch/README.md new file mode 100644 index 000000000..2d3e4ceea --- /dev/null +++ b/extensions/twitch/README.md @@ -0,0 +1,89 @@ +# @clawdbot/twitch + +Twitch channel plugin for Clawdbot. + +## Install (local checkout) + +```bash +clawdbot plugins install ./extensions/twitch +``` + +## Install (npm) + +```bash +clawdbot plugins install @clawdbot/twitch +``` + +Onboarding: select Twitch and confirm the install prompt to fetch the plugin automatically. + +## Config + +Minimal config (simplified single-account): + +**⚠️ Important:** `requireMention` defaults to `true`. Add access control (`allowFrom` or `allowedRoles`) to prevent unauthorized users from triggering the bot. + +```json5 +{ + channels: { + twitch: { + enabled: true, + username: "clawdbot", + accessToken: "oauth:abc123...", // OAuth Access Token (add oauth: prefix) + clientId: "xyz789...", // Client ID from Token Generator + channel: "vevisk", // Channel to join (required) + allowFrom: ["123456789"], // (recommended) Your Twitch user ID only (Convert your twitch username to ID at https://www.streamweasels.com/tools/convert-twitch-username-%20to-user-id/) + }, + }, +} +``` + +**Access control options:** + +- `requireMention: false` - Disable the default mention requirement to respond to all messages +- `allowFrom: ["your_user_id"]` - Restrict to your Twitch user ID only (find your ID at https://www.twitchangles.com/xqc or similar) +- `allowedRoles: ["moderator", "vip", "subscriber"]` - Restrict to specific roles + +Multi-account config (advanced): + +```json5 +{ + channels: { + twitch: { + enabled: true, + accounts: { + default: { + username: "clawdbot", + accessToken: "oauth:abc123...", + clientId: "xyz789...", + channel: "vevisk", + }, + channel2: { + username: "clawdbot", + accessToken: "oauth:def456...", + clientId: "uvw012...", + channel: "secondchannel", + }, + }, + }, + }, +} +``` + +## Setup + +1. Create a dedicated Twitch account for the bot, then generate credentials: [Twitch Token Generator](https://twitchtokengenerator.com/) + - Select **Bot Token** + - Verify scopes `chat:read` and `chat:write` are selected + - Copy the **Access Token** to `token` property + - Copy the **Client ID** to `clientId` property +2. Start the gateway + +## Full documentation + +See https://docs.clawd.bot/channels/twitch for: + +- Token refresh setup +- Access control patterns +- Multi-account configuration +- Troubleshooting +- Capabilities & limits diff --git a/extensions/twitch/clawdbot.plugin.json b/extensions/twitch/clawdbot.plugin.json new file mode 100644 index 000000000..3e7d1ec26 --- /dev/null +++ b/extensions/twitch/clawdbot.plugin.json @@ -0,0 +1,9 @@ +{ + "id": "twitch", + "channels": ["twitch"], + "configSchema": { + "type": "object", + "additionalProperties": false, + "properties": {} + } +} diff --git a/extensions/twitch/index.ts b/extensions/twitch/index.ts new file mode 100644 index 000000000..25adc4705 --- /dev/null +++ b/extensions/twitch/index.ts @@ -0,0 +1,20 @@ +import type { ClawdbotPluginApi } from "clawdbot/plugin-sdk"; +import { emptyPluginConfigSchema } from "clawdbot/plugin-sdk"; + +import { twitchPlugin } from "./src/plugin.js"; +import { setTwitchRuntime } from "./src/runtime.js"; + +export { monitorTwitchProvider } from "./src/monitor.js"; + +const plugin = { + id: "twitch", + name: "Twitch", + description: "Twitch channel plugin", + configSchema: emptyPluginConfigSchema(), + register(api: ClawdbotPluginApi) { + setTwitchRuntime(api.runtime); + api.registerChannel({ plugin: twitchPlugin as any }); + }, +}; + +export default plugin; diff --git a/extensions/twitch/package.json b/extensions/twitch/package.json new file mode 100644 index 000000000..2c9dd2683 --- /dev/null +++ b/extensions/twitch/package.json @@ -0,0 +1,20 @@ +{ + "name": "@clawdbot/twitch", + "version": "2026.1.23", + "description": "Clawdbot Twitch channel plugin", + "type": "module", + "dependencies": { + "@twurple/api": "^8.0.3", + "@twurple/auth": "^8.0.3", + "@twurple/chat": "^8.0.3", + "zod": "^4.3.5" + }, + "devDependencies": { + "clawdbot": "workspace:*" + }, + "clawdbot": { + "extensions": [ + "./index.ts" + ] + } +} diff --git a/extensions/twitch/src/access-control.test.ts b/extensions/twitch/src/access-control.test.ts new file mode 100644 index 000000000..1200f72db --- /dev/null +++ b/extensions/twitch/src/access-control.test.ts @@ -0,0 +1,489 @@ +import { describe, expect, it } from "vitest"; +import { checkTwitchAccessControl, extractMentions } from "./access-control.js"; +import type { TwitchAccountConfig, TwitchChatMessage } from "./types.js"; + +describe("checkTwitchAccessControl", () => { + const mockAccount: TwitchAccountConfig = { + username: "testbot", + token: "oauth:test", + }; + + const mockMessage: TwitchChatMessage = { + username: "testuser", + userId: "123456", + message: "hello bot", + channel: "testchannel", + }; + + describe("when no restrictions are configured", () => { + it("allows messages that mention the bot (default requireMention)", () => { + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + }; + const result = checkTwitchAccessControl({ + message, + account: mockAccount, + botUsername: "testbot", + }); + expect(result.allowed).toBe(true); + }); + }); + + describe("requireMention default", () => { + it("defaults to true when undefined", () => { + const message: TwitchChatMessage = { + ...mockMessage, + message: "hello bot", + }; + + const result = checkTwitchAccessControl({ + message, + account: mockAccount, + botUsername: "testbot", + }); + expect(result.allowed).toBe(false); + expect(result.reason).toContain("does not mention the bot"); + }); + + it("allows mention when requireMention is undefined", () => { + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + }; + + const result = checkTwitchAccessControl({ + message, + account: mockAccount, + botUsername: "testbot", + }); + expect(result.allowed).toBe(true); + }); + }); + + describe("requireMention", () => { + it("allows messages that mention the bot", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + requireMention: true, + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(true); + }); + + it("blocks messages that don't mention the bot", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + requireMention: true, + }; + + const result = checkTwitchAccessControl({ + message: mockMessage, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(false); + expect(result.reason).toContain("does not mention the bot"); + }); + + it("is case-insensitive for bot username", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + requireMention: true, + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@TestBot hello", + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(true); + }); + }); + + describe("allowFrom allowlist", () => { + it("allows users in the allowlist", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + allowFrom: ["123456", "789012"], + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(true); + expect(result.matchKey).toBe("123456"); + expect(result.matchSource).toBe("allowlist"); + }); + + it("allows users not in allowlist via fallback (open access)", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + allowFrom: ["789012"], + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + // Falls through to final fallback since allowedRoles is not set + expect(result.allowed).toBe(true); + }); + + it("blocks messages without userId", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + allowFrom: ["123456"], + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + userId: undefined, + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(false); + expect(result.reason).toContain("user ID not available"); + }); + + it("bypasses role checks when user is in allowlist", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + allowFrom: ["123456"], + allowedRoles: ["owner"], + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + isOwner: false, + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(true); + }); + + it("allows user with role even if not in allowlist", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + allowFrom: ["789012"], + allowedRoles: ["moderator"], + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + userId: "123456", + isMod: true, + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(true); + expect(result.matchSource).toBe("role"); + }); + + it("blocks user with neither allowlist nor role", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + allowFrom: ["789012"], + allowedRoles: ["moderator"], + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + userId: "123456", + isMod: false, + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(false); + expect(result.reason).toContain("does not have any of the required roles"); + }); + }); + + describe("allowedRoles", () => { + it("allows users with matching role", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + allowedRoles: ["moderator"], + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + isMod: true, + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(true); + expect(result.matchSource).toBe("role"); + }); + + it("allows users with any of multiple roles", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + allowedRoles: ["moderator", "vip", "subscriber"], + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + isVip: true, + isMod: false, + isSub: false, + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(true); + }); + + it("blocks users without matching role", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + allowedRoles: ["moderator"], + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + isMod: false, + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(false); + expect(result.reason).toContain("does not have any of the required roles"); + }); + + it("allows all users when role is 'all'", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + allowedRoles: ["all"], + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(true); + expect(result.matchKey).toBe("all"); + }); + + it("handles moderator role", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + allowedRoles: ["moderator"], + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + isMod: true, + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(true); + }); + + it("handles subscriber role", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + allowedRoles: ["subscriber"], + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + isSub: true, + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(true); + }); + + it("handles owner role", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + allowedRoles: ["owner"], + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + isOwner: true, + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(true); + }); + + it("handles vip role", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + allowedRoles: ["vip"], + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + isVip: true, + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(true); + }); + }); + + describe("combined restrictions", () => { + it("checks requireMention before allowlist", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + requireMention: true, + allowFrom: ["123456"], + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "hello", // No mention + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(false); + expect(result.reason).toContain("does not mention the bot"); + }); + + it("checks allowlist before allowedRoles", () => { + const account: TwitchAccountConfig = { + ...mockAccount, + allowFrom: ["123456"], + allowedRoles: ["owner"], + }; + const message: TwitchChatMessage = { + ...mockMessage, + message: "@testbot hello", + isOwner: false, + }; + + const result = checkTwitchAccessControl({ + message, + account, + botUsername: "testbot", + }); + expect(result.allowed).toBe(true); + expect(result.matchSource).toBe("allowlist"); + }); + }); +}); + +describe("extractMentions", () => { + it("extracts single mention", () => { + const mentions = extractMentions("hello @testbot"); + expect(mentions).toEqual(["testbot"]); + }); + + it("extracts multiple mentions", () => { + const mentions = extractMentions("hello @testbot and @otheruser"); + expect(mentions).toEqual(["testbot", "otheruser"]); + }); + + it("returns empty array when no mentions", () => { + const mentions = extractMentions("hello everyone"); + expect(mentions).toEqual([]); + }); + + it("handles mentions at start of message", () => { + const mentions = extractMentions("@testbot hello"); + expect(mentions).toEqual(["testbot"]); + }); + + it("handles mentions at end of message", () => { + const mentions = extractMentions("hello @testbot"); + expect(mentions).toEqual(["testbot"]); + }); + + it("converts mentions to lowercase", () => { + const mentions = extractMentions("hello @TestBot"); + expect(mentions).toEqual(["testbot"]); + }); + + it("extracts alphanumeric usernames", () => { + const mentions = extractMentions("hello @user123"); + expect(mentions).toEqual(["user123"]); + }); + + it("handles underscores in usernames", () => { + const mentions = extractMentions("hello @test_user"); + expect(mentions).toEqual(["test_user"]); + }); + + it("handles empty string", () => { + const mentions = extractMentions(""); + expect(mentions).toEqual([]); + }); +}); diff --git a/extensions/twitch/src/access-control.ts b/extensions/twitch/src/access-control.ts new file mode 100644 index 000000000..0ce86d78b --- /dev/null +++ b/extensions/twitch/src/access-control.ts @@ -0,0 +1,154 @@ +import type { TwitchAccountConfig, TwitchChatMessage } from "./types.js"; + +/** + * Result of checking access control for a Twitch message + */ +export type TwitchAccessControlResult = { + allowed: boolean; + reason?: string; + matchKey?: string; + matchSource?: string; +}; + +/** + * Check if a Twitch message should be allowed based on account configuration + * + * This function implements the access control logic for incoming Twitch messages, + * checking allowlists, role-based restrictions, and mention requirements. + * + * Priority order: + * 1. If `requireMention` is true, message must mention the bot + * 2. If `allowFrom` is set, sender must be in the allowlist (by user ID) + * 3. If `allowedRoles` is set, sender must have at least one of the specified roles + * + * Note: You can combine `allowFrom` with `allowedRoles`. If a user is in `allowFrom`, + * they bypass role checks. This is useful for allowing specific users regardless of role. + * + * Available roles: + * - "moderator": Moderators + * - "owner": Channel owner/broadcaster + * - "vip": VIPs + * - "subscriber": Subscribers + * - "all": Anyone in the chat + */ +export function checkTwitchAccessControl(params: { + message: TwitchChatMessage; + account: TwitchAccountConfig; + botUsername: string; +}): TwitchAccessControlResult { + const { message, account, botUsername } = params; + + if (account.requireMention ?? true) { + const mentions = extractMentions(message.message); + if (!mentions.includes(botUsername.toLowerCase())) { + return { + allowed: false, + reason: "message does not mention the bot (requireMention is enabled)", + }; + } + } + + if (account.allowFrom && account.allowFrom.length > 0) { + const allowFrom = account.allowFrom; + const senderId = message.userId; + + if (!senderId) { + return { + allowed: false, + reason: "sender user ID not available for allowlist check", + }; + } + + if (allowFrom.includes(senderId)) { + return { + allowed: true, + matchKey: senderId, + matchSource: "allowlist", + }; + } + } + + if (account.allowedRoles && account.allowedRoles.length > 0) { + const allowedRoles = account.allowedRoles; + + // "all" grants access to everyone + if (allowedRoles.includes("all")) { + return { + allowed: true, + matchKey: "all", + matchSource: "role", + }; + } + + const hasAllowedRole = checkSenderRoles({ + message, + allowedRoles, + }); + + if (!hasAllowedRole) { + return { + allowed: false, + reason: `sender does not have any of the required roles: ${allowedRoles.join(", ")}`, + }; + } + + return { + allowed: true, + matchKey: allowedRoles.join(","), + matchSource: "role", + }; + } + + return { + allowed: true, + }; +} + +/** + * Check if the sender has any of the allowed roles + */ +function checkSenderRoles(params: { message: TwitchChatMessage; allowedRoles: string[] }): boolean { + const { message, allowedRoles } = params; + const { isMod, isOwner, isVip, isSub } = message; + + for (const role of allowedRoles) { + switch (role) { + case "moderator": + if (isMod) return true; + break; + case "owner": + if (isOwner) return true; + break; + case "vip": + if (isVip) return true; + break; + case "subscriber": + if (isSub) return true; + break; + } + } + + return false; +} + +/** + * Extract @mentions from a Twitch chat message + * + * Returns a list of lowercase usernames that were mentioned in the message. + * Twitch mentions are in the format @username. + */ +export function extractMentions(message: string): string[] { + const mentionRegex = /@(\w+)/g; + const mentions: string[] = []; + let match: RegExpExecArray | null; + + // biome-ignore lint/suspicious/noAssignInExpressions: Standard regex iteration pattern + while ((match = mentionRegex.exec(message)) !== null) { + const username = match[1]; + if (username) { + mentions.push(username.toLowerCase()); + } + } + + return mentions; +} diff --git a/extensions/twitch/src/actions.ts b/extensions/twitch/src/actions.ts new file mode 100644 index 000000000..9e7ade194 --- /dev/null +++ b/extensions/twitch/src/actions.ts @@ -0,0 +1,173 @@ +/** + * Twitch message actions adapter. + * + * Handles tool-based actions for Twitch, such as sending messages. + */ + +import { DEFAULT_ACCOUNT_ID, getAccountConfig } from "./config.js"; +import { twitchOutbound } from "./outbound.js"; +import type { ChannelMessageActionAdapter, ChannelMessageActionContext } from "./types.js"; + +/** + * Create a tool result with error content. + */ +function errorResponse(error: string) { + return { + content: [ + { + type: "text", + text: JSON.stringify({ ok: false, error }), + }, + ], + details: { ok: false }, + }; +} + +/** + * Read a string parameter from action arguments. + * + * @param args - Action arguments + * @param key - Parameter key + * @param options - Options for reading the parameter + * @returns The parameter value or undefined if not found + */ +function readStringParam( + args: Record, + key: string, + options: { required?: boolean; trim?: boolean } = {}, +): string | undefined { + const value = args[key]; + if (value === undefined || value === null) { + if (options.required) { + throw new Error(`Missing required parameter: ${key}`); + } + return undefined; + } + + // Convert value to string safely + if (typeof value === "string") { + return options.trim !== false ? value.trim() : value; + } + + if (typeof value === "number" || typeof value === "boolean") { + const str = String(value); + return options.trim !== false ? str.trim() : str; + } + + throw new Error(`Parameter ${key} must be a string, number, or boolean`); +} + +/** Supported Twitch actions */ +const TWITCH_ACTIONS = new Set(["send" as const]); +type TwitchAction = typeof TWITCH_ACTIONS extends Set ? U : never; + +/** + * Twitch message actions adapter. + */ +export const twitchMessageActions: ChannelMessageActionAdapter = { + /** + * List available actions for this channel. + */ + listActions: () => [...TWITCH_ACTIONS], + + /** + * Check if an action is supported. + */ + supportsAction: ({ action }) => TWITCH_ACTIONS.has(action as TwitchAction), + + /** + * Extract tool send parameters from action arguments. + * + * Parses and validates the "to" and "message" parameters for sending. + * + * @param params - Arguments from the tool call + * @returns Parsed send parameters or null if invalid + * + * @example + * const result = twitchMessageActions.extractToolSend!({ + * args: { to: "#mychannel", message: "Hello!" } + * }); + * // Returns: { to: "#mychannel", message: "Hello!" } + */ + extractToolSend: ({ args }) => { + try { + const to = readStringParam(args, "to", { required: true }); + const message = readStringParam(args, "message", { required: true }); + + if (!to || !message) { + return null; + } + + return { to, message }; + } catch { + return null; + } + }, + + /** + * Handle an action execution. + * + * Processes the "send" action to send messages to Twitch. + * + * @param ctx - Action context including action type, parameters, and config + * @returns Tool result with content or null if action not supported + * + * @example + * const result = await twitchMessageActions.handleAction!({ + * action: "send", + * params: { message: "Hello Twitch!", to: "#mychannel" }, + * cfg: clawdbotConfig, + * accountId: "default", + * }); + */ + handleAction: async ( + ctx: ChannelMessageActionContext, + ): Promise<{ content: Array<{ type: string; text: string }> } | null> => { + if (ctx.action !== "send") { + return null; + } + + const message = readStringParam(ctx.params, "message", { required: true }); + const to = readStringParam(ctx.params, "to", { required: false }); + const accountId = ctx.accountId ?? DEFAULT_ACCOUNT_ID; + + const account = getAccountConfig(ctx.cfg, accountId); + if (!account) { + return errorResponse( + `Account not found: ${accountId}. Available accounts: ${Object.keys(ctx.cfg.channels?.twitch?.accounts ?? {}).join(", ") || "none"}`, + ); + } + + // Use the channel from account config (or override with `to` parameter) + const targetChannel = to || account.channel; + if (!targetChannel) { + return errorResponse("No channel specified and no default channel in account config"); + } + + if (!twitchOutbound.sendText) { + return errorResponse("sendText not implemented"); + } + + try { + const result = await twitchOutbound.sendText({ + cfg: ctx.cfg, + to: targetChannel, + text: message ?? "", + accountId, + }); + + return { + content: [ + { + type: "text", + text: JSON.stringify(result), + }, + ], + details: { ok: true }, + }; + } catch (error) { + const errorMsg = error instanceof Error ? error.message : String(error); + return errorResponse(errorMsg); + } + }, +}; diff --git a/extensions/twitch/src/client-manager-registry.ts b/extensions/twitch/src/client-manager-registry.ts new file mode 100644 index 000000000..1b7ae23f2 --- /dev/null +++ b/extensions/twitch/src/client-manager-registry.ts @@ -0,0 +1,115 @@ +/** + * Client manager registry for Twitch plugin. + * + * Manages the lifecycle of TwitchClientManager instances across the plugin, + * ensuring proper cleanup when accounts are stopped or reconfigured. + */ + +import { TwitchClientManager } from "./twitch-client.js"; +import type { ChannelLogSink } from "./types.js"; + +/** + * Registry entry tracking a client manager and its associated account. + */ +type RegistryEntry = { + /** The client manager instance */ + manager: TwitchClientManager; + /** The account ID this manager is for */ + accountId: string; + /** Logger for this entry */ + logger: ChannelLogSink; + /** When this entry was created */ + createdAt: number; +}; + +/** + * Global registry of client managers. + * Keyed by account ID. + */ +const registry = new Map(); + +/** + * Get or create a client manager for an account. + * + * @param accountId - The account ID + * @param logger - Logger instance + * @returns The client manager + */ +export function getOrCreateClientManager( + accountId: string, + logger: ChannelLogSink, +): TwitchClientManager { + const existing = registry.get(accountId); + if (existing) { + return existing.manager; + } + + const manager = new TwitchClientManager(logger); + registry.set(accountId, { + manager, + accountId, + logger, + createdAt: Date.now(), + }); + + logger.info(`Registered client manager for account: ${accountId}`); + return manager; +} + +/** + * Get an existing client manager for an account. + * + * @param accountId - The account ID + * @returns The client manager, or undefined if not registered + */ +export function getClientManager(accountId: string): TwitchClientManager | undefined { + return registry.get(accountId)?.manager; +} + +/** + * Disconnect and remove a client manager from the registry. + * + * @param accountId - The account ID + * @returns Promise that resolves when cleanup is complete + */ +export async function removeClientManager(accountId: string): Promise { + const entry = registry.get(accountId); + if (!entry) { + return; + } + + // Disconnect the client manager + await entry.manager.disconnectAll(); + + // Remove from registry + registry.delete(accountId); + entry.logger.info(`Unregistered client manager for account: ${accountId}`); +} + +/** + * Disconnect and remove all client managers from the registry. + * + * @returns Promise that resolves when all cleanup is complete + */ +export async function removeAllClientManagers(): Promise { + const promises = [...registry.keys()].map((accountId) => removeClientManager(accountId)); + await Promise.all(promises); +} + +/** + * Get the number of registered client managers. + * + * @returns The count of registered managers + */ +export function getRegisteredClientManagerCount(): number { + return registry.size; +} + +/** + * Clear all client managers without disconnecting. + * + * This is primarily for testing purposes. + */ +export function _clearAllClientManagersForTest(): void { + registry.clear(); +} diff --git a/extensions/twitch/src/config-schema.ts b/extensions/twitch/src/config-schema.ts new file mode 100644 index 000000000..f4d8500c7 --- /dev/null +++ b/extensions/twitch/src/config-schema.ts @@ -0,0 +1,82 @@ +import { MarkdownConfigSchema } from "clawdbot/plugin-sdk"; +import { z } from "zod"; + +/** + * Twitch user roles that can be allowed to interact with the bot + */ +const TwitchRoleSchema = z.enum(["moderator", "owner", "vip", "subscriber", "all"]); + +/** + * Twitch account configuration schema + */ +const TwitchAccountSchema = z.object({ + /** Twitch username */ + username: z.string(), + /** Twitch OAuth access token (requires chat:read and chat:write scopes) */ + accessToken: z.string(), + /** Twitch client ID (from Twitch Developer Portal or twitchtokengenerator.com) */ + clientId: z.string().optional(), + /** Channel name to join */ + channel: z.string().min(1), + /** Enable this account */ + enabled: z.boolean().optional(), + /** Allowlist of Twitch user IDs who can interact with the bot (use IDs for safety, not usernames) */ + allowFrom: z.array(z.string()).optional(), + /** Roles allowed to interact with the bot (e.g., ["moderator", "vip", "subscriber"]) */ + allowedRoles: z.array(TwitchRoleSchema).optional(), + /** Require @mention to trigger bot responses */ + requireMention: z.boolean().optional(), + /** Twitch client secret (required for token refresh via RefreshingAuthProvider) */ + clientSecret: z.string().optional(), + /** Refresh token (required for automatic token refresh) */ + refreshToken: z.string().optional(), + /** Token expiry time in seconds (optional, for token refresh tracking) */ + expiresIn: z.number().nullable().optional(), + /** Timestamp when token was obtained (optional, for token refresh tracking) */ + obtainmentTimestamp: z.number().optional(), +}); + +/** + * Base configuration properties shared by both single and multi-account modes + */ +const TwitchConfigBaseSchema = z.object({ + name: z.string().optional(), + enabled: z.boolean().optional(), + markdown: MarkdownConfigSchema.optional(), +}); + +/** + * Simplified single-account configuration schema + * + * Use this for single-account setups. Properties are at the top level, + * creating an implicit "default" account. + */ +const SimplifiedSchema = z.intersection(TwitchConfigBaseSchema, TwitchAccountSchema); + +/** + * Multi-account configuration schema + * + * Use this for multi-account setups. Each key is an account ID (e.g., "default", "secondary"). + */ +const MultiAccountSchema = z.intersection( + TwitchConfigBaseSchema, + z + .object({ + /** Per-account configuration (for multi-account setups) */ + accounts: z.record(z.string(), TwitchAccountSchema), + }) + .refine((val) => Object.keys(val.accounts || {}).length > 0, { + message: "accounts must contain at least one entry", + }), +); + +/** + * Twitch plugin configuration schema + * + * Supports two mutually exclusive patterns: + * 1. Simplified single-account: username, accessToken, clientId, channel at top level + * 2. Multi-account: accounts object with named account configs + * + * The union ensures clear discrimination between the two modes. + */ +export const TwitchConfigSchema = z.union([SimplifiedSchema, MultiAccountSchema]); diff --git a/extensions/twitch/src/config.test.ts b/extensions/twitch/src/config.test.ts new file mode 100644 index 000000000..cdef1c4c8 --- /dev/null +++ b/extensions/twitch/src/config.test.ts @@ -0,0 +1,88 @@ +import { describe, expect, it } from "vitest"; + +import { getAccountConfig } from "./config.js"; + +describe("getAccountConfig", () => { + const mockMultiAccountConfig = { + channels: { + twitch: { + accounts: { + default: { + username: "testbot", + accessToken: "oauth:test123", + }, + secondary: { + username: "secondbot", + accessToken: "oauth:secondary", + }, + }, + }, + }, + }; + + const mockSimplifiedConfig = { + channels: { + twitch: { + username: "testbot", + accessToken: "oauth:test123", + }, + }, + }; + + it("returns account config for valid account ID (multi-account)", () => { + const result = getAccountConfig(mockMultiAccountConfig, "default"); + + expect(result).not.toBeNull(); + expect(result?.username).toBe("testbot"); + }); + + it("returns account config for default account (simplified config)", () => { + const result = getAccountConfig(mockSimplifiedConfig, "default"); + + expect(result).not.toBeNull(); + expect(result?.username).toBe("testbot"); + }); + + it("returns non-default account from multi-account config", () => { + const result = getAccountConfig(mockMultiAccountConfig, "secondary"); + + expect(result).not.toBeNull(); + expect(result?.username).toBe("secondbot"); + }); + + it("returns null for non-existent account ID", () => { + const result = getAccountConfig(mockMultiAccountConfig, "nonexistent"); + + expect(result).toBeNull(); + }); + + it("returns null when core config is null", () => { + const result = getAccountConfig(null, "default"); + + expect(result).toBeNull(); + }); + + it("returns null when core config is undefined", () => { + const result = getAccountConfig(undefined, "default"); + + expect(result).toBeNull(); + }); + + it("returns null when channels are not defined", () => { + const result = getAccountConfig({}, "default"); + + expect(result).toBeNull(); + }); + + it("returns null when twitch is not defined", () => { + const result = getAccountConfig({ channels: {} }, "default"); + + expect(result).toBeNull(); + }); + + it("returns null when accounts are not defined", () => { + const result = getAccountConfig({ channels: { twitch: {} } }, "default"); + + expect(result).toBeNull(); + }); +}); diff --git a/extensions/twitch/src/config.ts b/extensions/twitch/src/config.ts new file mode 100644 index 000000000..b4c5d54ca --- /dev/null +++ b/extensions/twitch/src/config.ts @@ -0,0 +1,116 @@ +import type { ClawdbotConfig } from "clawdbot/plugin-sdk"; +import type { TwitchAccountConfig } from "./types.js"; + +/** + * Default account ID for Twitch + */ +export const DEFAULT_ACCOUNT_ID = "default"; + +/** + * Get account config from core config + * + * Handles two patterns: + * 1. Simplified single-account: base-level properties create implicit "default" account + * 2. Multi-account: explicit accounts object + * + * For "default" account, base-level properties take precedence over accounts.default + * For other accounts, only the accounts object is checked + */ +export function getAccountConfig( + coreConfig: unknown, + accountId: string, +): TwitchAccountConfig | null { + if (!coreConfig || typeof coreConfig !== "object") { + return null; + } + + const cfg = coreConfig as ClawdbotConfig; + const twitch = cfg.channels?.twitch; + // Access accounts via unknown to handle union type (single-account vs multi-account) + const twitchRaw = twitch as Record | undefined; + const accounts = twitchRaw?.accounts as Record | undefined; + + // For default account, check base-level config first + if (accountId === DEFAULT_ACCOUNT_ID) { + const accountFromAccounts = accounts?.[DEFAULT_ACCOUNT_ID]; + + // Base-level properties that can form an implicit default account + const baseLevel = { + username: typeof twitchRaw?.username === "string" ? twitchRaw.username : undefined, + accessToken: typeof twitchRaw?.accessToken === "string" ? twitchRaw.accessToken : undefined, + clientId: typeof twitchRaw?.clientId === "string" ? twitchRaw.clientId : undefined, + channel: typeof twitchRaw?.channel === "string" ? twitchRaw.channel : undefined, + enabled: typeof twitchRaw?.enabled === "boolean" ? twitchRaw.enabled : undefined, + allowFrom: Array.isArray(twitchRaw?.allowFrom) ? twitchRaw.allowFrom : undefined, + allowedRoles: Array.isArray(twitchRaw?.allowedRoles) ? twitchRaw.allowedRoles : undefined, + requireMention: + typeof twitchRaw?.requireMention === "boolean" ? twitchRaw.requireMention : undefined, + clientSecret: + typeof twitchRaw?.clientSecret === "string" ? twitchRaw.clientSecret : undefined, + refreshToken: + typeof twitchRaw?.refreshToken === "string" ? twitchRaw.refreshToken : undefined, + expiresIn: typeof twitchRaw?.expiresIn === "number" ? twitchRaw.expiresIn : undefined, + obtainmentTimestamp: + typeof twitchRaw?.obtainmentTimestamp === "number" + ? twitchRaw.obtainmentTimestamp + : undefined, + }; + + // Merge: base-level takes precedence over accounts.default + const merged: Partial = { + ...accountFromAccounts, + ...baseLevel, + } as Partial; + + // Only return if we have at least username + if (merged.username) { + return merged as TwitchAccountConfig; + } + + // Fall through to accounts.default if no base-level username + if (accountFromAccounts) { + return accountFromAccounts; + } + + return null; + } + + // For non-default accounts, only check accounts object + if (!accounts || !accounts[accountId]) { + return null; + } + + return accounts[accountId] as TwitchAccountConfig | null; +} + +/** + * List all configured account IDs + * + * Includes both explicit accounts and implicit "default" from base-level config + */ +export function listAccountIds(cfg: ClawdbotConfig): string[] { + const twitch = cfg.channels?.twitch; + // Access accounts via unknown to handle union type (single-account vs multi-account) + const twitchRaw = twitch as Record | undefined; + const accountMap = twitchRaw?.accounts as Record | undefined; + + const ids: string[] = []; + + // Add explicit accounts + if (accountMap) { + ids.push(...Object.keys(accountMap)); + } + + // Add implicit "default" if base-level config exists and "default" not already present + const hasBaseLevelConfig = + twitchRaw && + (typeof twitchRaw.username === "string" || + typeof twitchRaw.accessToken === "string" || + typeof twitchRaw.channel === "string"); + + if (hasBaseLevelConfig && !ids.includes(DEFAULT_ACCOUNT_ID)) { + ids.push(DEFAULT_ACCOUNT_ID); + } + + return ids; +} diff --git a/extensions/twitch/src/monitor.ts b/extensions/twitch/src/monitor.ts new file mode 100644 index 000000000..f5f00b3fb --- /dev/null +++ b/extensions/twitch/src/monitor.ts @@ -0,0 +1,257 @@ +/** + * Twitch message monitor - processes incoming messages and routes to agents. + * + * This monitor connects to the Twitch client manager, processes incoming messages, + * resolves agent routes, and handles replies. + */ + +import type { ReplyPayload, ClawdbotConfig } from "clawdbot/plugin-sdk"; +import type { TwitchAccountConfig, TwitchChatMessage } from "./types.js"; +import { checkTwitchAccessControl } from "./access-control.js"; +import { getTwitchRuntime } from "./runtime.js"; +import { getOrCreateClientManager } from "./client-manager-registry.js"; +import { stripMarkdownForTwitch } from "./utils/markdown.js"; + +export type TwitchRuntimeEnv = { + log?: (message: string) => void; + error?: (message: string) => void; +}; + +export type TwitchMonitorOptions = { + account: TwitchAccountConfig; + accountId: string; + config: unknown; // ClawdbotConfig + runtime: TwitchRuntimeEnv; + abortSignal: AbortSignal; + statusSink?: (patch: { lastInboundAt?: number; lastOutboundAt?: number }) => void; +}; + +export type TwitchMonitorResult = { + stop: () => void; +}; + +type TwitchCoreRuntime = ReturnType; + +/** + * Process an incoming Twitch message and dispatch to agent. + */ +async function processTwitchMessage(params: { + message: TwitchChatMessage; + account: TwitchAccountConfig; + accountId: string; + config: unknown; + runtime: TwitchRuntimeEnv; + core: TwitchCoreRuntime; + statusSink?: (patch: { lastInboundAt?: number; lastOutboundAt?: number }) => void; +}): Promise { + const { message, account, accountId, config, runtime, core, statusSink } = params; + const cfg = config as ClawdbotConfig; + + const route = core.channel.routing.resolveAgentRoute({ + cfg, + channel: "twitch", + accountId, + peer: { + kind: "group", // Twitch chat is always group-like + id: message.channel, + }, + }); + + const rawBody = message.message; + const body = core.channel.reply.formatAgentEnvelope({ + channel: "Twitch", + from: message.displayName ?? message.username, + timestamp: message.timestamp?.getTime(), + envelope: core.channel.reply.resolveEnvelopeFormatOptions(cfg), + body: rawBody, + }); + + const ctxPayload = core.channel.reply.finalizeInboundContext({ + Body: body, + RawBody: rawBody, + CommandBody: rawBody, + From: `twitch:user:${message.userId}`, + To: `twitch:channel:${message.channel}`, + SessionKey: route.sessionKey, + AccountId: route.accountId, + ChatType: "group", + ConversationLabel: message.channel, + SenderName: message.displayName ?? message.username, + SenderId: message.userId, + SenderUsername: message.username, + Provider: "twitch", + Surface: "twitch", + MessageSid: message.id, + OriginatingChannel: "twitch", + OriginatingTo: `twitch:channel:${message.channel}`, + }); + + const storePath = core.channel.session.resolveStorePath(cfg.session?.store, { + agentId: route.agentId, + }); + await core.channel.session.recordInboundSession({ + storePath, + sessionKey: ctxPayload.SessionKey ?? route.sessionKey, + ctx: ctxPayload, + onRecordError: (err) => { + runtime.error?.(`Failed updating session meta: ${String(err)}`); + }, + }); + + const tableMode = core.channel.text.resolveMarkdownTableMode({ + cfg, + channel: "twitch", + accountId, + }); + + await core.channel.reply.dispatchReplyWithBufferedBlockDispatcher({ + ctx: ctxPayload, + cfg, + dispatcherOptions: { + deliver: async (payload) => { + await deliverTwitchReply({ + payload, + channel: message.channel, + account, + accountId, + config, + tableMode, + runtime, + statusSink, + }); + }, + }, + }); +} + +/** + * Deliver a reply to Twitch chat. + */ +async function deliverTwitchReply(params: { + payload: ReplyPayload; + channel: string; + account: TwitchAccountConfig; + accountId: string; + config: unknown; + tableMode: "off" | "plain" | "markdown" | "bullets" | "code"; + runtime: TwitchRuntimeEnv; + statusSink?: (patch: { lastInboundAt?: number; lastOutboundAt?: number }) => void; +}): Promise { + const { payload, channel, account, accountId, config, tableMode, runtime, statusSink } = params; + + try { + const clientManager = getOrCreateClientManager(accountId, { + info: (msg) => runtime.log?.(msg), + warn: (msg) => runtime.log?.(msg), + error: (msg) => runtime.error?.(msg), + debug: (msg) => runtime.log?.(msg), + }); + + const client = await clientManager.getClient( + account, + config as Parameters[1], + accountId, + ); + if (!client) { + runtime.error?.(`No client available for sending reply`); + return; + } + + // Send the reply + if (!payload.text) { + runtime.error?.(`No text to send in reply payload`); + return; + } + + const textToSend = stripMarkdownForTwitch(payload.text); + + await client.say(channel, textToSend); + statusSink?.({ lastOutboundAt: Date.now() }); + } catch (err) { + runtime.error?.(`Failed to send reply: ${String(err)}`); + } +} + +/** + * Main monitor provider for Twitch. + * + * Sets up message handlers and processes incoming messages. + */ +export async function monitorTwitchProvider( + options: TwitchMonitorOptions, +): Promise { + const { account, accountId, config, runtime, abortSignal, statusSink } = options; + + const core = getTwitchRuntime(); + let stopped = false; + + const coreLogger = core.logging.getChildLogger({ module: "twitch" }); + const logVerboseMessage = (message: string) => { + if (!core.logging.shouldLogVerbose()) return; + coreLogger.debug?.(message); + }; + const logger = { + info: (msg: string) => coreLogger.info(msg), + warn: (msg: string) => coreLogger.warn(msg), + error: (msg: string) => coreLogger.error(msg), + debug: logVerboseMessage, + }; + + const clientManager = getOrCreateClientManager(accountId, logger); + + try { + await clientManager.getClient( + account, + config as Parameters[1], + accountId, + ); + } catch (error) { + const errorMsg = error instanceof Error ? error.message : String(error); + runtime.error?.(`Failed to connect: ${errorMsg}`); + throw error; + } + + const unregisterHandler = clientManager.onMessage(account, (message) => { + if (stopped) return; + + // Access control check + const botUsername = account.username.toLowerCase(); + if (message.username.toLowerCase() === botUsername) { + return; // Ignore own messages + } + + const access = checkTwitchAccessControl({ + message, + account, + botUsername, + }); + + if (!access.allowed) { + return; + } + + statusSink?.({ lastInboundAt: Date.now() }); + + // Fire-and-forget: process message without blocking + void processTwitchMessage({ + message, + account, + accountId, + config, + runtime, + core, + statusSink, + }).catch((err) => { + runtime.error?.(`Message processing failed: ${String(err)}`); + }); + }); + + const stop = () => { + stopped = true; + unregisterHandler(); + }; + + abortSignal.addEventListener("abort", stop, { once: true }); + + return { stop }; +} diff --git a/extensions/twitch/src/onboarding.test.ts b/extensions/twitch/src/onboarding.test.ts new file mode 100644 index 000000000..492845bc1 --- /dev/null +++ b/extensions/twitch/src/onboarding.test.ts @@ -0,0 +1,311 @@ +/** + * Tests for onboarding.ts helpers + * + * Tests cover: + * - promptToken helper + * - promptUsername helper + * - promptClientId helper + * - promptChannelName helper + * - promptRefreshTokenSetup helper + * - configureWithEnvToken helper + * - setTwitchAccount config updates + */ + +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; +import type { WizardPrompter } from "clawdbot/plugin-sdk"; +import type { TwitchAccountConfig } from "./types.js"; + +// Mock the helpers we're testing +const mockPromptText = vi.fn(); +const mockPromptConfirm = vi.fn(); +const mockPrompter: WizardPrompter = { + text: mockPromptText, + confirm: mockPromptConfirm, +} as unknown as WizardPrompter; + +const mockAccount: TwitchAccountConfig = { + username: "testbot", + accessToken: "oauth:test123", + clientId: "test-client-id", + channel: "#testchannel", +}; + +describe("onboarding helpers", () => { + beforeEach(() => { + vi.clearAllMocks(); + }); + + afterEach(() => { + // Don't restoreAllMocks as it breaks module-level mocks + }); + + describe("promptToken", () => { + it("should return existing token when user confirms to keep it", async () => { + const { promptToken } = await import("./onboarding.js"); + + mockPromptConfirm.mockResolvedValue(true); + + const result = await promptToken(mockPrompter, mockAccount, undefined); + + expect(result).toBe("oauth:test123"); + expect(mockPromptConfirm).toHaveBeenCalledWith({ + message: "Access token already configured. Keep it?", + initialValue: true, + }); + expect(mockPromptText).not.toHaveBeenCalled(); + }); + + it("should prompt for new token when user doesn't keep existing", async () => { + const { promptToken } = await import("./onboarding.js"); + + mockPromptConfirm.mockResolvedValue(false); + mockPromptText.mockResolvedValue("oauth:newtoken123"); + + const result = await promptToken(mockPrompter, mockAccount, undefined); + + expect(result).toBe("oauth:newtoken123"); + expect(mockPromptText).toHaveBeenCalledWith({ + message: "Twitch OAuth token (oauth:...)", + initialValue: "", + validate: expect.any(Function), + }); + }); + + it("should use env token as initial value when provided", async () => { + const { promptToken } = await import("./onboarding.js"); + + mockPromptConfirm.mockResolvedValue(false); + mockPromptText.mockResolvedValue("oauth:fromenv"); + + await promptToken(mockPrompter, null, "oauth:fromenv"); + + expect(mockPromptText).toHaveBeenCalledWith( + expect.objectContaining({ + initialValue: "oauth:fromenv", + }), + ); + }); + + it("should validate token format", async () => { + const { promptToken } = await import("./onboarding.js"); + + // Set up mocks - user doesn't want to keep existing token + mockPromptConfirm.mockResolvedValueOnce(false); + + // Track how many times promptText is called + let promptTextCallCount = 0; + let capturedValidate: ((value: string) => string | undefined) | undefined; + + mockPromptText.mockImplementationOnce((_args) => { + promptTextCallCount++; + // Capture the validate function from the first argument + if (_args?.validate) { + capturedValidate = _args.validate; + } + return Promise.resolve("oauth:test123"); + }); + + // Call promptToken + const result = await promptToken(mockPrompter, mockAccount, undefined); + + // Verify promptText was called + expect(promptTextCallCount).toBe(1); + expect(result).toBe("oauth:test123"); + + // Test the validate function + expect(capturedValidate).toBeDefined(); + expect(capturedValidate!("")).toBe("Required"); + expect(capturedValidate!("notoauth")).toBe("Token should start with 'oauth:'"); + }); + + it("should return early when no existing token and no env token", async () => { + const { promptToken } = await import("./onboarding.js"); + + mockPromptText.mockResolvedValue("oauth:newtoken"); + + const result = await promptToken(mockPrompter, null, undefined); + + expect(result).toBe("oauth:newtoken"); + expect(mockPromptConfirm).not.toHaveBeenCalled(); + }); + }); + + describe("promptUsername", () => { + it("should prompt for username with validation", async () => { + const { promptUsername } = await import("./onboarding.js"); + + mockPromptText.mockResolvedValue("mybot"); + + const result = await promptUsername(mockPrompter, null); + + expect(result).toBe("mybot"); + expect(mockPromptText).toHaveBeenCalledWith({ + message: "Twitch bot username", + initialValue: "", + validate: expect.any(Function), + }); + }); + + it("should use existing username as initial value", async () => { + const { promptUsername } = await import("./onboarding.js"); + + mockPromptText.mockResolvedValue("testbot"); + + await promptUsername(mockPrompter, mockAccount); + + expect(mockPromptText).toHaveBeenCalledWith( + expect.objectContaining({ + initialValue: "testbot", + }), + ); + }); + }); + + describe("promptClientId", () => { + it("should prompt for client ID with validation", async () => { + const { promptClientId } = await import("./onboarding.js"); + + mockPromptText.mockResolvedValue("abc123xyz"); + + const result = await promptClientId(mockPrompter, null); + + expect(result).toBe("abc123xyz"); + expect(mockPromptText).toHaveBeenCalledWith({ + message: "Twitch Client ID", + initialValue: "", + validate: expect.any(Function), + }); + }); + }); + + describe("promptChannelName", () => { + it("should return channel name when provided", async () => { + const { promptChannelName } = await import("./onboarding.js"); + + mockPromptText.mockResolvedValue("#mychannel"); + + const result = await promptChannelName(mockPrompter, null); + + expect(result).toBe("#mychannel"); + }); + + it("should require a non-empty channel name", async () => { + const { promptChannelName } = await import("./onboarding.js"); + + mockPromptText.mockResolvedValue(""); + + await promptChannelName(mockPrompter, null); + + const { validate } = mockPromptText.mock.calls[0]?.[0] ?? {}; + expect(validate?.("")).toBe("Required"); + expect(validate?.(" ")).toBe("Required"); + expect(validate?.("#chan")).toBeUndefined(); + }); + }); + + describe("promptRefreshTokenSetup", () => { + it("should return empty object when user declines", async () => { + const { promptRefreshTokenSetup } = await import("./onboarding.js"); + + mockPromptConfirm.mockResolvedValue(false); + + const result = await promptRefreshTokenSetup(mockPrompter, mockAccount); + + expect(result).toEqual({}); + expect(mockPromptConfirm).toHaveBeenCalledWith({ + message: "Enable automatic token refresh (requires client secret and refresh token)?", + initialValue: false, + }); + }); + + it("should prompt for credentials when user accepts", async () => { + const { promptRefreshTokenSetup } = await import("./onboarding.js"); + + mockPromptConfirm + .mockResolvedValueOnce(true) // First call: useRefresh + .mockResolvedValueOnce("secret123") // clientSecret + .mockResolvedValueOnce("refresh123"); // refreshToken + + mockPromptText.mockResolvedValueOnce("secret123").mockResolvedValueOnce("refresh123"); + + const result = await promptRefreshTokenSetup(mockPrompter, null); + + expect(result).toEqual({ + clientSecret: "secret123", + refreshToken: "refresh123", + }); + }); + + it("should use existing values as initial prompts", async () => { + const { promptRefreshTokenSetup } = await import("./onboarding.js"); + + const accountWithRefresh = { + ...mockAccount, + clientSecret: "existing-secret", + refreshToken: "existing-refresh", + }; + + mockPromptConfirm.mockResolvedValue(true); + mockPromptText + .mockResolvedValueOnce("existing-secret") + .mockResolvedValueOnce("existing-refresh"); + + await promptRefreshTokenSetup(mockPrompter, accountWithRefresh); + + expect(mockPromptConfirm).toHaveBeenCalledWith( + expect.objectContaining({ + initialValue: true, // Both clientSecret and refreshToken exist + }), + ); + }); + }); + + describe("configureWithEnvToken", () => { + it("should return null when user declines env token", async () => { + const { configureWithEnvToken } = await import("./onboarding.js"); + + // Reset and set up mock - user declines env token + mockPromptConfirm.mockReset().mockResolvedValue(false as never); + + const result = await configureWithEnvToken( + {} as Parameters[0], + mockPrompter, + null, + "oauth:fromenv", + false, + {} as Parameters[5], + ); + + // Since user declined, should return null without prompting for username/clientId + expect(result).toBeNull(); + expect(mockPromptText).not.toHaveBeenCalled(); + }); + + it("should prompt for username and clientId when using env token", async () => { + const { configureWithEnvToken } = await import("./onboarding.js"); + + // Reset and set up mocks - user accepts env token + mockPromptConfirm.mockReset().mockResolvedValue(true as never); + + // Set up mocks for username and clientId prompts + mockPromptText + .mockReset() + .mockResolvedValueOnce("testbot" as never) + .mockResolvedValueOnce("test-client-id" as never); + + const result = await configureWithEnvToken( + {} as Parameters[0], + mockPrompter, + null, + "oauth:fromenv", + false, + {} as Parameters[5], + ); + + // Should return config with username and clientId + expect(result).not.toBeNull(); + expect(result?.cfg.channels?.twitch?.accounts?.default?.username).toBe("testbot"); + expect(result?.cfg.channels?.twitch?.accounts?.default?.clientId).toBe("test-client-id"); + }); + }); +}); diff --git a/extensions/twitch/src/onboarding.ts b/extensions/twitch/src/onboarding.ts new file mode 100644 index 000000000..9308b55a0 --- /dev/null +++ b/extensions/twitch/src/onboarding.ts @@ -0,0 +1,411 @@ +/** + * Twitch onboarding adapter for CLI setup wizard. + */ + +import { + formatDocsLink, + promptChannelAccessConfig, + type ChannelOnboardingAdapter, + type ChannelOnboardingDmPolicy, + type WizardPrompter, +} from "clawdbot/plugin-sdk"; +import { DEFAULT_ACCOUNT_ID, getAccountConfig } from "./config.js"; +import { isAccountConfigured } from "./utils/twitch.js"; +import type { TwitchAccountConfig, TwitchRole } from "./types.js"; +import type { ClawdbotConfig } from "clawdbot/plugin-sdk"; + +const channel = "twitch" as const; + +/** + * Set Twitch account configuration + */ +function setTwitchAccount( + cfg: ClawdbotConfig, + account: Partial, +): ClawdbotConfig { + const existing = getAccountConfig(cfg, DEFAULT_ACCOUNT_ID); + const merged: TwitchAccountConfig = { + username: account.username ?? existing?.username ?? "", + accessToken: account.accessToken ?? existing?.accessToken ?? "", + clientId: account.clientId ?? existing?.clientId ?? "", + channel: account.channel ?? existing?.channel ?? "", + enabled: account.enabled ?? existing?.enabled ?? true, + allowFrom: account.allowFrom ?? existing?.allowFrom, + allowedRoles: account.allowedRoles ?? existing?.allowedRoles, + requireMention: account.requireMention ?? existing?.requireMention, + clientSecret: account.clientSecret ?? existing?.clientSecret, + refreshToken: account.refreshToken ?? existing?.refreshToken, + expiresIn: account.expiresIn ?? existing?.expiresIn, + obtainmentTimestamp: account.obtainmentTimestamp ?? existing?.obtainmentTimestamp, + }; + + return { + ...cfg, + channels: { + ...cfg.channels, + twitch: { + ...((cfg.channels as Record)?.twitch as + | Record + | undefined), + enabled: true, + accounts: { + ...(( + (cfg.channels as Record)?.twitch as Record | undefined + )?.accounts as Record | undefined), + [DEFAULT_ACCOUNT_ID]: merged, + }, + }, + }, + }; +} + +/** + * Note about Twitch setup + */ +async function noteTwitchSetupHelp(prompter: WizardPrompter): Promise { + await prompter.note( + [ + "Twitch requires a bot account with OAuth token.", + "1. Create a Twitch application at https://dev.twitch.tv/console", + "2. Generate a token with scopes: chat:read and chat:write", + " Use https://twitchtokengenerator.com/ or https://twitchapps.com/tmi/", + "3. Copy the token (starts with 'oauth:') and Client ID", + "Env vars supported: CLAWDBOT_TWITCH_ACCESS_TOKEN", + `Docs: ${formatDocsLink("/channels/twitch", "channels/twitch")}`, + ].join("\n"), + "Twitch setup", + ); +} + +/** + * Prompt for Twitch OAuth token with early returns. + */ +async function promptToken( + prompter: WizardPrompter, + account: TwitchAccountConfig | null, + envToken: string | undefined, +): Promise { + const existingToken = account?.accessToken ?? ""; + + // If we have an existing token and no env var, ask if we should keep it + if (existingToken && !envToken) { + const keepToken = await prompter.confirm({ + message: "Access token already configured. Keep it?", + initialValue: true, + }); + if (keepToken) { + return existingToken; + } + } + + // Prompt for new token + return String( + await prompter.text({ + message: "Twitch OAuth token (oauth:...)", + initialValue: envToken ?? "", + validate: (value) => { + const raw = String(value ?? "").trim(); + if (!raw) return "Required"; + if (!raw.startsWith("oauth:")) { + return "Token should start with 'oauth:'"; + } + return undefined; + }, + }), + ).trim(); +} + +/** + * Prompt for Twitch username. + */ +async function promptUsername( + prompter: WizardPrompter, + account: TwitchAccountConfig | null, +): Promise { + return String( + await prompter.text({ + message: "Twitch bot username", + initialValue: account?.username ?? "", + validate: (value) => (value?.trim() ? undefined : "Required"), + }), + ).trim(); +} + +/** + * Prompt for Twitch Client ID. + */ +async function promptClientId( + prompter: WizardPrompter, + account: TwitchAccountConfig | null, +): Promise { + return String( + await prompter.text({ + message: "Twitch Client ID", + initialValue: account?.clientId ?? "", + validate: (value) => (value?.trim() ? undefined : "Required"), + }), + ).trim(); +} + +/** + * Prompt for optional channel name. + */ +async function promptChannelName( + prompter: WizardPrompter, + account: TwitchAccountConfig | null, +): Promise { + const channelName = String( + await prompter.text({ + message: "Channel to join", + initialValue: account?.channel ?? "", + validate: (value) => (value?.trim() ? undefined : "Required"), + }), + ).trim(); + return channelName; +} + +/** + * Prompt for token refresh credentials (client secret and refresh token). + */ +async function promptRefreshTokenSetup( + prompter: WizardPrompter, + account: TwitchAccountConfig | null, +): Promise<{ clientSecret?: string; refreshToken?: string }> { + const useRefresh = await prompter.confirm({ + message: "Enable automatic token refresh (requires client secret and refresh token)?", + initialValue: Boolean(account?.clientSecret && account?.refreshToken), + }); + + if (!useRefresh) { + return {}; + } + + const clientSecret = + String( + await prompter.text({ + message: "Twitch Client Secret (for token refresh)", + initialValue: account?.clientSecret ?? "", + validate: (value) => (value?.trim() ? undefined : "Required"), + }), + ).trim() || undefined; + + const refreshToken = + String( + await prompter.text({ + message: "Twitch Refresh Token", + initialValue: account?.refreshToken ?? "", + validate: (value) => (value?.trim() ? undefined : "Required"), + }), + ).trim() || undefined; + + return { clientSecret, refreshToken }; +} + +/** + * Configure with env token path (returns early if user chooses env token). + */ +async function configureWithEnvToken( + cfg: ClawdbotConfig, + prompter: WizardPrompter, + account: TwitchAccountConfig | null, + envToken: string, + forceAllowFrom: boolean, + dmPolicy: ChannelOnboardingDmPolicy, +): Promise<{ cfg: ClawdbotConfig } | null> { + const useEnv = await prompter.confirm({ + message: "Twitch env var CLAWDBOT_TWITCH_ACCESS_TOKEN detected. Use env token?", + initialValue: true, + }); + if (!useEnv) { + return null; + } + + const username = await promptUsername(prompter, account); + const clientId = await promptClientId(prompter, account); + + const cfgWithAccount = setTwitchAccount(cfg, { + username, + clientId, + accessToken: "", // Will use env var + enabled: true, + }); + + if (forceAllowFrom && dmPolicy.promptAllowFrom) { + return { cfg: await dmPolicy.promptAllowFrom({ cfg: cfgWithAccount, prompter }) }; + } + + return { cfg: cfgWithAccount }; +} + +/** + * Set Twitch access control (role-based) + */ +function setTwitchAccessControl( + cfg: ClawdbotConfig, + allowedRoles: TwitchRole[], + requireMention: boolean, +): ClawdbotConfig { + const account = getAccountConfig(cfg, DEFAULT_ACCOUNT_ID); + if (!account) { + return cfg; + } + + return setTwitchAccount(cfg, { + ...account, + allowedRoles, + requireMention, + }); +} + +const dmPolicy: ChannelOnboardingDmPolicy = { + label: "Twitch", + channel, + policyKey: "channels.twitch.allowedRoles", // Twitch uses roles instead of DM policy + allowFromKey: "channels.twitch.accounts.default.allowFrom", + getCurrent: (cfg) => { + const account = getAccountConfig(cfg, DEFAULT_ACCOUNT_ID); + // Map allowedRoles to policy equivalent + if (account?.allowedRoles?.includes("all")) return "open"; + if (account?.allowFrom && account.allowFrom.length > 0) return "allowlist"; + return "disabled"; + }, + setPolicy: (cfg, policy) => { + const allowedRoles: TwitchRole[] = + policy === "open" ? ["all"] : policy === "allowlist" ? [] : ["moderator"]; + return setTwitchAccessControl(cfg as ClawdbotConfig, allowedRoles, true); + }, + promptAllowFrom: async ({ cfg, prompter }) => { + const account = getAccountConfig(cfg, DEFAULT_ACCOUNT_ID); + const existingAllowFrom = account?.allowFrom ?? []; + + const entry = await prompter.text({ + message: "Twitch allowFrom (user IDs, one per line, recommended for security)", + placeholder: "123456789", + initialValue: existingAllowFrom[0] ? String(existingAllowFrom[0]) : undefined, + }); + + const allowFrom = String(entry ?? "") + .split(/[\n,;]+/g) + .map((s) => s.trim()) + .filter(Boolean); + + return setTwitchAccount(cfg as ClawdbotConfig, { + ...(account ?? undefined), + allowFrom, + }); + }, +}; + +export const twitchOnboardingAdapter: ChannelOnboardingAdapter = { + channel, + getStatus: async ({ cfg }) => { + const account = getAccountConfig(cfg, DEFAULT_ACCOUNT_ID); + const configured = account ? isAccountConfigured(account) : false; + + return { + channel, + configured, + statusLines: [`Twitch: ${configured ? "configured" : "needs username, token, and clientId"}`], + selectionHint: configured ? "configured" : "needs setup", + }; + }, + configure: async ({ cfg, prompter, forceAllowFrom }) => { + const account = getAccountConfig(cfg, DEFAULT_ACCOUNT_ID); + + if (!account || !isAccountConfigured(account)) { + await noteTwitchSetupHelp(prompter); + } + + const envToken = process.env.CLAWDBOT_TWITCH_ACCESS_TOKEN?.trim(); + + // Check if env var is set and config is empty + if (envToken && !account?.accessToken) { + const envResult = await configureWithEnvToken( + cfg, + prompter, + account, + envToken, + forceAllowFrom, + dmPolicy, + ); + if (envResult) { + return envResult; + } + } + + // Prompt for credentials + const username = await promptUsername(prompter, account); + const token = await promptToken(prompter, account, envToken); + const clientId = await promptClientId(prompter, account); + const channelName = await promptChannelName(prompter, account); + const { clientSecret, refreshToken } = await promptRefreshTokenSetup(prompter, account); + + const cfgWithAccount = setTwitchAccount(cfg, { + username, + accessToken: token, + clientId, + channel: channelName, + clientSecret, + refreshToken, + enabled: true, + }); + + const cfgWithAllowFrom = + forceAllowFrom && dmPolicy.promptAllowFrom + ? await dmPolicy.promptAllowFrom({ cfg: cfgWithAccount, prompter }) + : cfgWithAccount; + + // Prompt for access control if allowFrom not set + if (!account?.allowFrom || account.allowFrom.length === 0) { + const accessConfig = await promptChannelAccessConfig({ + prompter, + label: "Twitch chat", + currentPolicy: account?.allowedRoles?.includes("all") + ? "open" + : account?.allowedRoles?.includes("moderator") + ? "allowlist" + : "disabled", + currentEntries: [], + placeholder: "", + updatePrompt: false, + }); + + if (accessConfig) { + const allowedRoles: TwitchRole[] = + accessConfig.policy === "open" + ? ["all"] + : accessConfig.policy === "allowlist" + ? ["moderator", "vip"] + : []; + + const cfgWithAccessControl = setTwitchAccessControl(cfgWithAllowFrom, allowedRoles, true); + return { cfg: cfgWithAccessControl }; + } + } + + return { cfg: cfgWithAllowFrom }; + }, + dmPolicy, + disable: (cfg) => { + const twitch = (cfg.channels as Record)?.twitch as + | Record + | undefined; + return { + ...cfg, + channels: { + ...cfg.channels, + twitch: { ...twitch, enabled: false }, + }, + }; + }, +}; + +// Export helper functions for testing +export { + promptToken, + promptUsername, + promptClientId, + promptChannelName, + promptRefreshTokenSetup, + configureWithEnvToken, +}; diff --git a/extensions/twitch/src/outbound.test.ts b/extensions/twitch/src/outbound.test.ts new file mode 100644 index 000000000..41a68418f --- /dev/null +++ b/extensions/twitch/src/outbound.test.ts @@ -0,0 +1,373 @@ +/** + * Tests for outbound.ts module + * + * Tests cover: + * - resolveTarget with various modes (explicit, implicit, heartbeat) + * - sendText with markdown stripping + * - sendMedia delegation to sendText + * - Error handling for missing accounts/channels + * - Abort signal handling + */ + +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; +import { twitchOutbound } from "./outbound.js"; +import type { ClawdbotConfig } from "clawdbot/plugin-sdk"; + +// Mock dependencies +vi.mock("./config.js", () => ({ + DEFAULT_ACCOUNT_ID: "default", + getAccountConfig: vi.fn(), +})); + +vi.mock("./send.js", () => ({ + sendMessageTwitchInternal: vi.fn(), +})); + +vi.mock("./utils/markdown.js", () => ({ + chunkTextForTwitch: vi.fn((text) => text.split(/(.{500})/).filter(Boolean)), +})); + +vi.mock("./utils/twitch.js", () => ({ + normalizeTwitchChannel: (channel: string) => channel.toLowerCase().replace(/^#/, ""), + missingTargetError: (channel: string, hint: string) => + `Missing target for ${channel}. Provide ${hint}`, +})); + +describe("outbound", () => { + const mockAccount = { + username: "testbot", + token: "oauth:test123", + clientId: "test-client-id", + channel: "#testchannel", + }; + + const mockConfig = { + channels: { + twitch: { + accounts: { + default: mockAccount, + }, + }, + }, + } as unknown as ClawdbotConfig; + + beforeEach(() => { + vi.clearAllMocks(); + }); + + afterEach(() => { + vi.restoreAllMocks(); + }); + + describe("metadata", () => { + it("should have direct delivery mode", () => { + expect(twitchOutbound.deliveryMode).toBe("direct"); + }); + + it("should have 500 character text chunk limit", () => { + expect(twitchOutbound.textChunkLimit).toBe(500); + }); + + it("should have chunker function", () => { + expect(twitchOutbound.chunker).toBeDefined(); + expect(typeof twitchOutbound.chunker).toBe("function"); + }); + }); + + describe("resolveTarget", () => { + it("should normalize and return target in explicit mode", () => { + const result = twitchOutbound.resolveTarget({ + to: "#MyChannel", + mode: "explicit", + allowFrom: [], + }); + + expect(result.ok).toBe(true); + expect(result.to).toBe("mychannel"); + }); + + it("should return target in implicit mode with wildcard allowlist", () => { + const result = twitchOutbound.resolveTarget({ + to: "#AnyChannel", + mode: "implicit", + allowFrom: ["*"], + }); + + expect(result.ok).toBe(true); + expect(result.to).toBe("anychannel"); + }); + + it("should return target in implicit mode when in allowlist", () => { + const result = twitchOutbound.resolveTarget({ + to: "#allowed", + mode: "implicit", + allowFrom: ["#allowed", "#other"], + }); + + expect(result.ok).toBe(true); + expect(result.to).toBe("allowed"); + }); + + it("should fallback to first allowlist entry when target not in list", () => { + const result = twitchOutbound.resolveTarget({ + to: "#notallowed", + mode: "implicit", + allowFrom: ["#primary", "#secondary"], + }); + + expect(result.ok).toBe(true); + expect(result.to).toBe("primary"); + }); + + it("should accept any target when allowlist is empty", () => { + const result = twitchOutbound.resolveTarget({ + to: "#anychannel", + mode: "heartbeat", + allowFrom: [], + }); + + expect(result.ok).toBe(true); + expect(result.to).toBe("anychannel"); + }); + + it("should use first allowlist entry when no target provided", () => { + const result = twitchOutbound.resolveTarget({ + to: undefined, + mode: "implicit", + allowFrom: ["#fallback", "#other"], + }); + + expect(result.ok).toBe(true); + expect(result.to).toBe("fallback"); + }); + + it("should return error when no target and no allowlist", () => { + const result = twitchOutbound.resolveTarget({ + to: undefined, + mode: "explicit", + allowFrom: [], + }); + + expect(result.ok).toBe(false); + expect(result.error).toContain("Missing target"); + }); + + it("should handle whitespace-only target", () => { + const result = twitchOutbound.resolveTarget({ + to: " ", + mode: "explicit", + allowFrom: [], + }); + + expect(result.ok).toBe(false); + expect(result.error).toContain("Missing target"); + }); + + it("should filter wildcard from allowlist when checking membership", () => { + const result = twitchOutbound.resolveTarget({ + to: "#mychannel", + mode: "implicit", + allowFrom: ["*", "#specific"], + }); + + // With wildcard, any target is accepted + expect(result.ok).toBe(true); + expect(result.to).toBe("mychannel"); + }); + }); + + describe("sendText", () => { + it("should send message successfully", async () => { + const { getAccountConfig } = await import("./config.js"); + const { sendMessageTwitchInternal } = await import("./send.js"); + + vi.mocked(getAccountConfig).mockReturnValue(mockAccount); + vi.mocked(sendMessageTwitchInternal).mockResolvedValue({ + ok: true, + messageId: "twitch-msg-123", + }); + + const result = await twitchOutbound.sendText({ + cfg: mockConfig, + to: "#testchannel", + text: "Hello Twitch!", + accountId: "default", + }); + + expect(result.channel).toBe("twitch"); + expect(result.messageId).toBe("twitch-msg-123"); + expect(result.to).toBe("testchannel"); + expect(result.timestamp).toBeGreaterThan(0); + }); + + it("should throw when account not found", async () => { + const { getAccountConfig } = await import("./config.js"); + + vi.mocked(getAccountConfig).mockReturnValue(null); + + await expect( + twitchOutbound.sendText({ + cfg: mockConfig, + to: "#testchannel", + text: "Hello!", + accountId: "nonexistent", + }), + ).rejects.toThrow("Twitch account not found: nonexistent"); + }); + + it("should throw when no channel specified", async () => { + const { getAccountConfig } = await import("./config.js"); + + const accountWithoutChannel = { ...mockAccount, channel: undefined as unknown as string }; + vi.mocked(getAccountConfig).mockReturnValue(accountWithoutChannel); + + await expect( + twitchOutbound.sendText({ + cfg: mockConfig, + to: undefined, + text: "Hello!", + accountId: "default", + }), + ).rejects.toThrow("No channel specified"); + }); + + it("should use account channel when target not provided", async () => { + const { getAccountConfig } = await import("./config.js"); + const { sendMessageTwitchInternal } = await import("./send.js"); + + vi.mocked(getAccountConfig).mockReturnValue(mockAccount); + vi.mocked(sendMessageTwitchInternal).mockResolvedValue({ + ok: true, + messageId: "msg-456", + }); + + await twitchOutbound.sendText({ + cfg: mockConfig, + to: undefined, + text: "Hello!", + accountId: "default", + }); + + expect(sendMessageTwitchInternal).toHaveBeenCalledWith( + "testchannel", + "Hello!", + mockConfig, + "default", + true, + console, + ); + }); + + it("should handle abort signal", async () => { + const abortController = new AbortController(); + abortController.abort(); + + await expect( + twitchOutbound.sendText({ + cfg: mockConfig, + to: "#testchannel", + text: "Hello!", + accountId: "default", + signal: abortController.signal, + }), + ).rejects.toThrow("Outbound delivery aborted"); + }); + + it("should throw on send failure", async () => { + const { getAccountConfig } = await import("./config.js"); + const { sendMessageTwitchInternal } = await import("./send.js"); + + vi.mocked(getAccountConfig).mockReturnValue(mockAccount); + vi.mocked(sendMessageTwitchInternal).mockResolvedValue({ + ok: false, + messageId: "failed-msg", + error: "Connection lost", + }); + + await expect( + twitchOutbound.sendText({ + cfg: mockConfig, + to: "#testchannel", + text: "Hello!", + accountId: "default", + }), + ).rejects.toThrow("Connection lost"); + }); + }); + + describe("sendMedia", () => { + it("should combine text and media URL", async () => { + const { sendMessageTwitchInternal } = await import("./send.js"); + const { getAccountConfig } = await import("./config.js"); + + vi.mocked(getAccountConfig).mockReturnValue(mockAccount); + vi.mocked(sendMessageTwitchInternal).mockResolvedValue({ + ok: true, + messageId: "media-msg-123", + }); + + const result = await twitchOutbound.sendMedia({ + cfg: mockConfig, + to: "#testchannel", + text: "Check this:", + mediaUrl: "https://example.com/image.png", + accountId: "default", + }); + + expect(result.channel).toBe("twitch"); + expect(result.messageId).toBe("media-msg-123"); + expect(sendMessageTwitchInternal).toHaveBeenCalledWith( + expect.anything(), + "Check this: https://example.com/image.png", + expect.anything(), + expect.anything(), + expect.anything(), + expect.anything(), + ); + }); + + it("should send media URL only when no text", async () => { + const { sendMessageTwitchInternal } = await import("./send.js"); + const { getAccountConfig } = await import("./config.js"); + + vi.mocked(getAccountConfig).mockReturnValue(mockAccount); + vi.mocked(sendMessageTwitchInternal).mockResolvedValue({ + ok: true, + messageId: "media-only-msg", + }); + + await twitchOutbound.sendMedia({ + cfg: mockConfig, + to: "#testchannel", + text: undefined, + mediaUrl: "https://example.com/image.png", + accountId: "default", + }); + + expect(sendMessageTwitchInternal).toHaveBeenCalledWith( + expect.anything(), + "https://example.com/image.png", + expect.anything(), + expect.anything(), + expect.anything(), + expect.anything(), + ); + }); + + it("should handle abort signal", async () => { + const abortController = new AbortController(); + abortController.abort(); + + await expect( + twitchOutbound.sendMedia({ + cfg: mockConfig, + to: "#testchannel", + text: "Check this:", + mediaUrl: "https://example.com/image.png", + accountId: "default", + signal: abortController.signal, + }), + ).rejects.toThrow("Outbound delivery aborted"); + }); + }); +}); diff --git a/extensions/twitch/src/outbound.ts b/extensions/twitch/src/outbound.ts new file mode 100644 index 000000000..7f2edabec --- /dev/null +++ b/extensions/twitch/src/outbound.ts @@ -0,0 +1,186 @@ +/** + * Twitch outbound adapter for sending messages. + * + * Implements the ChannelOutboundAdapter interface for Twitch chat. + * Supports text and media (URL) sending with markdown stripping and chunking. + */ + +import { DEFAULT_ACCOUNT_ID, getAccountConfig } from "./config.js"; +import { sendMessageTwitchInternal } from "./send.js"; +import type { + ChannelOutboundAdapter, + ChannelOutboundContext, + OutboundDeliveryResult, +} from "./types.js"; +import { chunkTextForTwitch } from "./utils/markdown.js"; +import { missingTargetError, normalizeTwitchChannel } from "./utils/twitch.js"; + +/** + * Twitch outbound adapter. + * + * Handles sending text and media to Twitch channels with automatic + * markdown stripping and message chunking. + */ +export const twitchOutbound: ChannelOutboundAdapter = { + /** Direct delivery mode - messages are sent immediately */ + deliveryMode: "direct", + + /** Twitch chat message limit is 500 characters */ + textChunkLimit: 500, + + /** Word-boundary chunker with markdown stripping */ + chunker: chunkTextForTwitch, + + /** + * Resolve target from context. + * + * Handles target resolution with allowlist support for implicit/heartbeat modes. + * For explicit mode, accepts any valid channel name. + * + * @param params - Resolution parameters + * @returns Resolved target or error + */ + resolveTarget: ({ to, allowFrom, mode }) => { + const trimmed = to?.trim() ?? ""; + const allowListRaw = (allowFrom ?? []) + .map((entry: unknown) => String(entry).trim()) + .filter(Boolean); + const hasWildcard = allowListRaw.includes("*"); + const allowList = allowListRaw + .filter((entry: string) => entry !== "*") + .map((entry: string) => normalizeTwitchChannel(entry)) + .filter((entry): entry is string => entry.length > 0); + + // If target is provided, normalize and validate it + if (trimmed) { + const normalizedTo = normalizeTwitchChannel(trimmed); + + // For implicit/heartbeat modes with allowList, check against allowlist + if (mode === "implicit" || mode === "heartbeat") { + if (hasWildcard || allowList.length === 0) { + return { ok: true, to: normalizedTo }; + } + if (allowList.includes(normalizedTo)) { + return { ok: true, to: normalizedTo }; + } + // Fallback to first allowFrom entry + // biome-ignore lint/style/noNonNullAssertion: length > 0 check ensures element exists + return { ok: true, to: allowList[0]! }; + } + + // For explicit mode, accept any valid channel name + return { ok: true, to: normalizedTo }; + } + + // No target provided, use allowFrom fallback + if (allowList.length > 0) { + // biome-ignore lint/style/noNonNullAssertion: length > 0 check ensures element exists + return { ok: true, to: allowList[0]! }; + } + + // No target and no allowFrom - error + return { + ok: false, + error: missingTargetError( + "Twitch", + " or channels.twitch.accounts..allowFrom[0]", + ), + }; + }, + + /** + * Send a text message to a Twitch channel. + * + * Strips markdown if enabled, validates account configuration, + * and sends the message via the Twitch client. + * + * @param params - Send parameters including target, text, and config + * @returns Delivery result with message ID and status + * + * @example + * const result = await twitchOutbound.sendText({ + * cfg: clawdbotConfig, + * to: "#mychannel", + * text: "Hello Twitch!", + * accountId: "default", + * }); + */ + sendText: async (params: ChannelOutboundContext): Promise => { + const { cfg, to, text, accountId, signal } = params; + + if (signal?.aborted) { + throw new Error("Outbound delivery aborted"); + } + + const resolvedAccountId = accountId ?? DEFAULT_ACCOUNT_ID; + const account = getAccountConfig(cfg, resolvedAccountId); + if (!account) { + const availableIds = Object.keys(cfg.channels?.twitch?.accounts ?? {}); + throw new Error( + `Twitch account not found: ${resolvedAccountId}. ` + + `Available accounts: ${availableIds.join(", ") || "none"}`, + ); + } + + const channel = to || account.channel; + if (!channel) { + throw new Error("No channel specified and no default channel in account config"); + } + + const result = await sendMessageTwitchInternal( + normalizeTwitchChannel(channel), + text, + cfg, + resolvedAccountId, + true, // stripMarkdown + console, + ); + + if (!result.ok) { + throw new Error(result.error ?? "Send failed"); + } + + return { + channel: "twitch", + messageId: result.messageId, + timestamp: Date.now(), + to: normalizeTwitchChannel(channel), + }; + }, + + /** + * Send media to a Twitch channel. + * + * Note: Twitch chat doesn't support direct media uploads. + * This sends the media URL as text instead. + * + * @param params - Send parameters including media URL + * @returns Delivery result with message ID and status + * + * @example + * const result = await twitchOutbound.sendMedia({ + * cfg: clawdbotConfig, + * to: "#mychannel", + * text: "Check this out!", + * mediaUrl: "https://example.com/image.png", + * accountId: "default", + * }); + */ + sendMedia: async (params: ChannelOutboundContext): Promise => { + const { text, mediaUrl, signal } = params; + + if (signal?.aborted) { + throw new Error("Outbound delivery aborted"); + } + + const message = mediaUrl ? `${text || ""} ${mediaUrl}`.trim() : text; + + if (!twitchOutbound.sendText) { + throw new Error("sendText not implemented"); + } + return twitchOutbound.sendText({ + ...params, + text: message, + }); + }, +}; diff --git a/extensions/twitch/src/plugin.test.ts b/extensions/twitch/src/plugin.test.ts new file mode 100644 index 000000000..dd8ec8ad0 --- /dev/null +++ b/extensions/twitch/src/plugin.test.ts @@ -0,0 +1,39 @@ +import { describe, expect, it } from "vitest"; +import type { ClawdbotConfig } from "clawdbot/plugin-sdk"; +import { twitchPlugin } from "./plugin.js"; + +describe("twitchPlugin.status.buildAccountSnapshot", () => { + it("uses the resolved account ID for multi-account configs", async () => { + const secondary = { + channel: "secondary-channel", + username: "secondary", + accessToken: "oauth:secondary-token", + clientId: "secondary-client", + enabled: true, + }; + + const cfg = { + channels: { + twitch: { + accounts: { + default: { + channel: "default-channel", + username: "default", + accessToken: "oauth:default-token", + clientId: "default-client", + enabled: true, + }, + secondary, + }, + }, + }, + } as ClawdbotConfig; + + const snapshot = await twitchPlugin.status?.buildAccountSnapshot?.({ + account: secondary, + cfg, + }); + + expect(snapshot?.accountId).toBe("secondary"); + }); +}); diff --git a/extensions/twitch/src/plugin.ts b/extensions/twitch/src/plugin.ts new file mode 100644 index 000000000..2064722b0 --- /dev/null +++ b/extensions/twitch/src/plugin.ts @@ -0,0 +1,274 @@ +/** + * Twitch channel plugin for Clawdbot. + * + * Main plugin export combining all adapters (outbound, actions, status, gateway). + * This is the primary entry point for the Twitch channel integration. + */ + +import type { ClawdbotConfig } from "clawdbot/plugin-sdk"; +import { buildChannelConfigSchema } from "clawdbot/plugin-sdk"; +import { twitchMessageActions } from "./actions.js"; +import { TwitchConfigSchema } from "./config-schema.js"; +import { DEFAULT_ACCOUNT_ID, getAccountConfig, listAccountIds } from "./config.js"; +import { twitchOnboardingAdapter } from "./onboarding.js"; +import { twitchOutbound } from "./outbound.js"; +import { probeTwitch } from "./probe.js"; +import { resolveTwitchTargets } from "./resolver.js"; +import { collectTwitchStatusIssues } from "./status.js"; +import { removeClientManager } from "./client-manager-registry.js"; +import { resolveTwitchToken } from "./token.js"; +import { isAccountConfigured } from "./utils/twitch.js"; +import type { + ChannelAccountSnapshot, + ChannelCapabilities, + ChannelLogSink, + ChannelMeta, + ChannelPlugin, + ChannelResolveKind, + ChannelResolveResult, + TwitchAccountConfig, +} from "./types.js"; + +/** + * Twitch channel plugin. + * + * Implements the ChannelPlugin interface to provide Twitch chat integration + * for Clawdbot. Supports message sending, receiving, access control, and + * status monitoring. + */ +export const twitchPlugin: ChannelPlugin = { + /** Plugin identifier */ + id: "twitch", + + /** Plugin metadata */ + meta: { + id: "twitch", + label: "Twitch", + selectionLabel: "Twitch (Chat)", + docsPath: "/channels/twitch", + blurb: "Twitch chat integration", + aliases: ["twitch-chat"], + } satisfies ChannelMeta, + + /** Onboarding adapter */ + onboarding: twitchOnboardingAdapter, + + /** Pairing configuration */ + pairing: { + idLabel: "twitchUserId", + normalizeAllowEntry: (entry) => entry.replace(/^(twitch:)?user:?/i, ""), + notifyApproval: async ({ id }) => { + // Note: Twitch doesn't support DMs from bots, so pairing approval is limited + // We'll log the approval instead + console.warn(`Pairing approved for user ${id} (notification sent via chat if possible)`); + }, + }, + + /** Supported chat capabilities */ + capabilities: { + chatTypes: ["group"], + } satisfies ChannelCapabilities, + + /** Configuration schema for Twitch channel */ + configSchema: buildChannelConfigSchema(TwitchConfigSchema), + + /** Account configuration management */ + config: { + /** List all configured account IDs */ + listAccountIds: (cfg: ClawdbotConfig): string[] => listAccountIds(cfg), + + /** Resolve an account config by ID */ + resolveAccount: (cfg: ClawdbotConfig, accountId?: string | null): TwitchAccountConfig => { + const account = getAccountConfig(cfg, accountId ?? DEFAULT_ACCOUNT_ID); + if (!account) { + // Return a default/empty account if not configured + return { + username: "", + accessToken: "", + clientId: "", + enabled: false, + } as TwitchAccountConfig; + } + return account; + }, + + /** Get the default account ID */ + defaultAccountId: (): string => DEFAULT_ACCOUNT_ID, + + /** Check if an account is configured */ + isConfigured: (_account: unknown, cfg: ClawdbotConfig): boolean => { + const account = getAccountConfig(cfg, DEFAULT_ACCOUNT_ID); + const tokenResolution = resolveTwitchToken(cfg, { accountId: DEFAULT_ACCOUNT_ID }); + return account ? isAccountConfigured(account, tokenResolution.token) : false; + }, + + /** Check if an account is enabled */ + isEnabled: (account: TwitchAccountConfig | undefined): boolean => account?.enabled !== false, + + /** Describe account status */ + describeAccount: (account: TwitchAccountConfig | undefined) => { + return { + accountId: DEFAULT_ACCOUNT_ID, + enabled: account?.enabled !== false, + configured: account ? isAccountConfigured(account, account?.accessToken) : false, + }; + }, + }, + + /** Outbound message adapter */ + outbound: twitchOutbound, + + /** Message actions adapter */ + actions: twitchMessageActions, + + /** Resolver adapter for username -> user ID resolution */ + resolver: { + resolveTargets: async ({ + cfg, + accountId, + inputs, + kind, + runtime, + }: { + cfg: ClawdbotConfig; + accountId?: string | null; + inputs: string[]; + kind: ChannelResolveKind; + runtime: import("../../../src/runtime.js").RuntimeEnv; + }): Promise => { + const account = getAccountConfig(cfg, accountId ?? DEFAULT_ACCOUNT_ID); + + if (!account) { + return inputs.map((input) => ({ + input, + resolved: false, + note: "account not configured", + })); + } + + // Adapt RuntimeEnv.log to ChannelLogSink + const log: ChannelLogSink = { + info: (msg) => runtime.log(msg), + warn: (msg) => runtime.log(msg), + error: (msg) => runtime.error(msg), + debug: (msg) => runtime.log(msg), + }; + return await resolveTwitchTargets(inputs, account, kind, log); + }, + }, + + /** Status monitoring adapter */ + status: { + /** Default runtime state */ + defaultRuntime: { + accountId: DEFAULT_ACCOUNT_ID, + running: false, + lastStartAt: null, + lastStopAt: null, + lastError: null, + }, + + /** Build channel summary from snapshot */ + buildChannelSummary: ({ snapshot }: { snapshot: ChannelAccountSnapshot }) => ({ + configured: snapshot.configured ?? false, + running: snapshot.running ?? false, + lastStartAt: snapshot.lastStartAt ?? null, + lastStopAt: snapshot.lastStopAt ?? null, + lastError: snapshot.lastError ?? null, + probe: snapshot.probe, + lastProbeAt: snapshot.lastProbeAt ?? null, + }), + + /** Probe account connection */ + probeAccount: async ({ + account, + timeoutMs, + }: { + account: TwitchAccountConfig; + timeoutMs: number; + }): Promise => { + return await probeTwitch(account, timeoutMs); + }, + + /** Build account snapshot with current status */ + buildAccountSnapshot: ({ + account, + cfg, + runtime, + probe, + }: { + account: TwitchAccountConfig; + cfg: ClawdbotConfig; + runtime?: ChannelAccountSnapshot; + probe?: unknown; + }): ChannelAccountSnapshot => { + const twitch = (cfg as Record).channels as + | Record + | undefined; + const twitchCfg = twitch?.twitch as Record | undefined; + const accountMap = (twitchCfg?.accounts as Record | undefined) ?? {}; + const resolvedAccountId = + Object.entries(accountMap).find(([, value]) => value === account)?.[0] ?? + DEFAULT_ACCOUNT_ID; + const tokenResolution = resolveTwitchToken(cfg, { accountId: resolvedAccountId }); + return { + accountId: resolvedAccountId, + enabled: account?.enabled !== false, + configured: isAccountConfigured(account, tokenResolution.token), + running: runtime?.running ?? false, + lastStartAt: runtime?.lastStartAt ?? null, + lastStopAt: runtime?.lastStopAt ?? null, + lastError: runtime?.lastError ?? null, + probe, + }; + }, + + /** Collect status issues for all accounts */ + collectStatusIssues: collectTwitchStatusIssues, + }, + + /** Gateway adapter for connection lifecycle */ + gateway: { + /** Start an account connection */ + startAccount: async (ctx): Promise => { + const account = ctx.account as TwitchAccountConfig; + const accountId = ctx.accountId; + + ctx.setStatus?.({ + accountId, + running: true, + lastStartAt: Date.now(), + lastError: null, + }); + + ctx.log?.info(`Starting Twitch connection for ${account.username}`); + + // Lazy import: the monitor pulls the reply pipeline; avoid ESM init cycles. + const { monitorTwitchProvider } = await import("./monitor.js"); + await monitorTwitchProvider({ + account, + accountId, + config: ctx.cfg, + runtime: ctx.runtime, + abortSignal: ctx.abortSignal, + }); + }, + + /** Stop an account connection */ + stopAccount: async (ctx): Promise => { + const account = ctx.account as TwitchAccountConfig; + const accountId = ctx.accountId; + + // Disconnect and remove client manager from registry + await removeClientManager(accountId); + + ctx.setStatus?.({ + accountId, + running: false, + lastStopAt: Date.now(), + }); + + ctx.log?.info(`Stopped Twitch connection for ${account.username}`); + }, + }, +}; diff --git a/extensions/twitch/src/probe.test.ts b/extensions/twitch/src/probe.test.ts new file mode 100644 index 000000000..21d43ee18 --- /dev/null +++ b/extensions/twitch/src/probe.test.ts @@ -0,0 +1,198 @@ +import { beforeEach, describe, expect, it, vi } from "vitest"; +import { probeTwitch } from "./probe.js"; +import type { TwitchAccountConfig } from "./types.js"; + +// Mock Twurple modules - Vitest v4 compatible mocking +const mockUnbind = vi.fn(); + +// Event handler storage +let connectHandler: (() => void) | null = null; +let disconnectHandler: ((manually: boolean, reason?: Error) => void) | null = null; +let authFailHandler: (() => void) | null = null; + +// Event listener mocks that store handlers and return unbind function +const mockOnConnect = vi.fn((handler: () => void) => { + connectHandler = handler; + return { unbind: mockUnbind }; +}); + +const mockOnDisconnect = vi.fn((handler: (manually: boolean, reason?: Error) => void) => { + disconnectHandler = handler; + return { unbind: mockUnbind }; +}); + +const mockOnAuthenticationFailure = vi.fn((handler: () => void) => { + authFailHandler = handler; + return { unbind: mockUnbind }; +}); + +// Connect mock that triggers the registered handler +const defaultConnectImpl = async () => { + // Simulate successful connection by calling the handler after a delay + if (connectHandler) { + await new Promise((resolve) => setTimeout(resolve, 1)); + connectHandler(); + } +}; + +const mockConnect = vi.fn().mockImplementation(defaultConnectImpl); + +const mockQuit = vi.fn().mockResolvedValue(undefined); + +vi.mock("@twurple/chat", () => ({ + ChatClient: class { + connect = mockConnect; + quit = mockQuit; + onConnect = mockOnConnect; + onDisconnect = mockOnDisconnect; + onAuthenticationFailure = mockOnAuthenticationFailure; + }, +})); + +vi.mock("@twurple/auth", () => ({ + StaticAuthProvider: class {}, +})); + +describe("probeTwitch", () => { + const mockAccount: TwitchAccountConfig = { + username: "testbot", + token: "oauth:test123456789", + channel: "testchannel", + }; + + beforeEach(() => { + vi.clearAllMocks(); + // Reset handlers + connectHandler = null; + disconnectHandler = null; + authFailHandler = null; + }); + + it("returns error when username is missing", async () => { + const account = { ...mockAccount, username: "" }; + const result = await probeTwitch(account, 5000); + + expect(result.ok).toBe(false); + expect(result.error).toContain("missing credentials"); + }); + + it("returns error when token is missing", async () => { + const account = { ...mockAccount, token: "" }; + const result = await probeTwitch(account, 5000); + + expect(result.ok).toBe(false); + expect(result.error).toContain("missing credentials"); + }); + + it("attempts connection regardless of token prefix", async () => { + // Note: probeTwitch doesn't validate token format - it tries to connect with whatever token is provided + // The actual connection would fail in production with an invalid token + const account = { ...mockAccount, token: "raw_token_no_prefix" }; + const result = await probeTwitch(account, 5000); + + // With mock, connection succeeds even without oauth: prefix + expect(result.ok).toBe(true); + }); + + it("successfully connects with valid credentials", async () => { + const result = await probeTwitch(mockAccount, 5000); + + expect(result.ok).toBe(true); + expect(result.connected).toBe(true); + expect(result.username).toBe("testbot"); + expect(result.channel).toBe("testchannel"); // uses account's configured channel + }); + + it("uses custom channel when specified", async () => { + const account: TwitchAccountConfig = { + ...mockAccount, + channel: "customchannel", + }; + + const result = await probeTwitch(account, 5000); + + expect(result.ok).toBe(true); + expect(result.channel).toBe("customchannel"); + }); + + it("times out when connection takes too long", async () => { + mockConnect.mockImplementationOnce(() => new Promise(() => {})); // Never resolves + + const result = await probeTwitch(mockAccount, 100); + + expect(result.ok).toBe(false); + expect(result.error).toContain("timeout"); + + // Reset mock + mockConnect.mockImplementation(defaultConnectImpl); + }); + + it("cleans up client even on failure", async () => { + mockConnect.mockImplementationOnce(async () => { + // Simulate connection failure by calling disconnect handler + // onDisconnect signature: (manually: boolean, reason?: Error) => void + if (disconnectHandler) { + await new Promise((resolve) => setTimeout(resolve, 1)); + disconnectHandler(false, new Error("Connection failed")); + } + }); + + const result = await probeTwitch(mockAccount, 5000); + + expect(result.ok).toBe(false); + expect(result.error).toContain("Connection failed"); + expect(mockQuit).toHaveBeenCalled(); + + // Reset mocks + mockConnect.mockImplementation(defaultConnectImpl); + }); + + it("handles connection errors gracefully", async () => { + mockConnect.mockImplementationOnce(async () => { + // Simulate connection failure by calling disconnect handler + // onDisconnect signature: (manually: boolean, reason?: Error) => void + if (disconnectHandler) { + await new Promise((resolve) => setTimeout(resolve, 1)); + disconnectHandler(false, new Error("Network error")); + } + }); + + const result = await probeTwitch(mockAccount, 5000); + + expect(result.ok).toBe(false); + expect(result.error).toContain("Network error"); + + // Reset mock + mockConnect.mockImplementation(defaultConnectImpl); + }); + + it("trims token before validation", async () => { + const account: TwitchAccountConfig = { + ...mockAccount, + token: " oauth:test123456789 ", + }; + + const result = await probeTwitch(account, 5000); + + expect(result.ok).toBe(true); + }); + + it("handles non-Error objects in catch block", async () => { + mockConnect.mockImplementationOnce(async () => { + // Simulate connection failure by calling disconnect handler + // onDisconnect signature: (manually: boolean, reason?: Error) => void + if (disconnectHandler) { + await new Promise((resolve) => setTimeout(resolve, 1)); + disconnectHandler(false, "String error" as unknown as Error); + } + }); + + const result = await probeTwitch(mockAccount, 5000); + + expect(result.ok).toBe(false); + expect(result.error).toBe("String error"); + + // Reset mock + mockConnect.mockImplementation(defaultConnectImpl); + }); +}); diff --git a/extensions/twitch/src/probe.ts b/extensions/twitch/src/probe.ts new file mode 100644 index 000000000..90e34826b --- /dev/null +++ b/extensions/twitch/src/probe.ts @@ -0,0 +1,118 @@ +import { StaticAuthProvider } from "@twurple/auth"; +import { ChatClient } from "@twurple/chat"; +import type { TwitchAccountConfig } from "./types.js"; +import { normalizeToken } from "./utils/twitch.js"; + +/** + * Result of probing a Twitch account + */ +export type ProbeTwitchResult = { + ok: boolean; + error?: string; + username?: string; + elapsedMs: number; + connected?: boolean; + channel?: string; +}; + +/** + * Probe a Twitch account to verify the connection is working + * + * This tests the Twitch OAuth token by attempting to connect + * to the chat server and verify the bot's username. + */ +export async function probeTwitch( + account: TwitchAccountConfig, + timeoutMs: number, +): Promise { + const started = Date.now(); + + if (!account.token || !account.username) { + return { + ok: false, + error: "missing credentials (token, username)", + username: account.username, + elapsedMs: Date.now() - started, + }; + } + + const rawToken = normalizeToken(account.token.trim()); + + let client: ChatClient | undefined; + + try { + const authProvider = new StaticAuthProvider(account.clientId ?? "", rawToken); + + client = new ChatClient({ + authProvider, + }); + + // Create a promise that resolves when connected + const connectionPromise = new Promise((resolve, reject) => { + let settled = false; + let connectListener: ReturnType | undefined; + let disconnectListener: ReturnType | undefined; + let authFailListener: ReturnType | undefined; + + const cleanup = () => { + if (settled) return; + settled = true; + connectListener?.unbind(); + disconnectListener?.unbind(); + authFailListener?.unbind(); + }; + + // Success: connection established + connectListener = client?.onConnect(() => { + cleanup(); + resolve(); + }); + + // Failure: disconnected (e.g., auth failed) + disconnectListener = client?.onDisconnect((_manually, reason) => { + cleanup(); + reject(reason || new Error("Disconnected")); + }); + + // Failure: authentication failed + authFailListener = client?.onAuthenticationFailure(() => { + cleanup(); + reject(new Error("Authentication failed")); + }); + }); + + const timeout = new Promise((_, reject) => { + setTimeout(() => reject(new Error(`timeout after ${timeoutMs}ms`)), timeoutMs); + }); + + client.connect(); + await Promise.race([connectionPromise, timeout]); + + client.quit(); + client = undefined; + + return { + ok: true, + connected: true, + username: account.username, + channel: account.channel, + elapsedMs: Date.now() - started, + }; + } catch (error) { + return { + ok: false, + error: error instanceof Error ? error.message : String(error), + username: account.username, + channel: account.channel, + elapsedMs: Date.now() - started, + }; + } finally { + if (client) { + try { + client.quit(); + } catch { + // Ignore cleanup errors + } + } + } +} diff --git a/extensions/twitch/src/resolver.ts b/extensions/twitch/src/resolver.ts new file mode 100644 index 000000000..acc578f4b --- /dev/null +++ b/extensions/twitch/src/resolver.ts @@ -0,0 +1,137 @@ +/** + * Twitch resolver adapter for channel/user name resolution. + * + * This module implements the ChannelResolverAdapter interface to resolve + * Twitch usernames to user IDs via the Twitch Helix API. + */ + +import { ApiClient } from "@twurple/api"; +import { StaticAuthProvider } from "@twurple/auth"; +import type { ChannelResolveKind, ChannelResolveResult } from "./types.js"; +import type { ChannelLogSink, TwitchAccountConfig } from "./types.js"; +import { normalizeToken } from "./utils/twitch.js"; + +/** + * Normalize a Twitch username - strip @ prefix and convert to lowercase + */ +function normalizeUsername(input: string): string { + const trimmed = input.trim(); + if (trimmed.startsWith("@")) { + return trimmed.slice(1).toLowerCase(); + } + return trimmed.toLowerCase(); +} + +/** + * Create a logger that includes the Twitch prefix + */ +function createLogger(logger?: ChannelLogSink): ChannelLogSink { + return { + info: (msg: string) => logger?.info(msg), + warn: (msg: string) => logger?.warn(msg), + error: (msg: string) => logger?.error(msg), + debug: (msg: string) => logger?.debug?.(msg) ?? (() => {}), + }; +} + +/** + * Resolve Twitch usernames to user IDs via the Helix API + * + * @param inputs - Array of usernames or user IDs to resolve + * @param account - Twitch account configuration with auth credentials + * @param kind - Type of target to resolve ("user" or "group") + * @param logger - Optional logger + * @returns Promise resolving to array of ChannelResolveResult + */ +export async function resolveTwitchTargets( + inputs: string[], + account: TwitchAccountConfig, + kind: ChannelResolveKind, + logger?: ChannelLogSink, +): Promise { + const log = createLogger(logger); + + if (!account.clientId || !account.token) { + log.error("Missing Twitch client ID or token"); + return inputs.map((input) => ({ + input, + resolved: false, + note: "missing Twitch credentials", + })); + } + + const normalizedToken = normalizeToken(account.token); + + const authProvider = new StaticAuthProvider(account.clientId, normalizedToken); + const apiClient = new ApiClient({ authProvider }); + + const results: ChannelResolveResult[] = []; + + for (const input of inputs) { + const normalized = normalizeUsername(input); + + if (!normalized) { + results.push({ + input, + resolved: false, + note: "empty input", + }); + continue; + } + + const looksLikeUserId = /^\d+$/.test(normalized); + + try { + if (looksLikeUserId) { + const user = await apiClient.users.getUserById(normalized); + + if (user) { + results.push({ + input, + resolved: true, + id: user.id, + name: user.name, + }); + log.debug?.(`Resolved user ID ${normalized} -> ${user.name}`); + } else { + results.push({ + input, + resolved: false, + note: "user ID not found", + }); + log.warn(`User ID ${normalized} not found`); + } + } else { + const user = await apiClient.users.getUserByName(normalized); + + if (user) { + results.push({ + input, + resolved: true, + id: user.id, + name: user.name, + note: user.displayName !== user.name ? `display: ${user.displayName}` : undefined, + }); + log.debug?.(`Resolved username ${normalized} -> ${user.id} (${user.name})`); + } else { + results.push({ + input, + resolved: false, + note: "username not found", + }); + log.warn(`Username ${normalized} not found`); + } + } + } catch (error) { + const errorMessage = error instanceof Error ? error.message : String(error); + results.push({ + input, + resolved: false, + note: `API error: ${errorMessage}`, + }); + log.error(`Failed to resolve ${input}: ${errorMessage}`); + } + } + + return results; +} diff --git a/extensions/twitch/src/runtime.ts b/extensions/twitch/src/runtime.ts new file mode 100644 index 000000000..5c2f1c672 --- /dev/null +++ b/extensions/twitch/src/runtime.ts @@ -0,0 +1,14 @@ +import type { PluginRuntime } from "clawdbot/plugin-sdk"; + +let runtime: PluginRuntime | null = null; + +export function setTwitchRuntime(next: PluginRuntime) { + runtime = next; +} + +export function getTwitchRuntime(): PluginRuntime { + if (!runtime) { + throw new Error("Twitch runtime not initialized"); + } + return runtime; +} diff --git a/extensions/twitch/src/send.test.ts b/extensions/twitch/src/send.test.ts new file mode 100644 index 000000000..541d4964d --- /dev/null +++ b/extensions/twitch/src/send.test.ts @@ -0,0 +1,289 @@ +/** + * Tests for send.ts module + * + * Tests cover: + * - Message sending with valid configuration + * - Account resolution and validation + * - Channel normalization + * - Markdown stripping + * - Error handling for missing/invalid accounts + * - Registry integration + */ + +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; +import { sendMessageTwitchInternal } from "./send.js"; +import type { ClawdbotConfig } from "clawdbot/plugin-sdk"; + +// Mock dependencies +vi.mock("./config.js", () => ({ + DEFAULT_ACCOUNT_ID: "default", + getAccountConfig: vi.fn(), +})); + +vi.mock("./utils/twitch.js", () => ({ + generateMessageId: vi.fn(() => "test-msg-id"), + isAccountConfigured: vi.fn(() => true), + normalizeTwitchChannel: (channel: string) => channel.toLowerCase().replace(/^#/, ""), +})); + +vi.mock("./utils/markdown.js", () => ({ + stripMarkdownForTwitch: vi.fn((text: string) => text.replace(/\*\*/g, "")), +})); + +vi.mock("./client-manager-registry.js", () => ({ + getClientManager: vi.fn(), +})); + +describe("send", () => { + const mockLogger = { + info: vi.fn(), + warn: vi.fn(), + error: vi.fn(), + debug: vi.fn(), + }; + + const mockAccount = { + username: "testbot", + token: "oauth:test123", + clientId: "test-client-id", + channel: "#testchannel", + }; + + const mockConfig = { + channels: { + twitch: { + accounts: { + default: mockAccount, + }, + }, + }, + } as unknown as ClawdbotConfig; + + beforeEach(() => { + vi.clearAllMocks(); + }); + + afterEach(() => { + vi.restoreAllMocks(); + }); + + describe("sendMessageTwitchInternal", () => { + it("should send a message successfully", async () => { + const { getAccountConfig } = await import("./config.js"); + const { getClientManager } = await import("./client-manager-registry.js"); + const { stripMarkdownForTwitch } = await import("./utils/markdown.js"); + + vi.mocked(getAccountConfig).mockReturnValue(mockAccount); + vi.mocked(getClientManager).mockReturnValue({ + sendMessage: vi.fn().mockResolvedValue({ + ok: true, + messageId: "twitch-msg-123", + }), + } as ReturnType); + vi.mocked(stripMarkdownForTwitch).mockImplementation((text) => text); + + const result = await sendMessageTwitchInternal( + "#testchannel", + "Hello Twitch!", + mockConfig, + "default", + false, + mockLogger as unknown as Console, + ); + + expect(result.ok).toBe(true); + expect(result.messageId).toBe("twitch-msg-123"); + }); + + it("should strip markdown when enabled", async () => { + const { getAccountConfig } = await import("./config.js"); + const { getClientManager } = await import("./client-manager-registry.js"); + const { stripMarkdownForTwitch } = await import("./utils/markdown.js"); + + vi.mocked(getAccountConfig).mockReturnValue(mockAccount); + vi.mocked(getClientManager).mockReturnValue({ + sendMessage: vi.fn().mockResolvedValue({ + ok: true, + messageId: "twitch-msg-456", + }), + } as ReturnType); + vi.mocked(stripMarkdownForTwitch).mockImplementation((text) => text.replace(/\*\*/g, "")); + + await sendMessageTwitchInternal( + "#testchannel", + "**Bold** text", + mockConfig, + "default", + true, + mockLogger as unknown as Console, + ); + + expect(stripMarkdownForTwitch).toHaveBeenCalledWith("**Bold** text"); + }); + + it("should return error when account not found", async () => { + const { getAccountConfig } = await import("./config.js"); + + vi.mocked(getAccountConfig).mockReturnValue(null); + + const result = await sendMessageTwitchInternal( + "#testchannel", + "Hello!", + mockConfig, + "nonexistent", + false, + mockLogger as unknown as Console, + ); + + expect(result.ok).toBe(false); + expect(result.error).toContain("Account not found: nonexistent"); + }); + + it("should return error when account not configured", async () => { + const { getAccountConfig } = await import("./config.js"); + const { isAccountConfigured } = await import("./utils/twitch.js"); + + vi.mocked(getAccountConfig).mockReturnValue(mockAccount); + vi.mocked(isAccountConfigured).mockReturnValue(false); + + const result = await sendMessageTwitchInternal( + "#testchannel", + "Hello!", + mockConfig, + "default", + false, + mockLogger as unknown as Console, + ); + + expect(result.ok).toBe(false); + expect(result.error).toContain("not properly configured"); + }); + + it("should return error when no channel specified", async () => { + const { getAccountConfig } = await import("./config.js"); + const { isAccountConfigured } = await import("./utils/twitch.js"); + + // Set channel to undefined to trigger the error (bypassing type check) + const accountWithoutChannel = { + ...mockAccount, + channel: undefined as unknown as string, + }; + vi.mocked(getAccountConfig).mockReturnValue(accountWithoutChannel); + vi.mocked(isAccountConfigured).mockReturnValue(true); + + const result = await sendMessageTwitchInternal( + "", + "Hello!", + mockConfig, + "default", + false, + mockLogger as unknown as Console, + ); + + expect(result.ok).toBe(false); + expect(result.error).toContain("No channel specified"); + }); + + it("should skip sending empty message after markdown stripping", async () => { + const { getAccountConfig } = await import("./config.js"); + const { isAccountConfigured } = await import("./utils/twitch.js"); + const { stripMarkdownForTwitch } = await import("./utils/markdown.js"); + + vi.mocked(getAccountConfig).mockReturnValue(mockAccount); + vi.mocked(isAccountConfigured).mockReturnValue(true); + vi.mocked(stripMarkdownForTwitch).mockReturnValue(""); + + const result = await sendMessageTwitchInternal( + "#testchannel", + "**Only markdown**", + mockConfig, + "default", + true, + mockLogger as unknown as Console, + ); + + expect(result.ok).toBe(true); + expect(result.messageId).toBe("skipped"); + }); + + it("should return error when client manager not found", async () => { + const { getAccountConfig } = await import("./config.js"); + const { isAccountConfigured } = await import("./utils/twitch.js"); + const { getClientManager } = await import("./client-manager-registry.js"); + + vi.mocked(getAccountConfig).mockReturnValue(mockAccount); + vi.mocked(isAccountConfigured).mockReturnValue(true); + vi.mocked(getClientManager).mockReturnValue(undefined); + + const result = await sendMessageTwitchInternal( + "#testchannel", + "Hello!", + mockConfig, + "default", + false, + mockLogger as unknown as Console, + ); + + expect(result.ok).toBe(false); + expect(result.error).toContain("Client manager not found"); + }); + + it("should handle send errors gracefully", async () => { + const { getAccountConfig } = await import("./config.js"); + const { isAccountConfigured } = await import("./utils/twitch.js"); + const { getClientManager } = await import("./client-manager-registry.js"); + + vi.mocked(getAccountConfig).mockReturnValue(mockAccount); + vi.mocked(isAccountConfigured).mockReturnValue(true); + vi.mocked(getClientManager).mockReturnValue({ + sendMessage: vi.fn().mockRejectedValue(new Error("Connection lost")), + } as ReturnType); + + const result = await sendMessageTwitchInternal( + "#testchannel", + "Hello!", + mockConfig, + "default", + false, + mockLogger as unknown as Console, + ); + + expect(result.ok).toBe(false); + expect(result.error).toBe("Connection lost"); + expect(mockLogger.error).toHaveBeenCalled(); + }); + + it("should use account channel when channel parameter is empty", async () => { + const { getAccountConfig } = await import("./config.js"); + const { isAccountConfigured } = await import("./utils/twitch.js"); + const { getClientManager } = await import("./client-manager-registry.js"); + + vi.mocked(getAccountConfig).mockReturnValue(mockAccount); + vi.mocked(isAccountConfigured).mockReturnValue(true); + const mockSend = vi.fn().mockResolvedValue({ + ok: true, + messageId: "twitch-msg-789", + }); + vi.mocked(getClientManager).mockReturnValue({ + sendMessage: mockSend, + } as ReturnType); + + await sendMessageTwitchInternal( + "", + "Hello!", + mockConfig, + "default", + false, + mockLogger as unknown as Console, + ); + + expect(mockSend).toHaveBeenCalledWith( + mockAccount, + "testchannel", // normalized account channel + "Hello!", + mockConfig, + "default", + ); + }); + }); +}); diff --git a/extensions/twitch/src/send.ts b/extensions/twitch/src/send.ts new file mode 100644 index 000000000..cc9ff678e --- /dev/null +++ b/extensions/twitch/src/send.ts @@ -0,0 +1,136 @@ +/** + * Twitch message sending functions with dependency injection support. + * + * These functions are the primary interface for sending messages to Twitch. + * They support dependency injection via the `deps` parameter for testability. + */ + +import { DEFAULT_ACCOUNT_ID, getAccountConfig } from "./config.js"; +import { getClientManager as getRegistryClientManager } from "./client-manager-registry.js"; +import type { ClawdbotConfig } from "clawdbot/plugin-sdk"; +import { resolveTwitchToken } from "./token.js"; +import { stripMarkdownForTwitch } from "./utils/markdown.js"; +import { generateMessageId, isAccountConfigured, normalizeTwitchChannel } from "./utils/twitch.js"; + +/** + * Result from sending a message to Twitch. + */ +export interface SendMessageResult { + /** Whether the send was successful */ + ok: boolean; + /** The message ID (generated for tracking) */ + messageId: string; + /** Error message if the send failed */ + error?: string; +} + +/** + * Internal send function used by the outbound adapter. + * + * This function has access to the full Clawdbot config and handles + * account resolution, markdown stripping, and actual message sending. + * + * @param channel - The channel name + * @param text - The message text + * @param cfg - Full Clawdbot configuration + * @param accountId - Account ID to use + * @param stripMarkdown - Whether to strip markdown (default: true) + * @param logger - Logger instance + * @returns Result with message ID and status + * + * @example + * const result = await sendMessageTwitchInternal( + * "#mychannel", + * "Hello Twitch!", + * clawdbotConfig, + * "default", + * true, + * console, + * ); + */ +export async function sendMessageTwitchInternal( + channel: string, + text: string, + cfg: ClawdbotConfig, + accountId: string = DEFAULT_ACCOUNT_ID, + stripMarkdown: boolean = true, + logger: Console = console, +): Promise { + const account = getAccountConfig(cfg, accountId); + if (!account) { + const availableIds = Object.keys(cfg.channels?.twitch?.accounts ?? {}); + return { + ok: false, + messageId: generateMessageId(), + error: `Account not found: ${accountId}. Available accounts: ${availableIds.join(", ") || "none"}`, + }; + } + + const tokenResolution = resolveTwitchToken(cfg, { accountId }); + if (!isAccountConfigured(account, tokenResolution.token)) { + return { + ok: false, + messageId: generateMessageId(), + error: + `Account ${accountId} is not properly configured. ` + + "Required: username, clientId, and token (config or env for default account).", + }; + } + + const normalizedChannel = channel || account.channel; + if (!normalizedChannel) { + return { + ok: false, + messageId: generateMessageId(), + error: "No channel specified and no default channel in account config", + }; + } + + const cleanedText = stripMarkdown ? stripMarkdownForTwitch(text) : text; + if (!cleanedText) { + return { + ok: true, + messageId: "skipped", + }; + } + + const clientManager = getRegistryClientManager(accountId); + if (!clientManager) { + return { + ok: false, + messageId: generateMessageId(), + error: `Client manager not found for account: ${accountId}. Please start the Twitch gateway first.`, + }; + } + + try { + const result = await clientManager.sendMessage( + account, + normalizeTwitchChannel(normalizedChannel), + cleanedText, + cfg, + accountId, + ); + + if (!result.ok) { + return { + ok: false, + messageId: result.messageId ?? generateMessageId(), + error: result.error ?? "Send failed", + }; + } + + return { + ok: true, + messageId: result.messageId ?? generateMessageId(), + }; + } catch (error) { + const errorMsg = error instanceof Error ? error.message : String(error); + logger.error(`Failed to send message: ${errorMsg}`); + return { + ok: false, + messageId: generateMessageId(), + error: errorMsg, + }; + } +} diff --git a/extensions/twitch/src/status.test.ts b/extensions/twitch/src/status.test.ts new file mode 100644 index 000000000..8f7cd55ab --- /dev/null +++ b/extensions/twitch/src/status.test.ts @@ -0,0 +1,270 @@ +/** + * Tests for status.ts module + * + * Tests cover: + * - Detection of unconfigured accounts + * - Detection of disabled accounts + * - Detection of missing clientId + * - Token format warnings + * - Access control warnings + * - Runtime error detection + */ + +import { describe, expect, it } from "vitest"; +import { collectTwitchStatusIssues } from "./status.js"; +import type { ChannelAccountSnapshot } from "./types.js"; + +describe("status", () => { + describe("collectTwitchStatusIssues", () => { + it("should detect unconfigured accounts", () => { + const snapshots: ChannelAccountSnapshot[] = [ + { + accountId: "default", + configured: false, + enabled: true, + running: false, + }, + ]; + + const issues = collectTwitchStatusIssues(snapshots); + + expect(issues.length).toBeGreaterThan(0); + expect(issues[0]?.kind).toBe("config"); + expect(issues[0]?.message).toContain("not properly configured"); + }); + + it("should detect disabled accounts", () => { + const snapshots: ChannelAccountSnapshot[] = [ + { + accountId: "default", + configured: true, + enabled: false, + running: false, + }, + ]; + + const issues = collectTwitchStatusIssues(snapshots); + + expect(issues.length).toBeGreaterThan(0); + const disabledIssue = issues.find((i) => i.message.includes("disabled")); + expect(disabledIssue).toBeDefined(); + }); + + it("should detect missing clientId when account configured (simplified config)", () => { + const snapshots: ChannelAccountSnapshot[] = [ + { + accountId: "default", + configured: true, + enabled: true, + running: false, + }, + ]; + + const mockCfg = { + channels: { + twitch: { + username: "testbot", + accessToken: "oauth:test123", + // clientId missing + }, + }, + }; + + const issues = collectTwitchStatusIssues(snapshots, () => mockCfg as never); + + const clientIdIssue = issues.find((i) => i.message.includes("client ID")); + expect(clientIdIssue).toBeDefined(); + }); + + it("should warn about oauth: prefix in token (simplified config)", () => { + const snapshots: ChannelAccountSnapshot[] = [ + { + accountId: "default", + configured: true, + enabled: true, + running: false, + }, + ]; + + const mockCfg = { + channels: { + twitch: { + username: "testbot", + accessToken: "oauth:test123", // has prefix + clientId: "test-id", + }, + }, + }; + + const issues = collectTwitchStatusIssues(snapshots, () => mockCfg as never); + + const prefixIssue = issues.find((i) => i.message.includes("oauth:")); + expect(prefixIssue).toBeDefined(); + expect(prefixIssue?.kind).toBe("config"); + }); + + it("should detect clientSecret without refreshToken (simplified config)", () => { + const snapshots: ChannelAccountSnapshot[] = [ + { + accountId: "default", + configured: true, + enabled: true, + running: false, + }, + ]; + + const mockCfg = { + channels: { + twitch: { + username: "testbot", + accessToken: "oauth:test123", + clientId: "test-id", + clientSecret: "secret123", + // refreshToken missing + }, + }, + }; + + const issues = collectTwitchStatusIssues(snapshots, () => mockCfg as never); + + const secretIssue = issues.find((i) => i.message.includes("clientSecret")); + expect(secretIssue).toBeDefined(); + }); + + it("should detect empty allowFrom array (simplified config)", () => { + const snapshots: ChannelAccountSnapshot[] = [ + { + accountId: "default", + configured: true, + enabled: true, + running: false, + }, + ]; + + const mockCfg = { + channels: { + twitch: { + username: "testbot", + accessToken: "test123", + clientId: "test-id", + allowFrom: [], // empty array + }, + }, + }; + + const issues = collectTwitchStatusIssues(snapshots, () => mockCfg as never); + + const allowFromIssue = issues.find((i) => i.message.includes("allowFrom")); + expect(allowFromIssue).toBeDefined(); + }); + + it("should detect allowedRoles 'all' with allowFrom conflict (simplified config)", () => { + const snapshots: ChannelAccountSnapshot[] = [ + { + accountId: "default", + configured: true, + enabled: true, + running: false, + }, + ]; + + const mockCfg = { + channels: { + twitch: { + username: "testbot", + accessToken: "test123", + clientId: "test-id", + allowedRoles: ["all"], + allowFrom: ["123456"], // conflict! + }, + }, + }; + + const issues = collectTwitchStatusIssues(snapshots, () => mockCfg as never); + + const conflictIssue = issues.find((i) => i.kind === "intent"); + expect(conflictIssue).toBeDefined(); + expect(conflictIssue?.message).toContain("allowedRoles is set to 'all'"); + }); + + it("should detect runtime errors", () => { + const snapshots: ChannelAccountSnapshot[] = [ + { + accountId: "default", + configured: true, + enabled: true, + running: false, + lastError: "Connection timeout", + }, + ]; + + const issues = collectTwitchStatusIssues(snapshots); + + const runtimeIssue = issues.find((i) => i.kind === "runtime"); + expect(runtimeIssue).toBeDefined(); + expect(runtimeIssue?.message).toContain("Connection timeout"); + }); + + it("should detect accounts that never connected", () => { + const snapshots: ChannelAccountSnapshot[] = [ + { + accountId: "default", + configured: true, + enabled: true, + running: false, + lastStartAt: undefined, + lastInboundAt: undefined, + lastOutboundAt: undefined, + }, + ]; + + const issues = collectTwitchStatusIssues(snapshots); + + const neverConnectedIssue = issues.find((i) => + i.message.includes("never connected successfully"), + ); + expect(neverConnectedIssue).toBeDefined(); + }); + + it("should detect long-running connections", () => { + const oldDate = Date.now() - 8 * 24 * 60 * 60 * 1000; // 8 days ago + + const snapshots: ChannelAccountSnapshot[] = [ + { + accountId: "default", + configured: true, + enabled: true, + running: true, + lastStartAt: oldDate, + }, + ]; + + const issues = collectTwitchStatusIssues(snapshots); + + const uptimeIssue = issues.find((i) => i.message.includes("running for")); + expect(uptimeIssue).toBeDefined(); + }); + + it("should handle empty snapshots array", () => { + const issues = collectTwitchStatusIssues([]); + + expect(issues).toEqual([]); + }); + + it("should skip non-Twitch accounts gracefully", () => { + const snapshots: ChannelAccountSnapshot[] = [ + { + accountId: undefined, + configured: false, + enabled: true, + running: false, + }, + ]; + + const issues = collectTwitchStatusIssues(snapshots); + + // Should not crash, may return empty or minimal issues + expect(Array.isArray(issues)).toBe(true); + }); + }); +}); diff --git a/extensions/twitch/src/status.ts b/extensions/twitch/src/status.ts new file mode 100644 index 000000000..b2a488e66 --- /dev/null +++ b/extensions/twitch/src/status.ts @@ -0,0 +1,176 @@ +/** + * Twitch status issues collector. + * + * Detects and reports configuration issues for Twitch accounts. + */ + +import { getAccountConfig } from "./config.js"; +import type { ChannelAccountSnapshot, ChannelStatusIssue } from "./types.js"; +import { resolveTwitchToken } from "./token.js"; +import { isAccountConfigured } from "./utils/twitch.js"; + +/** + * Collect status issues for Twitch accounts. + * + * Analyzes account snapshots and detects configuration problems, + * authentication issues, and other potential problems. + * + * @param accounts - Array of account snapshots to analyze + * @param getCfg - Optional function to get full config for additional checks + * @returns Array of detected status issues + * + * @example + * const issues = collectTwitchStatusIssues(accountSnapshots); + * if (issues.length > 0) { + * console.warn("Twitch configuration issues detected:"); + * issues.forEach(issue => console.warn(`- ${issue.message}`)); + * } + */ +export function collectTwitchStatusIssues( + accounts: ChannelAccountSnapshot[], + getCfg?: () => unknown, +): ChannelStatusIssue[] { + const issues: ChannelStatusIssue[] = []; + + for (const entry of accounts) { + const accountId = entry.accountId; + + if (!accountId) continue; + + let account: ReturnType | null = null; + let cfg: Parameters[0] | undefined; + if (getCfg) { + try { + cfg = getCfg() as { + channels?: { twitch?: { accounts?: Record } }; + }; + account = getAccountConfig(cfg, accountId); + } catch { + // Ignore config access errors + } + } + + if (!entry.configured) { + issues.push({ + channel: "twitch", + accountId, + kind: "config", + message: "Twitch account is not properly configured", + fix: "Add required fields: username, accessToken, and clientId to your account configuration", + }); + continue; + } + + if (entry.enabled === false) { + issues.push({ + channel: "twitch", + accountId, + kind: "config", + message: "Twitch account is disabled", + fix: "Set enabled: true in your account configuration to enable this account", + }); + continue; + } + + if (account && account.username && account.accessToken && !account.clientId) { + issues.push({ + channel: "twitch", + accountId, + kind: "config", + message: "Twitch client ID is required", + fix: "Add clientId to your Twitch account configuration (from Twitch Developer Portal)", + }); + } + + const tokenResolution = cfg + ? resolveTwitchToken(cfg as Parameters[0], { accountId }) + : { token: "", source: "none" }; + if (account && isAccountConfigured(account, tokenResolution.token)) { + if (account.accessToken?.startsWith("oauth:")) { + issues.push({ + channel: "twitch", + accountId, + kind: "config", + message: "Token contains 'oauth:' prefix (will be stripped)", + fix: "The 'oauth:' prefix is optional. You can use just the token value, or keep it as-is (it will be normalized automatically).", + }); + } + + if (account.clientSecret && !account.refreshToken) { + issues.push({ + channel: "twitch", + accountId, + kind: "config", + message: "clientSecret provided without refreshToken", + fix: "For automatic token refresh, provide both clientSecret and refreshToken. Otherwise, clientSecret is not needed.", + }); + } + + if (account.allowFrom && account.allowFrom.length === 0) { + issues.push({ + channel: "twitch", + accountId, + kind: "config", + message: "allowFrom is configured but empty", + fix: "Either add user IDs to allowFrom, remove the allowFrom field, or use allowedRoles instead.", + }); + } + + if ( + account.allowedRoles?.includes("all") && + account.allowFrom && + account.allowFrom.length > 0 + ) { + issues.push({ + channel: "twitch", + accountId, + kind: "intent", + message: "allowedRoles is set to 'all' but allowFrom is also configured", + fix: "When allowedRoles is 'all', the allowFrom list is not needed. Remove allowFrom or set allowedRoles to specific roles.", + }); + } + } + + if (entry.lastError) { + issues.push({ + channel: "twitch", + accountId, + kind: "runtime", + message: `Last error: ${entry.lastError}`, + fix: "Check your token validity and network connection. Ensure the bot has the required OAuth scopes.", + }); + } + + if ( + entry.configured && + !entry.running && + !entry.lastStartAt && + !entry.lastInboundAt && + !entry.lastOutboundAt + ) { + issues.push({ + channel: "twitch", + accountId, + kind: "runtime", + message: "Account has never connected successfully", + fix: "Start the Twitch gateway to begin receiving messages. Check logs for connection errors.", + }); + } + + if (entry.running && entry.lastStartAt) { + const uptime = Date.now() - entry.lastStartAt; + const daysSinceStart = uptime / (1000 * 60 * 60 * 24); + if (daysSinceStart > 7) { + issues.push({ + channel: "twitch", + accountId, + kind: "runtime", + message: `Connection has been running for ${Math.floor(daysSinceStart)} days`, + fix: "Consider restarting the connection periodically to refresh the connection. Twitch tokens may expire after long periods.", + }); + } + } + } + + return issues; +} diff --git a/extensions/twitch/src/token.test.ts b/extensions/twitch/src/token.test.ts new file mode 100644 index 000000000..3894532bc --- /dev/null +++ b/extensions/twitch/src/token.test.ts @@ -0,0 +1,171 @@ +/** + * Tests for token.ts module + * + * Tests cover: + * - Token resolution from config + * - Token resolution from environment variable + * - Fallback behavior when token not found + * - Account ID normalization + */ + +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; +import { resolveTwitchToken, type TwitchTokenSource } from "./token.js"; +import type { ClawdbotConfig } from "clawdbot/plugin-sdk"; + +describe("token", () => { + // Multi-account config for testing non-default accounts + const mockMultiAccountConfig = { + channels: { + twitch: { + accounts: { + default: { + username: "testbot", + accessToken: "oauth:config-token", + }, + other: { + username: "otherbot", + accessToken: "oauth:other-token", + }, + }, + }, + }, + } as unknown as ClawdbotConfig; + + // Simplified single-account config + const mockSimplifiedConfig = { + channels: { + twitch: { + username: "testbot", + accessToken: "oauth:config-token", + }, + }, + } as unknown as ClawdbotConfig; + + beforeEach(() => { + vi.clearAllMocks(); + }); + + afterEach(() => { + vi.restoreAllMocks(); + delete process.env.CLAWDBOT_TWITCH_ACCESS_TOKEN; + }); + + describe("resolveTwitchToken", () => { + it("should resolve token from simplified config for default account", () => { + const result = resolveTwitchToken(mockSimplifiedConfig, { accountId: "default" }); + + expect(result.token).toBe("oauth:config-token"); + expect(result.source).toBe("config"); + }); + + it("should resolve token from config for non-default account (multi-account)", () => { + const result = resolveTwitchToken(mockMultiAccountConfig, { accountId: "other" }); + + expect(result.token).toBe("oauth:other-token"); + expect(result.source).toBe("config"); + }); + + it("should prioritize config token over env var (simplified config)", () => { + process.env.CLAWDBOT_TWITCH_ACCESS_TOKEN = "oauth:env-token"; + + const result = resolveTwitchToken(mockSimplifiedConfig, { accountId: "default" }); + + // Config token should be used even if env var exists + expect(result.token).toBe("oauth:config-token"); + expect(result.source).toBe("config"); + }); + + it("should use env var when config token is empty (simplified config)", () => { + process.env.CLAWDBOT_TWITCH_ACCESS_TOKEN = "oauth:env-token"; + + const configWithEmptyToken = { + channels: { + twitch: { + username: "testbot", + accessToken: "", + }, + }, + } as unknown as ClawdbotConfig; + + const result = resolveTwitchToken(configWithEmptyToken, { accountId: "default" }); + + expect(result.token).toBe("oauth:env-token"); + expect(result.source).toBe("env"); + }); + + it("should return empty token when neither config nor env has token (simplified config)", () => { + const configWithoutToken = { + channels: { + twitch: { + username: "testbot", + accessToken: "", + }, + }, + } as unknown as ClawdbotConfig; + + const result = resolveTwitchToken(configWithoutToken, { accountId: "default" }); + + expect(result.token).toBe(""); + expect(result.source).toBe("none"); + }); + + it("should not use env var for non-default accounts (multi-account)", () => { + process.env.CLAWDBOT_TWITCH_ACCESS_TOKEN = "oauth:env-token"; + + const configWithoutToken = { + channels: { + twitch: { + accounts: { + secondary: { + username: "secondary", + accessToken: "", + }, + }, + }, + }, + } as unknown as ClawdbotConfig; + + const result = resolveTwitchToken(configWithoutToken, { accountId: "secondary" }); + + // Non-default accounts shouldn't use env var + expect(result.token).toBe(""); + expect(result.source).toBe("none"); + }); + + it("should handle missing account gracefully", () => { + const configWithoutAccount = { + channels: { + twitch: { + accounts: {}, + }, + }, + } as unknown as ClawdbotConfig; + + const result = resolveTwitchToken(configWithoutAccount, { accountId: "nonexistent" }); + + expect(result.token).toBe(""); + expect(result.source).toBe("none"); + }); + + it("should handle missing Twitch config section", () => { + const configWithoutSection = { + channels: {}, + } as unknown as ClawdbotConfig; + + const result = resolveTwitchToken(configWithoutSection, { accountId: "default" }); + + expect(result.token).toBe(""); + expect(result.source).toBe("none"); + }); + }); + + describe("TwitchTokenSource type", () => { + it("should have correct values", () => { + const sources: TwitchTokenSource[] = ["env", "config", "none"]; + + expect(sources).toContain("env"); + expect(sources).toContain("config"); + expect(sources).toContain("none"); + }); + }); +}); diff --git a/extensions/twitch/src/token.ts b/extensions/twitch/src/token.ts new file mode 100644 index 000000000..bad0f2b57 --- /dev/null +++ b/extensions/twitch/src/token.ts @@ -0,0 +1,87 @@ +/** + * Twitch access token resolution with environment variable support. + * + * Supports reading Twitch OAuth access tokens from config or environment variable. + * The CLAWDBOT_TWITCH_ACCESS_TOKEN env var is only used for the default account. + * + * Token resolution priority: + * 1. Account access token from merged config (accounts.{id} or base-level for default) + * 2. Environment variable: CLAWDBOT_TWITCH_ACCESS_TOKEN (default account only) + */ + +import type { ClawdbotConfig } from "../../../src/config/config.js"; +import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../../../src/routing/session-key.js"; + +export type TwitchTokenSource = "env" | "config" | "none"; + +export type TwitchTokenResolution = { + token: string; + source: TwitchTokenSource; +}; + +/** + * Normalize a Twitch OAuth token - ensure it has the oauth: prefix + */ +function normalizeTwitchToken(raw?: string | null): string | undefined { + if (!raw) return undefined; + const trimmed = raw.trim(); + if (!trimmed) return undefined; + // Twitch tokens should have oauth: prefix + return trimmed.startsWith("oauth:") ? trimmed : `oauth:${trimmed}`; +} + +/** + * Resolve Twitch access token from config or environment variable. + * + * Priority: + * 1. Account access token (from merged config - base-level for default, or accounts.{accountId}) + * 2. Environment variable: CLAWDBOT_TWITCH_ACCESS_TOKEN (default account only) + * + * The getAccountConfig function handles merging base-level config with accounts.default, + * so this logic works for both simplified and multi-account patterns. + * + * @param cfg - Clawdbot config + * @param opts - Options including accountId and optional envToken override + * @returns Token resolution with source + */ +export function resolveTwitchToken( + cfg?: ClawdbotConfig, + opts: { accountId?: string | null; envToken?: string | null } = {}, +): TwitchTokenResolution { + const accountId = normalizeAccountId(opts.accountId); + + // Get merged account config (handles both simplified and multi-account patterns) + const twitchCfg = cfg?.channels?.twitch; + const accountCfg = + accountId === DEFAULT_ACCOUNT_ID + ? (twitchCfg?.accounts?.[DEFAULT_ACCOUNT_ID] as Record | undefined) + : (twitchCfg?.accounts?.[accountId as string] as Record | undefined); + + // For default account, also check base-level config + let token: string | undefined; + if (accountId === DEFAULT_ACCOUNT_ID) { + // Base-level config takes precedence + token = normalizeTwitchToken( + (typeof twitchCfg?.accessToken === "string" ? twitchCfg.accessToken : undefined) || + (accountCfg?.accessToken as string | undefined), + ); + } else { + // Non-default accounts only use accounts object + token = normalizeTwitchToken(accountCfg?.accessToken as string | undefined); + } + + if (token) { + return { token, source: "config" }; + } + + // Environment variable (default account only) + const allowEnv = accountId === DEFAULT_ACCOUNT_ID; + const envToken = allowEnv + ? normalizeTwitchToken(opts.envToken ?? process.env.CLAWDBOT_TWITCH_ACCESS_TOKEN) + : undefined; + if (envToken) { + return { token: envToken, source: "env" }; + } + + return { token: "", source: "none" }; +} diff --git a/extensions/twitch/src/twitch-client.test.ts b/extensions/twitch/src/twitch-client.test.ts new file mode 100644 index 000000000..b6e270acd --- /dev/null +++ b/extensions/twitch/src/twitch-client.test.ts @@ -0,0 +1,574 @@ +/** + * Tests for TwitchClientManager class + * + * Tests cover: + * - Client connection and reconnection + * - Message handling (chat) + * - Message sending with rate limiting + * - Disconnection scenarios + * - Error handling and edge cases + */ + +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; +import { TwitchClientManager } from "./twitch-client.js"; +import type { ChannelLogSink, TwitchAccountConfig, TwitchChatMessage } from "./types.js"; + +// Mock @twurple dependencies +const mockConnect = vi.fn().mockResolvedValue(undefined); +const mockJoin = vi.fn().mockResolvedValue(undefined); +const mockSay = vi.fn().mockResolvedValue({ messageId: "test-msg-123" }); +const mockQuit = vi.fn(); +const mockUnbind = vi.fn(); + +// Event handler storage for testing +const messageHandlers: Array<(channel: string, user: string, message: string, msg: any) => void> = + []; + +// Mock functions that track handlers and return unbind objects +const mockOnMessage = vi.fn((handler: any) => { + messageHandlers.push(handler); + return { unbind: mockUnbind }; +}); + +const mockAddUserForToken = vi.fn().mockResolvedValue("123456"); +const mockOnRefresh = vi.fn(); +const mockOnRefreshFailure = vi.fn(); + +vi.mock("@twurple/chat", () => ({ + ChatClient: class { + onMessage = mockOnMessage; + connect = mockConnect; + join = mockJoin; + say = mockSay; + quit = mockQuit; + }, + LogLevel: { + CRITICAL: "CRITICAL", + ERROR: "ERROR", + WARNING: "WARNING", + INFO: "INFO", + DEBUG: "DEBUG", + TRACE: "TRACE", + }, +})); + +const mockAuthProvider = { + constructor: vi.fn(), +}; + +vi.mock("@twurple/auth", () => ({ + StaticAuthProvider: class { + constructor(...args: unknown[]) { + mockAuthProvider.constructor(...args); + } + }, + RefreshingAuthProvider: class { + addUserForToken = mockAddUserForToken; + onRefresh = mockOnRefresh; + onRefreshFailure = mockOnRefreshFailure; + }, +})); + +// Mock token resolution - must be after @twurple/auth mock +vi.mock("./token.js", () => ({ + resolveTwitchToken: vi.fn(() => ({ + token: "oauth:mock-token-from-tests", + source: "config" as const, + })), + DEFAULT_ACCOUNT_ID: "default", +})); + +describe("TwitchClientManager", () => { + let manager: TwitchClientManager; + let mockLogger: ChannelLogSink; + + const testAccount: TwitchAccountConfig = { + username: "testbot", + token: "oauth:test123456", + clientId: "test-client-id", + channel: "testchannel", + enabled: true, + }; + + const testAccount2: TwitchAccountConfig = { + username: "testbot2", + token: "oauth:test789", + clientId: "test-client-id-2", + channel: "testchannel2", + enabled: true, + }; + + beforeEach(async () => { + // Clear all mocks first + vi.clearAllMocks(); + + // Clear handler arrays + messageHandlers.length = 0; + + // Re-set up the default token mock implementation after clearing + const { resolveTwitchToken } = await import("./token.js"); + vi.mocked(resolveTwitchToken).mockReturnValue({ + token: "oauth:mock-token-from-tests", + source: "config" as const, + }); + + // Create mock logger + mockLogger = { + info: vi.fn(), + warn: vi.fn(), + error: vi.fn(), + debug: vi.fn(), + }; + + // Create manager instance + manager = new TwitchClientManager(mockLogger); + }); + + afterEach(() => { + // Clean up manager to avoid side effects + manager._clearForTest(); + }); + + describe("getClient", () => { + it("should create a new client connection", async () => { + const _client = await manager.getClient(testAccount); + + // New implementation: connect is called, channels are passed to constructor + expect(mockConnect).toHaveBeenCalledTimes(1); + expect(mockLogger.info).toHaveBeenCalledWith( + expect.stringContaining("Connected to Twitch as testbot"), + ); + }); + + it("should use account username as default channel when channel not specified", async () => { + const accountWithoutChannel: TwitchAccountConfig = { + ...testAccount, + channel: undefined, + }; + + await manager.getClient(accountWithoutChannel); + + // New implementation: channel (testbot) is passed to constructor, not via join() + expect(mockConnect).toHaveBeenCalledTimes(1); + }); + + it("should reuse existing client for same account", async () => { + const client1 = await manager.getClient(testAccount); + const client2 = await manager.getClient(testAccount); + + expect(client1).toBe(client2); + expect(mockConnect).toHaveBeenCalledTimes(1); + }); + + it("should create separate clients for different accounts", async () => { + await manager.getClient(testAccount); + await manager.getClient(testAccount2); + + expect(mockConnect).toHaveBeenCalledTimes(2); + }); + + it("should normalize token by removing oauth: prefix", async () => { + const accountWithPrefix: TwitchAccountConfig = { + ...testAccount, + token: "oauth:actualtoken123", + }; + + // Override the mock to return a specific token for this test + const { resolveTwitchToken } = await import("./token.js"); + vi.mocked(resolveTwitchToken).mockReturnValue({ + token: "oauth:actualtoken123", + source: "config" as const, + }); + + await manager.getClient(accountWithPrefix); + + expect(mockAuthProvider.constructor).toHaveBeenCalledWith("test-client-id", "actualtoken123"); + }); + + it("should use token directly when no oauth: prefix", async () => { + // Override the mock to return a token without oauth: prefix + const { resolveTwitchToken } = await import("./token.js"); + vi.mocked(resolveTwitchToken).mockReturnValue({ + token: "oauth:mock-token-from-tests", + source: "config" as const, + }); + + await manager.getClient(testAccount); + + // Implementation strips oauth: prefix from all tokens + expect(mockAuthProvider.constructor).toHaveBeenCalledWith( + "test-client-id", + "mock-token-from-tests", + ); + }); + + it("should throw error when clientId is missing", async () => { + const accountWithoutClientId: TwitchAccountConfig = { + ...testAccount, + clientId: undefined, + }; + + await expect(manager.getClient(accountWithoutClientId)).rejects.toThrow( + "Missing Twitch client ID", + ); + + expect(mockLogger.error).toHaveBeenCalledWith( + expect.stringContaining("Missing Twitch client ID"), + ); + }); + + it("should throw error when token is missing", async () => { + // Override the mock to return empty token + const { resolveTwitchToken } = await import("./token.js"); + vi.mocked(resolveTwitchToken).mockReturnValue({ + token: "", + source: "none" as const, + }); + + await expect(manager.getClient(testAccount)).rejects.toThrow("Missing Twitch token"); + }); + + it("should set up message handlers on client connection", async () => { + await manager.getClient(testAccount); + + expect(mockOnMessage).toHaveBeenCalled(); + expect(mockLogger.info).toHaveBeenCalledWith(expect.stringContaining("Set up handlers for")); + }); + + it("should create separate clients for same account with different channels", async () => { + const account1: TwitchAccountConfig = { + ...testAccount, + channel: "channel1", + }; + const account2: TwitchAccountConfig = { + ...testAccount, + channel: "channel2", + }; + + await manager.getClient(account1); + await manager.getClient(account2); + + expect(mockConnect).toHaveBeenCalledTimes(2); + }); + }); + + describe("onMessage", () => { + it("should register message handler for account", () => { + const handler = vi.fn(); + manager.onMessage(testAccount, handler); + + expect(handler).not.toHaveBeenCalled(); + }); + + it("should replace existing handler for same account", () => { + const handler1 = vi.fn(); + const handler2 = vi.fn(); + + manager.onMessage(testAccount, handler1); + manager.onMessage(testAccount, handler2); + + // Check the stored handler is handler2 + const key = manager.getAccountKey(testAccount); + expect((manager as any).messageHandlers.get(key)).toBe(handler2); + }); + }); + + describe("disconnect", () => { + it("should disconnect a connected client", async () => { + await manager.getClient(testAccount); + await manager.disconnect(testAccount); + + expect(mockQuit).toHaveBeenCalledTimes(1); + expect(mockLogger.info).toHaveBeenCalledWith(expect.stringContaining("Disconnected")); + }); + + it("should clear client and message handler", async () => { + const handler = vi.fn(); + await manager.getClient(testAccount); + manager.onMessage(testAccount, handler); + + await manager.disconnect(testAccount); + + const key = manager.getAccountKey(testAccount); + expect((manager as any).clients.has(key)).toBe(false); + expect((manager as any).messageHandlers.has(key)).toBe(false); + }); + + it("should handle disconnecting non-existent client gracefully", async () => { + // disconnect doesn't throw, just does nothing + await manager.disconnect(testAccount); + expect(mockQuit).not.toHaveBeenCalled(); + }); + + it("should only disconnect specified account when multiple accounts exist", async () => { + await manager.getClient(testAccount); + await manager.getClient(testAccount2); + + await manager.disconnect(testAccount); + + expect(mockQuit).toHaveBeenCalledTimes(1); + + const key2 = manager.getAccountKey(testAccount2); + expect((manager as any).clients.has(key2)).toBe(true); + }); + }); + + describe("disconnectAll", () => { + it("should disconnect all connected clients", async () => { + await manager.getClient(testAccount); + await manager.getClient(testAccount2); + + await manager.disconnectAll(); + + expect(mockQuit).toHaveBeenCalledTimes(2); + expect((manager as any).clients.size).toBe(0); + expect((manager as any).messageHandlers.size).toBe(0); + }); + + it("should handle empty client list gracefully", async () => { + // disconnectAll doesn't throw, just does nothing + await manager.disconnectAll(); + expect(mockQuit).not.toHaveBeenCalled(); + }); + }); + + describe("sendMessage", () => { + beforeEach(async () => { + await manager.getClient(testAccount); + }); + + it("should send message successfully", async () => { + const result = await manager.sendMessage(testAccount, "testchannel", "Hello, world!"); + + expect(result.ok).toBe(true); + expect(result.messageId).toBeDefined(); + expect(mockSay).toHaveBeenCalledWith("testchannel", "Hello, world!"); + }); + + it("should generate unique message ID for each message", async () => { + const result1 = await manager.sendMessage(testAccount, "testchannel", "First message"); + const result2 = await manager.sendMessage(testAccount, "testchannel", "Second message"); + + expect(result1.messageId).not.toBe(result2.messageId); + }); + + it("should handle sending to account's default channel", async () => { + const result = await manager.sendMessage( + testAccount, + testAccount.channel || testAccount.username, + "Test message", + ); + + // Should use the account's channel or username + expect(result.ok).toBe(true); + expect(mockSay).toHaveBeenCalled(); + }); + + it("should return error on send failure", async () => { + mockSay.mockRejectedValueOnce(new Error("Rate limited")); + + const result = await manager.sendMessage(testAccount, "testchannel", "Test message"); + + expect(result.ok).toBe(false); + expect(result.error).toBe("Rate limited"); + expect(mockLogger.error).toHaveBeenCalledWith( + expect.stringContaining("Failed to send message"), + ); + }); + + it("should handle unknown error types", async () => { + mockSay.mockRejectedValueOnce("String error"); + + const result = await manager.sendMessage(testAccount, "testchannel", "Test message"); + + expect(result.ok).toBe(false); + expect(result.error).toBe("String error"); + }); + + it("should create client if not already connected", async () => { + // Clear the existing client + (manager as any).clients.clear(); + + // Reset connect call count for this specific test + const connectCallCountBefore = mockConnect.mock.calls.length; + + const result = await manager.sendMessage(testAccount, "testchannel", "Test message"); + + expect(result.ok).toBe(true); + expect(mockConnect.mock.calls.length).toBeGreaterThan(connectCallCountBefore); + }); + }); + + describe("message handling integration", () => { + let capturedMessage: TwitchChatMessage | null = null; + + beforeEach(() => { + capturedMessage = null; + + // Set up message handler before connecting + manager.onMessage(testAccount, (message) => { + capturedMessage = message; + }); + }); + + it("should handle incoming chat messages", async () => { + await manager.getClient(testAccount); + + // Get the onMessage callback + const onMessageCallback = messageHandlers[0]; + if (!onMessageCallback) throw new Error("onMessageCallback not found"); + + // Simulate Twitch message + onMessageCallback("#testchannel", "testuser", "Hello bot!", { + userInfo: { + userName: "testuser", + displayName: "TestUser", + userId: "12345", + isMod: false, + isBroadcaster: false, + isVip: false, + isSubscriber: false, + }, + id: "msg123", + }); + + expect(capturedMessage).not.toBeNull(); + expect(capturedMessage?.username).toBe("testuser"); + expect(capturedMessage?.displayName).toBe("TestUser"); + expect(capturedMessage?.userId).toBe("12345"); + expect(capturedMessage?.message).toBe("Hello bot!"); + expect(capturedMessage?.channel).toBe("testchannel"); + expect(capturedMessage?.chatType).toBe("group"); + }); + + it("should normalize channel names without # prefix", async () => { + await manager.getClient(testAccount); + + const onMessageCallback = messageHandlers[0]; + + onMessageCallback("testchannel", "testuser", "Test", { + userInfo: { + userName: "testuser", + displayName: "TestUser", + userId: "123", + isMod: false, + isBroadcaster: false, + isVip: false, + isSubscriber: false, + }, + id: "msg1", + }); + + expect(capturedMessage?.channel).toBe("testchannel"); + }); + + it("should include user role flags in message", async () => { + await manager.getClient(testAccount); + + const onMessageCallback = messageHandlers[0]; + + onMessageCallback("#testchannel", "moduser", "Test", { + userInfo: { + userName: "moduser", + displayName: "ModUser", + userId: "456", + isMod: true, + isBroadcaster: false, + isVip: true, + isSubscriber: true, + }, + id: "msg2", + }); + + expect(capturedMessage?.isMod).toBe(true); + expect(capturedMessage?.isVip).toBe(true); + expect(capturedMessage?.isSub).toBe(true); + expect(capturedMessage?.isOwner).toBe(false); + }); + + it("should handle broadcaster messages", async () => { + await manager.getClient(testAccount); + + const onMessageCallback = messageHandlers[0]; + + onMessageCallback("#testchannel", "broadcaster", "Test", { + userInfo: { + userName: "broadcaster", + displayName: "Broadcaster", + userId: "789", + isMod: false, + isBroadcaster: true, + isVip: false, + isSubscriber: false, + }, + id: "msg3", + }); + + expect(capturedMessage?.isOwner).toBe(true); + }); + }); + + describe("edge cases", () => { + it("should handle multiple message handlers for different accounts", async () => { + const messages1: TwitchChatMessage[] = []; + const messages2: TwitchChatMessage[] = []; + + manager.onMessage(testAccount, (msg) => messages1.push(msg)); + manager.onMessage(testAccount2, (msg) => messages2.push(msg)); + + await manager.getClient(testAccount); + await manager.getClient(testAccount2); + + // Simulate message for first account + const onMessage1 = messageHandlers[0]; + if (!onMessage1) throw new Error("onMessage1 not found"); + onMessage1("#testchannel", "user1", "msg1", { + userInfo: { + userName: "user1", + displayName: "User1", + userId: "1", + isMod: false, + isBroadcaster: false, + isVip: false, + isSubscriber: false, + }, + id: "1", + }); + + // Simulate message for second account + const onMessage2 = messageHandlers[1]; + if (!onMessage2) throw new Error("onMessage2 not found"); + onMessage2("#testchannel2", "user2", "msg2", { + userInfo: { + userName: "user2", + displayName: "User2", + userId: "2", + isMod: false, + isBroadcaster: false, + isVip: false, + isSubscriber: false, + }, + id: "2", + }); + + expect(messages1).toHaveLength(1); + expect(messages2).toHaveLength(1); + expect(messages1[0]?.message).toBe("msg1"); + expect(messages2[0]?.message).toBe("msg2"); + }); + + it("should handle rapid client creation requests", async () => { + const promises = [ + manager.getClient(testAccount), + manager.getClient(testAccount), + manager.getClient(testAccount), + ]; + + await Promise.all(promises); + + // Note: The implementation doesn't handle concurrent getClient calls, + // so multiple connections may be created. This is expected behavior. + expect(mockConnect).toHaveBeenCalled(); + }); + }); +}); diff --git a/extensions/twitch/src/twitch-client.ts b/extensions/twitch/src/twitch-client.ts new file mode 100644 index 000000000..f76435aa4 --- /dev/null +++ b/extensions/twitch/src/twitch-client.ts @@ -0,0 +1,277 @@ +import { RefreshingAuthProvider, StaticAuthProvider } from "@twurple/auth"; +import { ChatClient, LogLevel } from "@twurple/chat"; +import type { ClawdbotConfig } from "clawdbot/plugin-sdk"; +import type { ChannelLogSink, TwitchAccountConfig, TwitchChatMessage } from "./types.js"; +import { resolveTwitchToken } from "./token.js"; +import { normalizeToken } from "./utils/twitch.js"; + +/** + * Manages Twitch chat client connections + */ +export class TwitchClientManager { + private clients = new Map(); + private messageHandlers = new Map void>(); + + constructor(private logger: ChannelLogSink) {} + + /** + * Create an auth provider for the account. + */ + private async createAuthProvider( + account: TwitchAccountConfig, + normalizedToken: string, + ): Promise { + if (!account.clientId) { + throw new Error("Missing Twitch client ID"); + } + + if (account.clientSecret) { + const authProvider = new RefreshingAuthProvider({ + clientId: account.clientId, + clientSecret: account.clientSecret, + }); + + await authProvider + .addUserForToken({ + accessToken: normalizedToken, + refreshToken: account.refreshToken ?? null, + expiresIn: account.expiresIn ?? null, + obtainmentTimestamp: account.obtainmentTimestamp ?? Date.now(), + }) + .then((userId) => { + this.logger.info( + `Added user ${userId} to RefreshingAuthProvider for ${account.username}`, + ); + }) + .catch((err) => { + this.logger.error( + `Failed to add user to RefreshingAuthProvider: ${err instanceof Error ? err.message : String(err)}`, + ); + }); + + authProvider.onRefresh((userId, token) => { + this.logger.info( + `Access token refreshed for user ${userId} (expires in ${token.expiresIn ? `${token.expiresIn}s` : "unknown"})`, + ); + }); + + authProvider.onRefreshFailure((userId, error) => { + this.logger.error(`Failed to refresh access token for user ${userId}: ${error.message}`); + }); + + const refreshStatus = account.refreshToken + ? "automatic token refresh enabled" + : "token refresh disabled (no refresh token)"; + this.logger.info(`Using RefreshingAuthProvider for ${account.username} (${refreshStatus})`); + + return authProvider; + } + + this.logger.info(`Using StaticAuthProvider for ${account.username} (no clientSecret provided)`); + return new StaticAuthProvider(account.clientId, normalizedToken); + } + + /** + * Get or create a chat client for an account + */ + async getClient( + account: TwitchAccountConfig, + cfg?: ClawdbotConfig, + accountId?: string, + ): Promise { + const key = this.getAccountKey(account); + + const existing = this.clients.get(key); + if (existing) { + return existing; + } + + const tokenResolution = resolveTwitchToken(cfg, { + accountId, + }); + + if (!tokenResolution.token) { + this.logger.error( + `Missing Twitch token for account ${account.username} (set channels.twitch.accounts.${account.username}.token or CLAWDBOT_TWITCH_ACCESS_TOKEN for default)`, + ); + throw new Error("Missing Twitch token"); + } + + this.logger.debug?.(`Using ${tokenResolution.source} token source for ${account.username}`); + + if (!account.clientId) { + this.logger.error(`Missing Twitch client ID for account ${account.username}`); + throw new Error("Missing Twitch client ID"); + } + + const normalizedToken = normalizeToken(tokenResolution.token); + + const authProvider = await this.createAuthProvider(account, normalizedToken); + + const client = new ChatClient({ + authProvider, + channels: [account.channel], + rejoinChannelsOnReconnect: true, + requestMembershipEvents: true, + logger: { + minLevel: LogLevel.WARNING, + custom: { + log: (level, message) => { + switch (level) { + case LogLevel.CRITICAL: + this.logger.error(`${message}`); + break; + case LogLevel.ERROR: + this.logger.error(`${message}`); + break; + case LogLevel.WARNING: + this.logger.warn(`${message}`); + break; + case LogLevel.INFO: + this.logger.info(`${message}`); + break; + case LogLevel.DEBUG: + this.logger.debug?.(`${message}`); + break; + case LogLevel.TRACE: + this.logger.debug?.(`${message}`); + break; + } + }, + }, + }, + }); + + this.setupClientHandlers(client, account); + + client.connect(); + + this.clients.set(key, client); + this.logger.info(`Connected to Twitch as ${account.username}`); + + return client; + } + + /** + * Set up message and event handlers for a client + */ + private setupClientHandlers(client: ChatClient, account: TwitchAccountConfig): void { + const key = this.getAccountKey(account); + + // Handle incoming messages + client.onMessage((channelName, _user, messageText, msg) => { + const handler = this.messageHandlers.get(key); + if (handler) { + const normalizedChannel = channelName.startsWith("#") ? channelName.slice(1) : channelName; + const from = `twitch:${msg.userInfo.userName}`; + const preview = messageText.slice(0, 100).replace(/\n/g, "\\n"); + this.logger.debug?.( + `twitch inbound: channel=${normalizedChannel} from=${from} len=${messageText.length} preview="${preview}"`, + ); + + handler({ + username: msg.userInfo.userName, + displayName: msg.userInfo.displayName, + userId: msg.userInfo.userId, + message: messageText, + channel: normalizedChannel, + id: msg.id, + timestamp: new Date(), + isMod: msg.userInfo.isMod, + isOwner: msg.userInfo.isBroadcaster, + isVip: msg.userInfo.isVip, + isSub: msg.userInfo.isSubscriber, + chatType: "group", + }); + } + }); + + this.logger.info(`Set up handlers for ${key}`); + } + + /** + * Set a message handler for an account + * @returns A function that removes the handler when called + */ + onMessage( + account: TwitchAccountConfig, + handler: (message: TwitchChatMessage) => void, + ): () => void { + const key = this.getAccountKey(account); + this.messageHandlers.set(key, handler); + return () => { + this.messageHandlers.delete(key); + }; + } + + /** + * Disconnect a client + */ + async disconnect(account: TwitchAccountConfig): Promise { + const key = this.getAccountKey(account); + const client = this.clients.get(key); + + if (client) { + client.quit(); + this.clients.delete(key); + this.messageHandlers.delete(key); + this.logger.info(`Disconnected ${key}`); + } + } + + /** + * Disconnect all clients + */ + async disconnectAll(): Promise { + this.clients.forEach((client) => client.quit()); + this.clients.clear(); + this.messageHandlers.clear(); + this.logger.info(" Disconnected all clients"); + } + + /** + * Send a message to a channel + */ + async sendMessage( + account: TwitchAccountConfig, + channel: string, + message: string, + cfg?: ClawdbotConfig, + accountId?: string, + ): Promise<{ ok: boolean; error?: string; messageId?: string }> { + try { + const client = await this.getClient(account, cfg, accountId); + + // Generate a message ID (Twurple's say() doesn't return the message ID, so we generate one) + const messageId = crypto.randomUUID(); + + // Send message (Twurple handles rate limiting) + await client.say(channel, message); + + return { ok: true, messageId }; + } catch (error) { + this.logger.error( + `Failed to send message: ${error instanceof Error ? error.message : String(error)}`, + ); + return { + ok: false, + error: error instanceof Error ? error.message : String(error), + }; + } + } + + /** + * Generate a unique key for an account + */ + public getAccountKey(account: TwitchAccountConfig): string { + return `${account.username}:${account.channel}`; + } + + /** + * Clear all clients and handlers (for testing) + */ + _clearForTest(): void { + this.clients.clear(); + this.messageHandlers.clear(); + } +} diff --git a/extensions/twitch/src/types.ts b/extensions/twitch/src/types.ts new file mode 100644 index 000000000..74b2b4acf --- /dev/null +++ b/extensions/twitch/src/types.ts @@ -0,0 +1,141 @@ +/** + * Twitch channel plugin types. + * + * This file defines Twitch-specific types. Generic channel types are imported + * from Clawdbot core. + */ + +import type { + ChannelAccountSnapshot, + ChannelCapabilities, + ChannelLogSink, + ChannelMessageActionAdapter, + ChannelMessageActionContext, + ChannelMeta, +} from "../../../src/channels/plugins/types.core.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import type { + ChannelGatewayContext, + ChannelOutboundAdapter, + ChannelOutboundContext, + ChannelResolveKind, + ChannelResolveResult, + ChannelStatusAdapter, +} from "../../../src/channels/plugins/types.adapters.js"; +import type { ClawdbotConfig } from "../../../src/config/config.js"; +import type { OutboundDeliveryResult } from "../../../src/infra/outbound/deliver.js"; +import type { RuntimeEnv } from "../../../src/runtime.js"; + +// ============================================================================ +// Twitch-Specific Types +// ============================================================================ + +/** + * Twitch user roles that can be allowed to interact with the bot + */ +export type TwitchRole = "moderator" | "owner" | "vip" | "subscriber" | "all"; + +/** + * Account configuration for a Twitch channel + */ +export interface TwitchAccountConfig { + /** Twitch username */ + username: string; + /** Twitch OAuth access token (requires chat:read and chat:write scopes) */ + accessToken: string; + /** Twitch client ID (from Twitch Developer Portal or twitchtokengenerator.com) */ + clientId: string; + /** Channel name to join (required) */ + channel: string; + /** Enable this account */ + enabled?: boolean; + /** Allowlist of Twitch user IDs who can interact with the bot (use IDs for safety, not usernames) */ + allowFrom?: Array; + /** Roles allowed to interact with the bot (e.g., ["mod", "vip", "sub"]) */ + allowedRoles?: TwitchRole[]; + /** Require @mention to trigger bot responses */ + requireMention?: boolean; + /** Twitch client secret (required for token refresh via RefreshingAuthProvider) */ + clientSecret?: string; + /** Refresh token (required for automatic token refresh) */ + refreshToken?: string; + /** Token expiry time in seconds (optional, for token refresh tracking) */ + expiresIn?: number | null; + /** Timestamp when token was obtained (optional, for token refresh tracking) */ + obtainmentTimestamp?: number; +} + +/** + * Message target for Twitch + */ +export interface TwitchTarget { + /** Account ID */ + accountId: string; + /** Channel name (defaults to account's channel) */ + channel?: string; +} + +/** + * Twitch message from chat + */ +export interface TwitchChatMessage { + /** Username of sender */ + username: string; + /** Twitch user ID of sender (unique, persistent identifier) */ + userId?: string; + /** Message text */ + message: string; + /** Channel name */ + channel: string; + /** Display name (may include special characters) */ + displayName?: string; + /** Message ID */ + id?: string; + /** Timestamp */ + timestamp?: Date; + /** Whether the sender is a moderator */ + isMod?: boolean; + /** Whether the sender is the channel owner/broadcaster */ + isOwner?: boolean; + /** Whether the sender is a VIP */ + isVip?: boolean; + /** Whether the sender is a subscriber */ + isSub?: boolean; + /** Chat type */ + chatType?: "group"; +} + +/** + * Send result from Twitch client + */ +export interface SendResult { + ok: boolean; + error?: string; + messageId?: string; +} + +// Re-export core types for convenience +export type { + ChannelAccountSnapshot, + ChannelGatewayContext, + ChannelLogSink, + ChannelMessageActionAdapter, + ChannelMessageActionContext, + ChannelMeta, + ChannelOutboundAdapter, + ChannelStatusAdapter, + ChannelCapabilities, + ChannelResolveKind, + ChannelResolveResult, + ChannelPlugin, + ChannelOutboundContext, + OutboundDeliveryResult, +}; + +// Import and re-export the schema type +import type { TwitchConfigSchema } from "./config-schema.js"; +import type { z } from "zod"; +export type TwitchConfig = z.infer; + +export type { ClawdbotConfig }; +export type { RuntimeEnv }; diff --git a/extensions/twitch/src/utils/markdown.ts b/extensions/twitch/src/utils/markdown.ts new file mode 100644 index 000000000..0fa4a5fdf --- /dev/null +++ b/extensions/twitch/src/utils/markdown.ts @@ -0,0 +1,92 @@ +/** + * Markdown utilities for Twitch chat + * + * Twitch chat doesn't support markdown formatting, so we strip it before sending. + * Based on Clawdbot's markdownToText in src/agents/tools/web-fetch-utils.ts. + */ + +/** + * Strip markdown formatting from text for Twitch compatibility. + * + * Removes images, links, bold, italic, strikethrough, code blocks, inline code, + * headers, and list formatting. Replaces newlines with spaces since Twitch + * is a single-line chat medium. + * + * @param markdown - The markdown text to strip + * @returns Plain text with markdown removed + */ +export function stripMarkdownForTwitch(markdown: string): string { + return ( + markdown + // Images + .replace(/!\[[^\]]*]\([^)]+\)/g, "") + // Links + .replace(/\[([^\]]+)]\([^)]+\)/g, "$1") + // Bold (**text**) + .replace(/\*\*([^*]+)\*\*/g, "$1") + // Bold (__text__) + .replace(/__([^_]+)__/g, "$1") + // Italic (*text*) + .replace(/\*([^*]+)\*/g, "$1") + // Italic (_text_) + .replace(/_([^_]+)_/g, "$1") + // Strikethrough (~~text~~) + .replace(/~~([^~]+)~~/g, "$1") + // Code blocks + .replace(/```[\s\S]*?```/g, (block) => block.replace(/```[^\n]*\n?/g, "").replace(/```/g, "")) + // Inline code + .replace(/`([^`]+)`/g, "$1") + // Headers + .replace(/^#{1,6}\s+/gm, "") + // Lists + .replace(/^\s*[-*+]\s+/gm, "") + .replace(/^\s*\d+\.\s+/gm, "") + // Normalize whitespace + .replace(/\r/g, "") // Remove carriage returns + .replace(/[ \t]+\n/g, "\n") // Remove trailing spaces before newlines + .replace(/\n/g, " ") // Replace newlines with spaces (for Twitch) + .replace(/[ \t]{2,}/g, " ") // Reduce multiple spaces to single + .trim() + ); +} + +/** + * Simple word-boundary chunker for Twitch (500 char limit). + * Strips markdown before chunking to avoid breaking markdown patterns. + * + * @param text - The text to chunk + * @param limit - Maximum characters per chunk (Twitch limit is 500) + * @returns Array of text chunks + */ +export function chunkTextForTwitch(text: string, limit: number): string[] { + // First, strip markdown + const cleaned = stripMarkdownForTwitch(text); + if (!cleaned) return []; + if (limit <= 0) return [cleaned]; + if (cleaned.length <= limit) return [cleaned]; + + const chunks: string[] = []; + let remaining = cleaned; + + while (remaining.length > limit) { + // Find the last space before the limit + const window = remaining.slice(0, limit); + const lastSpaceIndex = window.lastIndexOf(" "); + + if (lastSpaceIndex === -1) { + // No space found, hard split at limit + chunks.push(window); + remaining = remaining.slice(limit); + } else { + // Split at the last space + chunks.push(window.slice(0, lastSpaceIndex)); + remaining = remaining.slice(lastSpaceIndex + 1); + } + } + + if (remaining) { + chunks.push(remaining); + } + + return chunks; +} diff --git a/extensions/twitch/src/utils/twitch.ts b/extensions/twitch/src/utils/twitch.ts new file mode 100644 index 000000000..cb2667cb1 --- /dev/null +++ b/extensions/twitch/src/utils/twitch.ts @@ -0,0 +1,78 @@ +/** + * Twitch-specific utility functions + */ + +/** + * Normalize Twitch channel names. + * + * Removes the '#' prefix if present, converts to lowercase, and trims whitespace. + * Twitch channel names are case-insensitive and don't use the '#' prefix in the API. + * + * @param channel - The channel name to normalize + * @returns Normalized channel name + * + * @example + * normalizeTwitchChannel("#TwitchChannel") // "twitchchannel" + * normalizeTwitchChannel("MyChannel") // "mychannel" + */ +export function normalizeTwitchChannel(channel: string): string { + const trimmed = channel.trim().toLowerCase(); + return trimmed.startsWith("#") ? trimmed.slice(1) : trimmed; +} + +/** + * Create a standardized error message for missing target. + * + * @param provider - The provider name (e.g., "Twitch") + * @param hint - Optional hint for how to fix the issue + * @returns Error object with descriptive message + */ +export function missingTargetError(provider: string, hint?: string): Error { + return new Error(`Delivering to ${provider} requires target${hint ? ` ${hint}` : ""}`); +} + +/** + * Generate a unique message ID for Twitch messages. + * + * Twurple's say() doesn't return the message ID, so we generate one + * for tracking purposes. + * + * @returns A unique message ID + */ +export function generateMessageId(): string { + return `${Date.now()}-${Math.random().toString(36).substring(2, 15)}`; +} + +/** + * Normalize OAuth token by removing the "oauth:" prefix if present. + * + * Twurple doesn't require the "oauth:" prefix, so we strip it for consistency. + * + * @param token - The OAuth token to normalize + * @returns Normalized token without "oauth:" prefix + * + * @example + * normalizeToken("oauth:abc123") // "abc123" + * normalizeToken("abc123") // "abc123" + */ +export function normalizeToken(token: string): string { + return token.startsWith("oauth:") ? token.slice(6) : token; +} + +/** + * Check if an account is properly configured with required credentials. + * + * @param account - The Twitch account config to check + * @returns true if the account has required credentials + */ +export function isAccountConfigured( + account: { + username?: string; + accessToken?: string; + clientId?: string; + }, + resolvedToken?: string | null, +): boolean { + const token = resolvedToken ?? account?.accessToken; + return Boolean(account?.username && token && account?.clientId); +} diff --git a/extensions/twitch/test/setup.ts b/extensions/twitch/test/setup.ts new file mode 100644 index 000000000..fb391c471 --- /dev/null +++ b/extensions/twitch/test/setup.ts @@ -0,0 +1,7 @@ +/** + * Vitest setup file for Twitch plugin tests. + * + * Re-exports the root test setup to avoid duplication. + */ + +export * from "../../../test/setup.js"; diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 14bef9f5c..223537e85 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -172,6 +172,13 @@ importers: zod: specifier: ^4.3.6 version: 4.3.6 + optionalDependencies: + '@napi-rs/canvas': + specifier: ^0.1.88 + version: 0.1.88 + node-llama-cpp: + specifier: 3.15.0 + version: 3.15.0(typescript@5.9.3) devDependencies: '@grammyjs/types': specifier: ^3.23.0 @@ -254,13 +261,6 @@ importers: wireit: specifier: ^0.14.12 version: 0.14.12 - optionalDependencies: - '@napi-rs/canvas': - specifier: ^0.1.88 - version: 0.1.88 - node-llama-cpp: - specifier: 3.15.0 - version: 3.15.0(typescript@5.9.3) extensions/bluebubbles: {} @@ -424,6 +424,25 @@ importers: specifier: ^3.0.0 version: 3.0.0 + extensions/twitch: + dependencies: + '@twurple/api': + specifier: ^8.0.3 + version: 8.0.3(@twurple/auth@8.0.3) + '@twurple/auth': + specifier: ^8.0.3 + version: 8.0.3 + '@twurple/chat': + specifier: ^8.0.3 + version: 8.0.3(@twurple/auth@8.0.3) + zod: + specifier: ^4.3.5 + version: 4.3.6 + devDependencies: + clawdbot: + specifier: workspace:* + version: link:../.. + extensions/voice-call: dependencies: '@sinclair/typebox': @@ -810,6 +829,39 @@ packages: '@cloudflare/workers-types@4.20260120.0': resolution: {integrity: sha512-B8pueG+a5S+mdK3z8oKu1ShcxloZ7qWb68IEyLLaepvdryIbNC7JVPcY0bWsjS56UQVKc5fnyRge3yZIwc9bxw==} + '@d-fischer/cache-decorators@4.0.1': + resolution: {integrity: sha512-HNYLBLWs/t28GFZZeqdIBqq8f37mqDIFO6xNPof94VjpKvuP6ROqCZGafx88dk5zZUlBfViV9jD8iNNlXfc4CA==} + + '@d-fischer/connection@9.0.0': + resolution: {integrity: sha512-Mljp/EbaE+eYWfsFXUOk+RfpbHgrWGL/60JkAvjYixw6KREfi5r17XdUiXe54ByAQox6jwgdN2vebdmW1BT+nQ==} + + '@d-fischer/deprecate@2.0.2': + resolution: {integrity: sha512-wlw3HwEanJFJKctwLzhfOM6LKwR70FPfGZGoKOhWBKyOPXk+3a9Cc6S9zhm6tka7xKtpmfxVIReGUwPnMbIaZg==} + + '@d-fischer/detect-node@3.0.1': + resolution: {integrity: sha512-0Rf3XwTzuTh8+oPZW9SfxTIiL+26RRJ0BRPwj5oVjZFyFKmsj9RGfN2zuTRjOuA3FCK/jYm06HOhwNK+8Pfv8w==} + + '@d-fischer/escape-string-regexp@5.0.0': + resolution: {integrity: sha512-7eoxnxcto5eVPW5h1T+ePnVFukmI9f/ZR9nlBLh1t3kyzJDUNor2C+YW9H/Terw3YnbZSDgDYrpCJCHtOtAQHw==} + engines: {node: '>=10'} + + '@d-fischer/isomorphic-ws@7.0.2': + resolution: {integrity: sha512-xK+qIJUF0ne3dsjq5Y3BviQ4M+gx9dzkN+dPP7abBMje4YRfow+X9jBgeEoTe5e+Q6+8hI9R0b37Okkk8Vf0hQ==} + peerDependencies: + ws: ^8.2.0 + + '@d-fischer/logger@4.2.4': + resolution: {integrity: sha512-TFMZ/SVW8xyQtyJw9Rcuci4betSKy0qbQn2B5+1+72vVXeO8Qb1pYvuwF5qr0vDGundmSWq7W8r19nVPnXXSvA==} + + '@d-fischer/rate-limiter@1.1.0': + resolution: {integrity: sha512-O5HgACwApyCZhp4JTEBEtbv/W3eAwEkrARFvgWnEsDmXgCMWjIHwohWoHre5BW6IYXFSHBGsuZB/EvNL3942kQ==} + + '@d-fischer/shared-utils@3.6.4': + resolution: {integrity: sha512-BPkVLHfn2Lbyo/ENDBwtEB8JVQ+9OzkjJhUunLaxkw4k59YFlQxUUwlDBejVSFcpQT0t+D3CQlX+ySZnQj0wxw==} + + '@d-fischer/typed-event-emitter@3.3.3': + resolution: {integrity: sha512-OvSEOa8icfdWDqcRtjSEZtgJTFOFNgTjje7zaL0+nAtu2/kZtRCSK5wUMrI/aXtCH8o0Qz2vA8UqkhWUTARFQQ==} + '@discordjs/voice@0.19.0': resolution: {integrity: sha512-UyX6rGEXzVyPzb1yvjHtPfTlnLvB5jX/stAMdiytHhfoydX+98hfympdOwsnTktzr+IRvphxTbdErgYDJkEsvw==} engines: {node: '>=22.12.0'} @@ -1264,7 +1316,6 @@ packages: '@lancedb/lancedb@0.23.0': resolution: {integrity: sha512-aYrIoEG24AC+wILCL57Ius/Y4yU+xFHDPKLvmjzzN4byAjzeIGF0TC86S5RBt4Ji+dxS7yIWV5Q/gE5/fybIFQ==} engines: {node: '>= 18'} - cpu: [x64, arm64] os: [darwin, linux, win32] peerDependencies: apache-arrow: '>=15.0.0 <=18.1.0' @@ -2585,6 +2636,25 @@ packages: '@tokenizer/token@0.3.0': resolution: {integrity: sha512-OvjF+z51L3ov0OyAU0duzsYuvO01PH7x4t6DJx+guahgTnBHkhJdG7soQeTSFLWN3efnHyibZ4Z8l2EuWwJN3A==} + '@twurple/api-call@8.0.3': + resolution: {integrity: sha512-/5DBTqFjpYB+qqOkkFzoTWE79a7+I8uLXmBIIIYjGoq/CIPxKcHnlemXlU8cQhTr87PVa3th8zJXGYiNkpRx8w==} + + '@twurple/api@8.0.3': + resolution: {integrity: sha512-vnqVi9YlNDbCqgpUUvTIq4sDitKCY0dkTw9zPluZvRNqUB1eCsuoaRNW96HQDhKtA9P4pRzwZ8xU7v/1KU2ytg==} + peerDependencies: + '@twurple/auth': 8.0.3 + + '@twurple/auth@8.0.3': + resolution: {integrity: sha512-Xlv+WNXmGQir4aBXYeRCqdno5XurA6jzYTIovSEHa7FZf3AMHMFqtzW7yqTCUn4iOahfUSA2TIIxmxFM0wis0g==} + + '@twurple/chat@8.0.3': + resolution: {integrity: sha512-rhm6xhWKp+4zYFimaEj5fPm6lw/yjrAOsGXXSvPDsEqFR+fc0cVXzmHmglTavkmEELRajFiqNBKZjg73JZWhTQ==} + peerDependencies: + '@twurple/auth': 8.0.3 + + '@twurple/common@8.0.3': + resolution: {integrity: sha512-JQ2lb5qSFT21Y9qMfIouAILb94ppedLHASq49Fe/AP8oq0k3IC9Q7tX2n6tiMzGWqn+n8MnONUpMSZ6FhulMXA==} + '@tybys/wasm-util@0.10.1': resolution: {integrity: sha512-9tTaPJLSiejZKx+Bmog4uSubteqTvFrVrURwkmHixBo0G4seD0zUxp98E1DzUBJxLQ3NPwXrGKDiVjwx/DpPsg==} @@ -3775,6 +3845,9 @@ packages: engines: {node: '>=18.0.0'} hasBin: true + ircv3@0.33.0: + resolution: {integrity: sha512-7rK1Aial3LBiFycE8w3MHiBBFb41/2GG2Ll/fR2IJj1vx0pLpn1s+78K+z/I4PZTqCCSp/Sb4QgKMh3NMhx0Kg==} + is-binary-path@2.1.0: resolution: {integrity: sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==} engines: {node: '>=8'} @@ -3944,6 +4017,10 @@ packages: keyv@5.6.0: resolution: {integrity: sha512-CYDD3SOtsHtyXeEORYRx2qBtpDJFjRTGXUtmNEMGyzYOKj1TE3tycdlho7kA1Ufx9OYWZzg52QFBGALTirzDSw==} + klona@2.0.6: + resolution: {integrity: sha512-dhG34DXATL5hSxJbIexCft8FChFXtmskoZYnoPWjXQuebWYCNkVeV3KkGegCK9CP1oswI/vQibS2GY7Em/sJJA==} + engines: {node: '>= 8'} + leac@0.6.0: resolution: {integrity: sha512-y+SqErxb8h7nE/fiEX07jsbuhrpO9lL8eca7/Y1nuWV2moNlXhyd59iDGcRf6moVyDMbmTNzL40SUyrFU/yDpg==} @@ -6383,6 +6460,54 @@ snapshots: '@cloudflare/workers-types@4.20260120.0': optional: true + '@d-fischer/cache-decorators@4.0.1': + dependencies: + '@d-fischer/shared-utils': 3.6.4 + tslib: 2.8.1 + + '@d-fischer/connection@9.0.0': + dependencies: + '@d-fischer/isomorphic-ws': 7.0.2(ws@8.19.0) + '@d-fischer/logger': 4.2.4 + '@d-fischer/shared-utils': 3.6.4 + '@d-fischer/typed-event-emitter': 3.3.3 + '@types/ws': 8.18.1 + tslib: 2.8.1 + ws: 8.19.0 + transitivePeerDependencies: + - bufferutil + - utf-8-validate + + '@d-fischer/deprecate@2.0.2': {} + + '@d-fischer/detect-node@3.0.1': {} + + '@d-fischer/escape-string-regexp@5.0.0': {} + + '@d-fischer/isomorphic-ws@7.0.2(ws@8.19.0)': + dependencies: + ws: 8.19.0 + + '@d-fischer/logger@4.2.4': + dependencies: + '@d-fischer/detect-node': 3.0.1 + '@d-fischer/shared-utils': 3.6.4 + tslib: 2.8.1 + + '@d-fischer/rate-limiter@1.1.0': + dependencies: + '@d-fischer/logger': 4.2.4 + '@d-fischer/shared-utils': 3.6.4 + tslib: 2.8.1 + + '@d-fischer/shared-utils@3.6.4': + dependencies: + tslib: 2.8.1 + + '@d-fischer/typed-event-emitter@3.3.3': + dependencies: + tslib: 2.8.1 + '@discordjs/voice@0.19.0': dependencies: '@types/ws': 8.18.1 @@ -8225,6 +8350,57 @@ snapshots: '@tokenizer/token@0.3.0': {} + '@twurple/api-call@8.0.3': + dependencies: + '@d-fischer/shared-utils': 3.6.4 + '@twurple/common': 8.0.3 + tslib: 2.8.1 + + '@twurple/api@8.0.3(@twurple/auth@8.0.3)': + dependencies: + '@d-fischer/cache-decorators': 4.0.1 + '@d-fischer/detect-node': 3.0.1 + '@d-fischer/logger': 4.2.4 + '@d-fischer/rate-limiter': 1.1.0 + '@d-fischer/shared-utils': 3.6.4 + '@d-fischer/typed-event-emitter': 3.3.3 + '@twurple/api-call': 8.0.3 + '@twurple/auth': 8.0.3 + '@twurple/common': 8.0.3 + retry: 0.13.1 + tslib: 2.8.1 + + '@twurple/auth@8.0.3': + dependencies: + '@d-fischer/logger': 4.2.4 + '@d-fischer/shared-utils': 3.6.4 + '@d-fischer/typed-event-emitter': 3.3.3 + '@twurple/api-call': 8.0.3 + '@twurple/common': 8.0.3 + tslib: 2.8.1 + + '@twurple/chat@8.0.3(@twurple/auth@8.0.3)': + dependencies: + '@d-fischer/cache-decorators': 4.0.1 + '@d-fischer/deprecate': 2.0.2 + '@d-fischer/logger': 4.2.4 + '@d-fischer/rate-limiter': 1.1.0 + '@d-fischer/shared-utils': 3.6.4 + '@d-fischer/typed-event-emitter': 3.3.3 + '@twurple/auth': 8.0.3 + '@twurple/common': 8.0.3 + ircv3: 0.33.0 + tslib: 2.8.1 + transitivePeerDependencies: + - bufferutil + - utf-8-validate + + '@twurple/common@8.0.3': + dependencies: + '@d-fischer/shared-utils': 3.6.4 + klona: 2.0.6 + tslib: 2.8.1 + '@tybys/wasm-util@0.10.1': dependencies: tslib: 2.8.1 @@ -9644,6 +9820,19 @@ snapshots: '@reflink/reflink': 0.1.19 optional: true + ircv3@0.33.0: + dependencies: + '@d-fischer/connection': 9.0.0 + '@d-fischer/escape-string-regexp': 5.0.0 + '@d-fischer/logger': 4.2.4 + '@d-fischer/shared-utils': 3.6.4 + '@d-fischer/typed-event-emitter': 3.3.3 + klona: 2.0.6 + tslib: 2.8.1 + transitivePeerDependencies: + - bufferutil + - utf-8-validate + is-binary-path@2.1.0: dependencies: binary-extensions: 2.3.0 @@ -9814,6 +10003,8 @@ snapshots: dependencies: '@keyv/serialize': 1.1.1 + klona@2.0.6: {} + leac@0.6.0: {} lie@3.3.0: diff --git a/scripts/claude-auth-status.sh b/scripts/claude-auth-status.sh index cf10b197d..d0294d58d 100755 --- a/scripts/claude-auth-status.sh +++ b/scripts/claude-auth-status.sh @@ -54,7 +54,7 @@ calc_status_from_expires() { json_expires_for_claude_cli() { echo "$STATUS_JSON" | jq -r ' [.auth.oauth.profiles[] - | select(.provider == "anthropic" and .type == "oauth" and .source == "claude-cli") + | select(.provider == "anthropic" and (.type == "oauth" or .type == "token")) | .expiresAt // 0] | max // 0 ' 2>/dev/null || echo "0" diff --git a/src/agents/auth-health.ts b/src/agents/auth-health.ts index 96e79dc66..15bf3a07f 100644 --- a/src/agents/auth-health.ts +++ b/src/agents/auth-health.ts @@ -2,12 +2,10 @@ import type { ClawdbotConfig } from "../config/config.js"; import { type AuthProfileCredential, type AuthProfileStore, - CLAUDE_CLI_PROFILE_ID, - CODEX_CLI_PROFILE_ID, resolveAuthProfileDisplayLabel, } from "./auth-profiles.js"; -export type AuthProfileSource = "claude-cli" | "codex-cli" | "store"; +export type AuthProfileSource = "store"; export type AuthProfileHealthStatus = "ok" | "expiring" | "expired" | "missing" | "static"; @@ -41,9 +39,7 @@ export type AuthHealthSummary = { export const DEFAULT_OAUTH_WARN_MS = 24 * 60 * 60 * 1000; -export function resolveAuthProfileSource(profileId: string): AuthProfileSource { - if (profileId === CLAUDE_CLI_PROFILE_ID) return "claude-cli"; - if (profileId === CODEX_CLI_PROFILE_ID) return "codex-cli"; +export function resolveAuthProfileSource(_profileId: string): AuthProfileSource { return "store"; } diff --git a/src/agents/auth-profiles.ensureauthprofilestore.test.ts b/src/agents/auth-profiles.ensureauthprofilestore.test.ts index 3eadb6c5b..db7d6f031 100644 --- a/src/agents/auth-profiles.ensureauthprofilestore.test.ts +++ b/src/agents/auth-profiles.ensureauthprofilestore.test.ts @@ -3,8 +3,7 @@ import os from "node:os"; import path from "node:path"; import { describe, expect, it } from "vitest"; import { ensureAuthProfileStore } from "./auth-profiles.js"; -import { AUTH_STORE_VERSION, CODEX_CLI_PROFILE_ID } from "./auth-profiles/constants.js"; -import { withTempHome } from "../../test/helpers/temp-home.js"; +import { AUTH_STORE_VERSION } from "./auth-profiles/constants.js"; describe("ensureAuthProfileStore", () => { it("migrates legacy auth.json and deletes it (PR #368)", () => { @@ -123,80 +122,4 @@ describe("ensureAuthProfileStore", () => { fs.rmSync(root, { recursive: true, force: true }); } }); - - it("drops codex-cli from merged store when a custom openai-codex profile matches", async () => { - await withTempHome(async (tempHome) => { - const root = fs.mkdtempSync(path.join(os.tmpdir(), "clawdbot-auth-dedup-merge-")); - const previousAgentDir = process.env.CLAWDBOT_AGENT_DIR; - const previousPiAgentDir = process.env.PI_CODING_AGENT_DIR; - try { - const mainDir = path.join(root, "main-agent"); - const agentDir = path.join(root, "agent-x"); - fs.mkdirSync(mainDir, { recursive: true }); - fs.mkdirSync(agentDir, { recursive: true }); - - process.env.CLAWDBOT_AGENT_DIR = mainDir; - process.env.PI_CODING_AGENT_DIR = mainDir; - process.env.HOME = tempHome; - - fs.writeFileSync( - path.join(mainDir, "auth-profiles.json"), - `${JSON.stringify( - { - version: AUTH_STORE_VERSION, - profiles: { - [CODEX_CLI_PROFILE_ID]: { - type: "oauth", - provider: "openai-codex", - access: "shared-access-token", - refresh: "shared-refresh-token", - expires: Date.now() + 3600000, - }, - }, - }, - null, - 2, - )}\n`, - "utf8", - ); - - fs.writeFileSync( - path.join(agentDir, "auth-profiles.json"), - `${JSON.stringify( - { - version: AUTH_STORE_VERSION, - profiles: { - "openai-codex:my-custom-profile": { - type: "oauth", - provider: "openai-codex", - access: "shared-access-token", - refresh: "shared-refresh-token", - expires: Date.now() + 3600000, - }, - }, - }, - null, - 2, - )}\n`, - "utf8", - ); - - const store = ensureAuthProfileStore(agentDir); - expect(store.profiles[CODEX_CLI_PROFILE_ID]).toBeUndefined(); - expect(store.profiles["openai-codex:my-custom-profile"]).toBeDefined(); - } finally { - if (previousAgentDir === undefined) { - delete process.env.CLAWDBOT_AGENT_DIR; - } else { - process.env.CLAWDBOT_AGENT_DIR = previousAgentDir; - } - if (previousPiAgentDir === undefined) { - delete process.env.PI_CODING_AGENT_DIR; - } else { - process.env.PI_CODING_AGENT_DIR = previousPiAgentDir; - } - fs.rmSync(root, { recursive: true, force: true }); - } - }); - }); }); diff --git a/src/agents/auth-profiles.external-cli-credential-sync.does-not-overwrite-api-keys-syncing-external.test.ts b/src/agents/auth-profiles.external-cli-credential-sync.does-not-overwrite-api-keys-syncing-external.test.ts deleted file mode 100644 index 1109d3452..000000000 --- a/src/agents/auth-profiles.external-cli-credential-sync.does-not-overwrite-api-keys-syncing-external.test.ts +++ /dev/null @@ -1,102 +0,0 @@ -import fs from "node:fs"; -import os from "node:os"; -import path from "node:path"; -import { describe, expect, it } from "vitest"; -import { withTempHome } from "../../test/helpers/temp-home.js"; -import { CLAUDE_CLI_PROFILE_ID, ensureAuthProfileStore } from "./auth-profiles.js"; - -describe("external CLI credential sync", () => { - it("does not overwrite API keys when syncing external CLI creds", async () => { - const agentDir = fs.mkdtempSync(path.join(os.tmpdir(), "clawdbot-no-overwrite-")); - try { - await withTempHome( - async (tempHome) => { - // Create Claude Code CLI credentials - const claudeDir = path.join(tempHome, ".claude"); - fs.mkdirSync(claudeDir, { recursive: true }); - const claudeCreds = { - claudeAiOauth: { - accessToken: "cli-access", - refreshToken: "cli-refresh", - expiresAt: Date.now() + 30 * 60 * 1000, - }, - }; - fs.writeFileSync(path.join(claudeDir, ".credentials.json"), JSON.stringify(claudeCreds)); - - // Create auth-profiles.json with an API key - const authPath = path.join(agentDir, "auth-profiles.json"); - fs.writeFileSync( - authPath, - JSON.stringify({ - version: 1, - profiles: { - "anthropic:default": { - type: "api_key", - provider: "anthropic", - key: "sk-store", - }, - }, - }), - ); - - const store = ensureAuthProfileStore(agentDir); - - // Should keep the store's API key and still add the CLI profile. - expect((store.profiles["anthropic:default"] as { key: string }).key).toBe("sk-store"); - expect(store.profiles[CLAUDE_CLI_PROFILE_ID]).toBeDefined(); - }, - { prefix: "clawdbot-home-" }, - ); - } finally { - fs.rmSync(agentDir, { recursive: true, force: true }); - } - }); - it("prefers oauth over token even if token has later expiry (oauth enables auto-refresh)", async () => { - const agentDir = fs.mkdtempSync(path.join(os.tmpdir(), "clawdbot-cli-oauth-preferred-")); - try { - await withTempHome( - async (tempHome) => { - const claudeDir = path.join(tempHome, ".claude"); - fs.mkdirSync(claudeDir, { recursive: true }); - // CLI has OAuth credentials (with refresh token) expiring in 30 min - fs.writeFileSync( - path.join(claudeDir, ".credentials.json"), - JSON.stringify({ - claudeAiOauth: { - accessToken: "cli-oauth-access", - refreshToken: "cli-refresh", - expiresAt: Date.now() + 30 * 60 * 1000, - }, - }), - ); - - const authPath = path.join(agentDir, "auth-profiles.json"); - // Store has token credentials expiring in 60 min (later than CLI) - fs.writeFileSync( - authPath, - JSON.stringify({ - version: 1, - profiles: { - [CLAUDE_CLI_PROFILE_ID]: { - type: "token", - provider: "anthropic", - token: "store-token-access", - expires: Date.now() + 60 * 60 * 1000, - }, - }, - }), - ); - - const store = ensureAuthProfileStore(agentDir); - // OAuth should be preferred over token because it can auto-refresh - const cliProfile = store.profiles[CLAUDE_CLI_PROFILE_ID]; - expect(cliProfile.type).toBe("oauth"); - expect((cliProfile as { access: string }).access).toBe("cli-oauth-access"); - }, - { prefix: "clawdbot-home-" }, - ); - } finally { - fs.rmSync(agentDir, { recursive: true, force: true }); - } - }); -}); diff --git a/src/agents/auth-profiles.external-cli-credential-sync.does-not-overwrite-fresher-store-oauth-older.test.ts b/src/agents/auth-profiles.external-cli-credential-sync.does-not-overwrite-fresher-store-oauth-older.test.ts deleted file mode 100644 index 3ca83a576..000000000 --- a/src/agents/auth-profiles.external-cli-credential-sync.does-not-overwrite-fresher-store-oauth-older.test.ts +++ /dev/null @@ -1,106 +0,0 @@ -import fs from "node:fs"; -import os from "node:os"; -import path from "node:path"; -import { describe, expect, it } from "vitest"; -import { withTempHome } from "../../test/helpers/temp-home.js"; -import { CLAUDE_CLI_PROFILE_ID, ensureAuthProfileStore } from "./auth-profiles.js"; - -describe("external CLI credential sync", () => { - it("does not overwrite fresher store oauth with older CLI oauth", async () => { - const agentDir = fs.mkdtempSync(path.join(os.tmpdir(), "clawdbot-cli-oauth-no-downgrade-")); - try { - await withTempHome( - async (tempHome) => { - const claudeDir = path.join(tempHome, ".claude"); - fs.mkdirSync(claudeDir, { recursive: true }); - // CLI has OAuth credentials expiring in 30 min - fs.writeFileSync( - path.join(claudeDir, ".credentials.json"), - JSON.stringify({ - claudeAiOauth: { - accessToken: "cli-oauth-access", - refreshToken: "cli-refresh", - expiresAt: Date.now() + 30 * 60 * 1000, - }, - }), - ); - - const authPath = path.join(agentDir, "auth-profiles.json"); - // Store has OAuth credentials expiring in 60 min (later than CLI) - fs.writeFileSync( - authPath, - JSON.stringify({ - version: 1, - profiles: { - [CLAUDE_CLI_PROFILE_ID]: { - type: "oauth", - provider: "anthropic", - access: "store-oauth-access", - refresh: "store-refresh", - expires: Date.now() + 60 * 60 * 1000, - }, - }, - }), - ); - - const store = ensureAuthProfileStore(agentDir); - // Fresher store oauth should be kept - const cliProfile = store.profiles[CLAUDE_CLI_PROFILE_ID]; - expect(cliProfile.type).toBe("oauth"); - expect((cliProfile as { access: string }).access).toBe("store-oauth-access"); - }, - { prefix: "clawdbot-home-" }, - ); - } finally { - fs.rmSync(agentDir, { recursive: true, force: true }); - } - }); - it("does not downgrade store oauth to token when CLI lacks refresh token", async () => { - const agentDir = fs.mkdtempSync(path.join(os.tmpdir(), "clawdbot-cli-no-downgrade-oauth-")); - try { - await withTempHome( - async (tempHome) => { - const claudeDir = path.join(tempHome, ".claude"); - fs.mkdirSync(claudeDir, { recursive: true }); - // CLI has token-only credentials (no refresh token) - fs.writeFileSync( - path.join(claudeDir, ".credentials.json"), - JSON.stringify({ - claudeAiOauth: { - accessToken: "cli-token-access", - expiresAt: Date.now() + 30 * 60 * 1000, - }, - }), - ); - - const authPath = path.join(agentDir, "auth-profiles.json"); - // Store already has OAuth credentials with refresh token - fs.writeFileSync( - authPath, - JSON.stringify({ - version: 1, - profiles: { - [CLAUDE_CLI_PROFILE_ID]: { - type: "oauth", - provider: "anthropic", - access: "store-oauth-access", - refresh: "store-refresh", - expires: Date.now() + 60 * 60 * 1000, - }, - }, - }), - ); - - const store = ensureAuthProfileStore(agentDir); - // Keep oauth to preserve auto-refresh capability - const cliProfile = store.profiles[CLAUDE_CLI_PROFILE_ID]; - expect(cliProfile.type).toBe("oauth"); - expect((cliProfile as { access: string }).access).toBe("store-oauth-access"); - }, - { prefix: "clawdbot-home-" }, - ); - } finally { - fs.rmSync(agentDir, { recursive: true, force: true }); - } - }); -}); diff --git a/src/agents/auth-profiles.external-cli-credential-sync.skips-codex-sync-when-credentials-exist-in-another-profile.test.ts b/src/agents/auth-profiles.external-cli-credential-sync.skips-codex-sync-when-credentials-exist-in-another-profile.test.ts deleted file mode 100644 index 6fa6734d7..000000000 --- a/src/agents/auth-profiles.external-cli-credential-sync.skips-codex-sync-when-credentials-exist-in-another-profile.test.ts +++ /dev/null @@ -1,166 +0,0 @@ -import fs from "node:fs"; -import os from "node:os"; -import path from "node:path"; -import { describe, expect, it } from "vitest"; -import { withTempHome } from "../../test/helpers/temp-home.js"; -import { CODEX_CLI_PROFILE_ID, ensureAuthProfileStore } from "./auth-profiles.js"; - -describe("external CLI credential sync", () => { - it("skips codex-cli sync when credentials already exist in another openai-codex profile", async () => { - const agentDir = fs.mkdtempSync(path.join(os.tmpdir(), "clawdbot-codex-dedup-skip-")); - try { - await withTempHome( - async (tempHome) => { - const codexDir = path.join(tempHome, ".codex"); - fs.mkdirSync(codexDir, { recursive: true }); - const codexAuthPath = path.join(codexDir, "auth.json"); - fs.writeFileSync( - codexAuthPath, - JSON.stringify({ - tokens: { - access_token: "shared-access-token", - refresh_token: "shared-refresh-token", - }, - }), - ); - fs.utimesSync(codexAuthPath, new Date(), new Date()); - - const authPath = path.join(agentDir, "auth-profiles.json"); - fs.writeFileSync( - authPath, - JSON.stringify({ - version: 1, - profiles: { - "openai-codex:my-custom-profile": { - type: "oauth", - provider: "openai-codex", - access: "shared-access-token", - refresh: "shared-refresh-token", - expires: Date.now() + 3600000, - }, - }, - }), - ); - - const store = ensureAuthProfileStore(agentDir); - - expect(store.profiles[CODEX_CLI_PROFILE_ID]).toBeUndefined(); - expect(store.profiles["openai-codex:my-custom-profile"]).toBeDefined(); - }, - { prefix: "clawdbot-home-" }, - ); - } finally { - fs.rmSync(agentDir, { recursive: true, force: true }); - } - }); - - it("creates codex-cli profile when credentials differ from existing openai-codex profiles", async () => { - const agentDir = fs.mkdtempSync(path.join(os.tmpdir(), "clawdbot-codex-dedup-create-")); - try { - await withTempHome( - async (tempHome) => { - const codexDir = path.join(tempHome, ".codex"); - fs.mkdirSync(codexDir, { recursive: true }); - const codexAuthPath = path.join(codexDir, "auth.json"); - fs.writeFileSync( - codexAuthPath, - JSON.stringify({ - tokens: { - access_token: "unique-access-token", - refresh_token: "unique-refresh-token", - }, - }), - ); - fs.utimesSync(codexAuthPath, new Date(), new Date()); - - const authPath = path.join(agentDir, "auth-profiles.json"); - fs.writeFileSync( - authPath, - JSON.stringify({ - version: 1, - profiles: { - "openai-codex:my-custom-profile": { - type: "oauth", - provider: "openai-codex", - access: "different-access-token", - refresh: "different-refresh-token", - expires: Date.now() + 3600000, - }, - }, - }), - ); - - const store = ensureAuthProfileStore(agentDir); - - expect(store.profiles[CODEX_CLI_PROFILE_ID]).toBeDefined(); - expect((store.profiles[CODEX_CLI_PROFILE_ID] as { access: string }).access).toBe( - "unique-access-token", - ); - expect(store.profiles["openai-codex:my-custom-profile"]).toBeDefined(); - }, - { prefix: "clawdbot-home-" }, - ); - } finally { - fs.rmSync(agentDir, { recursive: true, force: true }); - } - }); - - it("removes codex-cli profile when it duplicates another openai-codex profile", async () => { - const agentDir = fs.mkdtempSync(path.join(os.tmpdir(), "clawdbot-codex-dedup-remove-")); - try { - await withTempHome( - async (tempHome) => { - const codexDir = path.join(tempHome, ".codex"); - fs.mkdirSync(codexDir, { recursive: true }); - const codexAuthPath = path.join(codexDir, "auth.json"); - fs.writeFileSync( - codexAuthPath, - JSON.stringify({ - tokens: { - access_token: "shared-access-token", - refresh_token: "shared-refresh-token", - }, - }), - ); - fs.utimesSync(codexAuthPath, new Date(), new Date()); - - const authPath = path.join(agentDir, "auth-profiles.json"); - fs.writeFileSync( - authPath, - JSON.stringify({ - version: 1, - profiles: { - [CODEX_CLI_PROFILE_ID]: { - type: "oauth", - provider: "openai-codex", - access: "shared-access-token", - refresh: "shared-refresh-token", - expires: Date.now() + 3600000, - }, - "openai-codex:my-custom-profile": { - type: "oauth", - provider: "openai-codex", - access: "shared-access-token", - refresh: "shared-refresh-token", - expires: Date.now() + 3600000, - }, - }, - }), - ); - - const store = ensureAuthProfileStore(agentDir); - - expect(store.profiles[CODEX_CLI_PROFILE_ID]).toBeUndefined(); - const saved = JSON.parse(fs.readFileSync(authPath, "utf8")) as { - profiles?: Record; - }; - expect(saved.profiles?.[CODEX_CLI_PROFILE_ID]).toBeUndefined(); - expect(saved.profiles?.["openai-codex:my-custom-profile"]).toBeDefined(); - }, - { prefix: "clawdbot-home-" }, - ); - } finally { - fs.rmSync(agentDir, { recursive: true, force: true }); - } - }); -}); diff --git a/src/agents/auth-profiles.external-cli-credential-sync.syncs-claude-cli-oauth-credentials-into-anthropic.test.ts b/src/agents/auth-profiles.external-cli-credential-sync.syncs-claude-cli-oauth-credentials-into-anthropic.test.ts deleted file mode 100644 index 1295552ba..000000000 --- a/src/agents/auth-profiles.external-cli-credential-sync.syncs-claude-cli-oauth-credentials-into-anthropic.test.ts +++ /dev/null @@ -1,96 +0,0 @@ -import fs from "node:fs"; -import os from "node:os"; -import path from "node:path"; -import { describe, expect, it } from "vitest"; -import { withTempHome } from "../../test/helpers/temp-home.js"; -import { CLAUDE_CLI_PROFILE_ID, ensureAuthProfileStore } from "./auth-profiles.js"; - -describe("external CLI credential sync", () => { - it("syncs Claude Code CLI OAuth credentials into anthropic:claude-cli", async () => { - const agentDir = fs.mkdtempSync(path.join(os.tmpdir(), "clawdbot-cli-sync-")); - try { - // Create a temp home with Claude Code CLI credentials - await withTempHome( - async (tempHome) => { - // Create Claude Code CLI credentials with refreshToken (OAuth) - const claudeDir = path.join(tempHome, ".claude"); - fs.mkdirSync(claudeDir, { recursive: true }); - const claudeCreds = { - claudeAiOauth: { - accessToken: "fresh-access-token", - refreshToken: "fresh-refresh-token", - expiresAt: Date.now() + 60 * 60 * 1000, // 1 hour from now - }, - }; - fs.writeFileSync(path.join(claudeDir, ".credentials.json"), JSON.stringify(claudeCreds)); - - // Create empty auth-profiles.json - const authPath = path.join(agentDir, "auth-profiles.json"); - fs.writeFileSync( - authPath, - JSON.stringify({ - version: 1, - profiles: { - "anthropic:default": { - type: "api_key", - provider: "anthropic", - key: "sk-default", - }, - }, - }), - ); - - // Load the store - should sync from CLI as OAuth credential - const store = ensureAuthProfileStore(agentDir); - - expect(store.profiles["anthropic:default"]).toBeDefined(); - expect((store.profiles["anthropic:default"] as { key: string }).key).toBe("sk-default"); - expect(store.profiles[CLAUDE_CLI_PROFILE_ID]).toBeDefined(); - // Should be stored as OAuth credential (type: "oauth") for auto-refresh - const cliProfile = store.profiles[CLAUDE_CLI_PROFILE_ID]; - expect(cliProfile.type).toBe("oauth"); - expect((cliProfile as { access: string }).access).toBe("fresh-access-token"); - expect((cliProfile as { refresh: string }).refresh).toBe("fresh-refresh-token"); - expect((cliProfile as { expires: number }).expires).toBeGreaterThan(Date.now()); - }, - { prefix: "clawdbot-home-" }, - ); - } finally { - fs.rmSync(agentDir, { recursive: true, force: true }); - } - }); - it("syncs Claude Code CLI credentials without refreshToken as token type", async () => { - const agentDir = fs.mkdtempSync(path.join(os.tmpdir(), "clawdbot-cli-token-sync-")); - try { - await withTempHome( - async (tempHome) => { - // Create Claude Code CLI credentials WITHOUT refreshToken (fallback to token type) - const claudeDir = path.join(tempHome, ".claude"); - fs.mkdirSync(claudeDir, { recursive: true }); - const claudeCreds = { - claudeAiOauth: { - accessToken: "access-only-token", - // No refreshToken - backward compatibility scenario - expiresAt: Date.now() + 60 * 60 * 1000, - }, - }; - fs.writeFileSync(path.join(claudeDir, ".credentials.json"), JSON.stringify(claudeCreds)); - - const authPath = path.join(agentDir, "auth-profiles.json"); - fs.writeFileSync(authPath, JSON.stringify({ version: 1, profiles: {} })); - - const store = ensureAuthProfileStore(agentDir); - - expect(store.profiles[CLAUDE_CLI_PROFILE_ID]).toBeDefined(); - // Should be stored as token type (no refresh capability) - const cliProfile = store.profiles[CLAUDE_CLI_PROFILE_ID]; - expect(cliProfile.type).toBe("token"); - expect((cliProfile as { token: string }).token).toBe("access-only-token"); - }, - { prefix: "clawdbot-home-" }, - ); - } finally { - fs.rmSync(agentDir, { recursive: true, force: true }); - } - }); -}); diff --git a/src/agents/auth-profiles.external-cli-credential-sync.updates-codex-cli-profile-codex-cli-refresh.test.ts b/src/agents/auth-profiles.external-cli-credential-sync.updates-codex-cli-profile-codex-cli-refresh.test.ts deleted file mode 100644 index 16fe775ab..000000000 --- a/src/agents/auth-profiles.external-cli-credential-sync.updates-codex-cli-profile-codex-cli-refresh.test.ts +++ /dev/null @@ -1,56 +0,0 @@ -import fs from "node:fs"; -import os from "node:os"; -import path from "node:path"; -import { describe, expect, it } from "vitest"; -import { withTempHome } from "../../test/helpers/temp-home.js"; -import { CODEX_CLI_PROFILE_ID, ensureAuthProfileStore } from "./auth-profiles.js"; - -describe("external CLI credential sync", () => { - it("updates codex-cli profile when Codex CLI refresh token changes", async () => { - const agentDir = fs.mkdtempSync(path.join(os.tmpdir(), "clawdbot-codex-refresh-sync-")); - try { - await withTempHome( - async (tempHome) => { - const codexDir = path.join(tempHome, ".codex"); - fs.mkdirSync(codexDir, { recursive: true }); - const codexAuthPath = path.join(codexDir, "auth.json"); - fs.writeFileSync( - codexAuthPath, - JSON.stringify({ - tokens: { - access_token: "same-access", - refresh_token: "new-refresh", - }, - }), - ); - fs.utimesSync(codexAuthPath, new Date(), new Date()); - - const authPath = path.join(agentDir, "auth-profiles.json"); - fs.writeFileSync( - authPath, - JSON.stringify({ - version: 1, - profiles: { - [CODEX_CLI_PROFILE_ID]: { - type: "oauth", - provider: "openai-codex", - access: "same-access", - refresh: "old-refresh", - expires: Date.now() - 1000, - }, - }, - }), - ); - - const store = ensureAuthProfileStore(agentDir); - expect((store.profiles[CODEX_CLI_PROFILE_ID] as { refresh: string }).refresh).toBe( - "new-refresh", - ); - }, - { prefix: "clawdbot-home-" }, - ); - } finally { - fs.rmSync(agentDir, { recursive: true, force: true }); - } - }); -}); diff --git a/src/agents/auth-profiles.external-cli-credential-sync.upgrades-token-oauth-claude-cli-gets-refreshtoken.test.ts b/src/agents/auth-profiles.external-cli-credential-sync.upgrades-token-oauth-claude-cli-gets-refreshtoken.test.ts deleted file mode 100644 index 2957215f6..000000000 --- a/src/agents/auth-profiles.external-cli-credential-sync.upgrades-token-oauth-claude-cli-gets-refreshtoken.test.ts +++ /dev/null @@ -1,103 +0,0 @@ -import fs from "node:fs"; -import os from "node:os"; -import path from "node:path"; -import { describe, expect, it } from "vitest"; -import { withTempHome } from "../../test/helpers/temp-home.js"; -import { - CLAUDE_CLI_PROFILE_ID, - CODEX_CLI_PROFILE_ID, - ensureAuthProfileStore, -} from "./auth-profiles.js"; - -describe("external CLI credential sync", () => { - it("upgrades token to oauth when Claude Code CLI gets refreshToken", async () => { - const agentDir = fs.mkdtempSync(path.join(os.tmpdir(), "clawdbot-cli-upgrade-")); - try { - await withTempHome( - async (tempHome) => { - // Create Claude Code CLI credentials with refreshToken - const claudeDir = path.join(tempHome, ".claude"); - fs.mkdirSync(claudeDir, { recursive: true }); - fs.writeFileSync( - path.join(claudeDir, ".credentials.json"), - JSON.stringify({ - claudeAiOauth: { - accessToken: "new-oauth-access", - refreshToken: "new-refresh-token", - expiresAt: Date.now() + 60 * 60 * 1000, - }, - }), - ); - - // Create auth-profiles.json with existing token type credential - const authPath = path.join(agentDir, "auth-profiles.json"); - fs.writeFileSync( - authPath, - JSON.stringify({ - version: 1, - profiles: { - [CLAUDE_CLI_PROFILE_ID]: { - type: "token", - provider: "anthropic", - token: "old-token", - expires: Date.now() + 30 * 60 * 1000, - }, - }, - }), - ); - - const store = ensureAuthProfileStore(agentDir); - - // Should upgrade from token to oauth - const cliProfile = store.profiles[CLAUDE_CLI_PROFILE_ID]; - expect(cliProfile.type).toBe("oauth"); - expect((cliProfile as { access: string }).access).toBe("new-oauth-access"); - expect((cliProfile as { refresh: string }).refresh).toBe("new-refresh-token"); - }, - { prefix: "clawdbot-home-" }, - ); - } finally { - fs.rmSync(agentDir, { recursive: true, force: true }); - } - }); - it("syncs Codex CLI credentials into openai-codex:codex-cli", async () => { - const agentDir = fs.mkdtempSync(path.join(os.tmpdir(), "clawdbot-codex-sync-")); - try { - await withTempHome( - async (tempHome) => { - // Create Codex CLI credentials - const codexDir = path.join(tempHome, ".codex"); - fs.mkdirSync(codexDir, { recursive: true }); - const codexCreds = { - tokens: { - access_token: "codex-access-token", - refresh_token: "codex-refresh-token", - }, - }; - const codexAuthPath = path.join(codexDir, "auth.json"); - fs.writeFileSync(codexAuthPath, JSON.stringify(codexCreds)); - - // Create empty auth-profiles.json - const authPath = path.join(agentDir, "auth-profiles.json"); - fs.writeFileSync( - authPath, - JSON.stringify({ - version: 1, - profiles: {}, - }), - ); - - const store = ensureAuthProfileStore(agentDir); - - expect(store.profiles[CODEX_CLI_PROFILE_ID]).toBeDefined(); - expect((store.profiles[CODEX_CLI_PROFILE_ID] as { access: string }).access).toBe( - "codex-access-token", - ); - }, - { prefix: "clawdbot-home-" }, - ); - } finally { - fs.rmSync(agentDir, { recursive: true, force: true }); - } - }); -}); diff --git a/src/agents/auth-profiles/external-cli-sync.ts b/src/agents/auth-profiles/external-cli-sync.ts index 8a7d8270f..d1fa31f23 100644 --- a/src/agents/auth-profiles/external-cli-sync.ts +++ b/src/agents/auth-profiles/external-cli-sync.ts @@ -1,22 +1,11 @@ +import { readQwenCliCredentialsCached } from "../cli-credentials.js"; import { - readClaudeCliCredentialsCached, - readCodexCliCredentialsCached, - readQwenCliCredentialsCached, -} from "../cli-credentials.js"; -import { - CLAUDE_CLI_PROFILE_ID, - CODEX_CLI_PROFILE_ID, EXTERNAL_CLI_NEAR_EXPIRY_MS, EXTERNAL_CLI_SYNC_TTL_MS, QWEN_CLI_PROFILE_ID, log, } from "./constants.js"; -import type { - AuthProfileCredential, - AuthProfileStore, - OAuthCredential, - TokenCredential, -} from "./types.js"; +import type { AuthProfileCredential, AuthProfileStore, OAuthCredential } from "./types.js"; function shallowEqualOAuthCredentials(a: OAuthCredential | undefined, b: OAuthCredential): boolean { if (!a) return false; @@ -33,25 +22,10 @@ function shallowEqualOAuthCredentials(a: OAuthCredential | undefined, b: OAuthCr ); } -function shallowEqualTokenCredentials(a: TokenCredential | undefined, b: TokenCredential): boolean { - if (!a) return false; - if (a.type !== "token") return false; - return ( - a.provider === b.provider && - a.token === b.token && - a.expires === b.expires && - a.email === b.email - ); -} - function isExternalProfileFresh(cred: AuthProfileCredential | undefined, now: number): boolean { if (!cred) return false; if (cred.type !== "oauth" && cred.type !== "token") return false; - if ( - cred.provider !== "anthropic" && - cred.provider !== "openai-codex" && - cred.provider !== "qwen-portal" - ) { + if (cred.provider !== "qwen-portal") { return false; } if (typeof cred.expires !== "number") return true; @@ -59,163 +33,14 @@ function isExternalProfileFresh(cred: AuthProfileCredential | undefined, now: nu } /** - * Find any existing openai-codex profile (other than codex-cli) that has the same - * access and refresh tokens. This prevents creating a duplicate codex-cli profile - * when the user has already set up a custom profile with the same credentials. - */ -export function findDuplicateCodexProfile( - store: AuthProfileStore, - creds: OAuthCredential, -): string | undefined { - for (const [profileId, profile] of Object.entries(store.profiles)) { - if (profileId === CODEX_CLI_PROFILE_ID) continue; - if (profile.type !== "oauth") continue; - if (profile.provider !== "openai-codex") continue; - if (profile.access === creds.access && profile.refresh === creds.refresh) { - return profileId; - } - } - return undefined; -} - -/** - * Sync OAuth credentials from external CLI tools (Claude Code CLI, Codex CLI) into the store. - * This allows clawdbot to use the same credentials as these tools without requiring - * separate authentication, and keeps credentials in sync when CLI tools refresh tokens. + * Sync OAuth credentials from external CLI tools (Qwen Code CLI) into the store. * * Returns true if any credentials were updated. */ -export function syncExternalCliCredentials( - store: AuthProfileStore, - options?: { allowKeychainPrompt?: boolean }, -): boolean { +export function syncExternalCliCredentials(store: AuthProfileStore): boolean { let mutated = false; const now = Date.now(); - // Sync from Claude Code CLI (supports both OAuth and Token credentials) - const existingClaude = store.profiles[CLAUDE_CLI_PROFILE_ID]; - const shouldSyncClaude = - !existingClaude || - existingClaude.provider !== "anthropic" || - existingClaude.type === "token" || - !isExternalProfileFresh(existingClaude, now); - const claudeCreds = shouldSyncClaude - ? readClaudeCliCredentialsCached({ - allowKeychainPrompt: options?.allowKeychainPrompt, - ttlMs: EXTERNAL_CLI_SYNC_TTL_MS, - }) - : null; - if (claudeCreds) { - const existing = store.profiles[CLAUDE_CLI_PROFILE_ID]; - const claudeCredsExpires = claudeCreds.expires ?? 0; - - // Determine if we should update based on credential comparison - let shouldUpdate = false; - let isEqual = false; - - if (claudeCreds.type === "oauth") { - const existingOAuth = existing?.type === "oauth" ? existing : undefined; - isEqual = shallowEqualOAuthCredentials(existingOAuth, claudeCreds); - // Update if: no existing profile, type changed to oauth, expired, or CLI has newer token - shouldUpdate = - !existingOAuth || - existingOAuth.provider !== "anthropic" || - existingOAuth.expires <= now || - (claudeCredsExpires > now && claudeCredsExpires > existingOAuth.expires); - } else { - const existingToken = existing?.type === "token" ? existing : undefined; - isEqual = shallowEqualTokenCredentials(existingToken, claudeCreds); - // Update if: no existing profile, expired, or CLI has newer token - shouldUpdate = - !existingToken || - existingToken.provider !== "anthropic" || - (existingToken.expires ?? 0) <= now || - (claudeCredsExpires > now && claudeCredsExpires > (existingToken.expires ?? 0)); - } - - // Also update if credential type changed (token -> oauth upgrade) - if (existing && existing.type !== claudeCreds.type) { - // Prefer oauth over token (enables auto-refresh) - if (claudeCreds.type === "oauth") { - shouldUpdate = true; - isEqual = false; - } - } - - // Avoid downgrading from oauth to token-only credentials. - if (existing?.type === "oauth" && claudeCreds.type === "token") { - shouldUpdate = false; - } - - if (shouldUpdate && !isEqual) { - store.profiles[CLAUDE_CLI_PROFILE_ID] = claudeCreds; - mutated = true; - log.info("synced anthropic credentials from claude cli", { - profileId: CLAUDE_CLI_PROFILE_ID, - type: claudeCreds.type, - expires: - typeof claudeCreds.expires === "number" - ? new Date(claudeCreds.expires).toISOString() - : "unknown", - }); - } - } - - // Sync from Codex CLI - const existingCodex = store.profiles[CODEX_CLI_PROFILE_ID]; - const existingCodexOAuth = existingCodex?.type === "oauth" ? existingCodex : undefined; - const duplicateExistingId = existingCodexOAuth - ? findDuplicateCodexProfile(store, existingCodexOAuth) - : undefined; - if (duplicateExistingId) { - delete store.profiles[CODEX_CLI_PROFILE_ID]; - mutated = true; - log.info("removed codex-cli profile: credentials already exist in another profile", { - existingProfileId: duplicateExistingId, - removedProfileId: CODEX_CLI_PROFILE_ID, - }); - } - const shouldSyncCodex = - !existingCodex || - existingCodex.provider !== "openai-codex" || - !isExternalProfileFresh(existingCodex, now); - const codexCreds = - shouldSyncCodex || duplicateExistingId - ? readCodexCliCredentialsCached({ ttlMs: EXTERNAL_CLI_SYNC_TTL_MS }) - : null; - if (codexCreds) { - const duplicateProfileId = findDuplicateCodexProfile(store, codexCreds); - if (duplicateProfileId) { - if (store.profiles[CODEX_CLI_PROFILE_ID]) { - delete store.profiles[CODEX_CLI_PROFILE_ID]; - mutated = true; - log.info("removed codex-cli profile: credentials already exist in another profile", { - existingProfileId: duplicateProfileId, - removedProfileId: CODEX_CLI_PROFILE_ID, - }); - } - } else { - const existing = store.profiles[CODEX_CLI_PROFILE_ID]; - const existingOAuth = existing?.type === "oauth" ? existing : undefined; - - // Codex creds don't carry expiry; use file mtime heuristic for freshness. - const shouldUpdate = - !existingOAuth || - existingOAuth.provider !== "openai-codex" || - existingOAuth.expires <= now || - codexCreds.expires > existingOAuth.expires; - - if (shouldUpdate && !shallowEqualOAuthCredentials(existingOAuth, codexCreds)) { - store.profiles[CODEX_CLI_PROFILE_ID] = codexCreds; - mutated = true; - log.info("synced openai-codex credentials from codex cli", { - profileId: CODEX_CLI_PROFILE_ID, - expires: new Date(codexCreds.expires).toISOString(), - }); - } - } - } - // Sync from Qwen Code CLI const existingQwen = store.profiles[QWEN_CLI_PROFILE_ID]; const shouldSyncQwen = diff --git a/src/agents/auth-profiles/oauth.ts b/src/agents/auth-profiles/oauth.ts index 8c59a3044..4138cda94 100644 --- a/src/agents/auth-profiles/oauth.ts +++ b/src/agents/auth-profiles/oauth.ts @@ -4,8 +4,7 @@ import lockfile from "proper-lockfile"; import type { ClawdbotConfig } from "../../config/config.js"; import { refreshChutesTokens } from "../chutes-oauth.js"; import { refreshQwenPortalCredentials } from "../../providers/qwen-portal-oauth.js"; -import { writeClaudeCliCredentials } from "../cli-credentials.js"; -import { AUTH_STORE_LOCK_OPTIONS, CLAUDE_CLI_PROFILE_ID } from "./constants.js"; +import { AUTH_STORE_LOCK_OPTIONS } from "./constants.js"; import { formatAuthDoctorHint } from "./doctor.js"; import { ensureAuthStoreFile, resolveAuthStorePath } from "./paths.js"; import { suggestOAuthProfileIdForLegacyDefault } from "./repair.js"; @@ -72,12 +71,6 @@ async function refreshOAuthTokenWithLock(params: { }; saveAuthProfileStore(store, params.agentDir); - // Sync refreshed credentials back to Claude Code CLI if this is the claude-cli profile - // This ensures Claude Code continues to work after ClawdBot refreshes the token - if (params.profileId === CLAUDE_CLI_PROFILE_ID && cred.provider === "anthropic") { - writeClaudeCliCredentials(result.newCredentials); - } - return result; } finally { if (release) { diff --git a/src/agents/auth-profiles/store.ts b/src/agents/auth-profiles/store.ts index 010f0e9b7..ae4a999b9 100644 --- a/src/agents/auth-profiles/store.ts +++ b/src/agents/auth-profiles/store.ts @@ -3,13 +3,8 @@ import type { OAuthCredentials } from "@mariozechner/pi-ai"; import lockfile from "proper-lockfile"; import { resolveOAuthPath } from "../../config/paths.js"; import { loadJsonFile, saveJsonFile } from "../../infra/json-file.js"; -import { - AUTH_STORE_LOCK_OPTIONS, - AUTH_STORE_VERSION, - CODEX_CLI_PROFILE_ID, - log, -} from "./constants.js"; -import { findDuplicateCodexProfile, syncExternalCliCredentials } from "./external-cli-sync.js"; +import { AUTH_STORE_LOCK_OPTIONS, AUTH_STORE_VERSION, log } from "./constants.js"; +import { syncExternalCliCredentials } from "./external-cli-sync.js"; import { ensureAuthStoreFile, resolveAuthStorePath, resolveLegacyAuthStorePath } from "./paths.js"; import type { AuthProfileCredential, AuthProfileStore, ProfileUsageStats } from "./types.js"; @@ -229,14 +224,14 @@ export function loadAuthProfileStore(): AuthProfileStore { function loadAuthProfileStoreForAgent( agentDir?: string, - options?: { allowKeychainPrompt?: boolean }, + _options?: { allowKeychainPrompt?: boolean }, ): AuthProfileStore { const authPath = resolveAuthStorePath(agentDir); const raw = loadJsonFile(authPath); const asStore = coerceAuthStore(raw); if (asStore) { // Sync from external CLI tools on every load - const synced = syncExternalCliCredentials(asStore, options); + const synced = syncExternalCliCredentials(asStore); if (synced) { saveJsonFile(authPath, asStore); } @@ -297,7 +292,7 @@ function loadAuthProfileStoreForAgent( } const mergedOAuth = mergeOAuthFileIntoStore(store); - const syncedCli = syncExternalCliCredentials(store, options); + const syncedCli = syncExternalCliCredentials(store); const shouldWrite = legacy !== null || mergedOAuth || syncedCli; if (shouldWrite) { saveJsonFile(authPath, store); @@ -337,15 +332,6 @@ export function ensureAuthProfileStore( const mainStore = loadAuthProfileStoreForAgent(undefined, options); const merged = mergeAuthProfileStores(mainStore, store); - // Keep per-agent view clean even if the main store has codex-cli. - const codexProfile = merged.profiles[CODEX_CLI_PROFILE_ID]; - if (codexProfile?.type === "oauth") { - const duplicateId = findDuplicateCodexProfile(merged, codexProfile); - if (duplicateId) { - delete merged.profiles[CODEX_CLI_PROFILE_ID]; - } - } - return merged; } diff --git a/src/agents/model-fallback.test.ts b/src/agents/model-fallback.test.ts index c3febd289..8662b0101 100644 --- a/src/agents/model-fallback.test.ts +++ b/src/agents/model-fallback.test.ts @@ -101,7 +101,7 @@ describe("runWithModelFallback", () => { const cfg = makeCfg(); const run = vi .fn() - .mockRejectedValueOnce(new Error('No credentials found for profile "anthropic:claude-cli".')) + .mockRejectedValueOnce(new Error('No credentials found for profile "anthropic:default".')) .mockResolvedValueOnce("ok"); const result = await runWithModelFallback({ diff --git a/src/agents/pi-embedded-helpers.isautherrormessage.test.ts b/src/agents/pi-embedded-helpers.isautherrormessage.test.ts index 160054b11..2c8fd65d0 100644 --- a/src/agents/pi-embedded-helpers.isautherrormessage.test.ts +++ b/src/agents/pi-embedded-helpers.isautherrormessage.test.ts @@ -12,7 +12,7 @@ const _makeFile = (overrides: Partial): WorkspaceBootstr describe("isAuthErrorMessage", () => { it("matches credential validation errors", () => { const samples = [ - 'No credentials found for profile "anthropic:claude-cli".', + 'No credentials found for profile "anthropic:default".', "No API key found for profile openai.", ]; for (const sample of samples) { diff --git a/src/agents/pi-tools.safe-bins.test.ts b/src/agents/pi-tools.safe-bins.test.ts new file mode 100644 index 000000000..43202bbb5 --- /dev/null +++ b/src/agents/pi-tools.safe-bins.test.ts @@ -0,0 +1,78 @@ +import fs from "node:fs"; +import os from "node:os"; +import path from "node:path"; +import { describe, expect, it, vi } from "vitest"; +import type { ClawdbotConfig } from "../config/config.js"; +import type { ExecApprovalsResolved } from "../infra/exec-approvals.js"; +import { createClawdbotCodingTools } from "./pi-tools.js"; + +vi.mock("../infra/exec-approvals.js", async (importOriginal) => { + const mod = await importOriginal(); + const approvals: ExecApprovalsResolved = { + path: "/tmp/exec-approvals.json", + socketPath: "/tmp/exec-approvals.sock", + token: "token", + defaults: { + security: "allowlist", + ask: "off", + askFallback: "deny", + autoAllowSkills: false, + }, + agent: { + security: "allowlist", + ask: "off", + askFallback: "deny", + autoAllowSkills: false, + }, + allowlist: [], + file: { + version: 1, + socket: { path: "/tmp/exec-approvals.sock", token: "token" }, + defaults: { + security: "allowlist", + ask: "off", + askFallback: "deny", + autoAllowSkills: false, + }, + agents: {}, + }, + }; + return { ...mod, resolveExecApprovals: () => approvals }; +}); + +describe("createClawdbotCodingTools safeBins", () => { + it("threads tools.exec.safeBins into exec allowlist checks", async () => { + if (process.platform === "win32") return; + + const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "clawdbot-safe-bins-")); + const cfg: ClawdbotConfig = { + tools: { + exec: { + host: "gateway", + security: "allowlist", + ask: "off", + safeBins: ["echo"], + }, + }, + }; + + const tools = createClawdbotCodingTools({ + config: cfg, + sessionKey: "agent:main:main", + workspaceDir: tmpDir, + agentDir: path.join(tmpDir, "agent"), + }); + const execTool = tools.find((tool) => tool.name === "exec"); + expect(execTool).toBeDefined(); + + const marker = `safe-bins-${Date.now()}`; + const result = await execTool!.execute("call1", { + command: `echo ${marker}`, + workdir: tmpDir, + }); + const text = result.content.find((content) => content.type === "text")?.text ?? ""; + + expect(result.details.status).toBe("completed"); + expect(text).toContain(marker); + }); +}); diff --git a/src/agents/pi-tools.ts b/src/agents/pi-tools.ts index bd745da03..9013f1e52 100644 --- a/src/agents/pi-tools.ts +++ b/src/agents/pi-tools.ts @@ -86,6 +86,7 @@ function resolveExecConfig(cfg: ClawdbotConfig | undefined) { ask: globalExec?.ask, node: globalExec?.node, pathPrepend: globalExec?.pathPrepend, + safeBins: globalExec?.safeBins, backgroundMs: globalExec?.backgroundMs, timeoutSec: globalExec?.timeoutSec, approvalRunningNoticeMs: globalExec?.approvalRunningNoticeMs, @@ -235,6 +236,7 @@ export function createClawdbotCodingTools(options?: { ask: options?.exec?.ask ?? execConfig.ask, node: options?.exec?.node ?? execConfig.node, pathPrepend: options?.exec?.pathPrepend ?? execConfig.pathPrepend, + safeBins: options?.exec?.safeBins ?? execConfig.safeBins, agentId, cwd: options?.workspaceDir, allowBackground, diff --git a/src/agents/workspace.test.ts b/src/agents/workspace.test.ts index 8c4f5a0de..ff589a193 100644 --- a/src/agents/workspace.test.ts +++ b/src/agents/workspace.test.ts @@ -1,152 +1,49 @@ -import fs from "node:fs/promises"; -import os from "node:os"; -import path from "node:path"; import { describe, expect, it } from "vitest"; -import { runCommandWithTimeout } from "../process/exec.js"; -import type { WorkspaceBootstrapFile } from "./workspace.js"; + import { - DEFAULT_AGENTS_FILENAME, - DEFAULT_BOOTSTRAP_FILENAME, - DEFAULT_HEARTBEAT_FILENAME, - DEFAULT_IDENTITY_FILENAME, - DEFAULT_SOUL_FILENAME, - DEFAULT_TOOLS_FILENAME, - DEFAULT_USER_FILENAME, - ensureAgentWorkspace, - filterBootstrapFilesForSession, + DEFAULT_MEMORY_ALT_FILENAME, + DEFAULT_MEMORY_FILENAME, + loadWorkspaceBootstrapFiles, } from "./workspace.js"; +import { makeTempWorkspace, writeWorkspaceFile } from "../test-helpers/workspace.js"; -describe("ensureAgentWorkspace", () => { - it("creates directory and bootstrap files when missing", async () => { - const dir = await fs.mkdtemp(path.join(os.tmpdir(), "clawdbot-ws-")); - const nested = path.join(dir, "nested"); - const result = await ensureAgentWorkspace({ - dir: nested, - ensureBootstrapFiles: true, - }); - expect(result.dir).toBe(path.resolve(nested)); - expect(result.agentsPath).toBe(path.join(path.resolve(nested), "AGENTS.md")); - expect(result.agentsPath).toBeDefined(); - if (!result.agentsPath) throw new Error("agentsPath missing"); - const content = await fs.readFile(result.agentsPath, "utf-8"); - expect(content).toContain("# AGENTS.md"); +describe("loadWorkspaceBootstrapFiles", () => { + it("includes MEMORY.md when present", async () => { + const tempDir = await makeTempWorkspace("clawdbot-workspace-"); + await writeWorkspaceFile({ dir: tempDir, name: "MEMORY.md", content: "memory" }); - const identity = path.join(path.resolve(nested), "IDENTITY.md"); - const user = path.join(path.resolve(nested), "USER.md"); - const heartbeat = path.join(path.resolve(nested), "HEARTBEAT.md"); - const bootstrap = path.join(path.resolve(nested), "BOOTSTRAP.md"); - await expect(fs.stat(identity)).resolves.toBeDefined(); - await expect(fs.stat(user)).resolves.toBeDefined(); - await expect(fs.stat(heartbeat)).resolves.toBeDefined(); - await expect(fs.stat(bootstrap)).resolves.toBeDefined(); + const files = await loadWorkspaceBootstrapFiles(tempDir); + const memoryEntries = files.filter((file) => + [DEFAULT_MEMORY_FILENAME, DEFAULT_MEMORY_ALT_FILENAME].includes(file.name), + ); + + expect(memoryEntries).toHaveLength(1); + expect(memoryEntries[0]?.missing).toBe(false); + expect(memoryEntries[0]?.content).toBe("memory"); }); - it("initializes a git repo for brand-new workspaces when git is available", async () => { - const dir = await fs.mkdtemp(path.join(os.tmpdir(), "clawdbot-ws-")); - const nested = path.join(dir, "nested"); - const gitAvailable = await runCommandWithTimeout(["git", "--version"], { timeoutMs: 2_000 }) - .then((res) => res.code === 0) - .catch(() => false); - if (!gitAvailable) return; + it("includes memory.md when MEMORY.md is absent", async () => { + const tempDir = await makeTempWorkspace("clawdbot-workspace-"); + await writeWorkspaceFile({ dir: tempDir, name: "memory.md", content: "alt" }); - await ensureAgentWorkspace({ - dir: nested, - ensureBootstrapFiles: true, - }); + const files = await loadWorkspaceBootstrapFiles(tempDir); + const memoryEntries = files.filter((file) => + [DEFAULT_MEMORY_FILENAME, DEFAULT_MEMORY_ALT_FILENAME].includes(file.name), + ); - await expect(fs.stat(path.join(nested, ".git"))).resolves.toBeDefined(); + expect(memoryEntries).toHaveLength(1); + expect(memoryEntries[0]?.missing).toBe(false); + expect(memoryEntries[0]?.content).toBe("alt"); }); - it("does not initialize git when workspace already exists", async () => { - const dir = await fs.mkdtemp(path.join(os.tmpdir(), "clawdbot-ws-")); - await fs.writeFile(path.join(dir, "AGENTS.md"), "custom", "utf-8"); + it("omits memory entries when no memory files exist", async () => { + const tempDir = await makeTempWorkspace("clawdbot-workspace-"); - await ensureAgentWorkspace({ - dir, - ensureBootstrapFiles: true, - }); + const files = await loadWorkspaceBootstrapFiles(tempDir); + const memoryEntries = files.filter((file) => + [DEFAULT_MEMORY_FILENAME, DEFAULT_MEMORY_ALT_FILENAME].includes(file.name), + ); - await expect(fs.stat(path.join(dir, ".git"))).rejects.toBeDefined(); - }); - - it("does not overwrite existing AGENTS.md", async () => { - const dir = await fs.mkdtemp(path.join(os.tmpdir(), "clawdbot-ws-")); - const agentsPath = path.join(dir, "AGENTS.md"); - await fs.writeFile(agentsPath, "custom", "utf-8"); - await ensureAgentWorkspace({ dir, ensureBootstrapFiles: true }); - expect(await fs.readFile(agentsPath, "utf-8")).toBe("custom"); - }); - - it("does not recreate BOOTSTRAP.md once workspace exists", async () => { - const dir = await fs.mkdtemp(path.join(os.tmpdir(), "clawdbot-ws-")); - const agentsPath = path.join(dir, "AGENTS.md"); - const bootstrapPath = path.join(dir, "BOOTSTRAP.md"); - - await fs.writeFile(agentsPath, "custom", "utf-8"); - await fs.rm(bootstrapPath, { force: true }); - - await ensureAgentWorkspace({ dir, ensureBootstrapFiles: true }); - - await expect(fs.stat(bootstrapPath)).rejects.toBeDefined(); - }); -}); - -describe("filterBootstrapFilesForSession", () => { - const files: WorkspaceBootstrapFile[] = [ - { - name: DEFAULT_AGENTS_FILENAME, - path: "/tmp/AGENTS.md", - content: "agents", - missing: false, - }, - { - name: DEFAULT_SOUL_FILENAME, - path: "/tmp/SOUL.md", - content: "soul", - missing: false, - }, - { - name: DEFAULT_TOOLS_FILENAME, - path: "/tmp/TOOLS.md", - content: "tools", - missing: false, - }, - { - name: DEFAULT_IDENTITY_FILENAME, - path: "/tmp/IDENTITY.md", - content: "identity", - missing: false, - }, - { - name: DEFAULT_USER_FILENAME, - path: "/tmp/USER.md", - content: "user", - missing: false, - }, - { - name: DEFAULT_HEARTBEAT_FILENAME, - path: "/tmp/HEARTBEAT.md", - content: "heartbeat", - missing: false, - }, - { - name: DEFAULT_BOOTSTRAP_FILENAME, - path: "/tmp/BOOTSTRAP.md", - content: "bootstrap", - missing: false, - }, - ]; - - it("keeps full bootstrap set for non-subagent sessions", () => { - const result = filterBootstrapFilesForSession(files, "agent:main:session:abc"); - expect(result.map((file) => file.name)).toEqual(files.map((file) => file.name)); - }); - - it("limits bootstrap files for subagent sessions", () => { - const result = filterBootstrapFilesForSession(files, "agent:main:subagent:abc"); - expect(result.map((file) => file.name)).toEqual([ - DEFAULT_AGENTS_FILENAME, - DEFAULT_TOOLS_FILENAME, - ]); + expect(memoryEntries).toHaveLength(0); }); }); diff --git a/src/agents/workspace.ts b/src/agents/workspace.ts index 6732069a9..8692977eb 100644 --- a/src/agents/workspace.ts +++ b/src/agents/workspace.ts @@ -26,6 +26,8 @@ export const DEFAULT_IDENTITY_FILENAME = "IDENTITY.md"; export const DEFAULT_USER_FILENAME = "USER.md"; export const DEFAULT_HEARTBEAT_FILENAME = "HEARTBEAT.md"; export const DEFAULT_BOOTSTRAP_FILENAME = "BOOTSTRAP.md"; +export const DEFAULT_MEMORY_FILENAME = "MEMORY.md"; +export const DEFAULT_MEMORY_ALT_FILENAME = "memory.md"; const TEMPLATE_DIR = path.resolve( path.dirname(fileURLToPath(import.meta.url)), @@ -61,7 +63,9 @@ export type WorkspaceBootstrapFileName = | typeof DEFAULT_IDENTITY_FILENAME | typeof DEFAULT_USER_FILENAME | typeof DEFAULT_HEARTBEAT_FILENAME - | typeof DEFAULT_BOOTSTRAP_FILENAME; + | typeof DEFAULT_BOOTSTRAP_FILENAME + | typeof DEFAULT_MEMORY_FILENAME + | typeof DEFAULT_MEMORY_ALT_FILENAME; export type WorkspaceBootstrapFile = { name: WorkspaceBootstrapFileName; @@ -184,6 +188,39 @@ export async function ensureAgentWorkspace(params?: { }; } +async function resolveMemoryBootstrapEntries(resolvedDir: string): Promise< + Array<{ name: WorkspaceBootstrapFileName; filePath: string }> +> { + const candidates: WorkspaceBootstrapFileName[] = [ + DEFAULT_MEMORY_FILENAME, + DEFAULT_MEMORY_ALT_FILENAME, + ]; + const entries: Array<{ name: WorkspaceBootstrapFileName; filePath: string }> = []; + for (const name of candidates) { + const filePath = path.join(resolvedDir, name); + try { + await fs.access(filePath); + entries.push({ name, filePath }); + } catch { + // optional + } + } + if (entries.length <= 1) return entries; + + const seen = new Set(); + const deduped: Array<{ name: WorkspaceBootstrapFileName; filePath: string }> = []; + for (const entry of entries) { + let key = entry.filePath; + try { + key = await fs.realpath(entry.filePath); + } catch {} + if (seen.has(key)) continue; + seen.add(key); + deduped.push(entry); + } + return deduped; +} + export async function loadWorkspaceBootstrapFiles(dir: string): Promise { const resolvedDir = resolveUserPath(dir); @@ -221,6 +258,8 @@ export async function loadWorkspaceBootstrapFiles(dir: string): Promise", "Provider id (e.g. anthropic)") .option("--agent ", "Agent id (default: configured default agent)") - .argument("", "Auth profile ids (e.g. anthropic:claude-cli)") + .argument("", "Auth profile ids (e.g. anthropic:default)") .action(async (profileIds: string[], opts) => { await runModelsCommand(async () => { await modelsAuthOrderSetCommand( diff --git a/src/cli/program/register.onboard.ts b/src/cli/program/register.onboard.ts index ee9d5ccd2..eac6a60df 100644 --- a/src/cli/program/register.onboard.ts +++ b/src/cli/program/register.onboard.ts @@ -52,7 +52,7 @@ export function registerOnboardCommand(program: Command) { .option("--mode ", "Wizard mode: local|remote") .option( "--auth-choice ", - "Auth: setup-token|claude-cli|token|chutes|openai-codex|openai-api-key|openrouter-api-key|ai-gateway-api-key|moonshot-api-key|kimi-code-api-key|synthetic-api-key|venice-api-key|codex-cli|gemini-api-key|zai-api-key|apiKey|minimax-api|minimax-api-lightning|opencode-zen|skip", + "Auth: setup-token|token|chutes|openai-codex|openai-api-key|openrouter-api-key|ai-gateway-api-key|moonshot-api-key|kimi-code-api-key|synthetic-api-key|venice-api-key|gemini-api-key|zai-api-key|apiKey|minimax-api|minimax-api-lightning|opencode-zen|skip", ) .option( "--token-provider ", @@ -78,7 +78,7 @@ export function registerOnboardCommand(program: Command) { .option("--opencode-zen-api-key ", "OpenCode Zen API key") .option("--gateway-port ", "Gateway port") .option("--gateway-bind ", "Gateway bind: loopback|tailnet|lan|auto|custom") - .option("--gateway-auth ", "Gateway auth: off|token|password") + .option("--gateway-auth ", "Gateway auth: token|password") .option("--gateway-token ", "Gateway token (token auth)") .option("--gateway-password ", "Gateway password (password auth)") .option("--remote-url ", "Remote Gateway WebSocket URL") diff --git a/src/cli/security-cli.ts b/src/cli/security-cli.ts index 42bca4ca4..2bd5a36b7 100644 --- a/src/cli/security-cli.ts +++ b/src/cli/security-cli.ts @@ -87,16 +87,23 @@ export function registerSecurityCli(program: Command) { lines.push(muted(` ${shortenHomeInString(change)}`)); } for (const action of fixResult.actions) { - const mode = action.mode.toString(8).padStart(3, "0"); - if (action.ok) lines.push(muted(` chmod ${mode} ${shortenHomePath(action.path)}`)); - else if (action.skipped) - lines.push( - muted(` skip chmod ${mode} ${shortenHomePath(action.path)} (${action.skipped})`), - ); - else if (action.error) - lines.push( - muted(` chmod ${mode} ${shortenHomePath(action.path)} failed: ${action.error}`), - ); + if (action.kind === "chmod") { + const mode = action.mode.toString(8).padStart(3, "0"); + if (action.ok) lines.push(muted(` chmod ${mode} ${shortenHomePath(action.path)}`)); + else if (action.skipped) + lines.push( + muted(` skip chmod ${mode} ${shortenHomePath(action.path)} (${action.skipped})`), + ); + else if (action.error) + lines.push( + muted(` chmod ${mode} ${shortenHomePath(action.path)} failed: ${action.error}`), + ); + continue; + } + const command = shortenHomeInString(action.command); + if (action.ok) lines.push(muted(` ${command}`)); + else if (action.skipped) lines.push(muted(` skip ${command} (${action.skipped})`)); + else if (action.error) lines.push(muted(` ${command} failed: ${action.error}`)); } if (fixResult.errors.length > 0) { for (const err of fixResult.errors) { diff --git a/src/commands/agents.commands.add.ts b/src/commands/agents.commands.add.ts index c8a6a3e0a..53b8ba049 100644 --- a/src/commands/agents.commands.add.ts +++ b/src/commands/agents.commands.add.ts @@ -258,7 +258,6 @@ export async function agentsAddCommand( prompter, store: authStore, includeSkip: true, - includeClaudeCliIfMissing: true, }); const authResult = await applyAuthChoice({ diff --git a/src/commands/auth-choice-options.test.ts b/src/commands/auth-choice-options.test.ts index db529761f..7bf917a27 100644 --- a/src/commands/auth-choice-options.test.ts +++ b/src/commands/auth-choice-options.test.ts @@ -1,6 +1,6 @@ import { describe, expect, it } from "vitest"; -import { type AuthProfileStore, CLAUDE_CLI_PROFILE_ID } from "../agents/auth-profiles.js"; +import type { AuthProfileStore } from "../agents/auth-profiles.js"; import { buildAuthChoiceOptions } from "./auth-choice-options.js"; describe("buildAuthChoiceOptions", () => { @@ -9,60 +9,18 @@ describe("buildAuthChoiceOptions", () => { const options = buildAuthChoiceOptions({ store, includeSkip: false, - includeClaudeCliIfMissing: false, - platform: "linux", }); expect(options.find((opt) => opt.value === "github-copilot")).toBeDefined(); }); - it("includes Claude Code CLI option on macOS even when missing", () => { + it("includes setup-token option for Anthropic", () => { const store: AuthProfileStore = { version: 1, profiles: {} }; const options = buildAuthChoiceOptions({ store, includeSkip: false, - includeClaudeCliIfMissing: true, - platform: "darwin", }); - const claudeCli = options.find((opt) => opt.value === "claude-cli"); - expect(claudeCli).toBeDefined(); - expect(claudeCli?.hint).toBe("reuses existing Claude Code auth · requires Keychain access"); - }); - - it("skips missing Claude Code CLI option off macOS", () => { - const store: AuthProfileStore = { version: 1, profiles: {} }; - const options = buildAuthChoiceOptions({ - store, - includeSkip: false, - includeClaudeCliIfMissing: true, - platform: "linux", - }); - - expect(options.find((opt) => opt.value === "claude-cli")).toBeUndefined(); - }); - - it("uses token hint when Claude Code CLI credentials exist", () => { - const store: AuthProfileStore = { - version: 1, - profiles: { - [CLAUDE_CLI_PROFILE_ID]: { - type: "token", - provider: "anthropic", - token: "token", - expires: Date.now() + 60 * 60 * 1000, - }, - }, - }; - - const options = buildAuthChoiceOptions({ - store, - includeSkip: false, - includeClaudeCliIfMissing: true, - platform: "darwin", - }); - - const claudeCli = options.find((opt) => opt.value === "claude-cli"); - expect(claudeCli?.hint).toContain("token ok"); + expect(options.some((opt) => opt.value === "token")).toBe(true); }); it("includes Z.AI (GLM) auth choice", () => { @@ -70,8 +28,6 @@ describe("buildAuthChoiceOptions", () => { const options = buildAuthChoiceOptions({ store, includeSkip: false, - includeClaudeCliIfMissing: true, - platform: "darwin", }); expect(options.some((opt) => opt.value === "zai-api-key")).toBe(true); @@ -82,8 +38,6 @@ describe("buildAuthChoiceOptions", () => { const options = buildAuthChoiceOptions({ store, includeSkip: false, - includeClaudeCliIfMissing: true, - platform: "darwin", }); expect(options.some((opt) => opt.value === "minimax-api")).toBe(true); @@ -95,8 +49,6 @@ describe("buildAuthChoiceOptions", () => { const options = buildAuthChoiceOptions({ store, includeSkip: false, - includeClaudeCliIfMissing: true, - platform: "darwin", }); expect(options.some((opt) => opt.value === "moonshot-api-key")).toBe(true); @@ -108,8 +60,6 @@ describe("buildAuthChoiceOptions", () => { const options = buildAuthChoiceOptions({ store, includeSkip: false, - includeClaudeCliIfMissing: true, - platform: "darwin", }); expect(options.some((opt) => opt.value === "ai-gateway-api-key")).toBe(true); @@ -120,8 +70,6 @@ describe("buildAuthChoiceOptions", () => { const options = buildAuthChoiceOptions({ store, includeSkip: false, - includeClaudeCliIfMissing: true, - platform: "darwin", }); expect(options.some((opt) => opt.value === "synthetic-api-key")).toBe(true); @@ -132,8 +80,6 @@ describe("buildAuthChoiceOptions", () => { const options = buildAuthChoiceOptions({ store, includeSkip: false, - includeClaudeCliIfMissing: true, - platform: "darwin", }); expect(options.some((opt) => opt.value === "chutes")).toBe(true); @@ -144,8 +90,6 @@ describe("buildAuthChoiceOptions", () => { const options = buildAuthChoiceOptions({ store, includeSkip: false, - includeClaudeCliIfMissing: true, - platform: "darwin", }); expect(options.some((opt) => opt.value === "qwen-portal")).toBe(true); diff --git a/src/commands/auth-choice-options.ts b/src/commands/auth-choice-options.ts index f13eef365..6b49ff17b 100644 --- a/src/commands/auth-choice-options.ts +++ b/src/commands/auth-choice-options.ts @@ -1,6 +1,4 @@ import type { AuthProfileStore } from "../agents/auth-profiles.js"; -import { CLAUDE_CLI_PROFILE_ID, CODEX_CLI_PROFILE_ID } from "../agents/auth-profiles.js"; -import { colorize, isRich, theme } from "../terminal/theme.js"; import type { AuthChoice } from "./onboard-types.js"; export type AuthChoiceOption = { @@ -41,13 +39,13 @@ const AUTH_CHOICE_GROUP_DEFS: { value: "openai", label: "OpenAI", hint: "Codex OAuth + API key", - choices: ["codex-cli", "openai-codex", "openai-api-key"], + choices: ["openai-codex", "openai-api-key"], }, { value: "anthropic", label: "Anthropic", - hint: "Claude Code CLI + API key", - choices: ["token", "claude-cli", "apiKey"], + hint: "setup-token + API key", + choices: ["token", "apiKey"], }, { value: "minimax", @@ -117,65 +115,12 @@ const AUTH_CHOICE_GROUP_DEFS: { }, ]; -function formatOAuthHint(expires?: number, opts?: { allowStale?: boolean }): string { - const rich = isRich(); - if (!expires) { - return colorize(rich, theme.muted, "token unavailable"); - } - const now = Date.now(); - const remaining = expires - now; - if (remaining <= 0) { - if (opts?.allowStale) { - return colorize(rich, theme.warn, "token present · refresh on use"); - } - return colorize(rich, theme.error, "token expired"); - } - const minutes = Math.round(remaining / (60 * 1000)); - const duration = - minutes >= 120 - ? `${Math.round(minutes / 60)}h` - : minutes >= 60 - ? "1h" - : `${Math.max(minutes, 1)}m`; - const label = `token ok · expires in ${duration}`; - if (minutes <= 10) { - return colorize(rich, theme.warn, label); - } - return colorize(rich, theme.success, label); -} - export function buildAuthChoiceOptions(params: { store: AuthProfileStore; includeSkip: boolean; - includeClaudeCliIfMissing?: boolean; - platform?: NodeJS.Platform; }): AuthChoiceOption[] { + void params.store; const options: AuthChoiceOption[] = []; - const platform = params.platform ?? process.platform; - - const codexCli = params.store.profiles[CODEX_CLI_PROFILE_ID]; - if (codexCli?.type === "oauth") { - options.push({ - value: "codex-cli", - label: "OpenAI Codex OAuth (Codex CLI)", - hint: formatOAuthHint(codexCli.expires, { allowStale: true }), - }); - } - - const claudeCli = params.store.profiles[CLAUDE_CLI_PROFILE_ID]; - if (claudeCli?.type === "oauth" || claudeCli?.type === "token") { - options.push({ - value: "claude-cli", - label: "Anthropic token (Claude Code CLI)", - hint: `reuses existing Claude Code auth · ${formatOAuthHint(claudeCli.expires)}`, - }); - } else if (params.includeClaudeCliIfMissing && platform === "darwin") { - options.push({ - value: "claude-cli", - label: "Anthropic token (Claude Code CLI)", - hint: "reuses existing Claude Code auth · requires Keychain access", - }); - } options.push({ value: "token", @@ -245,12 +190,7 @@ export function buildAuthChoiceOptions(params: { return options; } -export function buildAuthChoiceGroups(params: { - store: AuthProfileStore; - includeSkip: boolean; - includeClaudeCliIfMissing?: boolean; - platform?: NodeJS.Platform; -}): { +export function buildAuthChoiceGroups(params: { store: AuthProfileStore; includeSkip: boolean }): { groups: AuthChoiceGroup[]; skipOption?: AuthChoiceOption; } { diff --git a/src/commands/auth-choice-prompt.ts b/src/commands/auth-choice-prompt.ts index 82756229e..275fa72c9 100644 --- a/src/commands/auth-choice-prompt.ts +++ b/src/commands/auth-choice-prompt.ts @@ -9,8 +9,6 @@ export async function promptAuthChoiceGrouped(params: { prompter: WizardPrompter; store: AuthProfileStore; includeSkip: boolean; - includeClaudeCliIfMissing?: boolean; - platform?: NodeJS.Platform; }): Promise { const { groups, skipOption } = buildAuthChoiceGroups(params); const availableGroups = groups.filter((group) => group.options.length > 0); diff --git a/src/commands/auth-choice.apply.anthropic.ts b/src/commands/auth-choice.apply.anthropic.ts index c5700663c..b28b8ebee 100644 --- a/src/commands/auth-choice.apply.anthropic.ts +++ b/src/commands/auth-choice.apply.anthropic.ts @@ -1,8 +1,4 @@ -import { - CLAUDE_CLI_PROFILE_ID, - ensureAuthProfileStore, - upsertAuthProfile, -} from "../agents/auth-profiles.js"; +import { upsertAuthProfile } from "../agents/auth-profiles.js"; import { formatApiKeyPreview, normalizeApiKeyInput, @@ -15,153 +11,17 @@ import { applyAuthProfileConfig, setAnthropicApiKey } from "./onboard-auth.js"; export async function applyAuthChoiceAnthropic( params: ApplyAuthChoiceParams, ): Promise { - if (params.authChoice === "claude-cli") { + if ( + params.authChoice === "setup-token" || + params.authChoice === "oauth" || + params.authChoice === "token" + ) { let nextConfig = params.config; - const store = ensureAuthProfileStore(params.agentDir, { - allowKeychainPrompt: false, - }); - const hasClaudeCli = Boolean(store.profiles[CLAUDE_CLI_PROFILE_ID]); - if (!hasClaudeCli && process.platform === "darwin") { - await params.prompter.note( - [ - "macOS will show a Keychain prompt next.", - 'Choose "Always Allow" so the launchd gateway can start without prompts.', - 'If you choose "Allow" or "Deny", each restart will block on a Keychain alert.', - ].join("\n"), - "Claude Code CLI Keychain", - ); - const proceed = await params.prompter.confirm({ - message: "Check Keychain for Claude Code CLI credentials now?", - initialValue: true, - }); - if (!proceed) return { config: nextConfig }; - } - - const storeWithKeychain = hasClaudeCli - ? store - : ensureAuthProfileStore(params.agentDir, { - allowKeychainPrompt: true, - }); - - if (!storeWithKeychain.profiles[CLAUDE_CLI_PROFILE_ID]) { - if (process.stdin.isTTY) { - const runNow = await params.prompter.confirm({ - message: "Run `claude setup-token` now?", - initialValue: true, - }); - if (runNow) { - const res = await (async () => { - const { spawnSync } = await import("node:child_process"); - return spawnSync("claude", ["setup-token"], { stdio: "inherit" }); - })(); - if (res.error) { - await params.prompter.note( - `Failed to run claude: ${String(res.error)}`, - "Claude setup-token", - ); - } - } - } else { - await params.prompter.note( - "`claude setup-token` requires an interactive TTY.", - "Claude setup-token", - ); - } - - const refreshed = ensureAuthProfileStore(params.agentDir, { - allowKeychainPrompt: true, - }); - if (!refreshed.profiles[CLAUDE_CLI_PROFILE_ID]) { - await params.prompter.note( - process.platform === "darwin" - ? 'No Claude Code CLI credentials found in Keychain ("Claude Code-credentials") or ~/.claude/.credentials.json.' - : "No Claude Code CLI credentials found at ~/.claude/.credentials.json.", - "Claude Code CLI OAuth", - ); - return { config: nextConfig }; - } - } - nextConfig = applyAuthProfileConfig(nextConfig, { - profileId: CLAUDE_CLI_PROFILE_ID, - provider: "anthropic", - mode: "oauth", - }); - return { config: nextConfig }; - } - - if (params.authChoice === "setup-token" || params.authChoice === "oauth") { - let nextConfig = params.config; - await params.prompter.note( - [ - "This will run `claude setup-token` to create a long-lived Anthropic token.", - "Requires an interactive TTY and a Claude Pro/Max subscription.", - ].join("\n"), - "Anthropic setup-token", - ); - - if (!process.stdin.isTTY) { - await params.prompter.note( - "`claude setup-token` requires an interactive TTY.", - "Anthropic setup-token", - ); - return { config: nextConfig }; - } - - const proceed = await params.prompter.confirm({ - message: "Run `claude setup-token` now?", - initialValue: true, - }); - if (!proceed) return { config: nextConfig }; - - const res = await (async () => { - const { spawnSync } = await import("node:child_process"); - return spawnSync("claude", ["setup-token"], { stdio: "inherit" }); - })(); - if (res.error) { - await params.prompter.note( - `Failed to run claude: ${String(res.error)}`, - "Anthropic setup-token", - ); - return { config: nextConfig }; - } - if (typeof res.status === "number" && res.status !== 0) { - await params.prompter.note( - `claude setup-token failed (exit ${res.status})`, - "Anthropic setup-token", - ); - return { config: nextConfig }; - } - - const store = ensureAuthProfileStore(params.agentDir, { - allowKeychainPrompt: true, - }); - if (!store.profiles[CLAUDE_CLI_PROFILE_ID]) { - await params.prompter.note( - `No Claude Code CLI credentials found after setup-token. Expected ${CLAUDE_CLI_PROFILE_ID}.`, - "Anthropic setup-token", - ); - return { config: nextConfig }; - } - - nextConfig = applyAuthProfileConfig(nextConfig, { - profileId: CLAUDE_CLI_PROFILE_ID, - provider: "anthropic", - mode: "oauth", - }); - return { config: nextConfig }; - } - - if (params.authChoice === "token") { - let nextConfig = params.config; - const provider = (await params.prompter.select({ - message: "Token provider", - options: [{ value: "anthropic", label: "Anthropic (only supported)" }], - })) as "anthropic"; await params.prompter.note( ["Run `claude setup-token` in your terminal.", "Then paste the generated token below."].join( "\n", ), - "Anthropic token", + "Anthropic setup-token", ); const tokenRaw = await params.prompter.text({ @@ -174,6 +34,7 @@ export async function applyAuthChoiceAnthropic( message: "Token name (blank = default)", placeholder: "default", }); + const provider = "anthropic"; const namedProfileId = buildTokenProfileId({ provider, name: String(profileNameRaw ?? ""), diff --git a/src/commands/auth-choice.apply.openai.ts b/src/commands/auth-choice.apply.openai.ts index 7d96a35a1..947b81181 100644 --- a/src/commands/auth-choice.apply.openai.ts +++ b/src/commands/auth-choice.apply.openai.ts @@ -1,5 +1,4 @@ import { loginOpenAICodex } from "@mariozechner/pi-ai"; -import { CODEX_CLI_PROFILE_ID, ensureAuthProfileStore } from "../agents/auth-profiles.js"; import { resolveEnvApiKey } from "../agents/model-auth.js"; import { upsertSharedEnvVar } from "../infra/env-file.js"; import { isRemoteEnvironment } from "./oauth-env.js"; @@ -146,45 +145,5 @@ export async function applyAuthChoiceOpenAI( return { config: nextConfig, agentModelOverride }; } - if (params.authChoice === "codex-cli") { - let nextConfig = params.config; - let agentModelOverride: string | undefined; - const noteAgentModel = async (model: string) => { - if (!params.agentId) return; - await params.prompter.note( - `Default model set to ${model} for agent "${params.agentId}".`, - "Model configured", - ); - }; - - const store = ensureAuthProfileStore(params.agentDir); - if (!store.profiles[CODEX_CLI_PROFILE_ID]) { - await params.prompter.note( - "No Codex CLI credentials found at ~/.codex/auth.json.", - "Codex CLI OAuth", - ); - return { config: nextConfig, agentModelOverride }; - } - nextConfig = applyAuthProfileConfig(nextConfig, { - profileId: CODEX_CLI_PROFILE_ID, - provider: "openai-codex", - mode: "oauth", - }); - if (params.setDefaultModel) { - const applied = applyOpenAICodexModelDefault(nextConfig); - nextConfig = applied.next; - if (applied.changed) { - await params.prompter.note( - `Default model set to ${OPENAI_CODEX_DEFAULT_MODEL}`, - "Model configured", - ); - } - } else { - agentModelOverride = OPENAI_CODEX_DEFAULT_MODEL; - await noteAgentModel(OPENAI_CODEX_DEFAULT_MODEL); - } - return { config: nextConfig, agentModelOverride }; - } - return null; } diff --git a/src/commands/channels.adds-non-default-telegram-account.test.ts b/src/commands/channels.adds-non-default-telegram-account.test.ts index d03be6a51..3b1204c3b 100644 --- a/src/commands/channels.adds-non-default-telegram-account.test.ts +++ b/src/commands/channels.adds-non-default-telegram-account.test.ts @@ -244,7 +244,7 @@ describe("channels command", () => { authMocks.loadAuthProfileStore.mockReturnValue({ version: 1, profiles: { - "anthropic:claude-cli": { + "anthropic:default": { type: "oauth", provider: "anthropic", access: "token", @@ -252,7 +252,7 @@ describe("channels command", () => { expires: 0, created: 0, }, - "openai-codex:codex-cli": { + "openai-codex:default": { type: "oauth", provider: "openai", access: "token", @@ -268,8 +268,8 @@ describe("channels command", () => { auth?: Array<{ id: string }>; }; const ids = payload.auth?.map((entry) => entry.id) ?? []; - expect(ids).toContain("anthropic:claude-cli"); - expect(ids).toContain("openai-codex:codex-cli"); + expect(ids).toContain("anthropic:default"); + expect(ids).toContain("openai-codex:default"); }); it("stores default account names in accounts when multiple accounts exist", async () => { diff --git a/src/commands/channels/list.ts b/src/commands/channels/list.ts index 93571312f..bd707e4e0 100644 --- a/src/commands/channels/list.ts +++ b/src/commands/channels/list.ts @@ -1,8 +1,4 @@ -import { - CLAUDE_CLI_PROFILE_ID, - CODEX_CLI_PROFILE_ID, - loadAuthProfileStore, -} from "../../agents/auth-profiles.js"; +import { loadAuthProfileStore } from "../../agents/auth-profiles.js"; import { listChannelPlugins } from "../../channels/plugins/index.js"; import { buildChannelAccountSnapshot } from "../../channels/plugins/status.js"; import type { ChannelAccountSnapshot, ChannelPlugin } from "../../channels/plugins/types.js"; @@ -115,7 +111,7 @@ export async function channelsListCommand( id: profileId, provider: profile.provider, type: profile.type, - isExternal: profileId === CLAUDE_CLI_PROFILE_ID || profileId === CODEX_CLI_PROFILE_ID, + isExternal: false, })); if (opts.json) { const usage = includeUsage ? await loadProviderUsageSummary() : undefined; diff --git a/src/commands/configure.gateway-auth.test.ts b/src/commands/configure.gateway-auth.test.ts index 69faad450..26a3729f2 100644 --- a/src/commands/configure.gateway-auth.test.ts +++ b/src/commands/configure.gateway-auth.test.ts @@ -3,26 +3,18 @@ import { describe, expect, it } from "vitest"; import { buildGatewayAuthConfig } from "./configure.js"; describe("buildGatewayAuthConfig", () => { - it("clears token/password when auth is off", () => { - const result = buildGatewayAuthConfig({ - existing: { mode: "token", token: "abc", password: "secret" }, - mode: "off", - }); - - expect(result).toBeUndefined(); - }); - - it("preserves allowTailscale when auth is off", () => { + it("preserves allowTailscale when switching to token", () => { const result = buildGatewayAuthConfig({ existing: { - mode: "token", - token: "abc", + mode: "password", + password: "secret", allowTailscale: true, }, - mode: "off", + mode: "token", + token: "abc", }); - expect(result).toEqual({ allowTailscale: true }); + expect(result).toEqual({ mode: "token", token: "abc", allowTailscale: true }); }); it("drops password when switching to token", () => { diff --git a/src/commands/configure.gateway-auth.ts b/src/commands/configure.gateway-auth.ts index ad9406195..d60453a98 100644 --- a/src/commands/configure.gateway-auth.ts +++ b/src/commands/configure.gateway-auth.ts @@ -12,7 +12,7 @@ import { promptModelAllowlist, } from "./model-picker.js"; -type GatewayAuthChoice = "off" | "token" | "password"; +type GatewayAuthChoice = "token" | "password"; const ANTHROPIC_OAUTH_MODEL_KEYS = [ "anthropic/claude-opus-4-5", @@ -30,9 +30,6 @@ export function buildGatewayAuthConfig(params: { const base: GatewayAuthConfig = {}; if (typeof allowTailscale === "boolean") base.allowTailscale = allowTailscale; - if (params.mode === "off") { - return Object.keys(base).length > 0 ? base : undefined; - } if (params.mode === "token") { return { ...base, mode: "token", token: params.token }; } @@ -50,7 +47,6 @@ export async function promptAuthConfig( allowKeychainPrompt: false, }), includeSkip: true, - includeClaudeCliIfMissing: true, }); let next = cfg; @@ -77,10 +73,7 @@ export async function promptAuthConfig( } const anthropicOAuth = - authChoice === "claude-cli" || - authChoice === "setup-token" || - authChoice === "token" || - authChoice === "oauth"; + authChoice === "setup-token" || authChoice === "token" || authChoice === "oauth"; const allowlistSelection = await promptModelAllowlist({ config: next, diff --git a/src/commands/configure.gateway.ts b/src/commands/configure.gateway.ts index ba44c3dcf..d572e54a9 100644 --- a/src/commands/configure.gateway.ts +++ b/src/commands/configure.gateway.ts @@ -7,7 +7,7 @@ import { buildGatewayAuthConfig } from "./configure.gateway-auth.js"; import { confirm, select, text } from "./configure.shared.js"; import { guardCancel, randomToken } from "./onboard-helpers.js"; -type GatewayAuthChoice = "off" | "token" | "password"; +type GatewayAuthChoice = "token" | "password"; export async function promptGatewayConfig( cfg: ClawdbotConfig, @@ -91,11 +91,6 @@ export async function promptGatewayConfig( await select({ message: "Gateway auth", options: [ - { - value: "off", - label: "Off (loopback only)", - hint: "Not recommended unless you fully trust local processes", - }, { value: "token", label: "Token", hint: "Recommended default" }, { value: "password", label: "Password" }, ], @@ -165,11 +160,6 @@ export async function promptGatewayConfig( bind = "loopback"; } - if (authMode === "off" && bind !== "loopback") { - note("Non-loopback bind requires auth. Switching to token auth.", "Note"); - authMode = "token"; - } - if (tailscaleMode === "funnel" && authMode !== "password") { note("Tailscale funnel requires password auth.", "Note"); authMode = "password"; diff --git a/src/commands/doctor-auth.deprecated-cli-profiles.test.ts b/src/commands/doctor-auth.deprecated-cli-profiles.test.ts new file mode 100644 index 000000000..b7a50374b --- /dev/null +++ b/src/commands/doctor-auth.deprecated-cli-profiles.test.ts @@ -0,0 +1,109 @@ +import fs from "node:fs"; +import os from "node:os"; +import path from "node:path"; + +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; + +import { maybeRemoveDeprecatedCliAuthProfiles } from "./doctor-auth.js"; +import type { DoctorPrompter } from "./doctor-prompter.js"; + +let originalAgentDir: string | undefined; +let originalPiAgentDir: string | undefined; +let tempAgentDir: string | undefined; + +function makePrompter(confirmValue: boolean): DoctorPrompter { + return { + confirm: vi.fn().mockResolvedValue(confirmValue), + confirmRepair: vi.fn().mockResolvedValue(confirmValue), + confirmAggressive: vi.fn().mockResolvedValue(confirmValue), + confirmSkipInNonInteractive: vi.fn().mockResolvedValue(confirmValue), + select: vi.fn().mockResolvedValue(""), + shouldRepair: confirmValue, + shouldForce: false, + }; +} + +beforeEach(() => { + originalAgentDir = process.env.CLAWDBOT_AGENT_DIR; + originalPiAgentDir = process.env.PI_CODING_AGENT_DIR; + tempAgentDir = fs.mkdtempSync(path.join(os.tmpdir(), "clawdbot-auth-")); + process.env.CLAWDBOT_AGENT_DIR = tempAgentDir; + process.env.PI_CODING_AGENT_DIR = tempAgentDir; +}); + +afterEach(() => { + if (originalAgentDir === undefined) { + delete process.env.CLAWDBOT_AGENT_DIR; + } else { + process.env.CLAWDBOT_AGENT_DIR = originalAgentDir; + } + if (originalPiAgentDir === undefined) { + delete process.env.PI_CODING_AGENT_DIR; + } else { + process.env.PI_CODING_AGENT_DIR = originalPiAgentDir; + } + if (tempAgentDir) { + fs.rmSync(tempAgentDir, { recursive: true, force: true }); + tempAgentDir = undefined; + } +}); + +describe("maybeRemoveDeprecatedCliAuthProfiles", () => { + it("removes deprecated CLI auth profiles from store + config", async () => { + if (!tempAgentDir) throw new Error("Missing temp agent dir"); + const authPath = path.join(tempAgentDir, "auth-profiles.json"); + fs.writeFileSync( + authPath, + `${JSON.stringify( + { + version: 1, + profiles: { + "anthropic:claude-cli": { + type: "oauth", + provider: "anthropic", + access: "token-a", + refresh: "token-r", + expires: Date.now() + 60_000, + }, + "openai-codex:codex-cli": { + type: "oauth", + provider: "openai-codex", + access: "token-b", + refresh: "token-r2", + expires: Date.now() + 60_000, + }, + }, + }, + null, + 2, + )}\n`, + "utf8", + ); + + const cfg = { + auth: { + profiles: { + "anthropic:claude-cli": { provider: "anthropic", mode: "oauth" }, + "openai-codex:codex-cli": { provider: "openai-codex", mode: "oauth" }, + }, + order: { + anthropic: ["anthropic:claude-cli"], + "openai-codex": ["openai-codex:codex-cli"], + }, + }, + } as const; + + const next = await maybeRemoveDeprecatedCliAuthProfiles(cfg, makePrompter(true)); + + const raw = JSON.parse(fs.readFileSync(authPath, "utf8")) as { + profiles?: Record; + }; + expect(raw.profiles?.["anthropic:claude-cli"]).toBeUndefined(); + expect(raw.profiles?.["openai-codex:codex-cli"]).toBeUndefined(); + + expect(next.auth?.profiles?.["anthropic:claude-cli"]).toBeUndefined(); + expect(next.auth?.profiles?.["openai-codex:codex-cli"]).toBeUndefined(); + expect(next.auth?.order?.anthropic).toBeUndefined(); + expect(next.auth?.order?.["openai-codex"]).toBeUndefined(); + }); +}); diff --git a/src/commands/doctor-auth.ts b/src/commands/doctor-auth.ts index 7fc17e28f..4ef6f7a0e 100644 --- a/src/commands/doctor-auth.ts +++ b/src/commands/doctor-auth.ts @@ -11,6 +11,7 @@ import { resolveApiKeyForProfile, resolveProfileUnusableUntilForDisplay, } from "../agents/auth-profiles.js"; +import { updateAuthProfileStoreWithLock } from "../agents/auth-profiles/store.js"; import type { ClawdbotConfig } from "../config/config.js"; import { note } from "../terminal/note.js"; import { formatCliCommand } from "../cli/command-format.js"; @@ -38,6 +39,148 @@ export async function maybeRepairAnthropicOAuthProfileId( return repair.config; } +function pruneAuthOrder( + order: Record | undefined, + profileIds: Set, +): { next: Record | undefined; changed: boolean } { + if (!order) return { next: order, changed: false }; + let changed = false; + const next: Record = {}; + for (const [provider, list] of Object.entries(order)) { + const filtered = list.filter((id) => !profileIds.has(id)); + if (filtered.length !== list.length) changed = true; + if (filtered.length > 0) next[provider] = filtered; + } + return { next: Object.keys(next).length > 0 ? next : undefined, changed }; +} + +function pruneAuthProfiles( + cfg: ClawdbotConfig, + profileIds: Set, +): { next: ClawdbotConfig; changed: boolean } { + const profiles = cfg.auth?.profiles; + const order = cfg.auth?.order; + const nextProfiles = profiles ? { ...profiles } : undefined; + let changed = false; + + if (nextProfiles) { + for (const id of profileIds) { + if (id in nextProfiles) { + delete nextProfiles[id]; + changed = true; + } + } + } + + const prunedOrder = pruneAuthOrder(order, profileIds); + if (prunedOrder.changed) changed = true; + + if (!changed) return { next: cfg, changed: false }; + + const nextAuth = + nextProfiles || prunedOrder.next + ? { + ...cfg.auth, + profiles: nextProfiles && Object.keys(nextProfiles).length > 0 ? nextProfiles : undefined, + order: prunedOrder.next, + } + : undefined; + + return { + next: { + ...cfg, + auth: nextAuth, + }, + changed: true, + }; +} + +export async function maybeRemoveDeprecatedCliAuthProfiles( + cfg: ClawdbotConfig, + prompter: DoctorPrompter, +): Promise { + const store = ensureAuthProfileStore(undefined, { allowKeychainPrompt: false }); + const deprecated = new Set(); + if (store.profiles[CLAUDE_CLI_PROFILE_ID] || cfg.auth?.profiles?.[CLAUDE_CLI_PROFILE_ID]) { + deprecated.add(CLAUDE_CLI_PROFILE_ID); + } + if (store.profiles[CODEX_CLI_PROFILE_ID] || cfg.auth?.profiles?.[CODEX_CLI_PROFILE_ID]) { + deprecated.add(CODEX_CLI_PROFILE_ID); + } + + if (deprecated.size === 0) return cfg; + + const lines = ["Deprecated external CLI auth profiles detected (no longer supported):"]; + if (deprecated.has(CLAUDE_CLI_PROFILE_ID)) { + lines.push( + `- ${CLAUDE_CLI_PROFILE_ID} (Anthropic): use setup-token → ${formatCliCommand("clawdbot models auth setup-token")}`, + ); + } + if (deprecated.has(CODEX_CLI_PROFILE_ID)) { + lines.push( + `- ${CODEX_CLI_PROFILE_ID} (OpenAI Codex): use OAuth → ${formatCliCommand( + "clawdbot models auth login --provider openai-codex", + )}`, + ); + } + note(lines.join("\n"), "Auth profiles"); + + const shouldRemove = await prompter.confirmRepair({ + message: "Remove deprecated CLI auth profiles now?", + initialValue: true, + }); + if (!shouldRemove) return cfg; + + await updateAuthProfileStoreWithLock({ + updater: (nextStore) => { + let mutated = false; + for (const id of deprecated) { + if (nextStore.profiles[id]) { + delete nextStore.profiles[id]; + mutated = true; + } + if (nextStore.usageStats?.[id]) { + delete nextStore.usageStats[id]; + mutated = true; + } + } + if (nextStore.order) { + for (const [provider, list] of Object.entries(nextStore.order)) { + const filtered = list.filter((id) => !deprecated.has(id)); + if (filtered.length !== list.length) { + mutated = true; + if (filtered.length > 0) { + nextStore.order[provider] = filtered; + } else { + delete nextStore.order[provider]; + } + } + } + } + if (nextStore.lastGood) { + for (const [provider, profileId] of Object.entries(nextStore.lastGood)) { + if (deprecated.has(profileId)) { + delete nextStore.lastGood[provider]; + mutated = true; + } + } + } + return mutated; + }, + }); + + const pruned = pruneAuthProfiles(cfg, deprecated); + if (pruned.changed) { + note( + Array.from(deprecated.values()) + .map((id) => `- removed ${id} from config`) + .join("\n"), + "Doctor changes", + ); + } + return pruned.next; +} + type AuthIssue = { profileId: string; provider: string; @@ -47,10 +190,14 @@ type AuthIssue = { function formatAuthIssueHint(issue: AuthIssue): string | null { if (issue.provider === "anthropic" && issue.profileId === CLAUDE_CLI_PROFILE_ID) { - return "Run `claude setup-token` on the gateway host."; + return `Deprecated profile. Use ${formatCliCommand("clawdbot models auth setup-token")} or ${formatCliCommand( + "clawdbot configure", + )}.`; } if (issue.provider === "openai-codex" && issue.profileId === CODEX_CLI_PROFILE_ID) { - return `Run \`codex login\` (or \`${formatCliCommand("clawdbot configure")}\` → OpenAI Codex OAuth).`; + return `Deprecated profile. Use ${formatCliCommand( + "clawdbot models auth login --provider openai-codex", + )} or ${formatCliCommand("clawdbot configure")}.`; } return `Re-auth via \`${formatCliCommand("clawdbot configure")}\` or \`${formatCliCommand("clawdbot onboard")}\`.`; } diff --git a/src/commands/doctor.ts b/src/commands/doctor.ts index aa4f4d7a3..658504ecc 100644 --- a/src/commands/doctor.ts +++ b/src/commands/doctor.ts @@ -22,7 +22,11 @@ import { defaultRuntime } from "../runtime.js"; import { note } from "../terminal/note.js"; import { stylePromptTitle } from "../terminal/prompt-style.js"; import { shortenHomePath } from "../utils.js"; -import { maybeRepairAnthropicOAuthProfileId, noteAuthProfileHealth } from "./doctor-auth.js"; +import { + maybeRemoveDeprecatedCliAuthProfiles, + maybeRepairAnthropicOAuthProfileId, + noteAuthProfileHealth, +} from "./doctor-auth.js"; import { loadAndMaybeMigrateDoctorConfig } from "./doctor-config-flow.js"; import { maybeRepairGatewayDaemon } from "./doctor-gateway-daemon-flow.js"; import { checkGatewayHealth } from "./doctor-gateway-health.js"; @@ -104,6 +108,7 @@ export async function doctorCommand( } cfg = await maybeRepairAnthropicOAuthProfileId(cfg, prompter); + cfg = await maybeRemoveDeprecatedCliAuthProfiles(cfg, prompter); await noteAuthProfileHealth({ cfg, prompter, diff --git a/src/commands/models/auth.ts b/src/commands/models/auth.ts index b2da0cde1..c38cf4520 100644 --- a/src/commands/models/auth.ts +++ b/src/commands/models/auth.ts @@ -1,12 +1,6 @@ -import { spawnSync } from "node:child_process"; - import { confirm as clackConfirm, select as clackSelect, text as clackText } from "@clack/prompts"; -import { - CLAUDE_CLI_PROFILE_ID, - ensureAuthProfileStore, - upsertAuthProfile, -} from "../../agents/auth-profiles.js"; +import { upsertAuthProfile } from "../../agents/auth-profiles.js"; import { normalizeProviderId } from "../../agents/model-selection.js"; import { resolveAgentDir, @@ -33,6 +27,7 @@ import type { ProviderPlugin, } from "../../plugins/types.js"; import type { AuthProfileCredential } from "../../agents/auth-profiles/types.js"; +import { validateAnthropicSetupToken } from "../auth-token.js"; const confirm = (params: Parameters[0]) => clackConfirm({ @@ -73,9 +68,7 @@ export async function modelsAuthSetupTokenCommand( ) { const provider = resolveTokenProvider(opts.provider ?? "anthropic"); if (provider !== "anthropic") { - throw new Error( - "Only --provider anthropic is supported for setup-token (uses `claude setup-token`).", - ); + throw new Error("Only --provider anthropic is supported for setup-token."); } if (!process.stdin.isTTY) { @@ -84,38 +77,38 @@ export async function modelsAuthSetupTokenCommand( if (!opts.yes) { const proceed = await confirm({ - message: "Run `claude setup-token` now?", + message: "Have you run `claude setup-token` and copied the token?", initialValue: true, }); if (!proceed) return; } - const res = spawnSync("claude", ["setup-token"], { stdio: "inherit" }); - if (res.error) throw res.error; - if (typeof res.status === "number" && res.status !== 0) { - throw new Error(`claude setup-token failed (exit ${res.status})`); - } - - const store = ensureAuthProfileStore(undefined, { - allowKeychainPrompt: true, + const tokenInput = await text({ + message: "Paste Anthropic setup-token", + validate: (value) => validateAnthropicSetupToken(String(value ?? "")), + }); + const token = String(tokenInput).trim(); + const profileId = resolveDefaultTokenProfileId(provider); + + upsertAuthProfile({ + profileId, + credential: { + type: "token", + provider, + token, + }, }); - const synced = store.profiles[CLAUDE_CLI_PROFILE_ID]; - if (!synced) { - throw new Error( - `No Claude Code CLI credentials found after setup-token. Expected auth profile ${CLAUDE_CLI_PROFILE_ID}.`, - ); - } await updateConfig((cfg) => applyAuthProfileConfig(cfg, { - profileId: CLAUDE_CLI_PROFILE_ID, - provider: "anthropic", - mode: "oauth", + profileId, + provider, + mode: "token", }), ); logConfigUpdated(runtime); - runtime.log(`Auth profile: ${CLAUDE_CLI_PROFILE_ID} (anthropic/oauth)`); + runtime.log(`Auth profile: ${profileId} (${provider}/token)`); } export async function modelsAuthPasteTokenCommand( @@ -189,7 +182,7 @@ export async function modelsAuthAddCommand(_opts: Record, runtime { value: "setup-token", label: "setup-token (claude)", - hint: "Runs `claude setup-token` (recommended)", + hint: "Paste a setup-token from `claude setup-token`", }, ] : []), diff --git a/src/commands/models/list.status-command.ts b/src/commands/models/list.status-command.ts index 8aa7015c8..fc29cc5d5 100644 --- a/src/commands/models/list.status-command.ts +++ b/src/commands/models/list.status-command.ts @@ -487,7 +487,7 @@ export async function modelsStatusCommand( for (const provider of missingProvidersInUse) { const hint = provider === "anthropic" - ? `Run \`claude setup-token\` or \`${formatCliCommand("clawdbot configure")}\`.` + ? `Run \`claude setup-token\`, then \`${formatCliCommand("clawdbot models auth setup-token")}\` or \`${formatCliCommand("clawdbot configure")}\`.` : `Run \`${formatCliCommand("clawdbot configure")}\` or set an API key env var.`; runtime.log(`- ${theme.heading(provider)} ${hint}`); } @@ -558,9 +558,7 @@ export async function modelsStatusCommand( : profile.expiresAt ? ` expires in ${formatRemainingShort(profile.remainingMs)}` : " expires unknown"; - const source = - profile.source !== "store" ? colorize(rich, theme.muted, ` (${profile.source})`) : ""; - runtime.log(` - ${label} ${status}${expiry}${source}`); + runtime.log(` - ${label} ${status}${expiry}`); } } } diff --git a/src/commands/onboard-auth.test.ts b/src/commands/onboard-auth.test.ts index c87f4efeb..35e69fd45 100644 --- a/src/commands/onboard-auth.test.ts +++ b/src/commands/onboard-auth.test.ts @@ -154,13 +154,13 @@ describe("applyAuthProfileConfig", () => { }, }, { - profileId: "anthropic:claude-cli", + profileId: "anthropic:work", provider: "anthropic", mode: "oauth", }, ); - expect(next.auth?.order?.anthropic).toEqual(["anthropic:claude-cli", "anthropic:default"]); + expect(next.auth?.order?.anthropic).toEqual(["anthropic:work", "anthropic:default"]); }); }); diff --git a/src/commands/onboard-non-interactive.gateway.test.ts b/src/commands/onboard-non-interactive.gateway.test.ts index b5cf45166..a33cc531f 100644 --- a/src/commands/onboard-non-interactive.gateway.test.ts +++ b/src/commands/onboard-non-interactive.gateway.test.ts @@ -210,7 +210,7 @@ describe("onboard (non-interactive): gateway and remote auth", () => { await fs.rm(stateDir, { recursive: true, force: true }); }, 60_000); - it("auto-enables token auth when binding LAN and persists the token", async () => { + it("auto-generates token auth when binding LAN and persists the token", async () => { if (process.platform === "win32") { // Windows runner occasionally drops the temp config write in this flow; skip to keep CI green. return; @@ -242,7 +242,6 @@ describe("onboard (non-interactive): gateway and remote auth", () => { installDaemon: false, gatewayPort: port, gatewayBind: "lan", - gatewayAuth: "off", }, runtime, ); diff --git a/src/commands/onboard-non-interactive/local/auth-choice.ts b/src/commands/onboard-non-interactive/local/auth-choice.ts index 02e0a75b9..c5558596a 100644 --- a/src/commands/onboard-non-interactive/local/auth-choice.ts +++ b/src/commands/onboard-non-interactive/local/auth-choice.ts @@ -1,9 +1,4 @@ -import { - CLAUDE_CLI_PROFILE_ID, - CODEX_CLI_PROFILE_ID, - ensureAuthProfileStore, - upsertAuthProfile, -} from "../../../agents/auth-profiles.js"; +import { upsertAuthProfile } from "../../../agents/auth-profiles.js"; import { normalizeProviderId } from "../../../agents/model-selection.js"; import { parseDurationMs } from "../../../cli/parse-duration.js"; import type { ClawdbotConfig } from "../../../config/config.js"; @@ -36,7 +31,6 @@ import { setZaiApiKey, } from "../../onboard-auth.js"; import type { AuthChoice, OnboardOptions } from "../../onboard-types.js"; -import { applyOpenAICodexModelDefault } from "../../openai-codex-model-default.js"; import { resolveNonInteractiveApiKey } from "../api-keys.js"; import { shortenHomePath } from "../../../utils.js"; @@ -50,6 +44,28 @@ export async function applyNonInteractiveAuthChoice(params: { const { authChoice, opts, runtime, baseConfig } = params; let nextConfig = params.nextConfig; + if (authChoice === "claude-cli" || authChoice === "codex-cli") { + runtime.error( + [ + `Auth choice "${authChoice}" is deprecated.`, + 'Use "--auth-choice token" (Anthropic setup-token) or "--auth-choice openai-codex".', + ].join("\n"), + ); + runtime.exit(1); + return null; + } + + if (authChoice === "setup-token") { + runtime.error( + [ + 'Auth choice "setup-token" requires interactive mode.', + 'Use "--auth-choice token" with --token and --token-provider anthropic.', + ].join("\n"), + ); + runtime.exit(1); + return null; + } + if (authChoice === "apiKey") { const resolved = await resolveNonInteractiveApiKey({ provider: "anthropic", @@ -318,41 +334,6 @@ export async function applyNonInteractiveAuthChoice(params: { return applyMinimaxApiConfig(nextConfig, modelId); } - if (authChoice === "claude-cli") { - const store = ensureAuthProfileStore(undefined, { - allowKeychainPrompt: false, - }); - if (!store.profiles[CLAUDE_CLI_PROFILE_ID]) { - runtime.error( - process.platform === "darwin" - ? 'No Claude Code CLI credentials found. Run interactive onboarding to approve Keychain access for "Claude Code-credentials".' - : "No Claude Code CLI credentials found at ~/.claude/.credentials.json", - ); - runtime.exit(1); - return null; - } - return applyAuthProfileConfig(nextConfig, { - profileId: CLAUDE_CLI_PROFILE_ID, - provider: "anthropic", - mode: "oauth", - }); - } - - if (authChoice === "codex-cli") { - const store = ensureAuthProfileStore(); - if (!store.profiles[CODEX_CLI_PROFILE_ID]) { - runtime.error("No Codex CLI credentials found at ~/.codex/auth.json"); - runtime.exit(1); - return null; - } - nextConfig = applyAuthProfileConfig(nextConfig, { - profileId: CODEX_CLI_PROFILE_ID, - provider: "openai-codex", - mode: "oauth", - }); - return applyOpenAICodexModelDefault(nextConfig).next; - } - if (authChoice === "minimax") return applyMinimaxConfig(nextConfig); if (authChoice === "opencode-zen") { diff --git a/src/commands/onboard-non-interactive/local/gateway-config.ts b/src/commands/onboard-non-interactive/local/gateway-config.ts index fedf1ad19..70772fa9f 100644 --- a/src/commands/onboard-non-interactive/local/gateway-config.ts +++ b/src/commands/onboard-non-interactive/local/gateway-config.ts @@ -28,16 +28,20 @@ export function applyNonInteractiveGatewayConfig(params: { const port = hasGatewayPort ? (opts.gatewayPort as number) : params.defaultPort; let bind = opts.gatewayBind ?? "loopback"; - let authMode = opts.gatewayAuth ?? "token"; + const authModeRaw = opts.gatewayAuth ?? "token"; + if (authModeRaw !== "token" && authModeRaw !== "password") { + runtime.error("Invalid --gateway-auth (use token|password)."); + runtime.exit(1); + return null; + } + let authMode = authModeRaw; const tailscaleMode = opts.tailscale ?? "off"; const tailscaleResetOnExit = Boolean(opts.tailscaleResetOnExit); // Tighten config to safe combos: // - If Tailscale is on, force loopback bind (the tunnel handles external access). - // - If binding beyond loopback, disallow auth=off. // - If using Tailscale Funnel, require password auth. if (tailscaleMode !== "off" && bind !== "loopback") bind = "loopback"; - if (authMode === "off" && bind !== "loopback") authMode = "token"; if (tailscaleMode === "funnel" && authMode !== "password") authMode = "password"; let nextConfig = params.nextConfig; diff --git a/src/commands/onboard-types.ts b/src/commands/onboard-types.ts index 84c15afc4..aa1d9afe0 100644 --- a/src/commands/onboard-types.ts +++ b/src/commands/onboard-types.ts @@ -32,7 +32,7 @@ export type AuthChoice = | "copilot-proxy" | "qwen-portal" | "skip"; -export type GatewayAuthChoice = "off" | "token" | "password"; +export type GatewayAuthChoice = "token" | "password"; export type ResetScope = "config" | "config+creds+sessions" | "full"; export type GatewayBind = "loopback" | "lan" | "auto" | "custom" | "tailnet"; export type TailscaleMode = "off" | "serve" | "funnel"; diff --git a/src/commands/onboard.ts b/src/commands/onboard.ts index d8618a871..348aca613 100644 --- a/src/commands/onboard.ts +++ b/src/commands/onboard.ts @@ -12,9 +12,33 @@ import type { OnboardOptions } from "./onboard-types.js"; export async function onboardCommand(opts: OnboardOptions, runtime: RuntimeEnv = defaultRuntime) { assertSupportedRuntime(runtime); const authChoice = opts.authChoice === "oauth" ? ("setup-token" as const) : opts.authChoice; + const normalizedAuthChoice = + authChoice === "claude-cli" + ? ("setup-token" as const) + : authChoice === "codex-cli" + ? ("openai-codex" as const) + : authChoice; + if (opts.nonInteractive && (authChoice === "claude-cli" || authChoice === "codex-cli")) { + runtime.error( + [ + `Auth choice "${authChoice}" is deprecated.`, + 'Use "--auth-choice token" (Anthropic setup-token) or "--auth-choice openai-codex".', + ].join("\n"), + ); + runtime.exit(1); + return; + } + if (authChoice === "claude-cli") { + runtime.log('Auth choice "claude-cli" is deprecated; using setup-token flow instead.'); + } + if (authChoice === "codex-cli") { + runtime.log('Auth choice "codex-cli" is deprecated; using OpenAI Codex OAuth instead.'); + } const flow = opts.flow === "manual" ? ("advanced" as const) : opts.flow; const normalizedOpts = - authChoice === opts.authChoice && flow === opts.flow ? opts : { ...opts, authChoice, flow }; + normalizedAuthChoice === opts.authChoice && flow === opts.flow + ? opts + : { ...opts, authChoice: normalizedAuthChoice, flow }; if (normalizedOpts.nonInteractive && normalizedOpts.acceptRisk !== true) { runtime.error( diff --git a/src/config/schema.ts b/src/config/schema.ts index 63c10ed88..24d6bccfe 100644 --- a/src/config/schema.ts +++ b/src/config/schema.ts @@ -199,6 +199,7 @@ const FIELD_LABELS: Record = { "tools.web.fetch.userAgent": "Web Fetch User-Agent", "gateway.controlUi.basePath": "Control UI Base Path", "gateway.controlUi.allowInsecureAuth": "Allow Insecure Control UI Auth", + "gateway.controlUi.dangerouslyDisableDeviceAuth": "Dangerously Disable Control UI Device Auth", "gateway.http.endpoints.chatCompletions.enabled": "OpenAI Chat Completions Endpoint", "gateway.reload.mode": "Config Reload Mode", "gateway.reload.debounceMs": "Config Reload Debounce (ms)", @@ -381,6 +382,8 @@ const FIELD_HELP: Record = { "Optional URL prefix where the Control UI is served (e.g. /clawdbot).", "gateway.controlUi.allowInsecureAuth": "Allow Control UI auth over insecure HTTP (token-only; not recommended).", + "gateway.controlUi.dangerouslyDisableDeviceAuth": + "DANGEROUS. Disable Control UI device identity checks (token/password only).", "gateway.http.endpoints.chatCompletions.enabled": "Enable the OpenAI-compatible `POST /v1/chat/completions` endpoint (default: false).", "gateway.reload.mode": 'Hot reload strategy for config changes ("hybrid" recommended).', diff --git a/src/config/types.gateway.ts b/src/config/types.gateway.ts index 4c7ddcdf3..d80b721ec 100644 --- a/src/config/types.gateway.ts +++ b/src/config/types.gateway.ts @@ -66,6 +66,8 @@ export type GatewayControlUiConfig = { basePath?: string; /** Allow token-only auth over insecure HTTP (default: false). */ allowInsecureAuth?: boolean; + /** DANGEROUS: Disable device identity checks for the Control UI (default: false). */ + dangerouslyDisableDeviceAuth?: boolean; }; export type GatewayAuthMode = "token" | "password"; diff --git a/src/config/zod-schema.ts b/src/config/zod-schema.ts index 3c5bba8d7..f39b001fa 100644 --- a/src/config/zod-schema.ts +++ b/src/config/zod-schema.ts @@ -319,6 +319,7 @@ export const ClawdbotSchema = z enabled: z.boolean().optional(), basePath: z.string().optional(), allowInsecureAuth: z.boolean().optional(), + dangerouslyDisableDeviceAuth: z.boolean().optional(), }) .strict() .optional(), diff --git a/src/discord/monitor/presence-cache.test.ts b/src/discord/monitor/presence-cache.test.ts index 8cdf8cefa..007d0548a 100644 --- a/src/discord/monitor/presence-cache.test.ts +++ b/src/discord/monitor/presence-cache.test.ts @@ -1,11 +1,6 @@ import { beforeEach, describe, expect, it } from "vitest"; import type { GatewayPresenceUpdate } from "discord-api-types/v10"; -import { - clearPresences, - getPresence, - presenceCacheSize, - setPresence, -} from "./presence-cache.js"; +import { clearPresences, getPresence, presenceCacheSize, setPresence } from "./presence-cache.js"; describe("presence-cache", () => { beforeEach(() => { diff --git a/src/gateway/auth.test.ts b/src/gateway/auth.test.ts index 90bd5c41e..7e1022124 100644 --- a/src/gateway/auth.test.ts +++ b/src/gateway/auth.test.ts @@ -5,8 +5,8 @@ import { authorizeGatewayConnect } from "./auth.js"; describe("gateway auth", () => { it("does not throw when req is missing socket", async () => { const res = await authorizeGatewayConnect({ - auth: { mode: "none", allowTailscale: false }, - connectAuth: null, + auth: { mode: "token", token: "secret", allowTailscale: false }, + connectAuth: { token: "secret" }, // Regression: avoid crashing on req.socket.remoteAddress when callers pass a non-IncomingMessage. req: {} as never, }); @@ -63,40 +63,10 @@ describe("gateway auth", () => { expect(res.reason).toBe("password_missing_config"); }); - it("reports tailscale auth reasons when required", async () => { - const reqBase = { - socket: { remoteAddress: "100.100.100.100" }, - headers: { host: "gateway.local" }, - }; - - const missingUser = await authorizeGatewayConnect({ - auth: { mode: "none", allowTailscale: true }, - connectAuth: null, - req: reqBase as never, - }); - expect(missingUser.ok).toBe(false); - expect(missingUser.reason).toBe("tailscale_user_missing"); - - const missingProxy = await authorizeGatewayConnect({ - auth: { mode: "none", allowTailscale: true }, - connectAuth: null, - req: { - ...reqBase, - headers: { - host: "gateway.local", - "tailscale-user-login": "peter", - "tailscale-user-name": "Peter", - }, - } as never, - }); - expect(missingProxy.ok).toBe(false); - expect(missingProxy.reason).toBe("tailscale_proxy_missing"); - }); - it("treats local tailscale serve hostnames as direct", async () => { const res = await authorizeGatewayConnect({ - auth: { mode: "none", allowTailscale: true }, - connectAuth: null, + auth: { mode: "token", token: "secret", allowTailscale: true }, + connectAuth: { token: "secret" }, req: { socket: { remoteAddress: "127.0.0.1" }, headers: { host: "gateway.tailnet-1234.ts.net:443" }, @@ -104,21 +74,7 @@ describe("gateway auth", () => { }); expect(res.ok).toBe(true); - expect(res.method).toBe("none"); - }); - - it("does not treat tailscale clients as direct", async () => { - const res = await authorizeGatewayConnect({ - auth: { mode: "none", allowTailscale: true }, - connectAuth: null, - req: { - socket: { remoteAddress: "100.64.0.42" }, - headers: { host: "gateway.tailnet-1234.ts.net" }, - } as never, - }); - - expect(res.ok).toBe(false); - expect(res.reason).toBe("tailscale_user_missing"); + expect(res.method).toBe("token"); }); it("allows tailscale identity to satisfy token mode auth", async () => { @@ -143,41 +99,4 @@ describe("gateway auth", () => { expect(res.method).toBe("tailscale"); expect(res.user).toBe("peter"); }); - - it("rejects mismatched tailscale identity when required", async () => { - const res = await authorizeGatewayConnect({ - auth: { mode: "none", allowTailscale: true }, - connectAuth: null, - tailscaleWhois: async () => ({ login: "alice@example.com", name: "Alice" }), - req: { - socket: { remoteAddress: "127.0.0.1" }, - headers: { - host: "gateway.local", - "x-forwarded-for": "100.64.0.1", - "x-forwarded-proto": "https", - "x-forwarded-host": "ai-hub.bone-egret.ts.net", - "tailscale-user-login": "peter@example.com", - "tailscale-user-name": "Peter", - }, - } as never, - }); - - expect(res.ok).toBe(false); - expect(res.reason).toBe("tailscale_user_mismatch"); - }); - - it("treats trusted proxy loopback clients as direct", async () => { - const res = await authorizeGatewayConnect({ - auth: { mode: "none", allowTailscale: true }, - connectAuth: null, - trustedProxies: ["10.0.0.2"], - req: { - socket: { remoteAddress: "10.0.0.2" }, - headers: { host: "localhost", "x-forwarded-for": "127.0.0.1" }, - } as never, - }); - - expect(res.ok).toBe(true); - expect(res.method).toBe("none"); - }); }); diff --git a/src/gateway/auth.ts b/src/gateway/auth.ts index f716be5dd..1adc367a2 100644 --- a/src/gateway/auth.ts +++ b/src/gateway/auth.ts @@ -3,7 +3,7 @@ import type { IncomingMessage } from "node:http"; import type { GatewayAuthConfig, GatewayTailscaleMode } from "../config/config.js"; import { readTailscaleWhoisIdentity, type TailscaleWhoisIdentity } from "../infra/tailscale.js"; import { isTrustedProxyAddress, parseForwardedForClientIp, resolveGatewayClientIp } from "./net.js"; -export type ResolvedGatewayAuthMode = "none" | "token" | "password"; +export type ResolvedGatewayAuthMode = "token" | "password"; export type ResolvedGatewayAuth = { mode: ResolvedGatewayAuthMode; @@ -14,7 +14,7 @@ export type ResolvedGatewayAuth = { export type GatewayAuthResult = { ok: boolean; - method?: "none" | "token" | "password" | "tailscale" | "device-token"; + method?: "token" | "password" | "tailscale" | "device-token"; user?: string; reason?: string; }; @@ -84,7 +84,7 @@ function resolveRequestClientIp( }); } -function isLocalDirectRequest(req?: IncomingMessage, trustedProxies?: string[]): boolean { +export function isLocalDirectRequest(req?: IncomingMessage, trustedProxies?: string[]): boolean { if (!req) return false; const clientIp = resolveRequestClientIp(req, trustedProxies) ?? ""; if (!isLoopbackAddress(clientIp)) return false; @@ -219,13 +219,6 @@ export async function authorizeGatewayConnect(params: { user: tailscaleCheck.user.login, }; } - if (auth.mode === "none") { - return { ok: false, reason: tailscaleCheck.reason }; - } - } - - if (auth.mode === "none") { - return { ok: true, method: "none" }; } if (auth.mode === "token") { diff --git a/src/gateway/gateway.e2e.test.ts b/src/gateway/gateway.e2e.test.ts index 47ce694ce..0f65d16ac 100644 --- a/src/gateway/gateway.e2e.test.ts +++ b/src/gateway/gateway.e2e.test.ts @@ -181,7 +181,7 @@ describe("gateway e2e", () => { const port = await getFreeGatewayPort(); const server = await startGatewayServer(port, { bind: "loopback", - auth: { mode: "none" }, + auth: { mode: "token", token: wizardToken }, controlUiEnabled: false, wizardRunner: async (_opts, _runtime, prompter) => { await prompter.intro("Wizard E2E"); @@ -197,6 +197,7 @@ describe("gateway e2e", () => { const client = await connectGatewayClient({ url: `ws://127.0.0.1:${port}`, + token: wizardToken, clientDisplayName: "vitest-wizard", }); diff --git a/src/gateway/server.auth.e2e.test.ts b/src/gateway/server.auth.e2e.test.ts index 6474f285b..2eb3dcef9 100644 --- a/src/gateway/server.auth.e2e.test.ts +++ b/src/gateway/server.auth.e2e.test.ts @@ -122,6 +122,18 @@ describe("gateway server auth/connect", () => { await new Promise((resolve) => ws.once("close", () => resolve())); }); + test("requires nonce when host is non-local", async () => { + const ws = new WebSocket(`ws://127.0.0.1:${port}`, { + headers: { host: "example.com" }, + }); + await new Promise((resolve) => ws.once("open", resolve)); + + const res = await connectReq(ws); + expect(res.ok).toBe(false); + expect(res.error?.message).toBe("device nonce required"); + await new Promise((resolve) => ws.once("close", () => resolve())); + }); + test( "invalid connect params surface in response and close reason", { timeout: 60_000 }, @@ -290,6 +302,7 @@ describe("gateway server auth/connect", () => { test("allows control ui with device identity when insecure auth is enabled", async () => { testState.gatewayControlUi = { allowInsecureAuth: true }; + testState.gatewayAuth = { mode: "token", token: "secret" }; const { writeConfigFile } = await import("../config/config.js"); await writeConfigFile({ gateway: { @@ -352,19 +365,45 @@ describe("gateway server auth/connect", () => { } }); - test("rejects proxied connections without auth when proxy headers are untrusted", async () => { - testState.gatewayAuth = { mode: "none" }; + test("allows control ui with stale device identity when device auth is disabled", async () => { + testState.gatewayControlUi = { dangerouslyDisableDeviceAuth: true }; + testState.gatewayAuth = { mode: "token", token: "secret" }; const prevToken = process.env.CLAWDBOT_GATEWAY_TOKEN; - delete process.env.CLAWDBOT_GATEWAY_TOKEN; + process.env.CLAWDBOT_GATEWAY_TOKEN = "secret"; const port = await getFreePort(); const server = await startGatewayServer(port); - const ws = new WebSocket(`ws://127.0.0.1:${port}`, { - headers: { "x-forwarded-for": "203.0.113.10" }, + const ws = await openWs(port); + const { loadOrCreateDeviceIdentity, publicKeyRawBase64UrlFromPem, signDevicePayload } = + await import("../infra/device-identity.js"); + const identity = loadOrCreateDeviceIdentity(); + const signedAtMs = Date.now() - 60 * 60 * 1000; + const payload = buildDeviceAuthPayload({ + deviceId: identity.deviceId, + clientId: GATEWAY_CLIENT_NAMES.CONTROL_UI, + clientMode: GATEWAY_CLIENT_MODES.WEBCHAT, + role: "operator", + scopes: [], + signedAtMs, + token: "secret", }); - await new Promise((resolve) => ws.once("open", resolve)); - const res = await connectReq(ws, { skipDefaultAuth: true }); - expect(res.ok).toBe(false); - expect(res.error?.message ?? "").toContain("gateway auth required"); + const device = { + id: identity.deviceId, + publicKey: publicKeyRawBase64UrlFromPem(identity.publicKeyPem), + signature: signDevicePayload(identity.privateKeyPem, payload), + signedAt: signedAtMs, + }; + const res = await connectReq(ws, { + token: "secret", + device, + client: { + id: GATEWAY_CLIENT_NAMES.CONTROL_UI, + version: "1.0.0", + platform: "web", + mode: GATEWAY_CLIENT_MODES.WEBCHAT, + }, + }); + expect(res.ok).toBe(true); + expect((res.payload as { auth?: unknown } | undefined)?.auth).toBeUndefined(); ws.close(); await server.close(); if (prevToken === undefined) { diff --git a/src/gateway/server/ws-connection/message-handler.ts b/src/gateway/server/ws-connection/message-handler.ts index 7f8f9f2c6..d1f6ae511 100644 --- a/src/gateway/server/ws-connection/message-handler.ts +++ b/src/gateway/server/ws-connection/message-handler.ts @@ -23,10 +23,10 @@ import { rawDataToString } from "../../../infra/ws.js"; import type { createSubsystemLogger } from "../../../logging/subsystem.js"; import { isGatewayCliClient, isWebchatClient } from "../../../utils/message-channel.js"; import type { ResolvedGatewayAuth } from "../../auth.js"; -import { authorizeGatewayConnect } from "../../auth.js"; +import { authorizeGatewayConnect, isLocalDirectRequest } from "../../auth.js"; import { loadConfig } from "../../../config/config.js"; import { buildDeviceAuthPayload } from "../../device-auth.js"; -import { isLocalGatewayAddress, isTrustedProxyAddress, resolveGatewayClientIp } from "../../net.js"; +import { isLoopbackAddress, isTrustedProxyAddress, resolveGatewayClientIp } from "../../net.js"; import { resolveNodeCommandAllowlist } from "../../node-command-policy.js"; import { type ConnectParams, @@ -60,6 +60,17 @@ type SubsystemLogger = ReturnType; const DEVICE_SIGNATURE_SKEW_MS = 10 * 60 * 1000; +function resolveHostName(hostHeader?: string): string { + const host = (hostHeader ?? "").trim().toLowerCase(); + if (!host) return ""; + if (host.startsWith("[")) { + const end = host.indexOf("]"); + if (end !== -1) return host.slice(1, end); + } + const [name] = host.split(":"); + return name ?? ""; +} + type AuthProvidedKind = "token" | "password" | "none"; function formatGatewayAuthFailureMessage(params: { @@ -189,8 +200,17 @@ export function attachGatewayWsMessageHandler(params: { const hasProxyHeaders = Boolean(forwardedFor || realIp); const remoteIsTrustedProxy = isTrustedProxyAddress(remoteAddr, trustedProxies); const hasUntrustedProxyHeaders = hasProxyHeaders && !remoteIsTrustedProxy; - const isLocalClient = !hasUntrustedProxyHeaders && isLocalGatewayAddress(clientIp); - const reportedClientIp = hasUntrustedProxyHeaders ? undefined : clientIp; + const hostName = resolveHostName(requestHost); + const hostIsLocal = hostName === "localhost" || hostName === "127.0.0.1" || hostName === "::1"; + const hostIsTailscaleServe = hostName.endsWith(".ts.net"); + const hostIsLocalish = hostIsLocal || hostIsTailscaleServe; + const isLocalClient = isLocalDirectRequest(upgradeReq, trustedProxies); + const reportedClientIp = + isLocalClient || hasUntrustedProxyHeaders + ? undefined + : clientIp && !isLoopbackAddress(clientIp) + ? clientIp + : undefined; if (hasUntrustedProxyHeaders) { logWsControl.warn( @@ -199,6 +219,13 @@ export function attachGatewayWsMessageHandler(params: { "Configure gateway.trustedProxies to restore local client detection behind your proxy.", ); } + if (!hostIsLocalish && isLoopbackAddress(remoteAddr) && !hasProxyHeaders) { + logWsControl.warn( + "Loopback connection with non-local Host header. " + + "Treating it as remote. If you're behind a reverse proxy, " + + "set gateway.trustedProxies and forward X-Forwarded-For/X-Real-IP.", + ); + } const isWebchatConnect = (p: ConnectParams | null | undefined) => isWebchatClient(p?.client); @@ -335,7 +362,7 @@ export function attachGatewayWsMessageHandler(params: { connectParams.role = role; connectParams.scopes = scopes; - const device = connectParams.device; + const deviceRaw = connectParams.device; let devicePublicKey: string | null = null; const hasTokenAuth = Boolean(connectParams.auth?.token); const hasPasswordAuth = Boolean(connectParams.auth?.password); @@ -343,36 +370,14 @@ export function attachGatewayWsMessageHandler(params: { const isControlUi = connectParams.client.id === GATEWAY_CLIENT_IDS.CONTROL_UI; const allowInsecureControlUi = isControlUi && configSnapshot.gateway?.controlUi?.allowInsecureAuth === true; - if (hasUntrustedProxyHeaders && resolvedAuth.mode === "none") { - setHandshakeState("failed"); - setCloseCause("proxy-auth-required", { - client: connectParams.client.id, - clientDisplayName: connectParams.client.displayName, - mode: connectParams.client.mode, - version: connectParams.client.version, - }); - send({ - type: "res", - id: frame.id, - ok: false, - error: errorShape( - ErrorCodes.INVALID_REQUEST, - "gateway auth required behind reverse proxy", - { - details: { - hint: "set gateway.auth or configure gateway.trustedProxies", - }, - }, - ), - }); - close(1008, "gateway auth required"); - return; - } - + const disableControlUiDeviceAuth = + isControlUi && configSnapshot.gateway?.controlUi?.dangerouslyDisableDeviceAuth === true; + const allowControlUiBypass = allowInsecureControlUi || disableControlUiDeviceAuth; + const device = disableControlUiDeviceAuth ? null : deviceRaw; if (!device) { - const canSkipDevice = allowInsecureControlUi ? hasSharedAuth : hasTokenAuth; + const canSkipDevice = allowControlUiBypass ? hasSharedAuth : hasTokenAuth; - if (isControlUi && !allowInsecureControlUi) { + if (isControlUi && !allowControlUiBypass) { const errorMessage = "control ui requires HTTPS or localhost (secure context)"; setHandshakeState("failed"); setCloseCause("control-ui-insecure-auth", { @@ -566,7 +571,8 @@ export function attachGatewayWsMessageHandler(params: { trustedProxies, }); let authOk = authResult.ok; - let authMethod = authResult.method ?? "none"; + let authMethod = + authResult.method ?? (resolvedAuth.mode === "password" ? "password" : "token"); if (!authOk && connectParams.auth?.token && device) { const tokenCheck = await verifyDeviceToken({ deviceId: device.id, @@ -615,7 +621,7 @@ export function attachGatewayWsMessageHandler(params: { return; } - const skipPairing = allowInsecureControlUi && hasSharedAuth; + const skipPairing = allowControlUiBypass && hasSharedAuth; if (device && devicePublicKey && !skipPairing) { const requirePairing = async (reason: string, _paired?: { deviceId: string }) => { const pairing = await requestDevicePairing({ @@ -736,9 +742,7 @@ export function attachGatewayWsMessageHandler(params: { const shouldTrackPresence = !isGatewayCliClient(connectParams.client); const clientId = connectParams.client.id; const instanceId = connectParams.client.instanceId; - const presenceKey = shouldTrackPresence - ? (connectParams.device?.id ?? instanceId ?? connId) - : undefined; + const presenceKey = shouldTrackPresence ? (device?.id ?? instanceId ?? connId) : undefined; logWs("in", "connect", { connId, @@ -766,10 +770,10 @@ export function attachGatewayWsMessageHandler(params: { deviceFamily: connectParams.client.deviceFamily, modelIdentifier: connectParams.client.modelIdentifier, mode: connectParams.client.mode, - deviceId: connectParams.device?.id, + deviceId: device?.id, roles: [role], scopes, - instanceId: connectParams.device?.id ?? instanceId, + instanceId: device?.id ?? instanceId, reason: "connect", }); incrementPresenceVersion(); diff --git a/src/gateway/test-helpers.server.ts b/src/gateway/test-helpers.server.ts index 254365564..34c22c573 100644 --- a/src/gateway/test-helpers.server.ts +++ b/src/gateway/test-helpers.server.ts @@ -260,6 +260,9 @@ export async function startGatewayServer(port: number, opts?: GatewayServerOptio export async function startServerWithClient(token?: string, opts?: GatewayServerOptions) { let port = await getFreePort(); const prev = process.env.CLAWDBOT_GATEWAY_TOKEN; + if (typeof token === "string") { + testState.gatewayAuth = { mode: "token", token }; + } const fallbackToken = token ?? (typeof (testState.gatewayAuth as { token?: unknown } | undefined)?.token === "string" diff --git a/src/infra/provider-usage.auth.ts b/src/infra/provider-usage.auth.ts index 43e4c10c9..90d73bb59 100644 --- a/src/infra/provider-usage.auth.ts +++ b/src/infra/provider-usage.auth.ts @@ -3,7 +3,6 @@ import os from "node:os"; import path from "node:path"; import { - CLAUDE_CLI_PROFILE_ID, ensureAuthProfileStore, listProfilesForProvider, resolveApiKeyForProfile, @@ -111,9 +110,7 @@ async function resolveOAuthToken(params: { provider: params.provider, }); - // Claude Code CLI creds are the only Anthropic tokens that reliably include the - // `user:profile` scope required for the OAuth usage endpoint. - const candidates = params.provider === "anthropic" ? [CLAUDE_CLI_PROFILE_ID, ...order] : order; + const candidates = order; const deduped: string[] = []; for (const entry of candidates) { if (!deduped.includes(entry)) deduped.push(entry); diff --git a/src/infra/provider-usage.test.ts b/src/infra/provider-usage.test.ts index 7172c2ce9..bf082d559 100644 --- a/src/infra/provider-usage.test.ts +++ b/src/infra/provider-usage.test.ts @@ -335,81 +335,6 @@ describe("provider usage loading", () => { ); }); - it("prefers claude-cli token for Anthropic usage snapshots", async () => { - await withTempHome( - async () => { - const stateDir = process.env.CLAWDBOT_STATE_DIR; - if (!stateDir) throw new Error("Missing CLAWDBOT_STATE_DIR"); - const agentDir = path.join(stateDir, "agents", "main", "agent"); - fs.mkdirSync(agentDir, { recursive: true, mode: 0o700 }); - fs.writeFileSync( - path.join(agentDir, "auth-profiles.json"), - `${JSON.stringify( - { - version: 1, - profiles: { - "anthropic:default": { - type: "token", - provider: "anthropic", - token: "token-default", - expires: Date.UTC(2100, 0, 1, 0, 0, 0), - }, - "anthropic:claude-cli": { - type: "token", - provider: "anthropic", - token: "token-cli", - expires: Date.UTC(2100, 0, 1, 0, 0, 0), - }, - }, - }, - null, - 2, - )}\n`, - "utf8", - ); - - const makeResponse = (status: number, body: unknown): Response => { - const payload = typeof body === "string" ? body : JSON.stringify(body); - const headers = - typeof body === "string" ? undefined : { "Content-Type": "application/json" }; - return new Response(payload, { status, headers }); - }; - - const mockFetch = vi.fn, ReturnType>( - async (input, init) => { - const url = - typeof input === "string" - ? input - : input instanceof URL - ? input.toString() - : input.url; - if (url.includes("api.anthropic.com/api/oauth/usage")) { - const headers = (init?.headers ?? {}) as Record; - expect(headers.Authorization).toBe("Bearer token-cli"); - return makeResponse(200, { - five_hour: { utilization: 20, resets_at: "2026-01-07T01:00:00Z" }, - }); - } - return makeResponse(404, "not found"); - }, - ); - - const summary = await loadProviderUsageSummary({ - now: Date.UTC(2026, 0, 7, 0, 0, 0), - providers: ["anthropic"], - agentDir, - fetch: mockFetch, - }); - - expect(summary.providers).toHaveLength(1); - expect(summary.providers[0]?.provider).toBe("anthropic"); - expect(summary.providers[0]?.windows[0]?.label).toBe("5h"); - expect(mockFetch).toHaveBeenCalled(); - }, - { prefix: "clawdbot-provider-usage-" }, - ); - }); - it("falls back to claude.ai web usage when OAuth scope is missing", async () => { const cookieSnapshot = process.env.CLAUDE_AI_SESSION_KEY; process.env.CLAUDE_AI_SESSION_KEY = "sk-ant-web-1"; diff --git a/src/security/audit-extra.ts b/src/security/audit-extra.ts index 6dce5c896..9aabb9721 100644 --- a/src/security/audit-extra.ts +++ b/src/security/audit-extra.ts @@ -22,14 +22,12 @@ import type { SandboxToolPolicy } from "../agents/sandbox/types.js"; import { INCLUDE_KEY, MAX_INCLUDE_DEPTH } from "../config/includes.js"; import { normalizeAgentId } from "../routing/session-key.js"; import { - formatOctal, - isGroupReadable, - isGroupWritable, - isWorldReadable, - isWorldWritable, - modeBits, + formatPermissionDetail, + formatPermissionRemediation, + inspectPathPermissions, safeStat, } from "./audit-fs.js"; +import type { ExecFn } from "./windows-acl.js"; export type SecurityAuditFinding = { checkId: string; @@ -707,6 +705,9 @@ async function collectIncludePathsRecursive(params: { export async function collectIncludeFilePermFindings(params: { configSnapshot: ConfigFileSnapshot; + env?: NodeJS.ProcessEnv; + platform?: NodeJS.Platform; + execIcacls?: ExecFn; }): Promise { const findings: SecurityAuditFinding[] = []; if (!params.configSnapshot.exists) return findings; @@ -720,32 +721,53 @@ export async function collectIncludeFilePermFindings(params: { for (const p of includePaths) { // eslint-disable-next-line no-await-in-loop - const st = await safeStat(p); - if (!st.ok) continue; - const bits = modeBits(st.mode); - if (isWorldWritable(bits) || isGroupWritable(bits)) { + const perms = await inspectPathPermissions(p, { + env: params.env, + platform: params.platform, + exec: params.execIcacls, + }); + if (!perms.ok) continue; + if (perms.worldWritable || perms.groupWritable) { findings.push({ checkId: "fs.config_include.perms_writable", severity: "critical", title: "Config include file is writable by others", - detail: `${p} mode=${formatOctal(bits)}; another user could influence your effective config.`, - remediation: `chmod 600 ${p}`, + detail: `${formatPermissionDetail(p, perms)}; another user could influence your effective config.`, + remediation: formatPermissionRemediation({ + targetPath: p, + perms, + isDir: false, + posixMode: 0o600, + env: params.env, + }), }); - } else if (isWorldReadable(bits)) { + } else if (perms.worldReadable) { findings.push({ checkId: "fs.config_include.perms_world_readable", severity: "critical", title: "Config include file is world-readable", - detail: `${p} mode=${formatOctal(bits)}; include files can contain tokens and private settings.`, - remediation: `chmod 600 ${p}`, + detail: `${formatPermissionDetail(p, perms)}; include files can contain tokens and private settings.`, + remediation: formatPermissionRemediation({ + targetPath: p, + perms, + isDir: false, + posixMode: 0o600, + env: params.env, + }), }); - } else if (isGroupReadable(bits)) { + } else if (perms.groupReadable) { findings.push({ checkId: "fs.config_include.perms_group_readable", severity: "warn", title: "Config include file is group-readable", - detail: `${p} mode=${formatOctal(bits)}; include files can contain tokens and private settings.`, - remediation: `chmod 600 ${p}`, + detail: `${formatPermissionDetail(p, perms)}; include files can contain tokens and private settings.`, + remediation: formatPermissionRemediation({ + targetPath: p, + perms, + isDir: false, + posixMode: 0o600, + env: params.env, + }), }); } } @@ -757,28 +779,45 @@ export async function collectStateDeepFilesystemFindings(params: { cfg: ClawdbotConfig; env: NodeJS.ProcessEnv; stateDir: string; + platform?: NodeJS.Platform; + execIcacls?: ExecFn; }): Promise { const findings: SecurityAuditFinding[] = []; const oauthDir = resolveOAuthDir(params.env, params.stateDir); - const oauthStat = await safeStat(oauthDir); - if (oauthStat.ok && oauthStat.isDir) { - const bits = modeBits(oauthStat.mode); - if (isWorldWritable(bits) || isGroupWritable(bits)) { + const oauthPerms = await inspectPathPermissions(oauthDir, { + env: params.env, + platform: params.platform, + exec: params.execIcacls, + }); + if (oauthPerms.ok && oauthPerms.isDir) { + if (oauthPerms.worldWritable || oauthPerms.groupWritable) { findings.push({ checkId: "fs.credentials_dir.perms_writable", severity: "critical", title: "Credentials dir is writable by others", - detail: `${oauthDir} mode=${formatOctal(bits)}; another user could drop/modify credential files.`, - remediation: `chmod 700 ${oauthDir}`, + detail: `${formatPermissionDetail(oauthDir, oauthPerms)}; another user could drop/modify credential files.`, + remediation: formatPermissionRemediation({ + targetPath: oauthDir, + perms: oauthPerms, + isDir: true, + posixMode: 0o700, + env: params.env, + }), }); - } else if (isGroupReadable(bits) || isWorldReadable(bits)) { + } else if (oauthPerms.groupReadable || oauthPerms.worldReadable) { findings.push({ checkId: "fs.credentials_dir.perms_readable", severity: "warn", title: "Credentials dir is readable by others", - detail: `${oauthDir} mode=${formatOctal(bits)}; credentials and allowlists can be sensitive.`, - remediation: `chmod 700 ${oauthDir}`, + detail: `${formatPermissionDetail(oauthDir, oauthPerms)}; credentials and allowlists can be sensitive.`, + remediation: formatPermissionRemediation({ + targetPath: oauthDir, + perms: oauthPerms, + isDir: true, + posixMode: 0o700, + env: params.env, + }), }); } } @@ -795,40 +834,64 @@ export async function collectStateDeepFilesystemFindings(params: { const agentDir = path.join(params.stateDir, "agents", agentId, "agent"); const authPath = path.join(agentDir, "auth-profiles.json"); // eslint-disable-next-line no-await-in-loop - const authStat = await safeStat(authPath); - if (authStat.ok) { - const bits = modeBits(authStat.mode); - if (isWorldWritable(bits) || isGroupWritable(bits)) { + const authPerms = await inspectPathPermissions(authPath, { + env: params.env, + platform: params.platform, + exec: params.execIcacls, + }); + if (authPerms.ok) { + if (authPerms.worldWritable || authPerms.groupWritable) { findings.push({ checkId: "fs.auth_profiles.perms_writable", severity: "critical", title: "auth-profiles.json is writable by others", - detail: `${authPath} mode=${formatOctal(bits)}; another user could inject credentials.`, - remediation: `chmod 600 ${authPath}`, + detail: `${formatPermissionDetail(authPath, authPerms)}; another user could inject credentials.`, + remediation: formatPermissionRemediation({ + targetPath: authPath, + perms: authPerms, + isDir: false, + posixMode: 0o600, + env: params.env, + }), }); - } else if (isWorldReadable(bits) || isGroupReadable(bits)) { + } else if (authPerms.worldReadable || authPerms.groupReadable) { findings.push({ checkId: "fs.auth_profiles.perms_readable", severity: "warn", title: "auth-profiles.json is readable by others", - detail: `${authPath} mode=${formatOctal(bits)}; auth-profiles.json contains API keys and OAuth tokens.`, - remediation: `chmod 600 ${authPath}`, + detail: `${formatPermissionDetail(authPath, authPerms)}; auth-profiles.json contains API keys and OAuth tokens.`, + remediation: formatPermissionRemediation({ + targetPath: authPath, + perms: authPerms, + isDir: false, + posixMode: 0o600, + env: params.env, + }), }); } } const storePath = path.join(params.stateDir, "agents", agentId, "sessions", "sessions.json"); // eslint-disable-next-line no-await-in-loop - const storeStat = await safeStat(storePath); - if (storeStat.ok) { - const bits = modeBits(storeStat.mode); - if (isWorldReadable(bits) || isGroupReadable(bits)) { + const storePerms = await inspectPathPermissions(storePath, { + env: params.env, + platform: params.platform, + exec: params.execIcacls, + }); + if (storePerms.ok) { + if (storePerms.worldReadable || storePerms.groupReadable) { findings.push({ checkId: "fs.sessions_store.perms_readable", severity: "warn", title: "sessions.json is readable by others", - detail: `${storePath} mode=${formatOctal(bits)}; routing and transcript metadata can be sensitive.`, - remediation: `chmod 600 ${storePath}`, + detail: `${formatPermissionDetail(storePath, storePerms)}; routing and transcript metadata can be sensitive.`, + remediation: formatPermissionRemediation({ + targetPath: storePath, + perms: storePerms, + isDir: false, + posixMode: 0o600, + env: params.env, + }), }); } } @@ -840,16 +903,25 @@ export async function collectStateDeepFilesystemFindings(params: { const expanded = logFile.startsWith("~") ? expandTilde(logFile, params.env) : logFile; if (expanded) { const logPath = path.resolve(expanded); - const st = await safeStat(logPath); - if (st.ok) { - const bits = modeBits(st.mode); - if (isWorldReadable(bits) || isGroupReadable(bits)) { + const logPerms = await inspectPathPermissions(logPath, { + env: params.env, + platform: params.platform, + exec: params.execIcacls, + }); + if (logPerms.ok) { + if (logPerms.worldReadable || logPerms.groupReadable) { findings.push({ checkId: "fs.log_file.perms_readable", severity: "warn", title: "Log file is readable by others", - detail: `${logPath} mode=${formatOctal(bits)}; logs can contain private messages and tool output.`, - remediation: `chmod 600 ${logPath}`, + detail: `${formatPermissionDetail(logPath, logPerms)}; logs can contain private messages and tool output.`, + remediation: formatPermissionRemediation({ + targetPath: logPath, + perms: logPerms, + isDir: false, + posixMode: 0o600, + env: params.env, + }), }); } } diff --git a/src/security/audit-fs.ts b/src/security/audit-fs.ts index 5832b64f8..6bf0aec26 100644 --- a/src/security/audit-fs.ts +++ b/src/security/audit-fs.ts @@ -1,5 +1,33 @@ import fs from "node:fs/promises"; +import { + formatIcaclsResetCommand, + formatWindowsAclSummary, + inspectWindowsAcl, + type ExecFn, +} from "./windows-acl.js"; + +export type PermissionCheck = { + ok: boolean; + isSymlink: boolean; + isDir: boolean; + mode: number | null; + bits: number | null; + source: "posix" | "windows-acl" | "unknown"; + worldWritable: boolean; + groupWritable: boolean; + worldReadable: boolean; + groupReadable: boolean; + aclSummary?: string; + error?: string; +}; + +export type PermissionCheckOptions = { + platform?: NodeJS.Platform; + env?: NodeJS.ProcessEnv; + exec?: ExecFn; +}; + export async function safeStat(targetPath: string): Promise<{ ok: boolean; isSymlink: boolean; @@ -32,6 +60,98 @@ export async function safeStat(targetPath: string): Promise<{ } } +export async function inspectPathPermissions( + targetPath: string, + opts?: PermissionCheckOptions, +): Promise { + const st = await safeStat(targetPath); + if (!st.ok) { + return { + ok: false, + isSymlink: false, + isDir: false, + mode: null, + bits: null, + source: "unknown", + worldWritable: false, + groupWritable: false, + worldReadable: false, + groupReadable: false, + error: st.error, + }; + } + + const bits = modeBits(st.mode); + const platform = opts?.platform ?? process.platform; + + if (platform === "win32") { + const acl = await inspectWindowsAcl(targetPath, { env: opts?.env, exec: opts?.exec }); + if (!acl.ok) { + return { + ok: true, + isSymlink: st.isSymlink, + isDir: st.isDir, + mode: st.mode, + bits, + source: "unknown", + worldWritable: false, + groupWritable: false, + worldReadable: false, + groupReadable: false, + error: acl.error, + }; + } + return { + ok: true, + isSymlink: st.isSymlink, + isDir: st.isDir, + mode: st.mode, + bits, + source: "windows-acl", + worldWritable: acl.untrustedWorld.some((entry) => entry.canWrite), + groupWritable: acl.untrustedGroup.some((entry) => entry.canWrite), + worldReadable: acl.untrustedWorld.some((entry) => entry.canRead), + groupReadable: acl.untrustedGroup.some((entry) => entry.canRead), + aclSummary: formatWindowsAclSummary(acl), + }; + } + + return { + ok: true, + isSymlink: st.isSymlink, + isDir: st.isDir, + mode: st.mode, + bits, + source: "posix", + worldWritable: isWorldWritable(bits), + groupWritable: isGroupWritable(bits), + worldReadable: isWorldReadable(bits), + groupReadable: isGroupReadable(bits), + }; +} + +export function formatPermissionDetail(targetPath: string, perms: PermissionCheck): string { + if (perms.source === "windows-acl") { + const summary = perms.aclSummary ?? "unknown"; + return `${targetPath} acl=${summary}`; + } + return `${targetPath} mode=${formatOctal(perms.bits)}`; +} + +export function formatPermissionRemediation(params: { + targetPath: string; + perms: PermissionCheck; + isDir: boolean; + posixMode: number; + env?: NodeJS.ProcessEnv; +}): string { + if (params.perms.source === "windows-acl") { + return formatIcaclsResetCommand(params.targetPath, { isDir: params.isDir, env: params.env }); + } + const mode = params.posixMode.toString(8).padStart(3, "0"); + return `chmod ${mode} ${params.targetPath}`; +} + export function modeBits(mode: number | null): number | null { if (mode == null) return null; return mode & 0o777; diff --git a/src/security/audit.test.ts b/src/security/audit.test.ts index 2ee7e27ee..e87a6b47c 100644 --- a/src/security/audit.test.ts +++ b/src/security/audit.test.ts @@ -82,7 +82,7 @@ describe("security audit", () => { gateway: { bind: "loopback", controlUi: { enabled: true }, - auth: { mode: "none" as any }, + auth: {}, }, }; @@ -120,6 +120,83 @@ describe("security audit", () => { ); }); + it("treats Windows ACL-only perms as secure", async () => { + const tmp = await fs.mkdtemp(path.join(os.tmpdir(), "clawdbot-security-audit-win-")); + const stateDir = path.join(tmp, "state"); + await fs.mkdir(stateDir, { recursive: true }); + const configPath = path.join(stateDir, "clawdbot.json"); + await fs.writeFile(configPath, "{}\n", "utf-8"); + + const user = "DESKTOP-TEST\\Tester"; + const execIcacls = async (_cmd: string, args: string[]) => ({ + stdout: `${args[0]} NT AUTHORITY\\SYSTEM:(F)\n ${user}:(F)\n`, + stderr: "", + }); + + const res = await runSecurityAudit({ + config: {}, + includeFilesystem: true, + includeChannelSecurity: false, + stateDir, + configPath, + platform: "win32", + env: { ...process.env, USERNAME: "Tester", USERDOMAIN: "DESKTOP-TEST" }, + execIcacls, + }); + + const forbidden = new Set([ + "fs.state_dir.perms_world_writable", + "fs.state_dir.perms_group_writable", + "fs.state_dir.perms_readable", + "fs.config.perms_writable", + "fs.config.perms_world_readable", + "fs.config.perms_group_readable", + ]); + for (const id of forbidden) { + expect(res.findings.some((f) => f.checkId === id)).toBe(false); + } + }); + + it("flags Windows ACLs when Users can read the state dir", async () => { + const tmp = await fs.mkdtemp(path.join(os.tmpdir(), "clawdbot-security-audit-win-open-")); + const stateDir = path.join(tmp, "state"); + await fs.mkdir(stateDir, { recursive: true }); + const configPath = path.join(stateDir, "clawdbot.json"); + await fs.writeFile(configPath, "{}\n", "utf-8"); + + const user = "DESKTOP-TEST\\Tester"; + const execIcacls = async (_cmd: string, args: string[]) => { + const target = args[0]; + if (target === stateDir) { + return { + stdout: `${target} NT AUTHORITY\\SYSTEM:(F)\n BUILTIN\\Users:(RX)\n ${user}:(F)\n`, + stderr: "", + }; + } + return { + stdout: `${target} NT AUTHORITY\\SYSTEM:(F)\n ${user}:(F)\n`, + stderr: "", + }; + }; + + const res = await runSecurityAudit({ + config: {}, + includeFilesystem: true, + includeChannelSecurity: false, + stateDir, + configPath, + platform: "win32", + env: { ...process.env, USERNAME: "Tester", USERDOMAIN: "DESKTOP-TEST" }, + execIcacls, + }); + + expect( + res.findings.some( + (f) => f.checkId === "fs.state_dir.perms_readable" && f.severity === "warn", + ), + ).toBe(true); + }); + it("warns when small models are paired with web/browser tools", async () => { const cfg: ClawdbotConfig = { agents: { defaults: { model: { primary: "ollama/mistral-8b" } } }, @@ -293,7 +370,30 @@ describe("security audit", () => { expect.arrayContaining([ expect.objectContaining({ checkId: "gateway.control_ui.insecure_auth", - severity: "warn", + severity: "critical", + }), + ]), + ); + }); + + it("warns when control UI device auth is disabled", async () => { + const cfg: ClawdbotConfig = { + gateway: { + controlUi: { dangerouslyDisableDeviceAuth: true }, + }, + }; + + const res = await runSecurityAudit({ + config: cfg, + includeFilesystem: false, + includeChannelSecurity: false, + }); + + expect(res.findings).toEqual( + expect.arrayContaining([ + expect.objectContaining({ + checkId: "gateway.control_ui.device_auth_disabled", + severity: "critical", }), ]), ); diff --git a/src/security/audit.ts b/src/security/audit.ts index b2f9691c7..2169f197d 100644 --- a/src/security/audit.ts +++ b/src/security/audit.ts @@ -24,14 +24,11 @@ import { import { readChannelAllowFromStore } from "../pairing/pairing-store.js"; import { resolveNativeCommandsEnabled, resolveNativeSkillsEnabled } from "../config/commands.js"; import { - formatOctal, - isGroupReadable, - isGroupWritable, - isWorldReadable, - isWorldWritable, - modeBits, - safeStat, + formatPermissionDetail, + formatPermissionRemediation, + inspectPathPermissions, } from "./audit-fs.js"; +import type { ExecFn } from "./windows-acl.js"; export type SecurityAuditSeverity = "info" | "warn" | "critical"; @@ -66,6 +63,8 @@ export type SecurityAuditReport = { export type SecurityAuditOptions = { config: ClawdbotConfig; + env?: NodeJS.ProcessEnv; + platform?: NodeJS.Platform; deep?: boolean; includeFilesystem?: boolean; includeChannelSecurity?: boolean; @@ -79,6 +78,8 @@ export type SecurityAuditOptions = { plugins?: ReturnType; /** Dependency injection for tests. */ probeGatewayFn?: typeof probeGateway; + /** Dependency injection for tests (Windows ACL checks). */ + execIcacls?: ExecFn; }; function countBySeverity(findings: SecurityAuditFinding[]): SecurityAuditSummary { @@ -119,13 +120,19 @@ function classifyChannelWarningSeverity(message: string): SecurityAuditSeverity async function collectFilesystemFindings(params: { stateDir: string; configPath: string; + env?: NodeJS.ProcessEnv; + platform?: NodeJS.Platform; + execIcacls?: ExecFn; }): Promise { const findings: SecurityAuditFinding[] = []; - const stateDirStat = await safeStat(params.stateDir); - if (stateDirStat.ok) { - const bits = modeBits(stateDirStat.mode); - if (stateDirStat.isSymlink) { + const stateDirPerms = await inspectPathPermissions(params.stateDir, { + env: params.env, + platform: params.platform, + exec: params.execIcacls, + }); + if (stateDirPerms.ok) { + if (stateDirPerms.isSymlink) { findings.push({ checkId: "fs.state_dir.symlink", severity: "warn", @@ -133,37 +140,58 @@ async function collectFilesystemFindings(params: { detail: `${params.stateDir} is a symlink; treat this as an extra trust boundary.`, }); } - if (isWorldWritable(bits)) { + if (stateDirPerms.worldWritable) { findings.push({ checkId: "fs.state_dir.perms_world_writable", severity: "critical", title: "State dir is world-writable", - detail: `${params.stateDir} mode=${formatOctal(bits)}; other users can write into your Clawdbot state.`, - remediation: `chmod 700 ${params.stateDir}`, + detail: `${formatPermissionDetail(params.stateDir, stateDirPerms)}; other users can write into your Clawdbot state.`, + remediation: formatPermissionRemediation({ + targetPath: params.stateDir, + perms: stateDirPerms, + isDir: true, + posixMode: 0o700, + env: params.env, + }), }); - } else if (isGroupWritable(bits)) { + } else if (stateDirPerms.groupWritable) { findings.push({ checkId: "fs.state_dir.perms_group_writable", severity: "warn", title: "State dir is group-writable", - detail: `${params.stateDir} mode=${formatOctal(bits)}; group users can write into your Clawdbot state.`, - remediation: `chmod 700 ${params.stateDir}`, + detail: `${formatPermissionDetail(params.stateDir, stateDirPerms)}; group users can write into your Clawdbot state.`, + remediation: formatPermissionRemediation({ + targetPath: params.stateDir, + perms: stateDirPerms, + isDir: true, + posixMode: 0o700, + env: params.env, + }), }); - } else if (isGroupReadable(bits) || isWorldReadable(bits)) { + } else if (stateDirPerms.groupReadable || stateDirPerms.worldReadable) { findings.push({ checkId: "fs.state_dir.perms_readable", severity: "warn", title: "State dir is readable by others", - detail: `${params.stateDir} mode=${formatOctal(bits)}; consider restricting to 700.`, - remediation: `chmod 700 ${params.stateDir}`, + detail: `${formatPermissionDetail(params.stateDir, stateDirPerms)}; consider restricting to 700.`, + remediation: formatPermissionRemediation({ + targetPath: params.stateDir, + perms: stateDirPerms, + isDir: true, + posixMode: 0o700, + env: params.env, + }), }); } } - const configStat = await safeStat(params.configPath); - if (configStat.ok) { - const bits = modeBits(configStat.mode); - if (configStat.isSymlink) { + const configPerms = await inspectPathPermissions(params.configPath, { + env: params.env, + platform: params.platform, + exec: params.execIcacls, + }); + if (configPerms.ok) { + if (configPerms.isSymlink) { findings.push({ checkId: "fs.config.symlink", severity: "warn", @@ -171,29 +199,47 @@ async function collectFilesystemFindings(params: { detail: `${params.configPath} is a symlink; make sure you trust its target.`, }); } - if (isWorldWritable(bits) || isGroupWritable(bits)) { + if (configPerms.worldWritable || configPerms.groupWritable) { findings.push({ checkId: "fs.config.perms_writable", severity: "critical", title: "Config file is writable by others", - detail: `${params.configPath} mode=${formatOctal(bits)}; another user could change gateway/auth/tool policies.`, - remediation: `chmod 600 ${params.configPath}`, + detail: `${formatPermissionDetail(params.configPath, configPerms)}; another user could change gateway/auth/tool policies.`, + remediation: formatPermissionRemediation({ + targetPath: params.configPath, + perms: configPerms, + isDir: false, + posixMode: 0o600, + env: params.env, + }), }); - } else if (isWorldReadable(bits)) { + } else if (configPerms.worldReadable) { findings.push({ checkId: "fs.config.perms_world_readable", severity: "critical", title: "Config file is world-readable", - detail: `${params.configPath} mode=${formatOctal(bits)}; config can contain tokens and private settings.`, - remediation: `chmod 600 ${params.configPath}`, + detail: `${formatPermissionDetail(params.configPath, configPerms)}; config can contain tokens and private settings.`, + remediation: formatPermissionRemediation({ + targetPath: params.configPath, + perms: configPerms, + isDir: false, + posixMode: 0o600, + env: params.env, + }), }); - } else if (isGroupReadable(bits)) { + } else if (configPerms.groupReadable) { findings.push({ checkId: "fs.config.perms_group_readable", severity: "warn", title: "Config file is group-readable", - detail: `${params.configPath} mode=${formatOctal(bits)}; config can contain tokens and private settings.`, - remediation: `chmod 600 ${params.configPath}`, + detail: `${formatPermissionDetail(params.configPath, configPerms)}; config can contain tokens and private settings.`, + remediation: formatPermissionRemediation({ + targetPath: params.configPath, + perms: configPerms, + isDir: false, + posixMode: 0o600, + env: params.env, + }), }); } } @@ -274,7 +320,7 @@ function collectGatewayConfigFindings(cfg: ClawdbotConfig): SecurityAuditFinding if (cfg.gateway?.controlUi?.allowInsecureAuth === true) { findings.push({ checkId: "gateway.control_ui.insecure_auth", - severity: "warn", + severity: "critical", title: "Control UI allows insecure HTTP auth", detail: "gateway.controlUi.allowInsecureAuth=true allows token-only auth over HTTP and skips device identity.", @@ -282,6 +328,17 @@ function collectGatewayConfigFindings(cfg: ClawdbotConfig): SecurityAuditFinding }); } + if (cfg.gateway?.controlUi?.dangerouslyDisableDeviceAuth === true) { + findings.push({ + checkId: "gateway.control_ui.device_auth_disabled", + severity: "critical", + title: "DANGEROUS: Control UI device auth disabled", + detail: + "gateway.controlUi.dangerouslyDisableDeviceAuth=true disables device identity checks for the Control UI.", + remediation: "Disable it unless you are in a short-lived break-glass scenario.", + }); + } + const token = typeof auth.token === "string" && auth.token.trim().length > 0 ? auth.token.trim() : null; if (auth.mode === "token" && token && token.length < 24) { @@ -839,7 +896,9 @@ async function maybeProbeGateway(params: { export async function runSecurityAudit(opts: SecurityAuditOptions): Promise { const findings: SecurityAuditFinding[] = []; const cfg = opts.config; - const env = process.env; + const env = opts.env ?? process.env; + const platform = opts.platform ?? process.platform; + const execIcacls = opts.execIcacls; const stateDir = opts.stateDir ?? resolveStateDir(env); const configPath = opts.configPath ?? resolveConfigPath(env, stateDir); @@ -862,11 +921,23 @@ export async function runSecurityAudit(opts: SecurityAuditOptions): Promise { + const display = formatIcaclsResetCommand(params.path, { + isDir: params.require === "dir", + env: params.env, + }); + try { + const st = await fs.lstat(params.path); + if (st.isSymbolicLink()) { + return { + kind: "icacls", + path: params.path, + command: display, + ok: false, + skipped: "symlink", + }; + } + if (params.require === "dir" && !st.isDirectory()) { + return { + kind: "icacls", + path: params.path, + command: display, + ok: false, + skipped: "not-a-directory", + }; + } + if (params.require === "file" && !st.isFile()) { + return { + kind: "icacls", + path: params.path, + command: display, + ok: false, + skipped: "not-a-file", + }; + } + const cmd = createIcaclsResetCommand(params.path, { + isDir: st.isDirectory(), + env: params.env, + }); + if (!cmd) { + return { + kind: "icacls", + path: params.path, + command: display, + ok: false, + skipped: "missing-user", + }; + } + const exec = params.exec ?? runExec; + await exec(cmd.command, cmd.args); + return { kind: "icacls", path: params.path, command: cmd.display, ok: true }; + } catch (err) { + const code = (err as { code?: string }).code; + if (code === "ENOENT") { + return { + kind: "icacls", + path: params.path, + command: display, + ok: false, + skipped: "missing", + }; + } + return { + kind: "icacls", + path: params.path, + command: display, + ok: false, + error: String(err), + }; + } +} + function setGroupPolicyAllowlist(params: { cfg: ClawdbotConfig; channel: string; @@ -261,7 +350,12 @@ async function chmodCredentialsAndAgentState(params: { env: NodeJS.ProcessEnv; stateDir: string; cfg: ClawdbotConfig; - actions: SecurityFixChmodAction[]; + actions: SecurityFixAction[]; + applyPerms: (params: { + path: string; + mode: number; + require: "dir" | "file"; + }) => Promise; }): Promise { const credsDir = resolveOAuthDir(params.env, params.stateDir); params.actions.push(await safeChmod({ path: credsDir, mode: 0o700, require: "dir" })); @@ -294,18 +388,20 @@ async function chmodCredentialsAndAgentState(params: { // eslint-disable-next-line no-await-in-loop params.actions.push(await safeChmod({ path: agentRoot, mode: 0o700, require: "dir" })); // eslint-disable-next-line no-await-in-loop - params.actions.push(await safeChmod({ path: agentDir, mode: 0o700, require: "dir" })); + params.actions.push(await params.applyPerms({ path: agentDir, mode: 0o700, require: "dir" })); const authPath = path.join(agentDir, "auth-profiles.json"); // eslint-disable-next-line no-await-in-loop - params.actions.push(await safeChmod({ path: authPath, mode: 0o600, require: "file" })); + params.actions.push(await params.applyPerms({ path: authPath, mode: 0o600, require: "file" })); // eslint-disable-next-line no-await-in-loop - params.actions.push(await safeChmod({ path: sessionsDir, mode: 0o700, require: "dir" })); + params.actions.push( + await params.applyPerms({ path: sessionsDir, mode: 0o700, require: "dir" }), + ); const storePath = path.join(sessionsDir, "sessions.json"); // eslint-disable-next-line no-await-in-loop - params.actions.push(await safeChmod({ path: storePath, mode: 0o600, require: "file" })); + params.actions.push(await params.applyPerms({ path: storePath, mode: 0o600, require: "file" })); } } @@ -313,11 +409,16 @@ export async function fixSecurityFootguns(opts?: { env?: NodeJS.ProcessEnv; stateDir?: string; configPath?: string; + platform?: NodeJS.Platform; + exec?: ExecFn; }): Promise { const env = opts?.env ?? process.env; + const platform = opts?.platform ?? process.platform; + const exec = opts?.exec ?? runExec; + const isWindows = platform === "win32"; const stateDir = opts?.stateDir ?? resolveStateDir(env); const configPath = opts?.configPath ?? resolveConfigPath(env, stateDir); - const actions: SecurityFixChmodAction[] = []; + const actions: SecurityFixAction[] = []; const errors: string[] = []; const io = createConfigIO({ env, configPath }); @@ -352,8 +453,13 @@ export async function fixSecurityFootguns(opts?: { } } - actions.push(await safeChmod({ path: stateDir, mode: 0o700, require: "dir" })); - actions.push(await safeChmod({ path: configPath, mode: 0o600, require: "file" })); + const applyPerms = (params: { path: string; mode: number; require: "dir" | "file" }) => + isWindows + ? safeAclReset({ path: params.path, require: params.require, env, exec }) + : safeChmod({ path: params.path, mode: params.mode, require: params.require }); + + actions.push(await applyPerms({ path: stateDir, mode: 0o700, require: "dir" })); + actions.push(await applyPerms({ path: configPath, mode: 0o600, require: "file" })); if (snap.exists) { const includePaths = await collectIncludePathsRecursive({ @@ -362,15 +468,19 @@ export async function fixSecurityFootguns(opts?: { }).catch(() => []); for (const p of includePaths) { // eslint-disable-next-line no-await-in-loop - actions.push(await safeChmod({ path: p, mode: 0o600, require: "file" })); + actions.push(await applyPerms({ path: p, mode: 0o600, require: "file" })); } } - await chmodCredentialsAndAgentState({ env, stateDir, cfg: snap.config ?? {}, actions }).catch( - (err) => { - errors.push(`chmodCredentialsAndAgentState failed: ${String(err)}`); - }, - ); + await chmodCredentialsAndAgentState({ + env, + stateDir, + cfg: snap.config ?? {}, + actions, + applyPerms, + }).catch((err) => { + errors.push(`chmodCredentialsAndAgentState failed: ${String(err)}`); + }); return { ok: errors.length === 0, diff --git a/src/security/windows-acl.ts b/src/security/windows-acl.ts new file mode 100644 index 000000000..0a6779214 --- /dev/null +++ b/src/security/windows-acl.ts @@ -0,0 +1,203 @@ +import os from "node:os"; + +import { runExec } from "../process/exec.js"; + +export type ExecFn = typeof runExec; + +export type WindowsAclEntry = { + principal: string; + rights: string[]; + rawRights: string; + canRead: boolean; + canWrite: boolean; +}; + +export type WindowsAclSummary = { + ok: boolean; + entries: WindowsAclEntry[]; + untrustedWorld: WindowsAclEntry[]; + untrustedGroup: WindowsAclEntry[]; + trusted: WindowsAclEntry[]; + error?: string; +}; + +const INHERIT_FLAGS = new Set(["I", "OI", "CI", "IO", "NP"]); +const WORLD_PRINCIPALS = new Set([ + "everyone", + "users", + "builtin\\users", + "authenticated users", + "nt authority\\authenticated users", +]); +const TRUSTED_BASE = new Set([ + "nt authority\\system", + "system", + "builtin\\administrators", + "creator owner", +]); +const WORLD_SUFFIXES = ["\\users", "\\authenticated users"]; +const TRUSTED_SUFFIXES = ["\\administrators", "\\system"]; + +const normalize = (value: string) => value.trim().toLowerCase(); + +export function resolveWindowsUserPrincipal(env?: NodeJS.ProcessEnv): string | null { + const username = env?.USERNAME?.trim() || os.userInfo().username?.trim(); + if (!username) return null; + const domain = env?.USERDOMAIN?.trim(); + return domain ? `${domain}\\${username}` : username; +} + +function buildTrustedPrincipals(env?: NodeJS.ProcessEnv): Set { + const trusted = new Set(TRUSTED_BASE); + const principal = resolveWindowsUserPrincipal(env); + if (principal) { + trusted.add(normalize(principal)); + const parts = principal.split("\\"); + const userOnly = parts.at(-1); + if (userOnly) trusted.add(normalize(userOnly)); + } + return trusted; +} + +function classifyPrincipal( + principal: string, + env?: NodeJS.ProcessEnv, +): "trusted" | "world" | "group" { + const normalized = normalize(principal); + const trusted = buildTrustedPrincipals(env); + if (trusted.has(normalized) || TRUSTED_SUFFIXES.some((s) => normalized.endsWith(s))) + return "trusted"; + if (WORLD_PRINCIPALS.has(normalized) || WORLD_SUFFIXES.some((s) => normalized.endsWith(s))) + return "world"; + return "group"; +} + +function rightsFromTokens(tokens: string[]): { canRead: boolean; canWrite: boolean } { + const upper = tokens.join("").toUpperCase(); + const canWrite = + upper.includes("F") || upper.includes("M") || upper.includes("W") || upper.includes("D"); + const canRead = upper.includes("F") || upper.includes("M") || upper.includes("R"); + return { canRead, canWrite }; +} + +export function parseIcaclsOutput(output: string, targetPath: string): WindowsAclEntry[] { + const entries: WindowsAclEntry[] = []; + const normalizedTarget = targetPath.trim(); + const lowerTarget = normalizedTarget.toLowerCase(); + const quotedTarget = `"${normalizedTarget}"`; + const quotedLower = quotedTarget.toLowerCase(); + + for (const rawLine of output.split(/\r?\n/)) { + const line = rawLine.trimEnd(); + if (!line.trim()) continue; + const trimmed = line.trim(); + const lower = trimmed.toLowerCase(); + if ( + lower.startsWith("successfully processed") || + lower.startsWith("processed") || + lower.startsWith("failed processing") || + lower.startsWith("no mapping between account names") + ) { + continue; + } + + let entry = trimmed; + if (lower.startsWith(lowerTarget)) { + entry = trimmed.slice(normalizedTarget.length).trim(); + } else if (lower.startsWith(quotedLower)) { + entry = trimmed.slice(quotedTarget.length).trim(); + } + if (!entry) continue; + + const idx = entry.indexOf(":"); + if (idx === -1) continue; + + const principal = entry.slice(0, idx).trim(); + const rawRights = entry.slice(idx + 1).trim(); + const tokens = + rawRights + .match(/\(([^)]+)\)/g) + ?.map((token) => token.slice(1, -1).trim()) + .filter(Boolean) ?? []; + if (tokens.some((token) => token.toUpperCase() === "DENY")) continue; + const rights = tokens.filter((token) => !INHERIT_FLAGS.has(token.toUpperCase())); + if (rights.length === 0) continue; + const { canRead, canWrite } = rightsFromTokens(rights); + entries.push({ principal, rights, rawRights, canRead, canWrite }); + } + + return entries; +} + +export function summarizeWindowsAcl( + entries: WindowsAclEntry[], + env?: NodeJS.ProcessEnv, +): Pick { + const trusted: WindowsAclEntry[] = []; + const untrustedWorld: WindowsAclEntry[] = []; + const untrustedGroup: WindowsAclEntry[] = []; + for (const entry of entries) { + const classification = classifyPrincipal(entry.principal, env); + if (classification === "trusted") trusted.push(entry); + else if (classification === "world") untrustedWorld.push(entry); + else untrustedGroup.push(entry); + } + return { trusted, untrustedWorld, untrustedGroup }; +} + +export async function inspectWindowsAcl( + targetPath: string, + opts?: { env?: NodeJS.ProcessEnv; exec?: ExecFn }, +): Promise { + const exec = opts?.exec ?? runExec; + try { + const { stdout, stderr } = await exec("icacls", [targetPath]); + const output = `${stdout}\n${stderr}`.trim(); + const entries = parseIcaclsOutput(output, targetPath); + const { trusted, untrustedWorld, untrustedGroup } = summarizeWindowsAcl(entries, opts?.env); + return { ok: true, entries, trusted, untrustedWorld, untrustedGroup }; + } catch (err) { + return { + ok: false, + entries: [], + trusted: [], + untrustedWorld: [], + untrustedGroup: [], + error: String(err), + }; + } +} + +export function formatWindowsAclSummary(summary: WindowsAclSummary): string { + if (!summary.ok) return "unknown"; + const untrusted = [...summary.untrustedWorld, ...summary.untrustedGroup]; + if (untrusted.length === 0) return "trusted-only"; + return untrusted.map((entry) => `${entry.principal}:${entry.rawRights}`).join(", "); +} + +export function formatIcaclsResetCommand( + targetPath: string, + opts: { isDir: boolean; env?: NodeJS.ProcessEnv }, +): string { + const user = resolveWindowsUserPrincipal(opts.env) ?? "%USERNAME%"; + const grant = opts.isDir ? "(OI)(CI)F" : "F"; + return `icacls "${targetPath}" /inheritance:r /grant:r "${user}:${grant}" /grant:r "SYSTEM:${grant}"`; +} + +export function createIcaclsResetCommand( + targetPath: string, + opts: { isDir: boolean; env?: NodeJS.ProcessEnv }, +): { command: string; args: string[]; display: string } | null { + const user = resolveWindowsUserPrincipal(opts.env); + if (!user) return null; + const grant = opts.isDir ? "(OI)(CI)F" : "F"; + const args = [ + targetPath, + "/inheritance:r", + "/grant:r", + `${user}:${grant}`, + "/grant:r", + `SYSTEM:${grant}`, + ]; + return { command: "icacls", args, display: formatIcaclsResetCommand(targetPath, opts) }; +} diff --git a/src/wizard/onboarding.gateway-config.ts b/src/wizard/onboarding.gateway-config.ts index e8163cbad..c68836b32 100644 --- a/src/wizard/onboarding.gateway-config.ts +++ b/src/wizard/onboarding.gateway-config.ts @@ -93,11 +93,6 @@ export async function configureGatewayForOnboarding( : ((await prompter.select({ message: "Gateway auth", options: [ - { - value: "off", - label: "Off (loopback only)", - hint: "Not recommended unless you fully trust local processes", - }, { value: "token", label: "Token", @@ -165,7 +160,6 @@ export async function configureGatewayForOnboarding( // Safety + constraints: // - Tailscale wants bind=loopback so we never expose a non-loopback server + tailscale serve/funnel at once. - // - Auth off only allowed for bind=loopback. // - Funnel requires password auth. if (tailscaleMode !== "off" && bind !== "loopback") { await prompter.note("Tailscale requires bind=loopback. Adjusting bind to loopback.", "Note"); @@ -173,11 +167,6 @@ export async function configureGatewayForOnboarding( customBindHost = undefined; } - if (authMode === "off" && bind !== "loopback") { - await prompter.note("Non-loopback bind requires auth. Switching to token auth.", "Note"); - authMode = "token"; - } - if (tailscaleMode === "funnel" && authMode !== "password") { await prompter.note("Tailscale funnel requires password auth.", "Note"); authMode = "password"; diff --git a/src/wizard/onboarding.ts b/src/wizard/onboarding.ts index 1016e5680..39d17befa 100644 --- a/src/wizard/onboarding.ts +++ b/src/wizard/onboarding.ts @@ -244,7 +244,6 @@ export async function runOnboardingWizard( return "Auto"; }; const formatAuth = (value: GatewayAuthChoice) => { - if (value === "off") return "Off (loopback only)"; if (value === "token") return "Token (default)"; return "Password"; }; @@ -361,7 +360,6 @@ export async function runOnboardingWizard( prompter, store: authStore, includeSkip: true, - includeClaudeCliIfMissing: true, })); const authResult = await applyAuthChoice({ diff --git a/ui/src/ui/views/debug.ts b/ui/src/ui/views/debug.ts index 35e2e1af2..d33eaffc7 100644 --- a/ui/src/ui/views/debug.ts +++ b/ui/src/ui/views/debug.ts @@ -21,6 +21,22 @@ export type DebugProps = { }; export function renderDebug(props: DebugProps) { + const securityAudit = + props.status && typeof props.status === "object" + ? (props.status as { securityAudit?: { summary?: Record } }).securityAudit + : null; + const securitySummary = securityAudit?.summary ?? null; + const critical = securitySummary?.critical ?? 0; + const warn = securitySummary?.warn ?? 0; + const info = securitySummary?.info ?? 0; + const securityTone = critical > 0 ? "danger" : warn > 0 ? "warn" : "success"; + const securityLabel = + critical > 0 + ? `${critical} critical` + : warn > 0 + ? `${warn} warnings` + : "No critical issues"; + return html`
@@ -36,6 +52,12 @@ export function renderDebug(props: DebugProps) {
Status
+ ${securitySummary + ? html`
+ Security audit: ${securityLabel}${info > 0 ? ` · ${info} info` : ""}. Run + clawdbot security audit --deep for details. +
` + : nothing}
${JSON.stringify(props.status ?? {}, null, 2)}