macho-core 0.5.3

Byte-safe structural Mach-O parsing and validation
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

/// The constants module.
pub mod constants;
mod container;
/// The fat module.
pub mod fat;
/// The io module.
pub mod io;
/// The load_commands module.
pub mod load_commands;
/// The macho module.
pub mod macho;
/// The relocations module.
pub mod relocations;
/// The sections module.
pub mod sections;
/// The symbols module.
pub mod symbols;

pub use container::{parse, parse_with_options};
pub use fat::parse_fat_binary;
pub use macho::parse_macho_file;
pub use relocations::relocations_for_section;
pub use symbols::{fold_symbols, parse_symbol_table};

use crate::model::container::MachoContainer;
use crate::model::validate::Diagnostic;

/// Policy for handling recoverable structural diagnostics.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum ParseMode {
    /// Reject any error-severity structural diagnostic.
    Strict,
    /// Return the safe model together with recoverable diagnostics.
    Forensic,
}

/// Hard bounds applied before input-derived allocation or iteration.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ParseLimits {
    /// Maximum architecture entries in one fat container.
    pub max_fat_arches: usize,
    /// Maximum load commands in one Mach-O image.
    pub max_load_commands: usize,
    /// Maximum sections in one Mach-O image.
    pub max_sections: usize,
    /// Maximum cumulative load-command string bytes in one image.
    pub max_string_bytes: usize,
}

impl Default for ParseLimits {
    fn default() -> Self {
        Self {
            max_fat_arches: 256,
            max_load_commands: 10_000,
            max_sections: 100_000,
            max_string_bytes: 16 * 1024 * 1024,
        }
    }
}

/// Parse mode and hard resource limits.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ParseOptions {
    /// Recovery policy.
    pub mode: ParseMode,
    /// Hard limits.
    pub limits: ParseLimits,
}

impl Default for ParseOptions {
    fn default() -> Self {
        Self {
            mode: ParseMode::Strict,
            limits: ParseLimits::default(),
        }
    }
}

/// Safe parsed model plus recoverable diagnostics.
pub struct ParseOutcome<'data> {
    /// Parsed thin or fat container.
    pub container: MachoContainer<'data>,
    /// Structural diagnostics emitted after safe parsing.
    pub diagnostics: Vec<Diagnostic>,
}