dig-message 0.3.0

The DIG Network generic base message protocol: the byte-deterministic Chia-Streamable envelope + InnerMessage, length-framed size-bounded framing, additive compression (raw + zstd, decompression-bomb guarded), and the extensible message-type registry that every directed (1:1 / group) e2e-sealed peer message rides.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
//! Known-Answer-Test (KAT) harness for dig-message — the golden-vector infrastructure that pins the
//! byte-level wire contract (SPEC §2, §7). WU1 fills the crypto-free vectors: the envelope encodings
//! for every interaction shape and the compression round-trips. The seal / signature / replay /
//! streaming vectors are the clearly-marked WU2/WU4 placeholders at the bottom.
//!
//! Golden values are committed as SHA-256 digests of the deterministic on-wire bytes: a digest change
//! means the wire format drifted (a byte-determinism regression), which MUST be an intentional,
//! reviewed SemVer event — never an accident. All test material is DERIVED from a hashed seed (never a
//! hard-coded literal — CodeQL).

use chia_protocol::{Bytes32, Bytes48};
use dig_message::*;
use sha2::{Digest, Sha256};

/// Deterministic pseudo-random bytes for a labeled field — SHA-256(tag || counter) chained to `n`
/// bytes. Reproducible across runs and machines, so a golden digest is stable.
fn seeded(tag: &[u8], n: usize) -> Vec<u8> {
    let mut out = Vec::new();
    let mut counter = 0u64;
    while out.len() < n {
        let mut hasher = Sha256::new();
        hasher.update(tag);
        hasher.update(counter.to_le_bytes());
        out.extend_from_slice(&hasher.finalize());
        counter += 1;
    }
    out.truncate(n);
    out
}

fn b32(tag: &[u8]) -> Bytes32 {
    Bytes32::new(seeded(tag, 32).try_into().unwrap())
}

/// Lowercase-hex SHA-256 of the on-wire bytes — the committed golden form.
fn digest(bytes: &[u8]) -> String {
    let mut hasher = Sha256::new();
    hasher.update(bytes);
    hasher
        .finalize()
        .iter()
        .map(|b| format!("{b:02x}"))
        .collect()
}

/// The canonical golden envelope for a shape, built from seeded field material.
fn golden_envelope(shape: InteractionShape, stream: Option<StreamHeader>) -> DigMessageEnvelope {
    DigMessageEnvelope {
        version: ENVELOPE_VERSION,
        message_type: 0x0000_0201,
        flags: shape.as_bits() | FLAG_SEALED,
        correlation_id: b32(b"corr"),
        sender: b32(b"sender"),
        recipient: b32(b"recip"),
        sender_epoch: 3,
        stream,
        sealed: SealedPayload {
            kem_enc: Bytes48::new(seeded(b"kem", 48).try_into().unwrap()),
            ciphertext: seeded(b"ct", 24),
        },
    }
}

// ── Envelope golden vectors (SPEC §2) — byte-determinism is the wire contract. ──

#[test]
fn kat_envelope_oneshot() {
    let bytes = encode_envelope(&golden_envelope(InteractionShape::OneShot, None)).unwrap();
    assert_eq!(bytes.len(), 183);
    assert_eq!(
        digest(&bytes),
        "02e5acc39f11b32336d373d3334f3017f44e45e3df2212ff1caf5158f41f9bab"
    );
}

#[test]
fn kat_envelope_request() {
    let bytes = encode_envelope(&golden_envelope(InteractionShape::Request, None)).unwrap();
    assert_eq!(
        digest(&bytes),
        "eea426a86ded1df366d5a98d45285c82568f4eb0feacc5f62e63ead69b909c8a"
    );
}

#[test]
fn kat_envelope_response() {
    let bytes = encode_envelope(&golden_envelope(InteractionShape::Response, None)).unwrap();
    assert_eq!(
        digest(&bytes),
        "5a29d5c66105ba33c17ae53934af22fade4a3e61c6609044003f2ce0bdb05530"
    );
}

#[test]
fn kat_envelope_stream_frame() {
    let stream = Some(StreamHeader {
        frame: StreamFrame::Data as u8,
        seq: 42,
        window: 8,
    });
    let bytes = encode_envelope(&golden_envelope(InteractionShape::StreamFrame, stream)).unwrap();
    assert_eq!(bytes.len(), 196);
    assert_eq!(
        digest(&bytes),
        "ee409a0eb016f42280dfeea71d9fe8b4cdfb280f8e072e9391cbd161d6754ee3"
    );
}

