22b3a0062a
Some checks are pending
ci / test (pull_request) Waiting to run
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.
14 lines
674 B
Markdown
14 lines
674 B
Markdown
# OnionWire docs
|
|
|
|
Read these in order if you are evaluating the protocol without the Rust:
|
|
|
|
1. **[PROTOCOL.md](PROTOCOL.md)** — wire format, handshake, invite, frames.
|
|
This is the document a second implementation would use.
|
|
2. **[THREAT_MODEL.md](THREAT_MODEL.md)** — what v1 claims, and what it
|
|
refuses to claim.
|
|
3. **[SECURITY_AUDIT.md](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](../README.md). Android
|
|
build notes: [android/README.md](../android/README.md). SDK:
|
|
[crates/onionwire-sdk/README.md](../crates/onionwire-sdk/README.md).
|