revault_lockbox_api 0.0.48

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
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
//! Candidate ordered membership index with packed, mirrored copy-on-write pages.
//! Publication selects the root; preparing an index never authorizes its contents.
use super::publication_anchor::{RootRef, REGION_LEN};
use crate::creation_options::FormatMode;
use crate::crypto::{open_with_nonce, seal_with_random_nonce, strong_checksum};
use crate::page_buffer::ZeroizingBytes;
use crate::storage::Storage;
use crate::{Error, LockboxId, Result};
use sha2::Sha256;
use zeroize::Zeroizing;

mod cache;
pub(crate) use cache::PageCache;
mod borrowed;
pub(crate) use borrowed::{EntryRef, VisitRef};

const MAGIC: &[u8; 8] = b"RV4IDX02";
const HEADER: usize = 44;
const MAX_NODE: usize = 65536;
const BODY_HEADER: usize = 11;
// Use the same packing capacity in every protection mode.
const MAX_BODY: usize = MAX_NODE - HEADER - 16;
const MAX_ITEMS: usize = 1024;
const MAX_HEIGHT: u8 = 32;
const MAX_KEY: usize = 4096;
const MAX_VALUE: usize = 49152;
const MAX_ENTRIES: u64 = 1_000_000;

pub(crate) enum Visit {
    Page(RootRef),
    Entry(Entry),
}

#[derive(Clone)]
pub(crate) struct Entry {
    pub namespace: u8,
    pub key: Zeroizing<Vec<u8>>,
    pub value: Zeroizing<Vec<u8>>,
}
impl Entry {
    pub(crate) fn new(namespace: u8, key: &[u8], value: &[u8]) -> Result<Self> {
        validate_input(key, value)?;
        Ok(Self {
            namespace,
            key: Zeroizing::new(key.to_vec()),
            value: Zeroizing::new(value.to_vec()),
        })
    }
    fn identity(&self) -> (u8, &[u8]) {
        (self.namespace, &self.key)
    }
    fn size(&self) -> usize {
        7 + self.key.len() + self.value.len()
    }
}
#[derive(Clone)]
struct Key {
    namespace: u8,
    bytes: Zeroizing<Vec<u8>>,
}
impl Key {
    fn new(identity: (u8, &[u8])) -> Self {
        Self {
            namespace: identity.0,
            bytes: Zeroizing::new(identity.1.to_vec()),
        }
    }
    fn identity(&self) -> (u8, &[u8]) {
        (self.namespace, &self.bytes)
    }
}
#[derive(Clone)]
struct Link {
    reference: RootRef,
    count: u64,
    first: Key,
}
impl Link {
    fn size(&self) -> usize {
        67 + self.first.bytes.len()
    }
}
#[derive(Clone)]
enum Node {
    Leaf(Vec<Entry>),
    Branch { height: u8, children: Vec<Link> },
}
impl Node {
    fn count(&self) -> u64 {
        match self {
            Self::Leaf(entries) => entries.len() as u64,
            Self::Branch { children, .. } => children.iter().map(|c| c.count).sum(),
        }
    }
    fn height(&self) -> u8 {
        match self {
            Self::Leaf(_) => 0,
            Self::Branch { height, .. } => *height,
        }
    }
    fn first(&self) -> Option<(u8, &[u8])> {
        match self {
            Self::Leaf(entries) => entries.first().map(Entry::identity),
            Self::Branch { children, .. } => children.first().map(|c| c.first.identity()),
        }
    }
    fn last(&self) -> Option<(u8, &[u8])> {
        match self {
            Self::Leaf(entries) => entries.last().map(Entry::identity),
            Self::Branch { children, .. } => children.last().map(|c| c.first.identity()),
        }
    }
    fn body_len(&self) -> usize {
        BODY_HEADER
            + match self {
                Self::Leaf(entries) => entries.iter().map(Entry::size).sum::<usize>(),
                Self::Branch { children, .. } => children.iter().map(Link::size).sum(),
            }
    }
    fn item_count(&self) -> usize {
        match self {
            Self::Leaf(entries) => entries.len(),
            Self::Branch { children, .. } => children.len(),
        }
    }
    fn pack(self) -> Vec<Self> {
        match self {
            Self::Leaf(entries) => pack(entries, Entry::size)
                .into_iter()
                .map(Self::Leaf)
                .collect(),
            Self::Branch { height, children } => pack(children, Link::size)
                .into_iter()
                .map(|children| Self::Branch { height, children })
                .collect(),
        }
    }
    fn append(&mut self, other: Self) -> Result<()> {
        match (self, other) {
            (Self::Leaf(left), Self::Leaf(mut right)) => left.append(&mut right),
            (
                Self::Branch { height, children },
                Self::Branch {
                    height: other_height,
                    children: mut other,
                },
            ) if *height == other_height => children.append(&mut other),
            _ => return Err(Error::CorruptRecord),
        }
        Ok(())
    }
}

