caddy-hexspell 1.2.3

Dependency-free Rust library for parsing and patching PE, ELF, and Mach-O executables with a 1:1 on-disk API
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
//! Tools for working with the Windows Portable Executable format.
//!
//! The [`PE`](crate::pe::PE) type loads an executable into memory, parses its DOS, COFF, and
//! optional headers, and exposes section information through strongly typed
//! structures. Fields that can be altered are wrapped in [`crate::field::Field`]
//! so the original buffer can be updated in place.
//!
//! In addition to read/modify support, this module offers convenience
//! helpers like [`PE::calc_checksum`](crate::pe::PE::calc_checksum) for computing the file checksum and
//! `PE::write_file` for persisting changes. The implementation is not a
//! complete re-creation of the PE spec but aims to cover the portions
//! commonly needed when experimenting with binaries.

use alloc::vec::Vec;

#[cfg(feature = "std")]
use std::fs;
#[cfg(feature = "std")]
use std::io::{self, Write};

use crate::errors::FileParseError;
use crate::field::{Field, FixedBytes};

pub mod arch_data;
pub mod bound;
#[cfg(feature = "write")]
pub mod build;
pub mod certificate;
pub mod clr;
pub mod coff;
pub mod debug;
pub mod delay;
pub mod dos;
pub mod exception;
pub mod export;
pub mod header;
pub mod import;
pub mod layout;
pub mod linenum;
pub mod load_config;
pub mod read;
#[cfg(feature = "pe-reconstruct")]
pub mod reconstruct;
pub mod relocation;
pub mod resource;
pub mod rich;
pub mod section;
pub mod section_reloc;
pub mod symbol;
pub mod tls;
pub mod view;

/// A parsed PE image backed by owned bytes (by default) or a borrowed slice.
pub struct PE<B = Vec<u8>> {
    /// Full file contents; pass slices of this to [`crate::field::Field::update`].
    pub buffer: B,
    /// DOS stub header (`IMAGE_DOS_HEADER`).
    pub dos_header: dos::DosHeader,
    /// COFF file header (`IMAGE_FILE_HEADER`).
    pub coff_header: coff::CoffFileHeader,
    /// PE optional header (PE32 or PE32+).
    pub optional_header: header::OptionalHeader,
    /// Section table entries in file order.
    pub sections: Vec<section::PeSection>,
}

impl<B: core::ops::Deref<Target = [u8]>> PE<B> {
    /// Parses base relocations on demand from the current buffer.
    pub fn base_relocations(&self) -> Result<Vec<relocation::BaseRelocationBlock>, FileParseError> {
        self.base_relocations_iter()?
            .map(|block| block.map(|block| block.to_owned()))
            .collect()
    }

