diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 99e8088..20d1592 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -20,10 +20,10 @@ body: validations: required: true - type: input - id: macos + id: environment attributes: - label: macOS version and Mac - placeholder: "macOS 15.5, M2 MacBook Air" + label: Operating system and installation + placeholder: "macOS 15.5 DMG, or Ubuntu 24.04 Linux CLI tarball" validations: required: true - type: input diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index c1fbfa4..5fae59b 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -20,8 +20,8 @@ body: - type: input id: environment attributes: - label: macOS version and client - placeholder: "macOS 15.5, client name/version" + label: Operating system, installation, and client + placeholder: "Ubuntu 24.04, Linux CLI tarball, client name/version" validations: required: true - type: textarea diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9121701..245c9e1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ Please do not open a pull request with code or documentation changes yet. It may 1. Install the latest stable release and check existing issues. 2. Confirm the behavior with the smallest route and request that reproduce it. -3. Record the ReRouted version, macOS version, provider type, authentication method, model, client, and whether the request streamed. +3. Record the ReRouted version, operating system, installation method, provider type, authentication method, model, client, and whether the request streamed. 4. Replace account names, model identifiers, or request content when they are not essential to the report. Never attach `config.json` or paste full, unreviewed diagnostics. Remove API keys, gateway keys, tokens, OAuth callback URLs or codes, cookies, account IDs, email addresses, prompts, and private provider responses. @@ -40,7 +40,7 @@ npm test git diff --check ``` -Node.js 22.13 or newer is required. The packaged application currently targets Apple Silicon and macOS 12 Monterey or newer. +Node.js 22.13 or newer is required. The headless runtime is supported on Linux. The packaged desktop application targets Apple Silicon and macOS 12 Monterey or newer. Maintainers handle package version changes, signing, notarization, release publication, and installation verification. Reproduction branches should not include generated release artifacts or real provider credentials. diff --git a/PRIVACY.md b/PRIVACY.md index a2c2a5a..6788655 100644 --- a/PRIVACY.md +++ b/PRIVACY.md @@ -1,6 +1,6 @@ # Privacy -ReRouted is a local macOS application. It has no ReRouted account, hosted control plane, or third-party product analytics service. +ReRouted is a local macOS application and Linux headless service. It has no ReRouted account, hosted control plane, or third-party product analytics service. This document describes the application as shipped. The upstream providers and clients you connect have their own privacy policies and data practices. @@ -8,9 +8,9 @@ This document describes the application as shipped. The upstream providers and c The public `rerouted.dev` website is a static site delivered through Cloudflare and loads its display fonts from Google Fonts. Those services may receive ordinary web-request metadata such as your IP address, browser headers, and requested asset URLs under their own privacy policies. The website does not include ReRouted product analytics or an account system. -## Data stored on your Mac +## Data stored on your machine -ReRouted stores application data in its macOS Application Support directory, normally `~/Library/Application Support/ReRouted`. Existing installations may use `~/Library/Application Support/rerouted`. +On macOS, ReRouted stores application data in its Application Support directory, normally `~/Library/Application Support/ReRouted`; existing installations may use `~/Library/Application Support/rerouted`. On Linux, the headless runtime uses `$XDG_CONFIG_HOME/rerouted`, normally `~/.config/rerouted`. `REROUTED_USER_DATA` or the CLI `--data-dir` option can override the headless location. Local data includes: @@ -18,13 +18,13 @@ Local data includes: - Request metadata, provider and route selections, statuses, timestamps, and token counts in the uncapped `usage.sqlite` database. - Gateway, OAuth, update, and routing diagnostics in `rerouted.log`. -Prompt bodies are not intentionally persisted. Provider credentials and gateway keys are not encrypted at rest. ReRouted restricts local file permissions where macOS supports doing so, but anyone who can access your macOS user account or its files may be able to read them. +Prompt bodies are not intentionally persisted. Provider credentials and gateway keys are not encrypted at rest. ReRouted restricts local file permissions where the operating system supports doing so, but anyone who can access your local user account or its files may be able to read them. Diagnostics can contain provider error text, model and route names, account identifiers, and OAuth metadata. Treat logs as sensitive and review every line before sharing an excerpt. ## Local credential discovery -Credential discovery happens when you choose to scan or import accounts. Depending on the providers installed on the Mac, ReRouted may inspect supported entries in the Codex configuration, the Claude Code macOS Keychain or supported local auth files, ReRouted auth-profile folders, and Antigravity-named JSON files in supported folders including `~/Downloads`. ReRouted summarizes discoveries before import; selected credentials are copied into its own configuration. +Credential discovery happens when you choose to scan or import accounts. Depending on the providers installed on the machine, ReRouted may inspect supported entries in the Codex configuration, the Claude Code macOS Keychain or supported local auth files, ReRouted auth-profile folders, and Antigravity-named JSON files in supported folders including `~/Downloads`. ReRouted summarizes discoveries before import; selected credentials are copied into its own configuration. At startup, ReRouted may also read the local `~/.grok/auth.json` file to attach a human-readable identity to an xAI account that is already connected. This startup lookup only updates local account labeling; it does not import a new account by itself. @@ -35,9 +35,9 @@ ReRouted makes network requests only as needed to operate features you choose: - Completion requests, credentials, and supported image inputs are sent to the selected upstream provider. - OAuth authorization and token refresh requests are sent to the relevant provider. - Quota checks are sent to supported providers when you open the Quota page, every 60 seconds while that page remains open, or when you manually refresh it. -- Automatic update checks contact `update.electronjs.org` shortly after launch and about every six hours; signed update downloads come from GitHub Releases. +- The macOS app checks `update.electronjs.org` shortly after launch and about every six hours; signed update downloads come from GitHub Releases. The Linux CLI does not perform automatic update checks and is updated through its package manager. -The gateway binds to `127.0.0.1` by default. If you enable network access, it binds to `0.0.0.0`; devices that can reach the Mac can attempt to access it, and the gateway bearer key becomes the primary access boundary. +The gateway binds to `127.0.0.1` by default. If you enable network access, it binds to `0.0.0.0`; devices that can reach the machine can attempt to access it. Gateway API routes require a generated gateway key. In the headless runtime, `/dashboard/` uses a separate browser session and the local admin password; first-time browser setup is allowed only over loopback. ## OAuth and subscription notice @@ -45,13 +45,13 @@ ReRouted is independent and is not affiliated with or endorsed by any upstream p ## Retention and deletion -Usage history is not automatically pruned and remains on the Mac until the Application Support data is removed. Existing installations may also retain the former `usage.json` as a one-time migration backup. Logs can be cleared from the Activity diagnostics view. +Usage history is not automatically pruned and remains on the machine until the local data directory is removed. Existing installations may also retain the former `usage.json` as a one-time migration backup. Logs can be cleared from the Activity diagnostics view. Uninstalling the application bundle does not automatically remove Application Support data. To remove ReRouted and its stored credentials completely: -1. Quit ReRouted. -2. Delete `/Applications/ReRouted.app`. -3. Delete the ReRouted Application Support directory listed above. +1. Stop ReRouted. +2. On macOS, delete `/Applications/ReRouted.app`; on Linux, uninstall `@gitcommit90/rerouted` through npm. +3. Delete the relevant ReRouted data directory listed above. Deleting the Application Support directory permanently removes connected accounts, keys, routes, settings, usage history, and logs. Back up only the data you intentionally want to retain. diff --git a/README.md b/README.md index 9915598..0ca1fc0 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@

ReRouted

Stop rewiring your AI tools every time an account hits quota.

- A macOS menu-bar router that puts your connected accounts, models, - API keys, and fallback routes behind one local endpoint. + A local router for macOS and Linux that puts your connected accounts, + models, API keys, and fallback routes behind one endpoint.

Website | @@ -18,6 +18,7 @@

GitHub release macOS Apple Silicon + Linux headless Local first MIT license

@@ -51,9 +52,9 @@ The promise is deliberately focused: ReRouted exposes model discovery, OpenAI-st | A model name hard-codes a provider or account | A named route describes intent: `coding`, `fast`, `review` | | Quota means stopping to edit settings | The next route member is attempted automatically | | Multiple OAuth accounts are managed by hand | OAuth accounts share a provider pool and fall through in order | -| Requests and failures are scattered | Activity, quota, token counts, and logs live in the menu bar | +| Requests and failures are scattered | Activity, quota, token counts, and logs live in one control plane | -No hosted control plane. No account with ReRouted. No Dock icon. The gateway and panel run together on your Mac. +No hosted control plane and no ReRouted account. On macOS, the gateway and panel run together in the menu bar. On Linux, one headless process serves the gateway, interactive CLI setup, and the same control plane at `/dashboard/`. ## How it works @@ -87,7 +88,7 @@ Timeouts and retryable `408`, `429`, and `5xx` responses can advance the route. - **OAuth accounts:** ChatGPT, Claude, Antigravity, and xAI. - **API-key presets:** OpenRouter, NVIDIA NIM, Cloudflare, and GLM Coding. - **Custom upstreams:** any service that exposes the OpenAI chat-completions shape ReRouted expects. -- **Local credential discovery:** supported credentials already stored in known files or the macOS Keychain can be imported instead of re-entered. +- **Local credential discovery:** supported credentials already stored in known files, or in the macOS Keychain where available, can be imported instead of re-entered. - **Multiple accounts:** connect more than one account for the same provider and use shared or account-specific model routes. OAuth accounts and keyed providers can live in the same route. ReRouted handles request translation and normalizes supported upstream responses back into the shape your client expects. @@ -98,7 +99,7 @@ ReRouted is an independent project and is not affiliated with or endorsed by any ## Quick start -### 1. Install +### 1. Install on macOS [Download the latest ReRouted release for Apple Silicon](https://github.com/gitcommit90/rerouted/releases/latest), open the DMG, and drag ReRouted to Applications. @@ -108,6 +109,41 @@ The macOS release is Developer ID signed, notarized by Apple, and stapled for a After the first install, ReRouted checks stable releases in the background. You can also use **Settings → Software updates** at any time; new versions download inside the app and install on restart. +### Or install the headless Linux CLI + +ReRouted requires Node.js 22.13 or newer. Install the current CLI tarball from the stable GitHub Release; it provides the short `rerouted` command: + +```bash +npm install --global https://github.com/gitcommit90/rerouted/releases/latest/download/ReRouted-linux-node.tgz +rerouted +``` + +The first run opens the interactive terminal setup when a TTY is attached and prints both local URLs: + +```text +Gateway http://127.0.0.1:4949/v1 +Dashboard http://127.0.0.1:4949/dashboard/ +``` + +When started by systemd, Docker, SSH automation, or another non-interactive process, open the printed dashboard URL from the same machine to finish first-time setup. The browser flow covers the same providers, routes, activity, quota, keys, and settings as the menu-bar app. Dashboard sessions require the local admin password after onboarding. Run `rerouted help` for bind, port, and data-directory options. + +For a persistent user service after setup: + +```ini +# ~/.config/systemd/user/rerouted.service +[Unit] +Description=ReRouted local AI gateway + +[Service] +ExecStart=%h/.local/bin/rerouted --no-interactive +Restart=on-failure + +[Install] +WantedBy=default.target +``` + +Use the actual path from `command -v rerouted` if npm installed it elsewhere, then run `systemctl --user enable --now rerouted`. + ### 2. Connect what you already use Import a detected credential, complete an OAuth flow, or add an API key. ReRouted keeps OAuth accounts and keyed providers side by side. @@ -152,21 +188,21 @@ Claude Code uses the Anthropic Messages route. Point it at the gateway with its ReRouted accepts both `/v1/messages` and `/v1/v1/messages`, so current Claude Code versions work whether they append `/messages` or `/v1/messages` to that base URL. -## The menu-bar control plane +## One control plane, two shells - **Status:** gateway health, endpoint, latest route, and recent traffic. - **Accounts:** OAuth sessions, imported credentials, API keys, and model availability. - **Routes:** named fallback or round-robin model groups with explicit ordering controls. - **Activity:** requests, failures, token counts, route choices, and account usage. - **Quota:** provider-specific subscription windows where supported. -- **Settings:** gateway keys, localhost or network binding, login launch, security controls, and signed software updates. +- **Settings:** gateway keys, localhost or network binding, security controls, and platform-appropriate startup/update information.

ReRouted status panel ReRouted route editor

