zesven 3.1.0

A pure Rust implementation of the 7z archive format
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
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
//! Main header parser for 7z archives.
//!
//! This module provides the unified header parsing infrastructure that handles
//! both plain and encoded (compressed/encrypted) headers.

use crate::{Error, Result, codec};
use std::io::{Cursor, Read, Seek, SeekFrom};

use super::files::{ArchiveEntry, FilesInfo};
use super::header::StartHeader;
use super::property_id;
use super::reader::read_u8;
use super::streams::{Folder, PackInfo, ResourceLimits, SubStreamsInfo, UnpackInfo};
use super::{SIGNATURE_HEADER_SIZE, declared_buffer, declared_len};

/// Parsed archive header data.
#[derive(Debug, Clone, Default)]
pub struct ArchiveHeader {
    /// Pack info (compressed stream info).
    pub pack_info: Option<PackInfo>,
    /// Unpack info (folder/coder definitions).
    pub unpack_info: Option<UnpackInfo>,
    /// Substreams info (per-file info within folders).
    pub substreams_info: Option<SubStreamsInfo>,
    /// Files info (file metadata).
    pub files_info: Option<FilesInfo>,
    /// Whether the header itself was encrypted (required password to read metadata).
    pub header_encrypted: bool,
}

impl ArchiveHeader {
    /// Returns all file entries.
    pub fn entries(&self) -> &[ArchiveEntry] {
        self.files_info.as_ref().map_or(&[], |f| &f.entries)
    }

    /// Returns all folders.
    pub fn folders(&self) -> &[Folder] {
        self.unpack_info.as_ref().map_or(&[], |u| &u.folders)
    }
}

/// Header parser with resource limit enforcement.
#[derive(Debug)]
pub struct HeaderParser {
    /// Resource limits for parsing.
    limits: ResourceLimits,
    /// Bytes read so far.
    bytes_read: u64,
    /// Current recursion depth for encoded headers.
    recursion_depth: u32,
    /// Maximum recursion depth.
    max_recursion_depth: u32,
    /// Optional password for encrypted headers.
    #[cfg(feature = "aes")]
    password: Option<crate::crypto::Password>,
}

impl HeaderParser {
    /// Creates a new header parser with default limits.
    pub fn new() -> Self {
        Self::with_limits(ResourceLimits::default())
    }

    /// Creates a new header parser with custom limits.
    pub fn with_limits(limits: ResourceLimits) -> Self {
        Self {
            limits,
            bytes_read: 0,
            recursion_depth: 0,
            max_recursion_depth: 4,
            #[cfg(feature = "aes")]
            password: None,
        }
    }

    /// Sets the password for decrypting encrypted headers.
    #[cfg(feature = "aes")]
    pub fn with_password(mut self, password: Option<crate::crypto::Password>) -> Self {
        self.password = password;
        self
    }

    /// Parses the archive header from a reader (Read-only variant).
    ///
    /// This variant only supports plain headers. For encoded headers,
    /// use `parse_header_with_seek` instead.
    pub fn parse_header<R: Read>(&mut self, r: &mut R) -> Result<ArchiveHeader> {
        let first_byte = read_u8(r)?;
        self.bytes_read += 1;

        match first_byte {
            property_id::HEADER => self.parse_main_header(r),
            property_id::ENCODED_HEADER => Err(Error::UnsupportedFeature {
                feature: "encoded headers require seekable reader - use parse_header_with_seek",
            }),
            _ => Err(Error::InvalidFormat(format!(
                "expected header marker, got {:#x}",
                first_byte
            ))),
        }
    }

    /// Parses the archive header from a seekable reader.
    ///
    /// This variant supports both plain and encoded (compressed) headers.
    /// The reader should be positioned at the start of the header data.
    pub fn parse_header_with_seek<R: Read + Seek>(
        &mut self,
        r: &mut R,
        archive_data_start: u64,
    ) -> Result<ArchiveHeader> {
        let first_byte = read_u8(r)?;
        self.bytes_read += 1;

        match first_byte {
            property_id::HEADER => self.parse_main_header(r),
            property_id::ENCODED_HEADER => self.parse_encoded_header(r, archive_data_start),
            _ => Err(Error::InvalidFormat(format!(
                "expected header marker, got {:#x}",
                first_byte
            ))),
        }
    }

    /// Parses the main header content.
    fn parse_main_header<R: Read>(&mut self, r: &mut R) -> Result<ArchiveHeader> {
        let mut header = ArchiveHeader::default();

        loop {
            let prop_id = read_u8(r)?;
            self.bytes_read += 1;
            self.check_byte_limit()?;

            match prop_id {
                property_id::END => break,

                property_id::MAIN_STREAMS_INFO => {
                    self.parse_streams_info(r, &mut header)?;
                }

                property_id::FILES_INFO => {
                    // Get sizes and CRCs from substreams or folders
                    let (sizes, crcs) = self.get_file_sizes_and_crcs(&header);
                    header.files_info = Some(FilesInfo::parse(r, &sizes, &crcs, &self.limits)?);
                }

                // Both of these are legal header sections that carry nothing we
                // act on. Refusing them meant refusing archives another
                // implementation considers perfectly ordinary.
                property_id::ARCHIVE_PROPERTIES => self.skip_archive_properties(r)?,

                property_id::ADDITIONAL_STREAMS_INFO => {
                    let mut discarded = ArchiveHeader::default();
                    self.parse_streams_info(r, &mut discarded)?;
                }

                _ => {
                    return Err(Error::CorruptHeader {
                        offset: self.bytes_read,
                        reason: format!("unexpected property ID in header: {:#x}", prop_id),
                    });
                }
            }
        }

        Ok(header)
    }

    /// Skips the archive properties section.
    ///
    /// Each property is a type, a size and that many bytes, ending at kEnd.
    /// Skipping by the declared size is the rule for anything a reader does not
    /// recognise.
    fn skip_archive_properties<R: Read>(&mut self, r: &mut R) -> Result<()> {
        loop {
            let property_type = read_u8(r)?;
            self.bytes_read += 1;
            self.check_byte_limit()?;

            if property_type == property_id::END {
                return Ok(());
            }

            let size = crate::format::reader::read_variable_u64(r)?;
            if size > self.limits.max_header_bytes {
                return Err(Error::ResourceLimitExceeded(format!(
                    "archive property of {} bytes exceeds the header limit",
                    size
                )));
            }

            let mut discarded = declared_buffer(size, "archive property")?;
            r.read_exact(&mut discarded)?;
            self.bytes_read += size;
            self.check_byte_limit()?;
        }
    }

    /// Parses streams info section.
    fn parse_streams_info<R: Read>(&mut self, r: &mut R, header: &mut ArchiveHeader) -> Result<()> {
        loop {
            let prop_id = read_u8(r)?;
            self.bytes_read += 1;
            self.check_byte_limit()?;

            match prop_id {
                property_id::END => break,

                property_id::PACK_INFO => {
                    header.pack_info = Some(PackInfo::parse(r, &self.limits)?);
                }

                property_id::UNPACK_INFO => {
                    header.unpack_info = Some(UnpackInfo::parse(r, &self.limits)?);
                }

                property_id::SUBSTREAMS_INFO => {
                    let folders = header
                        .unpack_info
                        .as_ref()
                        .map_or(&[] as &[Folder], |u| &u.folders);
                    header.substreams_info = Some(SubStreamsInfo::parse(r, folders, &self.limits)?);
                }

                _ => {
                    return Err(Error::CorruptHeader {
                        offset: self.bytes_read,
                        reason: format!("unexpected property ID in streams info: {:#x}", prop_id),
                    });
                }
            }
        }

        Ok(())
    }

    /// Parses an encoded (compressed) header.
    ///
    /// Encoded headers contain StreamsInfo describing how to decompress the actual header.
    /// This method decompresses the header data and recursively parses the result.
    fn parse_encoded_header<R: Read + Seek>(
        &mut self,
        r: &mut R,
        archive_data_start: u64,
    ) -> Result<ArchiveHeader> {
        self.recursion_depth += 1;
        if self.recursion_depth > self.max_recursion_depth {
            return Err(Error::ResourceLimitExceeded(
                "maximum encoded header recursion depth exceeded".into(),
            ));
        }

        // Parse the streams info that describes how to decompress the header
        let mut streams_header = ArchiveHeader::default();
        self.parse_streams_info(r, &mut streams_header)?;

        // Check if header is encrypted (uses AES codec)
        let header_encrypted = Self::folder_uses_encryption(&streams_header);

        // The packed header stream lives in the data area like any other packed
        // stream, so its position is measured from the start of that area,
        // encrypted or not.
        let decompressed = self.decompress_header(r, &streams_header, archive_data_start)?;

        if decompressed.is_empty() {
            return Err(Error::InvalidFormat("empty decompressed header".into()));
        }

        // Parse the decompressed data
        let first_byte = decompressed[0];
        match first_byte {
            property_id::HEADER => {
                let mut cursor = Cursor::new(&decompressed[1..]);
                let mut header = self.parse_main_header(&mut cursor)?;
                header.header_encrypted = header_encrypted;
                Ok(header)
            }
            property_id::ENCODED_HEADER => {
                // Recursively handle nested encoded headers
                let mut cursor = Cursor::new(&decompressed[1..]);
                let mut nested_streams = ArchiveHeader::default();
                self.parse_streams_info(&mut cursor, &mut nested_streams)?;

                // Check nested header for encryption too
                let nested_encrypted = Self::folder_uses_encryption(&nested_streams);

                let nested_decompressed =
                    self.decompress_header(r, &nested_streams, archive_data_start)?;

                if nested_decompressed.is_empty() {
                    return Err(Error::InvalidFormat(
                        "empty nested decompressed header".into(),
                    ));
                }

                if nested_decompressed[0] == property_id::HEADER {
                    let mut inner_cursor = Cursor::new(&nested_decompressed[1..]);
                    let mut header = self.parse_main_header(&mut inner_cursor)?;
                    // Header is encrypted if either level used encryption
                    header.header_encrypted = header_encrypted || nested_encrypted;
                    Ok(header)
                } else {
                    Err(Error::InvalidFormat(format!(
                        "unexpected header marker in nested decompressed data: {:#x}",
                        nested_decompressed[0]
                    )))
                }
            }
            _ => Err(Error::InvalidFormat(format!(
                "unexpected header marker in decompressed data: {:#x}",
                first_byte
            ))),
        }
    }

    /// Checks if any folder in the header uses AES encryption.
    fn folder_uses_encryption(header: &ArchiveHeader) -> bool {
        if let Some(ref unpack_info) = header.unpack_info {
            for folder in &unpack_info.folders {
                for coder in &folder.coders {
                    if coder.method_id.as_slice() == codec::method::AES {
                        return true;
                    }
                }
            }
        }
        false
    }

    /// Decompresses encoded header data.
    ///
    /// Uses the pack_info and unpack_info from the streams header to locate
    /// and decompress the actual header data.
    fn decompress_header<R: Read + Seek>(
        &self,
        r: &mut R,
        header: &ArchiveHeader,
        archive_data_start: u64,
    ) -> Result<Vec<u8>> {
        let pack_info = header
            .pack_info
            .as_ref()
            .ok_or_else(|| Error::InvalidFormat("encoded header missing pack info".into()))?;

        let unpack_info = header
            .unpack_info
            .as_ref()
            .ok_or_else(|| Error::InvalidFormat("encoded header missing unpack info".into()))?;

        if unpack_info.folders.is_empty() {
            return Err(Error::InvalidFormat("encoded header has no folders".into()));
        }

        // Validate packed_streams and bind_pairs indices
        let num_pack_streams = pack_info.num_streams();
        for (folder_idx, folder) in unpack_info.folders.iter().enumerate() {
            folder
                .validate_packed_streams(num_pack_streams)
                .map_err(|e| Error::InvalidFormat(format!("folder[{}]: {}", folder_idx, e)))?;
            folder
                .validate_bind_pairs()
                .map_err(|e| Error::InvalidFormat(format!("folder[{}]: {}", folder_idx, e)))?;
        }

        let folder = &unpack_info.folders[0];

        // Calculate position of compressed header data. Both summands come
        // from the archive; overflow must be an error, not a panic.
        let pack_pos = archive_data_start
            .checked_add(pack_info.pack_pos)
            .ok_or_else(|| Error::InvalidFormat("encoded header pack position overflow".into()))?;
        r.seek(SeekFrom::Start(pack_pos))?;

        // Read compressed data
        let pack_size = pack_info
            .pack_sizes
            .first()
            .copied()
            .ok_or_else(|| Error::InvalidFormat("encoded header missing pack size".into()))?;

        // Declared by the archive; check against the header limit before
        // allocating (same reasoning as the next-header check above).
        if pack_size > self.limits.max_header_bytes {
            return Err(Error::ResourceLimitExceeded(format!(
                "encoded header pack size {} exceeds limit {}",
                pack_size, self.limits.max_header_bytes
            )));
        }

        let mut packed_data = declared_buffer(pack_size, "encoded header pack size")?;
        r.read_exact(&mut packed_data)?;

        // Get uncompressed size
        let unpack_size = folder
            .final_unpack_size()
            .ok_or_else(|| Error::InvalidFormat("encoded header missing unpack size".into()))?;

        if unpack_size > self.limits.max_header_bytes {
            return Err(Error::ResourceLimitExceeded(format!(
                "encoded header unpack size {} exceeds limit {}",
                unpack_size, self.limits.max_header_bytes
            )));
        }

        // Build decoder and decompress
        let cursor = Cursor::new(packed_data);
        let decoder = self.build_header_decoder(cursor, folder, unpack_size)?;

        // Stop at the recorded size rather than at end of stream. A header that
        // is only encrypted and not compressed decodes to the AES block padding
        // as well, and those trailing bytes are not part of the header.
        let mut decompressed = Vec::new();
        decompressed
            .try_reserve_exact(declared_len(unpack_size, "encoded header unpack size")?)
            .map_err(|_| {
                Error::ResourceLimitExceeded(format!(
                    "encoded header unpack size of {unpack_size} bytes cannot be held"
                ))
            })?;
        decoder.take(unpack_size).read_to_end(&mut decompressed)?;

        if decompressed.len() as u64 != unpack_size {
            return Err(Error::CorruptHeader {
                offset: pack_pos,
                reason: format!(
                    "encoded header is {} bytes, expected {}",
                    decompressed.len(),
                    unpack_size
                ),
            });
        }

        // Verify CRC if available
        if let Some(expected_crc) = folder.unpack_crc {
            let actual_crc = crc32fast::hash(&decompressed);
            if actual_crc != expected_crc {
                return Err(Error::CorruptHeader {
                    offset: pack_pos,
                    reason: format!(
                        "encoded header CRC mismatch: expected {:#x}, got {:#x}",
                        expected_crc, actual_crc
                    ),
                });
            }
        }

        Ok(decompressed)
    }

