Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Paolo Montesel committed May 27, 2020
1 parent ff65380 commit 96269bb
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,16 @@
# Nampa - FLIRT for (binary) ninjas

Author: **github.com/kenoph**

*Pure-python implementation of IDA Pro's FLIRT technology, and Binary Ninja plugin.*

**Note:** This project is still in an experimental phase and may fail to work or to recognize some functions.
*Pure-python implementation of IDA Pro's FLIRT technology. Also Binary Ninja plugin.*

## Description

Nampa is a package for reading IDA Pro's `.sig` files.
It comes with its own command-line tool for analyzing such files: `dumpsig.py`.

This repository will likely be split into a python-only package and a Binary Ninja plugin in the future,
as the former is completely decoupled from the latter.
Nampa the package is completely decoupled from the Binary Ninja plugin.

Nampa comes with a small library of `.sig` files, automatically downloaded
from 3rd-party GitHub repositories when needed.
Nampa the plugin comes with a small library of `.sig` files, automatically
downloaded from 3rd-party GitHub repositories when needed.

## Screenshot

Expand All @@ -33,7 +28,7 @@ For use as a Binary Ninja plugin:

```bash
cd ~/.binaryninja/plugins/
git clone git@github.com:kenoph/nampa.git
git clone git@github.com:thebabush/nampa.git
cd nampa
pip install -r requirements.txt # or sudo apt-get install python-future
```
Expand All @@ -42,16 +37,17 @@ pip install -r requirements.txt # or sudo apt-get install python-future

## About

Nampa ([なんぱ](http://jisho.org/search/%E8%BB%9F%E6%B4%BE)) is the Japanese art of picking up women on the street.
[Meaning of Nampa (ナンパ)](http://jisho.org/search/%E8%BB%9F%E6%B4%BE).

### Limitations

The code needs some real-world testing to rule out bugs introduced during the porting of flirt.c to python.
Ref functions are not implemented at the moment.

### Credits
### Thanks

A big part of this project is basically a python port of
- `radare` people, since this is basically a python port of
[radare's FLIRT implementation](https://raw.githubusercontent.com/radare/radare2/e8f80a165c7dd89d955a1ee7f432bd9a1ba88976/libr/anal/flirt.c).
- [trib0r3](https://github.com/trib0r3) for updating the Binary Ninja integration

### License

Expand Down

0 comments on commit 96269bb

Please sign in to comment.