rustbin 0.8.0

Parsers for binary file formats (mostly Windows related).
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

# RUSTBIN


[![Build Status](https://github.com/sunilkr/rustbin/actions/workflows/build.yml/badge.svg?event=push)](https://github.com/sunilkr/rustbin/actions/workflows/build.yml)

This is a learning project to understand Rust language and create fairly complex file parsers.

---

## Structure


Rustbin is created as a library which shall add more file parsers.

Every value which is part of a header is wrapped in `HeaderField` struct. `HeaderField` struct provides 3 values:

- value: The value of the field read from file
- offset: Offset of the the value in file. Structs have same offset as the offset of their first member
- rva: Relative Virtual Address
  - Applicable only to PE file format
  - Shall be same as offset wherever not applicable

## Supported Now


### PE (WIP)


#### Usage:


>Note: This example works only if built on Windows OS.

```rust
extern crate rustbin;
extern crate serde_json;

use std::{env, fs::OpenOptions, io::BufReader, path::Path};

use rustbin::{pe::{PeImage, ser::min::MinPeImage}, types::Header};

fn main() {
  //Create PathBuf for self (on Windows only).
  let args:Vec<String> = env::args().collect();
  let exe_name = args.get(0).unwrap();
  let binpath = Path::new(&exe_name);

  //Open file handle in read mode.
  let Ok(f) = OpenOptions::new()
    .read(true)
    .open(binpath)
  else {
    panic!("Failed to open file in read mode.");
  };
  
  //Parse the file from offset 0.
  let Ok(parsed) = parse_file(f, ParseAs::PE) else {
    panic!("Failed to parse as `PE`.");
  };

  let ParsedAs::PE(pe_image) = parsed;

  //Convert parsed image to a minimal set of `serde::Serialize`able values without metadata.
  let min_pe = MinPeImage::from(&pe_image);

  //Serialize minimal pe image to indented json.
  let json_str = serde_json::to_string_pretty(&min_pe).unwrap();

  println!("{}", json_str);
}

```

#### Parsing:


- [x] DOS Header
- [x] File Header
- [x] Optional Header x64
- [x] Optional Header x86
- [x] Data Directories
- [x] Section Headers
- [x] Imports
- [x] Exports
- [x] Relocations
- [x] Resources

#### Serialize (Minimal format)


- [x] DOS Header
- [x] File Header
- [x] Optional Header x64
- [x] Optional Header x86
- [x] Data Directories
- [x] Section Headers
- [x] Imports
- [x] Exports
- [x] Relocations
- [x] Resources