systemd-journal-sdk 0.6.1

Pure-Rust systemd journal reader and writer SDK
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
use super::reader_helpers::verify_journal_file_strict;
use super::*;
use hmac::{Hmac, Mac};
use journal_core::fss::{RECOMMENDED_SECPAR, gen_mk, gen_state0, get_key, seek};
use journal_core::seal::TAG_LENGTH;
use sha2::Sha256;
use std::fs::File;
use std::io::Read;

/// Validate the structural integrity of a journal file.
///
/// Opens the file (decompressing `.zst` if needed), validates the header,
/// and walks all entries and their referenced data objects.
/// Any parse or decompression error is reported as an `SdkError` with
/// a message containing "corrupt" so callers can detect verification failures.
///
/// For sealed journals, this validates structure only; use `verify_file_with_key`
/// when TAG/HMAC verification is required.
pub fn verify_file(path: impl AsRef<Path>) -> Result<()> {
    let path = path.as_ref();
    let data = read_journal_file_for_verify(path)
        .map_err(|err| SdkError::VerificationError(format!("open/decompression failed: {err}")))?;
    verify_graph::verify_object_graph(&data)
        .map_err(|err| SdkError::VerificationError(format!("corrupt object graph: {err}")))?;

    let reader = FileReader::open(path)
        .map_err(|err| SdkError::VerificationError(format!("open/decompression failed: {err}")))?;
    reader.inner.with_file(verify_journal_file_strict)
}

/// Validate the integrity of a journal file with a verification key.
///
/// For sealed files, parses the key and validates TAG/HMAC chains.
/// For unsealed files, behaves like `verify_file`.
pub fn verify_file_with_key(path: impl AsRef<Path>, verification_key: &str) -> Result<()> {
    let path = path.as_ref();
    let data = read_journal_file_for_verify(path)
        .map_err(|err| SdkError::VerificationError(format!("open/decompression failed: {err}")))?;

    if data.len() < HEADER_MIN_SIZE as usize {
        return Err(SdkError::VerificationError("file too small".into()));
    }
    verify_graph::verify_object_graph(&data)
        .map_err(|err| SdkError::VerificationError(format!("corrupt object graph: {err}")))?;

    let compatible_flags = u32::from_le_bytes([data[8], data[9], data[10], data[11]]);
    let incompatible_flags = u32::from_le_bytes([data[12], data[13], data[14], data[15]]);
    let sealed = (compatible_flags & 1) != 0;

    if !sealed {
        return verify_file(path);
    }

    let (seed, start_usec, interval_usec) = parse_verification_key(verification_key)
        .map_err(|e| SdkError::VerificationError(format!("invalid verification key: {e}")))?;

    verify_sealed(
        &data,
        compatible_flags,
        incompatible_flags,
        seed,
        start_usec,
        interval_usec,
    )?;
    verify_file(path)
}

fn read_journal_file_for_verify(path: &Path) -> std::io::Result<Vec<u8>> {
    if is_zst_file(path) {
        let source = File::open(path)?;
        let mut decoder = ruzstd::decoding::StreamingDecoder::new(source)
            .map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, e.to_string()))?;
        let mut data = Vec::new();
        decoder.read_to_end(&mut data)?;
        Ok(data)
    } else {
        std::fs::read(path)
    }
}

fn parse_verification_key(key: &str) -> std::result::Result<([u8; 12], u64, u64), String> {
    let bytes = key.as_bytes();
    let (seed, slash_offset) = parse_verification_seed(bytes)?;
    if slash_offset >= bytes.len() || bytes[slash_offset] != b'/' {
        return Err("missing / separator".into());
    }
    let (start_usec, dash_offset) = parse_verification_hex_value(bytes, slash_offset + 1, "start")?;
    if dash_offset >= bytes.len() || bytes[dash_offset] != b'-' {
        return Err("bad start hex".into());
    }
    let (interval_usec, end_offset) =
        parse_verification_hex_value(bytes, dash_offset + 1, "interval")?;
    if end_offset != bytes.len() {
        return Err("trailing data".into());
    }
    if interval_usec == 0 {
        return Err("zero interval".into());
    }
    Ok((seed, start_usec, interval_usec))
}

fn parse_verification_seed(bytes: &[u8]) -> std::result::Result<([u8; 12], usize), String> {
    let mut seed = [0u8; 12];
    let mut i = 0;
    for c in 0..12 {
        let (next, val) = parse_verification_seed_byte(bytes, i)?;
        seed[c] = val;
        i = next;
    }
    Ok((seed, i))
}

