reticiulum-specification/tools
Rob 0c2021e757 Correct §2.1 flag byte: bit 7 is IFAC, not part of header_type
Reverts the wrong normative claim added in 8c4d550. The official
manual §4.6.3 documents byte 1 as ifac_flag(7) | header_type(6) |
context_flag(5) | propagation_type(4) | dest_type(3-2) | packet_type(1-0).
Upstream confirms:

- RNS/Packet.py:246 — `(self.flags & 0b01000000) >> 6` parses
  header_type as a 1-bit field at position 6.
- RNS/Transport.py:1003 — `bytes([raw[0] | 0x80, raw[1]])` sets the
  IFAC flag at bit 7 in Transport.transmit when ifac_identity is
  attached.

The reporter on issue #4 was correct: bit 7 has always been the IFAC
indicator. The 8c4d550 paragraph telling implementations "MUST NOT
treat bit 7 as a separate flag" is removed and replaced with the
correct layout, the upstream parse masks, and the IFAC sealing snippet
showing where the bit gets set on the wire.

A spec-correction callout in §2.1 documents the prior-version mistake
so anyone who consumed the bad guidance can identify the breakage.

verify_packet_header.py gains verify_ifac_bit_position() which locks
in the bit-7-is-IFAC invariant against future regression: it asserts
header_type's parse mask covers bit 6 only, never bit 7, and that the
IFAC mask 0x80 is disjoint from the header_type mask. The existing
flag-layout cases were always correct (header_type << 6 puts it at
bit 6); only the docstring described the wrong layout.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-06 21:36:23 -04:00
..
_gen_toc.py SPEC.md: collapsible ToC + collapse §11.6 NomadNet specifics 2026-05-04 22:05:17 -04:00
README.md Bootstrap test-vectors/{announces,lxmf,links}.json + regenerators 2026-05-04 21:56:44 -04:00
regen_announces.py Bootstrap test-vectors/{announces,lxmf,links}.json + regenerators 2026-05-04 21:56:44 -04:00
regen_identities.py Verify §2.3, §4.3, §7.1, §7.4 against upstream RNS 1.2.0 / LXMF 0.9.6 2026-05-03 10:14:51 -04:00
regen_links.py Bootstrap test-vectors/{announces,lxmf,links}.json + regenerators 2026-05-04 21:56:44 -04:00
regen_lxmf.py Bootstrap test-vectors/{announces,lxmf,links}.json + regenerators 2026-05-04 21:56:44 -04:00
verify_announce_app_data.py Verify §2.3, §4.3, §7.1, §7.4 against upstream RNS 1.2.0 / LXMF 0.9.6 2026-05-03 10:14:51 -04:00
verify_announce_roundtrip.py Add three high-value verifiers: token crypto, announce, LXMF opportunistic 2026-05-03 12:41:20 -04:00
verify_destination_hash.py Fix and expand §1.3 — on-disk identity format (real spec bug!) 2026-05-03 11:54:54 -04:00
verify_link_handshake.py Add four more verifiers + receive-propagated flow + frontmatter version 2026-05-03 12:54:34 -04:00
verify_lxmf_opportunistic.py Add three high-value verifiers: token crypto, announce, LXMF opportunistic 2026-05-03 12:41:20 -04:00
verify_msgpack_quirk.py Add four more verifiers + receive-propagated flow + frontmatter version 2026-05-03 12:54:34 -04:00
verify_packet_header.py Correct §2.1 flag byte: bit 7 is IFAC, not part of header_type 2026-05-06 21:36:23 -04:00
verify_path_request.py Verify §2.3, §4.3, §7.1, §7.4 against upstream RNS 1.2.0 / LXMF 0.9.6 2026-05-03 10:14:51 -04:00
verify_proof_packet.py Add four more verifiers + receive-propagated flow + frontmatter version 2026-05-03 12:54:34 -04:00
verify_ratchet_dedup.py Resolve issue #1 — five §7.2/§7.3 gaps from clean-room JS implementation 2026-05-03 20:38:01 -04:00
verify_rnode_split.py Add four more verifiers + receive-propagated flow + frontmatter version 2026-05-03 12:54:34 -04:00
verify_stamps.py Add tools/verify_stamps.py — runtime-lock §5.7 2026-05-03 15:13:59 -04:00
verify_token_crypto.py Add three high-value verifiers: token crypto, announce, LXMF opportunistic 2026-05-03 12:41:20 -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

Populated against RNS 1.2.0 / LXMF 0.9.6:

Script Verifies SPEC.md section Status
verify_destination_hash.py §1.1, §1.2, §1.3 — identity composition, dest_hash = SHA256(name_hash || identity_hash)[:16], on-disk private-key round-trip via to_file/from_file
verify_packet_header.py §2.1, §2.2, §2.3 — flag byte layout, HEADER_1/HEADER_2 form, originator HEADER_1→HEADER_2 conversion via upstream Transport.outbound
verify_token_crypto.py §3 — Token encrypt/decrypt, HKDF salt = identity_hash, HMAC-then-AES order, PKCS#7 padding
verify_announce_app_data.py §4.3 — LXMF announce app_data 2-element form, parser tolerance
verify_announce_roundtrip.py §4.1, §4.2, §4.5 — announce body layout, signature, dest_hash recompute, tamper rejection
verify_lxmf_opportunistic.py §5.1, §5.2, §5.5, §5.6 — full identity → encrypt → decrypt → parse round-trip
verify_proof_packet.py §6.5 — implicit (64B) and explicit (96B) proof body forms, validator length-dispatch
verify_link_handshake.py §6.1, §6.2, §6.3, §6.6 — LINKREQUEST/LRPROOF body order, link_id derivation, signalling
verify_path_request.py §1.2 well-known hashes, §7.1 LXMF path-preamble gating
verify_rnode_split.py §8.3 — RNode air-frame split-packet TX/RX state machines
verify_msgpack_quirk.py §9.3 — encoding name as bytes vs str affects upstream parsing
verify_stamps.py §5.7 — workblock determinism, PoW stamp search/validate, ticket shortcut
verify_ratchet_dedup.py §7.3 / §4.5 step 6.3 — confirms replay defence is keyed on random_blob, NOT on (dest_hash, ratchet_pub)
regen_identities.py regenerates test-vectors/identities.json
regen_announces.py regenerates test-vectors/announces.json (deterministic announce wire bytes, with and without ratchet)
regen_lxmf.py regenerates test-vectors/lxmf.json (deterministic opportunistic-LXMF plaintext + Token ciphertext)
regen_links.py regenerates test-vectors/links.json (deterministic LINKREQUEST + LRPROOF + derived session key)

See ../agent.md §5 and ../todo.md for the remaining priority order.