Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/matteyeux/binja-win-docs

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/matteyeux/binja-win-docs
Owner: matteyeux
License: apache-2.0
Created: 2022-12-27T19:46:02.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-04-11T07:12:18.000Z (7 months ago)
Last Synced: 2024-04-12T14:22:30.553Z (7 months ago)
Language: Python
Size: 16.6 KB
Stars: 6
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Binja Win Docs

_Binary Ninja plugin to display the documentation of a Windows function in a sidebar widget._

![Screenshot from 2023-01-01 12-40-15](https://user-images.githubusercontent.com/8758978/210169502-ceafcb37-53b0-403b-88e7-d018e3932acd.png)

### Description

This plugin adds a sidebar widget to Binary Ninja. If the cursor is set to a `call` instruction the plugin detects the function's name a requests MSDN documentation.

The requested documentation is then displayed in the sidebar widget.

Each documented function is also saved to a cache file named `cache.json` in the current plugin directory, meaning the plugin doesn't requests the doc for the same function everytime.

### Demo

![Desktop 02-01-2023 08-05-21](https://user-images.githubusercontent.com/8758978/210202853-841b973f-8add-4e35-bcf0-dde51ac5aa87.gif)

### Installation Instructions

#### Darwin

Clone this repository into `~/Library/Application Support/Binary Ninja/plugins/`

#### Windows

Clone this repository into `%APPDATA%/Binary Ninja/plugins/`

#### Linux

Clone this repository into `~/.binaryninja/plugins/`

### TODO

- [ ] Improve scrapper

- [ ] Gif demo

- [ ] It might me possible to use binja's context to get the function's name instead of calling BNILs functions

### Credits

- [Eric Hennenfent](https://github.com/ehennenfent) for [binja_explain_instruction](https://github.com/ehennenfent/binja_explain_instruction) which I used as templated for this plugin.

- [Hacking Things](https://github.com/HackingThings) for the [URL I needed to make this work](https://github.com/HackingThings/binja_MSDN_Helper/blob/main/__init__.py#L17).

- kareemovic1000 from the Noun Project for the icon.