fn parse_verification_seed_byte(
    bytes: &[u8],
    start: usize,
) -> std::result::Result<(usize, u8), String> {
    let mut i = start;
    while i < bytes.len() && bytes[i] == b'-' {
        i += 1;
    }
    if i + 2 > bytes.len() {
        return Err("seed too short".into());
    }
    let val = u8::from_str_radix(std::str::from_utf8(&bytes[i..i + 2]).unwrap_or("xx"), 16)
        .map_err(|_| "bad seed hex".to_string())?;
    Ok((i + 2, val))
}

fn parse_verification_hex_value(
    bytes: &[u8],
    start: usize,
    label: &str,
) -> std::result::Result<(u64, usize), String> {
    let (next, ok) = consume_hex(bytes, start);
    if !ok {
        return Err(format!("bad {label} hex"));
    }
    let value = u64::from_str_radix(std::str::from_utf8(&bytes[start..next]).unwrap_or("0"), 16)
        .map_err(|_| format!("bad {label} hex"))?;
    Ok((value, next))
}

fn consume_hex(bytes: &[u8], start: usize) -> (usize, bool) {
    let mut i = start;
    while i < bytes.len() && bytes[i].is_ascii_hexdigit() {
        i += 1;
    }
    (i, i > start)
}

pub(super) fn align8(v: u64) -> u64 {
    v.checked_add(7).map(|value| value & !7).unwrap_or(0)
}

fn verify_slice<'a>(data: &'a [u8], offset: usize, len: usize, label: &str) -> Result<&'a [u8]> {
    let label_text = label.to_owned();
    let end = offset.checked_add(len).ok_or_else(|| {
        SdkError::VerificationError(format!(
            "{} read at offset {} overflows",
            label_text, offset
        ))
    })?;
    data.get(offset..end).ok_or_else(|| {
        SdkError::VerificationError(format!(
            "{} read at offset {} exceeds file bounds",
            label_text, offset
        ))
    })
}

fn read_u64_for_verify(data: &[u8], offset: usize, label: &str) -> Result<u64> {
    let bytes = verify_slice(data, offset, 8, label)?;
    Ok(u64::from_le_bytes(bytes.try_into().map_err(|_| {
        SdkError::VerificationError(format!("{label} has invalid length"))
    })?))
}

const COMPATIBLE_SEALED_CONTINUOUS: u32 = 1 << 2;
pub(super) const HEADER_MIN_SIZE: u64 = 208;
pub(super) const OBJECT_TYPE_DATA: u8 = 1;
const OBJECT_TYPE_FIELD: u8 = 2;
const OBJECT_TYPE_ENTRY: u8 = 3;
const OBJECT_TYPE_DATA_HASH_TABLE: u8 = 4;
const OBJECT_TYPE_FIELD_HASH_TABLE: u8 = 5;
const OBJECT_TYPE_ENTRY_ARRAY: u8 = 6;
pub(super) const OBJECT_TYPE_TAG: u8 = 7;
pub(super) const OBJECT_HEADER_SIZE: u64 = 16;
pub(super) const DATA_OBJECT_HEADER_SIZE: u64 = 64;
pub(super) const COMPACT_DATA_OBJECT_HEADER_SIZE: u64 = 72;
const FIELD_OBJECT_HEADER_SIZE: u64 = 40;
pub(super) const INCOMPATIBLE_COMPACT: u32 = 1 << 4;
const INCOMPATIBLE_COMPRESSED_XZ: u32 = 1 << 0;
const INCOMPATIBLE_COMPRESSED_LZ4: u32 = 1 << 1;
const INCOMPATIBLE_COMPRESSED_ZSTD: u32 = 1 << 3;
const OBJECT_COMPRESSED_XZ: u8 = 1 << 0;
const OBJECT_COMPRESSED_LZ4: u8 = 1 << 1;
const OBJECT_COMPRESSED_ZSTD: u8 = 1 << 2;

#[derive(Clone, Copy)]
struct SealedVerifyObject {
    offset: u64,
    typ: u8,
    flags: u8,
    size: u64,
    aligned_size: u64,
}

#[derive(Clone, Copy)]
struct SealedVerifyEntry {
    seqnum: u64,
    realtime: u64,
    monotonic: u64,
    boot_id: [u8; 16],
}

