revault_lockbox_api 0.0.49

reVault lockbox API to create and manage lockboxes
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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
use super::*;
use crate::file_format::allocation_map::{self as allocation, OwnedRecord, Snapshot, Transaction};
use crate::file_format::authenticated_index::{Entry, Index};
use crate::file_format::publication_anchor::{self as publication, Authority};
use crate::storage::StorageBackend;
use crate::{EncryptionMode, LockboxFormatOptions, OwnerSigningKeyPair, SigningMode, SizePadding};
const KEY: &[u8; 32] = &[91; 32];
fn archive() -> LockboxId {
    LockboxId::from_bytes([93; 16])
}
fn mode(encrypted: bool, signed: bool, compressed: bool, padded: bool) -> FormatMode {
    FormatMode::new(LockboxFormatOptions {
        encryption: if encrypted {
            EncryptionMode::ChaCha20Poly1305
        } else {
            EncryptionMode::None
        },
        signing: if signed {
            SigningMode::Owner
        } else {
            SigningMode::None
        },
        compression: if compressed {
            Compression::default()
        } else {
            Compression::None
        },
        size_padding: if padded {
            SizePadding::Default
        } else {
            SizePadding::None
        },
    })
}
fn key(mode: FormatMode) -> Option<&'static [u8]> {
    (!mode.plaintext()).then_some(KEY.as_slice())
}

#[test]
fn persisted_extents_round_trip_through_selected_ownership_all_modes_and_units() {
    let owner = OwnerSigningKeyPair::generate().unwrap();
    let public = owner.public_key();
    for encrypted in [false, true] {
        for signed in [false, true] {
            for compressed in [false, true] {
                for padded in [false, true] {
                    for unit in [65536, MAX_LOGICAL] {
                        let mode = mode(encrypted, signed, compressed, padded);
                        let authority = if signed {
                            Authority::Owner(&public)
                        } else if encrypted {
                            Authority::Symmetric(KEY)
                        } else {
                            Authority::Checksum
                        };
                        let signer = signed.then_some(&owner);
                        let codec = Codec::new(archive(), mode, key(mode)).unwrap();
                        let logical_unit = codec.logical_unit(unit).unwrap();
                        let content: Vec<_> = (0..logical_unit * 2 + 37)
                            .map(|i| ((i / 71 + i / 251) % 19) as u8)
                            .collect();
                        let mut storage = StorageBackend::memory(Vec::new());
                        allocation::create_empty(
                            &mut storage,
                            archive(),
                            mode,
                            &authority,
                            signer,
                            key(mode),
                        )
                        .unwrap();
                        let mut tx =
                            Transaction::begin(storage, archive(), mode, &authority, key(mode))
                                .unwrap();
                        let mut entries = Vec::new();
                        for (ordinal, plain) in content.chunks(logical_unit).enumerate() {
                            let (descriptor, bytes) = codec
                                .encode(
                                    [7; 16],
                                    ordinal as u64,
                                    (ordinal * logical_unit) as u64,
                                    plain,
                                )
                                .unwrap();
                            if padded {
                                assert_eq!(bytes.len() % PAD_UNIT, 0);
                            }
                            if !compressed {
                                assert!(bytes.len() <= 65536);
                            }
                            if compressed && plain.len() > 256 {
                                assert_eq!(descriptor.codec, COMPRESSION_ZSTD);
                            }
                            let extent = tx.append_encoded_extent(&bytes).unwrap();
                            let envelope =
                                OwnedRecord::encode(&descriptor.encode(), &[extent]).unwrap();
                            entries.push(
                                Entry::new(2, &(ordinal as u64).to_be_bytes(), &envelope).unwrap(),
                            );
                        }
                        tx.replace_all_sorted(entries.into_iter().map(Ok)).unwrap();
                        let (storage, committed) = tx.commit(&authority, signer).unwrap();
                        // Reopen separate bytes and authenticate membership before invoking codec.
                        let reopened = StorageBackend::memory(storage.read_all().unwrap());
                        let selected = publication::select(&reopened, archive(), mode, &authority)
                            .unwrap()
                            .anchor;
                        assert_eq!(selected, committed);
                        let index = Index::new(archive(), mode, key(mode)).unwrap();
                        Snapshot::inspect(&reopened, &selected, &index)
                            .unwrap()
                            .verify_reclaimed(&reopened)
                            .unwrap();
                        let mut decoder = Codec::new(archive(), mode, key(mode)).unwrap();
                        let mut decoded = Zeroizing::new(Vec::new());
                        index
                            .visit(&reopened, selected.index, selected.sealed_len, |entry| {
                                let record = OwnedRecord::decode(&entry.value)?;
                                let descriptor = Descriptor::decode(&record.metadata)?;
                                assert_eq!(descriptor.object, [7; 16]);
                                assert_eq!(
                                    descriptor.ordinal,
                                    u64::from_be_bytes(entry.key.as_slice().try_into().unwrap())
                                );
                                assert_eq!(descriptor.offset as usize, decoded.len());
                                decoded.extend_from_slice(&decoder.load(
                                    &reopened,
                                    record.extents[0],
                                    selected.sealed_len,
                                    &descriptor,
                                )?);
                                Ok(())
                            })
                            .unwrap();
                        assert_eq!(decoded.len(), content.len());
                        assert!(*decoded == content, "encrypted={encrypted},signed={signed},compressed={compressed},padded={padded},unit={unit},first mismatch={:?}", decoded.iter().zip(&content).position(|(a,b)|a!=b));
                    }
                }
            }
        }
    }
}

fn physical(mode: FormatMode, plain: &[u8]) -> (StorageBackend, Extent, Descriptor) {
    let codec = Codec::new(archive(), mode, key(mode)).unwrap();
    let (descriptor, bytes) = codec.encode([7; 16], 3, 256, plain).unwrap();
    let mut storage = StorageBackend::memory(vec![
        0;
        super::super::preparation_journal::DATA_START
            as usize
    ]);
    let start = storage.append(&bytes).unwrap();
    (
        storage,
        Extent {
            start,
            len: bytes.len() as u64,
            digest: strong_checksum(&bytes),
        },
        descriptor,
    )
}
#[test]
fn stored_commitment_and_encryption_context_prevent_substitution() {
    let mode = mode(true, true, true, true);
    let (storage, extent, descriptor) = physical(mode, &vec![0x41; 65536]);
    let sealed = storage.len().unwrap();
    let mut wrong_key = Codec::new(archive(), mode, Some(&[12; 32])).unwrap();
    assert!(wrong_key
        .load(&storage, extent, sealed, &descriptor)
        .is_err());
    let mut other_archive = Codec::new(LockboxId::from_bytes([33; 16]), mode, key(mode)).unwrap();
    assert!(other_archive
        .load(&storage, extent, sealed, &descriptor)
        .is_err());
    let mut codec = Codec::new(archive(), mode, key(mode)).unwrap();
    let mut substitutions = Vec::new();
    let mut wrong = descriptor.clone();
    wrong.object[0] ^= 1;
    substitutions.push(wrong);
    let mut wrong = descriptor.clone();
    wrong.ordinal += 1;
    substitutions.push(wrong);
    let mut wrong = descriptor.clone();
    wrong.offset += 1;
    substitutions.push(wrong);
    let mut wrong = descriptor.clone();
    wrong.logical_len -= 1;
    substitutions.push(wrong);
    for wrong in substitutions {
        assert!(codec.load(&storage, extent, sealed, &wrong).is_err());
    }
    for offset in [0, extent.len / 2, extent.len - 1] {
        let mut damaged = storage.clone();
        let byte = damaged.read_at(extent.start + offset, 1).unwrap()[0];
        damaged
            .write_at(extent.start + offset, &[byte ^ 0x80])
            .unwrap();
        assert!(codec.load(&damaged, extent, sealed, &descriptor).is_err());
    }
    let (mut neighbour, another, _) = physical(mode, &vec![0x41; 65536]);
    let replacement = neighbour
        .read_at(another.start, another.len as usize)
        .unwrap();
    // Random nonce changes stored commitment even for identical plaintext.
    assert_ne!(strong_checksum(&replacement), extent.digest);
    neighbour.write_at(another.start, &replacement).unwrap();
    assert!(codec.load(&neighbour, extent, sealed, &descriptor).is_err());
}

#[test]
fn malformed_descriptors_padding_and_oversized_codec_windows_are_rejected() {
    let mode = mode(false, false, true, true);
    let (mut storage, extent, descriptor) = physical(mode, &vec![0x31; 65536]);
    let mut codec = Codec::new(archive(), mode, None).unwrap();
    for length in [0, 1, 63, 65, 128] {
        assert!(Descriptor::decode(&vec![0; length]).is_err());
    }
    for offset in [0, 53, 63] {
        let mut bad = descriptor.encode();
        bad[offset] ^= 1;
        assert!(Descriptor::decode(&bad).is_err());
    }
    for wrong in [
        Descriptor {
            logical_len: MAX_LOGICAL as u32 + 1,
            ..descriptor.clone()
        },
        Descriptor {
            offset: u64::MAX,
            ..descriptor.clone()
        },
        Descriptor {
            encoded_len: u32::MAX,
            ..descriptor.clone()
        },
        Descriptor {
            allocation_len: u32::MAX,
            ..descriptor.clone()
        },
    ] {
        // Empty storage would return Truncated if reached; reject the descriptor first.
        assert!(matches!(
            codec.load(
                &StorageBackend::memory(Vec::new()),
                extent,
                u64::MAX,
                &wrong
            ),
            Err(Error::CorruptRecord)
        ));
    }
    storage
        .write_at(extent.start + extent.len - 1, &[1])
        .unwrap();
    let mutated = Extent {
        digest: strong_checksum(&storage.read_at(extent.start, extent.len as usize).unwrap()),
        ..extent
    };
    assert!(codec
        .load(&storage, mutated, storage.len().unwrap(), &descriptor)
        .is_err());
    // Valid Zstd magic, no content-size field, an enormous advertised window,
    // then an empty final raw block. Recompute the outer digest deliberately to
    // test the decoder boundary, not merely the stored-byte checksum rejection.
    let hostile = [0x28, 0xb5, 0x2f, 0xfd, 0, 0xff, 1, 0, 0];
    let mut bytes = vec![0; PAD_UNIT];
    bytes[..hostile.len()].copy_from_slice(&hostile);
    storage.write_at(extent.start, &bytes).unwrap();
    let hostile_descriptor = Descriptor {
        encoded_len: hostile.len() as u32,
        logical_len: MAX_LOGICAL as u32,
        ..descriptor
    };
    let hostile_extent = Extent {
        digest: strong_checksum(&bytes),
        ..extent
    };
    assert!(codec
        .load(
            &storage,
            hostile_extent,
            storage.len().unwrap(),
            &hostile_descriptor
        )
        .is_err());
    assert!(codec.scratch.len() < 8 * 1024 * 1024);
    assert!(codec.logical_unit(32768).is_err());
    assert!(codec.encode([0; 16], 0, 0, b"invalid identity").is_err());
    assert!(codec.encode([7; 16], 0, 0, &[]).is_err());
    assert!(codec
        .encode([7; 16], 0, 0, &vec![0; MAX_LOGICAL + 1])
        .is_err());
}

#[test]
fn repeated_decoder_matches_fresh_decoder_for_independent_extent_streams() {
    let mode = mode(false, false, true, false);
    let codec = Codec::new(archive(), mode, None).unwrap();
    let mut reused = Codec::new(archive(), mode, None).unwrap();
    for ordinal in 0..3u64 {
        let plain: Vec<_> = (ordinal * 65536..(ordinal + 1) * 65536)
            .map(|i| ((i / 71 + i / 251) % 19) as u8)
            .collect();
        let (descriptor, bytes) = codec
            .encode([7; 16], ordinal, ordinal * 65536, &plain)
            .unwrap();
        let encoded = &bytes[..descriptor.encoded_len as usize];
        let ordinary = crate::compression::decode_compression_frame(
            descriptor.codec,
            encoded,
            plain.len() as u64,
        )
        .unwrap();
        let mut storage = StorageBackend::memory(vec![
            0;
            super::super::preparation_journal::DATA_START
                as usize
        ]);
        let extent = Extent {
            start: storage.append(&bytes).unwrap(),
            len: bytes.len() as u64,
            digest: strong_checksum(&bytes),
        };
        let actual = reused
            .load(&storage, extent, storage.len().unwrap(), &descriptor)
            .unwrap();
        if let Some(directory) = std::env::var_os("REVAULT_EXTENT_DIAGNOSTIC") {
            let directory = std::path::PathBuf::from(directory);
            std::fs::write(directory.join(format!("extent-{ordinal}.expected")), &plain).unwrap();
            std::fs::write(directory.join(format!("extent-{ordinal}.zst")), encoded).unwrap();
            std::fs::write(
                directory.join(format!("extent-{ordinal}.ordinary")),
                &ordinary,
            )
            .unwrap();
            std::fs::write(
                directory.join(format!("extent-{ordinal}.bounded")),
                &*actual,
            )
            .unwrap();
        }
        assert!(
            ordinary == plain,
            "ordinary decoder mismatch at extent {ordinal}"
        );
        assert!(
            *actual == plain,
            "bounded decoder mismatch at extent {ordinal}"
        );
    }
}

