khive-runtime 0.20.0

Composable Service API: entity/note CRUD, graph traversal, hybrid search, curation.
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
use super::*;
use crate::credentials::{
    CredentialCacheLifetime, CredentialConfig, CredentialError, CredentialMaterial,
    CredentialProvider, VisibilityReceiptKeyConfig,
};
use std::collections::BTreeMap;
use std::sync::atomic::{AtomicUsize, Ordering};

struct TestProvider {
    keys: BTreeMap<String, String>,
    lookups: Arc<AtomicUsize>,
}

impl CredentialProvider for TestProvider {
    fn resolve(&self, name: &str) -> Result<CredentialMaterial, CredentialError> {
        self.lookups.fetch_add(1, Ordering::Relaxed);
        self.keys
            .get(name)
            .map(|value| CredentialMaterial::new(value.as_bytes().to_vec()))
            .ok_or_else(|| CredentialError::Unavailable {
                name: name.to_owned(),
            })
    }
    fn cache_lifetime(&self) -> CredentialCacheLifetime {
        CredentialCacheLifetime::NoCache
    }
}

fn sealer(encrypt: &str) -> (ReceiptSealer, Arc<AtomicUsize>) {
    sealer_with_keys(
        encrypt,
        [
            ("old".to_owned(), URL_SAFE_NO_PAD.encode([7_u8; 32])),
            ("new".to_owned(), URL_SAFE_NO_PAD.encode([19_u8; 32])),
        ]
        .into_iter()
        .collect(),
    )
}

fn sealer_with_keys(
    encrypt: &str,
    keys: BTreeMap<String, String>,
) -> (ReceiptSealer, Arc<AtomicUsize>) {
    let declarations = ["old", "new"]
        .into_iter()
        .map(|id| CredentialConfig {
            name: id.to_owned(),
            kind: CredentialKind::SigningKey,
            provider: "test".to_owned(),
            env_var: None,
            header: None,
        })
        .collect();
    let lookups = Arc::new(AtomicUsize::new(0));
    let mut credentials = CredentialRegistry::new(declarations).unwrap();
    credentials
        .register_provider(
            "test".to_owned(),
            Arc::new(TestProvider {
                keys,
                lookups: Arc::clone(&lookups),
            }),
        )
        .unwrap();
    let ring = VisibilityReceiptConfig {
        keys: ["old", "new"]
            .into_iter()
            .map(|id| VisibilityReceiptKeyConfig {
                id: id.to_owned(),
                credential: id.to_owned(),
                encrypt: id == encrypt,
            })
            .collect(),
    };
    (
        ReceiptSealer::new(ring, Arc::new(credentials)).unwrap(),
        lookups,
    )
}

#[test]
fn programmatic_rings_are_revalidated() {
    let declare = |name: &str, kind| CredentialConfig {
        name: name.to_owned(),
        kind,
        provider: "test".to_owned(),
        env_var: None,
        header: None,
    };
    let credentials = Arc::new(
        CredentialRegistry::new(vec![
            declare("sign", CredentialKind::SigningKey),
            declare("basic", CredentialKind::Basic),
        ])
        .unwrap(),
    );
    let key = |id: &str, credential: &str, encrypt| VisibilityReceiptKeyConfig {
        id: id.to_owned(),
        credential: credential.to_owned(),
        encrypt,
    };
    for keys in [
        vec![key("a", "sign", true), key("b", "sign", true)],
        vec![key("a", "sign", true), key("a", "sign", false)],
        vec![key("a", "basic", true)],
        vec![key("a", "missing", true)],
        vec![key("a", "sign", false)],
        vec![key("../a", "sign", true)],
    ] {
        assert!(matches!(
            ReceiptSealer::new(VisibilityReceiptConfig { keys }, Arc::clone(&credentials)),
            Err(ReceiptSealError::KeyUnavailable)
        ));
    }
    let ring = VisibilityReceiptConfig {
        keys: vec![key("a", "sign", true), key("b", "sign", false)],
    };
    assert!(ReceiptSealer::new(ring, credentials).is_ok());
}