struct SealedVerifyState<'a> {
    data: &'a [u8],
    compatible_flags: u32,
    incompatible_flags: u32,
    seed: [u8; 12],
    msk: Vec<u8>,
    state0: Vec<u8>,
    start_epoch: u64,
    interval_usec: u64,
    is_compact: bool,
    header_size: u64,
    tail_object_offset: u64,
    file_size: u64,
    head_entry_seqnum: u64,
    head_entry_realtime: u64,
    n_objects_header: u64,
    n_entries_header: u64,
    n_tags_header: u64,
    n_objects: u64,
    n_entries: u64,
    n_tags: u64,
    last_tag_end: u64,
    last_epoch: u64,
    last_tag_realtime: u64,
    entry_seqnum: u64,
    entry_seqnum_set: bool,
    entry_monotonic: u64,
    entry_monotonic_set: bool,
    entry_boot_id: [u8; 16],
    entry_realtime: u64,
    entry_realtime_set: bool,
    max_entry_realtime: u64,
    min_entry_realtime: u64,
}

fn verify_sealed(
    data: &[u8],
    compatible_flags: u32,
    incompatible_flags: u32,
    seed: [u8; 12],
    start_epoch: u64,
    interval_usec: u64,
) -> Result<()> {
    SealedVerifyState::new(
        data,
        compatible_flags,
        incompatible_flags,
        seed,
        start_epoch,
        interval_usec,
    )?
    .run()
}

impl<'a> SealedVerifyState<'a> {
    fn new(
        data: &'a [u8],
        compatible_flags: u32,
        incompatible_flags: u32,
        seed: [u8; 12],
        start_epoch: u64,
        interval_usec: u64,
    ) -> Result<Self> {
        let header_size = read_u64_for_verify(data, 88, "header_size")?;
        let file_size = data.len() as u64;
        if header_size < HEADER_MIN_SIZE || header_size > file_size {
            return Err(SdkError::VerificationError(format!(
                "invalid header_size {header_size}"
            )));
        }
        let (msk, mpk) = gen_mk(&seed, RECOMMENDED_SECPAR);
        let n_tags_header = if header_size >= 232 && data.len() >= 232 {
            read_u64_for_verify(data, 224, "n_tags")?
        } else {
            0
        };
        Ok(Self {
            data,
            compatible_flags,
            incompatible_flags,
            seed,
            msk,
            state0: gen_state0(&mpk, &seed),
            start_epoch,
            interval_usec,
            is_compact: (incompatible_flags & INCOMPATIBLE_COMPACT) != 0,
            header_size,
            tail_object_offset: read_u64_for_verify(data, 136, "tail_object_offset")?,
            file_size,
            head_entry_seqnum: read_u64_for_verify(data, 168, "head_entry_seqnum")?,
            head_entry_realtime: read_u64_for_verify(data, 184, "head_entry_realtime")?,
            n_objects_header: read_u64_for_verify(data, 144, "n_objects")?,
            n_entries_header: read_u64_for_verify(data, 152, "n_entries")?,
            n_tags_header,
            n_objects: 0,
            n_entries: 0,
            n_tags: 0,
            last_tag_end: 0,
            last_epoch: 0,
            last_tag_realtime: 0,
            entry_seqnum: 0,
            entry_seqnum_set: false,
            entry_monotonic: 0,
            entry_monotonic_set: false,
            entry_boot_id: [0; 16],
            entry_realtime: 0,
            entry_realtime_set: false,
            max_entry_realtime: 0,
            min_entry_realtime: u64::MAX,
        })
    }

    fn run(mut self) -> Result<()> {
        let mut offset = self.header_size;
        while self.tail_object_offset != 0 {
            let obj = self.read_object(offset)?;
            self.verify_object(obj)?;
            if offset == self.tail_object_offset {
                break;
            }
            offset += obj.aligned_size;
        }
        self.verify_final_counts()
    }

    fn read_object(&self, offset: u64) -> Result<SealedVerifyObject> {
        if offset > self.tail_object_offset {
            return Err(SdkError::VerificationError(format!(
                "object offset {offset} exceeds tail_object_offset {}",
                self.tail_object_offset
            )));
        }
        if offset > self.file_size - OBJECT_HEADER_SIZE {
            return Err(SdkError::VerificationError(format!(
                "object header at offset {offset} exceeds file bounds"
            )));
        }
        let obj = SealedVerifyObject {
            offset,
            typ: self.data[offset as usize],
            flags: self.data[offset as usize + 1],
            size: read_u64_for_verify(self.data, offset as usize + 8, "object size")?,
            aligned_size: 0,
        };
        let obj = SealedVerifyObject {
            aligned_size: align8(obj.size),
            ..obj
        };
        self.verify_object_envelope(obj)?;
        self.verify_object_flags(obj)?;
        Ok(obj)
    }

