Skip to content

docs: record what a stored value authenticates, and tell reviewers what is not a finding - #1258

Merged
coderdan merged 1 commit into
nextfrom
docs/integrity-model-review-guidance
Oct 19, 2026
Merged

coderdan merged 1 commit into
nextfrom
docs/integrity-model-review-guidance

Conversation

@coderdan

Copy link
Copy Markdown
Contributor

Summary

Agent reviews of Stack Encrypt have flagged the same thing four or five times: a stored container's entries and order are not authenticated. It's deliberate. Stored values are database rows and columns, which come back in any order and in part. Nothing a reviewer reads said so, which is why it kept coming back. This PR records the decision for Stack Encrypt and puts it in the files each review bot reads.

Changes

  • packages/stack-encrypt/docs/adr/0010-what-a-stored-value-authenticates.md: applies vitaminc's ADR 0002 to what Stack Encrypt stores.
    • Authenticated: each leaf's bytes and type tag, its context (with extensions and any context field), its map key or sequence role, and the wire version.
    • Not authenticated: a container's membership, order and length; a passthrough field, except a plan's context field; and which row a leaf belongs to, unless the context names the row.
    • Consequences: Aead is for a leaf that doesn't open, and OpenedType is for a refused type or shape. Stricter authentication will be opt-in through named types.
  • AGENTS.md: a new "Review guidelines" section listing these as known non-findings, with the rule kept narrow: a leaf not bound to its context, key, role, type or version is still a defect. Codex reads AGENTS.md, and CLAUDE.md imports it, so Claude Code's /code-review (cipherstash-agent) reads it too.
  • .github/copilot-instructions.md (new): the same list for Copilot code review.

Verification

  • Docs only.
  • The scripts suite (vitest run --config scripts/vitest.config.mjs) passed 76 of 77 files. The one failure, check-auth-npm-changeset, is environmental: @changesets/parse is missing from the node_modules I borrowed, and it fails the same way without this change.

Related

Review notes

…at is not a finding

Agent reviews have flagged, four or five times, that a stored container's
membership and order are not authenticated. That is deliberate (vitaminc
ADR 0002): stored values are rows and columns, read in any order and in
part. stack-encrypt ADR 0010 applies it to what Stack Encrypt stores: each
leaf is bound to its context, key, role, type and version; a container's
membership and order, a passthrough field (except a context field), and
which row a leaf belongs to are not.

AGENTS.md gains "Review guidelines" with these as known non-findings
(Codex reads it; CLAUDE.md imports it for Claude Code's /code-review), and
.github/copilot-instructions.md repeats them for Copilot.
@changeset-bot

changeset-bot Bot commented Oct 18, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 7ab2614

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Oct 18, 2026 •

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 7fe5a22d-f377-40de-84c5-d76a1b35912d

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@coderdan
coderdan marked this pull request as ready for review October 19, 2026 06:13
@coderdan
coderdan requested a review from a team as a code owner October 19, 2026 06:13
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ⚠️ Failed 2026-10-19T06:15:01.948063Z 7ab2614 Draft marked ready
🔒 Security Review ✅ Completed 2026-10-19T06:20:55.246049Z 7ab2614 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderdan
coderdan merged commit 7c1a0ab into next Oct 19, 2026
31 checks passed
@coderdan
coderdan deleted the docs/integrity-model-review-guidance branch October 19, 2026 06:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants