swaitsandClaude Opus 4.7
d785e35919
Set up the protocol spec as an mdBook and add a GitHub Actions workflow that builds it on every push/PR and deploys to GitHub Pages on main. The repo is now both a machine-readable corpus and a browsable, searchable site. Structure changes (one-time, mechanical): - Rename the spec source directory from `spec/` to `src/` to match mdBook's default convention. All 21 chapter files move; their internal relative cross-links are unchanged. - Add `src/SUMMARY.md` as the mdBook table of contents, grouping chapters under Wire Format, Payloads, Cryptography & Identity, and Routing & Higher-Layer Protocols. - Add `book.toml` at repo root: title, author, search enabled, fold enabled, edit-on-GitHub links, navy theme. - Add `.github/workflows/mdbook.yml`: build on push + PR, deploy on push to main only (configure-pages + upload-pages-artifact + deploy-pages from actions/). - Add `/book/` to .gitignore. Reference updates so the old path is fully retired: - Every `spec_ref` in `corpus/**/*.json` rewritten from `spec/` to `src/` (54 files). - Schema description text and example path in `corpus/schema/test-vector.schema.json`. - `README.md`: prominent link to the published site near the top; "What's Here" updated for the new layout. - `CONTRIBUTING.md`: spec-editing instructions point at `src/` and note the SUMMARY.md requirement. - `CLAUDE.md`: directory-layout notes updated. CHANGELOG.md historical entries intentionally keep their `spec/` paths since those record what the paths were at the time of those commits. After this lands, the user needs to enable GitHub Pages in repo settings with source = "GitHub Actions" (one-time, manual). The workflow will then publish to https://swaits.github.io/meshcore-spec/ on every push to main. Verified locally: `mdbook build` produces a clean book/ tree with all 21 chapters rendered and the SUMMARY-driven sidebar populated. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
66 lines
2.3 KiB
JSON
66 lines
2.3 KiB
JSON
{
|
|
"$schema": "../../schema/test-vector.schema.json",
|
|
"name": "Invalid - Truncated Packets",
|
|
"spec_ref": "src/01-wire-format.md",
|
|
"protocol_version": 0,
|
|
"description": "Tests packets that are truncated at various points, verifying that decoders reject them gracefully.",
|
|
"vectors": [
|
|
{
|
|
"id": "trunc-001",
|
|
"description": "Empty packet (0 bytes)",
|
|
"type": "invalid",
|
|
"binary": "",
|
|
"expected_error": "too_short",
|
|
"notes": "Zero-length input. Cannot read header."
|
|
},
|
|
{
|
|
"id": "trunc-002",
|
|
"description": "Header only (1 byte, FLOOD route)",
|
|
"type": "invalid",
|
|
"binary": "0D",
|
|
"expected_error": "too_short",
|
|
"notes": "Only header byte. Cannot read path_len."
|
|
},
|
|
{
|
|
"id": "trunc-003",
|
|
"description": "Header only (1 byte, TRANSPORT_FLOOD route) - transport codes truncated",
|
|
"type": "invalid",
|
|
"binary": "0C",
|
|
"expected_error": "too_short",
|
|
"notes": "Route type 0x00 requires 4 transport code bytes, but only header is present."
|
|
},
|
|
{
|
|
"id": "trunc-004",
|
|
"description": "TRANSPORT_FLOOD with partial transport codes (2 of 4 bytes)",
|
|
"type": "invalid",
|
|
"binary": "0C 1234",
|
|
"expected_error": "too_short",
|
|
"notes": "Only 2 of 4 transport code bytes present."
|
|
},
|
|
{
|
|
"id": "trunc-005",
|
|
"description": "TRANSPORT_FLOOD with transport codes but no path_len",
|
|
"type": "invalid",
|
|
"binary": "0C 0000 0000",
|
|
"expected_error": "too_short",
|
|
"notes": "5 bytes: header + 4 transport code bytes. Missing path_len."
|
|
},
|
|
{
|
|
"id": "trunc-006",
|
|
"description": "FLOOD with path_len indicating 3 hops but only 1 path byte",
|
|
"type": "invalid",
|
|
"binary": "0D 03 AA FF",
|
|
"expected_error": "truncated_path",
|
|
"notes": "path_len=0x03 means 3 bytes of path expected but only 1 byte follows before the alleged payload. The decoder would read 3 path bytes (AA FF ??) and run out."
|
|
},
|
|
{
|
|
"id": "trunc-007",
|
|
"description": "FLOOD with 2-byte hash path_len=0x42 (4 path bytes needed) but only 2 available",
|
|
"type": "invalid",
|
|
"binary": "0D 42 AABB FF",
|
|
"expected_error": "truncated_path",
|
|
"notes": "path_len=0x42: hash_size=2, count=2, need 4 path bytes. Only 2 bytes before payload marker."
|
|
}
|
|
]
|
|
}
|