    fn verify_object_envelope(&self, obj: SealedVerifyObject) -> Result<()> {
        if obj.size < OBJECT_HEADER_SIZE {
            return Err(SdkError::VerificationError(format!(
                "object size {} too small at offset {}",
                obj.size, obj.offset
            )));
        }
        if obj.aligned_size < obj.size || obj.aligned_size == 0 {
            return Err(SdkError::VerificationError(format!(
                "object size {} overflows alignment at offset {}",
                obj.size, obj.offset
            )));
        }
        if obj.aligned_size > self.file_size - obj.offset {
            return Err(SdkError::VerificationError(format!(
                "object at offset {} with aligned size {} exceeds file bounds",
                obj.offset, obj.aligned_size
            )));
        }
        Ok(())
    }

    fn verify_object_flags(&self, obj: SealedVerifyObject) -> Result<()> {
        if object_compression_flag_count(obj.flags) > 1 {
            return Err(SdkError::VerificationError(format!(
                "multiple compression flags at offset {}",
                obj.offset
            )));
        }
        self.verify_enabled_compression_flag(obj)?;
        if obj.flags & !(OBJECT_COMPRESSED_XZ | OBJECT_COMPRESSED_LZ4 | OBJECT_COMPRESSED_ZSTD) != 0
        {
            return Err(SdkError::VerificationError(format!(
                "unknown object flags 0x{:02x} at offset {}",
                obj.flags, obj.offset
            )));
        }
        if obj.typ != OBJECT_TYPE_DATA && obj.flags != 0 {
            return Err(SdkError::VerificationError(format!(
                "object type {} at offset {} has compression flags",
                obj.typ, obj.offset
            )));
        }
        Ok(())
    }

    fn verify_enabled_compression_flag(&self, obj: SealedVerifyObject) -> Result<()> {
        if obj.flags & OBJECT_COMPRESSED_XZ != 0
            && self.incompatible_flags & INCOMPATIBLE_COMPRESSED_XZ == 0
        {
            return Err(SdkError::VerificationError(format!(
                "XZ object in file without XZ support at offset {}",
                obj.offset
            )));
        }
        if obj.flags & OBJECT_COMPRESSED_LZ4 != 0
            && self.incompatible_flags & INCOMPATIBLE_COMPRESSED_LZ4 == 0
        {
            return Err(SdkError::VerificationError(format!(
                "LZ4 object in file without LZ4 support at offset {}",
                obj.offset
            )));
        }
        if obj.flags & OBJECT_COMPRESSED_ZSTD != 0
            && self.incompatible_flags & INCOMPATIBLE_COMPRESSED_ZSTD == 0
        {
            return Err(SdkError::VerificationError(format!(
                "ZSTD object in file without ZSTD support at offset {}",
                obj.offset
            )));
        }
        Ok(())
    }

    fn verify_object(&mut self, obj: SealedVerifyObject) -> Result<()> {
        self.n_objects += 1;
        match obj.typ {
            OBJECT_TYPE_DATA
            | OBJECT_TYPE_FIELD
            | OBJECT_TYPE_DATA_HASH_TABLE
            | OBJECT_TYPE_FIELD_HASH_TABLE
            | OBJECT_TYPE_ENTRY_ARRAY => Ok(()),
            OBJECT_TYPE_ENTRY => self.verify_entry_object(obj),
            OBJECT_TYPE_TAG => self.verify_tag_object(obj),
            _ => Err(SdkError::VerificationError(format!(
                "unknown object type {} at offset {}",
                obj.typ, obj.offset
            ))),
        }
    }

    fn verify_entry_object(&mut self, obj: SealedVerifyObject) -> Result<()> {
        if self.n_tags == 0 {
            return Err(SdkError::VerificationError(format!(
                "first entry before first tag at offset {}",
                obj.offset
            )));
        }
        let entry = self.read_entry(obj.offset)?;
        self.verify_entry_realtime_floor(obj, entry)?;
        self.verify_entry_seqnum(obj, entry.seqnum)?;
        self.verify_entry_monotonic(obj, entry)?;
        self.verify_entry_realtime_head(obj, entry.realtime)?;
        self.record_entry_realtime(entry.realtime);
        self.n_entries += 1;
        Ok(())
    }

