Skip to main content

Set up the GitHub connector

GitHub Advanced Security (GHAS) delivers integrated security capabilities to secure the software development lifecycle directly within GitHub. It includes code scanning for identifying vulnerabilities in code, secret scanning to detect and prevent credential exposure, and dependency review to analyze risks in third-party packages.

By integrating GHAS, Veracode Risk Manager (VRM) leverages its insights to recommend the best next actions for security teams, ensuring seamless alignment with their broader tool stack and promoting a unified, strategic approach to security management.

Complete the following tasks to set up your VRM connector for GitHub.

Enable fine-grained personal access token

The first step in the integration process is to ensure fine-grained personal access token has been enabled.

  1. From your GitHub organization page, go to Settings→Personal Access Tokens→Settings.

  2. Select Allow access via fine-grained personal access tokens option and select Save.

    Enabled personal access tokens

Create fine-grained personal access token

Once the fine-grained access token has been enabled, create a personal access token to complete the integration process.

Important: To prevent unnecessarily exceeding the rate limits of GitHub's REST API, Veracode recommends generating the personal access token for a user account specifically dedicated to VRM.

Prerequisites

  • You are logged in to the user account that you want to associate with the VRM connector
  • The user account has access to the repositories that you want VRM to ingest.

To complete this task:

  1. Select your user icon in the upper-right corner, and select Settings.

  2. Select Developer settings at the bottom of the left navigation bar.

  3. Select Personal access tokens > Fine-grained tokens.

  4. Select Generate new token.

    Generate new token

  5. Use these instructions to complete the following fields:

FieldInstructions
Token nameAny unique name for the token.
ExpirationVeracode recommends one year from the creation date.
DescriptionAdd a description that notes that VRM uses this token.
Resource ownerSelect your organization.
Repository accessVeracode recommends you select All Repositories to grant VRM access to read all repositories. If you want to restrict VRM's access to certain repositories, select Only select repositories, then select all of the repositories that you want VRM to access.
Repository permissionsSet the Actions, Code scanning alerts, Contents, Dependabot alerts, Metadata, and Secret scanning alerts permissions to Access: Read-only.
Organization permissionsSet the Members permission to Access: Read-only.

Permissions

Organization permissions

  1. Select Generate token.
  2. Copy the generated personal access token and save it for later reference.

Create a VRM connector

  1. In VRM, from the left navigation menu, select the Settings icon settings_icon.png.
  2. Select Add Connector.
  3. Select the GitHub tile.
  4. Enter a name for the connector.
  5. Paste the access token you generated in GitHub.
  6. Select Add Connector.