    /// Iterates borrowed relocation blocks without collecting their entries.
    pub fn base_relocations_iter(&self) -> Result<read::Relocations<'_>, FileParseError> {
        let (offset, size) = self.directory_range(header::BASERELOC)?;
        read::Relocations::new(&self.buffer, offset, size)
    }

    /// Iterates imports, borrowing names and storing each descriptor once.
    pub fn imports_iter(&self) -> Result<read::Imports<'_>, FileParseError> {
        let entry = &self.optional_header.data_directories[header::IMPORT];
        read::Imports::new(
            &self.buffer,
            &self.sections,
            entry.virtual_address.value,
            self.optional_header.pe_type()?,
        )
    }

    /// Iterates named exports, borrowing their UTF-8 names.
    pub fn exports_iter(&self) -> Result<read::Exports<'_>, FileParseError> {
        let entry = &self.optional_header.data_directories[header::EXPORT];
        read::Exports::new(
            &self.buffer,
            &self.sections,
            entry.virtual_address.value,
            entry.size.value,
        )
    }

    /// Iterates the full export address table, including ordinal-only exports and forwarders.
    pub fn export_functions_iter(&self) -> Result<read::ExportFunctions<'_>, FileParseError> {
        let entry = &self.optional_header.data_directories[header::EXPORT];
        read::ExportFunctions::new(
            &self.buffer,
            &self.sections,
            entry.virtual_address.value,
            entry.size.value,
        )
    }

    /// Iterates debug directory records without collecting them.
    pub fn debug_iter(&self) -> Result<read::DebugEntries<'_>, FileParseError> {
        let (offset, size) = self.directory_range(header::DEBUG)?;
        read::DebugEntries::new(&self.buffer, offset, size)
    }

    /// Builds an optional lookup index that borrows the current buffer and section table.
    pub fn rva_index(&self) -> read::RvaIndex<'_> {
        read::RvaIndex::new(&self.buffer, &self.sections)
    }

    fn directory_range(&self, index: usize) -> Result<(usize, usize), FileParseError> {
        if !self.optional_header.has_data_directory(index) {
            return Ok((0, 0));
        }
        let entry = &self.optional_header.data_directories[index];
        if entry.virtual_address.value == 0 || entry.size.value == 0 {
            return Ok((0, 0));
        }
        Ok((
            self.rva_to_offset(entry.virtual_address.value)?,
            entry.size.value as usize,
        ))
    }

    /// Returns the target architecture derived from the COFF `machine` field.
    pub fn architecture(&self) -> header::Architecture {
        self.coff_header.architecture()
    }

    /// Maps a relative virtual address to an absolute file offset.
    pub fn rva_to_offset(&self, rva: u32) -> Result<usize, FileParseError> {
        import::rva_to_offset(&self.buffer, &self.sections, rva)
    }

    /// Read-only view of the import directory (`IMAGE_IMPORT_DESCRIPTOR` array).
    pub fn imports(&self) -> Result<import::ImportDirectory, FileParseError> {
        let import_rva = self.optional_header.data_directories[header::IMPORT]
            .virtual_address
            .value;
        import::ImportDirectory::parse(
            &self.buffer,
            &self.sections,
            import_rva,
            self.optional_header.pe_type()?,
        )
    }

    /// Returns raw on-disk bytes for section `index` (`PointerToRawData` .. `SizeOfRawData`).
    pub fn section_data(&self, index: usize) -> Result<&[u8], FileParseError> {
        let section = self
            .sections
            .get(index)
            .ok_or(FileParseError::BufferOverflow)?;
        let start = section.pointer_to_raw_data.value as usize;
        let end = start
            .checked_add(section.size_of_raw_data.value as usize)
            .ok_or(FileParseError::BufferOverflow)?;
        self.buffer
            .get(start..end)
            .ok_or(FileParseError::BufferOverflow)
    }

    /// Parses the export data directory when present.
    ///
    /// Returns `Ok(None)` when the export directory RVA is zero.
    pub fn exports(&self) -> Result<Option<export::Exports>, FileParseError> {
        let entry = &self.optional_header.data_directories[header::EXPORT];
        if entry.virtual_address.value == 0 {
            return Ok(None);
        }

        let export_dir_rva = entry.virtual_address.value;
        let export_dir_size = entry.size.value;
        let offset = self.rva_to_offset(export_dir_rva)?;
        let directory = export::ExportDirectory::parse(&self.buffer, offset)?;
        let exports = export::Exports::parse(
            &self.buffer,
            &directory,
            export_dir_rva,
            export_dir_size,
            |rva| self.rva_to_offset(rva),
        )?;

        Ok(Some(exports))
    }

    /// Parses the bound import directory when present.
    pub fn bound_imports(&self) -> Result<Option<bound::BoundImportDirectory>, FileParseError> {
        if !self
            .optional_header
            .has_data_directory(header::BOUND_IMPORT)
        {
            return Ok(None);
        }
        let entry = &self.optional_header.data_directories[header::BOUND_IMPORT];
        if entry.virtual_address.value == 0 {
            return Ok(None);
        }
        Ok(Some(bound::BoundImportDirectory::parse(
            &self.buffer,
            &self.sections,
            entry.virtual_address.value,
        )?))
    }

    /// Parses the delay-load import directory when present.
    pub fn delay_imports(&self) -> Result<Option<delay::DelayLoadDirectory>, FileParseError> {
        if !self
            .optional_header
            .has_data_directory(header::DELAY_IMPORT)
        {
            return Ok(None);
        }
        let entry = &self.optional_header.data_directories[header::DELAY_IMPORT];
        if entry.virtual_address.value == 0 {
            return Ok(None);
        }
        Ok(Some(delay::DelayLoadDirectory::parse(
            &self.buffer,
            &self.sections,
            entry.virtual_address.value,
            self.optional_header.pe_type()?,
        )?))
    }

    /// Parses the TLS directory when present.
    pub fn tls(&self) -> Result<Option<tls::TlsDirectory>, FileParseError> {
        if !self.optional_header.has_data_directory(header::TLS) {
            return Ok(None);
        }
        let entry = &self.optional_header.data_directories[header::TLS];
        if entry.virtual_address.value == 0 {
            return Ok(None);
        }
        let offset = self.rva_to_offset(entry.virtual_address.value)?;
        Ok(Some(tls::TlsDirectory::parse(
            &self.buffer,
            offset,
            self.optional_header.pe_type()?,
        )?))
    }

    /// Parses the exception / runtime function directory when present.
    pub fn exceptions(&self) -> Result<Option<exception::ExceptionDirectory>, FileParseError> {
        if !self.optional_header.has_data_directory(header::EXCEPTION) {
            return Ok(None);
        }
        let entry = &self.optional_header.data_directories[header::EXCEPTION];
        if entry.virtual_address.value == 0 || entry.size.value == 0 {
            return Ok(None);
        }
        let offset = self.rva_to_offset(entry.virtual_address.value)?;
        Ok(Some(exception::ExceptionDirectory::parse(
            &self.buffer,
            offset,
            entry.size.value as usize,
        )?))
    }

    /// Parses the debug directory when present.
    pub fn debug_directory(&self) -> Result<Option<debug::DebugDirectory>, FileParseError> {
        if !self.optional_header.has_data_directory(header::DEBUG) {
            return Ok(None);
        }
        let entry = &self.optional_header.data_directories[header::DEBUG];
        if entry.virtual_address.value == 0 || entry.size.value == 0 {
            return Ok(None);
        }
        let offset = self.rva_to_offset(entry.virtual_address.value)?;
        Ok(Some(debug::DebugDirectory::parse(
            &self.buffer,
            offset,
            entry.size.value as usize,
        )?))
    }

    /// Parses the load configuration directory when present.
    pub fn load_config(&self) -> Result<Option<load_config::LoadConfigDirectory>, FileParseError> {
        if !self.optional_header.has_data_directory(header::LOAD_CONFIG) {
            return Ok(None);
        }
        let entry = &self.optional_header.data_directories[header::LOAD_CONFIG];
        if entry.virtual_address.value == 0 {
            return Ok(None);
        }
        let offset = self.rva_to_offset(entry.virtual_address.value)?;
        Ok(Some(load_config::LoadConfigDirectory::parse(
            &self.buffer,
            offset,
            self.optional_header.pe_type()?,
        )?))
    }

    /// Parses the resource directory tree when present.
    pub fn resources(&self) -> Result<Option<resource::ResourceTree>, FileParseError> {
        if !self.optional_header.has_data_directory(header::RESOURCE) {
            return Ok(None);
        }
        let entry = &self.optional_header.data_directories[header::RESOURCE];
        if entry.virtual_address.value == 0 {
            return Ok(None);
        }
        let offset = self.rva_to_offset(entry.virtual_address.value)?;
        Ok(Some(resource::ResourceTree::parse(
            &self.buffer,
            offset,
            |rva| self.rva_to_offset(rva),
        )?))
    }

    /// Parses the COFF symbol table referenced by the file header.
    pub fn coff_symbols(&self) -> Result<symbol::CoffSymbolTable, FileParseError> {
        symbol::CoffSymbolTable::parse(
            &self.buffer,
            self.coff_header.pointer_to_symbol_table.value,
            self.coff_header.number_of_symbols.value,
        )
    }

    /// Parses COFF relocations attached to section `index`.
    pub fn section_relocations(
        &self,
        index: usize,
    ) -> Result<section_reloc::SectionRelocationBlock, FileParseError> {
        let section = self
            .sections
            .get(index)
            .ok_or(FileParseError::BufferOverflow)?;
        section_reloc::SectionRelocationBlock::parse(&self.buffer, index, section)
    }

    /// Parses COFF line numbers attached to section `index`.
    pub fn section_linenumbers(
        &self,
        index: usize,
    ) -> Result<linenum::LineNumberBlock, FileParseError> {
        let section = self
            .sections
            .get(index)
            .ok_or(FileParseError::BufferOverflow)?;
        linenum::LineNumberBlock::parse(&self.buffer, index, section)
    }

    /// Parses the Rich header between the DOS stub and PE signature when present.
    pub fn rich_header(&self) -> Result<Option<rich::RichHeader>, FileParseError> {
        rich::RichHeader::parse(&self.buffer, self.dos_header.e_lfanew.value as usize)
    }

    /// Parses the Authenticode certificate table when present (read-only overlay).
    pub fn certificates(&self) -> Result<Option<certificate::CertificateTable>, FileParseError> {
        if !self.optional_header.has_data_directory(header::SECURITY) {
            return Ok(None);
        }
        let entry = &self.optional_header.data_directories[header::SECURITY];
        if entry.virtual_address.value == 0 && entry.size.value == 0 {
            return Ok(None);
        }
        Ok(Some(certificate::CertificateTable::parse(
            &self.buffer,
            entry.virtual_address.value,
            entry.size.value,
        )?))
    }

    /// Parses the CLR `IMAGE_COR20_HEADER` when the COM descriptor directory is present.
    pub fn clr(&self) -> Result<Option<clr::Cor20Header>, FileParseError> {
        if !self
            .optional_header
            .has_data_directory(header::COM_DESCRIPTOR)
        {
            return Ok(None);
        }
        let entry = &self.optional_header.data_directories[header::COM_DESCRIPTOR];
        if entry.virtual_address.value == 0 {
            return Ok(None);
        }
        let offset = self.rva_to_offset(entry.virtual_address.value)?;
        Ok(Some(clr::Cor20Header::parse(&self.buffer, offset)?))
    }

    /// Inspects architecture-specific metadata (ARM64x, CHPE, architecture directory).
    pub fn architecture_data(&self) -> Result<arch_data::ArchitectureData, FileParseError> {
        let arch_dir = &self.optional_header.data_directories[header::ARCHITECTURE];
        let (hybrid_meta, chpe_meta) =
            if self.optional_header.has_data_directory(header::LOAD_CONFIG) {
                let lc = &self.optional_header.data_directories[header::LOAD_CONFIG];
                if lc.virtual_address.value != 0 {
                    let offset = self.rva_to_offset(lc.virtual_address.value)?;
                    let size = self
                        .load_config()
                        .ok()
                        .flatten()
                        .map(|cfg| cfg.size.value)
                        .unwrap_or(0);
                    match arch_data::HybridLoadConfigFields::parse(
                        &self.buffer,
                        offset,
                        size,
                        self.coff_header.machine.value,
                        self.optional_header.pe_type()?,
                    ) {
                        Ok(fields) => {
                            let image_base = match self.optional_header.image_base.value {
                                header::ImageBase::Base32(value) => value as u64,
                                header::ImageBase::Base64(value) => value,
                            };
                            // CHPEMetadataPointer is a VA, while architecture
                            // metadata is located using an RVA-to-file mapper.
                            let pointer = fields
                                .hybrid_metadata_pointer
                                .and_then(|f| f.value.checked_sub(image_base))
                                .filter(|&rva| rva <= u32::MAX as u64);
                            (pointer, pointer)
                        }
                        Err(_) => (None, None),
                    }
                } else {
                    (None, None)
                }
            } else {
                (None, None)
            };

        arch_data::ArchitectureData::parse(
            &self.buffer,
            &self.coff_header,
            arch_dir,
            hybrid_meta,
            chpe_meta,
            |rva| self.rva_to_offset(rva),
        )
    }
}