-The gateway continues running when the panel is hidden. Quitting ReRouted stops both. +On macOS, hiding the panel leaves the gateway running. On Linux, keep the `rerouted` process or your service manager running; closing the dashboard tab does not stop it. ## API surface @@ -174,6 +210,7 @@ The gateway continues running when the panel is hidden. Quitting ReRouted stops | --- | --- | | `GET /` | Same unauthenticated local health response as `/health` | | `GET /health` | Local gateway health and listening port | +| `GET /dashboard/` | Local web control plane in the headless runtime | | `GET /v1/models` | Enabled direct models and named routes | | `POST /v1/chat/completions` | Streaming or non-streaming routed chat completions | | `POST /v1/responses` | Streaming or non-streaming routed Responses API requests | @@ -192,6 +229,7 @@ Requests require a generated gateway key except for `/` and `/health`. OpenAI ro - Provider credentials are not encrypted at rest. - Requests and the credentials needed to authorize them are sent to the upstream services you choose. - Enabling network access binds the gateway to `0.0.0.0`; only do that on a network you trust. +- The dashboard uses a separate, per-browser session protected by the local admin password. First-time browser setup is restricted to loopback. See [Privacy](./PRIVACY.md) for the local files ReRouted keeps, the network services it contacts, and how to remove its data. @@ -203,9 +241,9 @@ See [Privacy](./PRIVACY.md) for the local files ReRouted keeps, the network serv ReRouted is open source under the [MIT License](./LICENSE). External code contributions are not currently accepted while the contribution process is finalized; focused issues and sanitized reproduction reports are welcome. See [Contributing](./CONTRIBUTING.md) for the current policy. -## Build from source +## Build or run from source -Requires Node.js 22.13 or newer. Packaging requires macOS and produces an Apple Silicon DMG. +Requires Node.js 22.13 or newer. The test suite and headless runtime run on Linux; DMG packaging remains a separate macOS-only path. ```bash git clone https://github.com/gitcommit90/rerouted.git @@ -215,17 +253,23 @@ npm test npm start ``` +Run the headless CLI instead: + +```bash +npm run start:headless +``` + Package the macOS app and DMG: ```bash npm run package:dmg ``` -The implementation is intentionally small: Electron, Node's built-in HTTP server, and a vanilla HTML/CSS/JavaScript renderer. See [the architecture document](./docs/architecture.md) for the runtime, routing, persistence, and packaging details. +The shared implementation uses Node's built-in HTTP server and a vanilla HTML/CSS/JavaScript control plane. Electron supplies the macOS menu-bar shell; the Linux CLI supplies the headless shell and serves that same renderer from `/dashboard/`. See [the architecture document](./docs/architecture.md) for the runtime, routing, persistence, and packaging details. ## Current release -Public builds are Developer ID signed, notarized, stapled, and distributed through stable GitHub Releases with in-app updates. The public API is intentionally limited to health, model discovery, chat completions, Responses, and Anthropic Messages compatibility; a published third-party client compatibility matrix is still forthcoming. +macOS builds are Developer ID signed, notarized, stapled, and distributed through stable GitHub Releases with in-app updates. The Linux CLI is a separate npm-compatible tarball on the same stable release and is updated by rerunning its npm install command. The public API is intentionally limited to health, model discovery, chat completions, Responses, and Anthropic Messages compatibility; a published third-party client compatibility matrix is still forthcoming. ## License diff --git a/SECURITY.md b/SECURITY.md index b00ce9c..3c36d61 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -4,7 +4,7 @@ ReRouted handles OAuth sessions, API keys, gateway keys, and local routing data. ## Supported versions -Security fixes are provided for the latest stable release. Update through **Settings -> Software updates** or install the newest signed release before reporting a problem that may already be fixed. +Security fixes are provided for the latest stable release. On macOS, update through **Settings -> Software updates** or install the newest signed release. On Linux, reinstall the current `ReRouted-linux-node.tgz` asset through npm before reporting a problem that may already be fixed. ## Reporting a vulnerability @@ -14,10 +14,10 @@ Use GitHub's private [Report a vulnerability](https://github.com/gitcommit90/rer Include only the information needed to investigate: -- ReRouted version and macOS version. +- ReRouted version, operating system, and installation method. - The affected feature and realistic impact. - Reproduction steps that use placeholder credentials and sanitized data. -- Whether the gateway was bound only to localhost or exposed to a network. +- Whether the gateway/dashboard was bound only to localhost or exposed to a network. Never include API keys, gateway keys, access or refresh tokens, OAuth authorization codes, callback URLs, cookies, raw `config.json`, full unreviewed logs, account identifiers, or private prompts. diff --git a/docs/architecture.md b/docs/architecture.md index a225e41..d909c1f 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -4,13 +4,13 @@ This document describes the implementation in this repository today. It is the c ## Runtime shape -ReRouted is one Electron process with three jobs: +ReRouted has two shells around one shared runtime: -1. Own the macOS menu-bar icon and panel window. -2. Run the local HTTP gateway. -3. Persist provider, route, usage, and diagnostic state. +1. The macOS Electron shell owns the menu-bar icon, native panel, login-item preference, and signed updater. +2. The Linux headless shell owns the terminal lifecycle, interactive setup, and dashboard HTTP transport. +3. Both create the same store, router, gateway, usage, request-activity, quota, and control-plane services. -There is no separate daemon. Closing or hiding the panel does not stop the gateway; quitting ReRouted does. +There is no hosted control plane. On macOS, closing or hiding the panel does not stop the gateway; quitting ReRouted does. On Linux, closing the dashboard does not stop the gateway; stopping the `rerouted` process does. ```text OpenAI-style or Anthropic Messages client @@ -32,13 +32,19 @@ src/lib/providers/* ---> upstream provider API Response in the client's original API shape ``` -## Main process and panel +## Shared control plane and platform shells -`src/main.js` owns the single-instance lock, tray, frameless panel window, login-item preference, IPC handlers, store, usage store, router, and gateway lifecycle. +`src/lib/control-plane.js` owns the platform-neutral actions used by onboarding and the Status, Accounts, Routes, Activity, Quota, and Settings pages. Provider additions, OAuth completion, named routes, model controls, gateway keys, admin authentication, quota, usage, and logs pass through that one contract. + +`src/main.js` wires the contract to allowlisted Electron IPC and adds the single-instance lock, tray, frameless panel window, login-item preference, macOS session authentication, and updater. + +`src/cli/index.js` wires the same contract to a headless process created by `src/lib/headless-runtime.js`. The CLI performs interactive first-run setup when attached to a TTY. `src/lib/dashboard.js` serves the shared renderer and a JSON action transport at `/dashboard/`. The panel is a local file loaded from `src/renderer/index.html`. `src/preload.js` exposes an allowlisted IPC bridge to `src/renderer/app.js`; context isolation and the renderer sandbox are enabled, and renderer Node integration is disabled. -The renderer is vanilla HTML, CSS, and JavaScript. It renders onboarding and the Status, Accounts, Routes, Activity, and Settings pages from state returned by the main process. +The renderer is vanilla HTML, CSS, and JavaScript. It renders onboarding and the Status, Accounts, Routes, Activity, and Settings pages from state returned by the shared control plane. `src/renderer/web-api.js` provides the browser transport when Electron's preload bridge is absent. + +Each browser receives an independent, HttpOnly, same-site dashboard session. After onboarding, sensitive state and mutations require the scrypt-hashed admin password for that browser session. Browser action requests require an exact same-origin match, repeated password failures are throttled, dashboard assets are allowlisted, and first-time browser setup is accepted only over loopback. The gateway's `rr-` bearer keys and dashboard sessions are separate authentication boundaries. ## Gateway contract @@ -48,13 +54,14 @@ The renderer is vanilla HTML, CSS, and JavaScript. It renders onboarding and the | --- | --- | --- | | `GET /` | None | Same process health response as `/health` | | `GET /health` | None | App name and current listening port | +| `GET /dashboard/` | Browser session | Headless control-plane renderer and same-origin action transport | | `GET /v1/models` | Bearer key | Enabled provider models plus named route IDs | | `POST /v1/chat/completions` | Bearer key | Streaming or non-streaming routed chat completion | | `POST /v1/responses` | Bearer key | Responses requests adapted through the chat-completions router | | `POST /v1/messages` | Bearer key or `x-api-key` | Anthropic Messages requests adapted through the chat-completions router | | `POST /v1/messages/count_tokens` | Bearer key or `x-api-key` | Local best-effort input-token estimate without an upstream request | -The default bind is `127.0.0.1:4949`. Settings can switch the host to `0.0.0.0` for LAN or Tailscale access. CORS is currently `*`, so the bearer key is the gateway's access boundary when network binding is enabled. +The default bind is `127.0.0.1:4949`. Settings or CLI options can switch the host to `0.0.0.0` for LAN or Tailscale access. CORS for `/v1` is currently `*`, so the bearer key is the API boundary when network binding is enabled. Dashboard control requests do not use that CORS policy and require same-origin browser requests plus the dashboard session/password boundary above. JSON request bodies are limited to 32 MiB. Oversized requests receive a JSON `413` response before routing begins. @@ -97,15 +104,15 @@ OAuth access-token refreshes are persisted back to the provider record when an a ## OAuth and credential discovery -`src/lib/oauth.js` implements PKCE browser flows and loopback callbacks. Some providers require the user to paste a callback URL or code into the panel. +`src/lib/oauth.js` implements PKCE browser flows and loopback callbacks. Some providers require the user to paste a callback URL or code into the panel, dashboard, or interactive terminal setup. -`src/lib/detect.js` performs read-only discovery of supported provider credentials already stored in known local files or the macOS Keychain. +`src/lib/detect.js` performs read-only discovery of supported provider credentials already stored in known local files or, on macOS, the Keychain. Selected credentials are copied into ReRouted's config. ReRouted does not continue reading the original source on each request. ## Persistence -Electron's `userData` directory contains: +The macOS Electron `userData` directory or Linux `$XDG_CONFIG_HOME/rerouted` directory contains: | File | Contents | | --- | --- | @@ -123,6 +130,8 @@ The admin password is scrypt-hashed. Provider credentials and gateway keys are n ## Packaging +The Linux CLI is packaged separately as an npm-compatible tarball named `ReRouted--linux-node.tgz`, plus the stable alias `ReRouted-linux-node.tgz`; both install the `rerouted` executable. This is intentionally separate from the DMG and native updater path, and the CLI performs no automatic update checks. + `scripts/package-mac-dmg.js` must run on macOS. It: 1. Packages Electron for `darwin/arm64`. @@ -146,7 +155,7 @@ Packaged builds use Electron's native macOS updater and the public stable GitHub ## Tests and current gaps -`tests/gateway.test.js` covers password hashing, config persistence, bearer auth, request-size enforcement, model listing, streaming and non-streaming completion paths, fallback, round-robin ordering, timeouts, OAuth request behavior, token refresh, format translation, SSE decoding, multiple gateway keys, disabled models, and usage aggregation. +`tests/gateway.test.js` covers password hashing, config persistence, bearer auth, request-size enforcement, model listing, streaming and non-streaming completion paths, fallback, round-robin ordering, timeouts, OAuth request behavior, token refresh, format translation, SSE decoding, multiple gateway keys, disabled models, and usage aggregation. `tests/control-plane.test.js`, `tests/dashboard.test.js`, and `tests/cli.test.js` cover the shared action contract, session isolation, redaction, same-origin boundaries, login throttling, asset serving, Linux paths, the process lock, and real headless startup. Important gaps to keep visible: @@ -159,4 +168,4 @@ Important gaps to keep visible: ## Maintenance rules -Read [docs/release-checklist.md](release-checklist.md) before changing the app. A merged commit is only one stage of a ReRouted iteration; the DMG and MacBook Air installation are part of the deliverable. +Read [docs/release-checklist.md](release-checklist.md) before changing the app. A merged commit is only one stage of a ReRouted iteration; the DMG, Linux tarball, and target-system installation checks are part of the deliverable. diff --git a/docs/release-checklist.md b/docs/release-checklist.md index 912d149..3639312 100644 --- a/docs/release-checklist.md +++ b/docs/release-checklist.md @@ -1,6 +1,6 @@ # Release checklist -This is the required finish line for every ReRouted change, including fixes, features, refactors, UI adjustments, and documentation iterations. +This is the required finish line for every ReRouted change, including fixes, features, refactors, UI adjustments, and documentation iterations. Releases that include the headless runtime must verify both the macOS artifacts and Linux CLI package. **Do not say "done" until every check has passed.** @@ -127,9 +127,52 @@ trap - EXIT Record the version, merged commit, DMG filename, and SHA-256 before installation. +## 5b. Build the Linux CLI from merged `main` + +From an exact clean checkout of the same merged commit on Linux: + +```bash +set -euo pipefail + +test "$(git rev-parse HEAD)" = "$MERGED_COMMIT" +test -z "$(git status --porcelain)" +npm ci +npm test +npm run package:linux + +CLI_TGZ="dist/ReRouted-${VERSION}-linux-node.tgz" +CLI_LATEST="dist/ReRouted-linux-node.tgz" +test -s "$CLI_TGZ" +test -s "$CLI_LATEST" +CLI_SHA="$(sha256sum "$CLI_TGZ" | awk '{print $1}')" +test "$(sha256sum "$CLI_LATEST" | awk '{print $1}')" = "$CLI_SHA" +tar -tzf "$CLI_TGZ" | grep -Fx 'package/LICENSE' +tar -tzf "$CLI_TGZ" | grep -Fx 'package/src/cli/index.js' +tar -tzf "$CLI_TGZ" | grep -Fx 'package/src/renderer/index.html' +test -z "$(tar -tzf "$CLI_TGZ" | grep -E '(^|/)AGENTS\.md$' || true)" + +INSTALL_ROOT="$(mktemp -d)" +mkdir -p "$INSTALL_ROOT/home" +HOME="$INSTALL_ROOT/home" npm install --global --prefix "$INSTALL_ROOT/npm" "$(realpath "$CLI_TGZ")" +test "$("$INSTALL_ROOT/npm/bin/rerouted" --version)" = "$VERSION" +"$INSTALL_ROOT/npm/bin/rerouted" --data-dir "$INSTALL_ROOT/data" --port 54949 --no-interactive >"$INSTALL_ROOT/out" 2>"$INSTALL_ROOT/err" & +CLI_PID=$! +for _ in $(seq 1 30); do + curl -fsS http://127.0.0.1:54949/health && break + sleep 1 +done +curl -fsS http://127.0.0.1:54949/dashboard/ | grep -F 'web-api.js' +kill -TERM "$CLI_PID" +wait "$CLI_PID" +test ! -e "$INSTALL_ROOT/data/rerouted.pid" +rm -rf "$INSTALL_ROOT" +``` + +Record the versioned filename and SHA-256. The stable alias must be byte-for-byte identical. + ## 6. Publish the exact build -Tag the exact commit used for packaging. Create a draft release, upload both verified artifacts, and publish only after their server-side digests match. Publishing is the update activation point. +Tag the exact commit used for packaging. Create a draft release, upload every verified artifact, and publish only after their server-side digests match. Publishing is the macOS update activation point and makes the stable Linux alias public. ```bash set -euo pipefail @@ -137,12 +180,16 @@ set -euo pipefail TAG="v${VERSION}" LOCAL_SHA="$(shasum -a 256 "$DMG" | awk '{print $1}')" UPDATE_SHA="$(shasum -a 256 "$UPDATE_ZIP" | awk '{print $1}')" +CLI_TGZ="$ORIGINAL_REPO/dist/ReRouted-${VERSION}-linux-node.tgz" +CLI_LATEST="$ORIGINAL_REPO/dist/ReRouted-linux-node.tgz" +CLI_SHA="$(sha256sum "$CLI_TGZ" | awk '{print $1}')" +test "$(sha256sum "$CLI_LATEST" | awk '{print $1}')" = "$CLI_SHA" test "$(git rev-parse HEAD)" = "$MERGED_COMMIT" git tag -a "$TAG" "$MERGED_COMMIT" -m "ReRouted ${VERSION}" git push origin "refs/tags/$TAG:refs/tags/$TAG" -gh release create "$TAG" "$DMG#ReRouted ${VERSION} for Apple Silicon" "$UPDATE_ZIP#ReRouted ${VERSION} in-app update" \ +gh release create "$TAG" "$DMG#ReRouted ${VERSION} for Apple Silicon" "$UPDATE_ZIP#ReRouted ${VERSION} in-app update" "$CLI_TGZ#ReRouted ${VERSION} headless Linux CLI" "$CLI_LATEST#ReRouted headless Linux CLI (latest stable)" \ --repo gitcommit90/rerouted \ --verify-tag \ --draft \ @@ -152,8 +199,12 @@ gh release create "$TAG" "$DMG#ReRouted ${VERSION} for Apple Silicon" "$UPDATE_Z test "$(git rev-list -n 1 "$TAG")" = "$MERGED_COMMIT" REMOTE_DIGEST="$(gh release view "$TAG" --repo gitcommit90/rerouted --json assets --jq ".assets[] | select(.name == \"$(basename "$DMG")\") | .digest")" REMOTE_UPDATE_DIGEST="$(gh release view "$TAG" --repo gitcommit90/rerouted --json assets --jq ".assets[] | select(.name == \"$(basename "$UPDATE_ZIP")\") | .digest")" +REMOTE_CLI_DIGEST="$(gh release view "$TAG" --repo gitcommit90/rerouted --json assets --jq ".assets[] | select(.name == \"$(basename "$CLI_TGZ")\") | .digest")" +REMOTE_CLI_LATEST_DIGEST="$(gh release view "$TAG" --repo gitcommit90/rerouted --json assets --jq ".assets[] | select(.name == \"$(basename "$CLI_LATEST")\") | .digest")" test "$REMOTE_DIGEST" = "sha256:$LOCAL_SHA" test "$REMOTE_UPDATE_DIGEST" = "sha256:$UPDATE_SHA" +test "$REMOTE_CLI_DIGEST" = "sha256:$CLI_SHA" +test "$REMOTE_CLI_LATEST_DIGEST" = "sha256:$CLI_SHA" gh release edit "$TAG" --repo gitcommit90/rerouted --draft=false --latest ``` @@ -163,10 +214,14 @@ Download the published asset into a clean directory and verify it before install PUBLISHED_DIR="$(mktemp -d)" gh release download "$TAG" --repo gitcommit90/rerouted --pattern "$(basename "$DMG")" --dir "$PUBLISHED_DIR" gh release download "$TAG" --repo gitcommit90/rerouted --pattern "$(basename "$UPDATE_ZIP")" --dir "$PUBLISHED_DIR" +gh release download "$TAG" --repo gitcommit90/rerouted --pattern "$(basename "$CLI_TGZ")" --dir "$PUBLISHED_DIR" +gh release download "$TAG" --repo gitcommit90/rerouted --pattern "$(basename "$CLI_LATEST")" --dir "$PUBLISHED_DIR" PUBLISHED_DMG="$PUBLISHED_DIR/$(basename "$DMG")" PUBLISHED_UPDATE="$PUBLISHED_DIR/$(basename "$UPDATE_ZIP")" test "$(shasum -a 256 "$PUBLISHED_DMG" | awk '{print $1}')" = "$LOCAL_SHA" test "$(shasum -a 256 "$PUBLISHED_UPDATE" | awk '{print $1}')" = "$UPDATE_SHA" +test "$(sha256sum "$PUBLISHED_DIR/$(basename "$CLI_TGZ")" | awk '{print $1}')" = "$CLI_SHA" +test "$(sha256sum "$PUBLISHED_DIR/$(basename "$CLI_LATEST")" | awk '{print $1}')" = "$CLI_SHA" curl -fsS "https://update.electronjs.org/gitcommit90/rerouted/darwin-arm64/0.0.0" | grep -F "$(basename "$UPDATE_ZIP")" test "$(curl -sS -o /dev/null -w '%{http_code}' "https://update.electronjs.org/gitcommit90/rerouted/darwin-arm64/${VERSION}")" = "204" @@ -235,6 +290,10 @@ ssh macair ' The installed version must match `package.json`, the process must be running from `/Applications/ReRouted.app`, and the local health endpoint must answer successfully. +## 8b. Verify the public Linux CLI + +Install the exact public `ReRouted-linux-node.tgz` URL into a clean temporary npm prefix and repeat the version, `/health`, `/dashboard/`, SIGTERM, and PID-lock checks from step 5b. The installed `rerouted --version` must match `package.json`, and the public download digest must equal `CLI_SHA`. + ## 9. Final evidence The completion report must contain all five values: @@ -245,9 +304,11 @@ Merged commit: DMG: ReRouted--arm64.dmg DMG SHA-256: Update ZIP: ReRouted--mac-arm64.zip () +Linux CLI: ReRouted--linux-node.tgz () Release: Gatekeeper: Developer ID signature, app ticket, and DMG ticket verified MacBook Air: installed version verified, process running, health check passed +Linux CLI: public tarball installed, version/health/dashboard/shutdown verified ``` -If the DMG was not rebuilt, signed, notarized, and stapled; the MacBook Air was not updated; the code was not committed and pushed; or the change was not merged to `main`, the iteration is not complete. State the missing step plainly and do not use the word "done." +If the DMG was not rebuilt, signed, notarized, and stapled; the Linux CLI was not packaged and publicly smoke-tested; the MacBook Air was not updated; the code was not committed and pushed; or the change was not merged to `main`, the iteration is not complete. State the missing step plainly and do not use the word "done." diff --git a/package-lock.json b/package-lock.json index 584a210..4099e71 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,13 +1,16 @@ { - "name": "rerouted", - "version": "0.4.18", + "name": "@gitcommit90/rerouted", + "version": "0.5.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "rerouted", - "version": "0.4.18", + "name": "@gitcommit90/rerouted", + "version": "0.5.0", "license": "MIT", + "bin": { + "rerouted": "src/cli/index.js" + }, "devDependencies": { "@electron/osx-sign": "1.3.3", "@electron/packager": "18.4.4", diff --git a/package.json b/package.json index 3e7e76d..5875149 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,8 @@ { - "name": "rerouted", - "version": "0.4.18", - "description": "A macOS menu-bar router for accounts, models, and automatic fallback.", + "name": "@gitcommit90/rerouted", + "productName": "ReRouted", + "version": "0.5.0", + "description": "A local AI router for connected accounts, models, named routes, and automatic fallback.", "author": "gitcommit90", "license": "MIT", "homepage": "https://rerouted.dev", @@ -13,15 +14,32 @@ "url": "https://github.com/gitcommit90/rerouted/issues" }, "main": "src/main.js", - "private": true, + "private": false, + "bin": { + "rerouted": "src/cli/index.js" + }, + "publishConfig": { + "access": "public" + }, + "files": [ + "src/", + "resources/", + "LICENSE", + "PRIVACY.md", + "SECURITY.md", + "README.md" + ], "scripts": { "start": "electron .", + "start:headless": "node src/cli/index.js", "test": "node --test tests/*.test.js", "gen-icon": "node scripts/gen-tray-icon.js", "package:mac": "electron-packager . ReRouted --platform=darwin --arch=arm64 --out=dist --overwrite --asar --prune --extend-info=scripts/extendInfo.plist --app-bundle-id=dev.rerouted.app --extra-resource=resources/trayTemplate.png --extra-resource=resources/trayTemplate@2x.png", "package:dmg": "node scripts/package-mac-dmg.js", "package:dmg:release": "REROUTED_REQUIRE_NOTARIZATION=1 node scripts/package-mac-dmg.js", + "package:linux": "node scripts/package-linux-cli.js", "capture-ui": "electron scripts/capture-ui.js", + "capture-dashboard": "electron scripts/capture-dashboard.js", "site:serve": "node scripts/serve-site.js", "site:capture": "electron scripts/shoot-landing.js", "site:social": "electron scripts/shoot-social.js" diff --git a/scripts/capture-dashboard.js b/scripts/capture-dashboard.js new file mode 100644 index 0000000..e6fb85d --- /dev/null +++ b/scripts/capture-dashboard.js @@ -0,0 +1,113 @@ +#!/usr/bin/env node +"use strict"; + +const fs = require("node:fs"); +const os = require("node:os"); +const path = require("node:path"); +const { app, BrowserWindow } = require("electron"); +const { createHeadlessRuntime } = require("../src/lib/headless-runtime"); +const { hashPassword } = require("../src/lib/password"); +const { OAUTH } = require("../src/lib/constants"); + +const outputArg = process.argv.find((value) => /\.png$/i.test(value)); +const output = path.resolve(outputArg || path.join(process.cwd(), "dashboard-capture.png")); +const captureWidth = Number(process.env.DASHBOARD_CAPTURE_WIDTH) || 1200; +const captureHeight = Number(process.env.DASHBOARD_CAPTURE_HEIGHT) || 900; +const userData = fs.mkdtempSync(path.join(os.tmpdir(), "rerouted-dashboard-capture-")); +app.commandLine.appendSwitch("disable-gpu"); +if (process.getuid?.() === 0) app.commandLine.appendSwitch("no-sandbox"); + +app.whenReady().then(async () => { + const runtime = createHeadlessRuntime({ userData, version: "capture" }); + runtime.store.seed({ + onboardingComplete: true, + onboardingStep: "done", + adminPasswordHash: await hashPassword("capture-password"), + providers: [ + { + id: "prov_chatgpt_capture", + type: "chatgpt", + name: "ChatGPT", + accountAlias: "oauth1", + profileName: "Primary account", + accessToken: "capture-token", + enabled: true, + models: OAUTH.chatgpt.models, + createdAt: Date.now() - 10_000, + }, + { + id: "prov_claude_capture", + type: "claude", + name: "Claude", + accountAlias: "oauth1", + profileName: "Fallback account", + accessToken: "capture-token", + enabled: true, + models: OAUTH.claude.models, + createdAt: Date.now() - 5_000, + }, + ], + combos: [ + { + id: "combo_capture", + name: "coding", + strategy: "fallback", + members: [ + { providerId: "prov_chatgpt_capture", model: OAUTH.chatgpt.models[0].id }, + { providerId: "prov_claude_capture", model: OAUTH.claude.models[0].id }, + ], + createdAt: Date.now(), + }, + ], + }); + const address = await runtime.start({ port: 0, host: "127.0.0.1" }); + const win = new BrowserWindow({ + width: captureWidth, + height: captureHeight, + show: false, + webPreferences: { + contextIsolation: true, + nodeIntegration: false, + sandbox: true, + offscreen: true, + }, + }); + await win.loadURL(address.dashboard); + await win.webContents.executeJavaScript(` + (async () => { + const waitFor = async (selector) => { + const deadline = Date.now() + 5000; + while (!document.querySelector(selector) && Date.now() < deadline) { + await new Promise((resolve) => setTimeout(resolve, 25)); + } + if (!document.querySelector(selector)) throw new Error("Missing " + selector); + }; + await waitFor("#lock-pw"); + document.querySelector("#lock-pw").value = "capture-password"; + document.querySelector("#btn-unlock").click(); + await waitFor("[data-home-root]"); + await Promise.all([...document.images].map((image) => + image.complete + ? Promise.resolve() + : new Promise((resolve) => { + image.addEventListener("load", resolve, { once: true }); + image.addEventListener("error", resolve, { once: true }); + }) + )); + if (document.fonts?.ready) await document.fonts.ready; + await new Promise((resolve) => requestAnimationFrame(() => requestAnimationFrame(resolve))); + })() + `); + const image = await win.webContents.capturePage(); + fs.mkdirSync(path.dirname(output), { recursive: true }); + fs.writeFileSync(output, image.toPNG()); + console.log(output); + win.destroy(); + await runtime.close(); + fs.rmSync(userData, { recursive: true, force: true }); + app.quit(); +}).catch((error) => { + console.error(error); + process.exitCode = 1; + app.quit(); +}); diff --git a/scripts/package-linux-cli.js b/scripts/package-linux-cli.js new file mode 100644 index 0000000..bdb72c7 --- /dev/null +++ b/scripts/package-linux-cli.js @@ -0,0 +1,66 @@ +#!/usr/bin/env node +"use strict"; + +const fs = require("node:fs"); +const path = require("node:path"); +const { execFileSync } = require("node:child_process"); + +const ROOT = path.resolve(__dirname, ".."); +const DIST = path.join(ROOT, "dist"); +const pkg = JSON.parse(fs.readFileSync(path.join(ROOT, "package.json"), "utf8")); +const { versioned: versionedName, latest: latestName } = linuxCliArtifactNames(pkg.version); + +function linuxCliArtifactNames(version) { + if (!/^\d+\.\d+\.\d+(?:[-+][0-9A-Za-z.-]+)?$/.test(String(version || ""))) { + throw new Error("A semantic package version is required"); + } + return { + versioned: `ReRouted-${version}-linux-node.tgz`, + latest: "ReRouted-linux-node.tgz", + }; +} + +if (require.main !== module) { + module.exports = { linuxCliArtifactNames }; + return; +} + +fs.mkdirSync(DIST, { recursive: true }); +for (const name of [versionedName, latestName]) { + fs.rmSync(path.join(DIST, name), { force: true }); +} + +const output = execFileSync( + process.platform === "win32" ? "npm.cmd" : "npm", + ["pack", "--json", "--pack-destination", DIST], + { cwd: ROOT, encoding: "utf8" } +); +const result = JSON.parse(output)[0]; +if (!result?.filename) throw new Error("npm pack did not return an artifact filename"); + +const packedPath = path.join(DIST, result.filename); +const versionedPath = path.join(DIST, versionedName); +const latestPath = path.join(DIST, latestName); +fs.renameSync(packedPath, versionedPath); +fs.copyFileSync(versionedPath, latestPath); + +const listing = execFileSync("tar", ["-tzf", versionedPath], { encoding: "utf8" }); +for (const required of [ + "package/package.json", + "package/LICENSE", + "package/src/cli/index.js", + "package/src/lib/headless-runtime.js", + "package/src/lib/gateway.js", + "package/src/renderer/index.html", + "package/src/renderer/web-api.js", +]) { + if (!listing.split("\n").includes(required)) { + throw new Error(`Linux CLI package is missing ${required}`); + } +} +if (/(?:^|\/)AGENTS\.md$/m.test(listing)) { + throw new Error("Linux CLI package must not contain AGENTS.md"); +} + +console.log(versionedPath); +console.log(latestPath); diff --git a/site/index.html b/site/index.html index cef9184..8ed9451 100644 --- a/site/index.html +++ b/site/index.html @@ -10,7 +10,7 @@ - + @@ -622,6 +622,9 @@ } .setup-steps li .st-copy h4 { font-family: var(--display); font-weight: 600; font-size: 18px; margin-bottom: 3px; } .setup-steps li .st-copy p { font-size: 14.5px; color: var(--muted); line-height: 1.5; } + .band-dark .setup-steps li { border-bottom-color: rgba(255,255,255,0.1); } + .band-dark .setup-steps li .st-copy h4 { color: #fbf8f0; } + .band-dark .setup-steps li .st-copy p { color: rgba(236,232,221,0.62); } .codeblock { background: var(--night); @@ -738,7 +741,7 @@
- Local gateway · macOS menu bar + Local gateway · macOS + Linux

