sighthouse 1.0.5

A tool designed to assist reverse engineers by retrieving information and metadata from programs and identifying similar functions.

SightHouse

SightHouse is a tool designed to assist reverse engineers by retrieving information and metadata from programs and identifying similar functions. The project is divided into three parts:

• Signature Pipeline: Automatically feeds the signature database with new projects by scraping, compiling, and analyzing them.
• Frontend: A server that allows users to query signatures from the database produced by the signature pipeline.
• SRE Clients: Plugins tailored for each Software Reverse Engineering tool that interact with the frontend. We currently support IDA, Ghidra, and Binary Ninja.

Installation

SightHouse is available on Pypi.

# Install SRE clients only
pip install sighthouse-client 
# Install frontend only
pip install sighthouse-frontend
# Install pipeline only 
pip install sighthouse-pipeline
# Or install everything
pip install sighthouse[all]

From sources

You can also install it from the git repository:

# Download the repo
git clone https://github.com/quarkslab/sighthouse && cd sighthouse 
# Make install will create a new virtual env and install sighthouse in it
make install 

Build Documentation

The documentation can be build by first installing SightHouse and then serve the documentation on a local server.

# Skip this step if you already have a local repo
git clone https://github.com/quarkslab/sighthouse && cd sighthouse/doc 
# Install dependencies
make install
# Serve the documentation
make serve

An online documentation is available here.

Running unit tests

You can run unit tests locally for the default python version using:

# Skip this step if you already have a local repo
git clone https://github.com/quarkslab/sighthouse && cd sighthouse 
make test

Authors

• MadSquirrels (Forgette Benoit)
• Fenrisfulsur (Babigeon Sami)