1. Expel Support Center
  2. Connect your technology
  3. SaaS integrations

GitHub Cloud setup for Workbench

  • Updated

This article explains how to connect GitHub to Workbench.

In this article

Before you start

You must have:

Note

This procedure is specifically for cloud-hosted GitHub deployments. For on-prem, use the GitHub self-hosted (on-prem) Workbench setup guide.

Step 1: Install the cloud-hosted GitHub App

Expel uses a GitHub App as part of the onboarding process. During installation, the Expel GitHub App receives the following organization-level privileges:

  • Members: Read+Write

  • Administration: Read-Only

Note

GitHub doesn't log user identities, making it difficult to track suspicious activity at the user level. To solve this problem, Expel uses Write Permissions to map GitHub data to a user's identity.

  1. Navigate to the Expel GitHub Integration Application installation page: https://github.com/apps/expelgithubintegration and click Install.

  2. Follow the steps to install the application within the GitHub Organization you want to onboard.

    Note

    If you have multiple organizations, create a separate Security Device in Workbench for each organization.

  3. After you successfully install the application, note the Installation ID that can be found in your URL under the format "github.com/.../installations/<installation_id>/…"

Step 2: Configure the technology in Workbench

Now that we have the correct access configured and noted the credentials, we can integrate your tech with Workbench.

Note

Expel secures all login information our SOC analysts need about your devices in a MFA password product. Access to this login information is protected using our internal MFA processes. To learn more about the IP addresses all Expel traffic comes from, go here.

  1. In a new browser tab, login to https://workbench.expel.io/settings/security-devices?setupIntegration=github.

    mceclip2.png

  2. For Where is your device? select Cloud.

  3. Complete these fields using the credentials and information from Step 1:

    • For Name type the name of your GitHub organization.

    • For Location type Cloud.

    • For Organization name type the name of your GitHub organization.

    • For Enterprise slug type the enterprise slug URL. This is only required if you use an enterprise SAML identity provider, otherwise you can leave it blank.

    • For the Application installation ID type the installation ID from Step 1.

  4. Leave the other fields blank.

  5. Click Save.

You can see if the device is healthy on the Security Devices page. It may take a few minutes to see the device listed as healthy.

To check if alerts are coming through, navigate to the Alerts Analysis page. Scroll to the device you want to check and click View alerts. Switch to grid view, then check the list for device alerts. It can take 36 to 72 hours for alerts to appear after setup, as we tune your device.

Step 3: Update your GitHub logs to record/display IP addresses

While not required, consider updating your GitHub audit logs to record/display IP addresses. These addresses are not automatically logged in GitHub. This is a key field when the SOC analysts investigate GitHub activity.

Follow the instructions located here for steps to set this up.

Tip

This article was accurate at the time of writing, but changes happen. If you find the instructions are outdated, leave a description in the comment field below and let us know!

  • Was this article helpful?

  • 0 out of 0 found this helpful

Related articles