Skip to content

Document that BilateralReceipt.extensions is unsigned and untrusted #2

@willamhou

Description

@willamhou

Context

BilateralReceipt.extensions (crates/signet-core/src/receipt.rs:71) is explicitly excluded from the signature scope. The code has a comment // unsigned, outside sig scope, but this is not documented in docs/SECURITY.md or the README.

Users who store metadata in extensions may incorrectly assume it is tamper-proof.

What needs to change

  1. docs/SECURITY.md — Add a row to the "What gets signed" section noting that extensions is outside the signature scope
  2. receipt.rs — Expand the doc comment on the extensions field to explicitly say "UNTRUSTED: not covered by signature"
  3. README — If extensions are mentioned anywhere, add a trust caveat

Acceptance criteria

  • SECURITY.md explicitly lists extensions as unsigned
  • Rust doc comment on the field is clear about trust implications
  • No code changes needed, documentation only

Difficulty

Great first issue. Documentation only, no code changes.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions