Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ubfx/bindiffhelper

Ghidra Extension to integrate BinDiff for function matching
https://github.com/ubfx/bindiffhelper

bindiff ghidra ghidra-extension reverse-engineering

Last synced: 6 days ago
JSON representation

Ghidra Extension to integrate BinDiff for function matching

Awesome Lists containing this project

README 

        
# BinDiffHelper



Ghidra extension that uses BinDiff on your Ghidra project to find matching functions and rename them automatically (BinDiff 6, 7, 8 supported).

Check out the [BinDiff manual](https://www.zynamics.com/bindiff/manual/) to see how it works and how it matches functions / basic blocks. However, with this extension, BinDiff is automated from within Ghidra, so you don't have to diff your binaries yourself.



**Please report bugs via the issue feature on github**



## What it does / Changelog

### v0.6

* Update sqlite driver library, should now run on Apple silicon

* Support external textual diffs between decompiled functions (see https://github.com/ubfx/BinDiffHelper/pull/24)

* UI updates



### v0.5

* Support BinDiff 8

* Release for Ghidra 11.1



### v0.4.3

* Release for Ghidra 11.0



### v0.4.2

* Add function to import all functions (not just the ones checked in the table)

* Add function to toggle the checkbox for multiple elements in the table

* Update to support Ghidra 10.3



### v0.4.1

* Update to support Gradle 7.5 and Ghidra 10.1



### v0.4.0

* Support BinDiff 7 and Ghidra 10



### v0.3.2

* Fixed a bug where diffing with a different file from same project didn't work

* Fixed a bug where files with short names (< 3 characters>) could not be diffed



### v0.3.1

* Fixed a crash when opening a file via the "from project" option



### v0.3

* Coloring matched functions in the listing

* Add comments to matched functions in the listing linking to the other binary

* Fixed a bug where protobuf library was missing in some builds

* New file load menu



### v0.2

* Fix a bug where the file to import to needed to be checked out.

* Increase size of project file selection dialog



### v0.1

* BinDiff the binary opened in Ghidra with another binary from the same Ghidra project, show results and import function names

* Open a BinDiff file, created with BinDiff 6, from two .BinExport files and import the matching function names in Ghidra



### Next releases

* Import function names and function parameters (type and name)

* Compare the binary opened in Ghidra with an external .BinExport (from IDA for example)

* Communication with the BinDiff 6 GUI to show graphs for the different functions



## How to Install

Either download the .zip-File from the [release](https://github.com/ubfx/BinDiffHelper/releases), if it's compatible to your Ghidra version, otherwise see *How to build* below.



1. Open Ghidra

1. In the **Main Window**: Go to **File->Install Extensions...**

1. Click the +-Button in the top right and select the BinDiffHelper zip file

1. Close the plugin manager. Restart Ghidra to load the new plugin

1. See *Usage* below



## Recommended other tools

* BinExport plugin [binaries](https://github.com/google/binexport/releases) or compiled from [source](https://github.com/google/binexport/tree/master/java/BinExport) for your specific Ghidra version

* BinDiff (https://zynamics.com/software.html)



Without these, you will only be able to import .BinDiff files and not automatically export and diff from your Ghidra project



## Usage

Make sure the plugin is loaded in the Code Explorer by opening a file in Ghidra and in the **Code Explorer** go to **File->Configure**



Click the small plug-icon in the top right:



![Configure tool](https://i.imgur.com/xVqdY9U.png)



and make sure the checkbox next to BinDiffHelperPlugin is checked.



![Configure plugins](https://i.imgur.com/n6yhIpz.png)



## Import external .BinDiff



The corresponding .BinExport-Files need to be in the same Folder.



Open the file you want to import names into in the code Browser, then go to **Window->BinDiffHelper**

![Open BinDiffHelper](https://i.imgur.com/nl5Jino.png)



Use the *Open from BinDiff* button or menu item and select your .BinDiff file.



![Example import](https://i.imgur.com/b9HXm3s.png)



Select all the function names you want to import and click the **Import function names** button in the top right or the menu item.



## Compare between files in Ghidra project

Go to **Window->BinDiffHelper**, make sure there are no warnings concerning BinExport or BinDiff, then click the **Open from project** button.



Select the other file from the tree and click OK.



![Example project import](https://i.imgur.com/ebJ6CA4.png)



## How to build

Requirements:



* Ghidra installation (https://ghidra-sre.org) or compiled from source

* Some jdk. There might be certain restrictions depending on how your Ghidra was built and what other plugins you're using. I recommend using [Temurin 21 LTS](https://adoptium.net/temurin/releases/?version=21), as this currently seems to work with both BinExport and BinDiffHelper. 

* gradle (tested with 7.5, 8.10)



### Clone the repository

Recursively clone the repository, as it depends on [BinExport](https://github.com/google/binexport) for the respective protocol buffer definition.

```

git clone --recurse-submodules https://github.com/ubfx/BinDiffHelper.git

```



### Build it

You need to set the `GHIDRA_INSTALL_DIR` environment variable to the Ghidra installation dir.

If you have different JDKs installed, make sure the environment variable `JAVA_HOME` points to the one your Ghidra installation uses.



The extension will be built for that Ghidra version specifically.



And then go the *BinDiffHelper folder* in your shell and do



```

gradle

```



This will build both BinExport in the respective submodule and BinDiffHelper in the parent directory. There should have been a .zip-File created in the dist directory. Use that .zip File to install according to the instructions above.



## Development / Debugging setup

Sometimes it's useful to be able to debug the extension together with Ghidra, here are some notes on that:



1. Clone and build Ghidra and let gradle create eclipse projects according to the DevGuide

1. Import the projects into eclipse (make sure it has relevant plugins for extension development)

1. Build and install GhidraDev

1. Unpack the Ghidra build and link GhidraDev to it. Maybe have to set `GHIDRA_INSTALL_DIR` environment variable

1. Run Ghidra from eclipse and install BinExport extension

1. Create BinDiffHelper eclipse project with `gradle build eclipse`

1. Import it into eclipse and use GhidraDev to link it to the Ghidra build

1. Debug As->Ghidra



When debugging Ghidra with the extension out of eclipse, the extension is loaded into Ghidra automatically (don't go through the usual extension install). However, the plugin has to be enabled in the Code Explorer.



## References

* https://github.com/google/bindiff/releases

* https://www.zynamics.com/bindiff/manual/

* https://github.com/google/binexport/



Icons from: [Fatcow free icons](https://www.fatcow.com/free-icons)