sirius/onionwire
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases 3 Packages Wiki Activity Actions 4

docs: protocol spec and audit-notes cleanup #17

Open
sirius wants to merge 1 commit from docs/protocol into main
pull from: docs/protocol
merge into: sirius:main
Conversation 0 Commits 1 Files changed 7 +333 -188
sirius commented 2026-09-11 17:14:09 +00:00
Owner
Copy link

Summary

  • Add docs/PROTOCOL.md: handshake, framing, invite, loc/prf/inv/rcp/fil, and what v1 will not grow into. Readable without the Rust.
  • Add docs/README.md as the read order (protocol → threat model → audit notes).
  • Replace the stale SECURITY_AUDIT.md writeup of 2b42864 with a finding-status table. Explicitly not a third-party audit.
  • Point README / threat model / Android / SDK at the protocol. Fix the SDK invite-sig claim (encode is domain-separated; legacy concat is decode-only).

Test Plan

  • Docs-only; no code change. CI should be green.
  • Open docs/PROTOCOL.md and confirm it matches src/session.rs / src/frame.rs / src/qr.rs / src/dispatch.rs.
## Summary - Add `docs/PROTOCOL.md`: handshake, framing, invite, loc/prf/inv/rcp/fil, and what v1 will not grow into. Readable without the Rust. - Add `docs/README.md` as the read order (protocol → threat model → audit notes). - Replace the stale `SECURITY_AUDIT.md` writeup of `2b42864` with a finding-status table. Explicitly **not** a third-party audit. - Point README / threat model / Android / SDK at the protocol. Fix the SDK invite-sig claim (encode is domain-separated; legacy concat is decode-only). ## Test Plan - [ ] Docs-only; no code change. CI should be green. - [ ] Open `docs/PROTOCOL.md` and confirm it matches `src/session.rs` / `src/frame.rs` / `src/qr.rs` / `src/dispatch.rs`.
sirius added 1 commit 2026-09-11 17:14:09 +00:00
docs: add PROTOCOL.md and retire the stale audit writeup
Some checks are pending
ci / test (pull_request) Waiting to run
Details
22b3a0062a 
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.
Some checks are pending
ci / test (pull_request) Waiting to run
Details
This pull request can be merged automatically.
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin docs/protocol:docs/protocol
git checkout docs/protocol

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git checkout main
git merge --no-ff docs/protocol
git checkout docs/protocol
git rebase main
git checkout main
git merge --ff-only docs/protocol
git checkout docs/protocol
git rebase main
git checkout main
git merge --no-ff docs/protocol
git checkout main
git merge --squash docs/protocol
git checkout main
git merge --ff-only docs/protocol
git checkout main
git merge docs/protocol
git push origin main
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: sirius/onionwire#17
No description provided.
Delete branch "docs/protocol"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?