From 39b342a22a5c6d567c248ef9087e59032413642d Mon Sep 17 00:00:00 2001 From: Martijn Russchen Date: Mon, 3 Jun 2019 17:45:57 +0200 Subject: [PATCH 1/4] More details on the new Jira features --- docs/programs/jira-integration.md | 59 +++++++++++++++++++++---------- 1 file changed, 40 insertions(+), 19 deletions(-) diff --git a/docs/programs/jira-integration.md b/docs/programs/jira-integration.md index d7bc3b75301..8d8044ad4a6 100644 --- a/docs/programs/jira-integration.md +++ b/docs/programs/jira-integration.md @@ -21,34 +21,22 @@ Jump to: | -------- | [Creating a Jira Issue](#creating) | [Linking HackerOne Reports to Existing Jira Tasks](#linking) | +[Syncing updates from HackerOne to Jira](#hackerone-to-jira) | +[Syncing updates from Jira to HackerOne](#jira-to-hackerone) | +[Automaticly resolving a HackerOne report](#auto-close) | [Installing the Jira integration](#installing) | -### How it Works -A HackerOne report gets triaged and escalated into Jira. -![jira-integration-1](./images/jira-integration.png) - -Hackbot automatically captures the status change and posts an internal comment on the associated HackerOne report. -![jira-integration-2](./images/jira-cloud-4.png) - -These events and directions are currently supported through the bi-directional Jira integration: - -HackerOne to Jira | Jira to HackerOne ------------------ | ------------------- -Comments | Comments -State changes | State changes

You can select which Jira state will result in automatic closure of the HackerOne report. -Rewards | Resolution changes -Assignee changes | Assignee changes -Public disclosure | Priority changes -Report attachments | -

Creating a Jira Issue

You can create new Jira issues for reports you receive on HackerOne. To create a new Jira issue from your HackerOne report: 1. Go to the HackerOne report in your inbox that you want to create a new Jira issue for. 2. Click **Edit** next to References. -3. Click **Create JIRA issue**. +3. Click **Create JIRA issue**. Optional: If the report contains any attachments, these will be synced to the Jira issue created as well. + +![jira-integration-1](./images/jira-integration.png) + 4. Select the project that you want the issue to link to in the dropdown. *Note: This option occurs only if you have multiple projects to select from. If you only have 1 project, the issue will automatically escalate to that project.* ![create jira issue](./images/create-jira.png) @@ -90,6 +78,39 @@ There's also another way you can link your HackerOne reports to Jira. You can: 3. Enter the JIRA ticket number in the **Enter JIRA ticket #** field. 4. Click **Link JIRA issue**. +

Syncing updates from HackerOne to Jira

+ +With the Jira integration you can sync the following report updates to Jira. All updates on a report are synced as a comment to Jira: +- Report Comments +- State changes +- Rewards +- Assignee changes +- Public disclosure + +All actions are configureable and can be toggled from the Jira integration settings page. + +If you're using [Custom Fields](/programs/custom-fields.html), you can use these in the integration. All Custom Fields automaticly appear as available variables that you can use to set up the field mapping between HackerOne and Jira. + +

Syncing updates from Jira to HackerOne

+ +To make sure your security team stays up to date with the changes that happen in Jira, you can sync back activities from Jira to the HackerOne report. All updates from Jira will be reflected in HackerOne as an internal comment on the ascociated report. + +![jira-cloud-works-5](./images/jira-cloud-works-5.png) + +We currently support the following Jira activities: +- Comments +- State changes +- Resolution changes +- Assignee changes +- Priority changes + +You can choose which events you want to syncronize from the Jira integration settings page. Each of these activities can be toggled individually. + + + +

Automaticly resolving a HackerOne report

+ +You can choose to automaticly close a HackerOne report as "resolved" when a Jira issue closes. This helps you to close the loop in the HackerOne system and make sure the researcher is properly notified when closing the Jira issue that's linked to the report.

Installing the Jira integration

From 3f0422edbc79167e1a50214659c211f03232ad4a Mon Sep 17 00:00:00 2001 From: Martijn Russchen Date: Mon, 3 Jun 2019 18:48:38 +0200 Subject: [PATCH 2/4] Add 2 screenshots --- docs/programs/jira-integration.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/programs/jira-integration.md b/docs/programs/jira-integration.md index 8d8044ad4a6..cee9867f935 100644 --- a/docs/programs/jira-integration.md +++ b/docs/programs/jira-integration.md @@ -89,6 +89,8 @@ With the Jira integration you can sync the following report updates to Jira. All All actions are configureable and can be toggled from the Jira integration settings page. +![jira-server-6a](./images/jira-server-6a.png) + If you're using [Custom Fields](/programs/custom-fields.html), you can use these in the integration. All Custom Fields automaticly appear as available variables that you can use to set up the field mapping between HackerOne and Jira.

Syncing updates from Jira to HackerOne

@@ -106,7 +108,7 @@ We currently support the following Jira activities: You can choose which events you want to syncronize from the Jira integration settings page. Each of these activities can be toggled individually. - +![jira-server-5](./images/jira-server-jira-to-hackerone.png)

Automaticly resolving a HackerOne report

From 8d5f913a5e6fb08bba8231990a218a2316ee0c9e Mon Sep 17 00:00:00 2001 From: Martijn Russchen Date: Mon, 3 Jun 2019 18:51:06 +0200 Subject: [PATCH 3/4] Replace JIRA for Jira --- docs/changelog/2019/may.md | 2 +- docs/programs/jira-cloud-integration.md | 12 ++++++------ docs/programs/jira-integration.md | 10 +++++----- docs/programs/jira-server-integration.md | 16 ++++++++-------- 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/changelog/2019/may.md b/docs/changelog/2019/may.md index 9d79da94e85..b565e0dc499 100644 --- a/docs/changelog/2019/may.md +++ b/docs/changelog/2019/may.md @@ -18,7 +18,7 @@ The HackerOne to Jira escalation template now includes all additional fields tha ![additional fields wen escalating HackerOne to Jira](./images/may_2019_jira++_additional-fields.png) #### Sync Attachments -Jira users can now sync attachments from their HackerOne report to Jira by selecting **Synchronize attachments** in the **Select HackerOne to JIRA events** section when configuring their Jira integration. +Jira users can now sync attachments from their HackerOne report to Jira by selecting **Synchronize attachments** in the **Select HackerOne to Jira events** section when configuring their Jira integration. ![synchronize attachments option in the jira integration](./images/may_2019_jira++_sync-attachments.png) diff --git a/docs/programs/jira-cloud-integration.md b/docs/programs/jira-cloud-integration.md index f240bd3ef42..36a39a5ca72 100644 --- a/docs/programs/jira-cloud-integration.md +++ b/docs/programs/jira-cloud-integration.md @@ -10,10 +10,10 @@ You can integrate with Jira Cloud in order to sync information between your Hack To integrate with Jira Cloud: 1. Go to **Settings > Program > Integrations**. -2. Click the **Connect with JIRA** link. +2. Click the **Connect with Jira** link. ![jira-server-1](./images/jira-server-1.png) -3. Choose **JIRA Cloud**, and you'll be redirected to Atlassian Marketplace where you can download the HackerOne for JIRA application. +3. Choose **Jira Cloud**, and you'll be redirected to Atlassian Marketplace where you can download the HackerOne for Jira application. ![jira-server-3](./images/jira-server-3.png) @@ -31,13 +31,13 @@ To integrate with Jira Cloud: 7. The set up will take you to the Jira settings page where you can select which events you want to sync between HackerOne and Jira. -8. Configure which HackerOne projects you'd like to escalate to Jira in the **Configure HackerOne to JIRA escalation** window. +8. Configure which HackerOne projects you'd like to escalate to Jira in the **Configure HackerOne to Jira escalation** window. * Select the **Allow me to select a project every time when I escalate an issue** checkbox to have the ability to select from multiple projects when creating Jira issues. * Select the Jira Priority you want to map to the corresponding HackerOne severity. This enables the right priority to be set when escalating a HackerOne report to Jira. ![jira-server-4a](./images/jira-server-hackerone-to-jira.png) -9. *(Optional)* Select which Jira actions you'd like to post onto HackerOne in the **Select JIRA to HackerOne events** window. You can choose from: +9. *(Optional)* Select which Jira actions you'd like to post onto HackerOne in the **Select Jira to HackerOne events** window. You can choose from: Option | Detail ------ | ------- @@ -50,7 +50,7 @@ Closed issue status | Resolve the report when an issue is closed with the select ![jira-server-5](./images/jira-server-jira-to-hackerone.png) -10. *(Optional)* Select which actions in HackerOne you'd like to post to Jira in the **Select HackerOne to JIRA events** window. You can choose from: +10. *(Optional)* Select which actions in HackerOne you'd like to post to Jira in the **Select HackerOne to Jira events** window. You can choose from: Option | Detail ------ | ------- @@ -72,7 +72,7 @@ To create Jira issues from your HackerOne report: ![jira-cloud-works-1](./images/jira-cloud-works-1.png) -3. Click **Create JIRA Issue**. A Jira ID will automatically generate. +3. Click **Create Jira Issue**. A Jira ID will automatically generate. ![jira-cloud-works-2](./images/jira-cloud-works-2.png) diff --git a/docs/programs/jira-integration.md b/docs/programs/jira-integration.md index cee9867f935..c56e25257f5 100644 --- a/docs/programs/jira-integration.md +++ b/docs/programs/jira-integration.md @@ -33,7 +33,7 @@ You can create new Jira issues for reports you receive on HackerOne. To create a new Jira issue from your HackerOne report: 1. Go to the HackerOne report in your inbox that you want to create a new Jira issue for. 2. Click **Edit** next to References. -3. Click **Create JIRA issue**. Optional: If the report contains any attachments, these will be synced to the Jira issue created as well. +3. Click **Create Jira issue**. Optional: If the report contains any attachments, these will be synced to the Jira issue created as well. ![jira-integration-1](./images/jira-integration.png) @@ -62,8 +62,8 @@ To link your reports: ![link to jira-1](./images/link-jira-1.png) -3. Enter the Jira ticket reference ID in the **Link JIRA ticket** field. -4. Click **Link JIRA issue**. +3. Enter the Jira ticket reference ID in the **Link Jira ticket** field. +4. Click **Link Jira issue**. ![link to jira-2](./images/link-jira-2.png) @@ -75,8 +75,8 @@ There's also another way you can link your HackerOne reports to Jira. You can: ![link to jira-3](./images/link-jira-3.png) -3. Enter the JIRA ticket number in the **Enter JIRA ticket #** field. -4. Click **Link JIRA issue**. +3. Enter the Jira ticket number in the **Enter Jira ticket #** field. +4. Click **Link Jira issue**.

Syncing updates from HackerOne to Jira

diff --git a/docs/programs/jira-server-integration.md b/docs/programs/jira-server-integration.md index 20257738de8..e26720e1de8 100644 --- a/docs/programs/jira-server-integration.md +++ b/docs/programs/jira-server-integration.md @@ -10,15 +10,15 @@ You can integrate with Jira Server in order to sync information between your Hac To integrate with Jira Server: 1. Go to **Settings > Program > Integrations**. -2. Click the **Connect with JIRA** link. +2. Click the **Connect with Jira** link. ![jira-server-1](./images/jira-server-1.png) -3. Choose **JIRA Server**, and you'll be redirected to this 4-step setup screen where you can configure your Jira integration. +3. Choose **Jira Server**, and you'll be redirected to this 4-step setup screen where you can configure your Jira integration. ![jira-server-3](./images/jira-server-3.png) ![jira-server-2](./images/jira-server-2.png) -4. Navigate to the Application Links console of JIRA by going to **JIRA Administration > Applications > Application Links**. +4. Navigate to the Application Links console of Jira by going to **Jira Administration > Applications > Application Links**. > **Note:** You must be a Jira administrator in order to set up and access the Jira integration settings. After you set up your integration, you can go back to regular access on Jira. @@ -49,7 +49,7 @@ Display URL | https://hackerone.com Field | Details ----- | -------- -Consumer Key | HackerOne JIRA Client +Consumer Key | HackerOne Jira Client Consumer Name | HackerOne Public Key | Copy and paste from the key below:

-----BEGIN PUBLIC KEY----
MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAy8H4gLqU2Lkkce11/Scn
zac5uLs4Wa3xkg8pwTJb4AaUXxPp5c49MVXRlGhLMeQ2Wv1AfNvxJu4gcmvUyn6Q
A9hD156grA7qXD3G7aX4DJ4N5ialNaDQGZCWRqxAqwrT7KoXZohbiima5bAyUjgG
SwdGKTIHp7djBNfWa8Wv9uDbJZkNRkhzcuJ65dmsPk0gURosCzo3FhL9e0kjVt66
GbTMjP02L0BZYpFhwTbHTsrw/xpmW9RRDGZ9jYNXbCeki17bYdVSdGswvamvzv5Y
4EBK4hV4ocs+MumEWC5lYn1zdWjXaQcDTnrQLgF1BJ//hB7l6nPSrynYCiM4ceCU
vo1/2p6nOvNvbBjVlRMIYbsrrUgaBT1tvdHRqTkBDpxzDEQcNBuEgxhxu7oHNDvK
HnZsorPPvfixqhpB3jcO9NuYujPakAV/ishjrwwQtRIRXqLAFHYYQxbzfikhi0xs
RJGg/kzpkmz9F93cATONpMFSVrg6a4Vxmt0Yt8zND2WNi/8qHCWN2yju2DUWLLRm
6MdAkz48MMTCmYXRybB+6g8a9F4YBdl2TGnWsYfQ1R/y0utRKBC+P7cQwVTP8eus
liA2Ts+KvYyVgD6StR629HFyNCNglm9+NuudtYdUUfIHGlEq769wLwHX3bgddqBW
hgko43a2w0IWTvNkga5FBcMCAwEAAQ==
-----END PUBLIC KEY----- @@ -58,14 +58,14 @@ Public Key | Copy and paste from the key below:

-----BEGIN PUBLIC KEY---- 11. Click **Save**. 12. Navigate back to HackerOne and enter the URL of the Jira instance you want to authenticate with in the **Instance base URL** field in the **Configure an Application Link** step. ![jira-server-14](./images/jira-server-14.png) -13. Click the **Authenticate with JIRA** button to finalize the setup between HackerOne and your Jira instance. -14. Configure which HackerOne projects you'd like to escalate to Jira in the **Configure HackerOne to JIRA escalation** window. +13. Click the **Authenticate with Jira** button to finalize the setup between HackerOne and your Jira instance. +14. Configure which HackerOne projects you'd like to escalate to Jira in the **Configure HackerOne to Jira escalation** window. * Select the **Allow me to select a project every time when I escalate an issue** checkbox to have the ability to select from multiple projects when creating Jira issues. * Select the Jira Priority you want to map to the corresponding HackerOne severity. This enables the right priority to be set when escalating a HackerOne report to Jira. ![jira-server-4a](./images/jira-server-hackerone-to-jira.png) -15. *(Optional)* Select which Jira actions you'd like to post onto HackerOne in the **Select JIRA to HackerOne events** window. You can choose from: +15. *(Optional)* Select which Jira actions you'd like to post onto HackerOne in the **Select Jira to HackerOne events** window. You can choose from: Option | Detail ------ | ------- @@ -78,7 +78,7 @@ Closed issue status | Resolve the report when an issue is closed with the select ![jira-server-5](./images/jira-server-jira-to-hackerone.png) -16. *(Optional)* Select which actions in HackerOne you'd like to post to Jira in the **Select HackerOne to JIRA events** window. You can choose from: +16. *(Optional)* Select which actions in HackerOne you'd like to post to Jira in the **Select HackerOne to Jira events** window. You can choose from: Option | Detail ------ | ------- From 249c73b7e7326acb68bfff22518631999e58c507 Mon Sep 17 00:00:00 2001 From: stacyspiva <36056941+stacyspiva@users.noreply.github.com> Date: Mon, 3 Jun 2019 12:13:09 -0700 Subject: [PATCH 4/4] Update jira-integration.md --- docs/programs/jira-integration.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/programs/jira-integration.md b/docs/programs/jira-integration.md index c56e25257f5..08a4ddcfbec 100644 --- a/docs/programs/jira-integration.md +++ b/docs/programs/jira-integration.md @@ -23,7 +23,7 @@ Jump to: | [Linking HackerOne Reports to Existing Jira Tasks](#linking) | [Syncing updates from HackerOne to Jira](#hackerone-to-jira) | [Syncing updates from Jira to HackerOne](#jira-to-hackerone) | -[Automaticly resolving a HackerOne report](#auto-close) | +[Automatically resolving a HackerOne report](#auto-close) | [Installing the Jira integration](#installing) | @@ -33,7 +33,7 @@ You can create new Jira issues for reports you receive on HackerOne. To create a new Jira issue from your HackerOne report: 1. Go to the HackerOne report in your inbox that you want to create a new Jira issue for. 2. Click **Edit** next to References. -3. Click **Create Jira issue**. Optional: If the report contains any attachments, these will be synced to the Jira issue created as well. +3. Click **Create Jira issue**. ![jira-integration-1](./images/jira-integration.png) @@ -69,7 +69,7 @@ To link your reports: The HackerOne report will now be linked to the Jira task, and all activities that are performed on the report will be synced to the corresponding task. -There's also another way you can link your HackerOne reports to Jira. You can: +There's also another way you can link your HackerOne reports to Jira. You can: 1. Go to the bottom of your HackerOne report. 2. Select **Change state > Triaged** in the action picker. @@ -80,39 +80,39 @@ There's also another way you can link your HackerOne reports to Jira. You can:

Syncing updates from HackerOne to Jira

-With the Jira integration you can sync the following report updates to Jira. All updates on a report are synced as a comment to Jira: +With the Jira integration you can sync these report updates to Jira: - Report Comments - State changes - Rewards - Assignee changes - Public disclosure -All actions are configureable and can be toggled from the Jira integration settings page. +All updates on a report are synced as a comment to Jira. Additionally, all actions are configureable and can be toggled from the Jira integration settings page. ![jira-server-6a](./images/jira-server-6a.png) -If you're using [Custom Fields](/programs/custom-fields.html), you can use these in the integration. All Custom Fields automaticly appear as available variables that you can use to set up the field mapping between HackerOne and Jira. +If you've configured your own [custom fields](/programs/custom-fields.html), you can use them in the jira integration. All custom fields automatically appear as available variables that you can use to set up the field mapping between HackerOne and Jira.

Syncing updates from Jira to HackerOne

-To make sure your security team stays up to date with the changes that happen in Jira, you can sync back activities from Jira to the HackerOne report. All updates from Jira will be reflected in HackerOne as an internal comment on the ascociated report. +To make sure your security team stays up to date with the changes that happen in Jira, you can sync back activities from Jira to the HackerOne report. All updates from Jira will be reflected in HackerOne as an internal comment on the associated report. ![jira-cloud-works-5](./images/jira-cloud-works-5.png) -We currently support the following Jira activities: +We currently support these activities from Jira to HackerOne: - Comments - State changes - Resolution changes - Assignee changes - Priority changes -You can choose which events you want to syncronize from the Jira integration settings page. Each of these activities can be toggled individually. +You can choose which events you want to synchronize from Jira as each of the activities can be toggled individually. ![jira-server-5](./images/jira-server-jira-to-hackerone.png) -

Automaticly resolving a HackerOne report

+

Automatically resolving a HackerOne report

-You can choose to automaticly close a HackerOne report as "resolved" when a Jira issue closes. This helps you to close the loop in the HackerOne system and make sure the researcher is properly notified when closing the Jira issue that's linked to the report. +You can set your integration to automatically close a HackerOne report as Resolved when a Jira issue closes. This enables the hacker to be notified right away when the Jira issue that's linked to the report is closed.

Installing the Jira integration

@@ -122,4 +122,4 @@ You can choose to integrate from 2 different types of Jira integrations: Option | Details ------ | ------- [Jira Cloud](jira-cloud-integration.html) | You can access Jira from anywhere in the world. -[Jira Server](jira-server-integration.html)| Jira is self-hosted and can be behind a firewall or VPN. \ No newline at end of file +[Jira Server](jira-server-integration.html)| Jira is self-hosted and can be behind a firewall or VPN.