https://github.com/silentsignal/burp-commentator

Generates comments for selected request(s) based on regular expressions
https://github.com/silentsignal/burp-commentator

burp

Last synced: about 2 months ago
JSON representation

Generates comments for selected request(s) based on regular expressions

• Host: GitHub
• URL: https://github.com/silentsignal/burp-commentator
• Owner: silentsignal
• License: mit
• Created: 2017-01-20T10:38:50.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-06-28T12:27:04.000Z (about 6 years ago)
• Last Synced: 2024-05-09T00:04:49.801Z (4 months ago)
• Topics: burp
• Language: Java
• Homepage:
• Size: 84 KB
• Stars: 6
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-burp-extensions - Burp Commentator - Generates comments for selected request(s) based on regular expressions. (Logging and Notes / SSRF)

README

        
Comment generator plugin for Burp Suite

=======================================

[![Build Status](https://travis-ci.org/silentsignal/burp-commentator.svg?branch=master)](https://travis-ci.org/silentsignal/burp-commentator)

Generates comments for selected request(s) based on regular expressions.

Usage

-----

Select one or more HTTP messages (for example items in the top half of the

`HTTP history` tab within `Proxy`. Click with the right mouse button to open the

popup menu, and select `Generate comment field...`.

A window appears with several options:

![screenshot](screenshot.png)

 - A regular expression can be entered in the text field, the first group

   will become the comment on the selected items.

 - The dropdown list on the top of the window determines which input the

   regular expression is evaluated on; request or response.

 - Items that already have comments can be ignored or overwritten, depending

   on a checkbox.

 - The behavior of the regular expression engine can be fine tuned with the

   flags that Java provides (see below).

As it can be seen on the example in the screenshot above the list, the

regular expression uses the first (number 1) group after evaluation, so the

expression must contain at least one group (delimited by parentheses).

In regex, the 0th (also considered first by programmers) group contains the

whole expression, hence the above clarification regarding our use of the

first group, which is number 1, not 0.

The built-in regular expression engine of the Java runtime is used, their

interpretation of the standard, including character classes and flags can

be found in [the JDK documentation of java.util.regex.Pattern][1].

Known issues

------------

At least on Linux / OpenJDK hosts, the newly set messages [don't get updated

automatically][2], in these cases forcing a redraw manually (by clicking,

scrolling, changing tabs, etc.) might be necessary.

Building

--------

 - (For testing) install JUnit, put the JARs into `lib`

 - Execute `ant`, and you'll have the plugin ready in `burp-commentator.jar`

Dependencies

------------

 - JDK 1.6+ (tested on OpenJDK `1.8.0_111`, Debian/Ubuntu package: `openjdk-8-jdk`)

 - Apache ANT (Debian/Ubuntu package: `ant`)

 - JUnit 4+ (only required for testing)

License

-------

The whole project is available under MIT license, see `LICENSE.txt`.

  [1]: https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html

  [2]: https://support.portswigger.net/customer/en/portal/questions/16796165-ihttprequestresponse-setmessage-does-not-update-proxy-history-automatically