sirius/onionwire
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases 3 Packages Wiki Activity Actions 4
onionwire/docs/README.md
Sirius DevOps 22b3a0062a
Some checks are pending
ci / test (pull_request) Waiting to run
Details
docs: add PROTOCOL.md and retire the stale audit writeup 
Wire format lives in docs/PROTOCOL.md so the handshake, invite, and
frames can be read without the Rust. Threat model points at it. The
in-house audit notes are a finding-status table, not a third-party
audit. SDK README no longer claims the legacy concat invite signature
is what we encode.
2026-09-11 13:15:51 -04:00

674 B
Raw Blame History

OnionWire docs

Read these in order if you are evaluating the protocol without the Rust:

  1. PROTOCOL.md — wire format, handshake, invite, frames. This is the document a second implementation would use.
  2. THREAT_MODEL.md — what v1 claims, and what it refuses to claim.
  3. SECURITY_AUDIT.md — in-house review notes and which findings are still open. Not a public third-party audit.

Operator / product docs stay in the root README. Android build notes: android/README.md. SDK: crates/onionwire-sdk/README.md.