https://github.com/binaryanalysisplatform/bap-mode
An Emacs major mode for BAP's intermediate language
https://github.com/binaryanalysisplatform/bap-mode
bap emacs emacs-lisp intermediate-language
Last synced: 11 months ago
JSON representation
An Emacs major mode for BAP's intermediate language
- Host: GitHub
- URL: https://github.com/binaryanalysisplatform/bap-mode
- Owner: BinaryAnalysisPlatform
- License: mit
- Created: 2018-08-02T10:36:19.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-07-10T08:38:03.000Z (almost 6 years ago)
- Last Synced: 2025-05-07T17:15:06.752Z (about 1 year ago)
- Topics: bap, emacs, emacs-lisp, intermediate-language
- Language: Emacs Lisp
- Homepage:
- Size: 20.5 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bap-mode: an Emacs major mode for BAP's IR
[](https://melpa.org/#/bap-mode)
## What is bap-mode?
bap-mode is an Emacs major mode for reading and analyzing programs in [BAP](https://github.com/BinaryAnalysisPlatform/bap)'s IR. It allows to interact with BAP from within emacs. For example, *bap-open-file* (`C-c C-b o`) opens a file with BAP and emits the IR to an Emacs buffer. bap-mode hightlights the syntax and allows to quickly navigate the code (e.g. `C-c C-b m` to jump to the main function).
## How to install bap-mode?
bap-mode is avilable on [Melpa](https://melpa.org/). Install it with `M-x package-install bap-mode `. bap-mode requires [Helm](https://emacs-helm.github.io/helm/).
## How to use bap-mode?
The following keybindings are defined per default:
- `C-c C-b d` *bap-goto-function-definition*: jump to a function definition (presents function candidates with Helm)
- `C-c C-b l` *bap-goto-label*: jump to a label
- `C-c C-b m` *bap-goto-main*: jump to main function
- `C-c C-b o` *bap-open-file*: opens a binary with BAP and emits the IR
- `C-c C-b p` *bap-open-file-with-extra-pass*: same as above but adds an extra pass before emitting the IR
## Future work
Some of the things that would be nice to have are:
- jump to definition at point (function or address)
As always on github, pull requests are welcomed!
## Acknowledgments
This project is partly financed by [German Federal Office for Information Security (BSI)](https://www.bsi.bund.de).
## License
```
The MIT License (MIT)
bap-mode
Copyright (C) 2018 - 2019 Thomas Barabosch of Fraunhofer FKIE
Based on emacs-mips-mode
Copyright (c) 2017 Henrik Lissner
Permission 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:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE 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.
```