binper 0.1.2

BINPER is a binary parser library in Rust.
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

# BINPER
[![](http://meritbadge.herokuapp.com/binper)](https://crates.io/crates/binper)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
![](https://img.shields.io/badge/unsafe-forbidden-success.svg)

## Description 
BINPER is a binary parser library in Rust.  

 🔒 Implemented using 100% safe rust and works on all platforms supported by rust

## Install
```bash
cargo install binper
```
## Binary usage
```bash
binper [BIN_FILE_PATH]
```
#### ⚠️ WARNING  ⚠️
Currently, only PE file parsing is implemented

## Library usage
```rust
use std::fs::File;
use std::io::Read;

use binper::pe::pe::PE;

fn main() -> binper::error::Result<()> {
    let mut f = File::open("samples/pe.exe")?;
    let mut data = Vec::new();
    f.read_to_end(&mut data)?;
    let pe:PE = PE::new(&data)?;
    println!("{}", pe);

    Ok(())
}
```

## Progress
Windows binary PE 
- [x] DOS header
- [x] PE header
- [x] Optional header
- [x] Data Directories
- [x] Sections
- [ ] Export, Import tables
- [ ] Resources

Linux binary ELF
- [ ] ELF header
- [ ] Program header table
- [ ] Sections

## Contribution
If you want to add some features, fix bugs or improve the code as defined in the MIT license, without any additional terms or conditions, 
I will gladly accept. 

## ⚠️ WARNING  ⚠️
This is an alpha version.  
I don't recommend you to use in your production applications.  
The structure of objects can change.

## License

`binper` is distributed under the terms of the MIT license.

See [LICENSE](./LICENSE) for
details.

## Acknowledgments
This project has been inspired by [goblin](https://github.com/m4b/goblin) project.