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
use crate::*;
use std::fs::File;
use std::io::Read;

use thiserror::Error as TError;

#[derive(TError, Debug)]
pub enum ReadELFError {
    #[error("input file `{file_path}` is not an ELF file")]
    NotELF { file_path: String },
    #[error("can't parse elf header => `{k}`")]
    CantParseELFHeader { k: Box<dyn std::error::Error> },
    #[error("can't parse section header => `{k}`")]
    CantParseSectionHeader { k: Box<dyn std::error::Error> },
    #[error("can't parse program header => `{k}`")]
    CantParseProgramHeader { k: Box<dyn std::error::Error> },
    #[error("can't parse symbol => `{k}`")]
    CantParseSymbol { k: Box<dyn std::error::Error> },
}

/// read 64bit ELF and construct `file::ELF64`
pub fn read_elf64(file_path: &str) -> Result<file::ELF64, Box<dyn std::error::Error>> {
    let mut f = File::open(file_path)?;
    let mut buf = Vec::new();
    let _ = f.read_to_end(&mut buf);

    let _ = check_elf_magic(file_path, &buf[..4])?;

    let elf_header = parse_elf64_header(&buf[..header::Ehdr64::size() as usize])?;
    let phdr_table_exists = elf_header.e_phnum != 0;

    let mut elf_file = file::ELF64::new(elf_header);

    let sections = read_elf64_sections(&elf_file.ehdr, &buf)?;
    elf_file.sections = sections;

    if phdr_table_exists {
        let segments = read_elf64_segments(&elf_file.ehdr, &buf)?;
        elf_file.segments = segments;
    }
    set_sections_name_shstrtab(&mut elf_file);
    set_symbols_name(&mut elf_file);

    Ok(elf_file)
}

fn read_elf64_sections(
    elf_header: &header::Ehdr64,
    buf: &[u8],
) -> Result<Vec<section::Section64>, Box<dyn std::error::Error>> {
    let mut sections: Vec<section::Section64> = Vec::new();

    for sct_idx in 0..elf_header.e_shnum {
        let header_start =
            elf_header.e_shoff as usize + section::Shdr64::size() as usize * sct_idx as usize;
        let shdr = section::Shdr64::deserialize(buf, header_start)?;

        let mut sct = section::Section64::new(String::new(), shdr);

        if sct.header.sh_size != 0 {
            let sct_start = sct.header.sh_offset as usize;
            let sct_type = sct.header.get_type();

            match sct_type {
                section::Type::SymTab | section::Type::DynSym => {
                    let symbols = parse_bytes_as_vec(&sct, sct_start, buf)?;
                    sct.symbols = Some(symbols);
                }

                section::Type::Rela => {
                    let rela_symbols = parse_bytes_as_vec(&sct, sct_start, buf)?;
                    sct.rela_symbols = Some(rela_symbols);
                }
                section::Type::Dynamic => {
                    let dynamics = parse_bytes_as_vec(&sct, sct_start, buf)?;
                    sct.dynamics = Some(dynamics);
                }

                section::Type::NoBits => {}

                // 通常通りバイト列として処理
                _ => {
                    sct.bytes =
                        Some(buf[sct_start..sct_start + sct.header.sh_size as usize].to_vec());
                }
            }
        }

        // sct.shdrがシンボルテーブルなどの場合,追加の処理が必要となる
        sections.push(sct);
    }

    Ok(sections)
}

fn parse_bytes_as_vec<'a, T: serde::Deserialize<'a>>(
    sct: &section::Section64,
    sct_start: usize,
    buf: &'a [u8],
) -> Result<Vec<T>, Box<dyn std::error::Error>> {
    let ent_size = sct.header.sh_entsize as usize;
    let symbol_number = sct.header.sh_size as usize / ent_size;
    let mut symbols: Vec<T> = Vec::new();

    for sym_idx in 0..symbol_number {
        let sym_start = sct_start + sym_idx * ent_size;
        let sym_end = sct_start + (sym_idx + 1) * ent_size;

        let sym: T = match bincode::deserialize(&buf[sym_start..sym_end]) {
            Ok(s) => s,
            Err(e) => {
                return Err(Box::new(ReadELFError::CantParseSymbol { k: e }));
            }
        };
        symbols.push(sym);
    }

    Ok(symbols)
}