/// An error can leave a partial pair. Track the entire preparation range, not
/// just `created`. `retired` also includes superseded unpublished nodes. Erasure
/// requires a successfully synchronized mirrored publication, never just a root.
pub(crate) struct Change {
    pub root: RootRef,
    pub created: Vec<RootRef>,
    pub retired: Vec<RootRef>,
}
impl Change {
    fn new(root: RootRef) -> Self {
        Self {
            root,
            created: Vec::new(),
            retired: Vec::new(),
        }
    }
}

pub(crate) struct RecoveryReport {
    pub recovered: u64,
    pub unavailable: u64,
    pub damaged_pages: Vec<RootRef>,
}

pub(crate) struct Index {
    archive: LockboxId,
    mode: FormatMode,
    key: Option<Zeroizing<[u8; 32]>>,
}
impl Index {
    pub(crate) fn new(archive: LockboxId, mode: FormatMode, key: Option<&[u8]>) -> Result<Self> {
        FormatMode::parse(mode.0)?;
        if mode.plaintext() != key.is_none() || key.is_some_and(|k| k.len() != 32) {
            return Err(Error::InvalidKey);
        }
        let key = key.map(|key| {
            let mut derived = Zeroizing::new([0; 32]);
            hkdf::Hkdf::<Sha256>::new(Some(archive.as_bytes()), key)
                .expand(b"revault-candidate-packed-index-key-v1\0", &mut *derived)
                .expect("fixed SHA-256 key length");
            derived
        });
        Ok(Self { archive, mode, key })
    }
    pub(crate) fn empty(&self, storage: &mut impl Storage) -> Result<RootRef> {
        Ok(self.write(storage, &Node::Leaf(Vec::new()))?.reference)
    }
    pub(crate) fn get(
        &self,
        storage: &impl Storage,
        root: RootRef,
        sealed: u64,
        namespace: u8,
        key: &[u8],
    ) -> Result<Option<Entry>> {
        validate_input(key, &[])?;
        let identity = (namespace, key);
        let mut node = self.read(storage, root, sealed)?;
        let mut upper: Option<Key> = None;
        loop {
            match node {
                Node::Leaf(entries) => {
                    return Ok(entries
                        .binary_search_by(|e| e.identity().cmp(&identity))
                        .ok()
                        .map(|i| entries[i].clone()))
                }
                Node::Branch { height, children } => {
                    let position = children.partition_point(|c| c.first.identity() <= identity);
                    if position == 0 {
                        return Ok(None);
                    }
                    let position = position - 1;
                    if let Some(next) = children.get(position + 1) {
                        upper = Some(next.first.clone());
                    }
                    node =
                        self.child(storage, &children[position], height, sealed, upper.as_ref())?;
                }
            }
        }
    }

    pub(crate) fn put(
        &self,
        storage: &mut impl Storage,
        root: RootRef,
        sealed: u64,
        entry: Entry,
    ) -> Result<Change> {
        validate_input(&entry.key, &entry.value)?;
        self.mutate(storage, root, sealed, entry.identity(), Some(&entry))
    }
    pub(crate) fn remove(
        &self,
        storage: &mut impl Storage,
        root: RootRef,
        sealed: u64,
        namespace: u8,
        key: &[u8],
    ) -> Result<Change> {
        validate_input(key, &[])?;
        self.mutate(storage, root, sealed, (namespace, key), None)
    }
    fn mutate(
        &self,
        storage: &mut impl Storage,
        root: RootRef,
        sealed: u64,
        identity: (u8, &[u8]),
        replacement: Option<&Entry>,
    ) -> Result<Change> {
        let node = self.read(storage, root, sealed)?;
        let mut change = Change::new(root);
        let Some(mut nodes) = self.edit(
            storage,
            root,
            node,
            sealed,
            None,
            identity,
            replacement,
            &mut change,
        )?
        else {
            return Ok(change);
        };
        if nodes.len() > 1 {
            let height = nodes[0]
                .height()
                .checked_add(1)
                .ok_or(Error::CorruptRecord)?;
            if height > MAX_HEIGHT {
                return Err(Error::SecurityLimitExceeded("index height limit".into()));
            }
            let children = nodes
                .iter()
                .map(|node| self.write_tracked(storage, node, &mut change))
                .collect::<Result<Vec<_>>>()?;
            nodes = vec![Node::Branch { height, children }];
        }
        let node = nodes.pop().unwrap_or(Node::Leaf(Vec::new()));
        // Collapse unary roots without adding another unnecessary root page.
        if let Node::Branch { ref children, .. } = node {
            if children.len() == 1 {
                let mut link = children[0].clone();
                let mut parent_height = node.height();
                loop {
                    let child = self.child(storage, &link, parent_height, storage.len()?, None)?;
                    if let Node::Branch { height, children } = child {
                        if children.len() == 1 {
                            change.retired.push(link.reference);
                            link = children[0].clone();
                            parent_height = height;
                            continue;
                        }
                    }
                    change.root = link.reference;
                    return Ok(change);
                }
            }
        }
        change.root = self.write_tracked(storage, &node, &mut change)?.reference;
        Ok(change)
    }
    #[allow(clippy::too_many_arguments)]
    fn edit(
        &self,
        storage: &mut impl Storage,
        old: RootRef,
        node: Node,
        sealed: u64,
        upper: Option<&Key>,
        identity: (u8, &[u8]),
        replacement: Option<&Entry>,
        change: &mut Change,
    ) -> Result<Option<Vec<Node>>> {
        let next = match node {
            Node::Leaf(mut entries) => {
                match (
                    entries.binary_search_by(|e| e.identity().cmp(&identity)),
                    replacement,
                ) {
                    (Ok(i), Some(entry)) => {
                        if entries[i].value == entry.value {
                            return Ok(None);
                        }
                        entries[i] = entry.clone();
                    }
                    (Err(i), Some(entry)) => entries.insert(i, entry.clone()),
                    (Ok(i), None) => {
                        entries.remove(i);
                    }
                    (Err(_), None) => return Ok(None),
                }
                Node::Leaf(entries)
            }
            Node::Branch {
                height,
                mut children,
            } => {
                let position = children
                    .partition_point(|c| c.first.identity() <= identity)
                    .saturating_sub(1);
                let bound = children.get(position + 1).map(|c| &c.first).or(upper);
                let child = self.child(storage, &children[position], height, sealed, bound)?;
                let Some(mut changed) = self.edit(
                    storage,
                    children[position].reference,
                    child,
                    sealed,
                    bound,
                    identity,
                    replacement,
                    change,
                )?
                else {
                    return Ok(None);
                };
                let mut start = position;
                let mut end = position + 1;
                // Merge/rebalance an underfilled child with one adjacent sibling.
                // Newly produced pages remain in memory until this is decided.
                if changed.len() == 1 && changed[0].body_len() < MAX_BODY / 3 && children.len() > 1
                {
                    let sibling = if position > 0 {
                        position - 1
                    } else {
                        position + 1
                    };
                    let bound = children.get(sibling + 1).map(|c| &c.first).or(upper);
                    let neighbor =
                        self.child(storage, &children[sibling], height, sealed, bound)?;
                    let combined = if sibling < position {
                        let mut combined = neighbor;
                        combined.append(changed.remove(0))?;
                        combined
                    } else {
                        let mut combined = changed.remove(0);
                        combined.append(neighbor)?;
                        combined
                    };
                    changed = combined.pack();
                    change.retired.push(children[sibling].reference);
                    start = start.min(sibling);
                    end = end.max(sibling + 1);
                }
                let links = changed
                    .iter()
                    .filter(|node| node.count() > 0)
                    .map(|node| self.write_tracked(storage, node, change))
                    .collect::<Result<Vec<_>>>()?;
                children.splice(start..end, links);
                Node::Branch { height, children }
            }
        };
        if next.count() > MAX_ENTRIES {
            return Err(Error::SecurityLimitExceeded("index entry limit".into()));
        }
        change.retired.push(old);
        Ok(Some(if next.count() == 0 {
            Vec::new()
        } else {
            next.pack()
        }))
    }

    /// Bound bulk-build bytes when every key/value has the supplied fixed size.
    /// Includes both copies and every branch, with the current padding policy.
    pub(crate) fn fixed_record_size_bound(
        &self,
        count: u64,
        key_len: usize,
        value_len: usize,
    ) -> Result<u64> {
        Ok(self.fixed_record_geometry(count, key_len, value_len)?.0)
    }
    pub(crate) fn fixed_record_node_bound(
        &self,
        count: u64,
        key_len: usize,
        value_len: usize,
    ) -> Result<u64> {
        Ok(self.fixed_record_geometry(count, key_len, value_len)?.1)
    }
    fn fixed_record_geometry(
        &self,
        count: u64,
        key_len: usize,
        value_len: usize,
    ) -> Result<(u64, u64)> {
        if count > MAX_ENTRIES || key_len > MAX_KEY || value_len > MAX_VALUE {
            return Err(Error::SecurityLimitExceeded("bulk size bound".into()));
        }
        let mut item_size = 7 + key_len + value_len;
        let mut capacity = ((MAX_BODY - BODY_HEADER) / item_size).min(MAX_ITEMS) as u64;
        if capacity == 0 {
            return Err(Error::CorruptRecord);
        }
        let mut items = count;
        let mut total = 0;
        let mut nodes = 0;
        loop {
            let pages = items.div_ceil(capacity).max(1);
            let bytes = if self.mode.unpadded() {
                pages * (HEADER + BODY_HEADER + if self.key.is_some() { 16 } else { 0 }) as u64
                    + items * item_size as u64
            } else {
                pages * MAX_NODE as u64
            };
            total += 2 * bytes;
            nodes += pages;
            if pages == 1 {
                return Ok((total, nodes));
            }
            items = pages;
            item_size = 67 + key_len;
            capacity = ((MAX_BODY - BODY_HEADER) / item_size).min(MAX_ITEMS) as u64;
            if capacity < 2 {
                return Err(Error::CorruptRecord);
            }
        }
    }