    /// Builds a decoder for header decompression.
    ///
    /// Most headers use a single LZMA coder, but some may use a filter chain.
    /// Encrypted headers use AES + LZMA2 and require a password.
    fn build_header_decoder(
        &self,
        input: Cursor<Vec<u8>>,
        folder: &Folder,
        unpack_size: u64,
    ) -> Result<Box<dyn Read>> {
        if folder.coders.is_empty() {
            return Err(Error::InvalidFormat("folder has no coders".into()));
        }

        // Header coder chains are linear: every coder takes one stream and
        // produces one. Multi-stream coders such as BCJ2 only ever wrap file data.
        if folder
            .coders
            .iter()
            .any(|c| c.num_in_streams != 1 || c.num_out_streams != 1)
        {
            return Err(Error::UnsupportedFeature {
                feature: "encoded headers with multi-stream coders",
            });
        }

        // Follow the chain through the bind pairs instead of assuming an order.
        // Writers are free to list the coders however they like: 7-Zip puts AES
        // first and the codec second, and reading that as a fixed layout is what
        // made 7-Zip's header-encrypted archives unreadable here.
        let first_packed = *folder.packed_streams.first().ok_or_else(|| {
            Error::InvalidFormat("encoded header folder has no packed stream".into())
        })?;
        // An index, but one the archive chose: narrowing it with `as` on a
        // 32-bit target would drop its high half and could land on a coder that
        // exists, following a chain the header never described.
        let mut index = declared_len(first_packed, "packed stream index")?;

        let mut stream: Box<dyn Read + Send> = Box::new(input);

        for _ in 0..folder.coders.len() {
            let coder = folder.coders.get(index).ok_or_else(|| {
                Error::InvalidFormat(format!("encoded header coder index {} out of range", index))
            })?;
            let output_size = folder
                .unpack_sizes
                .get(index)
                .copied()
                .unwrap_or(unpack_size);

            #[cfg(feature = "aes")]
            let decoder = if coder.method_id.as_slice() == codec::method::AES {
                let password = self.password.as_ref().ok_or(Error::PasswordRequired)?;
                codec::build_decoder_encrypted(stream, coder, output_size, password)?
            } else {
                codec::build_decoder(stream, coder, output_size)?
            };
            #[cfg(not(feature = "aes"))]
            let decoder = codec::build_decoder(stream, coder, output_size)?;

            stream = Box::new(decoder);

            // The coder whose output feeds nothing produces the header itself.
            match folder
                .bind_pairs
                .iter()
                .find(|bp| bp.out_index as usize == index)
            {
                Some(bind_pair) => index = bind_pair.in_index as usize,
                None => return Ok(stream),
            }
        }

        Err(Error::InvalidFormat(
            "encoded header coder chain does not terminate".into(),
        ))
    }

    /// Gets file sizes and CRCs from parsed structures.
    fn get_file_sizes_and_crcs(&self, header: &ArchiveHeader) -> (Vec<u64>, Vec<Option<u32>>) {
        if let Some(ref substreams) = header.substreams_info {
            (substreams.unpack_sizes.clone(), substreams.digests.clone())
        } else if let Some(ref unpack_info) = header.unpack_info {
            // Single file per folder
            let sizes: Vec<u64> = unpack_info
                .folders
                .iter()
                .filter_map(|f| f.final_unpack_size())
                .collect();
            let crcs: Vec<Option<u32>> = unpack_info.folders.iter().map(|f| f.unpack_crc).collect();
            (sizes, crcs)
        } else {
            (Vec::new(), Vec::new())
        }
    }

    /// Checks if we've exceeded the byte limit.
    fn check_byte_limit(&self) -> Result<()> {
        if self.bytes_read > self.limits.max_header_bytes {
            Err(Error::ResourceLimitExceeded(
                "header byte limit exceeded".into(),
            ))
        } else {
            Ok(())
        }
    }
}

impl Default for HeaderParser {
    fn default() -> Self {
        Self::new()
    }
}

/// Reads a complete 7z archive's headers.
///
/// This is the main entry point for parsing a 7z file.
/// Supports both plain and encoded (compressed) headers.
pub fn read_archive_header<R: Read + Seek>(
    r: &mut R,
    limits: Option<ResourceLimits>,
) -> Result<(StartHeader, ArchiveHeader)> {
    read_archive_header_internal(r, limits, 0, None)
}

/// Reads a complete 7z archive's headers with a password for encrypted headers.
///
/// This variant supports encrypted headers that require a password to decrypt.
#[cfg(feature = "aes")]
pub fn read_archive_header_with_password<R: Read + Seek>(
    r: &mut R,
    limits: Option<ResourceLimits>,
    password: Option<crate::crypto::Password>,
) -> Result<(StartHeader, ArchiveHeader)> {
    read_archive_header_internal(r, limits, 0, password)
}

/// Reads a complete 7z archive's headers with an optional SFX offset.
///
/// This is the main entry point for parsing a 7z file.
/// Supports both plain and encoded (compressed) headers.
///
/// # Arguments
///
/// * `r` - Reader positioned at the start of the 7z signature
/// * `limits` - Resource limits for parsing
/// * `sfx_offset` - Offset to the 7z signature (non-zero for SFX archives)
pub fn read_archive_header_with_offset<R: Read + Seek>(
    r: &mut R,
    limits: Option<ResourceLimits>,
    sfx_offset: u64,
) -> Result<(StartHeader, ArchiveHeader)> {
    read_archive_header_internal(r, limits, sfx_offset, None)
}

/// Reads a complete 7z archive's headers with SFX offset and optional password.
///
/// This variant supports encrypted headers that require a password to decrypt.
#[cfg(feature = "aes")]
pub fn read_archive_header_with_offset_and_password<R: Read + Seek>(
    r: &mut R,
    limits: Option<ResourceLimits>,
    sfx_offset: u64,
    password: Option<crate::crypto::Password>,
) -> Result<(StartHeader, ArchiveHeader)> {
    read_archive_header_internal(r, limits, sfx_offset, password)
}

