Atlassian Jira Cloud

jira

StackHawk’s official Jira Cloud integration.

Overview

The StackHawk Jira integration lets you identify and track scan findings within your Atlassian Jira Cloud workspace. The integration consists of a Jira App that has to be first installed into your Jira workspace (admin privileges required), and then connected back to a StackHawk Organization with a Integration Token to support communication with StackHawk.

Features

  • HawkScan findings can send and associate scanner findings to a Jira Workspace as new or existing Jira Issue.

Requirements

StackHawk:

  • You must have a StackHawk account.
  • Your StackHawk Organization must belong to a plan with The Jira Integration enabled. Reach out to support@stackhawk.com to enable it.

Jira:

  • You must have login permissions to the Jira workspace you wish to add the integration to.

  • You must have sufficient administration permissions to install add-ons to your Jira workspace.

  • Your Jira Project must have a defined “Bug” issue type, which is not present for all Jira Project workspaces by default. See Adding the bug issue type to your Jira project for more details.

Scopes

With this integration you authorize StackHawk with the following Jira scopes:

  • Read access to the connected Jira workspace
  • Write access to the connected Jira workspace

Setup

Click here to install the StackHawk for Jira add-on from the Atlassian Marketplace

The StackHawk for Jira App will first need to be installed from the Atlassian marketplace, before it can be connected to a StackHawk organization.

  1. Log into StackHawk and visit the Jira Integration page in StackHawk
  2. Click Enable Jira. This will generate the temporary integration token.
  3. Click the View In Marketplace button. This will open a new tab to add the StackHawk add-on from the Atlassian Marketplace.
  4. In the new tab, click Install to add the app in your Jira workspace and go through installation process. Once completed, you can press Get Started to authorize the add-on with your Jira workspace.

Token Authorization

Once the StackHawk add-on has been installed in Jira, a one-time integration token from StackHawk needs to be copied into Jira to connect the Jira Workspace with your StackHawk organization.

  1. After installing the app from the Marketplace, go to the Jira page in StackHawk.
  2. Copy the UUID integration token. Note: this key is time-sensitive, and will expire after one hour.
  3. In Jira, go to Apps > Manage Your Apps > StackHawk for Jira > Get Started.
  4. Paste the integration token into the StackHawk Integration Token field.
  5. If successful, your Jira workspace will now be connected to your StackHawk organization, and the integration completed.
   
   

Verify Installation

You can verify the Jira App installation at any time after configuring a integration token.

  1. Go to the Jira page in StackHawk.
  2. You should see a Connected to: <your workspace URL>, which indicates the integration has been linked to that Jira Workspace.

Usage

Send to Jira

With the Jira App installation verified, you can send a finding to Jira by creating a Jira Issue and associating it with a StackHawk scanner finding.

  1. Go to a finding detail in StackHawk Scans > Scan Details > Findings
  2. Click on the checkbox for a given Path, Status, Method
  3. Click on Actions > Send to Jira
  4. Fill out the Jira ticket details. Findings can be promoted with either a new Jira issue, or linked to an existing Jira issue.

Creating a New Issue: Select the project you want the created ticket to be associated with. The created issue will be made with the Bug issue type. The created issue will have details about those findings. Click Create Issue, and the Jira issue will be created and associated with the scan findings.

Linking an Existing Issue: Select the issue from the query search you want associated with your Jira ticket. The linked issue will receive a comment with the details of the vulnerability findings. Click Link Issue, and the Jira issue will be created and associated with the scan findings.

Other actions

Similar to sending to Jira, you can clear the status of a finding or change it to another status by selecting the Path, Status, and Method and selecting a different action.

TroubleShooting

Adding the Bug Issue Type to your Jira Project

A Jira project has defined issue types. Jira Classic Software Projects will have the Bug issue type defined by default, however Jira Next-Gen Software Projects and Jira Core Projects will not include this issue type by default. To send created issues to these projects, you will have to add a Bug issue type:

  1. In your Jira project workspace, go to Settings > Issues
  2. Click Issue types > Add issue type
  3. Add a standard Issue Type named Bug, and make sure it has “Summary”, “Description” and “Environment” description fields assigned.
  4. Click Add

The created Bug issue type will be used for Jira Issues created from the StackHawk platform for that project.

Custom Fields on Jira Issue Types

It is not uncommon for a Jira project to have custom fields on their issuetypes. This is a feature provided by Atlassian, but can affect StackHawk ticket creation. If your project’s Bug IssueType has additional custom fields, make sure they also have an acceptable default value defined:

Removing the Jira App

The Jira integration can be disconnected from the authorized StackHawk organization from the Jira Integration page.

  1. Go to the Jira Integration page in StackHawk.
  2. Click Remove Integration
  3. In Jira, go to Apps > Manage Your Apps > StackHawk for Jira
  4. Click Uninstall

Feedback

Have any suggestions, feature requests, or feedback to share? Drop us a line at support@stackhawk.com