Skip to content
Python

docs: security-first README (use cases + governed-by-design) and SECURITY.md

Rohit C Prasad5c799b03633a
diff --git a/README.md b/README.md
index 72547b42..27d16f0d 100644
--- a/README.md
+++ b/README.md
@@ -6,9 +6,9 @@
> **Beta** - OpenWorker is in open beta: fully usable, updates itself, and we're actively polishing rough edges. [Issues](https://github.com/andrewyng/openworker/issues) welcome.
-**AI that gets your everyday tasks done.** OpenWorker is an open-source AI coworker that lives on your desktop and delivers **finished work**, not just chat: a polished document, a Slack reply with the numbers, an updated calendar, a triaged inbox.
+**AI that gets your everyday tasks done.** OpenWorker is an open-source AI coworker that lives on your desktop and delivers **finished work**, not just chat: your code reviewed for vulnerabilities with fixes ready to go, a polished document, a Slack reply with the numbers, a triaged inbox. It ships **specialist Security coworkers** first — attackers already use AI, and defenders deserve the same leverage, governed.
-It runs on your machine and doesn't lock you into any model: bring your own API key for OpenAI, Anthropic, Google, or an open-weight provider, or run fully local with Ollama. Your data leaves your machine only through the model and integrations *you* choose.
+It runs on your machine and doesn't lock you into any model: bring your own API key for OpenAI, Anthropic, Google, or an open-weight provider, or run fully local with Ollama. Your data leaves your machine only through the model and integrations *you* choose. Every action an agent takes is governed and logged — see [Governed by design](#governed-by-design).
[![How OpenWorker works](docs/assets/how-it-works.png)](https://openworker.com)
@@ -22,6 +22,18 @@ It runs on your machine and doesn't lock you into any model: bring your own API
Open the app, add a model key (or point it at Ollama), and ask for something real.
+## Use cases
+
+Pick a coworker, point it at real work, get a finished deliverable:
+
+- **Security review** - scan a codebase and its dependencies for real risk. Findings come from deterministic scanners (like semgrep) plus model reasoning; proposed fixes are re-scanned and diff-reviewed before you approve them - the fixer is never the only checker.
+- **Cloud posture** - audit cloud configuration against common misconfiguration classes and draft the remediation plan.
+- **Incident triage** - work a security or ops incident: gather context across your tools, draft the timeline, prepare the report.
+- **Everyday work** - prep a customer call from your CRM and inbox, turn scattered notes into a shippable plan, produce documents and spreadsheets, keep your calendar and Slack threads handled.
+- **Standing automations** - a morning brief, a weekly report, a watch over a channel - on a schedule, with full transcripts.
+
+Specialist coworkers arrive with the tools, working style, and check-ins for one job already set up. Security coworkers ship first.
+
## How it works
1. Tell OpenWorker the outcome you want - "prepare a customer brief," "untangle my calendar," "draft a report," "check where the release stands across Jira and GitHub."
@@ -42,13 +54,23 @@ Under the hood:
└───────────────┴────────────────┴───────────────┘
```
+## Governed by design
+
+Governance is the architecture, not a plugin - the agent can't grant itself new permissions, and no prompt can talk it past a gate. Three tiers, all in this repo:
+
+1. **Hard floors.** A set of dangerous and irreversible operations is human-only, always. No mode - including full auto-approve - lowers these floors; they always escalate to you.
+2. **A ladder of earned autonomy.** Actions are approval-gated by default. One-off approvals can graduate into standing rules, then into config allowlists - each step explicit, visible, and revocable. In auto-approve mode a reviewer model lets routine actions through and escalates anything it isn't sure about to you; repeated denials trip a circuit breaker that pauses the reviewer and hands control back. Reviewer verdicts are judgments, not guarantees - the floors and the audit trail are what backstop them.
+3. **An audit trail that answers "who did this, and why?"** Every tool call is recorded with its approval provenance - auto-approved, user-approved, or denied, with the reviewer's reasoning attached - and persisted with the conversation.
+
+Unattended runs never self-approve: their asks park in an inbox until a human answers. Found a vulnerability? See [SECURITY.md](SECURITY.md).
+
## What it can do
- **Produce real deliverables** - documents, spreadsheets, reports, and web pages land as files you can open and share.
- **Work from Slack** - mention `@OpenWorker` in a channel; a session opens on your desktop, the work happens with your tools, and the answer comes back as a thread reply.
- **Use your everyday tools** - 25+ integrations including GitHub, Slack, Jira, Notion, Linear, HubSpot, Outlook, monday.com, Gmail, and Google Calendar, plus your **terminal and local files**. Any tool reachable over [MCP](https://modelcontextprotocol.io/) plugs in too, with per-tool control.
- **Run on a schedule** - automations for recurring work: a morning brief, a weekly report, a standing watch over a channel. Runs land in the app with full transcripts.
-- **Ask before acting** - writes, sends, and shell commands are approval-gated. Unattended runs park their asks in an inbox instead of acting on their own.
+- **Ask before acting** - writes, sends, and shell commands are approval-gated, with an optional auto-approve mode that still escalates anything uncertain - see [Governed by design](#governed-by-design).
## Bring your own model
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 00000000..2fd18e83
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,36 @@
+# Security Policy
+
+OpenWorker is a security-positioned project; we hold ourselves to the standard we
+pitch. If you find a vulnerability, we want to hear about it.
+
+## Reporting a vulnerability
+
+Email **[email protected]** with:
+
+- a description of the issue and its impact,
+- reproduction steps or a proof of concept,
+- the version you tested (app version from the About screen, or a commit hash).
+
+Please use email rather than a public issue so a fix can ship before details are
+public. We'll acknowledge your report within 3 business days, keep you updated as
+we work on it, and credit you in the release notes when the fix ships (unless you
+prefer otherwise). Please give us a reasonable window to fix before public
+disclosure.
+
+## Scope
+
+- The desktop app and local agent server in this repository - including the
+ permission gates, approval/reviewer flow, and audit trail. Bypasses of the
+ human-only floors or approval gates (e.g. via prompt injection or a malicious
+ MCP tool) are in scope and treated as high severity.
+- The OAuth broker service used for managed connectors.
+
+Out of scope: vulnerabilities in third-party model providers or connected
+services themselves, and issues requiring an already-compromised machine.
+
+## Supported versions
+
+The latest release only. The app auto-updates, so fixes reach installs quickly -
+this is also why we don't patch older versions.
+
+There is no bug bounty program at this time.