reticiulum-specification/tools
Rob cafb2889ab Initial bootstrap: README, LICENSE, SPEC.md, agent.md, scaffolding
Bootstrapped from the working notes of two reverse-engineering efforts:
- reticulum-lora-webclient (web/Capacitor)
- reticulum-mobile-app (Kotlin Multiplatform / Android)

SPEC.md consolidates byte-level wire format findings that aren't in the
upstream Reticulum manual. Each section grounded in upstream Python
source citations (file + line) where possible.

agent.md establishes the verification rules:
- Every claim is verified, unverified, or speculation; markers required
- Verification means a runnable script or a source citation
- PRs that quietly remove markers get rejected

tools/ and test-vectors/ are placeholder scaffolding with READMEs
describing the work needed.

Sections in SPEC.md flagged as currently UNVERIFIED:
- §2.3 Originator HEADER_1 -> HEADER_2 conversion
- §4.3 app_data 3-element variant with capabilities
- §7.1 path? always precedes LXMF (vs only on stale paths)
- §7.4 ratchet ring count default = 8

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-03 09:38:46 -04:00
..
README.md Initial bootstrap: README, LICENSE, SPEC.md, agent.md, scaffolding 2026-05-03 09:38:46 -04:00

Verifier scripts

Self-contained Python scripts that test claims in ../SPEC.md against the upstream RNS / LXMF Python stack.

Conventions

  • Each script verifies one claim or one related cluster of claims.
  • Exit code 0 on PASS, non-zero on FAIL.
  • Print a one-line PASS/FAIL summary plus a unified diff or hex dump on mismatch.
  • Reference the SPEC.md section the script verifies in a docstring at the top.

Required environment

pip install rns lxmf

The scripts read RNS.__version__ at startup and print it in their output so a future reader can tell which RNS version a verification ran against.

Status

Empty placeholder. See ../agent.md §5 for the priority order.

Initial scripts to write:

Script Verifies SPEC.md section
verify_destination_hash.py §1.2 — `dest_hash = SHA256(name_hash
verify_packet_header.py §2.1, §2.2 — flag byte layout + HEADER_1/HEADER_2 round-trip
verify_announce_roundtrip.py §4 — announce build matches upstream Identity().announce() bytes
verify_token_crypto.py §3 — Token encrypt/decrypt against upstream RNS.Cryptography.Token
verify_lxmf_opportunistic.py §5.1, §5.5 — opportunistic LXMF body bytes match upstream
verify_link_handshake.py §6 — LINKREQUEST + LRPROOF + session key match upstream
verify_path_request.py §7.1, §7.2 — path-request payload format
verify_msgpack_quirk.py §9.3 — encoding name as bytes vs str affects upstream parsing