#[test]
fn kat_every_shape_round_trips() {
    let cases = [
        golden_envelope(InteractionShape::OneShot, None),
        golden_envelope(InteractionShape::Request, None),
        golden_envelope(InteractionShape::Response, None),
        golden_envelope(
            InteractionShape::StreamFrame,
            Some(StreamHeader {
                frame: StreamFrame::Open as u8,
                seq: 0,
                window: 16,
            }),
        ),
    ];
    for env in cases {
        let decoded = decode_envelope(&encode_envelope(&env).unwrap()).unwrap();
        assert_eq!(env, decoded);
    }
}

// ── Compression golden vectors (SPEC §1.1). ──

#[test]
fn kat_compression_zstd_round_trip() {
    // A low-entropy payload zstd compresses deterministically (level 3, single-frame, no dictionary).
    let payload: Vec<u8> = (0..4096usize).map(|i| (i % 7) as u8).collect();
    let compressed = compress_payload(&payload).unwrap();
    assert_eq!(compressed.compression, COMPRESSION_ZSTD);
    assert_eq!(
        compressed.bytes.len(),
        24,
        "pinned zstd params -> pinned compressed length"
    );
    assert_eq!(
        digest(&compressed.bytes),
        "3a2ad06d6906a2fdd9353e52f386d097eac0fadb9529fb9a3289eae782b49e70",
        "compressed bytes are the cross-target byte-agreement contract (SPEC §1.2)"
    );
    let restored = decompress_payload(
        compressed.compression,
        &compressed.bytes,
        compressed.uncompressed_len,
    )
    .unwrap();
    assert_eq!(restored, payload);
}

#[test]
fn kat_compression_raw_round_trip() {
    let payload = seeded(b"raw-kat", 40); // below MIN_COMPRESS_BYTES -> raw
    let compressed = compress_payload(&payload).unwrap();
    assert_eq!(compressed.compression, COMPRESSION_NONE);
    assert_eq!(compressed.bytes, payload);
    let restored = decompress_payload(
        compressed.compression,
        &compressed.bytes,
        compressed.uncompressed_len,
    )
    .unwrap();
    assert_eq!(restored, payload);
}

#[test]
fn kat_unknown_compression_id_rejected() {
    assert_eq!(
        decompress_payload(63, &seeded(b"x", 8), 8).unwrap_err(),
        MessageError::UnsupportedCompression(63)
    );
}

#[test]
fn kat_decompression_bomb_rejected() {
    let over = (MAX_DECOMPRESSED_BYTES + 1) as u32;
    assert!(matches!(
        decompress_payload(COMPRESSION_ZSTD, &[], over).unwrap_err(),
        MessageError::DecompressionBomb { .. }
    ));
}

// ── WU2 KATs (seal + BLS signature + replay/expiry, SPEC §5) — implemented in #1160. ──
//
// These integration KATs exercise the PUBLIC seal API end-to-end (the same contract a second
// implementation is built against). All key/nonce material is DERIVED from a hashed seed (never a
// hard-coded literal — CodeQL). Fine-grained unit KATs live beside the code in `src/{seal,replay,
// transcript}.rs`; the vectors here pin the integration-level behavior.

use dig_identity::bls::SecretKey;
use dig_identity::{derive_identity_sk, master_secret_key_from_seed, public_key_bytes};

const KAT_NOW: u64 = 1_700_000_000_000;

/// A deterministic identity key from a label (reproducible across implementations).
fn kat_sk(label: &str) -> SecretKey {
    let seed: [u8; 32] = Sha256::digest(label.as_bytes()).into();
    derive_identity_sk(&master_secret_key_from_seed(&seed))
}

/// A deterministic ephemeral key from a label (so a seal KAT is byte-stable).
fn kat_ephemeral(label: &str) -> SecretKey {
    let seed: [u8; 32] = Sha256::digest(label.as_bytes()).into();
    SecretKey::from_seed(&seed)
}

/// A fixed-sender-key resolver (the unit-test stand-in for the dig-identity chain resolution).
fn kat_resolver(pk: [u8; 48]) -> impl Fn(Bytes32, u32) -> Option<[u8; 48]> {
    move |_did, _epoch| Some(pk)
}

/// A default one-shot [`SealParams`] (counter 0, timestamp `KAT_NOW`, no expiry). Callers override the
/// `counter` / `timestamp_ms` / `expires_at` fields on the returned value where a KAT needs them.
fn kat_params<'a>(
    sender_sk: &'a SecretKey,
    sender: Bytes32,
    recipient: Bytes32,
    recipient_pub: &'a [u8; 48],
    payload: &'a [u8],
) -> SealParams<'a> {
    SealParams {
        sender_sk,
        sender,
        sender_epoch: 0,
        recipient,
        recipient_pub,
        message_type: BAND_DIG_CHAT,
        shape: InteractionShape::OneShot,
        correlation_id: b32(b"kat/corr"),
        stream: None,
        counter: 0,
        timestamp_ms: KAT_NOW,
        expires_at: 0,
        payload,
    }
}

#[test]
fn kat_seal_open_round_trip_raw_and_compressed() {
    let alice = kat_sk("kat/seal/alice");
    let bob = kat_sk("kat/seal/bob");
    let (a_did, b_did) = (b32(b"kat/a"), b32(b"kat/b"));
    let b_pub = public_key_bytes(&bob);

    for (label, msg) in [
        ("raw", b"hi".to_vec()),
        (
            "zstd",
            (0..2048).map(|i| (i % 5) as u8).collect::<Vec<u8>>(),
        ),
    ] {
        let params = kat_params(&alice, a_did, b_did, &b_pub, &msg);
        let env = seal_with_ephemeral(&params, &kat_ephemeral(label)).unwrap();
        let mut guard = ReplayGuard::new();
        let opened = open_message(
            &bob,
            &env,
            kat_resolver(public_key_bytes(&alice)),
            &mut guard,
            KAT_NOW,
        )
        .unwrap();
        assert_eq!(opened.payload, msg, "{label} payload round-trips");
    }
}

#[test]
fn kat_relay_sees_only_ciphertext() {
    let alice = kat_sk("kat/leak/a");
    let bob = kat_sk("kat/leak/b");
    let secret = b"UNIQUE-PLAINTEXT-NEEDLE-XYZ";
    let b_pub = public_key_bytes(&bob);
    let params = kat_params(&alice, b32(b"a"), b32(b"b"), &b_pub, secret);
    let env = seal_with_ephemeral(&params, &kat_ephemeral("leak")).unwrap();
    let wire = encode_envelope(&env).unwrap();
    assert!(wire.windows(secret.len()).all(|w| w != secret));
}

#[test]
fn kat_wrong_recipient_and_wrong_sender_reject() {
    let alice = kat_sk("kat/wr/a");
    let bob = kat_sk("kat/wr/b");
    let eve = kat_sk("kat/wr/eve");
    let b_pub = public_key_bytes(&bob);
    let params = kat_params(&alice, b32(b"a"), b32(b"b"), &b_pub, b"secret");
    let env = seal_with_ephemeral(&params, &kat_ephemeral("wr")).unwrap();

    let mut g1 = ReplayGuard::new();
    assert_eq!(
        open_message(
            &eve,
            &env,
            kat_resolver(public_key_bytes(&alice)),
            &mut g1,
            KAT_NOW
        )
        .unwrap_err(),
        MessageError::OpenFailed,
        "wrong recipient key cannot open"
    );
    let mut g2 = ReplayGuard::new();
    assert_eq!(
        open_message(
            &bob,
            &env,
            kat_resolver(public_key_bytes(&eve)),
            &mut g2,
            KAT_NOW
        )
        .unwrap_err(),
        MessageError::OpenFailed,
        "wrong sender key cannot open"
    );
}

#[test]
fn kat_non_subgroup_kem_enc_rejected() {
    let alice = kat_sk("kat/sg/a");
    let bob = kat_sk("kat/sg/b");
    let b_pub = public_key_bytes(&bob);
    let params = kat_params(&alice, b32(b"a"), b32(b"b"), &b_pub, b"x");
    let mut env = seal_with_ephemeral(&params, &kat_ephemeral("sg")).unwrap();
    env.sealed.kem_enc = Bytes48::new([0xFFu8; 48]); // off-curve / non-subgroup point
    let mut guard = ReplayGuard::new();
    assert_eq!(
        open_message(
            &bob,
            &env,
            kat_resolver(public_key_bytes(&alice)),
            &mut guard,
            KAT_NOW
        )
        .unwrap_err(),
        MessageError::InvalidPoint
    );
}