    /// One pass over strictly increasing (namespace, key) input. At most a leaf
    /// and one incomplete branch per level are buffered, plus allocation receipts.
    pub(crate) fn build_sorted(
        &self,
        storage: &mut impl Storage,
        entries: impl IntoIterator<Item = Result<Entry>>,
    ) -> Result<Change> {
        let mut change = Change::new(RootRef::default());
        let mut leaf = Vec::new();
        let mut size = BODY_HEADER;
        let mut frontier: Vec<Vec<Link>> = Vec::new();
        let mut previous: Option<Key> = None;
        let mut count = 0u64;
        for entry in entries {
            let entry = entry?;
            validate_input(&entry.key, &entry.value)?;
            if previous
                .as_ref()
                .is_some_and(|p| p.identity() >= entry.identity())
            {
                return Err(Error::InvalidInput(
                    "bulk index input must have strictly increasing identities".into(),
                ));
            }
            count += 1;
            if count > MAX_ENTRIES {
                return Err(Error::SecurityLimitExceeded("index entry limit".into()));
            }
            previous = Some(Key::new(entry.identity()));
            if size + entry.size() > MAX_BODY || leaf.len() == MAX_ITEMS {
                let link = self.write_tracked(
                    storage,
                    &Node::Leaf(std::mem::take(&mut leaf)),
                    &mut change,
                )?;
                self.push_frontier(storage, &mut frontier, 0, link, &mut change)?;
                size = BODY_HEADER;
            }
            size += entry.size();
            leaf.push(entry);
        }
        if leaf.is_empty() && count == 0 {
            change.root = self
                .write_tracked(storage, &Node::Leaf(leaf), &mut change)?
                .reference;
            return Ok(change);
        }
        if !leaf.is_empty() {
            let link = self.write_tracked(storage, &Node::Leaf(leaf), &mut change)?;
            self.push_frontier(storage, &mut frontier, 0, link, &mut change)?;
        }
        for level in 0..=MAX_HEIGHT as usize {
            if level >= frontier.len() {
                return Err(Error::CorruptRecord);
            }
            let children = std::mem::take(&mut frontier[level]);
            if children.is_empty() {
                continue;
            }
            let higher_empty = frontier.iter().skip(level + 1).all(Vec::is_empty);
            if children.len() == 1 && higher_empty {
                change.root = children[0].reference;
                return Ok(change);
            }
            let height = (level + 1) as u8;
            if height > MAX_HEIGHT {
                return Err(Error::CorruptRecord);
            }
            let link =
                self.write_tracked(storage, &Node::Branch { height, children }, &mut change)?;
            self.push_frontier(storage, &mut frontier, level + 1, link, &mut change)?;
        }
        Err(Error::CorruptRecord)
    }
    fn push_frontier(
        &self,
        storage: &mut impl Storage,
        frontier: &mut Vec<Vec<Link>>,
        level: usize,
        link: Link,
        change: &mut Change,
    ) -> Result<()> {
        if level > MAX_HEIGHT as usize {
            return Err(Error::SecurityLimitExceeded("index height limit".into()));
        }
        if frontier.len() <= level {
            frontier.resize_with(level + 1, Vec::new);
        }
        let size = BODY_HEADER + frontier[level].iter().map(Link::size).sum::<usize>();
        if size + link.size() > MAX_BODY || frontier[level].len() == MAX_ITEMS {
            let children = std::mem::take(&mut frontier[level]);
            let parent = self.write_tracked(
                storage,
                &Node::Branch {
                    height: (level + 1) as u8,
                    children,
                },
                change,
            )?;
            self.push_frontier(storage, frontier, level + 1, parent, change)?;
        }
        frontier[level].push(link);
        Ok(())
    }