fn read_elf64_segments(
    elf_header: &header::Ehdr64,
    buf: &[u8],
) -> Result<Vec<segment::Segment64>, Box<dyn std::error::Error>> {
    let mut segments: Vec<segment::Segment64> = Vec::new();

    for seg_idx in 0..elf_header.e_phnum {
        let header_start =
            elf_header.e_phoff as usize + segment::Phdr64::size() as usize * seg_idx as usize;
        let phdr = segment::Phdr64::deserialize(buf, header_start)?;

        let seg = segment::Segment64::new(phdr);
        segments.push(seg);
    }

    Ok(segments)
}

fn set_sections_name_shstrtab(elf_file: &mut file::ELF64) {
    let shstrndx = elf_file.ehdr.e_shstrndx as usize;
    let shnum = elf_file.ehdr.e_shnum as usize;

    let mut sh_name: u32 = 1;
    for idx in 0..shnum {
        if idx == 0 || idx >= shnum {
            continue;
        }

        let name_idx = elf_file.sections[idx].header.sh_name;

        let name_bytes: Vec<u8> = elf_file.sections[shstrndx].bytes.as_ref().unwrap()
            [name_idx as usize..]
            .to_vec()
            .iter()
            .take_while(|byte| **byte != 0x00)
            .map(|byte| *byte)
            .collect();

        elf_file.sections[idx].name = std::str::from_utf8(&name_bytes).unwrap().to_string();
        elf_file.sections[idx].header.sh_name = sh_name as u32;
        sh_name += name_bytes.len() as u32 + 1;
    }
}

fn set_symbols_name(elf_file: &mut file::ELF64) {
    let shnum = elf_file.ehdr.e_shnum as usize;

    for idx in 0..shnum {
        if elf_file.sections[idx].header.get_type() != section::Type::SymTab
            && elf_file.sections[idx].header.get_type() != section::Type::DynSym
        {
            continue;
        }

        let symbol_strtab_idx = elf_file.sections[idx].header.sh_link as usize;
        let symbol_strtab = elf_file.sections[symbol_strtab_idx]
            .bytes
            .as_ref()
            .unwrap()
            .clone();

        if let Some(ref mut symbols) = elf_file.sections[idx].symbols {
            let symbol_number = symbols.len();

            for sym_idx in 0..symbol_number {
                let name_idx = symbols[sym_idx].st_name;
                let name_bytes: Vec<u8> = symbol_strtab[name_idx as usize..]
                    .to_vec()
                    .iter()
                    .take_while(|byte| **byte != 0x00)
                    .map(|byte| *byte)
                    .collect();

                symbols[sym_idx].symbol_name =
                    Some(std::str::from_utf8(&name_bytes).unwrap().to_string());
            }
        }
    }
}

fn check_elf_magic(file_path: &str, buf: &[u8]) -> Result<(), Box<dyn std::error::Error>> {
    assert_eq!(buf.len(), 4);

    if buf[0] != 0x7f || buf[1] != 0x45 || buf[2] != 0x4c || buf[3] != 0x46 {
        return Err(Box::new(ReadELFError::NotELF {
            file_path: file_path.to_string(),
        }));
    }

    Ok(())
}

fn parse_elf64_header(buf: &[u8]) -> Result<header::Ehdr64, Box<dyn std::error::Error>> {
    assert_eq!(buf.len(), header::Ehdr64::size() as usize);

    header::Ehdr64::deserialize(buf, 0)
}

#[cfg(test)]
mod parse_tests {
    use super::*;

    #[test]
    fn check_elf_magic_test() {
        assert!(check_elf_magic("", &[0x7f, 0x45, 0x4c, 0x46]).is_ok());
        assert!(check_elf_magic("", &[0x7f, 0x45, 0x4b, 0x46]).is_err());
        assert!(check_elf_magic("", &[0x7f, 0x42, 0x43, 0x46]).is_err());
    }

