vrr/codeburn
2
0
Fork 0
mirror of https://github.com/AgentSeal/codeburn.git synced 2026-10-21 05:23:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Add security email and OSS Scanner build files (#1770)

Browse source
This commit is contained in:
Resham Joshi 2026-10-20 18:02:22 +02:00 • committed by GitHub
parent 0322472db3
commit b8eead8442
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 140 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

29
.oss-scanner/Dockerfile Normal file
View file

@ -0,0 +1,29 @@
# Build image for Anthropic's OSS Scanner: installs every dependency and builds CodeBurn so an offline agent can read,
# build and test it. The Swift menubar app (mac/) and the Rust half of the Windows app (windows/src-tauri) do not build
# on Linux; their source is still in /src.
FROM node:22-bookworm
ENV CI=1 \
ELECTRON_SKIP_BINARY_DOWNLOAD=1 \
npm_config_audit=false \
npm_config_fund=false
COPY --chown=node:node . /src
WORKDIR /src
# Tests that simulate an unwritable file only behave as a normal user, so build and test as `node`.
USER node
# CLI and web dashboard (npm run build also builds dash/)
RUN npm ci && npm run build
# Desktop app: Electron main process and renderer
RUN cd app && npm ci && npm run build
# VS Code extension: host, webview and the staged CLI
RUN cd vscode && npm ci && npm run build
# Windows app: web UI only
RUN cd windows && npm ci && npm run build
RUN npm test -- --maxWorkers=4 || echo "WARNING: CLI tests reported failures"
RUN (cd app && npm test) || echo "WARNING: desktop tests reported failures"
RUN (cd vscode && npm test) || echo "WARNING: VS Code extension tests reported failures"
USER root

105
.oss-scanner/threat_model.md Normal file
View file