    pub(crate) fn visit(
        &self,
        storage: &impl Storage,
        root: RootRef,
        sealed: u64,
        visitor: impl FnMut(Entry) -> Result<()>,
    ) -> Result<()> {
        self.visit_range(storage, root, sealed, None, None, visitor)
    }
    /// Ordered half-open range; bounds refer to (namespace, key). Unrelated
    /// subtrees are skipped, so directory/prefix queries need no second index.
    pub(crate) fn visit_range(
        &self,
        storage: &impl Storage,
        root: RootRef,
        sealed: u64,
        start: Option<(u8, &[u8])>,
        end: Option<(u8, &[u8])>,
        mut visitor: impl FnMut(Entry) -> Result<()>,
    ) -> Result<()> {
        if start.zip(end).is_some_and(|(start, end)| start > end) {
            return Err(Error::InvalidInput("inverted index range".into()));
        }
        let node = self.read(storage, root, sealed)?;
        self.visit_node(
            storage,
            node,
            sealed,
            None,
            start,
            end,
            &mut |event| match event {
                Visit::Page(_) => Ok(()),
                Visit::Entry(entry) => visitor(entry),
            },
        )
    }
    /// Enumerate authenticated records and every reachable page pair in one walk.
    /// The caller must discard partial results if any callback or child fails.
    pub(crate) fn visit_owned(
        &self,
        storage: &impl Storage,
        root: RootRef,
        sealed: u64,
        mut visitor: impl FnMut(Visit) -> Result<()>,
    ) -> Result<()> {
        let node = self.read(storage, root, sealed)?;
        visitor(Visit::Page(root))?;
        self.visit_node(storage, node, sealed, None, None, None, &mut visitor)
    }
    #[allow(clippy::too_many_arguments)]
    fn visit_node(
        &self,
        storage: &impl Storage,
        node: Node,
        sealed: u64,
        upper: Option<&Key>,
        start: Option<(u8, &[u8])>,
        end: Option<(u8, &[u8])>,
        visitor: &mut impl FnMut(Visit) -> Result<()>,
    ) -> Result<()> {
        match node {
            Node::Leaf(entries) => {
                for entry in entries {
                    if start.is_none_or(|s| entry.identity() >= s)
                        && end.is_none_or(|e| entry.identity() < e)
                    {
                        visitor(Visit::Entry(entry))?;
                    }
                }
            }
            Node::Branch { height, children } => {
                for (position, link) in children.iter().enumerate() {
                    let bound = children.get(position + 1).map(|c| &c.first).or(upper);
                    if end.is_some_and(|e| link.first.identity() >= e)
                        || start.is_some_and(|s| bound.is_some_and(|b| b.identity() <= s))
                    {
                        continue;
                    }
                    let child = self.child(storage, link, height, sealed, bound)?;
                    visitor(Visit::Page(link.reference))?;
                    self.visit_node(storage, child, sealed, bound, start, end, visitor)?;
                }
            }
        }
        Ok(())
    }
    /// Salvage membership from the selected root without requiring unrelated
    /// pages to be readable. Missing authenticated subtrees are reported, never
    /// replaced by an older tree. I/O, key and visitor errors remain fatal.
    pub(crate) fn recover(
        &self,
        storage: &impl Storage,
        root: RootRef,
        sealed: u64,
        mut visitor: impl FnMut(Entry) -> Result<()>,
    ) -> Result<RecoveryReport> {
        let node = self.read(storage, root, sealed)?;
        let expected = node.count();
        let mut report = RecoveryReport {
            recovered: 0,
            unavailable: 0,
            damaged_pages: Vec::new(),
        };
        self.recover_node(storage, node, sealed, None, &mut visitor, &mut report)?;
        if report.recovered + report.unavailable != expected {
            return Err(Error::CorruptRecord);
        }
        Ok(report)
    }
    fn recover_node(
        &self,
        storage: &impl Storage,
        node: Node,
        sealed: u64,
        upper: Option<&Key>,
        visitor: &mut impl FnMut(Entry) -> Result<()>,
        report: &mut RecoveryReport,
    ) -> Result<()> {
        match node {
            Node::Leaf(entries) => {
                for entry in entries {
                    visitor(entry)?;
                    report.recovered += 1;
                }
            }
            Node::Branch { height, children } => {
                for (position, link) in children.iter().enumerate() {
                    let bound = children.get(position + 1).map(|c| &c.first).or(upper);
                    match self.child(storage, link, height, sealed, bound) {
                        Ok(child) => {
                            self.recover_node(storage, child, sealed, bound, visitor, report)?
                        }
                        Err(Error::CorruptRecord | Error::CorruptHeader | Error::Truncated) => {
                            report.unavailable += link.count;
                            report.damaged_pages.push(link.reference);
                        }
                        Err(error) => return Err(error),
                    }
                }
            }
        }
        Ok(())
    }
    fn child(
        &self,
        storage: &impl Storage,
        link: &Link,
        height: u8,
        sealed: u64,
        upper: Option<&Key>,
    ) -> Result<Node> {
        let node = self.read(storage, link.reference, sealed)?;
        if node.height() + 1 != height
            || node.count() != link.count
            || node.first() != Some(link.first.identity())
            || node
                .last()
                .is_some_and(|last| upper.is_some_and(|upper| last >= upper.identity()))
        {
            return Err(Error::CorruptRecord);
        }
        Ok(node)
    }
    fn read(&self, storage: &impl Storage, reference: RootRef, sealed: u64) -> Result<Node> {
        validate_ref(reference, sealed)?;
        self.decode(
            &ZeroizingBytes::new(reference.read_verified(storage)?),
            sealed,
        )
    }
    fn encode(&self, node: &Node) -> Result<ZeroizingBytes> {
        validate_node(node, u64::MAX)?;
        let stored_len = if self.mode.unpadded() {
            node.body_len()
        } else {
            MAX_NODE - HEADER - if self.key.is_some() { 16 } else { 0 }
        };
        // Reserve before copying private bytes; never leave old allocations behind.
        let mut body = ZeroizingBytes::new(Vec::with_capacity(stored_len));
        body.push(node.height());
        body.extend_from_slice(&node.count().to_le_bytes());
        body.extend_from_slice(&(node.item_count() as u16).to_le_bytes());
        match node {
            Node::Leaf(entries) => {
                for entry in entries {
                    body.push(entry.namespace);
                    body.extend_from_slice(&(entry.key.len() as u16).to_le_bytes());
                    body.extend_from_slice(&(entry.value.len() as u32).to_le_bytes());
                    body.extend_from_slice(&entry.key);
                    body.extend_from_slice(&entry.value);
                }
            }
            Node::Branch { children, .. } => {
                for link in children {
                    body.push(link.first.namespace);
                    body.extend_from_slice(&(link.first.bytes.len() as u16).to_le_bytes());
                    body.extend_from_slice(&link.first.bytes);
                    body.extend_from_slice(&link.reference.primary.to_le_bytes());
                    body.extend_from_slice(&link.reference.mirror.to_le_bytes());
                    body.extend_from_slice(&link.reference.len.to_le_bytes());
                    body.extend_from_slice(&link.reference.digest);
                    body.extend_from_slice(&link.count.to_le_bytes());
                }
            }
        }
        body.resize(stored_len, 0);
        let mut out = ZeroizingBytes::new(Vec::with_capacity(HEADER + body.len() + 16));
        out.extend_from_slice(MAGIC);
        out.extend_from_slice(&1u16.to_le_bytes());
        out.extend_from_slice(&self.mode.0.to_le_bytes());
        out.extend_from_slice(self.archive.as_bytes());
        if let Some(key) = &self.key {
            let (nonce, encrypted) = seal_with_random_nonce(&body, key.as_slice(), &out)?;
            out.extend_from_slice(&nonce);
            out.extend_from_slice(&(encrypted.len() as u32).to_le_bytes());
            out.extend_from_slice(&encrypted);
        } else {
            out.extend_from_slice(&[0; 12]);
            out.extend_from_slice(&(body.len() as u32).to_le_bytes());
            out.extend_from_slice(&body);
        }
        Ok(out)
    }
    fn write(&self, storage: &mut impl Storage, node: &Node) -> Result<Link> {
        let bytes = self.encode(node)?;
        if storage.len()? < REGION_LEN as u64 {
            return Err(Error::CorruptHeader);
        }
        let (primary, mirror) = storage.append_pair(&bytes)?;
        Ok(Link {
            reference: RootRef {
                primary,
                mirror,
                len: bytes.len() as u64,
                digest: strong_checksum(&bytes),
            },
            count: node.count(),
            first: Key::new(node.first().unwrap_or((0, &[]))),
        })
    }
    fn write_tracked(
        &self,
        storage: &mut impl Storage,
        node: &Node,
        change: &mut Change,
    ) -> Result<Link> {
        let link = self.write(storage, node)?;
        change.created.push(link.reference);
        Ok(link)
    }
}

