finch-examples's Introduction

falconre

Falconre is a python3 library using pyo3 to wrap:

Falcon - A binary analysis framework in Rust
Finch - A symbolic executor built on Falcon
Raptor - Higher order IR and analysis on top of Falcon

This is alpha-quality software.

What is this really?

This is me (endeav0r) hacking on Falcon and other things to try and automate different simple static analysis tasks.

Here are some things you can try:

Print out all the function calls in a program

git clone https://github.com/endeav0r/corpora
git clone https://github.com/falconre/falconre

# Build some example programs
pushd corpora
./build.sh
popd

# Build falconre in a Docker container
pushd falconre
docker build -t falconre .
# Watch youtube, this will take a few minutes
popd

docker run --rm -ti -v $(pwd):/opt falconre \
  python3 /opt/falconre/examples/print-calls.py \
  /opt/corpora/build/stack_buffer/vuln/one

Find trivial stack buffer overflows

# Run the example stack-writes.py script against a trivially vulnerable stack
# buffer overflow program.
docker run --rm -ti -v $(pwd):/opt falconre \
  python3 /opt/falconre/examples/stack-writes.py \
  /opt/corpora/build/stack_buffer/vuln/one

# Run the example stack-writes.py against a non-vulnerable version of the same
# program.
docker run --rm -ti -v $(pwd):/opt falconre \
  python3 /opt/falconre/examples/stack-writes.py \
  /opt/corpora/build/stack_buffer/not_vuln/one

Symbolically execute a toy amd64 assembly function

docker run --rm -ti -v $(pwd):/opt falconre \
  python3 /opt/falconre/examples/symex-one.py \
  /opt/corpora/build/symex/one

Print out DOT graph of Falcon IL

docker run --rm -ti -v $(pwd):/opt falconre \
  python3 /opt/falconre/examples/falcon-dot-graph.py \
  /opt/corpora/build/symex/one run | dot -Tpng -o /tmp/main.png

Installing

Docker

docker build -t falconre .

Natively on OSX

This is how I use falconre.

Install rust:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

You'll need this thing called "Rust nightly":

rustup toolchain install nightly
rustup default nightly

Get the dependencies

brew install z3 capstone

Install with setuptools

python3 setup.py install

If you don't want to install with setuptools, assuming you want to run the examples:

cargo build --release
cp target/release/libfalconre.dylib examples/falconre.so

finch-examples's People

Contributors

Stargazers

Watchers

finch-examples's Issues

Unable to build example-0

I attempted to build example-0 and got an error from some code in syntex_syntax. I'm not sure what this is, but I don't see it in the Cargo.toml file for this project, finch, nor falcon.

I wouldn't expect code that doesn't even compile to be able to make it into a release of a package (specifically: one of example-0's dependencies), but I don't have any other explanation...

I'm not really sure where to go from here on this one.

vagrant@debian9:~/finch-examples/example-0/example$ cargo build
   Compiling syntex_syntax v0.58.1
   Compiling syn v0.14.9
error[E0423]: expected function, tuple struct or tuple variant, found struct `ast::Name`
   --> /home/vagrant/.cargo/registry/src/github.com-1ecc6299db9ec823/syntex_syntax-0.58.1/src/symbol.rs:146:27
    |
146 |                       name: ast::Name($index),
    |                             ^^^^^^^^^
...
165 | / declare_keywords! {
166 | |     // Invalid identifier
167 | |     (0,  Invalid,        "")
168 | |
...   |
231 | |     (56, CrateRoot, "{{root}}")
232 | | }
    | |_- in this macro invocation

   Compiling syn v0.15.3
error: aborting due to previous error

For more information about this error, try `rustc --explain E0423`.
error: could not compile `syntex_syntax`.
warning: build failed, waiting for other jobs to finish...
error: build failed

Recommend Projects