#[test]
fn round_trip_stamps_server_time_and_sorts_fences() {
    let (sealer, _) = sealer("new");
    let before = chrono::Utc::now().timestamp_millis();
    let token = sealer
        .seal("lambda:private", &[("z".into(), 900), ("a".into(), 1)])
        .unwrap();
    let receipt = sealer.open(&token).unwrap();
    let after = chrono::Utc::now().timestamp_millis();
    assert_eq!(receipt.namespace, "lambda:private");
    assert_eq!(receipt.fences, [("a".to_owned(), 1), ("z".to_owned(), 900)]);
    assert!((before..=after).contains(&receipt.issued_at));
    let envelope = URL_SAFE_NO_PAD.decode(&token).unwrap();
    let needle = b"lambda:private";
    assert!(!envelope
        .windows(needle.len())
        .any(|window| window == needle));
    let empty = sealer.open(&sealer.seal("local", &[]).unwrap()).unwrap();
    assert!(empty.fences.is_empty());
}

#[test]
fn rotation_keeps_old_key_decrypt_only() {
    let (old, _) = sealer("old");
    let (new, _) = sealer("new");
    let old_token = old.seal("local", &[("model".into(), 17)]).unwrap();
    let recovered = new.open(&old_token).unwrap();
    assert_eq!(recovered.fences, [("model".to_owned(), 17)]);
    let new_token = new.seal("local", &[]).unwrap();
    let envelope = URL_SAFE_NO_PAD.decode(new_token).unwrap();
    assert_eq!(&envelope[2..5], b"new");
}

#[test]
fn unknown_or_unavailable_key_is_typed_and_never_replaced() {
    let (valid, _) = sealer("new");
    let token = valid
        .seal("hidden-namespace", &[("hidden-model".into(), 834_827)])
        .unwrap();
    let mut envelope = URL_SAFE_NO_PAD.decode(&token).unwrap();
    envelope[2..5].copy_from_slice(b"who");
    let error = valid.open(&URL_SAFE_NO_PAD.encode(envelope)).err().unwrap();
    assert_eq!(error, ReceiptSealError::KeyUnavailable);
    let (missing, _) = sealer_with_keys("new", BTreeMap::new());
    assert_eq!(
        missing.open(&token).err(),
        Some(ReceiptSealError::KeyUnavailable)
    );
    assert_eq!(
        missing.seal("local", &[]),
        Err(ReceiptSealError::KeyUnavailable)
    );
    let diagnostic = format!("{error} {error:?}");
    for value in ["hidden-namespace", "hidden-model", "834827", &token] {
        assert!(!diagnostic.contains(value));
    }
}

#[test]
fn ciphertext_flip_and_appended_byte_fail_authentication() {
    let (sealer, _) = sealer("new");
    let token = sealer.seal("local", &[("model".into(), 1)]).unwrap();
    let envelope = URL_SAFE_NO_PAD.decode(token).unwrap();
    let mut flipped = envelope.clone();
    flipped[2 + 3 + NONCE_BYTES] ^= 0x80;
    let mut appended = envelope;
    appended.push(0);
    for invalid in [flipped, appended] {
        assert_eq!(
            sealer.open(&URL_SAFE_NO_PAD.encode(invalid)).err(),
            Some(ReceiptSealError::InvalidReceipt)
        );
    }
}

#[test]
fn repeated_seals_use_distinct_os_nonces() {
    let (sealer, _) = sealer("new");
    let first = URL_SAFE_NO_PAD
        .decode(sealer.seal("local", &[]).unwrap())
        .unwrap();
    let second = URL_SAFE_NO_PAD
        .decode(sealer.seal("local", &[]).unwrap())
        .unwrap();
    assert_ne!(&first[5..29], &second[5..29]);
}

#[test]
fn nonce_failure_refuses_sealing_without_fallback() {
    let (sealer, _) = sealer("new");
    assert_eq!(
        sealer.seal_with_nonce_source("local", &[], |_| Err(ReceiptSealError::NonceUnavailable)),
        Err(ReceiptSealError::NonceUnavailable)
    );
}

#[test]
fn associated_data_matches_independent_byte_vector() {
    // The expected bytes are independent of PURPOSE, VERSION and envelope encoding.
    assert_eq!(
        associated_data("key-7"),
        [
            0x6b, 0x68, 0x69, 0x76, 0x65, 0x2e, 0x6d, 0x65, 0x6d, 0x6f, 0x72, 0x79, 0x2e, 0x76,
            0x69, 0x73, 0x69, 0x62, 0x69, 0x6c, 0x69, 0x74, 0x79, 0x02, 0x05, 0x6b, 0x65, 0x79,
            0x2d, 0x37,
        ]
    );
}

