Get involved in the Burp challenge for opportunities to test your skills and win swag  –   Challenge me

PROFESSIONALCOMMUNITY

Installing extensions

  • Last updated: November 25, 2022

  • Read time: 3 Minutes

This section explains how to install extensions from the BApp Store, or from a file.

Installing extensions from the BApp Store

The BApp Store contains community-created extensions, or BApps, that we have reviewed for security and quality. Every extension in the BApp Store is listed with the following information:

  • A description of the extension's function.
  • An estimate of the extension's impact on your system resources.
  • Summary information, including a community rating and an indication of the extension's popularity.

Requirements

Please note the following requirements before you install an extension:

  • Some extensions require you to upgrade from Burp Suite Community Edition to Burp Suite Professional.
  • Some extensions may require you to update your version of Burp Suite.
  • Some extensions require you to install Jython or JRuby.
  • Your device must be able to access portswigger.net.

Note

If your device has no internet access, you can install an extension from a file.

To install an extension from the BApp Store:

  1. To view the BApp Store in Burp Suite, go to Extensions > BApp Store.
  2. Select an extension from the list. Notice the summary information for the extension in the right-hand panel.
  3. If available, click Install to install the extension.

Note

Some BApps that use our legacy Extender API were written in Python or Ruby. If you want to use these extensions, you may need to install Jython or JRuby.

If the extension requires Jython or JRuby, the Install button is grayed out. You can install Jython or JRuby as described below.

Installing Jython or JRuby

You need to install Jython or JRuby if you see a Download Jython or Download JRuby button next to the extension in the BApp Store. This enables extensions written in Python or Ruby to interact with Burp's legacy, Java-based Extender API.

To install Jython or JRuby:

  1. Click the Download Jython or Download JRuby button.
  2. Download the standalone JAR version of Jython or JRuby.
  3. In Burp Suite, go to Extensions > Options.
  4. Under Python Environment or Ruby Environment, click Select file.
  5. Select the JAR file and click Open.
  6. Go to Extensions > BApp Store. Notice that the Install button is now available for your extension.

Installing an extension from a file

You can install extensions from a file. This may be useful if you are running Burp Suite on a machine without internet access.

You have two options for installing an extension from a file:

  • You can download an extension directly from the BApp Store website https://portswigger.net/bappstore. These are in .bapp format.

  • You can use a custom file. These are typically in JAR format.

To install an extension from a .bapp file:

  1. Go to Extensions > BApp Store and click Manual install at the bottom of the window.
  2. Select the file and click Open.
  3. Wait for the extension to install. Notice that the extension is now listed in the Installed tab.

To install an extension from a JAR file:

  1. Go to Extensions > Installed and click Add.
  2. Under Extension Details, click Select file and locate the file.
  3. If necessary, set your output and error preferences.
  4. Click Next.
  5. Wait for the extension to install. Notice that the extension is now listed in the Installed tab.

Before you can install extensions written in Python or Ruby, you also need to install Jython or JRuby.

Was this article helpful?