Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/parsiya/bug-diaries
A extension for Burp's free edition that mimics the pro edition's custom scan issues.
https://github.com/parsiya/bug-diaries
burpsuite extension
Last synced: 3 months ago
JSON representation
A extension for Burp's free edition that mimics the pro edition's custom scan issues.
- Host: GitHub
- URL: https://github.com/parsiya/bug-diaries
- Owner: parsiya
- License: gpl-3.0
- Created: 2019-11-14T06:03:12.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-23T16:54:37.000Z (almost 5 years ago)
- Last Synced: 2024-05-20T10:36:22.232Z (9 months ago)
- Topics: burpsuite, extension
- Language: Java
- Homepage:
- Size: 2.81 MB
- Stars: 8
- Watchers: 3
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bug Diaries
Burp Issues for All!
Bug Diaries is a Burp extension that implements an bug tracker for the
community edition of Burp.
It's under heavy development but the `master` branch works.
Originally, the extension was written in Python. While the Python version works,
the Java version has more capabilities. See the Python version inside
[@Python](@python).
## Usage
1. Add the pre-built jar file at [release/BugDiaries-all.jar](release/BugDiaries-all.jar).
## Building The Extension
1. Clone the repository.
2. Setup Open JDK 11.
3. Setup Gradle.
1. Use the instructions at: https://gradle.org/install/
4. If you prefer the Wrapper:
1. *nix: `./gradlew wrapper --gradle-version=6.0.1 --distribution-type=bin`
2. Windows: `gradlew.bat wrapper --gradle-version=6.0.1 --distribution-type=bin`
5. Run `gradle bigjar` or `gradlew[.bat] bigjar` (if you use the Wrapper).
6. The newly built jar file will be at [release/BugDiaries-all.jar](release/BugDiaries-all.jar).
## Development
For more information about my development process (and debugging Burp
extensions), please see the following blog post:
* https://parsiya.net/blog/2019-12-02-developing-and-debugging-java-burp-extensions-with-visual-studio-code/
# Features
## Adding a New Bug
1. Right click on any request and select `Send to Bug Diaries`.
* Every tab that supports context menus in Burp works. E.g., Target, Proxy,
and Repeater.
2. A new frame pops up with the request, response, host, and path (based on the
request), already populated.
3. Set a name for your bug.
4. Optionally, select a template. The template will overwrite description,
remediation, and add the CWE number and name to the bug name.
* See below on how to customize it.
5. Press `Save`.
6. The bug will be added to the `Bug Diaries` tab.
## Viewing Bugs
1. In the `Bug Diaries` tab, select any bug.
2. The details will be populated in the panel.
## Sending Requests to Other Burp tabs
1. Right click on the request or response message editor for any bug in the
main tab.
2. Send the request or response to any other Burp tab such as Repeater,
Comparer, or Intruder.
## Editing Bugs
1. Double click on any bug, in the `Bug Diaries` tab.
2. A new frame will pop-up that allows editing.
3. Edit the bug and press `Save`.
4. Modified bug will be displayed in the table.
## Exporting Bugs
Bug Diaries supports exporting bugs to JSON.
1. In the `Bug Diaries` tab click `Export`.
2. Select a file in the dialog. By default, only `.json` files are displayed.
* The extension remembers your last used directory.
* The extension does not warn you if a file already exists.
3. Bugs will be exported in JSON format to the file.
## Importing Bugs
The JSON file can be imported again.
*Note: Importing will overwrite current bugs.*
1. In the `Bug Diaries` tab click `Import`.
2. Select the file with exported bugs.
3. Bugs are not populated in the table. As mentioned above, current items in
the table are overwritten.
# TODO
A lot. See Github issues for som planned features.
# Bugs
Please make a Github issue.
# License
GPLv3, see [LICENSE](LICENSE) for details.