15 lines
674 B
Markdown
15 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).
|