impl PE {
    /// Updates a data directory RVA in the optional header and buffer.
    pub fn sync_data_directory_rva(
        &mut self,
        index: usize,
        new_rva: u32,
    ) -> Result<(), FileParseError> {
        let entry = self
            .optional_header
            .data_directories
            .get_mut(index)
            .ok_or(FileParseError::BufferOverflow)?;
        entry.virtual_address.update(&mut self.buffer, new_rva)
    }

    /// Updates a data directory size in the optional header and buffer.
    pub fn sync_data_directory_size(
        &mut self,
        index: usize,
        new_size: u32,
    ) -> Result<(), FileParseError> {
        let entry = self
            .optional_header
            .data_directories
            .get_mut(index)
            .ok_or(FileParseError::BufferOverflow)?;
        entry.size.update(&mut self.buffer, new_size)
    }

    /// Updates the preferred image base and applies base relocations.
    pub fn apply_image_base(&mut self, new_base: header::ImageBase) -> Result<(), FileParseError> {
        let pe_type = self.optional_header.pe_type()?;
        let old_base = match self.optional_header.image_base.value {
            header::ImageBase::Base32(value) => value as u64,
            header::ImageBase::Base64(value) => value,
        };
        let new_base_value = match new_base {
            header::ImageBase::Base32(value) => value as u64,
            header::ImageBase::Base64(value) => value,
        };

        let base_relocations = self.base_relocations()?;
        relocation::apply_base_relocations(
            &mut self.buffer,
            &base_relocations,
            &self.sections,
            old_base,
            new_base_value,
            pe_type,
        )?;

        self.optional_header
            .image_base
            .update(&mut self.buffer, new_base)?;

        Ok(())
    }
}

