ovi3 / burpbeautifier Goto Github PK

BurpBeautifier is a Burpsuite extension for beautifying request/response body, supporting JS, JSON, HTML, XML format, writing in Jython 2.7.

Install from BApp Store:

1. Visit Jython Offical Site, and download Jython Standalone jar file.
2. Open Burpsuite, goto Extender -> Options -> Python Environment, set the Location of Jython Jar. And goto Extender -> BApp Store, find Burp Beautifier and install it.

(BurpBeautifier had been removed from BApp Store since the new version of Burpsuite already has beautify function.)

Manual Install:

1. Visit Jython Offical Site, and download Jython Installer.
2. Open Jython Installer to install Jython(In standard mode, make sure it will install pip). Assume it has be installed in D:\jython2.7.1 directory.
3. Install Jython modules: D:\jython2.7.1\bin\jython.exe -m pip install -r requirements.txt.
4. Open Burpsuite, goto Extender -> Options -> Python Environment, set the Location of Jython Jar is D:\jython2.7.1\jython.jar, and the Folder for loading modules is D:\jython2.7.1.
5. Download this tool, Open Burpsuite, goto Extender -> Extensions -> Add -> Choose the beautifier.py.

MessageEditorTab:

Standalone beautifier panel:

Options panel:

Options setting:

1. General Options: Set Max Size of data that should be beautified.
2. Enable in MessageEditorTab: By default, JavaScript and JSON is enable, and HTML and XML is disable cause Burpsuite already beautify these.
3. Replace PROXY Response: Enable it if you want to beautify response and replace it.

1. Supportting Format
   • JS: use jsbeautify module
   • JSON: use jsbeautify module
   • HTML: use beautifulsoup4 module, and jsbeautify module for js code in HTML
   • XML: use xml module
2. Writing in Jython, modify source code conveniently. eg: Modify the beautify function to change how to beautify.
3. Beautify and replace response body.
4. Option setting persistence.
5. Send Resquest/Response body to Beautifier Panel.

1. It may modify data, such as: beautifying xml will add the <?xml version="1.0" encoding="UTF-8"?> header, beautifying html will repair html tag.
2. It assume the request/response body is utf-8, so if the body is not utf8 encoding or compatible with utf8, it may not work well.
3. Not considering gzip/deflate compress/decompress, so need the Proxy->Options->Miscellaneous->Unpack gzip/deflate in response is enabled(Enabled by default).

1. Jython is slow. So It will not beautify if size excess dataMaxSize(default is 680KB).