Blogs & Stories

SpiderLabs Blog

Attracting more than a half-million annual readers, this is the security community's go-to destination for technical breakdowns of the latest threats, critical vulnerability disclosures and cutting-edge research.

Introducing the Burp Notes Extension

As a Security Analyst I spend a significant amount of timeworking in tools like Burp Suite. On any given project I need to keep track ofa large number of requests, responses, and various scan results. Conveniently,I can store all this in a single state file to keep for future referral. I alsouse a number of external scripts that have important output, but that endsup in a spread of text files that I have to keep track of. With that in mind,and the revamp of the Burp Extender API, I have decided to create an extensionto make organization a bit easier.

The Burp Notes Extension adds a tab to the interface where Ican create and manage text documents and spreadsheets. From the main tab a user can create newdocuments, load previously saved data, and save any currently open documents. I've also added the ability to import and export documents so that they can be easily reused for each project. One of the apparent limitations of the API is that it does not provideintegration with Burp's state functionality; all documents within the Notes tabare saved and loaded externally to the state file. I have taken care, however,to make sure that users are prompted to save before anything closes to makesure data isn't lost. State integration is on the top of my list once thatfunctionality becomes available.


Notes tab with a text file


Notes tab with a spreadsheet

I've also taken measures to integrate the tab with the restof Burp. Any response or request can be sent directly to an existing textdocument or added to a new one. The Notes context menu will appear in variousplaces, such as the proxy history and the site map table.

Context menu to capture requests and responses

This extension is dependent upon the newest API released with and unfortunately won't work with the current free release of Burp. While it doesn't access features only available in the Pro version, it does need access to the user interface exposed in the new framework in order to actually display text editors and spreadsheets. Once you have downloaded the JAR file, navigate to the Extender tab and choose "Add". Leave the extender type as Java and navigate to the file you downloaded. Once you select "Next" Burp will load the extension and you will be ready to go. Unless you specifically unload the extension, it should be there every time you start Burp for now on.

Working on this extension made for a fun introduction toBurp's API. I have a number of things I'd like to keep adding, such as more selective copying from responses or the ability to create and manage template sets. I also hope that mywork on this and future extensions will be useful to others.

The repository for this project can be found here on GitHub.