binja_toolbar

binja_toolbar is a fork of BinjaDock that adds a toolbar to Binary Ninja and allows you to easily add buttons to it. This probably won't be useful on its own, but plugin developers may find it makes it easy for them to effectively incorporate their code into the UI.

Installation

Inside your Binary Ninja plugins folder, just run git clone https://github.com/ehennenfent/binja_toolbar.git

Usage

After loading a binary, just click the Initialize toolbar for this view item in the tools menu.

Sample Utilization

The following script adds some demo buttons to the toolbar. This can be placed in the __init__.py file of its own plugin. In your own plugins, you can simply import the add_image_button and add_text_button functions from binja_toolbar.

~/
  .binaryninja/
    plugins/
      toolbar_tester/
        __init__.py
        fidget_spinner.png
      binja_toolbar/

from binja_toolbar import add_image_button, add_text_button
from binaryninja import log

def show_demo_message(_view):
    try:
        log.log(3, "Current bv is associated with: " + _view.file.filename)
    except:
        print("No view yet!")

add_text_button("Test", show_demo_message)

def show_toolbar_message(_view):
    log.log(3, "This is an image button!")

add_image_button('.binaryninja/plugins/toolbar_tester/fidget_spinner.png', (24,24), show_toolbar_message, tooltip="Just a demo button")

Note that plugins are initialized inside of ~, so it is necessary to specify the entire file path for images.

API

add_text_button(name, function, tooltip)
  name: Text to display on the button
  function: function pointer to the callback to be executed each time the button is pushed. The current binary view is passed as an argument to this function
  tooltip: optional tooltip to display

add_image_button(filename, size, function, tooltip)
  filename: full path to the image to display
  size: a tuple containing the desired rendered size of the icon
  function: function pointer to the callback to be executed each time the button is pushed. The current binary view is passed as an argument to this function
  tooltip: optional tooltip to display

add_picker(items, callback)
  items: a list of strings to be displayed in the combobox
  callback: a function to be executed when the item in the combobox is changed. Gets passed the index of the new item.

Current Limitations

There's currently (to my knowledge) no good way to track when the user switches between open binary views, so this plugin works best when used with only a single binary open. One can make it work by reinitializing the toolbar every time one switches between binaries, but that's less than ideal. This may not be fixed until the upcoming UI API features in version 1.2.

Requirements

• PyQt5
• Binary Ninja

binja_toolbar has only been tested on Ubuntu 16.04. You are encouraged to file a pull request or open an issue for any incompatibilities.