One endpoint.
Your run keeps going.

Point a compatible configurable chat-completions client at one local URL. @@ -750,6 +753,7 @@

One endpoint.
Your run keeps goi Download for Apple Silicon + Install for Linux See how it routes

Binds to 127.0.0.1 by default. No hosted control plane. No ReRouted account. No Dock icon.
@@ -830,7 +834,7 @@

You already changed your mind about providers 1

Connect once

-

Import supported credentials already stored on your Mac, connect an OAuth account, or paste an API key. Accounts and keys live side by side.

+

Import supported credentials already stored on your machine, connect an OAuth account, or paste an API key. Accounts and keys live side by side.

2 @@ -872,7 +876,7 @@

Accounts & keys, together

Traffic you can see

-

Requests, failures, token counts, routes, and logs — all in the menu-bar panel. No dashboard tab to keep open.

+

Requests, failures, token counts, routes, and logs — in the menu-bar panel on macOS or the matching dashboard on Linux.

@@ -881,8 +885,8 @@

Local by default

-

No desktop bloat

-

No Dock icon. No frontend framework. Signed updates install from inside the app. It lives quietly in the menu bar.

+

Native or headless

+

No Dock icon on macOS. No desktop required on Linux. The same control plane runs as a menu-bar panel or at /dashboard/.

@@ -919,15 +923,20 @@

Bring the accounts you already pay for.
- Three minutes to useful + Mac or Linux · three minutes to useful

Run one test. Done.

    -

  1. Install & launch

    Open the Apple Silicon DMG, drag to Applications, launch. Look up — it’s in the menu bar.

    2. +

  2. Install & launch

    Open the Apple Silicon DMG, or install the Linux tarball with npm and run rerouted.

  3. Connect an account

    Import local credentials, connect OAuth, or add a key.

  4. Point your client here

    Copy the endpoint and generated rr-… key from Home.

+
+
linux install
+
npm install --global https://github.com/gitcommit90/rerouted/releases/latest/download/ReRouted-linux-node.tgz +rerouted # terminal setup + /dashboard/
+
smoke test
@@ -954,12 +963,13 @@

Run one test.

Connect once. Route on purpose.
Stop babysitting provider failures.

-

The gateway you keep meaning to build — already sitting in your menu bar.

+

The gateway you keep meaning to build — in your menu bar or one headless command.

Download for Apple Silicon + Install for Linux How it works

@@ -970,7 +980,7 @@