#[test]
fn raw_extent_budget_includes_encryption_and_rejects_oversized_packs() {
    for encrypted in [false, true] {
        let mode = mode(encrypted, false, false, true);
        let codec = Codec::new(archive(), mode, key(mode)).unwrap();
        let unit = codec.logical_unit(MAX_LOGICAL).unwrap();
        assert!(codec.encode([7; 16], 0, 0, &vec![1; unit + 1]).is_err());
        let (descriptor, stored) = codec.encode([7; 16], 0, 0, &vec![1; unit]).unwrap();
        assert!(stored.len() <= 65536);
        let mut oversized = descriptor;
        oversized.logical_len += 4096;
        oversized.encoded_len += 4096;
        oversized.allocation_len += 65536;
        let extent = Extent {
            start: super::super::preparation_journal::DATA_START,
            len: oversized.allocation_len as u64,
            digest: [0; 32],
        };
        assert!(codec.validate_extent(extent, u64::MAX, &oversized).is_err());
    }
}

#[test]
fn packed_codec_and_padding_contexts_are_distinct_and_bounded() {
    let mode = mode(true, true, true, false);
    let mut packed = Codec::packed(archive(), mode, key(mode)).unwrap();
    let mut standalone = Codec::new(archive(), mode, key(mode)).unwrap();
    let (descriptor, bytes) = packed
        .encode([7; 16], 0, 0, b"independent fragment")
        .unwrap();
    let mut storage = StorageBackend::memory(vec![
        0;
        super::super::preparation_journal::DATA_START
            as usize
    ]);
    let start = storage.append(&bytes).unwrap();
    let extent = Extent {
        start,
        len: bytes.len() as u64,
        digest: strong_checksum(&bytes),
    };
    assert!(standalone
        .load(&storage, extent, storage.len().unwrap(), &descriptor)
        .is_err());
    assert!(
        packed.verify_pack_padding(&bytes).is_err(),
        "file ciphertext must not be accepted as empty padding"
    );
    assert_eq!(
        &**packed
            .load(&storage, extent, storage.len().unwrap(), &descriptor)
            .unwrap(),
        b"independent fragment"
    );
    let padded_mode = super::tests::mode(true, true, true, true);
    let padded = Codec::packed(archive(), padded_mode, key(padded_mode)).unwrap();
    for used in [
        1,
        65508,
        65509,
        65535,
        65536,
        65537,
        MAX_LOGICAL - 1,
        MAX_LOGICAL + 28,
    ] {
        let total = padded.pack_padded_len(used).unwrap();
        assert_eq!(total % 65536, 0);
        assert!(total <= MAX_ALLOCATION);
        let padding = padded.pack_padding(total - used).unwrap();
        padded.verify_pack_padding(&padding).unwrap();
        if !padding.is_empty() {
            assert!(standalone.verify_pack_padding(&padding).is_err());
        }
    }
}

#[test]
fn raw_visit_reuses_only_wiped_bytes_and_recovers_from_failures() {
    // Private codec fixture: no public CLI exposes experimental buffer state or
    // partial storage callbacks. Stored fragments still use the real encoder.
    use std::cell::Cell;
    #[derive(Clone, Debug)]
    struct Partial {
        storage: StorageBackend,
        fail: Cell<bool>,
    }
    impl Storage for Partial {
        fn len(&self) -> Result<u64> {
            self.storage.len()
        }
        fn read_at(&self, offset: u64, len: usize) -> Result<Vec<u8>> {
            self.storage.read_at(offset, len)
        }
        fn read_at_into(&self, offset: u64, out: &mut [u8]) -> Result<()> {
            if self.fail.replace(false) {
                let len = out.len().min(17);
                out[..len].fill(71);
                return Err(Error::Io("injected partial read".into()));
            }
            self.storage.read_at_into(offset, out)
        }
        fn append(&mut self, bytes: &[u8]) -> Result<u64> {
            self.storage.append(bytes)
        }
        fn write_at(&mut self, offset: u64, bytes: &[u8]) -> Result<()> {
            self.storage.write_at(offset, bytes)
        }
        fn truncate(&mut self, len: u64) -> Result<()> {
            self.storage.truncate(len)
        }
        fn sync(&self) -> Result<()> {
            self.storage.sync()
        }
    }
    for compressed in [false, true] {
        for signed in [false, true] {
            for padded in [false, true] {
                let mode = mode(false, signed, compressed, padded);
                let mut codec = Codec::shared_packed(archive(), mode, None).unwrap();
                let mut storage = Partial {
                    storage: StorageBackend::memory(vec![0; publication::REGION_LEN]),
                    fail: Cell::new(false),
                };
                let sizes = if compressed {
                    vec![65536, 196608, 262144, 17, 4096, 262144]
                } else {
                    vec![65536, 17, 4096, 65536]
                };
                for size in sizes {
                    // Deterministic incompressible bytes exercise the raw fallback
                    // in compression-enabled mode at its larger fragment bound.
                    let mut state = 0x819af132b61480d9u64;
                    let plain: Vec<u8> = (0..size)
                        .map(|_| {
                            state ^= state << 13;
                            state ^= state >> 7;
                            state ^= state << 17;
                            state as u8
                        })
                        .collect();
                    let (descriptor, bytes) = codec.encode([81; 16], 0, 0, &plain).unwrap();
                    assert_eq!(descriptor.codec, COMPRESSION_NONE);
                    let start = storage.append(&bytes).unwrap();
                    let extent = allocation::Extent {
                        start,
                        len: bytes.len() as u64,
                        digest: strong_checksum(&bytes),
                    };
                    let sealed = storage.len().unwrap();
                    codec
                        .with_loaded(&storage, extent, sealed, &descriptor, |loaded| {
                            assert_eq!(loaded, plain);
                            Ok(())
                        })
                        .unwrap();
                    assert!(codec.raw_scratch.iter().all(|b| *b == 0));
                    assert!(codec.raw_scratch.capacity() <= MAX_ALLOCATION);
                    let capacity = codec.raw_scratch.capacity();
                    storage.fail.set(true);
                    let mut exposed = false;
                    assert!(codec
                        .with_loaded(&storage, extent, sealed, &descriptor, |_| {
                            exposed = true;
                            Ok(())
                        })
                        .is_err());
                    assert!(!exposed);
                    assert!(codec.raw_scratch.iter().all(|b| *b == 0));
                    assert!(codec
                        .with_loaded::<()>(&storage, extent, sealed, &descriptor, |_| Err(
                            Error::CorruptRecord
                        ))
                        .is_err());
                    assert!(codec.raw_scratch.iter().all(|b| *b == 0));
                    assert!(codec
                        .with_loaded(
                            &storage,
                            allocation::Extent {
                                digest: [0; 32],
                                ..extent
                            },
                            sealed,
                            &descriptor,
                            |_| {
                                exposed = true;
                                Ok(())
                            }
                        )
                        .is_err());
                    assert!(!exposed);
                    assert!(codec.raw_scratch.iter().all(|b| *b == 0));
                    assert_eq!(codec.raw_scratch.capacity(), capacity);
                    let caught = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
                        codec.with_loaded::<()>(&storage, extent, sealed, &descriptor, |_| {
                            panic!("injected visitor unwind")
                        })
                    }));
                    assert!(caught.is_err());
                    assert!(codec.raw_scratch.is_empty());
                    codec
                        .with_loaded(&storage, extent, sealed, &descriptor, |loaded| {
                            assert_eq!(loaded, plain);
                            Ok(())
                        })
                        .unwrap();
                    assert!(codec.raw_scratch.iter().all(|b| *b == 0));
                }
            }
        }
    }
}

#[test]
fn raw_visit_still_refuses_authenticated_nonzero_internal_padding() {
    let mode = mode(false, true, false, true);
    let mut codec = Codec::new(archive(), mode, None).unwrap();
    let (descriptor, mut bytes) = codec.encode([82; 16], 0, 0, b"short plaintext").unwrap();
    assert!(bytes.len() > descriptor.encoded_len as usize);
    *bytes.last_mut().unwrap() = 1;
    let mut storage = StorageBackend::memory(vec![
        0;
        super::super::preparation_journal::DATA_START
            as usize
    ]);
    let start = storage.append(&bytes).unwrap();
    let extent = allocation::Extent {
        start,
        len: bytes.len() as u64,
        digest: strong_checksum(&bytes),
    };
    let mut exposed = false;
    assert!(codec
        .with_loaded(
            &storage,
            extent,
            storage.len().unwrap(),
            &descriptor,
            |_| {
                exposed = true;
                Ok(())
            }
        )
        .is_err());
    assert!(!exposed);
    assert!(codec.raw_scratch.iter().all(|b| *b == 0));
}