    fn read_entry(&self, offset: u64) -> Result<SealedVerifyEntry> {
        let mut boot_id = [0u8; 16];
        let boot_id_bytes = verify_slice(self.data, offset as usize + 40, 16, "entry boot_id")?;
        boot_id.copy_from_slice(boot_id_bytes);
        Ok(SealedVerifyEntry {
            seqnum: read_u64_for_verify(self.data, offset as usize + 16, "entry seqnum")?,
            realtime: read_u64_for_verify(self.data, offset as usize + 24, "entry realtime")?,
            monotonic: read_u64_for_verify(self.data, offset as usize + 32, "entry monotonic")?,
            boot_id,
        })
    }

    fn verify_entry_realtime_floor(
        &self,
        obj: SealedVerifyObject,
        entry: SealedVerifyEntry,
    ) -> Result<()> {
        if self.entry_realtime_set && entry.realtime < self.last_tag_realtime {
            return Err(SdkError::VerificationError(format!(
                "older entry after newer tag at offset {}",
                obj.offset
            )));
        }
        Ok(())
    }

    fn verify_entry_seqnum(&mut self, obj: SealedVerifyObject, seqnum: u64) -> Result<()> {
        if !self.entry_seqnum_set && seqnum != self.head_entry_seqnum {
            return Err(SdkError::VerificationError(format!(
                "head entry seqnum mismatch at offset {}",
                obj.offset
            )));
        }
        if self.entry_seqnum_set && self.entry_seqnum >= seqnum {
            return Err(SdkError::VerificationError(format!(
                "entry seqnum out of sync at offset {}",
                obj.offset
            )));
        }
        self.entry_seqnum = seqnum;
        self.entry_seqnum_set = true;
        Ok(())
    }

    fn verify_entry_monotonic(
        &mut self,
        obj: SealedVerifyObject,
        entry: SealedVerifyEntry,
    ) -> Result<()> {
        if self.entry_monotonic_set
            && entry.boot_id == self.entry_boot_id
            && self.entry_monotonic > entry.monotonic
        {
            return Err(SdkError::VerificationError(format!(
                "entry monotonic out of sync at offset {}",
                obj.offset
            )));
        }
        self.entry_monotonic = entry.monotonic;
        self.entry_boot_id = entry.boot_id;
        self.entry_monotonic_set = true;
        Ok(())
    }

    fn verify_entry_realtime_head(&mut self, obj: SealedVerifyObject, realtime: u64) -> Result<()> {
        if !self.entry_realtime_set && realtime != self.head_entry_realtime {
            return Err(SdkError::VerificationError(format!(
                "head entry realtime mismatch at offset {}",
                obj.offset
            )));
        }
        self.entry_realtime = realtime;
        self.entry_realtime_set = true;
        Ok(())
    }

    fn record_entry_realtime(&mut self, realtime: u64) {
        self.max_entry_realtime = self.max_entry_realtime.max(realtime);
        self.min_entry_realtime = self.min_entry_realtime.min(realtime);
    }

    fn verify_tag_object(&mut self, obj: SealedVerifyObject) -> Result<()> {
        if obj.size != OBJECT_HEADER_SIZE + 8 + 8 + TAG_LENGTH as u64 {
            return Err(SdkError::VerificationError(format!(
                "invalid tag object size {} at offset {}",
                obj.size, obj.offset
            )));
        }
        let seqnum = read_u64_for_verify(self.data, obj.offset as usize + 16, "tag seqnum")?;
        let epoch = read_u64_for_verify(self.data, obj.offset as usize + 24, "tag epoch")?;
        self.verify_tag_seqnum(obj, seqnum)?;
        self.verify_tag_epoch(obj, epoch)?;
        let rt = self.verify_tag_realtime_window(obj, epoch)?;
        self.verify_tag_hmac(obj, epoch)?;
        self.record_tag(obj, epoch, rt);
        Ok(())
    }

    fn verify_tag_seqnum(&self, obj: SealedVerifyObject, seqnum: u64) -> Result<()> {
        if seqnum != self.n_tags + 1 {
            return Err(SdkError::VerificationError(format!(
                "tag seqnum mismatch: got {seqnum}, want {} at offset {}",
                self.n_tags + 1,
                obj.offset
            )));
        }
        Ok(())
    }