/// Internal implementation for reading archive headers.
#[cfg(feature = "aes")]
fn read_archive_header_internal<R: Read + Seek>(
    r: &mut R,
    limits: Option<ResourceLimits>,
    sfx_offset: u64,
    password: Option<crate::crypto::Password>,
) -> Result<(StartHeader, ArchiveHeader)> {
    // Parse start header (validates signature and gets next header location)
    let mut start_header = StartHeader::parse(r)?;
    start_header.sfx_offset = sfx_offset;

    // Handle empty archives
    if start_header.next_header_size == 0 {
        return Ok((start_header, ArchiveHeader::default()));
    }

    let limits = limits.unwrap_or_default();

    // The declared size comes from the archive and is protected only by a
    // CRC32, which an attacker can recompute at will: check it against the
    // limit before allocating anything.
    if start_header.next_header_size > limits.max_header_bytes {
        return Err(Error::ResourceLimitExceeded(format!(
            "next header size {} exceeds limit {}",
            start_header.next_header_size, limits.max_header_bytes
        )));
    }

    // Seek to the next header
    let header_pos = start_header.next_header_position();
    r.seek(SeekFrom::Start(header_pos))?;

    // Read header data into buffer for CRC verification
    let mut header_data = declared_buffer(start_header.next_header_size, "next header")?;
    r.read_exact(&mut header_data)?;

    // Verify CRC of header data
    let actual_crc = crc32fast::hash(&header_data);
    if actual_crc != start_header.next_header_crc {
        return Err(Error::CorruptHeader {
            offset: header_pos,
            reason: format!(
                "next header CRC mismatch: expected {:#x}, got {:#x}",
                start_header.next_header_crc, actual_crc
            ),
        });
    }

    // Parse the header from the buffer, but pass the original reader
    // for seeking if we encounter an encoded header
    let mut parser = HeaderParser::with_limits(limits).with_password(password);

    // Check first byte to determine header type
    if header_data.is_empty() {
        return Err(Error::InvalidFormat("empty header data".into()));
    }

    let first_byte = header_data[0];
    let archive_header = match first_byte {
        property_id::HEADER => {
            // Plain header - parse from buffer
            let mut cursor = Cursor::new(&header_data[1..]);
            parser.parse_main_header(&mut cursor)?
        }
        property_id::ENCODED_HEADER => {
            // Encoded header - need to seek back and use the reader
            // for accessing compressed header data
            r.seek(SeekFrom::Start(header_pos))?;
            // For SFX archives, the data start includes the SFX offset
            let data_start = sfx_offset + SIGNATURE_HEADER_SIZE;
            parser.parse_header_with_seek(r, data_start)?
        }
        _ => {
            return Err(Error::InvalidFormat(format!(
                "expected header marker, got {:#x}",
                first_byte
            )));
        }
    };

    Ok((start_header, archive_header))
}

/// Internal implementation for reading archive headers (non-AES version).
#[cfg(not(feature = "aes"))]
fn read_archive_header_internal<R: Read + Seek>(
    r: &mut R,
    limits: Option<ResourceLimits>,
    sfx_offset: u64,
    _password: Option<()>,
) -> Result<(StartHeader, ArchiveHeader)> {
    // Parse start header (validates signature and gets next header location)
    let mut start_header = StartHeader::parse(r)?;
    start_header.sfx_offset = sfx_offset;

    // Handle empty archives
    if start_header.next_header_size == 0 {
        return Ok((start_header, ArchiveHeader::default()));
    }

    let limits = limits.unwrap_or_default();

    // The declared size comes from the archive and is protected only by a
    // CRC32, which an attacker can recompute at will: check it against the
    // limit before allocating anything.
    if start_header.next_header_size > limits.max_header_bytes {
        return Err(Error::ResourceLimitExceeded(format!(
            "next header size {} exceeds limit {}",
            start_header.next_header_size, limits.max_header_bytes
        )));
    }

    // Seek to the next header
    let header_pos = start_header.next_header_position();
    r.seek(SeekFrom::Start(header_pos))?;

    // Read header data into buffer for CRC verification
    let mut header_data = declared_buffer(start_header.next_header_size, "next header")?;
    r.read_exact(&mut header_data)?;

    // Verify CRC of header data
    let actual_crc = crc32fast::hash(&header_data);
    if actual_crc != start_header.next_header_crc {
        return Err(Error::CorruptHeader {
            offset: header_pos,
            reason: format!(
                "next header CRC mismatch: expected {:#x}, got {:#x}",
                start_header.next_header_crc, actual_crc
            ),
        });
    }

    // Parse the header from the buffer, but pass the original reader
    // for seeking if we encounter an encoded header
    let mut parser = HeaderParser::with_limits(limits);

    // Check first byte to determine header type
    if header_data.is_empty() {
        return Err(Error::InvalidFormat("empty header data".into()));
    }

    let first_byte = header_data[0];
    let archive_header = match first_byte {
        property_id::HEADER => {
            // Plain header - parse from buffer
            let mut cursor = Cursor::new(&header_data[1..]);
            parser.parse_main_header(&mut cursor)?
        }
        property_id::ENCODED_HEADER => {
            // Encoded header - need to seek back and use the reader
            // for accessing compressed header data
            r.seek(SeekFrom::Start(header_pos))?;
            // For SFX archives, the data start includes the SFX offset
            let data_start = sfx_offset + SIGNATURE_HEADER_SIZE;
            parser.parse_header_with_seek(r, data_start)?
        }
        _ => {
            return Err(Error::InvalidFormat(format!(
                "expected header marker, got {:#x}",
                first_byte
            )));
        }
    };

    Ok((start_header, archive_header))
}