    #[test]
    fn parse_elf64_header_test() {
        let header_bytes = vec![
            0x7f, 0x45, 0x4c, 0x46, 0x02, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
            0x00, 0x00, 0x03, 0x00, 0x3e, 0x00, 0x01, 0x00, 0x00, 0x00, 0x60, 0xe1, 0x00, 0x00,
            0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x20, 0x1d,
            0x57, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x38, 0x00,
            0x0c, 0x00, 0x40, 0x00, 0x2c, 0x00, 0x2b, 0x00,
        ];
        let hdr_result = parse_elf64_header(&header_bytes);
        assert!(hdr_result.is_ok());
        let hdr_result = hdr_result.unwrap();

        assert_eq!(hdr_result.get_type(), header::Type::Dyn);
        assert_eq!(hdr_result.e_entry, 0xe160);
        assert_eq!(hdr_result.e_shnum, 44);
    }

    #[test]
    fn read_elf64_test() {
        let f_result = read_elf64("examples/sample");
        assert!(f_result.is_ok());
        let f = f_result.unwrap();

        assert_eq!(f.ehdr.e_entry, 0x1040);
        assert_eq!(f.ehdr.e_shnum, 29);
        assert_eq!(f.ehdr.e_shstrndx, 28);

        assert_eq!(f.sections.len(), 29);
        assert_eq!(f.segments.len(), 13);

        assert_eq!(".interp", &f.sections[1].name);
        assert_eq!(f.sections[1].header.get_type(), section::Type::ProgBits);
        assert_eq!(f.sections[1].header.sh_addr, 0x318);
        assert_eq!(f.sections[1].header.sh_offset, 0x318);
        assert_eq!(f.sections[1].header.sh_addralign, 0x1);
        assert_eq!(f.sections[1].header.sh_flags, section::SHF_ALLOC);
        assert_eq!(f.sections[1].header.sh_size, 0x1c);
        assert!(f.sections[1].bytes.is_some());
        assert_eq!(
            f.sections[1].bytes.as_ref().unwrap().len(),
            f.sections[1].header.sh_size as usize
        );

        assert_eq!(f.sections[2].header.get_type(), section::Type::Note);
        assert_eq!(f.sections[2].header.sh_addr, 0x338);
        assert!(f.sections[2].bytes.is_some());
        assert_eq!(
            f.sections[2].bytes.as_ref().unwrap().len(),
            f.sections[2].header.sh_size as usize
        );

        assert_eq!(f.sections[10].header.get_type(), section::Type::Rela);
        assert_eq!(f.sections[10].rela_symbols.as_ref().unwrap().len(), 8);
        assert_eq!(f.sections[26].header.get_type(), section::Type::SymTab);
        assert_eq!(f.sections[26].symbols.as_ref().unwrap().len(), 62);
        assert!(f.sections[26].symbols.as_ref().unwrap()[26]
            .symbol_name
            .is_some());
        assert_eq!(
            f.sections[26].symbols.as_ref().unwrap()[26]
                .symbol_name
                .as_ref()
                .unwrap(),
            "crtstuff.c"
        );
        assert_eq!(
            f.sections[26].symbols.as_ref().unwrap()[45]
                .symbol_name
                .as_ref()
                .unwrap(),
            "_ITM_deregisterTMCloneTable"
        );

        assert_eq!(f.sections[21].header.get_type(), section::Type::Dynamic);
        // assert_eq!(f.sections[21].dynamics.as_ref().unwrap().len(), 24);
        assert_eq!(
            f.sections[21].dynamics.as_ref().unwrap()[1].get_type(),
            dynamic::EntryType::Init
        );
        assert_eq!(
            f.sections[21].dynamics.as_ref().unwrap()[2].get_type(),
            dynamic::EntryType::Fini
        );

        assert_eq!(f.segments[0].header.get_type(), segment::Type::Phdr);
        assert_eq!(f.segments[0].header.p_flags, segment::PF_R);
        assert_eq!(f.segments[0].header.p_align, 8);

        assert_eq!(f.segments[1].header.get_type(), segment::Type::Interp);
        assert_eq!(f.segments[1].header.p_flags, segment::PF_R);
        assert_eq!(f.segments[1].header.p_align, 1);
    }

    #[test]
    fn read_elf64_test_2() {
        let f_result = read_elf64("/bin/ls");
        assert!(f_result.is_ok());
    }
}