    fn verify_tag_epoch(&self, obj: SealedVerifyObject, epoch: u64) -> Result<()> {
        if self.compatible_flags & COMPATIBLE_SEALED_CONTINUOUS != 0 {
            return self.verify_continuous_tag_epoch(obj, epoch);
        }
        if epoch < self.last_epoch {
            return Err(SdkError::VerificationError(format!(
                "epoch out of sync: got {epoch}, last {} at offset {}",
                self.last_epoch, obj.offset
            )));
        }
        Ok(())
    }

    fn verify_continuous_tag_epoch(&self, obj: SealedVerifyObject, epoch: u64) -> Result<()> {
        let ok = self.n_tags == 0
            || (self.n_tags == 1 && epoch == self.last_epoch)
            || epoch == self.last_epoch + 1;
        if !ok {
            return Err(SdkError::VerificationError(format!(
                "epoch not continuous: got {epoch}, last {} at offset {}",
                self.last_epoch, obj.offset
            )));
        }
        Ok(())
    }

    fn verify_tag_realtime_window(&self, obj: SealedVerifyObject, epoch: u64) -> Result<u64> {
        let (rt, rt_end) = tag_realtime_range(self.start_epoch, epoch, self.interval_usec)?;
        if self.entry_realtime_set && self.entry_realtime >= rt_end {
            return Err(SdkError::VerificationError(format!(
                "entry realtime {} too late for tag end {rt_end} at offset {}",
                self.entry_realtime, obj.offset
            )));
        }
        if self.max_entry_realtime >= rt_end {
            return Err(SdkError::VerificationError(format!(
                "max entry realtime {} too late for tag end {rt_end} at offset {}",
                self.max_entry_realtime, obj.offset
            )));
        }
        if self.min_entry_realtime < rt {
            return Err(SdkError::VerificationError(format!(
                "entry realtime {} too early for tag start {rt} at offset {}",
                self.min_entry_realtime, obj.offset
            )));
        }
        Ok(rt)
    }

    fn verify_tag_hmac(&self, obj: SealedVerifyObject, epoch: u64) -> Result<()> {
        let mut hm = self.new_tag_hmac(epoch);
        if self.n_tags == 0 {
            self.write_first_tag_header_hmac(&mut hm);
        }
        self.write_tag_object_hmacs(&mut hm, obj.offset)?;
        let stored =
            &self.data[(obj.offset as usize + 32)..(obj.offset as usize + 32 + TAG_LENGTH)];
        if hm.verify_slice(stored).is_err() {
            return Err(SdkError::VerificationError(format!(
                "tag failed verification at offset {}",
                obj.offset
            )));
        }
        Ok(())
    }

    fn new_tag_hmac(&self, epoch: u64) -> Hmac<Sha256> {
        let state = seek(&self.state0, epoch, &self.msk, &self.seed);
        let key = get_key(&state, TAG_LENGTH, 0);
        Hmac::<Sha256>::new_from_slice(&key).expect("HMAC key length valid")
    }

    fn write_first_tag_header_hmac(&self, hm: &mut Hmac<Sha256>) {
        hm.update(&self.data[0..16]);
        hm.update(&self.data[24..56]);
        hm.update(&self.data[72..96]);
        hm.update(&self.data[104..136]);
    }

    fn write_tag_object_hmacs(&self, hm: &mut Hmac<Sha256>, tag_offset: u64) -> Result<()> {
        let mut offset = self.last_tag_end;
        if self.n_tags == 0 {
            offset = self.header_size;
        }
        while offset <= tag_offset {
            let obj = self.read_hmac_object(offset)?;
            hmac_object(hm, self.data, offset, obj.typ, obj.size, self.is_compact);
            offset += obj.aligned_size;
        }
        Ok(())
    }

