Skip to content
This repository has been archived by the owner on Nov 20, 2023. It is now read-only.

Commit

Permalink
Merge pull request #1120 from nathaliacoutinho/gateway-v2-docs
Browse files Browse the repository at this point in the history
Added documentation for HackerOne Gateway V2.
  • Loading branch information
jessiwright authored Aug 24, 2023
2 parents abdbd20 + 535608d commit d7618db
Show file tree
Hide file tree
Showing 8 changed files with 70 additions and 16 deletions.
30 changes: 30 additions & 0 deletions docs/organizations/hackerone-vpn-v1.md
Original file line number Diff line number Diff line change
@@ -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.
<ul><li><b>Note:</b> If your Gateway is in full tunnel mode or if your assets are under a Content Delivery Network (CDN), you won't be able to disconnect your Gateway as disconnecting your Gateway will prevent hackers from hacking on other programs.</li></ul>

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.
52 changes: 37 additions & 15 deletions docs/organizations/hackerone-vpn.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<ul><li><b>Note:</b> If your Gateway is in full tunnel mode or if your assets are under a Content Delivery Network (CDN), you won't be able to disconnect your Gateway as disconnecting your Gateway will prevent hackers from hacking on other programs.</li></ul>
### 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.
Binary file added docs/organizations/images/gateway-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/organizations/images/gateway-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/organizations/images/gateway-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/organizations/images/gateway-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/organizations/images/gateway-7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion src/pages/organizations/organizations-nav.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit d7618db

Please sign in to comment.