#[cfg(test)]
#[allow(clippy::vec_init_then_push)]
mod tests {
    use super::*;
    use std::io::Cursor;

    fn write_variable_u64(buf: &mut Vec<u8>, value: u64) {
        use super::super::reader::write_variable_u64;
        write_variable_u64(buf, value).unwrap();
    }

    #[test]
    fn test_header_parser_empty() {
        // Empty header (just END)
        let data = vec![property_id::HEADER, property_id::END];

        let mut cursor = Cursor::new(&data);
        let mut parser = HeaderParser::new();
        let header = parser.parse_header(&mut cursor).unwrap();

        assert!(header.pack_info.is_none());
        assert!(header.unpack_info.is_none());
        assert!(header.files_info.is_none());
    }

    #[test]
    fn test_header_parser_invalid_first_byte() {
        let data = vec![0x99]; // Invalid marker

        let mut cursor = Cursor::new(&data);
        let mut parser = HeaderParser::new();
        let err = parser.parse_header(&mut cursor).unwrap_err();

        assert!(matches!(err, Error::InvalidFormat(_)));
    }

    #[test]
    fn test_header_parser_with_streams() {
        let mut data = Vec::new();

        // K_HEADER
        data.push(property_id::HEADER);

        // K_MAIN_STREAMS_INFO
        data.push(property_id::MAIN_STREAMS_INFO);

        // K_PACK_INFO
        data.push(property_id::PACK_INFO);
        write_variable_u64(&mut data, 0); // pack_pos
        write_variable_u64(&mut data, 1); // 1 stream
        data.push(property_id::SIZE);
        write_variable_u64(&mut data, 1000); // size
        data.push(property_id::END);

        // End streams info
        data.push(property_id::END);

        // End header
        data.push(property_id::END);

        let mut cursor = Cursor::new(&data);
        let mut parser = HeaderParser::new();
        let header = parser.parse_header(&mut cursor).unwrap();

        assert!(header.pack_info.is_some());
        let pack_info = header.pack_info.unwrap();
        assert_eq!(pack_info.pack_sizes, vec![1000]);
    }

    #[test]
    fn test_encoded_header_requires_codecs() {
        // Simulate an encoded header
        let data = vec![
            property_id::ENCODED_HEADER,
            property_id::END, // Minimal streams info
        ];

        let mut cursor = Cursor::new(&data);
        let mut parser = HeaderParser::new();
        let err = parser.parse_header(&mut cursor).unwrap_err();

        assert!(matches!(err, Error::UnsupportedFeature { .. }));
    }

    #[test]
    fn test_resource_limits() {
        let limits = ResourceLimits {
            max_entries: 10,
            max_header_bytes: 100,
            ..Default::default()
        };

        let parser = HeaderParser::with_limits(limits.clone());
        assert_eq!(parser.limits.max_entries, 10);
        assert_eq!(parser.limits.max_header_bytes, 100);
    }

    /// Builds a 32-byte start header with a valid start-header CRC.
    fn start_header_bytes(
        next_header_offset: u64,
        next_header_size: u64,
        next_header_crc: u32,
    ) -> Vec<u8> {
        let mut rest = Vec::with_capacity(20);
        rest.extend_from_slice(&next_header_offset.to_le_bytes());
        rest.extend_from_slice(&next_header_size.to_le_bytes());
        rest.extend_from_slice(&next_header_crc.to_le_bytes());
        let crc = crc32fast::hash(&rest);

        let mut data = Vec::with_capacity(32);
        data.extend_from_slice(crate::format::SIGNATURE);
        data.extend_from_slice(&[0x00, 0x04]); // version 0.4
        data.extend_from_slice(&crc.to_le_bytes());
        data.extend_from_slice(&rest);
        data
    }

    /// A tiny file whose start header declares a gigantic next header must be
    /// rejected by the size check, not by an allocation abort. The CRC32
    /// guarding the size field is no protection: an attacker recomputes it.
    #[test]
    fn test_oversized_next_header_rejected_before_allocation() {
        let data = start_header_bytes(0, u64::MAX, 0);
        let mut cursor = Cursor::new(data);
        let err = read_archive_header_with_offset(&mut cursor, None, 0).unwrap_err();
        assert!(
            matches!(err, Error::ResourceLimitExceeded(_)),
            "expected ResourceLimitExceeded, got: {err:?}"
        );
    }