impl<B: core::ops::Deref<Target = [u8]>> PE<B> {
    /// Writes [`PE::buffer`] to `output_path`.
    #[cfg(feature = "std")]
    pub fn write_file(&self, output_path: &str) -> io::Result<()> {
        let mut file: fs::File = fs::File::create(output_path)?;
        file.write_all(&self.buffer)?;
        Ok(())
    }

    /// Calculate the checksum for a PE file, ignoring the checksum field itself
    ///
    /// # Examples
    /// ```
    /// # #[cfg(feature = "std")]
    /// # {
    /// use hexspell::pe::PE;
    /// let pe = PE::from_file("tests/samples/sample1.exe").unwrap(); // Sample checksum has to be the correct
    /// let calculed_check:u32 = pe.calc_checksum();
    /// assert_eq!(pe.optional_header.checksum.value, calculed_check);
    /// # }
    /// ```
    pub fn calc_checksum(&self) -> u32 {
        let mut checksum: u64 = 0;
        let len = self.buffer.len();
        let mut i = 0;

        while i < len {
            // Skip checksum field
            if i == self.optional_header.checksum.offset {
                i += self.optional_header.checksum.size;
                continue;
            }

            if i + 1 < len {
                let word = u16::from_le_bytes([self.buffer[i], self.buffer[i + 1]]);
                checksum += word as u64;
                i += 2;
            } else {
                checksum += self.buffer[i] as u64;
                break;
            }
        }

        while checksum >> 16 != 0 {
            checksum = (checksum & 0xFFFF) + (checksum >> 16);
        }
        (checksum + len as u64) as u32
    }
}

