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>
111 lines
3.2 KiB
JSON
111 lines
3.2 KiB
JSON
{
|
||
"$schema": "../../schema/test-vector.schema.json",
|
||
"name": "AES-128-ECB Encryption",
|
||
"spec_ref": "src/14-crypto.md",
|
||
"protocol_version": 0,
|
||
"description": "Standalone AES-128-ECB encryption test vectors. Key is the first 16 bytes of the shared secret. These vectors test the raw encryption operation without MAC.",
|
||
"vectors": [
|
||
{
|
||
"id": "aes-001",
|
||
"description": "AES-128-ECB: key=00..0F, plaintext=all zeros",
|
||
"type": "encode_decode",
|
||
"structured": {
|
||
"header": {
|
||
"version": 0,
|
||
"payload_type": "raw_custom",
|
||
"route_type": "flood"
|
||
},
|
||
"path": {
|
||
"hash_size": 1,
|
||
"hash_count": 0,
|
||
"hashes": []
|
||
},
|
||
"payload": {
|
||
"data": "C6A13B37878F5B826F4F8162A1C8D879"
|
||
}
|
||
},
|
||
"binary": "3D 00 C6A13B37878F5B826F4F8162A1C8D879",
|
||
"crypto_context": {
|
||
"encryption_key": "000102030405060708090A0B0C0D0E0F",
|
||
"plaintext": "00000000000000000000000000000000"
|
||
},
|
||
"notes": "AES-128-ECB(key=00..0F, pt=00×16) = C6A13B37878F5B826F4F8162A1C8D879. Wrapped in RAW_CUSTOM for schema compliance."
|
||
},
|
||
{
|
||
"id": "aes-002",
|
||
"description": "AES-128-ECB: key=00..0F, plaintext=all FF",
|
||
"type": "encode_decode",
|
||
"structured": {
|
||
"header": {
|
||
"version": 0,
|
||
"payload_type": "raw_custom",
|
||
"route_type": "flood"
|
||
},
|
||
"path": {
|
||
"hash_size": 1,
|
||
"hash_count": 0,
|
||
"hashes": []
|
||
},
|
||
"payload": {
|
||
"data": "3C441F32CE07822364D7A2990E50BB13"
|
||
}
|
||
},
|
||
"binary": "3D 00 3C441F32CE07822364D7A2990E50BB13",
|
||
"crypto_context": {
|
||
"encryption_key": "000102030405060708090A0B0C0D0E0F",
|
||
"plaintext": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"
|
||
}
|
||
},
|
||
{
|
||
"id": "aes-003",
|
||
"description": "AES-128-ECB: key=00..0F, plaintext=00..0F (sequential)",
|
||
"type": "encode_decode",
|
||
"structured": {
|
||
"header": {
|
||
"version": 0,
|
||
"payload_type": "raw_custom",
|
||
"route_type": "flood"
|
||
},
|
||
"path": {
|
||
"hash_size": 1,
|
||
"hash_count": 0,
|
||
"hashes": []
|
||
},
|
||
"payload": {
|
||
"data": "0A940BB5416EF045F1C39458C653EA5A"
|
||
}
|
||
},
|
||
"binary": "3D 00 0A940BB5416EF045F1C39458C653EA5A",
|
||
"crypto_context": {
|
||
"encryption_key": "000102030405060708090A0B0C0D0E0F",
|
||
"plaintext": "000102030405060708090A0B0C0D0E0F"
|
||
}
|
||
},
|
||
{
|
||
"id": "aes-004",
|
||
"description": "AES-128-ECB: key=all FF, plaintext=all zeros",
|
||
"type": "encode_decode",
|
||
"structured": {
|
||
"header": {
|
||
"version": 0,
|
||
"payload_type": "raw_custom",
|
||
"route_type": "flood"
|
||
},
|
||
"path": {
|
||
"hash_size": 1,
|
||
"hash_count": 0,
|
||
"hashes": []
|
||
},
|
||
"payload": {
|
||
"data": "A1F6258C877D5FCD8964484538BFC92C"
|
||
}
|
||
},
|
||
"binary": "3D 00 A1F6258C877D5FCD8964484538BFC92C",
|
||
"crypto_context": {
|
||
"encryption_key": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
|
||
"plaintext": "00000000000000000000000000000000"
|
||
}
|
||
}
|
||
]
|
||
}
|