    /// The same file, with the limits turned off, must still be refused.
    ///
    /// `unlimited()` says the caller will accept a header of any size, not that
    /// they will accept one this machine cannot hold. A declared size that no
    /// allocation can satisfy is refused whatever the limit is: a caller who
    /// asked for no limits is not asking to be aborted by a 32-byte file.
    #[test]
    fn test_oversized_next_header_rejected_even_with_limits_off() {
        let data = start_header_bytes(0, u64::MAX, 0);
        let mut cursor = Cursor::new(data);
        let err =
            read_archive_header_with_offset(&mut cursor, Some(ResourceLimits::unlimited()), 0)
                .unwrap_err();
        assert!(
            matches!(err, Error::ResourceLimitExceeded(_)),
            "expected ResourceLimitExceeded, got: {err:?}"
        );
    }

    #[test]
    fn test_next_header_just_over_limit_rejected() {
        let over = ResourceLimits::default().max_header_bytes + 1;
        let data = start_header_bytes(0, over, 0);
        let mut cursor = Cursor::new(data);
        let err = read_archive_header_with_offset(&mut cursor, None, 0).unwrap_err();
        assert!(
            matches!(err, Error::ResourceLimitExceeded(_)),
            "expected ResourceLimitExceeded, got: {err:?}"
        );
    }

    /// A header exactly at the limit passes the size check (and fails later
    /// on the missing data, as this buffer has none).
    #[test]
    fn test_next_header_at_limit_passes_size_check() {
        let at = ResourceLimits::default().max_header_bytes;
        let data = start_header_bytes(0, at, 0);
        let mut cursor = Cursor::new(data);
        let err = read_archive_header_with_offset(&mut cursor, None, 0).unwrap_err();
        assert!(
            !matches!(err, Error::ResourceLimitExceeded(_)),
            "size at the limit must pass the check, got: {err:?}"
        );
    }

    fn encoded_header_with(pack_sizes: Vec<u64>, unpack_sizes: Vec<u64>) -> ArchiveHeader {
        use super::super::streams::Coder;

        ArchiveHeader {
            pack_info: Some(PackInfo {
                pack_pos: 0,
                pack_sizes,
                ..Default::default()
            }),
            unpack_info: Some(UnpackInfo {
                folders: vec![Folder {
                    coders: vec![Coder {
                        method_id: vec![0x00],
                        num_in_streams: 1,
                        num_out_streams: 1,
                        properties: None,
                    }],
                    bind_pairs: vec![],
                    packed_streams: vec![0],
                    unpack_sizes,
                    unpack_crc: None,
                }],
            }),
            ..Default::default()
        }
    }

    /// The pack and unpack sizes of an encoded header are attacker-controlled
    /// too and must be checked before the buffers are allocated.
    #[test]
    fn test_encoded_header_oversized_pack_size_rejected() {
        let header = encoded_header_with(vec![u64::MAX], vec![16]);
        let parser = HeaderParser::new();
        let mut cursor = Cursor::new(vec![0u8; 16]);
        let err = parser
            .decompress_header(&mut cursor, &header, 0)
            .unwrap_err();
        assert!(
            matches!(err, Error::ResourceLimitExceeded(_)),
            "expected ResourceLimitExceeded, got: {err:?}"
        );
    }

    #[test]
    fn test_encoded_header_oversized_unpack_size_rejected() {
        let header = encoded_header_with(vec![1], vec![u64::MAX]);
        let parser = HeaderParser::new();
        let mut cursor = Cursor::new(vec![0u8; 16]);
        let err = parser
            .decompress_header(&mut cursor, &header, 0)
            .unwrap_err();
        assert!(
            matches!(err, Error::ResourceLimitExceeded(_)),
            "expected ResourceLimitExceeded, got: {err:?}"
        );
    }

    /// The pack position is attacker-controlled: overflowing the data-start
    /// addition must be an error, not a panic.
    #[test]
    fn test_encoded_header_pack_pos_overflow_rejected() {
        let mut header = encoded_header_with(vec![1], vec![16]);
        header.pack_info.as_mut().unwrap().pack_pos = u64::MAX;
        let parser = HeaderParser::new();
        let mut cursor = Cursor::new(vec![0u8; 16]);
        let err = parser
            .decompress_header(&mut cursor, &header, SIGNATURE_HEADER_SIZE)
            .unwrap_err();
        assert!(
            matches!(err, Error::InvalidFormat(_)),
            "expected InvalidFormat, got: {err:?}"
        );
    }
}