impl PE {
    /// Reads and parses a PE file from disk.
    #[cfg(feature = "std")]
    pub fn from_file(path: &str) -> Result<PE, FileParseError> {
        let data: Vec<u8> = fs::read(path).map_err(|e: std::io::Error| FileParseError::Io(e))?;
        PE::from_buffer(data)
    }

    /// Parses a PE image from an owned byte buffer.
    pub fn from_buffer(buffer: Vec<u8>) -> Result<Self, FileParseError> {
        Self::parse_buffer(buffer)
    }

    fn build_section_header(
        &self,
        name: &str,
        size: u32,
        characteristics: u32,
    ) -> Result<section::PeSection, FileParseError> {
        let file_alignment = self.optional_header.file_alignment.value;
        let section_alignment = self.optional_header.section_alignment.value;

        if !file_alignment.is_power_of_two() || !section_alignment.is_power_of_two() {
            return Err(FileParseError::InvalidFileFormat);
        }
        let align = |value: u32, alignment: u32| {
            value
                .checked_add(alignment - 1)
                .map(|value| value & !(alignment - 1))
                .ok_or(FileParseError::ValueTooLarge)
        };

        let last_section = self
            .sections
            .last()
            .ok_or(FileParseError::InvalidFileFormat)?;

        let new_section_offset = last_section
            .characteristics
            .offset
            .checked_add(last_section.characteristics.size)
            .ok_or(FileParseError::BufferOverflow)?;
        let mut virtual_end = self.optional_header.size_of_headers.value;
        let mut raw_end = self.optional_header.size_of_headers.value;
        for section in &self.sections {
            virtual_end = virtual_end.max(
                section
                    .virtual_address
                    .value
                    .checked_add(
                        section
                            .virtual_size
                            .value
                            .max(section.size_of_raw_data.value),
                    )
                    .ok_or(FileParseError::ValueTooLarge)?,
            );
            if section.size_of_raw_data.value != 0 {
                raw_end = raw_end.max(
                    section
                        .pointer_to_raw_data
                        .value
                        .checked_add(section.size_of_raw_data.value)
                        .ok_or(FileParseError::ValueTooLarge)?,
                );
            }
        }
        let new_section_rva = align(virtual_end, section_alignment)?;
        let virtual_size = align(size, section_alignment)?;
        let size_of_raw_data = align(size, file_alignment)?;
        let raw_data_ptr = align(raw_end, file_alignment)?;

        // Check the complete new extents before insertion can mutate the buffer.
        align(
            new_section_rva
                .checked_add(virtual_size)
                .ok_or(FileParseError::ValueTooLarge)?,
            section_alignment,
        )?;
        raw_data_ptr
            .checked_add(size_of_raw_data)
            .ok_or(FileParseError::ValueTooLarge)?;

        let mut name_bytes = [0u8; 8];
        let name_slice = name.as_bytes();
        let len = name_slice.len().min(8);
        name_bytes[..len].copy_from_slice(&name_slice[..len]);

        Ok(section::PeSection {
            name: Field::new(FixedBytes(name_bytes), new_section_offset, 8),
            virtual_size: Field::new(virtual_size, new_section_offset + 8, 4),
            virtual_address: Field::new(new_section_rva, new_section_offset + 12, 4),
            size_of_raw_data: Field::new(size_of_raw_data, new_section_offset + 16, 4),
            pointer_to_raw_data: Field::new(raw_data_ptr, new_section_offset + 20, 4),
            pointer_to_relocations: Field::new(0, new_section_offset + 24, 4),
            pointer_to_linenumbers: Field::new(0, new_section_offset + 28, 4),
            number_of_relocations: Field::new(0, new_section_offset + 32, 2),
            number_of_linenumbers: Field::new(0, new_section_offset + 34, 2),
            characteristics: Field::new(characteristics, new_section_offset + 36, 4),
        })
    }

