Skip to content

Commit 8512141

Browse files
authored
SPEC.md: add version stamp, cross-references, and golden test corpus reference (#1)
PILOT-55 (IETF draft + protocol spec doc currency) - Add version status block with last-reviewed date - Cross-reference IETF drafts, SPEC-compat-mode, and common v1.10.x - Add references section linking golden test corpus as byte-level spec - Add companion document pointers for IETF drafts
1 parent d56135c commit 8512141

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

SPEC.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
# Pilot Protocol Wire Specification v0.5
22

3+
# Pilot Protocol Wire Specification v0.5
4+
5+
> **Status:** Active specification
36
> **Specification version:** v0.5
4-
> **Protocol version (header):** `1` (4-bit field, see §3.2)
7+
> **Protocol version (header):** `1` (4-bit field, see §3.2)
8+
> **Last reviewed:** 2026-06-18
9+
> **Companion documents:** [IETF draft-teodor-pilot-protocol-01](https://datatracker.ietf.org/doc/draft-teodor-pilot-protocol/) (protocol), [draft-teodor-pilot-problem-statement-01](https://datatracker.ietf.org/doc/draft-teodor-pilot-problem-statement/) (problem statement)
10+
> **Reference implementation:** [pilot-protocol/common](https://github.com/pilot-protocol/common) v1.10.x
11+
> **Compatibility:** See [SPEC-compat-mode.md](SPEC-compat-mode.md) for WSS/WebSocket transport
512
613
## Version Compatibility
714

@@ -17,6 +24,7 @@
1724
1825
---
1926

27+
2028
## 1. Addressing
2129

2230
### 1.1 Virtual Address Format
@@ -549,3 +557,12 @@ The secure channel on port 443 uses a separate nonce scheme:
549557
- **Counter**: 8-byte unsigned integer starting at 0, incremented per encryption.
550558

551559
Each secure connection performs its own X25519 key exchange and HKDF-SHA256 key derivation (info: "pilot-secure-v1"), so nonce uniqueness is guaranteed per-key. The sender's nonce prefix (first 4 bytes) is used as GCM AAD on both sides.
560+
561+
---
562+
563+
### References
564+
565+
- **Byte-level specification:** [Golden test corpus](https://github.com/pilot-protocol/common/tree/main/protocol/testdata/wire) — contains canonical wire-format encode/decode test vectors.
566+
- **IETF drafts:** [draft-teodor-pilot-protocol](https://datatracker.ietf.org/doc/draft-teodor-pilot-protocol/), [draft-teodor-pilot-problem-statement](https://datatracker.ietf.org/doc/draft-teodor-pilot-problem-statement/)
567+
- **Compatibility:** [SPEC-compat-mode.md](SPEC-compat-mode.md) — WSS/WebSocket transport
568+
- **Architecture guidance:** See DESIGN.md in each component repository (where available)

0 commit comments

Comments
 (0)