Integrating with Jira
Last updated: October 28, 2021
Read time: 4 Minutes
If you use Jira to manage your projects, you can set up an integration with Burp Suite Enterprise Edition. Once configured, this enables you to create Jira tickets directly from the results of a scan. Integration with both cloud-based and server-based Jira installations is supported.
If your Jira server is configured to use HTTPS, you need to make sure that it has a CA-signed certificate. Burp Suite Enterprise Edition does not currently support integration using self-signed certificates.
Creating your Jira API token (cloud only)
If you want to integrate a cloud-based Jira installation, you first need to create a Jira API token. This is used to authenticate communication with Jira. If you use a server-based Jira installation, you can skip this step.
- Log in to Jira as the user that you want to use for the integration. This must be a user that is authorized to create tickets. Remember this user because you will need to provide the credentials in Burp Suite Enterprise Edition in order to complete the integration.
- In Jira, click your user icon and open your account settings.
- On the account settings page, go to the "Security" section.
- Click "Create and manage API tokens" and then "Create API token".
- Enter a label for the token and click "Create".
- Copy the token to your clipboard and save it somewhere secure. Note that you will not be able to view or copy this token again once you close the popup.
Configuring the integration
To enable Jira integration, you first need to configure some settings so that the Enterprise server and Jira can communicate. You also specify the Jira projects for which tickets can be created.
- Log in to Burp Suite Enterprise Edition as a user with "Modify settings" permissions.
- Click the settings cog icon and select "Jira integration".
- Enter the URL for your Jira server then click "Continue". This is either your internal server URL for on-premise installations or the URL of your cloud server.
- For cloud-based Jira installations, enter the email address and the API token of a Jira user that is authorized to create tickets. For server-based Jira installations, enter the username and password of a user that is authorized to create tickets.
- Click "Connect to Jira".
Configuring Jira ticket creation
After you have successfully connected to your Jira server, you can specify how you want Burp Suite Enterprise Edition and Jira to interact. You can set automatic and/or manual ticket creation by ticking the relevant boxes. Automatic ticket creation makes Jira tickets whenever Burp Suite discovers a new issue. Manual ticket creation allows you to manually create tickets from scans.
When configuring manual ticket creation, use the drop-down lists to select the relevant projects and ticket types. You can add as many new entries as necessary.
Burp Suite Enterprise Edition can automatically create Jira tickets when a new issue is found. You can control which issues are considered new by adjusting the scan delta settings on the "Sites and scan data" settings page. When configuring automatic ticket creation, use the drop-down lists to select each project and ticket type. Use the sliders to specify the minimum severity and confidence level for which Burp Suite Enterprise Edition should automatically create Jira tickets for the selected project.
Please keep in mind that even tickets that were created automatically by Burp Suite Enterprise Edition will need to be processed manually in Jira. We recommend being conservative with automatic ticket creation until you have a better understanding of how many tickets will be generated. Otherwise, you might unintentionally clutter your Jira backlog with an overwhelming number of tickets.
Manually creating Jira tickets
Once you have configured the integration with Jira, users can manually create tickets for issues, or link an issue to an existing ticket, directly from the scan results. You can link an issue to multiple Jira tickets.
- Log in to Burp Suite Enterprise Edition.
- Open the issue for which you want to create a ticket.
- In the upper-right corner of the screen, click the "Link to Jira" button.
- In the popup that appears, select whether you want to create a new ticket in Jira or link to an existing one. To link to an existing ticket, you need to enter the exact ticket number.
- Select the project and ticket type. This is based on the list of combinations that the administrator created when configuring the Jira integration.
- Confirm your settings.
A ticket containing a link to the issue and some basic information about it is added to the Jira project backlog. In Jira, you can now assign the issue to a sprint or other project workflow as you would any other ticket. In Burp Suite Enterprise Edition, the issue now contains a "Linked Jira ticket" tab, where you can choose to unlink the ticket. However, please be aware that when you unlink a ticket from an issue, the ticket still exists in Jira and must be closed manually.
The HTTP requests and responses for issues are currently not included automatically in the Jira ticket. Although a link to the issue is provided, if the developer assigned to investigate the issue does not have access to a Burp Suite Enterprise Edition account, you may need to download the HTML report and attach it to the Jira ticket manually.