cog-ha-matter (ADR-116 P4): pure witness hash-chain primitive

Second P4 unit: an append-only SHA-256 hash chain for tamper-evident
audit logging. ADR-116 §2.2 promised this for healthcare /
education / shared-housing deployments — this lands the primitive
with no key dependency so the next iter can layer Ed25519 signing
on top without touching the chain itself.

Module shape:

  * `WitnessHash([u8; 32])` newtype + `WitnessHash::GENESIS` sentinel
  * `WitnessEvent { seq, prev_hash, ts, kind, payload, this_hash }`
    — once committed, every field is immutable
  * `WitnessChain` — `append`, `tip`, `verify`, `events`
  * `canonical_bytes` — length-prefixed serialization that prevents
    the classic concatenation forgery
    (`abc|def` ≠ `ab|cdef`)
  * `WitnessVerifyError` — auditor-friendly error with `at: usize`
    on every variant (SeqGap, PrevHashMismatch, HashMismatch)

13 new tests covering both happy path and active tampering:

  * genesis hash all-zeros
  * empty chain tip is genesis
  * canonical bytes length-prefixed (anti-forgery)
  * canonical bytes start with prev_hash (wire-format lock)
  * append links to prev_hash
  * seq monotonic from 0
  * verify passes on clean chain
  * verify catches tampered payload (fires HashMismatch)
  * verify catches broken prev_hash link
  * verify catches seq gap
  * hash hex is 64 lowercase chars
  * first event prev_hash == GENESIS (auditor anchor)
  * different payloads → different hashes

Hash-chain over Merkle is the right tradeoff for the cog's event
rate (a few/min steady, dozens during a fall) — linear scan is
fine and we save the Merkle complexity for a future tier when
chains span days.

34/34 cog tests green (21 → 34).

ADR-116 P4 row updated to enumerate the three P4 sub-units shipped /
pending: (a) mDNS record-builder , (b) witness hash-chain , (c)
responder + embedded broker + Ed25519 signing pending.

Co-Authored-By: claude-flow <ruv@ruv.net>
This commit is contained in:
ruv 2026-05-23 18:08:56 -04:00
parent 35722529bf
commit fe913b0ea7
5 changed files with 352 additions and 1 deletions

View File

@ -95,7 +95,7 @@ Ranked by build cost × user impact:
| **P1** | Research dossier ([`docs/research/ADR-116-ha-matter-cog-research.md`](../research/ADR-116-ha-matter-cog-research.md)) | ✅ **done** — 8 sections, 30+ citations, v1 scope ranked |
| **P2** | Cog crate scaffold (`v2/crates/cog-ha-matter/`) — Cargo.toml + `src/{lib,main,manifest}.rs`, workspace member, CLI args, `--print-manifest` flag, 2 manifest unit tests | ✅ **done**`cargo check` + `cargo test` green |
| **P3** | Wrap existing ADR-115 MQTT publisher as cog entry point | ✅ **wiring done**`main.rs` boots ADR-115's `publisher::spawn` via `runtime::spawn_publisher` thin wrapper, holds a long-lived `broadcast::Sender<VitalsSnapshot>`, awaits Ctrl-C. Live-handle test green without a broker. Next (P3.5): subscribe to sensing-server `/v1/snapshot` WS and republish into the channel. |
| **P4** | Seed-native enhancements (embedded broker, mDNS, witness) | in progress — mDNS service-record builder shipped: pure `mdns::build_mdns_service` returns wire-format `MdnsService { service_type, instance_name, control_port, txt_records }` with locked 6-key TXT surface (`cog_id`, `cog_version`, `node_id`, `mqtt_port`, `privacy`, `proto`). 9 unit tests, including PII-leak guard. Responder (mdns-sd) + embedded rumqttd + witness chain still pending. |
| **P4** | Seed-native enhancements (embedded broker, mDNS, witness) | in progress — (a) mDNS service-record builder shipped (`mdns::build_mdns_service`, 6-key locked TXT surface, PII-leak guard). (b) Witness hash-chain primitive shipped (`witness::WitnessChain` — append-only SHA-256 chain with `verify()` catching tampered payload / broken prev_hash / seq gap). (c) Responder (mdns-sd) + embedded rumqttd + Ed25519 signing layer still pending. |
| **P5** | RuVector-backed threshold learning (SONA adaptation) | pending |
| **P6** | Multi-Seed federation (cross-Seed dedup + witness) | pending |
| **P7** | Matter Bridge mode (depends on matter-rs / esp-matter readiness) | pending |