    /// Inserts a section described by [`section::NewSection`], updating headers and checksum.
    pub fn insert_section(
        &mut self,
        new: section::NewSection,
    ) -> Result<&section::PeSection, FileParseError> {
        let section_header = self.build_section_header(
            &new.name,
            u32::try_from(new.data.len()).map_err(|_| FileParseError::ValueTooLarge)?,
            new.characteristics,
        )?;
        self.insert_section_raw(section_header, new.data)?;
        Ok(self.sections.last().expect("section just pushed"))
    }

    /// Inserts a pre-built [`section::PeSection`] header and raw section data.
    pub fn insert_section_raw(
        &mut self,
        new_section: section::PeSection,
        data: Vec<u8>,
    ) -> Result<(), FileParseError> {
        self.insert_section_impl(new_section, data)
    }

    fn insert_section_impl(
        &mut self,
        mut new_section: section::PeSection,
        shellcode: Vec<u8>,
    ) -> Result<(), FileParseError> {
        const SECTION_HEADER_SIZE: usize = 40;

        // The header slot and the header area (padding is spliced in at SizeOfHeaders) must lie
        // inside the file. Checked before anything is modified so a failure leaves the buffer as is.
        let header_slot_end = new_section
            .name
            .offset
            .checked_add(SECTION_HEADER_SIZE)
            .ok_or(FileParseError::BufferOverflow)?;
        if header_slot_end > self.buffer.len()
            || self.optional_header.size_of_headers.value as usize > self.buffer.len()
        {
            return Err(FileParseError::BufferOverflow);
        }

        let fixups = layout::FileOffsetFixups::capture(self)?;
        let mut file_edits = Vec::new();

        let mut header_pad_diff = 0usize;
        if new_section.characteristics.offset + new_section.characteristics.size
            > self.optional_header.size_of_headers.value as usize
        {
            let new_size_of_headers =
                self.optional_header.size_of_headers.value + SECTION_HEADER_SIZE as u32;

            let alig_new_size_of_headers =
                (new_size_of_headers + self.optional_header.file_alignment.value - 1)
                    & !(self.optional_header.file_alignment.value - 1);
            let alig_old_size_of_headers = self.optional_header.size_of_headers.value;

            if alig_new_size_of_headers != alig_old_size_of_headers {
                self.optional_header
                    .size_of_headers
                    .update(&mut self.buffer, alig_new_size_of_headers)?;

                let diff = alig_new_size_of_headers as usize - alig_old_size_of_headers as usize;

                if diff > 0 {
                    header_pad_diff = diff;
                    let header_splice_at = alig_old_size_of_headers as usize;
                    self.buffer.splice(
                        header_splice_at..header_splice_at,
                        core::iter::repeat_n(0, diff),
                    );
                    file_edits.push((header_splice_at, 0, diff));

                    for section in self.sections.iter_mut() {
                        section.pointer_to_raw_data.update(
                            &mut self.buffer,
                            section.pointer_to_raw_data.value + diff as u32,
                        )?;
                    }

                    if self.optional_header.has_data_directory(header::SECURITY) {
                        let security = &mut self.optional_header.data_directories[header::SECURITY];
                        if security.virtual_address.value != 0
                            && security.virtual_address.value as usize >= header_splice_at
                        {
                            security.virtual_address.update(
                                &mut self.buffer,
                                security.virtual_address.value + diff as u32,
                            )?;
                        }
                    }
                }
            }
        }

        if header_pad_diff > 0 {
            let adjusted_ptr = new_section.pointer_to_raw_data.value + header_pad_diff as u32;
            new_section.pointer_to_raw_data.value = adjusted_ptr;
        }

        let raw_data_ptr = new_section.pointer_to_raw_data.value;
        let new_total_buffer_size =
            raw_data_ptr as usize + new_section.size_of_raw_data.value as usize;
        if (raw_data_ptr as usize) < self.buffer.len() {
            let raw_size = new_section.size_of_raw_data.value as usize;
            self.buffer.splice(
                raw_data_ptr as usize..raw_data_ptr as usize,
                core::iter::repeat_n(0, raw_size),
            );
            file_edits.push((raw_data_ptr as usize, 0, raw_size));
        } else if self.buffer.len() < new_total_buffer_size {
            self.buffer.resize(new_total_buffer_size, 0);
        }
        fixups.apply(&mut self.buffer, &file_edits)?;

        let mut section_header_buffer = Vec::with_capacity(SECTION_HEADER_SIZE);
        section_header_buffer.extend_from_slice(&new_section.name.value.0);
        section_header_buffer.extend(&new_section.virtual_size.value.to_le_bytes());
        section_header_buffer.extend(&new_section.virtual_address.value.to_le_bytes());
        section_header_buffer.extend(&new_section.size_of_raw_data.value.to_le_bytes());
        section_header_buffer.extend(&new_section.pointer_to_raw_data.value.to_le_bytes());
        section_header_buffer.extend(&new_section.pointer_to_relocations.value.to_le_bytes());
        section_header_buffer.extend(&new_section.pointer_to_linenumbers.value.to_le_bytes());
        section_header_buffer.extend(&new_section.number_of_relocations.value.to_le_bytes());
        section_header_buffer.extend(&new_section.number_of_linenumbers.value.to_le_bytes());
        section_header_buffer.extend(&new_section.characteristics.value.to_le_bytes());

        self.buffer.splice(
            new_section.name.offset..new_section.name.offset + SECTION_HEADER_SIZE,
            section_header_buffer.iter().copied(),
        );

        self.buffer.splice(
            raw_data_ptr as usize..raw_data_ptr as usize + shellcode.len(),
            shellcode.iter().copied(),
        );

        let new_size_of_image = (new_section.virtual_address.value
            + new_section.virtual_size.value
            + self.optional_header.section_alignment.value
            - 1)
            & !(self.optional_header.section_alignment.value - 1);
        self.optional_header
            .size_of_image
            .update(&mut self.buffer, new_size_of_image)?;

        self.coff_header.number_of_sections.update(
            &mut self.buffer,
            self.coff_header.number_of_sections.value + 1,
        )?;

        self.sections.push(new_section);

        // File-offset fixups may also change COFF and security directory fields.
        let buffer = core::mem::take(&mut self.buffer);
        *self = PE::from_buffer(buffer)?;

        let new_checksum = self.calc_checksum();
        self.optional_header
            .checksum
            .update(&mut self.buffer, new_checksum)?;

        Ok(())
    }
    /// Parses borrowed bytes without copying the file buffer.
    ///
    /// Headers and tables are still allocated. Use `from_buffer` for editing.
    ///
    /// Borrowed buffers cannot be patched:
    /// ```compile_fail
    /// use hexspell::pe::PE;
    /// let mut image = PE::from_slice(&[]).unwrap();
    /// image.coff_header.time_date_stamp.update(&mut image.buffer, 0).unwrap();
    /// ```
    pub fn from_slice(buffer: &[u8]) -> Result<PE<&[u8]>, FileParseError> {
        PE::parse_buffer(buffer)
    }
}

impl<B: core::ops::Deref<Target = [u8]>> PE<B> {
    fn parse_buffer(buffer: B) -> Result<Self, FileParseError> {
        let dos_header = dos::DosHeader::parse(&buffer)?;
        let pe_header_offset = dos_header.e_lfanew.value as usize;

        if buffer.len() < pe_header_offset + 24
            || &buffer[pe_header_offset..pe_header_offset + 4] != b"PE\0\0"
        {
            return Err(FileParseError::InvalidFileFormat);
        }

        let coff_offset = pe_header_offset + 4;
        let coff_header = coff::CoffFileHeader::parse(&buffer, coff_offset)?;
        let optional_header_offset = coff_offset + 20;
        let optional_header_size = coff_header.size_of_optional_header.value as usize;
        let sections_offset = optional_header_offset + optional_header_size;
        let number_of_sections = coff_header.number_of_sections.value;

        if buffer.len() < optional_header_offset + optional_header_size {
            return Err(FileParseError::BufferOverflow);
        }

        let optional_header = header::OptionalHeader::parse(&buffer, optional_header_offset)?;

        let sections_end = usize::from(number_of_sections)
            .checked_mul(40)
            .and_then(|size| sections_offset.checked_add(size))
            .ok_or(FileParseError::BufferOverflow)?;
        buffer
            .get(sections_offset..sections_end)
            .ok_or(FileParseError::BufferOverflow)?;
        let mut sections = Vec::with_capacity(number_of_sections as usize);
        let mut current_offset = sections_offset;
        for _ in 0..number_of_sections {
            let section = section::PeSection::parse_section(&buffer, current_offset)?;
            sections.push(section);
            current_offset += 40;
        }

        Ok(PE {
            buffer,
            dos_header,
            coff_header,
            optional_header,
            sections,
        })
    }
}