Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
psifertex committed Mar 27, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 889f302 commit a5c7605
Showing 2 changed files with 2 additions and 37 deletions.
36 changes: 1 addition & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,10 @@
# Kaitai UI Plugin (v1.1a)
Author: **Vector 35 Inc**
_Browse hex with a tree view populated from Kaitai Struct formats._
## Description:
This UI plugin allows you to browse a hex dump within Binary Ninja with a tree view informed by [Kaitai Struct](https://kaitai.io/).
This Binary Ninja UI plugin allows you to browse a hex dump within Binary Ninja with a tree view informed by [Kaitai Struct](https://kaitai.io/).

![](https://github.com/Vector35/kaitai/blob/master/media/kaitai.gif?raw=true)

This wires up Kaitai Struct as a parsing library to produce templated dissection of binary files. Of course, this concept itself isn’t new. Plenty of great tools like 010, Hexinator and Synalyze It! have this feature (last two by the same company for different platforms). Thanks to the Kaitai Project not only for the project in general, but also for working with us to resolve some small issues while we were developing the plugin.


## Installation Instructions

### Darwin

no special instructions, package manager is recommended

### Linux

no special instructions, package manager is recommended

### Windows

no special instructions, package manager is recommended
## Minimum Version

This plugin requires the following minimum version of Binary Ninja:

* 1200



## Required Dependencies

The following dependencies are required for this plugin:



## License

This plugin is released under a MIT license.
## Metadata Version

2
3 changes: 1 addition & 2 deletions plugin.json
Original file line number Diff line number Diff line change
@@ -4,7 +4,6 @@
"type": ["ui"],
"api": ["python2", "python3"],
"description": "Browse hex with a tree view populated from Kaitai Struct formats.",
"longdescription": "This UI plugin allows you to browse a hex dump within Binary Ninja with a tree view informed by [Kaitai Struct](https://kaitai.io/).\n\n![](https://github.com/Vector35/kaitai/blob/master/media/kaitai.gif?raw=true)\n\nThis wires up Kaitai Struct as a parsing library to produce templated dissection of binary files. Of course, this concept itself isn’t new. Plenty of great tools like 010, Hexinator and Synalyze It! have this feature (last two by the same company for different platforms). Thanks to the Kaitai Project not only for the project in general, but also for working with us to resolve some small issues while we were developing the plugin.",
"license": {
"name": "MIT",
"text": "Copyright (c) 2019 Vector 35 Inc\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE."
@@ -17,7 +16,7 @@
},
"dependencies": {
},
"version": "1.1a",
"version": "1.1.1",
"author": "Vector 35 Inc",
"minimumbinaryninjaversion": 1200
}

0 comments on commit a5c7605

Please sign in to comment.