1
v2/Cargo.lock generated
View File

@ -936,6 +936,7 @@ dependencies = [
"clap",
"serde",
"serde_json",
"sha2",
"tempfile",
"thiserror 1.0.69",
"tokio",

View File

@ -35,5 +35,9 @@ wifi-densepose-sensing-server = { version = "0.3.0", path = "../wifi-densepose-s
# Hardware crate for SyncPacket + NodeState bridging (ADR-110 substrate).
wifi-densepose-hardware = { version = "0.3.0", path = "../wifi-densepose-hardware" }
# Witness chain (ADR-116 P4): SHA-256 only for now; Ed25519 signing
# layers on top once we ship the key-management story.
sha2 = { workspace = true }
[dev-dependencies]
tempfile = "3.10"

View File

@ -29,6 +29,7 @@
pub mod manifest;
pub mod mdns;
pub mod runtime;
pub mod witness;
/// Cog identifier used in Seed's app-registry.json + the manifest.
pub const COG_ID: &str = "ha-matter";

View File

@ -0,0 +1,345 @@
//! `witness` — append-only hash-chained event log for the cog.
//!
//! ADR-116 §2.2 promises a tamper-evident audit log so regulated
//! deployments (healthcare, education, shared housing) can prove
//! that the state transitions a Seed reported were actually emitted
//! by the cog at the time they were emitted, not retroactively
//! rewritten.
//!
//! This module is the **pure hash-chain primitive**:
//!
//! * SHA-256 over deterministic canonical bytes,
//! * `prev_hash` chains each event to its predecessor,
//! * `WitnessChain::append` is the only mutator — no random
//! access, no replace, no delete.
//!
//! Ed25519 signing layers on top once the key-management story
//! lands (probably as `witness_signing.rs` reading a key from the
//! Seed's secure store). Keeping the hash chain and the signature
//! in separate modules means the chain primitive can be tested
//! without a key fixture, and a future key rotation doesn't
//! invalidate the chain itself — only the signature over each
//! event.
//!
//! ## Why hash-chain first, not Merkle tree?
//!
//! The cog emits witness events at the rate of semantic-primitive
//! transitions — a few per minute in steady state, dozens during
//! a fall-detection / room-transition event. Linear scan is fine
//! at that rate; we save the Merkle complexity for a future tier
//! when the chain spans days and the auditor wants O(log n)
//! inclusion proofs.
use sha2::{Digest, Sha256};
/// 32-byte hash output. Lifted into a newtype so a future migration
/// to Blake3 / SHA-512 surfaces as a type change instead of a
/// silent length difference in serialized witness bundles.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct WitnessHash(pub [u8; 32]);
impl WitnessHash {
/// Genesis hash — the predecessor of the first event. Sentinel
/// "no prior event" value.
pub const GENESIS: WitnessHash = WitnessHash([0u8; 32]);
/// Lowercase hex without `0x` prefix. Matches the format the
/// `cog-pose-estimation` manifest uses for `binary_sha256` so
/// downstream tooling can apply one parser.
pub fn to_hex(&self) -> String {
let mut s = String::with_capacity(64);
for b in self.0 {
s.push_str(&format!("{b:02x}"));
}
s
}
}
/// A single witnessed event. Append-only — once committed to a
/// `WitnessChain`, the fields here are immutable.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct WitnessEvent {
/// Zero-based sequence number. Strictly monotonically
/// increasing within a chain — gaps mean the chain was
/// truncated.
pub seq: u64,
/// Hash of the previous event, or [`WitnessHash::GENESIS`] for
/// the first.
pub prev_hash: WitnessHash,
/// Unix epoch seconds at append time. Caller-supplied so the
/// test suite isn't time-coupled; production uses
/// `SystemTime::now()`.
pub timestamp_unix_s: u64,
/// Short stable kind tag — e.g. `"fall_risk_elevated"`,
/// `"bed_exit"`, `"privacy_mode_toggled"`. Locked vocabulary
/// in the future; free-form here until the semantic-primitive
/// catalog stabilises.
pub kind: String,
/// Opaque payload bytes. Typically the JSON of the emitted MQTT
/// state message so an auditor can re-derive what HA was told.
pub payload: Vec<u8>,
/// Hash of *this* event, computed over canonical bytes that
/// include `prev_hash` — so reconstructing the chain proves
/// nothing in the past was rewritten.
pub this_hash: WitnessHash,
}
/// Compute the canonical-bytes form an event is hashed over.
///
/// The format is intentionally simple and length-prefixed so a
/// future migration can be staged with a `version` byte in front
/// without ambiguity:
///
/// ```text
/// prev_hash[32] | seq:u64-be | ts:u64-be | kind_len:u32-be | kind | payload_len:u32-be | payload
/// ```
///
/// Length-prefixing prevents the classic "concatenation forgery"
/// attack where `"abc" + "def"` and `"ab" + "cdef"` would hash the
/// same.
pub fn canonical_bytes(
prev_hash: WitnessHash,
seq: u64,
timestamp_unix_s: u64,
kind: &str,
payload: &[u8],
) -> Vec<u8> {
let kind_bytes = kind.as_bytes();
let mut out = Vec::with_capacity(32 + 8 + 8 + 4 + kind_bytes.len() + 4 + payload.len());
out.extend_from_slice(&prev_hash.0);
out.extend_from_slice(&seq.to_be_bytes());
out.extend_from_slice(&timestamp_unix_s.to_be_bytes());
out.extend_from_slice(&(kind_bytes.len() as u32).to_be_bytes());
out.extend_from_slice(kind_bytes);
out.extend_from_slice(&(payload.len() as u32).to_be_bytes());
out.extend_from_slice(payload);
out
}
/// Compute the SHA-256 hash for an event.
pub fn hash_event(
prev_hash: WitnessHash,
seq: u64,
timestamp_unix_s: u64,
kind: &str,
payload: &[u8],
) -> WitnessHash {
let mut h = Sha256::new();
h.update(canonical_bytes(prev_hash, seq, timestamp_unix_s, kind, payload));
let digest = h.finalize();
let mut out = [0u8; 32];
out.copy_from_slice(&digest);
WitnessHash(out)
}
/// In-memory append-only chain. Persistence (write to the Seed's
/// `~/cognitum/witness/<cog>/events.jsonl`) is a separate concern
/// kept out of this module.
#[derive(Debug, Default, Clone)]
pub struct WitnessChain {
events: Vec<WitnessEvent>,
}
impl WitnessChain {
pub fn new() -> Self {
Self::default()
}
/// Last committed hash, or `GENESIS` if the chain is empty.
pub fn tip(&self) -> WitnessHash {
self.events
.last()
.map(|e| e.this_hash)
.unwrap_or(WitnessHash::GENESIS)
}
pub fn len(&self) -> usize {
self.events.len()
}
pub fn is_empty(&self) -> bool {
self.events.is_empty()
}
/// Append a new event. Caller supplies the wall-clock so tests
/// stay deterministic.
pub fn append(&mut self, kind: &str, payload: &[u8], timestamp_unix_s: u64) -> &WitnessEvent {
let prev_hash = self.tip();
let seq = self.events.len() as u64;
let this_hash = hash_event(prev_hash, seq, timestamp_unix_s, kind, payload);
self.events.push(WitnessEvent {
seq,
prev_hash,
timestamp_unix_s,
kind: kind.to_string(),
payload: payload.to_vec(),
this_hash,
});
self.events.last().expect("just pushed")
}
pub fn events(&self) -> &[WitnessEvent] {
&self.events
}
/// Verify every event's `this_hash` matches the canonical bytes,
/// every `prev_hash` matches the predecessor's `this_hash`, and
/// `seq` is gap-free starting at 0.
///
/// Returns `Ok(())` on a sound chain or an `Err` with the first
/// failing index + reason — auditor-friendly.
pub fn verify(&self) -> Result<(), WitnessVerifyError> {
let mut prev = WitnessHash::GENESIS;
for (i, ev) in self.events.iter().enumerate() {
if ev.seq != i as u64 {
return Err(WitnessVerifyError::SeqGap { at: i, found: ev.seq });
}
if ev.prev_hash != prev {
return Err(WitnessVerifyError::PrevHashMismatch { at: i });
}
let recomputed = hash_event(
ev.prev_hash,
ev.seq,
ev.timestamp_unix_s,
&ev.kind,
&ev.payload,
);
if recomputed != ev.this_hash {
return Err(WitnessVerifyError::HashMismatch { at: i });
}
prev = ev.this_hash;
}
Ok(())
}
}
#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
pub enum WitnessVerifyError {
#[error("seq gap at index {at}: expected {at}, found {found}")]
SeqGap { at: usize, found: u64 },
#[error("prev_hash mismatch at index {at}")]
PrevHashMismatch { at: usize },
#[error("this_hash mismatch at index {at} — event tampered")]
HashMismatch { at: usize },
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn genesis_hash_is_all_zeros() {
assert_eq!(WitnessHash::GENESIS.0, [0u8; 32]);
}
#[test]
fn empty_chain_tip_is_genesis() {
let c = WitnessChain::new();
assert_eq!(c.tip(), WitnessHash::GENESIS);
assert!(c.is_empty());
}
#[test]
fn canonical_bytes_length_prefixing_prevents_ambiguity() {
// Classic concatenation forgery: without length prefixes,
// ("abc","def") and ("ab","cdef") would produce the same
// hash. With them, they don't.
let a = canonical_bytes(WitnessHash::GENESIS, 0, 0, "abc", b"def");
let b = canonical_bytes(WitnessHash::GENESIS, 0, 0, "ab", b"cdef");
assert_ne!(a, b);
}
#[test]
fn canonical_bytes_starts_with_prev_hash() {
// Locks the on-wire format. A future migration that flips
// field order must bump a version byte and update this test.
let bytes = canonical_bytes(WitnessHash([7u8; 32]), 1, 2, "k", b"p");
assert_eq!(&bytes[..32], &[7u8; 32]);
}
#[test]
fn append_links_to_prev_hash() {
let mut c = WitnessChain::new();
let h1 = c.append("a", b"1", 100).this_hash;
let e2 = c.append("b", b"2", 101);
assert_eq!(e2.prev_hash, h1);
assert_eq!(e2.seq, 1);
}
#[test]
fn sequence_is_monotonic_starting_at_zero() {
let mut c = WitnessChain::new();
for i in 0..5 {
c.append("k", &[i], 0);
}
for (i, ev) in c.events().iter().enumerate() {
assert_eq!(ev.seq, i as u64);
}
}
#[test]
fn verify_passes_on_clean_chain() {
let mut c = WitnessChain::new();
c.append("fall_risk_elevated", b"{}", 100);
c.append("bed_exit", b"{}", 101);
c.append("privacy_mode_toggled", br#"{"on":true}"#, 102);
c.verify().expect("clean chain verifies");
}
#[test]
fn verify_catches_tampered_payload() {
let mut c = WitnessChain::new();
c.append("a", b"original", 100);
c.append("b", b"original2", 101);
// Tamper with event 0's payload directly.
c.events[0].payload = b"forged".to_vec();
let err = c.verify().unwrap_err();
assert!(matches!(err, WitnessVerifyError::HashMismatch { at: 0 }));
}
#[test]
fn verify_catches_broken_prev_link() {
let mut c = WitnessChain::new();
c.append("a", b"1", 100);
c.append("b", b"2", 101);
c.events[1].prev_hash = WitnessHash([0xff; 32]);
let err = c.verify().unwrap_err();
assert!(matches!(err, WitnessVerifyError::PrevHashMismatch { at: 1 }));
}
#[test]
fn verify_catches_seq_gap() {
let mut c = WitnessChain::new();
c.append("a", b"1", 100);
c.append("b", b"2", 101);
c.events[1].seq = 99;
let err = c.verify().unwrap_err();
assert!(matches!(err, WitnessVerifyError::SeqGap { at: 1, found: 99 }));
}
#[test]
fn hash_to_hex_is_64_lowercase_chars() {
let h = hash_event(WitnessHash::GENESIS, 0, 0, "k", b"p");
let hex = h.to_hex();
assert_eq!(hex.len(), 64);
assert!(hex.chars().all(|c| c.is_ascii_hexdigit() && !c.is_ascii_uppercase()));
}
#[test]
fn first_event_prev_hash_is_genesis() {
// Auditor relies on this: a witness bundle that doesn't start
// with prev_hash == GENESIS is either truncated or stitched
// together from two chains.
let mut c = WitnessChain::new();
let e = c.append("init", b"", 0);
assert_eq!(e.prev_hash, WitnessHash::GENESIS);
assert_eq!(e.seq, 0);
}
#[test]
fn different_payloads_produce_different_hashes() {
let h1 = hash_event(WitnessHash::GENESIS, 0, 100, "k", b"a");
let h2 = hash_event(WitnessHash::GENESIS, 0, 100, "k", b"b");
assert_ne!(h1, h2);
}
}