Connect once. Route on purpose.
Stop ba
ReRouted — a local OpenAI-style chat-completions gateway.
- Current stable release · macOS 12+ · Apple Silicon · Developer ID signed · Apple notarized
+ macOS 12+ Apple Silicon · Linux with Node.js 22.13+ · local by default
An independent personal project.
diff --git a/src/cli/index.js b/src/cli/index.js new file mode 100755 index 0000000..c10896c --- /dev/null +++ b/src/cli/index.js @@ -0,0 +1,188 @@ +#!/usr/bin/env node +"use strict"; + +const fs = require("node:fs"); +const path = require("node:path"); +const { createHeadlessRuntime, createProcessLock, defaultUserData } = require("../lib/headless-runtime"); +const { createPrompts } = require("./prompts"); +const { runFirstSetup } = require("./setup"); +const packageJson = require("../../package.json"); + +const HELP = `ReRouted ${packageJson.version} + +Usage: + rerouted [start] [options] Run the gateway and dashboard + rerouted paths Show local data paths + rerouted help Show this help + +Options: + --host
Override the configured bind address + --port Override the configured port + --data-dir Store config, usage, and logs in this directory + --no-interactive Skip the terminal setup wizard + --version Print the installed version + --help Show this help + +Running "rerouted" for the first time opens an interactive setup in your +terminal. The same setup and full control plane are served at /dashboard/. +`; + +function parseArgs(argv) { + const result = { + command: "start", + host: null, + port: null, + dataDir: null, + interactive: true, + }; + const args = [...argv]; + if (args[0] && !args[0].startsWith("-")) result.command = args.shift(); + for (let index = 0; index < args.length; index += 1) { + const arg = args[index]; + if (arg === "--help" || arg === "-h") result.command = "help"; + else if (arg === "--version" || arg === "-v") result.command = "version"; + else if (arg === "--no-interactive") result.interactive = false; + else if (arg === "--host") result.host = args[++index]; + else if (arg === "--port") result.port = Number(args[++index]); + else if (arg === "--data-dir") result.dataDir = args[++index]; + else throw new Error(`Unknown option: ${arg}`); + } + if (args.includes("--host") && !result.host) throw new Error("--host requires an address"); + if (args.includes("--port") && !Number.isFinite(result.port)) throw new Error("--port requires a number"); + if (args.includes("--data-dir") && !result.dataDir) throw new Error("--data-dir requires a path"); + if (result.host === "localhost") result.host = "127.0.0.1"; + if (result.host && !["127.0.0.1", "0.0.0.0"].includes(result.host)) { + throw new Error("--host must be 127.0.0.1, localhost, or 0.0.0.0"); + } + if (result.port != null && (!Number.isInteger(result.port) || result.port < 0 || result.port > 65535)) { + throw new Error("--port must be an integer from 1 to 65535"); + } + if (result.dataDir) result.dataDir = path.resolve(result.dataDir); + return result; +} + +function pathsFor(userData) { + return { + data: userData, + config: path.join(userData, "config.json"), + usage: path.join(userData, "usage.sqlite"), + logs: path.join(userData, "rerouted.log"), + }; +} + +async function run(argv = process.argv.slice(2), io = {}) { + const input = io.input || process.stdin; + const output = io.output || process.stdout; + const errorOutput = io.error || process.stderr; + let options; + try { + options = parseArgs(argv); + } catch (error) { + errorOutput.write(`${error.message}\nRun "rerouted help" for usage.\n`); + return 2; + } + + if (options.command === "help") { + output.write(HELP); + return 0; + } + if (options.command === "version") { + output.write(`${packageJson.version}\n`); + return 0; + } + + const userData = options.dataDir || defaultUserData(); + if (options.command === "paths") { + const paths = pathsFor(userData); + for (const [label, value] of Object.entries(paths)) output.write(`${label.padEnd(7)} ${value}\n`); + return 0; + } + if (options.command !== "start") { + errorOutput.write(`Unknown command: ${options.command}\nRun "rerouted help" for usage.\n`); + return 2; + } + + let processLock; + try { + processLock = createProcessLock(userData); + } catch (error) { + errorOutput.write(`${error.message}\n`); + return error.code === "ALREADY_RUNNING" ? 3 : 1; + } + + let stopping = false; + let runtime; + let prompts; + const stop = async () => { + if (stopping) return; + stopping = true; + prompts?.close(); + try { + await runtime?.close(); + } finally { + processLock.release(); + } + }; + + runtime = createHeadlessRuntime({ + userData, + version: packageJson.version, + onQuit: stop, + }); + + try { + const address = await runtime.start({ port: options.port, host: options.host }); + output.write(`\nReRouted ${packageJson.version}\n`); + output.write(`Gateway ${address.endpoint}\n`); + output.write(`Dashboard ${address.dashboard}\n`); + output.write(`Data ${userData}\n`); + + const firstRun = !runtime.store.load().onboardingComplete; + const interactive = options.interactive && input.isTTY === true && output.isTTY === true; + if (firstRun && interactive) { + prompts = createPrompts({ input, output }); + await runFirstSetup({ + prompts, + controlPlane: runtime.controlPlane, + dashboardUrl: address.dashboard, + output, + }); + prompts.close(); + prompts = null; + } else if (firstRun) { + output.write( + `\nFirst-time setup is waiting at ${address.dashboard}\n` + + "Open it from this machine, or restart ReRouted in an interactive terminal.\n" + ); + } else { + output.write("\nReRouted is ready. Press Ctrl+C to stop.\n"); + } + + if (io.waitForSignal === false) { + await stop(); + return 0; + } + + await new Promise((resolve) => { + const finish = () => resolve(); + process.once("SIGINT", finish); + process.once("SIGTERM", finish); + process.once("SIGHUP", finish); + }); + output.write("\nStopping ReRouted…\n"); + await stop(); + return 0; + } catch (error) { + errorOutput.write(`ReRouted could not start: ${error.message}\n`); + await stop(); + return 1; + } +} + +if (require.main === module) { + run().then((code) => { + process.exitCode = code; + }); +} + +module.exports = { HELP, parseArgs, pathsFor, run }; diff --git a/src/cli/prompts.js b/src/cli/prompts.js new file mode 100644 index 0000000..d2964c8 --- /dev/null +++ b/src/cli/prompts.js @@ -0,0 +1,90 @@ +"use strict"; + +const readline = require("node:readline"); +const { Writable } = require("node:stream"); + +function createPrompts({ input = process.stdin, output = process.stdout } = {}) { + let muted = false; + const terminalOutput = new Writable({ + write(chunk, _encoding, callback) { + if (!muted) output.write(chunk); + callback(); + }, + }); + const rl = readline.createInterface({ + input, + output: terminalOutput, + terminal: !!input.isTTY && !!output.isTTY, + }); + + async function text(message, { defaultValue = "", required = false } = {}) { + while (true) { + const suffix = defaultValue ? ` (${defaultValue})` : ""; + const answer = (await new Promise((resolve) => rl.question(`${message}${suffix}: `, resolve))).trim(); + const value = answer || defaultValue; + if (value || !required) return value; + output.write("Please enter a value.\n"); + } + } + + async function confirm(message, { defaultValue = true } = {}) { + const hint = defaultValue ? "Y/n" : "y/N"; + const answer = (await text(`${message} [${hint}]`)).toLowerCase(); + if (!answer) return defaultValue; + return answer === "y" || answer === "yes"; + } + + async function secret(message, { required = false } = {}) { + while (true) { + output.write(`${message}: `); + muted = true; + const value = await new Promise((resolve) => rl.question("", resolve)).finally(() => { + muted = false; + }); + output.write("\n"); + if (value || !required) return value; + output.write("Please enter a value.\n"); + } + } + + async function select(message, options, { defaultIndex = 0 } = {}) { + if (!Array.isArray(options) || !options.length) throw new TypeError("Select requires options"); + output.write(`\n${message}\n`); + options.forEach((option, index) => { + output.write(` ${index + 1}. ${typeof option === "string" ? option : option.label}\n`); + }); + while (true) { + const value = await text("Choose", { defaultValue: String(defaultIndex + 1) }); + const index = Number(value) - 1; + if (Number.isInteger(index) && index >= 0 && index < options.length) return index; + output.write(`Choose a number from 1 to ${options.length}.\n`); + } + } + + async function multiSelect(message, options, { defaultAll = false } = {}) { + if (!Array.isArray(options) || !options.length) return []; + output.write(`\n${message}\n`); + options.forEach((option, index) => { + output.write(` ${index + 1}. ${typeof option === "string" ? option : option.label}\n`); + }); + const hint = defaultAll ? "all" : "none"; + while (true) { + const answer = (await text("Choose comma-separated numbers", { defaultValue: hint })).toLowerCase(); + if (answer === "none" || answer === "skip") return []; + if (answer === "all") return options.map((_, index) => index); + const indexes = [...new Set(answer.split(",").map((item) => Number(item.trim()) - 1))]; + if (indexes.length && indexes.every((index) => Number.isInteger(index) && index >= 0 && index < options.length)) { + return indexes; + } + output.write(`Enter numbers from 1 to ${options.length}, "all", or "none".\n`); + } + } + + function close() { + rl.close(); + } + + return { text, secret, confirm, select, multiSelect, close }; +} + +module.exports = { createPrompts }; diff --git a/src/cli/setup.js b/src/cli/setup.js new file mode 100644 index 0000000..a96dea5 --- /dev/null +++ b/src/cli/setup.js @@ -0,0 +1,188 @@ +"use strict"; + +const { KEYED_PRESETS } = require("../lib/constants"); + +const OAUTH_NOTICE = + "Subscription OAuth sessions are not officially licensed for router use and may carry account risk."; + +function publicModelOptions(state) { + const options = []; + for (const provider of state.providers || []) { + if (provider.enabled === false) continue; + for (const model of provider.models || []) { + if (model.enabled === false) continue; + options.push({ + label: `${provider.name}${provider.accountAlias ? ` · ${provider.accountAlias}` : ""}: ${model.name || model.id}`, + providerId: provider.id, + model: model.id, + }); + } + } + return options; +} + +async function createPassword(prompts, invoke, output) { + while (true) { + const password = await prompts.secret("Create an admin password (4+ characters)", { required: true }); + const confirm = await prompts.secret("Confirm admin password", { required: true }); + if (password !== confirm) { + output.write("Passwords do not match. Try again.\n"); + continue; + } + const result = await invoke("app:set-admin-password", password); + if (result.ok) return; + output.write(`${result.error || "Could not save password"}\n`); + } +} + +async function importDetected(prompts, invoke, output) { + if (!(await prompts.confirm("Scan this machine for supported provider credentials?"))) return; + output.write("Scanning local credential files…\n"); + const result = await invoke("app:detect-providers"); + const found = result.found || []; + if (!found.length) { + output.write("No supported credentials were found.\n"); + return; + } + const indexes = await prompts.multiSelect( + "Import detected accounts", + found.map((item) => ({ + label: `${item.name || item.type}${item.email ? ` · ${item.email}` : ""} (${item.source})`, + })), + { defaultAll: true } + ); + if (!indexes.length) return; + await invoke("app:import-detected", indexes.map((index) => found[index].id)); + output.write(`Imported ${indexes.length} account${indexes.length === 1 ? "" : "s"}.\n`); +} + +async function connectOauth(prompts, invoke, output) { + output.write(`\n${OAUTH_NOTICE}\n`); + while (await prompts.confirm("Connect an OAuth subscription account now?", { defaultValue: false })) { + const state = await invoke("app:get-state"); + const providers = state.oauthProviders || []; + const index = await prompts.select( + "OAuth provider", + providers.map((provider) => provider.name) + ); + const type = providers[index].id; + const started = await invoke("app:oauth-start", type); + if (!started.ok) { + output.write(`Could not start OAuth: ${started.error}\n`); + continue; + } + output.write(`\nOpen this URL in a browser:\n${started.authUrl}\n\n`); + const code = await prompts.text( + "Paste the callback URL/code, or press Enter after the browser returns automatically" + ); + const completed = await invoke("app:oauth-complete", { + type, + pasteCode: code || undefined, + }); + if (completed.ok) output.write(`Connected ${completed.account.name}.\n`); + else output.write(`Could not connect: ${completed.error}\n`); + } +} + +async function addKeyedProvider(prompts, invoke, output) { + while (await prompts.confirm("Add an API-key provider now?", { defaultValue: false })) { + const presets = [...Object.values(KEYED_PRESETS), { id: "custom", name: "Custom OpenAI-compatible" }]; + const index = await prompts.select("API-key provider", presets.map((preset) => preset.name)); + const preset = presets[index]; + const custom = preset.id === "custom"; + const name = custom + ? await prompts.text("Connection name", { required: true }) + : preset.name; + const accountId = preset.needsAccountId + ? await prompts.text("Cloudflare account ID", { required: true }) + : ""; + const baseUrl = custom + ? await prompts.text("Base URL (https://…/v1)", { required: true }) + : preset.baseUrl.replace("{account_id}", accountId); + const apiKey = await prompts.secret("API key", { required: true }); + const explicitModel = custom + ? await prompts.text("Exact model ID if /models is unavailable (optional)") + : ""; + output.write("Testing connection and discovering models…\n"); + const tested = await invoke("app:test-keyed-provider", { + providerType: custom ? "openai-compat" : preset.id, + baseUrl, + apiKey, + modelId: explicitModel, + }); + if (!tested.ok) { + output.write(`Connection failed: ${tested.error}\n`); + continue; + } + const added = await invoke("app:add-keyed-provider", { + preset: custom ? null : preset.id, + name, + baseUrl, + apiKey, + accountId, + models: (tested.models || []).map((model) => ({ + ...(typeof model === "string" ? { id: model, name: model } : model), + enabled: true, + })), + }); + if (added.ok) output.write(`Added ${name} with ${(tested.models || []).length} model(s).\n`); + else output.write(`Could not add provider: ${added.error}\n`); + } +} + +async function createRoute(prompts, invoke, output) { + const state = await invoke("app:get-state"); + const models = publicModelOptions(state); + if (!models.length) { + output.write("No provider models are available yet. Add them later from the dashboard.\n"); + return; + } + if (!(await prompts.confirm("Create your first named route?"))) return; + const name = await prompts.text("Route/model ID", { defaultValue: "coding", required: true }); + const strategyIndex = await prompts.select("Routing strategy", ["Fallback", "Round robin"]); + const indexes = await prompts.multiSelect( + "Route members (selection order is preserved)", + models.map((model) => model.label) + ); + if (!indexes.length) { + output.write("Route skipped because no models were selected.\n"); + return; + } + const result = await invoke("app:save-combo", { + name, + strategy: strategyIndex === 1 ? "round-robin" : "fallback", + members: indexes.map((index) => ({ + providerId: models[index].providerId, + model: models[index].model, + })), + }); + if (result.ok) output.write(`Created route ${name}.\n`); + else output.write(`Could not create route: ${result.error}\n`); +} + +async function runFirstSetup({ prompts, controlPlane, dashboardUrl, output = process.stdout }) { + const invoke = (channel, ...args) => + controlPlane.invoke(channel, args, { harness: true }); + const initial = await invoke("app:get-state"); + if (initial.onboardingComplete) return false; + + output.write("\nReRouted headless setup\n"); + output.write("One local gateway for your provider accounts, keys, and named routes.\n"); + output.write(`The same setup is also available at ${dashboardUrl}\n\n`); + + await invoke("app:set-onboarding-step", "admin-password"); + await createPassword(prompts, invoke, output); + await invoke("app:set-onboarding-step", "auto-detect"); + await importDetected(prompts, invoke, output); + await invoke("app:set-onboarding-step", "oauth-providers"); + await connectOauth(prompts, invoke, output); + await invoke("app:set-onboarding-step", "api-keys"); + await addKeyedProvider(prompts, invoke, output); + await invoke("app:set-onboarding-step", "first-combo"); + await createRoute(prompts, invoke, output); + await invoke("app:complete-onboarding"); + output.write("\nSetup complete. ReRouted will keep running until you press Ctrl+C.\n"); + return true; +} + +module.exports = { runFirstSetup, publicModelOptions }; diff --git a/src/lib/control-plane.js b/src/lib/control-plane.js new file mode 100644 index 0000000..344455f --- /dev/null +++ b/src/lib/control-plane.js @@ -0,0 +1,725 @@ +"use strict"; + +const { hydrateUsageIdentity } = require("./usage"); +const { hashPassword, verifyPassword, generateId, generateApiKey } = require("./password"); +const { detectAll, summarizeDetected } = require("./detect"); +const { startOAuth, completeOAuth, oauthStatus, clearPending } = require("./oauth"); +const { + canInvoke, + hasAdminPassword, + isAllowedExternalUrl, + lockedError, + redactLockedState, +} = require("./ipc-security"); +const { runProviderModelTest } = require("./model-test"); +const { testKeyedProvider } = require("./keyed-provider-test"); +const { KEYED_PRESETS, ONBOARDING_STEPS, DEFAULT_PORT, OAUTH } = require("./constants"); +const { listProviderModels, getAdapter } = require("./providers"); +const { + customConnectionNameError, + customModelRouteConflict, + customProviderModelId, + isCustomProviderType, +} = require("./model-ids"); +const { + publicCombo, + comboMatchesId, + publicRouteId, + providerRouteIds, + comboStorageIdConflict, + comboNameConflict, +} = require("./combos"); + +function createControlPlane({ + store, + router, + gateway, + requestActivity, + quota, + logger, + sessionAuth, + getAppVersion = () => "0.0.0", + getUpdateService = () => null, + harnessModeEnabled = () => false, + restartGateway = () => gateway.restart(), + setOpenAtLogin = async () => {}, + openExternal = async () => {}, + revealFile = async () => {}, + hidePanel = async () => {}, + quit = async () => {}, + runtime = "desktop", + platform = process.platform, +} = {}) { + if (!store || !router || !gateway || !requestActivity || !quota || !logger || !sessionAuth) { + throw new TypeError("Control plane requires the ReRouted runtime services"); + } + + let detectedCache = []; + const handlers = new Map(); + const handle = (channel, handler) => { + if (handlers.has(channel)) throw new Error(`Duplicate control-plane handler: ${channel}`); + handlers.set(channel, handler); + }; + + function publicActivityEntry(entry, cfg) { + return { + ...hydrateUsageIdentity(entry, cfg.providers), + model: publicRouteId(cfg.combos, entry.model), + }; + } + + function publicStats(stats, cfg) { + if (!stats) return stats; + return { + ...stats, + recent: (stats.recent || []).map((entry) => publicActivityEntry(entry, cfg)), + }; + } + + function publicUsage(usage, cfg) { + if (!usage) return usage; + return { + ...usage, + byModel: (usage.byModel || []).map((entry) => ({ + ...entry, + model: publicRouteId(cfg.combos, entry.model), + })), + byProvider: (usage.byProvider || []).map((entry) => + hydrateUsageIdentity(entry, cfg.providers) + ), + recent: (usage.recent || []).map((entry) => publicActivityEntry(entry, cfg)), + }; + } + + handle("app:get-state", async (_e) => { + const cfg = store.load(); + const publicProviders = (cfg.providers || []).map((p) => { + const models = listProviderModels(p, { includeDisabled: true }).map((m) => ({ + id: m.upstreamModel, + gatewayId: m.id, + name: m.name, + enabled: m.enabled !== false, + })); + return { + id: p.id, + type: p.type, + name: p.name, + accountAlias: p.accountAlias || null, + email: p.email, + profileName: p.profileName, + enabled: p.enabled !== false, + hasToken: !!(p.accessToken || p.apiKey), + models, + baseUrl: p.baseUrl, + }; + }); + const listening = gateway.getListeningAddress?.(); + const port = listening?.port || cfg.port || DEFAULT_PORT; + const bindHost = listening?.host || cfg.bindHost || "127.0.0.1"; + const apiKeys = (cfg.apiKeys || []).map((k) => ({ + id: k.id, + name: k.name || "Key", + key: k.key, + enabled: k.enabled !== false, + createdAt: k.createdAt, + })); + // Primary key for simple copy on Home / onboarding + const primaryKey = apiKeys.find((k) => k.enabled !== false)?.key || ""; + const hasPassword = hasAdminPassword(cfg); + const unlocked = _e.sessionAuth.isUnlocked(hasPassword) || _e.harness; + return redactLockedState({ + onboardingComplete: !!cfg.onboardingComplete, + appVersion: getAppVersion(), + runtime, + platform, + update: getUpdateService()?.state() || { + status: runtime === "headless" ? "unsupported" : "idle", + currentVersion: getAppVersion(), + version: null, + checkedAt: null, + error: + runtime === "headless" + ? "Update ReRouted through the package manager you installed it with." + : null, + }, + onboardingStep: cfg.onboardingStep || "permissions", + openAtLogin: !!cfg.openAtLogin, + port, + bindHost, + apiKey: primaryKey, + apiKeys, + endpoint: `http://127.0.0.1:${port}/v1`, + // When bound to all interfaces, tools on other Tailscale nodes can use this host's tailnet IP + listenHint: + bindHost === "0.0.0.0" + ? "Listening on all interfaces (LAN / Tailscale). Use this machine's network address and configured port." + : "Listening on localhost only. Switch bind to All interfaces in Settings for LAN or Tailscale.", + serverEnabled: cfg.serverEnabled !== false, + serverListening: gateway.isListening(), + providers: publicProviders, + combos: (cfg.combos || []).map(publicCombo), + stats: publicStats(router.stats(), cfg), + usage: publicUsage(router.usageAggregate("24h"), cfg), + activeRequests: requestActivity.snapshot(), + unlocked, + hasAdminPassword: hasPassword, + oauthProviders: Object.keys(OAUTH).map((k) => ({ + id: k, + name: OAUTH[k].name, + })), + keyedPresets: Object.values(KEYED_PRESETS), + steps: ONBOARDING_STEPS, + }); + }); + +handle("app:set-onboarding-step", async (_e, step) => { + store.update((cfg) => { + cfg.onboardingStep = step; + if (step === "done") cfg.onboardingComplete = true; + }); + return { ok: true }; +}); + +handle("app:complete-onboarding", async () => { + store.update((cfg) => { + cfg.onboardingComplete = true; + cfg.onboardingStep = "done"; + }); + return { ok: true }; +}); + +handle("app:set-open-at-login", async (_e, enabled) => { + await setOpenAtLogin(!!enabled); + store.update((cfg) => { + cfg.openAtLogin = !!enabled; + }); + return { ok: true, openAtLogin: !!enabled }; +}); + +handle("app:set-admin-password", async (_e, password) => { + if (!password || String(password).length < 4) { + return { ok: false, error: "Password must be at least 4 characters" }; + } + const hash = await hashPassword(password); + store.update((cfg) => { + cfg.adminPasswordHash = hash; + }); + _e.sessionAuth.setManualUnlocked(true); + return { ok: true }; +}); + +handle("app:verify-admin-password", async (_e, password) => { + const cfg = store.load(); + if (!cfg.adminPasswordHash || cfg.adminPasswordHash === "harness") { + _e.sessionAuth.setManualUnlocked(true); + return { ok: true }; + } + const ok = await verifyPassword(password, cfg.adminPasswordHash); + _e.sessionAuth.setManualUnlocked(ok); + return { ok }; +}); + +handle("app:change-admin-password", async (_e, { current, next }) => { + const cfg = store.load(); + if (cfg.adminPasswordHash && cfg.adminPasswordHash !== "harness") { + const ok = await verifyPassword(current, cfg.adminPasswordHash); + if (!ok) return { ok: false, error: "Current password incorrect" }; + } + if (!next || String(next).length < 4) { + return { ok: false, error: "New password too short" }; + } + const hash = await hashPassword(next); + store.update((c) => { + c.adminPasswordHash = hash; + }); + return { ok: true }; +}); + +handle("app:detect-providers", async () => { + detectedCache = await detectAll(); + return { ok: true, found: summarizeDetected(detectedCache) }; +}); + +handle("app:import-detected", async (_e, ids) => { + const want = new Set(ids || []); + const toImport = detectedCache.filter((d) => want.has(d.id)); + store.update((cfg) => { + for (const d of toImport) { + // Avoid duplicate by type+email/source path + const exists = cfg.providers.some( + (p) => + p.type === d.type && + ((d.email && p.email === d.email) || (d.path && p.importPath === d.path)) + ); + if (exists) continue; + cfg.providers.push({ + id: d.id || generateId("prov"), + type: d.type, + name: d.name, + email: d.email, + accessToken: d.accessToken, + refreshToken: d.refreshToken, + accountId: d.accountId, + projectId: d.projectId, + clientId: d.clientId, + clientSecret: d.clientSecret, + models: d.models, + enabled: true, + importPath: d.path, + source: d.source, + createdAt: Date.now(), + }); + } + }); + return { ok: true }; +}); + +handle("app:oauth-start", async (_e, type) => { + try { + logger.oauth(`UI requested OAuth start for ${type}`); + const result = await startOAuth(type); + logger.oauth(`Opening external browser for ${type}`); + if (runtime === "desktop") await openExternal(result.authUrl); + logger.oauth(`Browser open dispatched for ${type}`); + return { + ok: true, + authUrl: result.authUrl, + altAuthUrl: result.altAuthUrl || null, + redirectUri: result.redirectUri, + needsPaste: result.needsPaste, + params: result.params, + logFile: logger.getFilePath(), + }; + } catch (e) { + logger.error(`oauth-start failed: ${e.message}`); + return { ok: false, error: e.message, logFile: logger.getFilePath() }; + } +}); + +handle("app:oauth-status", async (_e, type) => oauthStatus(type)); + +handle("app:oauth-cancel", async (_e, type) => { + clearPending(type); + return { ok: true }; +}); + +handle("app:oauth-complete", async (_e, { type, pasteCode, providerId }) => { + try { + logger.oauth(`UI requested OAuth complete for ${type}`, { + providerId: providerId || null, + pasteLen: pasteCode ? String(pasteCode).length : 0, + }); + const account = await completeOAuth(type, { pasteCode }); + store.update((cfg) => { + if (providerId) { + const i = cfg.providers.findIndex((p) => p.id === providerId); + if (i >= 0) { + const prev = cfg.providers[i]; + cfg.providers[i] = { + ...prev, + accessToken: account.accessToken, + refreshToken: account.refreshToken || prev.refreshToken, + expiresAt: account.expiresAt, + accountId: account.accountId || prev.accountId, + projectId: account.projectId || prev.projectId, + email: account.email || prev.email, + profileName: account.profileName || prev.profileName, + name: prev.name || account.name, + enabled: true, + }; + return; + } + } + cfg.providers.push(account); + }); + logger.oauth(`OAuth complete SUCCESS for ${type}`, { + name: account.name, + reauthed: !!providerId, + }); + return { + ok: true, + account: { + id: providerId || account.id, + type: account.type, + name: account.name, + email: account.email || null, + profileName: account.profileName || null, + reauthed: !!providerId, + }, + }; + } catch (e) { + logger.error(`oauth-complete FAILED for ${type}: ${e.message}`); + return { ok: false, error: e.message, logFile: logger.getFilePath() }; + } +}); + +handle("app:logs-get", async (_e, limit) => { + return { + ok: true, + entries: logger.list(limit || 200), + file: logger.getFilePath(), + }; +}); + +handle("app:logs-clear", async () => { + logger.clear(); + logger.info("Logs cleared by user"); + return { ok: true }; +}); + +handle("app:logs-reveal", async () => { + const f = logger.getFilePath(); + if (f) { + await revealFile(f); + return { ok: true, file: f }; + } + return { ok: false, error: "No log file" }; +}); + +handle("app:add-keyed-provider", async (_e, payload) => { + const { preset, name, baseUrl, apiKey, accountId, models } = payload || {}; + let finalBase = baseUrl; + let finalName = name; + let type = "custom"; + if (preset && KEYED_PRESETS[preset]) { + const p = KEYED_PRESETS[preset]; + finalBase = p.baseUrl.replace("{account_id}", accountId || ""); + finalName = finalName || p.name; + type = preset; + } + if (!finalBase || !apiKey) return { ok: false, error: "Base URL and API key required" }; + if (type === "custom") { + const current = store.load(); + const nameError = customConnectionNameError(finalName, current.providers); + if (nameError) return { ok: false, error: nameError }; + finalName = String(finalName).trim(); + const conflict = customModelRouteConflict(finalName, models, current.combos); + if (conflict) { + const modelId = typeof conflict === "string" ? conflict : conflict.id; + return { + ok: false, + error: `A route named ${customProviderModelId({ name: finalName }, modelId)} already exists`, + }; + } + } + const prov = { + id: generateId("prov"), + type: type === "custom" ? "openai-compat" : type, + name: finalName || "Custom", + baseUrl: finalBase.replace(/\/+$/, ""), + apiKey, + models: models || [], + enabled: true, + createdAt: Date.now(), + }; + store.update((cfg) => { + cfg.providers.push(prov); + }); + return { ok: true, id: prov.id }; +}); + +handle("app:test-keyed-provider", async (_e, payload) => { + const adapter = getAdapter(payload?.providerType); + return testKeyedProvider(payload, { adapter: adapter || undefined, logger }); +}); + +handle("app:remove-provider", async (_e, id) => { + store.update((cfg) => { + cfg.providers = cfg.providers.filter((p) => p.id !== id); + for (const c of cfg.combos) { + c.members = (c.members || []).filter((m) => m.providerId !== id); + } + }); + return { ok: true }; +}); + +handle("app:set-provider-enabled", async (_e, { id, enabled }) => { + let found = false; + store.update((cfg) => { + const p = cfg.providers.find((x) => x.id === id); + if (p) { + p.enabled = !!enabled; + found = true; + } + }); + return { ok: found, enabled: !!enabled }; +}); + +handle("app:usage", async (_e, period) => { + const cfg = store.load(); + return { + ok: true, + usage: publicUsage(router.usageAggregate(period || "24h"), cfg), + stats: publicStats(router.stats(), cfg), + }; +}); + +handle("app:quota-get", async () => { + return { ok: true, quota: quota.current() }; +}); + +handle("app:quota-refresh", async () => { + return { ok: true, quota: await quota.refresh() }; +}); + +handle("app:save-combo", async (_e, combo) => { + const name = String(combo?.name || "").trim(); + if (!name) return { ok: false, error: "Model ID is required" }; + const current = store.load(); + const editIndex = combo.id + ? (current.combos || []).findIndex((entry) => comboMatchesId(entry, combo.id)) + : -1; + if (combo.id && editIndex < 0) return { ok: false, error: "Route not found" }; + if (comboNameConflict(current.combos, name, editIndex)) { + return { ok: false, error: `A route named ${name} already exists` }; + } + if (comboStorageIdConflict(current.combos, name)) { + return { ok: false, error: "That model ID is reserved by an existing route" }; + } + if (providerRouteIds(current.providers).has(name.toLowerCase())) { + return { ok: false, error: "That model ID is already used by a connected provider" }; + } + store.update((cfg) => { + if (combo.id) { + const i = cfg.combos.findIndex((c) => comboMatchesId(c, combo.id)); + if (i >= 0) { + const internalId = cfg.combos[i].id; + cfg.combos[i] = { ...cfg.combos[i], ...combo, name, id: internalId }; + } + } else { + cfg.combos.push({ + id: generateId("combo"), + name, + strategy: combo.strategy || "fallback", + members: combo.members || [], + createdAt: Date.now(), + }); + } + }); + return { ok: true, combos: store.load().combos.map(publicCombo) }; +}); + +handle("app:delete-combo", async (_e, id) => { + store.update((cfg) => { + cfg.combos = cfg.combos.filter((c) => !comboMatchesId(c, id)); + }); + return { ok: true }; +}); + +handle("app:set-server-enabled", async (_e, enabled) => { + store.update((cfg) => { + cfg.serverEnabled = !!enabled; + }); + return { ok: true }; +}); + +handle("app:set-bind-host", async (_e, bindHost) => { + const h = bindHost === "0.0.0.0" ? "0.0.0.0" : "127.0.0.1"; + store.update((cfg) => { + cfg.bindHost = h; + }); + try { + await restartGateway(); + return { ok: true, bindHost: h }; + } catch (e) { + return { ok: false, error: e.message, bindHost: h }; + } +}); + +handle("app:create-api-key", async (_e, name) => { + const key = generateApiKey(); + const entry = { + id: generateId("key"), + key, + name: (name && String(name).trim()) || "Key", + createdAt: Date.now(), + enabled: true, + }; + store.update((cfg) => { + if (!Array.isArray(cfg.apiKeys)) cfg.apiKeys = []; + cfg.apiKeys.push(entry); + }); + return { ok: true, key: entry }; +}); + +handle("app:revoke-api-key", async (_e, id) => { + store.update((cfg) => { + cfg.apiKeys = (cfg.apiKeys || []).filter((k) => k.id !== id); + if (!cfg.apiKeys.length) { + const key = generateApiKey(); + cfg.apiKeys = [ + { id: generateId("key"), key, name: "Default", createdAt: Date.now(), enabled: true }, + ]; + } + cfg.apiKey = cfg.apiKeys.find((k) => k.enabled !== false)?.key || ""; + }); + return { ok: true, apiKeys: store.load().apiKeys }; +}); + +handle("app:set-api-key-enabled", async (_e, { id, enabled }) => { + store.update((cfg) => { + const k = (cfg.apiKeys || []).find((x) => x.id === id); + if (k) k.enabled = !!enabled; + cfg.apiKey = cfg.apiKeys.find((x) => x.enabled !== false)?.key || ""; + }); + return { ok: true }; +}); + +handle("app:set-model-enabled", async (_e, { providerId, modelId, enabled }) => { + store.update((cfg) => { + const p = cfg.providers.find((x) => x.id === providerId); + if (!p) return; + if (!Array.isArray(p.models)) p.models = []; + let m = p.models.find((x) => (typeof x === "string" ? x : x.id) === modelId); + if (!m) { + p.models.push({ id: modelId, name: modelId, enabled: !!enabled }); + } else if (typeof m === "string") { + const i = p.models.indexOf(m); + p.models[i] = { id: m, name: m, enabled: !!enabled }; + } else { + m.enabled = !!enabled; + } + }); + return { ok: true }; +}); + +handle("app:add-model", async (_e, { providerId, modelId }) => { + const mid = String(modelId || "").trim(); + if (!mid) return { ok: false, error: "Model name required" }; + const cfg = store.load(); + const prov = (cfg.providers || []).find((p) => p.id === providerId); + if (!prov) return { ok: false, error: "Provider not found" }; + if (prov.enabled === false) return { ok: false, error: "Provider is disabled" }; + if (isCustomProviderType(prov.type)) { + const conflict = customModelRouteConflict(prov.name, [mid], cfg.combos); + if (conflict) { + return { + ok: false, + error: `A route named ${customProviderModelId(prov, mid)} already exists`, + }; + } + } + + // Verify with a minimal non-stream chat request through the real adapter + const adapter = getAdapter(prov.type); + if (!adapter || typeof adapter.chat !== "function") { + return { ok: false, error: `No chat adapter for ${prov.type}` }; + } + const testResult = await runProviderModelTest({ + adapter, + provider: prov, + model: mid, + logger, + onTokenRefresh: async (tokens) => { + store.update((c) => { + const p = c.providers.find((x) => x.id === providerId); + if (p) Object.assign(p, tokens); + }); + }, + }); + if (!testResult.ok) return testResult; + + store.update((c) => { + const p = c.providers.find((x) => x.id === providerId); + if (!p) return; + if (!Array.isArray(p.models)) p.models = []; + const exists = p.models.some((m) => (typeof m === "string" ? m : m.id) === mid); + if (!exists) p.models.push({ id: mid, name: mid, enabled: true }); + else { + const m = p.models.find((x) => (typeof x === "string" ? x : x.id) === mid); + if (m && typeof m !== "string") m.enabled = true; + } + }); + const savedModel = store + .load() + .providers.find((provider) => provider.id === providerId) + ?.models?.find((model) => (typeof model === "string" ? model : model.id) === mid); + if (!savedModel || (typeof savedModel !== "string" && savedModel.enabled === false)) { + return { ok: false, error: "Model passed its test but could not be saved" }; + } + return { ok: true, modelId: mid }; +}); + +handle("app:remove-model", async (_e, { providerId, modelId }) => { + store.update((cfg) => { + const p = cfg.providers.find((x) => x.id === providerId); + if (!p || !Array.isArray(p.models)) return; + p.models = p.models.filter((m) => (typeof m === "string" ? m : m.id) !== modelId); + }); + return { ok: true }; +}); + +handle("app:open-external", async (_e, url) => { + if (!isAllowedExternalUrl(url)) { + return { ok: false, error: "That external link is not allowed." }; + } + if (runtime === "desktop") await openExternal(url); + return { ok: true }; +}); + +handle("app:update-check", async () => + getUpdateService()?.check() || { + ok: false, + error: "Updates are managed by the current distribution.", + } +); + +handle("app:update-install", async () => { + const updateService = getUpdateService(); + if (!updateService || updateService.state().status !== "ready") { + return { ok: false, error: "No downloaded update is ready" }; + } + await gateway.stop(); + return updateService.install(); +}); + +handle("app:hide-panel", async () => { + await hidePanel(); + return { ok: true }; +}); + +handle("app:quit", async () => { + await quit(); + return { ok: true }; +}); + +handle("app:regenerate-key", async () => { + // Back-compat: create an additional key named Regenerated + const key = generateApiKey(); + const entry = { + id: generateId("key"), + key, + name: "Regenerated", + createdAt: Date.now(), + enabled: true, + }; + store.update((cfg) => { + if (!Array.isArray(cfg.apiKeys)) cfg.apiKeys = []; + cfg.apiKeys.push(entry); + cfg.apiKey = key; + }); + return { ok: true, apiKey: key }; +}); + + async function invoke(channel, args = [], context = {}) { + const handler = handlers.get(channel); + if (!handler) { + return { ok: false, code: "unsupported_action", error: "Unsupported ReRouted action." }; + } + const auth = context.sessionAuth || sessionAuth; + const harness = context.harness === true || harnessModeEnabled(); + const cfg = store.load(); + if (!canInvoke(channel, cfg, auth, { harness })) { + logger.warn("Blocked locked control-plane request", { channel }); + return lockedError(); + } + return handler({ sessionAuth: auth, harness, runtime, platform }, ...args); + } + + return { + invoke, + channels: () => [...handlers.keys()], + }; +} + +module.exports = { createControlPlane }; diff --git a/src/lib/dashboard.js b/src/lib/dashboard.js new file mode 100644 index 0000000..4480fb3 --- /dev/null +++ b/src/lib/dashboard.js @@ -0,0 +1,426 @@ +"use strict"; + +const crypto = require("node:crypto"); +const fs = require("node:fs"); +const path = require("node:path"); +const { createSessionAuth } = require("./session-auth"); +const { hasAdminPassword } = require("./ipc-security"); + +const SESSION_COOKIE = "rerouted_dashboard"; +const SESSION_IDLE_MS = 12 * 60 * 60 * 1000; +const SESSION_MAX_MS = 24 * 60 * 60 * 1000; +const LOGIN_WINDOW_MS = 60 * 1000; +const LOGIN_ATTEMPTS = 6; +const MAX_RPC_BYTES = 1024 * 1024; +const MAX_SESSIONS = 512; +const MAX_EVENT_CLIENTS = 128; +const VERIFY_CHANNEL = "app:verify-admin-password"; +const PUBLIC_ONBOARDING_CHANNELS = new Set([ + "app:get-state", + "app:set-onboarding-step", + "app:set-admin-password", + "app:detect-providers", + "app:import-detected", + "app:oauth-start", + "app:oauth-status", + "app:oauth-cancel", + "app:oauth-complete", + "app:add-keyed-provider", + "app:test-keyed-provider", + "app:save-combo", + "app:complete-onboarding", + "app:open-external", +]); + +const ASSETS = new Map([ + ["", ["index.html", "text/html; charset=utf-8"]], + ["index.html", ["index.html", "text/html; charset=utf-8"]], + ["styles.css", ["styles.css", "text/css; charset=utf-8"]], + ["web-api.js", ["web-api.js", "text/javascript; charset=utf-8"]], + ["app.js", ["app.js", "text/javascript; charset=utf-8"]], + ["account-identity.js", ["account-identity.js", "text/javascript; charset=utf-8"]], + ["number-format.js", ["number-format.js", "text/javascript; charset=utf-8"]], + ["lock-state.js", ["lock-state.js", "text/javascript; charset=utf-8"]], + ["provider-catalog.js", ["provider-catalog.js", "text/javascript; charset=utf-8"]], + ["route-picker.js", ["route-picker.js", "text/javascript; charset=utf-8"]], + ["oauth-prompt.js", ["oauth-prompt.js", "text/javascript; charset=utf-8"]], + ["assets/brandMark.png", ["assets/brandMark.png", "image/png"]], + ["assets/brandMark@2x.png", ["assets/brandMark@2x.png", "image/png"]], + ["assets/providers/chatgpt.svg", ["assets/providers/chatgpt.svg", "image/svg+xml"]], + ["assets/providers/claude.svg", ["assets/providers/claude.svg", "image/svg+xml"]], + ["assets/providers/antigravity.svg", ["assets/providers/antigravity.svg", "image/svg+xml"]], + ["assets/providers/xai.svg", ["assets/providers/xai.svg", "image/svg+xml"]], + ["assets/providers/openrouter.svg", ["assets/providers/openrouter.svg", "image/svg+xml"]], + ["assets/providers/nvidia.svg", ["assets/providers/nvidia.svg", "image/svg+xml"]], + ["assets/providers/cloudflare.svg", ["assets/providers/cloudflare.svg", "image/svg+xml"]], + ["assets/providers/glm.svg", ["assets/providers/glm.svg", "image/svg+xml"]], + ["assets/providers/custom.svg", ["assets/providers/custom.svg", "image/svg+xml"]], +]); + +function cookieValue(req, name) { + for (const part of String(req.headers.cookie || "").split(";")) { + const [key, ...rest] = part.trim().split("="); + if (key === name) return decodeURIComponent(rest.join("=")); + } + return ""; +} + +function isLoopback(req) { + const address = String(req.socket?.remoteAddress || ""); + return address === "127.0.0.1" || address === "::1" || address === "::ffff:127.0.0.1"; +} + +function requestOriginMatches(req) { + const origin = String(req.headers.origin || ""); + const host = String(req.headers.host || ""); + if (!origin || !host) return false; + try { + const parsed = new URL(origin); + return (parsed.protocol === "http:" || parsed.protocol === "https:") && parsed.host === host; + } catch { + return false; + } +} + +function safeHeaders(res, { html = false } = {}) { + res.setHeader("Cache-Control", "no-store"); + res.setHeader("Referrer-Policy", "no-referrer"); + res.setHeader("X-Content-Type-Options", "nosniff"); + res.setHeader("X-Frame-Options", "DENY"); + res.setHeader("Cross-Origin-Resource-Policy", "same-origin"); + if (html) { + res.setHeader( + "Content-Security-Policy", + "default-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'self'; connect-src 'self'; img-src 'self'; frame-ancestors 'none'; base-uri 'none'; form-action 'self'" + ); + } +} + +function json(res, status, body) { + safeHeaders(res); + res.writeHead(status, { "Content-Type": "application/json; charset=utf-8" }); + res.end(JSON.stringify(body)); +} + +function readJson(req) { + return new Promise((resolve, reject) => { + const chunks = []; + let size = 0; + let complete = false; + const fail = (message, code) => { + const error = new Error(message); + error.code = code; + return error; + }; + const declared = Number(req.headers["content-length"]); + if (Number.isFinite(declared) && declared > MAX_RPC_BYTES) { + req.resume(); + reject(fail("Dashboard request is too large", "BODY_TOO_LARGE")); + return; + } + req.on("data", (chunk) => { + if (complete) return; + size += chunk.length; + if (size > MAX_RPC_BYTES) { + complete = true; + chunks.length = 0; + reject(fail("Dashboard request is too large", "BODY_TOO_LARGE")); + return; + } + chunks.push(chunk); + }); + req.on("end", () => { + if (complete) return; + complete = true; + try { + resolve(JSON.parse(Buffer.concat(chunks).toString("utf8") || "{}")); + } catch { + reject(fail("Dashboard request must be valid JSON", "INVALID_JSON")); + } + }); + req.on("error", reject); + }); +} + +function createDashboard({ + store, + controlPlane, + rendererRoot = path.join(__dirname, "..", "renderer"), + logger, + now = () => Date.now(), +} = {}) { + if (!store || !controlPlane || !logger) { + throw new TypeError("Dashboard requires store, controlPlane, and logger"); + } + const sessions = new Map(); + const loginAttempts = new Map(); + const eventClients = new Set(); + + function prune() { + const current = now(); + for (const [token, session] of sessions) { + if (current - session.lastSeen > SESSION_IDLE_MS || current - session.createdAt > SESSION_MAX_MS) { + sessions.delete(token); + } + } + for (const [address, attempts] of loginAttempts) { + const fresh = attempts.filter((at) => current - at < LOGIN_WINDOW_MS); + if (fresh.length) loginAttempts.set(address, fresh); + else loginAttempts.delete(address); + } + } + + function sessionFor(req, res) { + prune(); + const supplied = cookieValue(req, SESSION_COOKIE); + let session = supplied && sessions.get(supplied); + if (!session) { + if (sessions.size >= MAX_SESSIONS) { + let oldestToken = null; + let oldestSeen = Infinity; + for (const [candidate, value] of sessions) { + if (value.lastSeen < oldestSeen) { + oldestToken = candidate; + oldestSeen = value.lastSeen; + } + } + if (oldestToken) sessions.delete(oldestToken); + } + const token = crypto.randomBytes(32).toString("base64url"); + session = { + token, + auth: createSessionAuth({ platform: "linux" }), + passwordHash: store.load().adminPasswordHash || null, + createdAt: now(), + lastSeen: now(), + }; + sessions.set(token, session); + res.setHeader( + "Set-Cookie", + `${SESSION_COOKIE}=${encodeURIComponent(token)}; HttpOnly; SameSite=Strict; Path=/dashboard; Max-Age=86400` + ); + } + const currentHash = store.load().adminPasswordHash || null; + if (session.passwordHash !== currentHash) { + session.auth.setManualUnlocked(false); + session.passwordHash = currentHash; + } + session.lastSeen = now(); + return session; + } + + function canAttemptLogin(req) { + const address = String(req.socket?.remoteAddress || "unknown"); + const current = now(); + const recent = (loginAttempts.get(address) || []).filter((at) => current - at < LOGIN_WINDOW_MS); + if (recent.length >= LOGIN_ATTEMPTS) return false; + recent.push(current); + loginAttempts.set(address, recent); + return true; + } + + async function serveAsset(res, name) { + const asset = ASSETS.get(name); + if (!asset) return false; + const [relativePath, contentType] = asset; + let body; + try { + body = await fs.promises.readFile(path.join(rendererRoot, relativePath)); + } catch (error) { + logger.error("Dashboard asset unavailable", { asset: relativePath, error: error.message }); + json(res, 500, { error: "Dashboard asset unavailable" }); + return true; + } + safeHeaders(res, { html: contentType.startsWith("text/html") }); + res.writeHead(200, { "Content-Type": contentType }); + res.end(body); + return true; + } + + function publish(channel, payload) { + const cfg = store.load(); + const password = hasAdminPassword(cfg); + for (const client of [...eventClients]) { + if (client.res.writableEnded || client.res.destroyed) { + eventClients.delete(client); + continue; + } + if (password && !client.session.auth.isUnlocked(true)) continue; + client.res.write(`event: ${channel}\ndata: ${JSON.stringify(payload)}\n\n`); + } + } + + async function handle(req, res, { path: requestPath }) { + const relative = decodeURIComponent(requestPath.slice("/dashboard".length)).replace(/^\/+/, ""); + if (requestPath === "/dashboard") { + safeHeaders(res); + res.writeHead(308, { Location: "/dashboard/" }); + res.end(); + return true; + } + + if (req.method === "GET" && relative === "api/events") { + if (eventClients.size >= MAX_EVENT_CLIENTS) { + json(res, 503, { ok: false, error: "Too many dashboard event connections" }); + return true; + } + if (req.headers.origin && !requestOriginMatches(req)) { + json(res, 403, { ok: false, error: "Dashboard origin check failed" }); + return true; + } + const session = sessionFor(req, res); + safeHeaders(res); + res.writeHead(200, { + "Content-Type": "text/event-stream; charset=utf-8", + Connection: "keep-alive", + "X-Accel-Buffering": "no", + }); + res.write(": ReRouted dashboard events\n\n"); + const client = { res, session }; + eventClients.add(client); + const cleanup = () => eventClients.delete(client); + req.once("close", cleanup); + res.once("close", cleanup); + return true; + } + + if (req.method === "POST" && relative === "api/invoke") { + if (!requestOriginMatches(req)) { + json(res, 403, { ok: false, error: "Dashboard origin check failed" }); + return true; + } + let body; + try { + body = await readJson(req); + } catch (error) { + json(res, error.code === "BODY_TOO_LARGE" ? 413 : 400, { + ok: false, + error: error.message, + }); + return true; + } + const channel = String(body.channel || ""); + const args = Array.isArray(body.args) ? body.args : []; + const session = sessionFor(req, res); + const cfg = store.load(); + if (!cfg.onboardingComplete && !isLoopback(req)) { + json(res, 403, { + ok: false, + error: "Initial setup is available only from this machine.", + }); + return true; + } + if (!cfg.onboardingComplete && !PUBLIC_ONBOARDING_CHANNELS.has(channel)) { + json(res, 403, { ok: false, error: "That action is unavailable during setup." }); + return true; + } + if ( + cfg.onboardingComplete && + !hasAdminPassword(cfg) && + channel !== "app:get-state" && + channel !== "app:set-admin-password" + ) { + json(res, 403, { + ok: false, + error: "Create an admin password before using the dashboard.", + }); + return true; + } + if (channel === VERIFY_CHANNEL && !canAttemptLogin(req)) { + json(res, 429, { + ok: false, + error: "Too many unlock attempts. Wait a minute and try again.", + }); + return true; + } + let result = await controlPlane.invoke(channel, args, { + sessionAuth: session.auth, + harness: false, + }); + if (channel === "app:get-state" && cfg.onboardingComplete && !hasAdminPassword(cfg)) { + result = { + onboardingComplete: false, + onboardingStep: "admin-password", + appVersion: result.appVersion, + runtime: result.runtime, + platform: result.platform, + update: result.update, + port: result.port, + openAtLogin: false, + bindHost: result.bindHost, + endpoint: result.endpoint, + listenHint: result.listenHint, + serverEnabled: result.serverEnabled, + serverListening: result.serverListening, + providers: [], + combos: [], + stats: { totalRequests: 0, sessionRequests: 0, recent: [] }, + usage: { + period: "24h", + requests: 0, + ok: 0, + errors: 0, + prompt_tokens: 0, + completion_tokens: 0, + cached_tokens: 0, + total_tokens: 0, + byModel: [], + byProvider: [], + recent: [], + }, + activeRequests: [], + oauthProviders: [], + keyedPresets: [], + unlocked: true, + hasAdminPassword: false, + steps: result.steps || [], + }; + } + if (channel === "app:set-admin-password" || channel === "app:change-admin-password") { + session.passwordHash = store.load().adminPasswordHash || null; + } + json(res, 200, result); + return true; + } + + if (req.method === "GET") { + if (relative === "" || relative === "index.html") sessionFor(req, res); + if (await serveAsset(res, relative)) return true; + } + json(res, 404, { error: "Not found" }); + return true; + } + + const heartbeat = setInterval(() => { + prune(); + for (const client of [...eventClients]) { + if (client.res.writableEnded || client.res.destroyed) eventClients.delete(client); + else client.res.write(": keepalive\n\n"); + } + }, 25_000); + heartbeat.unref?.(); + + function disconnect() { + for (const client of eventClients) client.res.end(); + eventClients.clear(); + } + + function close() { + clearInterval(heartbeat); + disconnect(); + sessions.clear(); + } + + return { handle, publish, disconnect, close }; +} + +module.exports = { + createDashboard, + cookieValue, + isLoopback, + requestOriginMatches, + SESSION_COOKIE, + MAX_SESSIONS, + MAX_EVENT_CLIENTS, + PUBLIC_ONBOARDING_CHANNELS, +}; diff --git a/src/lib/gateway.js b/src/lib/gateway.js index c80525c..cd98c32 100644 --- a/src/lib/gateway.js +++ b/src/lib/gateway.js @@ -36,6 +36,7 @@ function createGateway({ let server = null; let listeningPort = null; let listeningHost = null; + let dashboardHandler = null; function unauthorized(res, anthropic = false) { res.writeHead(401, { "Content-Type": "application/json" }); @@ -126,6 +127,15 @@ function createGateway({ const path = url.pathname.replace(/^\/v1\/v1(?=\/|$)/, "/v1"); const anthropicPath = path === "/v1/messages" || path === "/v1/messages/count_tokens"; + if (path === "/dashboard" || path.startsWith("/dashboard/")) { + if (dashboardHandler && (await dashboardHandler(req, res, { path, url })) !== false) { + return; + } + res.writeHead(404, { "Content-Type": "application/json" }); + res.end(JSON.stringify({ error: { message: "Dashboard unavailable" } })); + return; + } + // CORS for local tools res.setHeader("Access-Control-Allow-Origin", "*"); res.setHeader( @@ -437,7 +447,31 @@ function createGateway({ return listeningPort ? `http://127.0.0.1:${listeningPort}/v1` : null; } - return { start, stop, restart, isListening, getAddress, checkAuth, handle, validKeys }; + function getListeningAddress() { + return listeningPort == null + ? null + : { port: listeningPort, host: listeningHost || resolveHost() }; + } + + function setDashboardHandler(handler) { + if (handler != null && typeof handler !== "function") { + throw new TypeError("Dashboard handler must be a function"); + } + dashboardHandler = handler || null; + } + + return { + start, + stop, + restart, + isListening, + getAddress, + getListeningAddress, + checkAuth, + handle, + validKeys, + setDashboardHandler, + }; } module.exports = { createGateway, MAX_JSON_BODY_BYTES }; diff --git a/src/lib/headless-runtime.js b/src/lib/headless-runtime.js new file mode 100644 index 0000000..95f6523 --- /dev/null +++ b/src/lib/headless-runtime.js @@ -0,0 +1,233 @@ +"use strict"; + +const fs = require("node:fs"); +const os = require("node:os"); +const path = require("node:path"); +const { createStore } = require("./store"); +const { createRouter } = require("./router"); +const { createGateway } = require("./gateway"); +const { createDashboard } = require("./dashboard"); +const { createRequestActivity } = require("./request-activity"); +const { createUsageStore } = require("./usage"); +const { createQuotaService } = require("./quota"); +const { createSessionAuth } = require("./session-auth"); +const { createControlPlane } = require("./control-plane"); +const { backfillLocalOAuthIdentities } = require("./detect"); +const { backfillClaudeProfiles } = require("./oauth"); +const { getAdapter } = require("./providers"); +const { DEFAULT_PORT } = require("./constants"); +const defaultLogger = require("./logger"); + +function defaultUserData({ + platform = process.platform, + env = process.env, + homedir = os.homedir(), +} = {}) { + if (env.REROUTED_USER_DATA) return path.resolve(env.REROUTED_USER_DATA); + if (platform === "win32") { + return path.join(env.APPDATA || path.join(homedir, "AppData", "Roaming"), "ReRouted"); + } + if (platform === "darwin") { + return path.join(homedir, "Library", "Application Support", "ReRouted"); + } + return path.join(env.XDG_CONFIG_HOME || path.join(homedir, ".config"), "rerouted"); +} + +function createProcessLock(userData, { pid = process.pid, kill = process.kill } = {}) { + const lockPath = path.join(userData, "rerouted.pid"); + fs.mkdirSync(userData, { recursive: true, mode: 0o700 }); + + function liveProcess(savedPid) { + if (!Number.isSafeInteger(savedPid) || savedPid <= 0) return false; + try { + kill(savedPid, 0); + return true; + } catch (error) { + return error?.code === "EPERM"; + } + } + + for (let attempt = 0; attempt < 2; attempt += 1) { + try { + const fd = fs.openSync(lockPath, "wx", 0o600); + fs.writeFileSync(fd, `${pid}\n`, "utf8"); + fs.closeSync(fd); + let released = false; + return { + path: lockPath, + release() { + if (released) return; + released = true; + try { + const current = Number(fs.readFileSync(lockPath, "utf8").trim()); + if (current === pid) fs.unlinkSync(lockPath); + } catch { + // The process lock is best-effort during shutdown. + } + }, + }; + } catch (error) { + if (error?.code !== "EEXIST") throw error; + let savedPid = null; + try { + savedPid = Number(fs.readFileSync(lockPath, "utf8").trim()); + } catch { + // Treat an unreadable lock as stale only if we can replace it atomically below. + } + if (liveProcess(savedPid)) { + const active = new Error(`ReRouted is already running (PID ${savedPid})`); + active.code = "ALREADY_RUNNING"; + active.pid = savedPid; + throw active; + } + try { + fs.unlinkSync(lockPath); + } catch (unlinkError) { + if (unlinkError?.code !== "ENOENT") throw unlinkError; + } + } + } + throw new Error("Could not acquire the ReRouted process lock"); +} + +function createHeadlessRuntime({ + userData = defaultUserData(), + version = "0.0.0", + rendererRoot = path.join(__dirname, "..", "renderer"), + logger = defaultLogger, + openExternal = async () => {}, + onQuit = async () => {}, +} = {}) { + const configPath = path.join(userData, "config.json"); + const usagePath = path.join(userData, "usage.sqlite"); + const legacyUsagePath = path.join(userData, "usage.json"); + const logPath = path.join(userData, "rerouted.log"); + logger.configure(logPath); + + const store = createStore(configPath); + const usage = createUsageStore(usagePath, { legacyPath: legacyUsagePath }); + const requestActivity = createRequestActivity(); + const router = createRouter({ store, usage }); + const gateway = createGateway({ store, router, requestActivity }); + const sessionAuth = createSessionAuth({ platform: "linux" }); + + async function refreshProviderForQuota(provider) { + const adapter = getAdapter(provider?.type); + if (!adapter || !provider?.refreshToken || typeof adapter.refreshToken !== "function") { + return provider; + } + const tokens = await adapter.refreshToken(provider); + store.update((cfg) => { + const saved = (cfg.providers || []).find((item) => item.id === provider.id); + if (saved) Object.assign(saved, tokens); + }); + return { ...provider, ...tokens }; + } + + const quota = createQuotaService({ store, refreshProvider: refreshProviderForQuota }); + let dashboard = null; + const controlPlane = createControlPlane({ + store, + router, + gateway, + requestActivity, + quota, + logger, + sessionAuth, + getAppVersion: () => version, + openExternal, + revealFile: async () => {}, + quit: onQuit, + restartGateway: async () => { + dashboard?.disconnect(); + setTimeout(() => { + gateway.restart().catch((error) => + logger.error("Gateway restart failed", { error: error.message }) + ); + }, 100).unref?.(); + }, + runtime: "headless", + platform: process.platform, + }); + dashboard = createDashboard({ store, controlPlane, rendererRoot, logger }); + gateway.setDashboardHandler(dashboard.handle); + const unsubscribeActivity = requestActivity.subscribe((activity) => { + dashboard.publish("app:request-activity", activity); + }); + + let started = false; + let closing = null; + + async function start({ port, host } = {}) { + if (started) { + return { + address: gateway.getAddress(), + dashboard: gateway.getAddress()?.replace(/\/v1$/, "/dashboard/"), + }; + } + const cfg = store.load(); + if (backfillLocalOAuthIdentities(cfg.providers)) store.save(cfg); + const address = await gateway.start(port ?? cfg.port ?? DEFAULT_PORT, host ?? cfg.bindHost); + started = true; + logger.info("ReRouted headless runtime started", { + host: address.host, + port: address.port, + userData, + }); + + const claudeAdapter = getAdapter("claude"); + void backfillClaudeProfiles(store.load().providers, { + refreshImpl: (provider, options) => claudeAdapter.refreshToken(provider, options), + }) + .then((changed) => { + if (!changed) return; + store.save(store.load()); + dashboard.publish("app:provider-identities-updated", { changed: true }); + }) + .catch((error) => logger.warn(`Could not enrich Claude account identities: ${error.message}`)); + + return { + ...address, + endpoint: `http://127.0.0.1:${address.port}/v1`, + dashboard: `http://127.0.0.1:${address.port}/dashboard/`, + }; + } + + async function close({ drainMs = 5_000 } = {}) { + if (closing) return closing; + closing = (async () => { + unsubscribeActivity(); + dashboard.close(); + const deadline = Date.now() + Math.max(0, Number(drainMs) || 0); + while (requestActivity.snapshot().length && Date.now() < deadline) { + await new Promise((resolve) => setTimeout(resolve, 25)); + } + await gateway.stop(); + usage.close(); + started = false; + logger.info("ReRouted headless runtime stopped"); + })(); + return closing; + } + + return { + userData, + store, + usage, + router, + gateway, + requestActivity, + quota, + sessionAuth, + controlPlane, + dashboard, + start, + close, + }; +} + +module.exports = { + createHeadlessRuntime, + createProcessLock, + defaultUserData, +}; diff --git a/src/lib/password.js b/src/lib/password.js index 86e537c..371f9d4 100644 --- a/src/lib/password.js +++ b/src/lib/password.js @@ -24,11 +24,15 @@ async function verifyPassword(password, stored) { if (!stored || typeof stored !== "string") return false; const parts = stored.split("$"); if (parts.length !== 3 || parts[0] !== "scrypt") return false; - const salt = Buffer.from(parts[1], "hex"); - const expected = Buffer.from(parts[2], "hex"); - if (salt.length === 0 || expected.length === 0) return false; - const key = await scryptAsync(String(password), salt, expected.length, SCRYPT_OPTS); - return crypto.timingSafeEqual(key, expected); + if (!/^[a-f0-9]{32}$/i.test(parts[1]) || !/^[a-f0-9]{128}$/i.test(parts[2])) return false; + try { + const salt = Buffer.from(parts[1], "hex"); + const expected = Buffer.from(parts[2], "hex"); + const key = await scryptAsync(String(password), salt, KEY_LEN, SCRYPT_OPTS); + return crypto.timingSafeEqual(key, expected); + } catch { + return false; + } } /** diff --git a/src/main.js b/src/main.js index 5b43ba5..faf6f68 100644 --- a/src/main.js +++ b/src/main.js @@ -20,46 +20,19 @@ const { createStore } = require("./lib/store"); const { createRouter } = require("./lib/router"); const { createGateway } = require("./lib/gateway"); const { createRequestActivity } = require("./lib/request-activity"); -const { createUsageStore, hydrateUsageIdentity } = require("./lib/usage"); +const { createUsageStore } = require("./lib/usage"); const logger = require("./lib/logger"); -const { hashPassword, verifyPassword, generateId, generateApiKey } = require("./lib/password"); -const { detectAll, summarizeDetected, backfillLocalOAuthIdentities } = require("./lib/detect"); -const { - startOAuth, - completeOAuth, - oauthStatus, - clearPending, - backfillClaudeProfiles, -} = require("./lib/oauth"); +const { generateApiKey } = require("./lib/password"); +const { backfillLocalOAuthIdentities } = require("./lib/detect"); +const { backfillClaudeProfiles } = require("./lib/oauth"); const { createQuotaService } = require("./lib/quota"); const { createSessionAuth, isMacSessionActive } = require("./lib/session-auth"); -const { - canInvoke, - hasAdminPassword, - isAllowedExternalUrl, - lockedError, - redactLockedState, -} = require("./lib/ipc-security"); -const { runProviderModelTest } = require("./lib/model-test"); -const { testKeyedProvider } = require("./lib/keyed-provider-test"); +const { hasAdminPassword } = require("./lib/ipc-security"); const { createUpdateService } = require("./lib/updater"); const { acquireSingleInstance } = require("./lib/single-instance"); -const { KEYED_PRESETS, ONBOARDING_STEPS, DEFAULT_PORT, OAUTH } = require("./lib/constants"); -const { defaultModelsForType, listProviderModels, getAdapter } = require("./lib/providers"); -const { - customConnectionNameError, - customModelRouteConflict, - customProviderModelId, - isCustomProviderType, -} = require("./lib/model-ids"); -const { - publicCombo, - comboMatchesId, - publicRouteId, - providerRouteIds, - comboStorageIdConflict, - comboNameConflict, -} = require("./lib/combos"); +const { createControlPlane } = require("./lib/control-plane"); +const { DEFAULT_PORT } = require("./lib/constants"); +const { getAdapter } = require("./lib/providers"); // ─── Paths / single instance ─────────────────────────────────────────── const gotLock = acquireSingleInstance(app); @@ -292,646 +265,40 @@ function updateTrayTitle() { tray.setTitle(n > 0 ? ` ${n}` : ""); } -// ─── IPC ─────────────────────────────────────────────────────────────── -function registerIpc() { - const handle = (channel, handler) => { - ipcMain.handle(channel, async (...args) => { - const cfg = store.load(); - if (!canInvoke(channel, cfg, sessionAuth, { harness: harnessModeEnabled() })) { - logger.warn("Blocked locked IPC request", { channel }); - return lockedError(); - } - return handler(...args); - }); - }; - - function publicActivityEntry(entry, cfg) { - return { - ...hydrateUsageIdentity(entry, cfg.providers), - model: publicRouteId(cfg.combos, entry.model), - }; - } - - function publicStats(stats, cfg) { - if (!stats) return stats; - return { - ...stats, - recent: (stats.recent || []).map((entry) => publicActivityEntry(entry, cfg)), - }; - } +// ─── Shared control plane / IPC ─────────────────────────────────────── +const controlPlane = createControlPlane({ + store, + router, + gateway, + requestActivity, + quota, + logger, + sessionAuth, + getAppVersion: () => app.getVersion(), + getUpdateService: () => updateService, + harnessModeEnabled, + setOpenAtLogin: async (enabled) => { + app.setLoginItemSettings({ openAtLogin: enabled, openAsHidden: true }); + }, + openExternal: (url) => shell.openExternal(url), + revealFile: async (filePath) => { + shell.showItemInFolder(filePath); + }, + hidePanel, + quit: async () => app.quit(), + runtime: "desktop", + platform: process.platform, +}); - function publicUsage(usage, cfg) { - if (!usage) return usage; - return { - ...usage, - byModel: (usage.byModel || []).map((entry) => ({ - ...entry, - model: publicRouteId(cfg.combos, entry.model), - })), - byProvider: (usage.byProvider || []).map((entry) => - hydrateUsageIdentity(entry, cfg.providers) - ), - recent: (usage.recent || []).map((entry) => publicActivityEntry(entry, cfg)), - }; +function registerIpc() { + for (const channel of controlPlane.channels()) { + ipcMain.handle(channel, async (_event, ...args) => + controlPlane.invoke(channel, args, { + sessionAuth, + harness: harnessModeEnabled(), + }) + ); } - - handle("app:get-state", async () => { - const cfg = store.load(); - const publicProviders = (cfg.providers || []).map((p) => { - const models = listProviderModels(p, { includeDisabled: true }).map((m) => ({ - id: m.upstreamModel, - gatewayId: m.id, - name: m.name, - enabled: m.enabled !== false, - })); - return { - id: p.id, - type: p.type, - name: p.name, - accountAlias: p.accountAlias || null, - email: p.email, - profileName: p.profileName, - enabled: p.enabled !== false, - hasToken: !!(p.accessToken || p.apiKey), - models, - baseUrl: p.baseUrl, - }; - }); - const port = cfg.port || DEFAULT_PORT; - const bindHost = cfg.bindHost || "127.0.0.1"; - const apiKeys = (cfg.apiKeys || []).map((k) => ({ - id: k.id, - name: k.name || "Key", - key: k.key, - enabled: k.enabled !== false, - createdAt: k.createdAt, - })); - // Primary key for simple copy on Home / onboarding - const primaryKey = apiKeys.find((k) => k.enabled !== false)?.key || ""; - const hasPassword = hasAdminPassword(cfg); - const unlocked = sessionAuth.isUnlocked(hasPassword) || harnessModeEnabled(); - return redactLockedState({ - onboardingComplete: !!cfg.onboardingComplete, - appVersion: app.getVersion(), - update: updateService?.state() || { - status: "idle", - currentVersion: app.getVersion(), - version: null, - checkedAt: null, - error: null, - }, - onboardingStep: cfg.onboardingStep || "permissions", - openAtLogin: !!cfg.openAtLogin, - port, - bindHost, - apiKey: primaryKey, - apiKeys, - endpoint: `http://127.0.0.1:${port}/v1`, - // When bound to all interfaces, tools on other Tailscale nodes can use this host's tailnet IP - listenHint: - bindHost === "0.0.0.0" - ? "Listening on all interfaces (LAN / Tailscale). Use this Mac's Tailscale IP + port 4949." - : "Listening on localhost only. Switch bind to All interfaces in Settings for Tailscale.", - serverEnabled: cfg.serverEnabled !== false, - serverListening: gateway.isListening(), - providers: publicProviders, - combos: (cfg.combos || []).map(publicCombo), - stats: publicStats(router.stats(), cfg), - usage: publicUsage(router.usageAggregate("24h"), cfg), - activeRequests: requestActivity.snapshot(), - unlocked, - hasAdminPassword: hasPassword, - oauthProviders: Object.keys(OAUTH).map((k) => ({ - id: k, - name: OAUTH[k].name, - })), - keyedPresets: Object.values(KEYED_PRESETS), - steps: ONBOARDING_STEPS, - }); - }); - - handle("app:set-onboarding-step", async (_e, step) => { - store.update((cfg) => { - cfg.onboardingStep = step; - if (step === "done") cfg.onboardingComplete = true; - }); - return { ok: true }; - }); - - handle("app:complete-onboarding", async () => { - store.update((cfg) => { - cfg.onboardingComplete = true; - cfg.onboardingStep = "done"; - }); - return { ok: true }; - }); - - handle("app:set-open-at-login", async (_e, enabled) => { - app.setLoginItemSettings({ openAtLogin: !!enabled, openAsHidden: true }); - store.update((cfg) => { - cfg.openAtLogin = !!enabled; - }); - return { ok: true, openAtLogin: !!enabled }; - }); - - handle("app:set-admin-password", async (_e, password) => { - if (!password || String(password).length < 4) { - return { ok: false, error: "Password must be at least 4 characters" }; - } - const hash = await hashPassword(password); - store.update((cfg) => { - cfg.adminPasswordHash = hash; - }); - sessionAuth.setManualUnlocked(true); - return { ok: true }; - }); - - handle("app:verify-admin-password", async (_e, password) => { - const cfg = store.load(); - if (!cfg.adminPasswordHash || cfg.adminPasswordHash === "harness") { - sessionAuth.setManualUnlocked(true); - return { ok: true }; - } - const ok = await verifyPassword(password, cfg.adminPasswordHash); - sessionAuth.setManualUnlocked(ok); - return { ok }; - }); - - handle("app:change-admin-password", async (_e, { current, next }) => { - const cfg = store.load(); - if (cfg.adminPasswordHash && cfg.adminPasswordHash !== "harness") { - const ok = await verifyPassword(current, cfg.adminPasswordHash); - if (!ok) return { ok: false, error: "Current password incorrect" }; - } - if (!next || String(next).length < 4) { - return { ok: false, error: "New password too short" }; - } - const hash = await hashPassword(next); - store.update((c) => { - c.adminPasswordHash = hash; - }); - return { ok: true }; - }); - - handle("app:detect-providers", async () => { - detectedCache = await detectAll(); - return { ok: true, found: summarizeDetected(detectedCache) }; - }); - - handle("app:import-detected", async (_e, ids) => { - const want = new Set(ids || []); - const toImport = detectedCache.filter((d) => want.has(d.id)); - store.update((cfg) => { - for (const d of toImport) { - // Avoid duplicate by type+email/source path - const exists = cfg.providers.some( - (p) => - p.type === d.type && - ((d.email && p.email === d.email) || (d.path && p.importPath === d.path)) - ); - if (exists) continue; - cfg.providers.push({ - id: d.id || generateId("prov"), - type: d.type, - name: d.name, - email: d.email, - accessToken: d.accessToken, - refreshToken: d.refreshToken, - accountId: d.accountId, - projectId: d.projectId, - clientId: d.clientId, - clientSecret: d.clientSecret, - models: d.models, - enabled: true, - importPath: d.path, - source: d.source, - createdAt: Date.now(), - }); - } - }); - return { ok: true }; - }); - - handle("app:oauth-start", async (_e, type) => { - try { - logger.oauth(`UI requested OAuth start for ${type}`); - const result = await startOAuth(type); - logger.oauth(`Opening external browser for ${type}`); - await shell.openExternal(result.authUrl); - logger.oauth(`Browser open dispatched for ${type}`); - return { - ok: true, - authUrl: result.authUrl, - altAuthUrl: result.altAuthUrl || null, - redirectUri: result.redirectUri, - needsPaste: result.needsPaste, - params: result.params, - logFile: logger.getFilePath(), - }; - } catch (e) { - logger.error(`oauth-start failed: ${e.message}`); - return { ok: false, error: e.message, logFile: logger.getFilePath() }; - } - }); - - handle("app:oauth-status", async (_e, type) => oauthStatus(type)); - - handle("app:oauth-cancel", async (_e, type) => { - clearPending(type); - return { ok: true }; - }); - - handle("app:oauth-complete", async (_e, { type, pasteCode, providerId }) => { - try { - logger.oauth(`UI requested OAuth complete for ${type}`, { - providerId: providerId || null, - pasteLen: pasteCode ? String(pasteCode).length : 0, - }); - const account = await completeOAuth(type, { pasteCode }); - store.update((cfg) => { - if (providerId) { - const i = cfg.providers.findIndex((p) => p.id === providerId); - if (i >= 0) { - const prev = cfg.providers[i]; - cfg.providers[i] = { - ...prev, - accessToken: account.accessToken, - refreshToken: account.refreshToken || prev.refreshToken, - expiresAt: account.expiresAt, - accountId: account.accountId || prev.accountId, - projectId: account.projectId || prev.projectId, - email: account.email || prev.email, - profileName: account.profileName || prev.profileName, - name: prev.name || account.name, - enabled: true, - }; - return; - } - } - cfg.providers.push(account); - }); - logger.oauth(`OAuth complete SUCCESS for ${type}`, { - name: account.name, - reauthed: !!providerId, - }); - return { - ok: true, - account: { - id: providerId || account.id, - type: account.type, - name: account.name, - email: account.email || null, - profileName: account.profileName || null, - reauthed: !!providerId, - }, - }; - } catch (e) { - logger.error(`oauth-complete FAILED for ${type}: ${e.message}`); - return { ok: false, error: e.message, logFile: logger.getFilePath() }; - } - }); - - handle("app:logs-get", async (_e, limit) => { - return { - ok: true, - entries: logger.list(limit || 200), - file: logger.getFilePath(), - }; - }); - - handle("app:logs-clear", async () => { - logger.clear(); - logger.info("Logs cleared by user"); - return { ok: true }; - }); - - handle("app:logs-reveal", async () => { - const f = logger.getFilePath(); - if (f) { - shell.showItemInFolder(f); - return { ok: true, file: f }; - } - return { ok: false, error: "No log file" }; - }); - - handle("app:add-keyed-provider", async (_e, payload) => { - const { preset, name, baseUrl, apiKey, accountId, models } = payload || {}; - let finalBase = baseUrl; - let finalName = name; - let type = "custom"; - if (preset && KEYED_PRESETS[preset]) { - const p = KEYED_PRESETS[preset]; - finalBase = p.baseUrl.replace("{account_id}", accountId || ""); - finalName = finalName || p.name; - type = preset; - } - if (!finalBase || !apiKey) return { ok: false, error: "Base URL and API key required" }; - if (type === "custom") { - const current = store.load(); - const nameError = customConnectionNameError(finalName, current.providers); - if (nameError) return { ok: false, error: nameError }; - finalName = String(finalName).trim(); - const conflict = customModelRouteConflict(finalName, models, current.combos); - if (conflict) { - const modelId = typeof conflict === "string" ? conflict : conflict.id; - return { - ok: false, - error: `A route named ${customProviderModelId({ name: finalName }, modelId)} already exists`, - }; - } - } - const prov = { - id: generateId("prov"), - type: type === "custom" ? "openai-compat" : type, - name: finalName || "Custom", - baseUrl: finalBase.replace(/\/+$/, ""), - apiKey, - models: models || [], - enabled: true, - createdAt: Date.now(), - }; - store.update((cfg) => { - cfg.providers.push(prov); - }); - return { ok: true, id: prov.id }; - }); - - handle("app:test-keyed-provider", async (_e, payload) => { - const adapter = getAdapter(payload?.providerType); - return testKeyedProvider(payload, { adapter: adapter || undefined, logger }); - }); - - handle("app:remove-provider", async (_e, id) => { - store.update((cfg) => { - cfg.providers = cfg.providers.filter((p) => p.id !== id); - for (const c of cfg.combos) { - c.members = (c.members || []).filter((m) => m.providerId !== id); - } - }); - return { ok: true }; - }); - - handle("app:set-provider-enabled", async (_e, { id, enabled }) => { - let found = false; - store.update((cfg) => { - const p = cfg.providers.find((x) => x.id === id); - if (p) { - p.enabled = !!enabled; - found = true; - } - }); - return { ok: found, enabled: !!enabled }; - }); - - handle("app:usage", async (_e, period) => { - const cfg = store.load(); - return { - ok: true, - usage: publicUsage(router.usageAggregate(period || "24h"), cfg), - stats: publicStats(router.stats(), cfg), - }; - }); - - handle("app:quota-get", async () => { - return { ok: true, quota: quota.current() }; - }); - - handle("app:quota-refresh", async () => { - return { ok: true, quota: await quota.refresh() }; - }); - - handle("app:save-combo", async (_e, combo) => { - const name = String(combo?.name || "").trim(); - if (!name) return { ok: false, error: "Model ID is required" }; - const current = store.load(); - const editIndex = combo.id - ? (current.combos || []).findIndex((entry) => comboMatchesId(entry, combo.id)) - : -1; - if (combo.id && editIndex < 0) return { ok: false, error: "Route not found" }; - if (comboNameConflict(current.combos, name, editIndex)) { - return { ok: false, error: `A route named ${name} already exists` }; - } - if (comboStorageIdConflict(current.combos, name)) { - return { ok: false, error: "That model ID is reserved by an existing route" }; - } - if (providerRouteIds(current.providers).has(name.toLowerCase())) { - return { ok: false, error: "That model ID is already used by a connected provider" }; - } - store.update((cfg) => { - if (combo.id) { - const i = cfg.combos.findIndex((c) => comboMatchesId(c, combo.id)); - if (i >= 0) { - const internalId = cfg.combos[i].id; - cfg.combos[i] = { ...cfg.combos[i], ...combo, name, id: internalId }; - } - } else { - cfg.combos.push({ - id: generateId("combo"), - name, - strategy: combo.strategy || "fallback", - members: combo.members || [], - createdAt: Date.now(), - }); - } - }); - return { ok: true, combos: store.load().combos.map(publicCombo) }; - }); - - handle("app:delete-combo", async (_e, id) => { - store.update((cfg) => { - cfg.combos = cfg.combos.filter((c) => !comboMatchesId(c, id)); - }); - return { ok: true }; - }); - - handle("app:set-server-enabled", async (_e, enabled) => { - store.update((cfg) => { - cfg.serverEnabled = !!enabled; - }); - return { ok: true }; - }); - - handle("app:set-bind-host", async (_e, bindHost) => { - const h = bindHost === "0.0.0.0" ? "0.0.0.0" : "127.0.0.1"; - store.update((cfg) => { - cfg.bindHost = h; - }); - try { - await gateway.restart(); - return { ok: true, bindHost: h }; - } catch (e) { - return { ok: false, error: e.message, bindHost: h }; - } - }); - - handle("app:create-api-key", async (_e, name) => { - const key = generateApiKey(); - const entry = { - id: generateId("key"), - key, - name: (name && String(name).trim()) || "Key", - createdAt: Date.now(), - enabled: true, - }; - store.update((cfg) => { - if (!Array.isArray(cfg.apiKeys)) cfg.apiKeys = []; - cfg.apiKeys.push(entry); - }); - return { ok: true, key: entry }; - }); - - handle("app:revoke-api-key", async (_e, id) => { - store.update((cfg) => { - cfg.apiKeys = (cfg.apiKeys || []).filter((k) => k.id !== id); - if (!cfg.apiKeys.length) { - const key = generateApiKey(); - cfg.apiKeys = [ - { id: generateId("key"), key, name: "Default", createdAt: Date.now(), enabled: true }, - ]; - } - cfg.apiKey = cfg.apiKeys.find((k) => k.enabled !== false)?.key || ""; - }); - return { ok: true, apiKeys: store.load().apiKeys }; - }); - - handle("app:set-api-key-enabled", async (_e, { id, enabled }) => { - store.update((cfg) => { - const k = (cfg.apiKeys || []).find((x) => x.id === id); - if (k) k.enabled = !!enabled; - cfg.apiKey = cfg.apiKeys.find((x) => x.enabled !== false)?.key || ""; - }); - return { ok: true }; - }); - - handle("app:set-model-enabled", async (_e, { providerId, modelId, enabled }) => { - store.update((cfg) => { - const p = cfg.providers.find((x) => x.id === providerId); - if (!p) return; - if (!Array.isArray(p.models)) p.models = []; - let m = p.models.find((x) => (typeof x === "string" ? x : x.id) === modelId); - if (!m) { - p.models.push({ id: modelId, name: modelId, enabled: !!enabled }); - } else if (typeof m === "string") { - const i = p.models.indexOf(m); - p.models[i] = { id: m, name: m, enabled: !!enabled }; - } else { - m.enabled = !!enabled; - } - }); - return { ok: true }; - }); - - handle("app:add-model", async (_e, { providerId, modelId }) => { - const mid = String(modelId || "").trim(); - if (!mid) return { ok: false, error: "Model name required" }; - const cfg = store.load(); - const prov = (cfg.providers || []).find((p) => p.id === providerId); - if (!prov) return { ok: false, error: "Provider not found" }; - if (prov.enabled === false) return { ok: false, error: "Provider is disabled" }; - if (isCustomProviderType(prov.type)) { - const conflict = customModelRouteConflict(prov.name, [mid], cfg.combos); - if (conflict) { - return { - ok: false, - error: `A route named ${customProviderModelId(prov, mid)} already exists`, - }; - } - } - - // Verify with a minimal non-stream chat request through the real adapter - const adapter = getAdapter(prov.type); - if (!adapter || typeof adapter.chat !== "function") { - return { ok: false, error: `No chat adapter for ${prov.type}` }; - } - const testResult = await runProviderModelTest({ - adapter, - provider: prov, - model: mid, - logger, - onTokenRefresh: async (tokens) => { - store.update((c) => { - const p = c.providers.find((x) => x.id === providerId); - if (p) Object.assign(p, tokens); - }); - }, - }); - if (!testResult.ok) return testResult; - - store.update((c) => { - const p = c.providers.find((x) => x.id === providerId); - if (!p) return; - if (!Array.isArray(p.models)) p.models = []; - const exists = p.models.some((m) => (typeof m === "string" ? m : m.id) === mid); - if (!exists) p.models.push({ id: mid, name: mid, enabled: true }); - else { - const m = p.models.find((x) => (typeof x === "string" ? x : x.id) === mid); - if (m && typeof m !== "string") m.enabled = true; - } - }); - const savedModel = store - .load() - .providers.find((provider) => provider.id === providerId) - ?.models?.find((model) => (typeof model === "string" ? model : model.id) === mid); - if (!savedModel || (typeof savedModel !== "string" && savedModel.enabled === false)) { - return { ok: false, error: "Model passed its test but could not be saved" }; - } - return { ok: true, modelId: mid }; - }); - - handle("app:remove-model", async (_e, { providerId, modelId }) => { - store.update((cfg) => { - const p = cfg.providers.find((x) => x.id === providerId); - if (!p || !Array.isArray(p.models)) return; - p.models = p.models.filter((m) => (typeof m === "string" ? m : m.id) !== modelId); - }); - return { ok: true }; - }); - - handle("app:open-external", async (_e, url) => { - if (!isAllowedExternalUrl(url)) { - return { ok: false, error: "That external link is not allowed." }; - } - await shell.openExternal(url); - return { ok: true }; - }); - - handle("app:update-check", async () => updateService?.check() || { ok: false }); - - handle("app:update-install", async () => { - if (!updateService || updateService.state().status !== "ready") { - return { ok: false, error: "No downloaded update is ready" }; - } - await gateway.stop(); - return updateService.install(); - }); - - handle("app:hide-panel", async () => { - hidePanel(); - return { ok: true }; - }); - - handle("app:quit", async () => { - app.quit(); - }); - - handle("app:regenerate-key", async () => { - // Back-compat: create an additional key named Regenerated - const key = generateApiKey(); - const entry = { - id: generateId("key"), - key, - name: "Regenerated", - createdAt: Date.now(), - enabled: true, - }; - store.update((cfg) => { - if (!Array.isArray(cfg.apiKeys)) cfg.apiKeys = []; - cfg.apiKeys.push(entry); - cfg.apiKey = key; - }); - return { ok: true, apiKey: key }; - }); - } // ─── Boot ────────────────────────────────────────────────────────────── diff --git a/src/renderer/app.js b/src/renderer/app.js index c5dd983..bd24ec7 100644 --- a/src/renderer/app.js +++ b/src/renderer/app.js @@ -1,6 +1,7 @@ "use strict"; const api = window.rerouted; +const dashboardRuntime = document.documentElement.classList.contains("dashboard-runtime"); const { accountDisplayName, accountIdentityLabel, maskAccountEmail } = window.ReroutedAccountIdentity; const { compactNumber: fmtNum } = window.ReroutedNumberFormat; @@ -13,6 +14,8 @@ const $ = (sel, el = document) => el.querySelector(sel); const view = $("#view"); const nav = $("#nav"); const toastEl = $("#toast"); +const closeButton = $("#btn-close"); +if (!dashboardRuntime) closeButton.hidden = false; let state = null; let page = "home"; @@ -320,9 +323,16 @@ function stepProgress(step) { function renderPermissions() { view.innerHTML = ` ${stepProgress("permissions")} -