fn authenticated_token(plaintext: &[u8], aad: &[u8]) -> String {
    let cipher = XChaCha20Poly1305::new_from_slice(&[19_u8; 32]).unwrap();
    // Test-only synthetic key/nonce. Production always obtains a fresh OS nonce.
    let nonce = [31_u8; 24];
    let mut body = plaintext.to_vec();
    let tag = cipher
        .encrypt_inout_detached(&XNonce::from(nonce), aad, body.as_mut_slice().into())
        .unwrap();
    let mut envelope = vec![2, 3, b'n', b'e', b'w'];
    envelope.extend_from_slice(&nonce);
    envelope.extend_from_slice(&body);
    envelope.extend_from_slice(&tag);
    URL_SAFE_NO_PAD.encode(envelope)
}

#[test]
fn opens_frozen_0_10_1_receipt() {
    // Frozen visibility receipt with synthetic key [19; 32] and nonce [31; 24],
    // independently reproduced with PyNaCl/libsodium XChaCha20-Poly1305 IETF.
    // Keep this literal and the expected fields unchanged across crypto upgrades.
    const FROZEN_TOKEN: &str = "AgNuZXcfHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx_0oaDgfrUt5o5cB8ZnR2i2KhRGGE83fiaSYLduVGBIgBnNszAwRYYOkQ";

    let receipt = sealer("new").0.open(FROZEN_TOKEN).unwrap();
    assert_eq!(receipt.namespace, "ns");
    assert_eq!(receipt.issued_at, 1);
    assert_eq!(receipt.fences, vec![("x".to_owned(), 9)]);
}

#[test]
fn frozen_0_10_1_receipt_rejects_body_tampering() {
    // Frozen envelope: 5-byte header, 24-byte nonce, 25-byte ciphertext, 16-byte tag.
    assert_frozen_receipt_tampering_is_refused(29..54);
}

#[test]
fn frozen_0_10_1_receipt_rejects_tag_tampering() {
    assert_frozen_receipt_tampering_is_refused(54..70);
}

fn assert_frozen_receipt_tampering_is_refused(offsets: std::ops::Range<usize>) {
    // Mutate the frozen compatibility vector, never a freshly sealed token.
    const FROZEN_TOKEN: &str = "AgNuZXcfHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx_0oaDgfrUt5o5cB8ZnR2i2KhRGGE83fiaSYLduVGBIgBnNszAwRYYOkQ";
    let envelope = URL_SAFE_NO_PAD.decode(FROZEN_TOKEN).unwrap();
    assert_eq!(envelope.len(), 70);
    let (sealer, _) = sealer("new");
    for offset in offsets {
        let mut tampered = envelope.clone();
        tampered[offset] ^= 1;
        assert_eq!(
            sealer.open(&URL_SAFE_NO_PAD.encode(tampered)).err(),
            Some(ReceiptSealError::InvalidReceipt),
            "frozen receipt byte {offset} was changed"
        );
    }
}

#[test]
fn open_authenticates_the_purpose_and_header_binding() {
    let (sealer, _) = sealer("new");
    let plain = encode_plaintext("local", 1, &[], 3).unwrap();
    for aad in [
        b"".as_slice(),
        b"khive.memory.visibility\x02\x03old",
        b"other.memory.visibility\x02\x03new",
    ] {
        let token = authenticated_token(&plain, aad);
        assert_eq!(
            sealer.open(&token).err(),
            Some(ReceiptSealError::InvalidReceipt)
        );
    }
    let token = authenticated_token(&plain, b"khive.memory.visibility\x02\x03new");
    assert_eq!(sealer.open(&token).unwrap().namespace, "local");
}

#[test]
fn structural_refusals_happen_before_provider_lookup() {
    let (sealer, lookups) = sealer("new");
    let token = sealer.seal("local", &[]).unwrap();
    let mut wrong_version = URL_SAFE_NO_PAD.decode(&token).unwrap();
    wrong_version[0] = 1;
    let mut invalid_id = wrong_version.clone();
    invalid_id[0] = 2;
    invalid_id[2] = b'/';
    let mut too_large = vec![0; MAX_ENVELOPE_BYTES + 1];
    too_large[..5].copy_from_slice(&[2, 3, b'n', b'e', b'w']);
    let mut short_body = vec![2, 3, b'n', b'e', b'w'];
    short_body.resize(5 + NONCE_BYTES + MIN_PLAINTEXT_BYTES + TAG_BYTES, 0);
    let count = lookups.load(Ordering::Relaxed);
    for malformed in [
        String::new(),
        "AgA".into(),
        format!("{token}="),
        format!(" {token}"),
        URL_SAFE_NO_PAD.encode(wrong_version),
        URL_SAFE_NO_PAD.encode(invalid_id),
        URL_SAFE_NO_PAD.encode([2, 65]),
        URL_SAFE_NO_PAD.encode(too_large),
        URL_SAFE_NO_PAD.encode([2, 3, b'n', b'e', b'w']),
        URL_SAFE_NO_PAD.encode(short_body),
        "A".repeat(MAX_ENCODED_BYTES + 1),
    ] {
        assert_eq!(
            sealer.open(&malformed).err(),
            Some(ReceiptSealError::InvalidReceipt)
        );
    }
    assert_eq!(lookups.load(Ordering::Relaxed), count);
}

