diff --git a/docs/organizations/hackerone-vpn-v1.md b/docs/organizations/hackerone-vpn-v1.md new file mode 100644 index 00000000000..b0e26cbb43c --- /dev/null +++ b/docs/organizations/hackerone-vpn-v1.md @@ -0,0 +1,30 @@ +--- +title: "HackerOne Gateway (VPN) - V1" +path: "/organizations/hackerone-vpn-v1.html" +id: "organizations/hackerone-vpn-v1" +--- + +You can require finders to set up a virtual private network (VPN) instance with HackerOne Gateway (VPN) in order to find vulnerabilities in your program. The HackerOne Gateway (VPN) enables you to have granular control over finder activities on your program and assets. + +> Gateway (VPN) is available as an add-on. To learn more about adding HackerOne Gateway (VPN) to your program, contact your account manager. + +![Gateway program UI](./images/gateway-1.png) + +To manage your Gateway settings: +1. Go to **Program Settings > Program > Hacker Management > Gateway**. +2. Check to see if your Gateway is connected under the **Manage Global Gateway Access** section. You’ll see a green **Connected** icon to notify you that traffic is able to successfully flow through the HackerOne Gateway (VPN) instances. If traffic through the Gateway is disrupted, you’ll see a grey **Disconnected** icon. +3. *(Optional)* Click **Disconnect Gateway** if you want to close your gateway to finders. Keep in mind that disconnecting your gateway will prevent finders from finding vulnerabilities on your Gateway-protected targets until you reconnect the gateway. + + +4. *(Optional)* Click **Reconnect Gateway** if you want finders to connect to your servers via Gateway. + +### Manage Individual Finder Access +You can also manage which finders are able to access your Gateway. You can view the username of the finder and their Gateway Instance IP. + +![UI for Manage Individual Finder Access](./images/gateway-2.png) + +To manage individual finder access under the **Manage Individual Finder Access** section: +1. Click **Pause** for any finders that you want to prevent from accessing your servers via the Gateway. +2. Click **Resume** to enable Gateway access for the finder. + +To receive complete traffic logs, contact your program manager. diff --git a/docs/organizations/hackerone-vpn.md b/docs/organizations/hackerone-vpn.md index 6d2aa7a5a8a..09e091691da 100644 --- a/docs/organizations/hackerone-vpn.md +++ b/docs/organizations/hackerone-vpn.md @@ -4,27 +4,49 @@ path: "/organizations/hackerone-vpn.html" id: "organizations/hackerone-vpn" --- -You can require finders to set up a virtual private network (VPN) instance with HackerOne Gateway (VPN) in order to find vulnerabilities in your program. The HackerOne Gateway (VPN) enables you to have granular control over finder activities on your program and assets. +This page refers to V2 of Gateway, for documentation of V1 Legacy Gateway solution, please refer to [this page](https://docs.hackerone.com/organizations/hackerone-vpn-v1.html). + +The HackerOne Gateway (VPN) enables access to public and firewalled assets as well as allows IP whitelisting per program. It also provides the ability to control hackers access at both a high and granular level. > Gateway (VPN) is available as an add-on. To learn more about adding HackerOne Gateway (VPN) to your program, contact your account manager. -![Gateway program UI](./images/gateway-1.png) +### Managing Gateway settings + +1. Go to **Program Settings > Program > Hacker Management > Gateway** to manage your Gateway settings. +2. To pause or resume the Gateway program, click on the Online/Offline toggle on the top left as shown below. + +![gateway_access_toggle](./images/gateway-3.png) + +### Whitelisted IPs + +1. To view a list of the Whitelisted IPs provided by HackerOne Gateway, click on the **Whitelisted IPs** button in the top right corner of the page. + +![gateway_whitelisted_ips](./images/gateway-4.png) + +### Manage Hacker Access In Bulk + +You can pause or resume access of multiple hackers at the same time. + +1. Select the Hackers you want to manage access of by using the checkboxes. +2. **Pause Access** and **Resume access** buttons will show. Simply click on the desired action to block/unblock a Hacker. +3. You can easily view blocked hackers by clicking on the **Blocked** tab on the top. + +![gateway_manage_hacker_access_bulk](./images/gateway-5.png) + +### Manage Individual Hacker Access + +You can pause or resume access of individual hackers by: + +1. Clicking on the 3 dots at the far right of the Hacker's name, as indicated below. + +![gateway_manage_individual_hacker_access](./images/gateway-6.png) -To manage your Gateway settings: -1. Go to **Program Settings > Program > Hacker Management > Gateway**. -2. Check to see if your Gateway is connected under the **Manage Global Gateway Access** section. You’ll see a green **Connected** icon to notify you that traffic is able to successfully flow through the HackerOne Gateway (VPN) instances. If traffic through the Gateway is disrupted, you’ll see a grey **Disconnected** icon. -3. *(Optional)* Click **Disconnect Gateway** if you want to close your gateway to finders. Keep in mind that disconnecting your gateway will prevent finders from finding vulnerabilities on your Gateway-protected targets until you reconnect the gateway. - +### Activity logs -4. *(Optional)* Click **Reconnect Gateway** if you want finders to connect to your servers via Gateway. +The activity logs show what actions are being performed by Hackers while on the Gateway solution. It is possible to customize the results by using the filters available, such as **Date**, **Month**, **Year** and **start-end** time, or by using the search box. +Please note that it can take up to 20 minutes to display the latest activity logs. -### Manage Individual Finder Access -You can also manage which finders are able to access your Gateway. You can view the username of the finder and their Gateway Instance IP. +![gateway_activity_logs](./images/gateway-6.png) -![UI for Manage Individual Finder Access](./images/gateway-2.png) -To manage individual finder access under the **Manage Individual Finder Access** section: -1. Click **Pause** for any finders that you want to prevent from accessing your servers via the Gateway. -2. Click **Resume** to enable Gateway access for the finder. -To receive complete traffic logs, contact your program manager. diff --git a/docs/organizations/images/gateway-3.png b/docs/organizations/images/gateway-3.png new file mode 100644 index 00000000000..406002574c8 Binary files /dev/null and b/docs/organizations/images/gateway-3.png differ diff --git a/docs/organizations/images/gateway-4.png b/docs/organizations/images/gateway-4.png new file mode 100644 index 00000000000..fecccd516b0 Binary files /dev/null and b/docs/organizations/images/gateway-4.png differ diff --git a/docs/organizations/images/gateway-5.png b/docs/organizations/images/gateway-5.png new file mode 100644 index 00000000000..2f9fa25fbfa Binary files /dev/null and b/docs/organizations/images/gateway-5.png differ diff --git a/docs/organizations/images/gateway-6.png b/docs/organizations/images/gateway-6.png new file mode 100644 index 00000000000..d22073278c7 Binary files /dev/null and b/docs/organizations/images/gateway-6.png differ diff --git a/docs/organizations/images/gateway-7.png b/docs/organizations/images/gateway-7.png new file mode 100644 index 00000000000..d0aa509a62d Binary files /dev/null and b/docs/organizations/images/gateway-7.png differ diff --git a/src/pages/organizations/organizations-nav.yaml b/src/pages/organizations/organizations-nav.yaml index e2344d699fa..960c3b2e0a4 100644 --- a/src/pages/organizations/organizations-nav.yaml +++ b/src/pages/organizations/organizations-nav.yaml @@ -341,7 +341,9 @@ - title: Gateway path: /organizations/hackerone-vpn.html items: - - title: FAQs + - title: Gateway V1 + path: /organizations/hackerone-vpn-v1.html + - title: FAQs Gateway V1 path: /organizations/vpn-faqs.html - title: Pentests items: