elf 0.8.0

A pure-rust library for parsing ELF files
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

//! Parsing [CompressionHeader] from compressed ELF sections
//!
//! Note: This library does not provide any decompression functionality, but
//! does expose parsed ELF compression headers alongside the raw compressed data.
//!
//! It is up to users of the library to choose the decompression library of
//! their choice when dealing with compressed section contents.
use crate::endian::EndianParse;
use crate::file::Class;
use crate::parse::{ParseAt, ParseError};

/// C-style 32-bit ELF Compression Header definition
///
/// These C-style definitions are for users who want to implement their own ELF manipulation logic.
#[derive(Debug)]
#[repr(C)]
pub struct Elf32_Chdr {
    pub ch_type: u32,
    pub ch_size: u32,
    pub ch_addralign: u32,
}

/// C-style 64-bit ELF Compression Header definition
///
/// These C-style definitions are for users who want to implement their own ELF manipulation logic.
#[derive(Debug)]
#[repr(C)]
pub struct Elf64_Chdr {
    pub ch_type: u32,
    pub ch_reserved: u32,
    pub ch_size: u64,
    pub ch_addralign: u64,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CompressionHeader {
    pub ch_type: u32,
    pub ch_size: u64,
    pub ch_addralign: u64,
}

impl ParseAt for CompressionHeader {
    fn parse_at<E: EndianParse>(
        endian: E,
        class: Class,
        offset: &mut usize,
        data: &[u8],
    ) -> Result<Self, ParseError> {
        match class {
            Class::ELF32 => Ok(CompressionHeader {
                ch_type: endian.parse_u32_at(offset, data)?,
                ch_size: endian.parse_u32_at(offset, data)? as u64,
                ch_addralign: endian.parse_u32_at(offset, data)? as u64,
            }),
            Class::ELF64 => {
                let ch_type = endian.parse_u32_at(offset, data)?;
                let _ch_reserved = endian.parse_u32_at(offset, data)?;
                Ok(CompressionHeader {
                    ch_type,
                    ch_size: endian.parse_u64_at(offset, data)?,
                    ch_addralign: endian.parse_u64_at(offset, data)?,
                })
            }
        }
    }

    #[inline]
    fn size_for(class: Class) -> usize {
        match class {
            Class::ELF32 => 12,
            Class::ELF64 => 24,
        }
    }
}

#[cfg(test)]
mod parse_tests {
    use super::*;
    use crate::endian::{BigEndian, LittleEndian};
    use crate::parse::{test_parse_for, test_parse_fuzz_too_short};

    #[test]
    fn parse_chdr32_lsb() {
        test_parse_for(
            LittleEndian,
            Class::ELF32,
            CompressionHeader {
                ch_type: 0x03020100,
                ch_size: 0x07060504,
                ch_addralign: 0x0B0A0908,
            },
        );
    }

    #[test]
    fn parse_chdr32_msb() {
        test_parse_for(
            BigEndian,
            Class::ELF32,
            CompressionHeader {
                ch_type: 0x00010203,
                ch_size: 0x04050607,
                ch_addralign: 0x08090A0B,
            },
        );
    }

    #[test]
    fn parse_chdr64_lsb() {
        test_parse_for(
            LittleEndian,
            Class::ELF64,
            CompressionHeader {
                ch_type: 0x03020100,
                ch_size: 0x0F0E0D0C0B0A0908,
                ch_addralign: 0x1716151413121110,
            },
        );
    }

    #[test]
    fn parse_chdr64_msb() {
        test_parse_for(
            BigEndian,
            Class::ELF64,
            CompressionHeader {
                ch_type: 0x00010203,
                ch_size: 0x08090A0B0C0D0E0F,
                ch_addralign: 0x1011121314151617,
            },
        );
    }

    #[test]
    fn parse_chdr32_lsb_fuzz_too_short() {
        test_parse_fuzz_too_short::<_, CompressionHeader>(LittleEndian, Class::ELF32);
    }

    #[test]
    fn parse_chdr32_msb_fuzz_too_short() {
        test_parse_fuzz_too_short::<_, CompressionHeader>(BigEndian, Class::ELF32);
    }

    #[test]
    fn parse_chdr64_lsb_fuzz_too_short() {
        test_parse_fuzz_too_short::<_, CompressionHeader>(LittleEndian, Class::ELF64);
    }

    #[test]
    fn parse_chdr64_msb_fuzz_too_short() {
        test_parse_fuzz_too_short::<_, CompressionHeader>(BigEndian, Class::ELF64);
    }
}