Permissions

-

ReRouted runs in your menu bar and serves a local API on this Mac only. Enable open at login so the endpoint is ready when you need it. Importing local credentials may prompt for macOS Keychain access.

-
+

${dashboardRuntime ? "Headless runtime" : "Permissions"}

+

${ + dashboardRuntime + ? "ReRouted serves its local API and this dashboard from one headless process. Keep that process running so your tools can always reach the endpoint." + : "ReRouted runs in your menu bar and serves a local API on this Mac only. Enable open at login so the endpoint is ready when you need it. Importing local credentials may prompt for macOS Keychain access." + }

+ ${ + dashboardRuntime + ? "" + : `
Open at Login
@@ -330,15 +340,18 @@ function renderPermissions() {
-
+
` + }
`; - $("#tog-login").onchange = async (e) => { - await api.invoke("app:set-open-at-login", e.target.checked); - await refresh(); - }; + if ($("#tog-login")) { + $("#tog-login").onchange = async (e) => { + await api.invoke("app:set-open-at-login", e.target.checked); + await refresh(); + }; + } $("#btn-next").onclick = () => goStep("admin-password"); } @@ -346,7 +359,11 @@ function renderAdminPassword() { view.innerHTML = ` ${stepProgress("admin-password")}

Create admin password

-