    fn read_hmac_object(&self, offset: u64) -> Result<SealedVerifyObject> {
        if offset > self.file_size - OBJECT_HEADER_SIZE {
            return Err(SdkError::VerificationError(format!(
                "HMAC object header at offset {offset} exceeds file bounds"
            )));
        }
        let size = read_u64_for_verify(self.data, offset as usize + 8, "HMAC object size")?;
        let aligned_size = align8(size);
        if size < OBJECT_HEADER_SIZE {
            return Err(SdkError::VerificationError(format!(
                "HMAC object size {size} too small at offset {offset}"
            )));
        }
        if aligned_size < size || aligned_size == 0 {
            return Err(SdkError::VerificationError(format!(
                "HMAC object size {size} overflows alignment at offset {offset}"
            )));
        }
        if aligned_size > self.file_size - offset {
            return Err(SdkError::VerificationError(format!(
                "HMAC object at offset {offset} with aligned size {aligned_size} exceeds file bounds"
            )));
        }
        Ok(SealedVerifyObject {
            offset,
            typ: self.data[offset as usize],
            flags: 0,
            size,
            aligned_size,
        })
    }

    fn record_tag(&mut self, obj: SealedVerifyObject, epoch: u64, realtime: u64) {
        self.n_tags += 1;
        self.last_tag_end = obj.offset + obj.aligned_size;
        self.last_epoch = epoch;
        self.last_tag_realtime = realtime;
        self.min_entry_realtime = u64::MAX;
    }

    fn verify_final_counts(&self) -> Result<()> {
        if self.n_objects != self.n_objects_header {
            return Err(SdkError::VerificationError(format!(
                "object count mismatch: got {}, want {}",
                self.n_objects, self.n_objects_header
            )));
        }
        if self.n_entries != self.n_entries_header {
            return Err(SdkError::VerificationError(format!(
                "entry count mismatch: got {}, want {}",
                self.n_entries, self.n_entries_header
            )));
        }
        if self.n_tags != self.n_tags_header {
            return Err(SdkError::VerificationError(format!(
                "tag count mismatch: got {}, want {}",
                self.n_tags, self.n_tags_header
            )));
        }
        Ok(())
    }
}

fn object_compression_flag_count(flags: u8) -> u32 {
    [
        OBJECT_COMPRESSED_XZ,
        OBJECT_COMPRESSED_LZ4,
        OBJECT_COMPRESSED_ZSTD,
    ]
    .iter()
    .filter(|flag| flags & **flag != 0)
    .count() as u32
}

fn tag_realtime_range(start_epoch: u64, epoch: u64, interval_usec: u64) -> Result<(u64, u64)> {
    let absolute_epoch = start_epoch
        .checked_add(epoch)
        .ok_or_else(|| SdkError::VerificationError("tag realtime overflow".into()))?;
    let rt = absolute_epoch
        .checked_mul(interval_usec)
        .ok_or_else(|| SdkError::VerificationError("tag realtime overflow".into()))?;
    let rt_end = rt
        .checked_add(interval_usec)
        .ok_or_else(|| SdkError::VerificationError("tag realtime overflow".into()))?;
    Ok((rt, rt_end))
}

fn hmac_object(
    hm: &mut impl hmac::Mac,
    data: &[u8],
    offset: u64,
    typ: u8,
    size: u64,
    is_compact: bool,
) {
    hm.update(&data[offset as usize..(offset + OBJECT_HEADER_SIZE) as usize]);

    match typ {
        OBJECT_TYPE_DATA => {
            hm.update(&data[(offset + 16) as usize..(offset + 24) as usize]);
            let payload_offset = if is_compact {
                COMPACT_DATA_OBJECT_HEADER_SIZE
            } else {
                DATA_OBJECT_HEADER_SIZE
            };
            if size > payload_offset {
                hm.update(&data[(offset + payload_offset) as usize..(offset + size) as usize]);
            }
        }
        OBJECT_TYPE_FIELD => {
            hm.update(&data[(offset + 16) as usize..(offset + 24) as usize]);
            if size > FIELD_OBJECT_HEADER_SIZE {
                hm.update(
                    &data[(offset + FIELD_OBJECT_HEADER_SIZE) as usize..(offset + size) as usize],
                );
            }
        }
        OBJECT_TYPE_ENTRY => {
            if size > OBJECT_HEADER_SIZE {
                hm.update(&data[(offset + OBJECT_HEADER_SIZE) as usize..(offset + size) as usize]);
            }
        }
        OBJECT_TYPE_DATA_HASH_TABLE | OBJECT_TYPE_FIELD_HASH_TABLE | OBJECT_TYPE_ENTRY_ARRAY => {}
        OBJECT_TYPE_TAG => {
            hm.update(
                &data[(offset + OBJECT_HEADER_SIZE) as usize
                    ..(offset + OBJECT_HEADER_SIZE + 16) as usize],
            );
        }
        _ => {}
    }
}