@ -0,0 +1,105 @@
# CodeBurn threat model
## What CodeBurn is
CodeBurn shows what AI coding tools cost. It runs on developers' own machines as:
- a CLI (`src/`);
- a desktop app (`app/`);
- a macOS menubar app (`mac/`);
- a Windows app (`windows/`);
- a VS Code extension (`vscode/`);
- a GNOME extension (`gnome/`).
It reads the session logs that tools such as Claude Code, Codex, Cursor and Copilot leave on disk, prices them, and shows the result. Everything is computed on the user's machine, and this repository has no hosted backend.
That makes it a valuable target for three reasons:
- it runs on thousands of developer machines;
- it reads AI provider sign-in tokens to show plan quotas;
- it updates itself.
## Where untrusted input enters
Treat all of these as attacker-controlled:
- **Session logs and tool databases** (`src/providers/`, `src/parser.ts`, `src/sqlite.ts`, `src/parse-worker*.ts`). Other tools write these files, but the content includes whatever the agent read: web pages, files from cloned repositories, tool output, MCP responses. A crafted line in a log is the most realistic attack path.
- **The local network** (`src/sharing/`). Sharing listens on all interfaces over TLS, announces itself with Bonjour, and pairs devices with a code and certificate pinning. Anyone on the same network can reach it.
- **Web pages in the user's browser** that reach the loopback servers:
- the web dashboard (`src/web-dashboard.ts`);
- the sync sign-in callback (`src/sync/auth.ts`).
- **Network responses**:
- provider quota APIs (`src/quota/`, `app/electron/quota/`, `mac/`);
- pricing and model data;
- release metadata and downloads used by the updaters.
- **Workspaces opened in VS Code** (`vscode/`), which may be untrusted repositories.
- **Plugins** (`src/plugins/`): manifests and signatures from the plugins directory.
## What matters most
1. **Provider credentials.** `src/quota/` and the desktop and menubar quota code read OAuth tokens and API keys (the macOS Keychain, files such as `~/.codex/auth.json`) and call each provider's own API. A token must never reach:
- another host;
- a log or a cache;
- telemetry or a shared report;
- another local user.
2. **Code execution.** Any path from the inputs above to running a command, loading code, writing an executable or hook, or running script in a webview. Look in particular at:
- the desktop app's IPC bridge (`app/electron/preload.ts`, `app/electron/bridge-handlers.ts`);
- the webviews in `app/` and `vscode/`;
- child processes the apps spawn (`app/electron/`, `vscode/`, `windows/src-tauri/`);
- hooks written by `src/guard/`;
- file changes made by `src/act/` (`codeburn optimize --apply`).
3. **Update and release integrity.** Anything that lets someone ship code to users. That covers:
- `src/update.ts` and `src/menubar-installer.ts`;
- `app/electron/auto-update.ts` and `app/electron/companion-update.ts`;
- `windows/src-tauri/src/update.rs`;
- the workflows in `.github/workflows/` that sign and publish releases.
4. **Sharing and sync.**
- In `src/sharing/`: pairing, peer authentication, and what a paired or unpaired device can read.
- In `src/sync/`: the OIDC flow, stored credentials, and the OTLP export.
5. **Privacy.** Prompts, file paths, and project and repository names must not leave the machine unless the user turned that feature on. Telemetry (`src/telemetry-snapshot.ts`, `app/electron/telemetry.ts`, `windows/src-tauri/src/telemetry.rs`), sharing and sync are all meant to be opt-in.
Lower priority but still in scope:
- the terminal UI (`src/*.tsx`);
- the GNOME extension;
- the MCP server (`src/mcp/`, stdio only);
- `src/serve.ts` (stdio, used by the desktop app).
## How to exercise it
- **What the image builds:**
- the CLI (`dist/`) and the dashboard (`dash/dist/`);
- the desktop app's main process and renderer (`app/`);
- the VS Code extension (`vscode/`);
- the Windows web UI.
- **Tests:** `npm test` at the repository root runs the CLI suite, and `tests/fixtures/` holds sample session logs for many providers. `app/` and `vscode/` each have their own `npm test`.
- **Run the tests as the `node` user** (`su node -c "npm test"`). As root, a few tests that simulate an unwritable file fail, because root can write anyway.
- **Manual runs:** run the CLI against a fake home, for example `HOME=/tmp/fake node dist/cli.js report`, after placing crafted logs where a provider looks for them. Each file in `src/providers/` defines its paths.
- **Source only:** `mac/` (Swift) and `windows/src-tauri/` (Rust) do not build on Linux; review their source.
## Severity
- **Critical:**
- code execution on a user's machine, or theft of provider credentials, from input the attacker controls without local access. Examples: a log line the agent wrote after reading a web page or a repository, a device on the network, a server response;
- shipping code to users through the update or release path.
- **High:**
- the same outcomes when they need an unusual setting or a user click;
- credentials written to disk, logs or caches that other users or apps can read;
- arbitrary file write;
- an unpaired device reading shared data.
- **Medium:**
- private data (prompts, paths, project names) leaving the machine beyond what the user turned on;
- a crafted input that breaks the app on every launch.
- **Low:**
- one-off crashes or hangs on malformed input;
- hardening gaps with no demonstrated impact.
## Leave alone
- Wrong costs, token counts or prices. Those are bugs; please open an issue.
- Attacks that need code already running as the same user, since that user can read the same files directly.
- Vulnerabilities in dependencies, unless CodeBurn uses the dependency unsafely.
- `docs/`, `perf/`, `assets/`, `scripts/perf/` and other developer-only tooling, unless it runs in CI with access to secrets.
## Reports
- One report per root cause, listing every affected path.
- Say what the attacker controls, and include a minimal proof of concept. A crafted log file or request is ideal.
- Keep patches small and in the existing style (TypeScript, Vitest), with a test that fails before the fix. No new dependencies.

8
SECURITY.md
View file

@ -2,7 +2,7 @@
## Reporting a Vulnerability
Please report security vulnerabilities via [GitHub's private vulnerability reporting](https://github.com/getagentseal/codeburn/security/advisories/new).
Please report security vulnerabilities via [GitHub's private vulnerability reporting](https://github.com/getagentseal/codeburn/security/advisories/new) or by email to security@codeburn.app.
Do not open a public issue for security vulnerabilities.
@ -13,7 +13,11 @@ Security reports are welcome for:
- The CLI (`src/`)
- The menubar installer (`src/menubar-installer.ts`)
- The macOS menubar app (`mac/`)
- The desktop app (`desktop/`)
- The desktop app (`app/`)
- The Windows app (`windows/`)
- The VS Code extension (`vscode/`)
- The GNOME extension (`gnome/`)
- The web dashboard (`dash/`)
- CI/CD workflows (`.github/workflows/`)
## Release Integrity