#[test]
fn kat_replay_and_expiry() {
    let alice = kat_sk("kat/re/a");
    let bob = kat_sk("kat/re/b");
    let a_pub = public_key_bytes(&alice);
    let b_pub = public_key_bytes(&bob);
    let (a_did, b_did) = (b32(b"a"), b32(b"b"));

    // Replay: the same envelope twice -> second REJECT.
    let env = seal_with_ephemeral(
        &kat_params(&alice, a_did, b_did, &b_pub, b"x"),
        &kat_ephemeral("re0"),
    )
    .unwrap();
    let mut guard = ReplayGuard::new();
    assert!(open_message(&bob, &env, kat_resolver(a_pub), &mut guard, KAT_NOW).is_ok());
    assert_eq!(
        open_message(&bob, &env, kat_resolver(a_pub), &mut guard, KAT_NOW).unwrap_err(),
        MessageError::Replay
    );

    // Past-expires -> DISCARD.
    let mut expiring_params = kat_params(&alice, a_did, b_did, &b_pub, b"x");
    expiring_params.counter = 1;
    expiring_params.expires_at = KAT_NOW + 1000;
    let expiring = seal_with_ephemeral(&expiring_params, &kat_ephemeral("re1")).unwrap();
    let mut g2 = ReplayGuard::new();
    assert_eq!(
        open_message(
            &bob,
            &expiring,
            kat_resolver(a_pub),
            &mut g2,
            KAT_NOW + 5000
        )
        .unwrap_err(),
        MessageError::Expired
    );
}

#[test]
fn kat_self_addressed_round_trip() {
    // SPEC §5.6a: sender key == recipient key is first-class.
    let me = kat_sk("kat/self");
    let me_pub = public_key_bytes(&me);
    let did = b32(b"kat/self/did");
    let params = kat_params(&me, did, did, &me_pub, b"note to self");
    let env = seal_with_ephemeral(&params, &kat_ephemeral("self")).unwrap();
    let mut guard = ReplayGuard::new();
    let opened = open_message(&me, &env, kat_resolver(me_pub), &mut guard, KAT_NOW).unwrap();
    assert_eq!(opened.payload, b"note to self");
}

#[test]
fn kat_bls_domain_separation_vs_chain_agg_sig() {
    // SPEC §5.1a: the signed bytes are SIG_DOMAIN || transcript, so a dig-message signature can never
    // be confused with an un-prefixed chain AGG_SIG message. The signature verifies over the
    // domain-prefixed bytes and does NOT verify over the transcript with the domain stripped.
    let alice = kat_sk("kat/dom/a");
    let a_pub = public_key_bytes(&alice);
    let kem = [7u8; 48];
    let transcript = TranscriptFields {
        version: 1,
        message_type: BAND_DIG_CHAT,
        flags: InteractionShape::OneShot.as_bits() | FLAG_SEALED,
        correlation_id: b32(b"kat/dom/corr"),
        sender: b32(b"kat/dom/s"),
        recipient: b32(b"kat/dom/r"),
        sender_epoch: 0,
        counter: 0,
        timestamp_ms: KAT_NOW,
        expires_at: 0,
        stream: None,
        kem_enc: &kem,
        compression: COMPRESSION_NONE,
        uncompressed_len: 1,
        compressed_payload: b"z",
    };
    let signing = transcript.signing_bytes();
    assert!(
        signing.starts_with(SIG_DOMAIN),
        "the domain tag prefixes the signed bytes"
    );

    let sig = transcript.sign(&alice);
    assert!(transcript.verify(&a_pub, &sig));

    // Strip the domain tag: an AGG_SIG-style raw message must NOT verify under this signature.
    use dig_identity::verify_signature;
    let stripped = &signing[SIG_DOMAIN.len()..];
    assert!(
        !verify_signature(&a_pub, stripped, &sig),
        "domain-stripped message must not verify"
    );
}

// ── WU4 placeholders (streaming + replay/expiry, SPEC §3 / §5.6 / §5.6b) — implemented in #1162. ──
//
//   - streaming round-trip; CANCEL/RESET; backpressure; cross-session frame-replay reject
//   - replayed message rejected; stale (old-counter/out-of-freshness) rejected
//   - within-expires accepted; past-expires DISCARDED; expires_at > cap REJECTED; expires_at==0 no-op