[go: up one dir, main page]

goblin 0.0.7

An impish, cross-platform binary parsing and loading crate
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

# libgoblin [![Build Status](https://travis-ci.org/m4b/goblin.svg?branch=master)](https://travis-ci.org/m4b/goblin)

![say the right words](https://s-media-cache-ak0.pinimg.com/736x/1b/6a/aa/1b6aaa2bae005e2fed84b1a7c32ecb1b.jpg)

### Documentation

https://docs.rs/goblin/

### Usage

Goblin requires `rustc` 1.15.

Add to your `Cargo.toml`

```toml
[dependencies]
goblin = "0.7.0"
```

### Features

* awesome crate name
* the best, most feature complete ELF64/32 implementation, ever - now with auto type punning!
* PE 32-bit support for binary analysis (raw writers are in the works)
* many cfg options - it will make your head spin, and make you angry when reading the source!
* slowly adding mach-o, mostly because it's boring and it's just a port of [rdr](http://github.com/m4b/rdr)
* goblins (TBA)
* tests

`libgoblin` aims to be your one-stop shop for binary parsing, loading,
and analysis.  Eventually, at some future date, once the holy trinity
is finished (ELF, mach, PE), writers for the various binary
formats are planned.

### Use-cases

Here are some things you could do with this crate (or help to implement so they could be done):

1. write a compiler and use it to generate binaries (all ELF32/64 have [`Pwrite`](https://github.com/m4b/scroll) derived)
2. write a binary analysis tool which loads, parses, and analyzes various binary formats, e.g., [panopticon](https://github.com/das-labor/panopticon)
3. write a [semi-functioning dynamic linker](http://github.com/m4b/dryad)
4. write a [kernel](https://github.com/redox-os/redox) and load binaries using `no_std` cfg. I.e., it is essentially just struct and const defs (like a C header) - no fd, no output, no std.
5. write a bin2json tool (http://github.com/m4b/bin2json), because why shouldn't binary formats be in JSON?

### Cfgs

`libgoblin` is designed to be massively configurable. The current flags are:

* elf64 - 64-bit elf binaries
* elf32 - 32-bit elf binaries
* pe32 - 32-bit PE binary parser
* archive - a Unix Archive parser
* endian_fd - parses according to the endianness in the binary
* std - to allow `no_std` environments
* pe64 - wip
* mach64 - wip
* mach32 - wip