Files
Derek Carr 5952a5a23f feat(workspace): add workspace resource model with scoping, membershi… (#2243)
* feat(workspace): implement workspace model (Phase 1 of RFC 0011)

Implements workspace and membership model providing hard isolation
boundaries for multi-player OpenShell deployments.

Workspace CRUD with Kubernetes-style Terminating phase for graceful
deletion. All resources scoped by workspace via ObjectMeta. Membership
RPCs for workspace access control. Persistence migration shifts name
uniqueness to (object_type, workspace, name). Provider profiles support
platform and workspace scoping. Service routing uses workspace-prefixed
DNS labels. Inference routes renamed and workspace-scoped with
DeleteInferenceRoute RPC. Python SDK with WorkspaceClient, two-method
list pattern (workspace-scoped and for_all_workspaces), and workspace
parameter on all methods. CLI workspace flags, TUI workspace cycling.
K8s driver filters unmanaged CRs and uses delete preconditions. Podman
driver uses immutable container IDs. Label serialization fixed across
all put_if call sites.

Signed-off-by: Derek Carr <decarr@redhat.com>

* fix(cli): delegate sandbox upload command to existing upload function

The standalone `sandbox upload` command reimplemented upload logic
inline with two bugs: it used `Path::exists()` which follows symlinks
(rejecting dangling symlinks), and it ran git-aware filtering on
symlink sources. The `run::sandbox_upload()` function already handles
both cases correctly via `sandbox_upload_plan()`. Replace the inline
logic with a call to the existing function.

Signed-off-by: Derek Carr <decarr@redhat.com>

* fix(e2e): shorten sandbox names and fix test compatibility

Shorten the sandbox name in initial_sparse_policy_is_acknowledged_as_loaded
from 'e2e-2159-sparse-enrich' (22 chars) to 'e2e-sparse-enrich' (17 chars)
to comply with MAX_ROUTABLE_NAME_LEN (19 chars).

Also capture stderr in create_keep_with_args so future sandbox creation
failures include the actual CLI error instead of reporting empty output.

Signed-off-by: Derek Carr <decarr@redhat.com>

* test(workspace): add test coverage for workspace CRUD and persistence isolation

Add unit tests for workspace create happy path, get round-trip, get
not-found, get empty-name rejection, already-exists error, and
resolve_workspace not-found. Add persistence test proving cross-workspace
name uniqueness (same name in different workspaces produces separate
records). Add workspace name max-length boundary tests. Fix e2e harness
to include stderr in name-parse-failure error path. Align Python e2e
test_workspace_crud with try/finally pattern. Document provider profile
catalog workspace scoping gap in RFC 0011.

Signed-off-by: Derek Carr <decarr@redhat.com>

* fix(examples): update examples for workspace model compatibility

Shorten sandbox names in demo scripts to fit the 19-character
MAX_ROUTABLE_NAME_LEN limit: policy-demo prefix to pd-, multi-agent
notepad derives a short SANDBOX_TAG from the run ID, governance
interceptor uses gs-PID-RANDOM. Update vscode-remote-sandbox.md SSH
host aliases from openshell-{name} to openshell-{name}.{workspace}
format.

Signed-off-by: Derek Carr <decarr@redhat.com>

* feat(sdk): add workspace-scoped client and workspace CRUD

Add WorkspaceScopedClient modeled after kube::Api::namespaced — captures
workspace once and injects it into every sandbox request. Add workspace
CRUD methods (create, get, list, delete) and list_sandboxes_all_workspaces
on OpenShellClient. Extend SandboxRef with workspace field and add
WorkspaceRef type. Include mock tests for all new operations.

Signed-off-by: Derek Carr <decarr@redhat.com>

* fix(lint): resolve clippy warnings in workspace test assertions

Signed-off-by: Derek Carr <decarr@redhat.com>

* fix(docs): convert indented code blocks to fenced in RFC 0011

Signed-off-by: Derek Carr <decarr@redhat.com>

* fix(lint): resolve clippy warnings and apply cargo fmt across workspace

Auto-format with cargo fmt and fix clippy warnings exposed by the
reformat: unnecessary qualifications, map_unwrap_or, identical match
arms, unused variable prefix, dead code annotations, and let-unit-value
in e2e harness.

Signed-off-by: Derek Carr <decarr@redhat.com>

* fix(workspace): address workspace scoping issues from review

- Add workspace field to settings JSON output (CLI)
- Skip Podman containers missing workspace label instead of defaulting
  to empty string, matching K8s driver behavior
- Add resource_version to list_by_scope SELECT in both SQLite and
  Postgres backends, with regression test
- Gate PolicyLocalContext proposal/lookup routes on workspace readiness,
  returning 503 when workspace is not yet discovered
- Block sandbox and provider creation in TUI all-workspaces mode
- Clear workspace vectors in TUI reset_sandbox_state

Signed-off-by: Derek Carr <decarr@redhat.com>

* fix(workspace): make provider profile catalog workspace-aware

Thread workspace through snapshot_catalog so the
EffectiveProviderProfileCatalog enforces workspace boundaries on both
read and write paths. UserProviderProfileSource now loads platform-scoped
profiles (workspace "") plus the target workspace's profiles, preventing
cross-workspace duplicate profile ID collisions that previously caused
global catalog failures.

Update RFC 0011 to reflect catalog scoping is implemented in Phase 1
rather than deferred to future work.

Signed-off-by: Derek Carr <decarr@redhat.com>

* fix(persistence): include workspace column in atomic policy revision INSERT

put_policy_revision_atomic omitted the workspace column from the INSERT
into the objects table in both SQLite and Postgres backends, causing
atomically-written policy revisions to lose their workspace association.
Add workspace field to AtomicPolicyRevisionWrite and thread it through
both backend INSERT statements, matching the non-atomic put_policy_revision
path which already included it.

Signed-off-by: Derek Carr <decarr@redhat.com>

* fix(proxy): skip ancestor walk when socket owner is the entrypoint

collect_ancestor_identities walked the entire process tree above the
entrypoint when the connecting process was the entrypoint itself,
SHA256-hashing every ancestor binary (IDE, shell, container runtime).
On dev machines with large binaries in the ancestor chain this exceeded
the 30-second test timeout. When start_pid == stop_pid there are no
intermediate ancestors to verify, so return an empty list immediately.

Signed-off-by: Derek Carr <decarr@redhat.com>

* fix(workspace): make provider profile catalog scope-aware

Allow the same profile ID at platform and workspace scopes by
introducing layered catalog entries where workspace profiles shadow
platform profiles. Add source and scope fields to the ProviderProfile
proto and CLI output. Migrate List/Get handlers to the catalog,
fixing divergence with runtime profile resolution.

Signed-off-by: Derek Carr <decarr@redhat.com>

* fix(e2e): align podman e2e labels with centralized driver constants

The podman driver moved its container labels to the centralized
openshell.ai/ prefix, but the e2e test harness and cleanup script
still referenced the old openshell.sandbox-* keys, causing the
local_driver_token_restart test to fail on container lookup.

Signed-off-by: Derek Carr <decarr@redhat.com>

* fix(e2e): align python profile isolation test with scope-aware catalog

Platform profiles are now visible in workspace listings as fallbacks
per the layered catalog design. Update the assertion to match.

Signed-off-by: Derek Carr <decarr@redhat.com>

* fix(workspace): honor profile_workspace in runtime profile resolution

Runtime profile lookups now consult provider.profile_workspace via
get_type_profile_for_scope. Providers created with --global-profile
(profile_workspace="") resolve to the platform profile even when a
workspace profile shadows the same ID. All 6 runtime call sites
updated; type-only call sites remain scope-agnostic.

Signed-off-by: Derek Carr <decarr@redhat.com>

---------

Signed-off-by: Derek Carr <decarr@redhat.com>
2026-07-21 00:59:18 +00:00
..

Agent-Driven Policy Management Demo

Run the full agent-driven policy loop end-to-end:

  1. A Codex agent inside an OpenShell sandbox tries to write a markdown file to GitHub via the Contents API.
  2. OpenShell denies the request with a structured policy_denied 403 because the initial policy only allows read-only access to api.github.com.
  3. The agent reads /etc/openshell/skills/policy_advisor.md, drafts the narrowest rule needed, and submits it to http://policy.local/v1/proposals. It saves the returned chunk_id.
  4. The gateway merges the proposed rule with the current sandbox policy, runs the policy prover, and stores a concise validation_result on the pending chunk. This is deterministic control-plane evidence, not agent prose.
  5. The agent calls GET /v1/proposals/{chunk_id}/wait?timeout=300 — a single HTTP request that the supervisor holds open until the developer decides. This is the load-bearing UX point: the agent burns zero LLM tokens while it waits; it's literally sleeping on a socket.
  6. You approve the proposal from the host with one keystroke after seeing the exact rule and the prover verdict in openshell rule get.
  7. The agent's /wait returns within ~1 second of the approval. The sandbox has hot-reloaded the merged policy; the agent retries the original PUT once and exits.

The whole loop usually finishes in under two minutes; most of that time is sandbox cold-start (SSH bring-up + Codex install inside the sandbox), not the policy round-trip itself.

Prerequisites

  • An active OpenShell gateway (openshell gateway start).

  • gh auth login (or a GITHUB_TOKEN env var with contents-write on a scratch repo).

  • codex login on the host.

  • A scratch GitHub repository with at least one commit on the default branch. If you don't have one yet:

    gh repo create "$(gh api user --jq .login)/openshell-policy-demo" \
        --private --add-readme \
        --description "OpenShell policy advisor demo scratch repo"
    

Run it

bash examples/agent-driven-policy-management/demo.sh

That's the whole thing. The demo resolves your GitHub handle from gh, picks openshell-policy-demo as the repo, and writes one timestamped markdown file under openshell-policy-advisor-demo/ per run.

Driving it manually (real-session UX)

DEMO_MANUAL_APPROVE=1 bash examples/agent-driven-policy-management/demo.sh

Same flow, but the script no longer auto-approves. When the agent submits a proposal, the demo prints the exact approve and reject --reason commands and pauses until you run one from another terminal. This is how you'd review a coding agent's privilege ask in a real session — read the structured grant, decide, type one command, watch the agent's /wait unblock within ~1s.

Try a rejection-with-guidance to see the full revise-and-resubmit loop: reject with --reason "scope to docs/ paths only" and the agent reads rejection_reason, drafts a tighter proposal, and pauses again.

Overrides (all optional)

Env var Default
DEMO_GITHUB_OWNER gh api user --jq .login
DEMO_GITHUB_REPO openshell-policy-demo
DEMO_BRANCH main
DEMO_RUN_ID timestamp
DEMO_GITHUB_TOKEN falls back to GITHUB_TOKEN, GH_TOKEN, or gh auth token
DEMO_KEEP_SANDBOX 0 (set 1 to inspect the sandbox after the demo)
DEMO_MANUAL_APPROVE 0 (set 1 to pause for host-side rule approve / rule reject --reason)
DEMO_APPROVAL_TIMEOUT_SECS 240 (auto), 1800 (manual mode)
DEMO_CODEX_MODEL gpt-5.4-mini (pinned for ChatGPT-account compatibility; override if your account supports a different model)
DEMO_CODEX_REASONING low (the demo task is mechanical; medium/high slow it down without changing outcomes)
OPENSHELL_BIN target/debug/openshell if present, else openshell on PATH

What the agent sees

policy.template.yaml is the initial restrictive policy: a read-only L7 REST rule for api.github.com plus the binary set Codex needs. The agent has to ask for the additional PUT /repos/.../contents/... write itself — that's the proposal you approve.

What gets approved (trust model)

Every proposal lands in the gateway as a PolicyChunk — a structured object with three parts, each with a different trust level:

Field Source Trust
proposed_rule (host, port, method, path, binary) agent, schema-validated by the gateway structured contract — this is what you're approving
rationale (free-form prose) agent hint only — a compromised agent can lie here
validation_result (prover output) gateway-side prover trust signal — but this surface is in progress (see RFC 0002)

The MVP today shows the structured rule plus the agent's rationale in openshell rule get and the TUI inbox panel. With prover validation wired into the gateway, openshell rule get also shows a Validation: line for agent-authored chunks. The value is the prover's verdict in OCSF-shorthand style — one short, scannable string per chunk:

Validation: prover: no new findings
Validation: prover: 1 new finding
              capability_expansion: PUT on api.github.com:443 via /usr/bin/curl

Other possible verdicts: validation unavailable (gateway-side prover infra issue — surfaces in the gateway log, not as proposal failure), merge failed: … (proposal won't merge into the current policy), and policy invalid: … (merged policy fails the structural safety check).

Read the structured rule (Endpoints + Binary). Read the Validation line. Approve if both look right. The demo's openshell rule approve-all auto-approves to keep the loop short; in a real session a developer makes that judgment per chunk before pressing a.

Going further

Two LLM-less regression scripts cover adjacent slices of the same surface when you're iterating on the sandbox or gateway code:

  • e2e/policy-advisor/test.sh — drives the original deny-observe-approve loop end-to-end against a real GitHub repo, using curl from inside the sandbox in a retry loop until policy hot-reloads. Exercises the L7 proxy enforcement, the proposal-submit path, and the merged-policy reload.
  • e2e/policy-advisor/wait-smoke.sh — pure wire-contract regression for the GET /v1/proposals/{id}/wait endpoint shipped here. No LLM, no GitHub, no real network traffic; just submits a synthetic proposal, blocks on /wait, and asserts the developer's approve or reject --reason text round-trips back into the response body. Faster (~10s) and the right thing to add to when changing policy.local or the gateway draft-chunk persistence.