| 1 | import type { DocsTrustDict } from "../types"; |
| 2 | |
| 3 | /** |
| 4 | * English reference dictionary for `app/[locale]/docs/trust/page.tsx`. |
| 5 | * Statements trace to docs/SANDBOX.md, docs/AUTHORIZATION_ORDER.md, |
| 6 | * docs/TELEMETRY.md, and the `trust` block of docs/public-surface-facts.json. |
| 7 | */ |
| 8 | export const docsTrust: DocsTrustDict = { |
| 9 | metaTitle: "Security & trust · Codewhale Docs", |
| 10 | metaDescription: |
| 11 | "What stays on your machine, what a hosted provider receives, how approvals and the OS sandbox differ, what telemetry sends and how to turn it off, and where to report a vulnerability.", |
| 12 | bodyClassName: "text-ink-soft leading-relaxed", |
| 13 | overviewTitle: "Security & trust", |
| 14 | overviewLead: |
| 15 | "This page says what Codewhale does with your code, your commands, and your data — as implemented, not as intended. Each claim is drawn from a repository document that the facts gate checks on every build.", |
| 16 | boundaryTitle: "Where your data goes", |
| 17 | boundaries: [ |
| 18 | ["Local runtime", "The runtime, workspace state, and audit log stay on your machine."], |
| 19 | ["Hosted provider", "The hosted provider you select receives the turn context required for inference. There is no mandatory Codewhale relay in between."], |
| 20 | ["Local inference", "A loopback local-model route (vLLM, Ollama, SGLang) can keep inference on your machine entirely."], |
| 21 | ["Account", "No account is required for the local runtime."], |
| 22 | ["Plan mode", "Plan is read-only."], |
| 23 | ], |
| 24 | approvalTitle: "Approvals are not a sandbox", |
| 25 | approvalLead: |
| 26 | "Approval posture — Ask, Auto-Review, Full Access — decides whether a proposed command is shown to you before it runs. An approval from one layer is never a universal bypass: a later layer can still require review or block the call, and an approval is not an operating-system sandbox grant. The full model tool-call pipeline is nine ordered layers, from effective configuration through hooks, typed permission rules, repository law, and human approval to the execution sandbox.", |
| 27 | sandboxTitle: "The OS sandbox, per platform", |
| 28 | sandboxLead: |
| 29 | "Only behaviour wired into the command execution path is described here, and Codewhale reports the mechanism it actually selected.", |
| 30 | sandboxes: [ |
| 31 | ["macOS — Seatbelt", "Automatic when the runtime probe of sandbox-exec succeeds. Reported as {seatbelt}."], |
| 32 | ["Linux — bubblewrap", "Opt-in: {preferBwrap} and an executable /usr/bin/bwrap. Reported as {bwrap}."], |
| 33 | ["Linux without bwrap", "No OS wrapper by default. Reported as {none}."], |
| 34 | ["Windows", "No OS wrapper in the current implementation. Reported as {none}."], |
| 35 | ["External service", "{opensandbox} routes execution to an OpenSandbox-compatible service."], |
| 36 | ], |
| 37 | sandboxNote: |
| 38 | "The repository also contains a seccomp module and a future Windows helper contract. Neither is wired into child-command launch, so Codewhale does not advertise them: source-only sandbox code is not evidence that a command was restricted.", |
| 39 | telemetryTitle: "Telemetry, exactly", |
| 40 | telemetryLead: |
| 41 | "Codewhale 0.9.13 counts anonymous usage by default and tells you so at first launch; the earlier 0.9.11 release asked first. Turning it off is a saved choice that later versions keep, and an opt-out recorded under the earlier opt-in policy stays off. Showing the notice never records any acceptance on your behalf; Codewhale and PostHog are named as the processors.", |
| 42 | telemetry: [ |
| 43 | ["Never collected", "Conversations, code, prompts, files, file/repo/branch names, model content, credentials, or any per-turn or per-tool timeline."], |
| 44 | ["Sent while on", "Version and platform classes, session duration and outcome, feature and error counters, closed enums, and a random install id that rotates every 90 days."], |
| 45 | ["Endpoint", "{endpoint} — a first-party Cloudflare Worker whose source is in the repository under telemetry-ingest/."], |
| 46 | ["First-party storage", "No IP, country, or geo column. No request logs. Retention is a fixed three months."], |
| 47 | ["PostHog", "Optional forwarding requires separate operator configuration and verified IP-safe egress. PostHog retention is a separate project setting; source support does not mean the processor is active."], |
| 48 | ["Audit it yourself", "Set {dryRun}: batches are appended to {dryRunFile} on your machine, byte for byte what the server would have received, and no HTTP client is constructed."], |
| 49 | ["Turn it off", "{configOff} or {envOff}."], |
| 50 | ], |
| 51 | auditTitle: "Local audit log", |
| 52 | auditLead: |
| 53 | "Sensitive events — credential, approval, and elevation events — append best-effort to {auditLog}. Write failures are logged rather than hidden. Provider token and cache usage is shown locally when available.", |
| 54 | reportTitle: "Report a vulnerability", |
| 55 | reportLead: |
| 56 | "Send security reports by email to the maintainer rather than filing a public issue. Include the version from the masthead and a reproduction if you have one.", |
| 57 | reportCta: "Email the maintainer", |
| 58 | sourceNote: |
| 59 | "Source documents: docs/SANDBOX.md, docs/AUTHORIZATION_ORDER.md, docs/TELEMETRY.md, docs/public-surface-facts.json · Update docs-map.ts when changing.", |
| 60 | }; |
| 61 |