gman0064/chisel
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Actually update README this time

Browse Source
This commit is contained in:
Garrett Dickinson 2023-03-01 01:52:19 -06:00
parent 0d227f10af
commit b2e4ef8522
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,12 +1,16 @@
# chisel
`chisel` is a tool for decompiling *nix ELF programs for binary analysis and reverse engineering. This project is being developed for assignments pertaining to Auburn University's **COMP5970 Binary Program Analysis** course.
## Binary Analysis Technique
## Supported Binary formats
`chisel` uses a linear dissassembly approach for converting the ELF text section into x86 assembly instructions. Future implementations will have more advances analysis techniques such as recursive descent, as well as potential binary patching.
## Supported formats
`chisel` supports binaries compiled to the [ELF format](https://en.wikipedia.org/wiki/Executable_and_Linkable_Format) from most x86/x64 *nix systems, and __does not__ currently support macOS Mach-O or Windows PE binaries.
> Due to an indexing bug, current iterations of chisel do not support 32-bit x86 applications
> Due to an indexing bug, current iterations of chisel do not support 32-bit x86 applications. Only x86-64 is supported.
## Building and Installing
@ -22,6 +26,8 @@ $ cd chisel && cargo install
## Usage
The following format can be used to pass a binary to `chisel` to analyze. The repository also includes a few binaries in `./testing/` as included examples.
```shell
$ chisel [path to ELF executable]
```