8000 docs(spec): move BEP-047 (split-user VM) to spec 24's non-goals by norrietaylor · Pull Request #2768 · gominimal/minimal · GitHub
[go: up one dir, main page]

Skip to content

docs(spec): move BEP-047 (split-user VM) to spec 24's non-goals - #2768

Merged
norrietaylor merged 3 commits into
mainfrom
docs/spec24-defer-bep047
Oct 31, 2026
Merged

norrietaylor merged 3 commits into
mainfrom
docs/spec24-defer-bep047

Conversation

@norrietaylor
@norrietaylor norrietaylor commented Oct 31, 2026 •
Copy link
Copy Markdown
Member

Part of #1501, close-out.

The owner deferred slice S8 (#2256) on 2026-10-31. The split-user work is a hardening step that no user story of #1501 depends on. Its last two tasks are stuck: #2566 stopped because no task builds the minvmd __egw process the design needs, and #2285 waits on it.

Change

Spec 24

  • BEP-047 leaves the Requirements and becomes a Non-goals line that links the follow-on epic gominimal/inbox#1184 and the design docs/design/2026-10-25-split-user-vmm-provider-dir.md. The line also states what holds today: the proxy, gvproxy and the VM run as the login user.
  • Design reasoning no longer claims gvproxy and the VM run as a dedicated user.
  • The key-custody invariant's covered by drops BEP-047.
  • The same invariant's enforced by now names the keychain access control bound to the proxy's code signature first, then process separation. Every process runs as the login user, so process separation no longer guards against a compromised VMM on its own. A note under the invariant says so, links gominimal/inbox#1184, and says that custody on a real macOS keychain is unproven while #2436 is open. This answers the minimal-review finding on that line.
  • updated: is 2026-10-31.

Code comments

The split-user pieces that already landed (T65: the minimal-vmm user, the file and socket modes, the guest door admitting that uid) cite BEP-047 in their comments, an ID the spec no longer defines. Each citation now reads "formerly BEP-047, gominimal/inbox#1184" in crates/minimal/src/cmd/finalize_install.rs and in crates/minvmd/src/ (sock.rs, control.rs, volume.rs, cmd/vmm_child.rs, cmd/run.rs, guest_telemetry.rs). Comments only: no code, test name or behaviour changes.

Checks

  • 8000 spec-lint (gominimal/foundry fb5932b, the CI linter): 7 findings, down from 8 on main. All are P004 on requirement lines this PR does not touch: the linter does not find e2e cases named in verify: because scripts/session-e2e.sh defines them as proof_<name>. The finding this PR removes is BEP-047's.
  • just lint-prose on the changed lines: the prose lines (Non-goals, Design reasoning, updated:) have 0 alerts. The invariant's enforced by and covered by lines keep ste.SentenceLength warnings: Vale reads the field lines as one run-on sentence, which every invariant in the file shares. The file keeps its other existing alerts, per AGENTS.md.
  • just fix and just clippy (macOS scope): clean, and just fix changed nothing beyond this PR's edits. finalize_install.rs is outside the macOS scope. Its change is to comments only, so CI's Linux lanes cover it.

The plan amendment that drops T66 and T38 from S8 follows on the epic once this merges.

Summary by CodeRabbit

  • Documentation
    • Updated the egress proxy specification and clarified that the proxy, gvproxy, and VM currently run as the operator.
    • Clarified that running these processes separately does not provide isolation through separate operating-system users; separate-user operation is deferred.
    • Updated related documentation to reflect the current status of the separate-user work and the security assumptions around process separation.

The owner deferred S8 on 2026-10-31 so epic #1501 can close on its user
stories. Running gvproxy and the VM as dedicated users, with the egress
gate in its own process, moves to gominimal/inbox#1184 with the split-user
design. The Design reasoning and the key-custody invariant no longer cite
BEP-047.
@norrietaylor
norrietaylor requested a review from a team as a code owner October 31, 2026 03:54
@coderabbitai
coderabbitai Bot commented Oct 31, 2026 •
Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Essentials
  • Run ID: 25588828-0e7a-47dc-872b-13b231676476
Commits

Reviewing files that changed from the base of the PR and between 3a62a86 and 6c9ade6.

Files selected for processing: 8
  • crates/minimal/src/cmd/finalize_install.rs
  • crates/minvmd/src/cmd/run.rs
  • crates/minvmd/src/cmd/vmm_child.rs
  • crates/minvmd/src/control.rs
  • crates/minvmd/src/guest_telemetry.rs
  • crates/minvmd/src/sock.rs
  • crates/minvmd/src/volume.rs
  • docs/specs/24-spec-box-egress-proxy/24-spec-box-egress-proxy.md

Included review availability: This review used your included allowance. Your plan provides up to 5 included reviews per hour; 0 remain after this review.

Walkthrough

The specification removes BEP-047 and states that separate users for gvproxy and the VM are deferred. Related code comments now identify BEP-047 as former work. No executable behavior or test expectations changed.

Changes: Egress proxy specification and references

Layer / File(s) Summary
Split-user scope and security statements
docs/specs/24-spec-box-egress-proxy/24-spec-box-egress-proxy.md
The specification removes BEP-047, identifies the separate-user arrangement as deferred, and updates related design and security statements. The update date changes to 2026-10-31.
Code comment reference updates
crates/minimal/src/cmd/finalize_install.rs, crates/minvmd/src/cmd/run.rs, crates/minvmd/src/cmd/vmm_child.rs, crates/minvmd/src/control.rs, crates/minvmd/src/guest_telemetry.rs, crates/minvmd/src/sock.rs, crates/minvmd/src/volume.rs
Comments mark BEP-047 as former work and add references to the follow-on issue. Implementation and test expectations are unchanged.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Possibly related issues

Suggested reviewers: mitodrummer

Merge Risk: Minimal · up to 6c9ad

This PR updates specification scope and references without changing runtime behavior, so no current-head merge-blocking risk is established.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title follows the Conventional Commit form docs(spec): ... and names the main change: BEP-047 (split-user VM) moves from spec 24's Requirements to its Non-goals. It is specific, lower-case, has …
Description check Passed The description covers the substance of the change. It gives the summary and the reason for the change, links related issues (#1501, #2256, #2566, #2285, inbox#1184, #2436), and explains the spec and …
Docstring Coverage Passed Docstring coverage is 87.50% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentati…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title follows the Conventional Commit form docs(spec): ... and names the main change: BEP-047 (split-user VM) moves from spec 24's Requirements to its Non-goals. It is specific, lower-case, has no trailing period, and matches the raw summary and PR objectives. The code comment edits in the changeset are secondary and do not need to appear in the title.

Full details: Description check

Explanation

The description covers the substance of the change. It gives the summary and the reason for the change, links related issues (#1501, #2256, #2566, #2285, inbox#1184, #2436), and explains the spec and code-comment edits. The Testing section is not a separate heading, but the author reports spec-lint, lint-prose, just fix, and just clippy results with counts. The Checklist is missing. The author does not mark 'Docs updated if behavior changed' or the 'BREAKING CHANGE:' footer, and the PR does not clearly state whether a breaking change applies. The template's headings are also not used exactly: the description uses '## Change' and '## Checks' in place of '## Summary' and '## Testing', and it has no '## Checklist'. The description is mostly complete, so the check passes, but the author should add the Checklist and confirm the breaking-change status.

Resolution

Optional: rename or map the '## Change' and '## Checks' sections to the template's '## Summary' and '## Testing' headings, and add the '## Checklist' section with the 'Docs updated' item marked and an explicit statement on the 'BREAKING CHANGE:' footer.

Full details: Docstring Coverage

Explanation

Docstring coverage is 87.50% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 8 functions across 7 files. (1 skipped: 1 unsupported.)

Finishing Touches
Generate docstrings
  • Commit to this branch
  • Create a new PR
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

Some tools did not complete. Review the errors below.

Vale (3.24.0)

{
"Line": 13,
"Path": ".vale.ini",
"Text": "Style 'ste' isn't on the StylesPath (/styles). If it's a package, run vale sync.",
"Code": "E201",
"Span": 23
}

A rabbit reads the spec at dawn
BEP-047’s old wording is gone
The user split waits for its turn
While comments mark what’s past to learn
Then hops away beneath the moon

@github-actions
Copy link
Copy Markdown
Contributor

Spec lint

docs/specs/24-spec-box-egress-proxy/24-spec-box-egress-proxy.md — 7 finding(s)

docs/specs/24-spec-box-egress-proxy/24-spec-box-egress-proxy.md:113: P004 BEP-003 names test 'bep_second_box_needs_no_sign_in', which was not found in the repository
docs/specs/24-spec-box-egress-proxy/24-spec-box-egress-proxy.md:170: P004 BEP-007 names test 'bep_box_env_holds_sealed_value_only', which was not found in the repository
docs/specs/24-spec-box-egress-proxy/24-spec-box-egress-proxy.md:214: P004 BEP-011 names test 'bep_root_ca_present_in_box_trust_store', which was not found in the repository
docs/specs/24-spec-box-egress-proxy/24-spec-box-egress-proxy.md:230: P004 BEP-012 names test 'bep_proxy_env_and_no_proxy_are_set', which was not found in the repository
docs/specs/24-spec-box-egress-proxy/24-spec-box-egress-proxy.md:284: P004 BEP-015 names test 'bep_git_and_gh_against_private_repo', which was not found in the repository
docs/specs/24-spec-box-egress-proxy/24-spec-box-egress-proxy.md:638: P004 BEP-043 names test 'bep_destroyed_box_values_refused_within_60s', which was not found in the repository
docs/specs/24-spec-box-egress-proxy/24-spec-box-egress-proxy.md:647: P004 BEP-044 names test 'bep_logout_refuses_every_reference_at_next_request', which was not found in the repository

Advisory. None of this blocks the merge; the review decides.

Advisory, and never a merge gate. Linter: gominimal/foundry@fb5932b8, spec format: How Minimal Writes Specs.

@minimal-foundry
minimal-foundry Bot commented Oct 31, 2026 •
Copy link
Copy Markdown
Contributor

Approved: no findings at 6c9ade603bd1.

Nothing to do.

Clobber: none seen.

@minimal-foundry minimal-foundry Bot left a comment
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minimal-review — advisory review

Verdict COMMENT — 1 finding, 1 inline.

Panel: 3 of 3 personas ran (correctness, security, supply-chain).

@minimal-foundry minimal-foundry Bot left a comment
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minimal-review — approved

Verdict APPROVE — No findings.

Panel: 3 of 3 personas ran (correctness, security, supply-chain).

@minimal-foundry minimal-foundry Bot added the review:approved minimal-review approved the current head label Oct 31, 2026
@norrietaylor
norrietaylor added this pull request to the merge queue Oct 31, 2026
Merged via the queue into main with commit 53cd4be Oct 31, 2026
36 checks passed
@norrietaylor
norrietaylor deleted the docs/spec24-defer-bep047 branch October 31, 2026 06:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review:approved minimal-review approved the current head

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

0