#[test]
fn key_material_requires_canonical_encoding_and_exact_size() {
    for key in [
        "not-a-key".to_owned(),
        URL_SAFE_NO_PAD.encode([7_u8; 31]),
        URL_SAFE_NO_PAD.encode([7_u8; 33]),
        format!("{}=", URL_SAFE_NO_PAD.encode([7_u8; 32])),
    ] {
        let (sealer, _) =
            sealer_with_keys("new", [("new".into(), key.clone())].into_iter().collect());
        let error = sealer.seal("local", &[]).unwrap_err();
        assert_eq!(error, ReceiptSealError::KeyUnavailable);
        assert!(!format!("{error} {error:?}").contains(&key));
    }
}

#[test]
fn plaintext_layout_is_fixed_width_and_strictly_decoded() {
    let bytes = encode_plaintext("ns", 1, &[("x".into(), 9)], 3).unwrap();
    assert_eq!(
        &*bytes,
        &[0, 2, b'n', b's', 0, 0, 0, 0, 0, 0, 0, 1, 0, 1, 0, 1, b'x', 0, 0, 0, 0, 0, 0, 0, 9,]
    );
    let other = encode_plaintext("ns", 1, &[("x".into(), u64::MAX)], 3).unwrap();
    assert_eq!(bytes.len(), other.len());
    for cut in 0..bytes.len() {
        assert_eq!(
            decode_plaintext(&bytes[..cut]).err(),
            Some(ReceiptSealError::InvalidReceipt)
        );
    }
    let mut trailing = bytes.to_vec();
    trailing.push(0);
    let mut zero_sequence = bytes.to_vec();
    *zero_sequence.last_mut().unwrap() = 0;
    let mut invalid_utf8 = bytes.to_vec();
    invalid_utf8[2] = 0xff;
    let (sealer, _) = sealer("new");
    for invalid in [trailing, zero_sequence, invalid_utf8] {
        // Even valid authentication never admits invalid plaintext structure.
        let token = authenticated_token(&invalid, b"khive.memory.visibility\x02\x03new");
        assert_eq!(
            sealer.open(&token).err(),
            Some(ReceiptSealError::InvalidReceipt)
        );
    }
}

#[test]
fn fences_refuse_duplicates_zero_sequences_and_received_disorder() {
    for fences in [
        vec![("a".into(), 1), ("a".into(), 2)],
        vec![("a".into(), 0)],
    ] {
        assert!(matches!(
            encode_plaintext("ns", 1, &fences, 3),
            Err(ReceiptSealError::InvalidReceipt)
        ));
    }
    let mut bytes = encode_plaintext("ns", 1, &[("a".into(), 1), ("z".into(), 2)], 3).unwrap();
    bytes[16] = b'z';
    bytes[27] = b'a';
    assert_eq!(
        decode_plaintext(&bytes).err(),
        Some(ReceiptSealError::InvalidReceipt)
    );
    bytes[27] = b'z';
    assert_eq!(
        decode_plaintext(&bytes).err(),
        Some(ReceiptSealError::InvalidReceipt)
    );
}

#[test]
fn envelope_ceiling_is_enforced_before_large_allocation() {
    let (sealer, _) = sealer("new");
    // 54 + key-id(3) + namespace(2) + model framing(10) + model = 65,536.
    let model = "m".repeat(65_467);
    let token = sealer.seal("ns", &[(model.clone(), 1)]).unwrap();
    assert_eq!(
        URL_SAFE_NO_PAD.decode(&token).unwrap().len(),
        MAX_ENVELOPE_BYTES
    );
    assert_eq!(token.len(), MAX_ENCODED_BYTES);
    assert_eq!(sealer.open(&token).unwrap().fences[0].0, model);
    assert_eq!(
        sealer.seal("ns", &[(format!("{model}m"), 1)]),
        Err(ReceiptSealError::InvalidReceipt)
    );
}