fn validate_input(key: &[u8], value: &[u8]) -> Result<()> {
    if key.len() > MAX_KEY || value.len() > MAX_VALUE {
        return Err(Error::SecurityLimitExceeded(
            "index key or descriptor exceeds node limit".into(),
        ));
    }
    Ok(())
}
fn validate_node(node: &Node, sealed: u64) -> Result<()> {
    if node.height() > MAX_HEIGHT
        || node.item_count() > MAX_ITEMS
        || node.body_len() > MAX_BODY
        || node.count() > MAX_ENTRIES
    {
        return Err(Error::CorruptRecord);
    }
    match node {
        Node::Leaf(entries) => {
            for entry in entries {
                validate_input(&entry.key, &entry.value)?;
            }
            if entries
                .windows(2)
                .any(|w| w[0].identity() >= w[1].identity())
            {
                return Err(Error::CorruptRecord);
            }
        }
        Node::Branch { height, children } => {
            if *height == 0
                || children.is_empty()
                || children
                    .windows(2)
                    .any(|w| w[0].first.identity() >= w[1].first.identity())
            {
                return Err(Error::CorruptRecord);
            }
            let mut ranges = Vec::with_capacity(2 * children.len());
            for child in children {
                validate_input(&child.first.bytes, &[])?;
                validate_ref(child.reference, sealed)?;
                if child.count == 0 || child.count > MAX_ENTRIES {
                    return Err(Error::CorruptRecord);
                }
                for offset in [child.reference.primary, child.reference.mirror] {
                    ranges.push((offset, offset + child.reference.len));
                }
            }
            ranges.sort_unstable();
            if ranges.windows(2).any(|w| w[0].1 > w[1].0) {
                return Err(Error::CorruptRecord);
            }
        }
    }
    Ok(())
}
fn validate_ref(reference: RootRef, sealed: u64) -> Result<()> {
    if reference.len < HEADER as u64 || reference.len > MAX_NODE as u64 {
        return Err(Error::CorruptRecord);
    }
    let first = reference.primary.min(reference.mirror);
    let last = reference.primary.max(reference.mirror);
    if first < REGION_LEN as u64
        || first
            .checked_add(reference.len)
            .is_none_or(|end| end > last)
        || last
            .checked_add(reference.len)
            .is_none_or(|end| end > sealed)
    {
        return Err(Error::CorruptRecord);
    }
    Ok(())
}
/// Greedy packing followed by byte-balanced redistribution between adjacent pages.
/// Individual records may be large enough to prevent half-full pages; keep each
/// whole record and preserve hard byte/item bounds instead of assuming equal sizes.
fn pack<T>(items: Vec<T>, size: impl Fn(&T) -> usize) -> Vec<Vec<T>> {
    let mut groups = Vec::new();
    let mut current = Vec::new();
    let mut bytes = BODY_HEADER;
    for item in items {
        if bytes + size(&item) > MAX_BODY || current.len() == MAX_ITEMS {
            groups.push(std::mem::take(&mut current));
            bytes = BODY_HEADER;
        }
        bytes += size(&item);
        current.push(item);
    }
    if !current.is_empty() {
        groups.push(current);
    }
    for i in (1..groups.len()).rev() {
        let mut together = std::mem::take(&mut groups[i - 1]);
        together.append(&mut groups[i]);
        let total = together.iter().map(&size).sum::<usize>();
        let mut left = 0;
        let mut best = None;
        for cut in 1..together.len() {
            left += size(&together[cut - 1]);
            let right = total - left;
            if cut <= MAX_ITEMS
                && together.len() - cut <= MAX_ITEMS
                && left + BODY_HEADER <= MAX_BODY
                && right + BODY_HEADER <= MAX_BODY
            {
                let score = left.abs_diff(right);
                if best.is_none_or(|(_, old_score)| score < old_score) {
                    best = Some((cut, score));
                }
            }
        }
        let (cut, _) = best.expect("original adjacent groups satisfy page bounds");
        let right = together.split_off(cut);
        groups[i - 1] = together;
        groups[i] = right;
    }
    groups
}
struct Cursor<'a>(&'a [u8]);
impl<'a> Cursor<'a> {
    fn take(&mut self, len: usize) -> Result<&'a [u8]> {
        if len > self.0.len() {
            return Err(Error::CorruptRecord);
        }
        let (next, rest) = self.0.split_at(len);
        self.0 = rest;
        Ok(next)
    }
    fn u16(&mut self) -> Result<u16> {
        Ok(u16::from_le_bytes(self.take(2)?.try_into().unwrap()))
    }
    fn u32(&mut self) -> Result<u32> {
        Ok(u32::from_le_bytes(self.take(4)?.try_into().unwrap()))
    }
    fn u64(&mut self) -> Result<u64> {
        Ok(u64::from_le_bytes(self.take(8)?.try_into().unwrap()))
    }
    fn link(&mut self, sealed: u64) -> Result<Link> {
        let namespace = self.take(1)?[0];
        let key_len = self.u16()? as usize;
        if key_len > MAX_KEY {
            return Err(Error::CorruptRecord);
        }
        let first = Key::new((namespace, self.take(key_len)?));
        let reference = RootRef {
            primary: self.u64()?,
            mirror: self.u64()?,
            len: self.u64()?,
            digest: self.take(32)?.try_into().unwrap(),
        };
        validate_ref(reference, sealed)?;
        let count = self.u64()?;
        if count == 0 || count > MAX_ENTRIES {
            return Err(Error::CorruptRecord);
        }
        Ok(Link {
            reference,
            count,
            first,
        })
    }
}

#[cfg(test)]
#[path = "authenticated_index_tests.rs"]
mod tests;