Your active macOS login unlocks ReRouted. This password is the fallback when the app cannot confirm that session. It is stored as a scrypt hash — never sent anywhere.

+

${ + dashboardRuntime + ? "This password protects dashboard access to your providers, routes, gateway keys, and activity. It is stored locally as a scrypt hash — never sent anywhere else." + : "Your active macOS login unlocks ReRouted. This password is the fallback when the app cannot confirm that session. It is stored as a scrypt hash — never sent anywhere." + }

@@ -370,7 +387,7 @@ function renderWelcome() {

Your models.
One clean route.

Connect subscriptions and API keys once. ReRouted presents a single local endpoint and moves traffic when an account runs out.

-
Runs on this Mac
+
Runs on this ${dashboardRuntime ? "machine" : "Mac"}
Claude · ChatGPT · Gemini · Grok · API keys
@@ -385,10 +402,10 @@ function renderAutoDetect() { view.innerHTML = ` ${stepProgress("auto-detect")}

Auto-detect providers?

-

ReRouted can import supported credentials already stored on this Mac so you can skip another sign-in. Tokens stay local.

+

ReRouted can import supported credentials already stored on this ${dashboardRuntime ? "machine" : "Mac"} so you can skip another sign-in. Tokens stay local.

- +
`; @@ -867,7 +884,11 @@ function renderLock() {
RR
Local control plane

Unlock ReRouted

-

Your Mac session normally unlocks this panel. Enter the admin password if the session state cannot be verified.

+

${ + dashboardRuntime + ? "Enter your admin password to manage providers, routes, keys, and activity." + : "Your Mac session normally unlocks this panel. Enter the admin password if the session state cannot be verified." + }

@@ -2219,6 +2240,7 @@ function renderSettings() { const keys = state.apiKeys || []; const bindAll = state.bindHost === "0.0.0.0"; const update = state.update || { status: "idle", currentVersion: state.appVersion }; + const showDesktopSettings = state.runtime !== "headless"; const updateUi = { idle: { copy: "Check for signed releases without leaving ReRouted.", @@ -2252,13 +2274,13 @@ function renderSettings() { }[update.status] || { copy: "Check for signed releases.", label: "Check now" }; view.innerHTML = ` ${pageHeader("Control", "Settings", "Configure startup, network exposure, credentials, and local security.")} - ${sectionHeader("General")} -
+ ${showDesktopSettings ? sectionHeader("General") : ""} + ${showDesktopSettings ? `
Open at login
Keep the local gateway ready after sign-in.
-
+
` : ""} ${sectionHeader("Gateway", state.serverListening ? "Online" : "Offline")}
@@ -2294,7 +2316,7 @@ function renderSettings() {
${sectionHeader("Security")}
-
Change admin password
Used only when the active Mac session cannot unlock the panel.
+
Change admin password
${showDesktopSettings ? "Used only when the active Mac session cannot unlock the panel." : "Required to unlock this dashboard in a new browser session."}
@@ -2302,16 +2324,18 @@ function renderSettings() {
${sectionHeader("Application", `ReRouted ${state.appVersion || ""}`)}
-
Software updates
${esc(updateUi.copy)}
-
Quit ReRouted
Stops the menu bar app and local gateway.
+
Software updates
${esc(updateUi.copy)}
${showDesktopSettings ? `` : ""}
+ ${showDesktopSettings ? '
Quit ReRouted
Stops the menu bar app and local gateway.
' : ""}
· Independent personal project.
`; wireSecrets(); $("#copy-settings-url").onclick = () => copy(state.endpoint); - $("#tog-login").onchange = async (e) => { - await api.invoke("app:set-open-at-login", e.target.checked); - }; + if ($("#tog-login")) { + $("#tog-login").onchange = async (e) => { + await api.invoke("app:set-open-at-login", e.target.checked); + }; + } $("#tog-srv").onchange = async (e) => { await api.invoke("app:set-server-enabled", e.target.checked); await refresh(); @@ -2355,7 +2379,7 @@ function renderSettings() { }); toast(r.ok ? "Password updated" : r.error || "Failed"); }; - $("#btn-update").onclick = async () => { + if ($("#btn-update")) $("#btn-update").onclick = async () => { const current = state.update?.status; const result = await api.invoke( current === "ready" ? "app:update-install" : "app:update-check" @@ -2364,7 +2388,7 @@ function renderSettings() { if (!result?.ok && result?.error) toast(result.error); if (page === "settings") render(); }; - $("#btn-quit").onclick = () => api.invoke("app:quit"); + if ($("#btn-quit")) $("#btn-quit").onclick = () => api.invoke("app:quit"); $("#btn-product-site").onclick = () => api.invoke("app:open-external", "https://rerouted.dev"); } @@ -2449,7 +2473,7 @@ nav.querySelectorAll(".nav-btn").forEach((btn) => { }; }); -$("#btn-close").onclick = () => api.invoke("app:hide-panel"); +closeButton.onclick = () => api.invoke("app:hide-panel"); api.on("app:session-lock-changed", async (session) => { if (state && session?.unlocked === false) { diff --git a/src/renderer/index.html b/src/renderer/index.html index f649756..19bb6e7 100644 --- a/src/renderer/index.html +++ b/src/renderer/index.html @@ -28,7 +28,7 @@ Local
-
@@ -58,6 +58,7 @@

+ diff --git a/src/renderer/styles.css b/src/renderer/styles.css index e48e861..0ba4988 100644 --- a/src/renderer/styles.css +++ b/src/renderer/styles.css @@ -181,6 +181,10 @@ summary:focus-visible, cursor: pointer; } +.icon-btn[hidden] { + display: none !important; +} + .icon-btn:hover { color: #fff; background: rgba(255, 255, 255, 0.1); @@ -2096,6 +2100,79 @@ summary:focus-visible, to { opacity: 1; transform: scaleX(1); } } +.dashboard-runtime, +.dashboard-runtime body { + min-width: 320px; + min-height: 100%; + overflow: auto; + background: var(--canvas); +} + +.dashboard-runtime body { + display: grid; + place-items: start center; + padding: clamp(12px, 3vw, 36px); +} + +.dashboard-runtime .shell { + width: min(100%, 980px); + height: min(860px, calc(100vh - clamp(24px, 6vw, 72px))); + min-height: 620px; + border-color: var(--line-strong); + border-radius: 18px; + box-shadow: 0 24px 70px rgba(27, 29, 24, 0.16); +} + +.dashboard-runtime .titlebar { + padding-inline: 22px; + -webkit-app-region: no-drag; +} + +.dashboard-runtime .view { + padding: 26px clamp(24px, 5vw, 58px) 40px; +} + +.dashboard-runtime .lead { + max-width: 620px; +} + +.dashboard-runtime .provider-card-grid { + grid-template-columns: repeat(auto-fit, minmax(250px, 1fr)); +} + +.dashboard-runtime .nav { + min-height: 68px; + padding-inline: clamp(24px, 8vw, 110px); +} + +@media (max-width: 680px) { + .dashboard-runtime body { + display: block; + padding: 0; + } + + .dashboard-runtime .shell { + width: 100%; + height: 100dvh; + min-height: 540px; + border: 0; + border-radius: 0; + box-shadow: none; + } + + .dashboard-runtime .titlebar { + padding-inline: 16px 10px; + } + + .dashboard-runtime .view { + padding: 20px 18px 28px; + } + + .dashboard-runtime .nav { + padding-inline: 8px; + } +} + @media (max-width: 360px) { .provider-card-grid { grid-template-columns: 1fr; diff --git a/src/renderer/web-api.js b/src/renderer/web-api.js new file mode 100644 index 0000000..23c3463 --- /dev/null +++ b/src/renderer/web-api.js @@ -0,0 +1,84 @@ +(function () { + "use strict"; + + if (window.rerouted) return; + + const listeners = new Map(); + let events = null; + + function emit(channel, payload) { + for (const listener of listeners.get(channel) || []) { + try { + listener(payload); + } catch { + // A dashboard event listener must not stop the transport. + } + } + } + + function ensureEvents() { + if (events || typeof EventSource !== "function") return; + events = new EventSource("api/events"); + for (const channel of [ + "app:update-state", + "app:session-lock-changed", + "app:provider-identities-updated", + "app:request-activity", + "app:open-settings", + ]) { + events.addEventListener(channel, (event) => { + try { + emit(channel, JSON.parse(event.data)); + } catch { + // Ignore malformed or stale server events. + } + }); + } + } + + async function invoke(channel, ...args) { + const oauthWindow = channel === "app:oauth-start" + ? window.open("about:blank", "_blank") + : null; + const response = await fetch("api/invoke", { + method: "POST", + credentials: "same-origin", + headers: { "Content-Type": "application/json" }, + body: JSON.stringify({ channel, args }), + }); + let result; + try { + result = await response.json(); + } catch { + result = { ok: false, error: `Dashboard request failed (HTTP ${response.status})` }; + } + if (!response.ok && !result?.error) { + result = { ok: false, error: `Dashboard request failed (HTTP ${response.status})` }; + } + if (channel === "app:oauth-start" && result?.ok && result.authUrl) { + if (oauthWindow) { + oauthWindow.opener = null; + oauthWindow.location.replace(result.authUrl); + } else { + window.open(result.authUrl, "_blank", "noopener,noreferrer"); + } + } else if (oauthWindow) { + oauthWindow.close(); + } else if (channel === "app:open-external" && result?.ok && args[0]) { + window.open(String(args[0]), "_blank", "noopener,noreferrer"); + } + return result; + } + + window.rerouted = { + invoke, + on(channel, callback) { + if (!listeners.has(channel)) listeners.set(channel, new Set()); + listeners.get(channel).add(callback); + ensureEvents(); + return () => listeners.get(channel)?.delete(callback); + }, + }; + + document.documentElement.classList.add("dashboard-runtime"); +})(); diff --git a/tests/cli.test.js b/tests/cli.test.js new file mode 100644 index 0000000..f7e158a --- /dev/null +++ b/tests/cli.test.js @@ -0,0 +1,145 @@ +"use strict"; + +const assert = require("node:assert/strict"); +const fs = require("node:fs"); +const os = require("node:os"); +const path = require("node:path"); +const { describe, it } = require("node:test"); +const { parseArgs, pathsFor, run } = require("../src/cli"); +const { + createHeadlessRuntime, + createProcessLock, + defaultUserData, +} = require("../src/lib/headless-runtime"); +const { runFirstSetup } = require("../src/cli/setup"); +const { verifyPassword } = require("../src/lib/password"); + +function memoryOutput() { + let value = ""; + return { + isTTY: false, + write(chunk) { + value += chunk; + return true; + }, + value: () => value, + }; +} + +describe("ReRouted CLI", () => { + it("parses start options and validates network boundaries", () => { + assert.deepEqual(parseArgs(["--host", "localhost", "--port", "5050", "--no-interactive"]), { + command: "start", + host: "127.0.0.1", + port: 5050, + dataDir: null, + interactive: false, + }); + assert.throws(() => parseArgs(["--host", "192.168.1.5"]), /--host must be/); + assert.throws(() => parseArgs(["--port", "70000"]), /--port must be/); + assert.throws(() => parseArgs(["--port"]), /requires a number/); + assert.throws(() => parseArgs(["--data-dir"]), /requires a path/); + assert.throws(() => parseArgs(["--wat"]), /Unknown option/); + }); + + it("uses the XDG config directory on Linux and exposes stable data paths", () => { + const data = defaultUserData({ + platform: "linux", + env: { XDG_CONFIG_HOME: "/tmp/xdg" }, + homedir: "/home/dev", + }); + assert.equal(data, "/tmp/xdg/rerouted"); + assert.deepEqual(pathsFor(data), { + data, + config: "/tmp/xdg/rerouted/config.json", + usage: "/tmp/xdg/rerouted/usage.sqlite", + logs: "/tmp/xdg/rerouted/rerouted.log", + }); + }); + + it("runs the real gateway and dashboard in non-interactive mode", async () => { + const root = fs.mkdtempSync(path.join(os.tmpdir(), "rerouted-cli-")); + const output = memoryOutput(); + const error = memoryOutput(); + try { + const code = await run( + ["--data-dir", root, "--host", "127.0.0.1", "--port", "0", "--no-interactive"], + { + input: { isTTY: false }, + output, + error, + waitForSignal: false, + } + ); + assert.equal(code, 0, error.value()); + assert.match(output.value(), /Gateway\s+http:\/\/127\.0\.0\.1:\d+\/v1/); + assert.match(output.value(), /Dashboard http:\/\/127\.0\.0\.1:\d+\/dashboard\//); + assert.match(output.value(), /First-time setup is waiting/); + assert.equal(fs.existsSync(path.join(root, "config.json")), true); + assert.equal(fs.existsSync(path.join(root, "rerouted.pid")), false); + } finally { + fs.rmSync(root, { recursive: true, force: true }); + } + }); + + it("completes first-run terminal setup without requiring a provider", async () => { + const root = fs.mkdtempSync(path.join(os.tmpdir(), "rerouted-setup-")); + const runtime = createHeadlessRuntime({ userData: root, version: "test" }); + const output = memoryOutput(); + const secrets = ["terminal-password", "terminal-password"]; + const confirmations = [false, false, false]; + const prompts = { + secret: async () => secrets.shift(), + confirm: async () => confirmations.shift(), + text: async () => "", + select: async () => 0, + multiSelect: async () => [], + }; + try { + const completed = await runFirstSetup({ + prompts, + controlPlane: runtime.controlPlane, + dashboardUrl: "http://127.0.0.1:4949/dashboard/", + output, + }); + assert.equal(completed, true); + const cfg = runtime.store.load(); + assert.equal(cfg.onboardingComplete, true); + assert.equal(cfg.onboardingStep, "done"); + assert.equal(await verifyPassword("terminal-password", cfg.adminPasswordHash), true); + assert.match(output.value(), /Setup complete/); + assert.match(output.value(), /No provider models are available yet/); + } finally { + await runtime.close(); + fs.rmSync(root, { recursive: true, force: true }); + } + }); +}); + +describe("headless process lock", () => { + it("rejects a live duplicate and cleans up the owning lock", () => { + const root = fs.mkdtempSync(path.join(os.tmpdir(), "rerouted-lock-")); + try { + const first = createProcessLock(root); + assert.throws(() => createProcessLock(root), (error) => error.code === "ALREADY_RUNNING"); + first.release(); + const second = createProcessLock(root); + second.release(); + assert.equal(fs.existsSync(path.join(root, "rerouted.pid")), false); + } finally { + fs.rmSync(root, { recursive: true, force: true }); + } + }); + + it("replaces a stale PID lock", () => { + const root = fs.mkdtempSync(path.join(os.tmpdir(), "rerouted-lock-")); + try { + fs.writeFileSync(path.join(root, "rerouted.pid"), "999999999\n", { mode: 0o600 }); + const lock = createProcessLock(root); + assert.equal(Number(fs.readFileSync(lock.path, "utf8").trim()), process.pid); + lock.release(); + } finally { + fs.rmSync(root, { recursive: true, force: true }); + } + }); +}); diff --git a/tests/control-plane.test.js b/tests/control-plane.test.js new file mode 100644 index 0000000..56c03aa --- /dev/null +++ b/tests/control-plane.test.js @@ -0,0 +1,94 @@ +"use strict"; + +const assert = require("node:assert/strict"); +const fs = require("node:fs"); +const os = require("node:os"); +const path = require("node:path"); +const { afterEach, describe, it } = require("node:test"); +const { createHeadlessRuntime } = require("../src/lib/headless-runtime"); + +const cleanups = []; +afterEach(async () => { + while (cleanups.length) await cleanups.pop()(); +}); + +function tempRuntime() { + const root = fs.mkdtempSync(path.join(os.tmpdir(), "rerouted-control-")); + const runtime = createHeadlessRuntime({ userData: root, version: "9.8.7" }); + cleanups.push(async () => { + await runtime.close(); + fs.rmSync(root, { recursive: true, force: true }); + }); + return runtime; +} + +describe("shared control plane", () => { + it("covers every production renderer invoke channel", () => { + const runtime = tempRuntime(); + const source = fs.readFileSync(path.join(__dirname, "..", "src", "preload.js"), "utf8"); + const invokeBlock = source.slice( + source.indexOf("const INVOKE_CHANNELS"), + source.indexOf("const EVENT_CHANNELS") + ); + const preloadChannels = [...invokeBlock.matchAll(/"(app:[^"]+)"/g)].map((match) => match[1]); + const available = new Set(runtime.controlPlane.channels()); + const missing = [...new Set(preloadChannels)].filter((channel) => !available.has(channel)); + assert.deepEqual(missing, []); + }); + + it("returns headless runtime state and protects sensitive actions per session", async () => { + const runtime = tempRuntime(); + const session = runtime.sessionAuth; + const invoke = (channel, ...args) => + runtime.controlPlane.invoke(channel, args, { sessionAuth: session }); + + const initial = await invoke("app:get-state"); + assert.equal(initial.runtime, "headless"); + assert.equal(initial.platform, process.platform); + assert.equal(initial.appVersion, "9.8.7"); + assert.equal(initial.update.status, "unsupported"); + assert.match(initial.update.error, /package manager/i); + + assert.deepEqual(await invoke("app:set-admin-password", "correct horse"), { ok: true }); + assert.deepEqual(await invoke("app:complete-onboarding"), { ok: true }); + + const otherSession = require("../src/lib/session-auth").createSessionAuth({ platform: "linux" }); + const blocked = await runtime.controlPlane.invoke("app:create-api-key", ["blocked"], { + sessionAuth: otherSession, + }); + assert.equal(blocked.code, "rerouted_locked"); + + const locked = await runtime.controlPlane.invoke("app:get-state", [], { + sessionAuth: otherSession, + }); + assert.equal(locked.unlocked, false); + assert.equal(locked.apiKeys, undefined); + + assert.deepEqual( + await runtime.controlPlane.invoke("app:verify-admin-password", ["wrong"], { + sessionAuth: otherSession, + }), + { ok: false } + ); + assert.deepEqual( + await runtime.controlPlane.invoke("app:verify-admin-password", ["correct horse"], { + sessionAuth: otherSession, + }), + { ok: true } + ); + const unlocked = await runtime.controlPlane.invoke("app:get-state", [], { + sessionAuth: otherSession, + }); + assert.equal(unlocked.unlocked, true); + assert.equal(unlocked.apiKeys.length, 1); + }); + + it("returns a stable error for actions outside the shared contract", async () => { + const runtime = tempRuntime(); + assert.deepEqual(await runtime.controlPlane.invoke("app:not-real"), { + ok: false, + code: "unsupported_action", + error: "Unsupported ReRouted action.", + }); + }); +}); diff --git a/tests/dashboard.test.js b/tests/dashboard.test.js new file mode 100644 index 0000000..4862eb4 --- /dev/null +++ b/tests/dashboard.test.js @@ -0,0 +1,189 @@ +"use strict"; + +const assert = require("node:assert/strict"); +const fs = require("node:fs"); +const os = require("node:os"); +const path = require("node:path"); +const { afterEach, describe, it } = require("node:test"); +const { createHeadlessRuntime } = require("../src/lib/headless-runtime"); +const { isLoopback, requestOriginMatches, SESSION_COOKIE } = require("../src/lib/dashboard"); + +const cleanups = []; +afterEach(async () => { + while (cleanups.length) await cleanups.pop()(); +}); + +async function runningRuntime() { + const root = fs.mkdtempSync(path.join(os.tmpdir(), "rerouted-dashboard-")); + const runtime = createHeadlessRuntime({ userData: root, version: "9.8.7" }); + const address = await runtime.start({ port: 0, host: "127.0.0.1" }); + cleanups.push(async () => { + await runtime.close(); + fs.rmSync(root, { recursive: true, force: true }); + }); + return { runtime, address, base: `http://127.0.0.1:${address.port}` }; +} + +function cookieFrom(response) { + return String(response.headers.get("set-cookie") || "").split(";")[0]; +} + +async function browser(base) { + const loaded = await fetch(`${base}/dashboard/`); + return { + loaded, + cookie: cookieFrom(loaded), + invoke(channel, args = [], { origin = base } = {}) { + return fetch(`${base}/dashboard/api/invoke`, { + method: "POST", + headers: { + "Content-Type": "application/json", + Cookie: this.cookie, + Origin: origin, + }, + body: JSON.stringify({ channel, args }), + }); + }, + }; +} + +describe("headless dashboard", () => { + it("serves the real renderer and keeps the gateway health path unchanged", async () => { + const { base } = await runningRuntime(); + const redirect = await fetch(`${base}/dashboard`, { redirect: "manual" }); + assert.equal(redirect.status, 308); + assert.equal(redirect.headers.get("location"), "/dashboard/"); + + const client = await browser(base); + assert.equal(client.loaded.status, 200); + assert.match(client.cookie, new RegExp(`^${SESSION_COOKIE}=`)); + assert.match(client.loaded.headers.get("content-security-policy"), /frame-ancestors 'none'/); + const html = await client.loaded.text(); + assert.match(html, /web-api\.js/); + assert.match(html, /app\.js/); + assert.ok(html.indexOf("web-api.js") < html.indexOf("app.js")); + + const css = await fetch(`${base}/dashboard/styles.css`); + assert.equal(css.status, 200); + assert.match(await css.text(), /dashboard-runtime/); + + const health = await fetch(`${base}/health`).then((response) => response.json()); + assert.equal(health.ok, true); + assert.equal(health.port, Number(new URL(base).port)); + }); + + it("uses isolated browser sessions and redacts state until password sign-in", async () => { + const { runtime, base } = await runningRuntime(); + await runtime.controlPlane.invoke("app:set-admin-password", ["dashboard-pass"], { harness: true }); + await runtime.controlPlane.invoke("app:complete-onboarding", [], { harness: true }); + + const first = await browser(base); + const second = await browser(base); + assert.notEqual(first.cookie, second.cookie); + + let response = await first.invoke("app:get-state"); + assert.equal(response.status, 200); + let state = await response.json(); + assert.equal(state.unlocked, false); + assert.equal(state.apiKeys, undefined); + + response = await first.invoke("app:verify-admin-password", ["dashboard-pass"]); + assert.deepEqual(await response.json(), { ok: true }); + state = await (await first.invoke("app:get-state")).json(); + assert.equal(state.unlocked, true); + assert.equal(state.apiKeys.length, 1); + + state = await (await second.invoke("app:get-state")).json(); + assert.equal(state.unlocked, false); + assert.equal(state.apiKeys, undefined); + }); + + it("rejects cross-origin mutations and throttles repeated password attempts", async () => { + const { runtime, base } = await runningRuntime(); + await runtime.controlPlane.invoke("app:set-admin-password", ["dashboard-pass"], { harness: true }); + await runtime.controlPlane.invoke("app:complete-onboarding", [], { harness: true }); + const client = await browser(base); + + const crossOrigin = await client.invoke("app:get-state", [], { origin: "https://attacker.invalid" }); + assert.equal(crossOrigin.status, 403); + + for (let attempt = 0; attempt < 6; attempt += 1) { + const response = await client.invoke("app:verify-admin-password", ["wrong"]); + assert.equal(response.status, 200); + assert.deepEqual(await response.json(), { ok: false }); + } + const limited = await client.invoke("app:verify-admin-password", ["dashboard-pass"]); + assert.equal(limited.status, 429); + assert.match((await limited.json()).error, /too many/i); + }); + + it("serves only allowlisted dashboard assets", async () => { + const { base } = await runningRuntime(); + const missing = await fetch(`${base}/dashboard/package.json`); + assert.equal(missing.status, 404); + assert.equal(missing.headers.get("set-cookie"), null); + const asset = await fetch(`${base}/dashboard/assets/providers/chatgpt.svg`); + assert.equal(asset.status, 200); + assert.equal(asset.headers.get("set-cookie"), null); + }); + + it("invalidates other browser sessions when the admin password changes", async () => { + const { runtime, base } = await runningRuntime(); + await runtime.controlPlane.invoke("app:set-admin-password", ["first-password"], { harness: true }); + await runtime.controlPlane.invoke("app:complete-onboarding", [], { harness: true }); + const first = await browser(base); + const second = await browser(base); + assert.deepEqual(await (await first.invoke("app:verify-admin-password", ["first-password"])).json(), { ok: true }); + assert.deepEqual(await (await second.invoke("app:verify-admin-password", ["first-password"])).json(), { ok: true }); + + const changed = await first.invoke("app:change-admin-password", [ + { current: "first-password", next: "second-password" }, + ]); + assert.deepEqual(await changed.json(), { ok: true }); + const firstState = await (await first.invoke("app:get-state")).json(); + assert.equal(firstState.unlocked, true); + const secondState = await (await second.invoke("app:get-state")).json(); + assert.equal(secondState.unlocked, false); + assert.equal(secondState.apiKeys, undefined); + }); + + it("requires a dashboard password when an imported config claims onboarding is complete", async () => { + const { runtime, base } = await runningRuntime(); + runtime.store.update((cfg) => { + cfg.onboardingComplete = true; + cfg.onboardingStep = "done"; + cfg.adminPasswordHash = null; + }); + const client = await browser(base); + const recoveryState = await (await client.invoke("app:get-state")).json(); + assert.equal(recoveryState.onboardingComplete, false); + assert.equal(recoveryState.onboardingStep, "admin-password"); + assert.equal(recoveryState.apiKeys, undefined); + const blocked = await client.invoke("app:create-api-key", ["unsafe"]); + assert.equal(blocked.status, 403); + assert.match((await blocked.json()).error, /admin password/i); + const password = await client.invoke("app:set-admin-password", ["new-dashboard-password"]); + assert.deepEqual(await password.json(), { ok: true }); + }); +}); + +describe("dashboard request boundaries", () => { + it("recognizes loopback addresses only", () => { + for (const remoteAddress of ["127.0.0.1", "::1", "::ffff:127.0.0.1"]) { + assert.equal(isLoopback({ socket: { remoteAddress } }), true); + } + assert.equal(isLoopback({ socket: { remoteAddress: "192.168.1.20" } }), false); + }); + + it("requires exact same-origin host and port", () => { + assert.equal( + requestOriginMatches({ headers: { origin: "http://127.0.0.1:4949", host: "127.0.0.1:4949" } }), + true + ); + assert.equal( + requestOriginMatches({ headers: { origin: "http://127.0.0.1:4950", host: "127.0.0.1:4949" } }), + false + ); + assert.equal(requestOriginMatches({ headers: { host: "127.0.0.1:4949" } }), false); + }); +}); diff --git a/tests/gateway.test.js b/tests/gateway.test.js index 9bf0431..7a2311b 100644 --- a/tests/gateway.test.js +++ b/tests/gateway.test.js @@ -48,6 +48,12 @@ describe("password + api key", () => { const k = generateApiKey(); assert.match(k, /^rr-[a-f0-9]{32}$/); }); + + it("rejects malformed scrypt hashes without allocating attacker-sized keys", async () => { + assert.equal(await verifyPassword("password", "scrypt$00$ff"), false); + assert.equal(await verifyPassword("password", `scrypt$${"00".repeat(16)}$${"ff".repeat(65)}`), false); + assert.equal(await verifyPassword("password", "scrypt$not-hex$also-not-hex"), false); + }); }); describe("store atomic write + mode", () => { diff --git a/tests/release-artifacts.test.js b/tests/release-artifacts.test.js index b7efba8..5483cb4 100644 --- a/tests/release-artifacts.test.js +++ b/tests/release-artifacts.test.js @@ -6,6 +6,7 @@ const fs = require("node:fs"); const path = require("node:path"); const { updateZipName, isRecognizedMacUpdateZip } = require("../scripts/release-artifacts"); +const { linuxCliArtifactNames } = require("../scripts/package-linux-cli"); test("names updater ZIPs for the macOS Apple Silicon release feed", () => { const name = updateZipName("ReRouted", "0.3.1", "arm64"); @@ -30,3 +31,11 @@ test("declares MIT and includes its notice in packaged release copies", () => { assert.match(packager, /path\.join\(ROOT, "LICENSE"\)/); assert.match(packager, /path\.join\(stage, "LICENSE\.txt"\)/); }); + +test("names the versioned and stable Linux CLI release tarballs", () => { + assert.deepEqual(linuxCliArtifactNames("1.2.3"), { + versioned: "ReRouted-1.2.3-linux-node.tgz", + latest: "ReRouted-linux-node.tgz", + }); + assert.throws(() => linuxCliArtifactNames("latest"), /semantic package version/i); +});