binfarce 0.2.1

Extremely minimal parser for ELF, Mach-O, PE and ar.
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

// Prohibit dangerous things we definitely don't want
#![deny(clippy::integer_arithmetic)]
#![deny(clippy::cast_possible_truncation)]
#![deny(clippy::indexing_slicing)]
// Style lints
#![warn(clippy::cast_lossless)]

use std::{str, mem, convert::TryInto};
use crate::ByteOrder;

#[derive(Debug, Copy, Clone)]
pub struct UnexpectedEof {}

impl std::fmt::Display for UnexpectedEof {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "Unexpected end of file")
    }
}

impl std::error::Error for UnexpectedEof {}

pub trait RawNumber: Sized {
    fn parse(s: &mut Stream) -> Option<Self>;
}

impl RawNumber for u8 {
    #[inline]
    fn parse(s: &mut Stream) -> Option<Self> {
        s.data.get(s.offset).copied()
    }
}

impl RawNumber for i8 {
    #[inline]
    fn parse(s: &mut Stream) -> Option<Self> {
        s.data.get(s.offset).map(|x| *x as i8)
    }
}

impl RawNumber for u16 {
    #[inline]
    fn parse(s: &mut Stream) -> Option<Self> {
        let start = s.offset;
        let end = s.offset.checked_add(mem::size_of::<Self>())?;
        let num = u16::from_ne_bytes(s.data.get(start..end)?.try_into().unwrap());
        match s.byte_order {
            ByteOrder::LittleEndian => Some(num),
            ByteOrder::BigEndian => Some(num.to_be()),
        }
    }
}

impl RawNumber for i16 {
    #[inline]
    fn parse(s: &mut Stream) -> Option<Self> {
        u16::parse(s).map(|x| x as i16)
    }
}

impl RawNumber for u32 {
    #[inline]
    fn parse(s: &mut Stream) -> Option<Self> {
        let start = s.offset;
        let end = s.offset.checked_add(mem::size_of::<Self>())?;
        let num = u32::from_ne_bytes(s.data.get(start..end)?.try_into().unwrap());
        match s.byte_order {
            ByteOrder::LittleEndian => Some(num),
            ByteOrder::BigEndian => Some(num.to_be()),
        }
    }
}

impl RawNumber for u64 {
    #[inline]
    fn parse(s: &mut Stream) -> Option<Self> {
        let start = s.offset;
        let end = s.offset.checked_add(mem::size_of::<Self>())?;
        let num = u64::from_ne_bytes(s.data.get(start..end)?.try_into().unwrap());
        match s.byte_order {
            ByteOrder::LittleEndian => Some(num),
            ByteOrder::BigEndian => Some(num.to_be()),
        }
    }
}

#[derive(Clone, Copy)]
pub struct Stream<'a> {
    data: &'a [u8],
    offset: usize,
    byte_order: ByteOrder,
}

impl<'a> Stream<'a> {
    #[inline]
    pub fn new(data: &'a [u8], byte_order: ByteOrder) -> Self {
        Stream {
            data,
            offset: 0,
            byte_order,
        }
    }

    #[inline]
    pub fn new_at(data: &'a [u8], offset: usize, byte_order: ByteOrder) -> Result<Self, UnexpectedEof> {
        if offset < data.len() {
            Ok(Stream {
                data,
                offset,
                byte_order,
            })
        } else {
            Err(UnexpectedEof{})
        }
    }

    #[inline]
    pub fn at_end(&self) -> bool {
        self.offset >= self.data.len()
    }

    #[inline]
    pub fn offset(&self) -> usize {
        self.offset
    }

    #[inline]
    pub fn skip<T: RawNumber>(&mut self) -> Result<(), UnexpectedEof> {
        self.skip_len(mem::size_of::<T>())
    }

    #[inline]
    pub fn skip_len(&mut self, len: usize) -> Result<(), UnexpectedEof> {
        let new_offset = self.offset.checked_add(len);
        match new_offset {
            Some(valid_offset) => {self.offset = valid_offset; Ok(())}
            None => {Err(UnexpectedEof{})}
        }
    }

    #[inline]
    pub fn read<T: RawNumber>(&mut self) -> Result<T, UnexpectedEof> {
        let new_offset = self.offset.checked_add(mem::size_of::<T>()).ok_or(UnexpectedEof{})?;
        let v = T::parse(self).ok_or(UnexpectedEof{})?;
        self.offset = new_offset;
        Ok(v)
    }

    #[inline]
    pub fn read_bytes(&mut self, len: usize) -> Result<&'a [u8], UnexpectedEof> {
        let new_offset = self.offset.checked_add(len)
            .ok_or(UnexpectedEof{})?;
        let bytes = &self.data.get(self.offset..new_offset)
            .ok_or(UnexpectedEof{})?;
        self.offset = new_offset;
        Ok(bytes)
    }

    #[inline]
    pub fn remaining(&self) -> usize {
        self.data.len().saturating_sub(self.offset)
    }
}

pub fn parse_null_string(data: &[u8], start: usize) -> Option<&str> {
    match data.get(start..)?.iter().position(|c| *c == b'\0') {
        Some(i) if i != 0 => str::from_utf8(data.get(start..start.checked_add(i)?)?).ok(),
        _ => None,
    }
}