GitHub integration

Snyk's GitHub integration lets you:

• Continuously perform security scanning across all the integrated repositories

• Detect vulnerabilities in your open-source components

• Provide automated fixes and upgrades

GitHub integration: per user, not per Organization

GitHub integration is set up for your own user account, not for a Snyk Organization. GitHub integration settings apply to all Organizations associated with your user account, but do not automatically apply to other user accounts in an Organization.

So when you import a Snyk Project via your GitHub integration with the Snyk PR functionality enabled, Snyk PRs are created for that Project. However, if another user imports Projects with their GitHub integration after disabling the Snyk PR functionality, Snyk PRs are not created for the Projects they import.

API import limitations

Similarly, you cannot use a GitHub integration to import public and private Projects via the Snyk API with a Snyk Service Account, as the GitHub integration is associated with your user account, not with the Snyk Organization. To import public and private Projects via the API with a Snyk Service Account, use the GitHub Enterprise integration.

Connect GitHub to Snyk

To connect your GitHub repositories to Snyk for scanning, you need to set up the integration, then import Projects.

See Set up an integration and Import a Project for details of this process.

GitHub integration settings

To see all settings for your GitHub integration, go to the Snyk GitHub Integration settings page, go to Organization Settings, then select GitHub in the INTEGRATIONS section:

You can then scroll down to the section required, and set the options accordingly:

• General settings

• Pull requests:

  • Open Snyk automatic PRs from a fixed GitHub account

  • Automatic fix PRs

  • Automatic dependency upgrade PRs

  • Pull request assignees

  • Snyk vulnerability patches

• Pull request status checks (PR Checks)

  • Open Source security and licenses

  • Code analysis

• Dockerfiles

  • Detect Dockerfiles

  • Update Dockerfile base images

General settings

Select General to view general settings:

• Integration ID: The unique ID for this integration; needed if you use the Snyk API.

• Repository access: Whether Snyk can access private repos (in addition to public repos). Changing this setting affects existing Projects.

GitHub integration features

After you have connected GitHub to Snyk, you can use:

• Project-level security reports

• Project monitoring and automatic fix pull requests

• Commit signing

• Pull request testing

Project-level security reports

Snyk produces advanced security reports that let you explore the vulnerabilities found in your repositories and fix them right away by opening a fix pull request directly in your repository, with the required upgrades or patches.

This example shows a Project-level security report.

Project monitoring and automatic fix pull requests

Snyk scans your Projects on either a daily or a weekly basis. When new vulnerabilities are found, Snyk notifies you via email and opens automated pull requests with fixes for your repositories.

The example that follows shows a fix pull request opened by Snyk.

To review and adjust the automatic fix pull request settings in the Snyk GitHub Integration settings page, go to Organization Settings > Integrations > Source control > GitHub.

Scroll down to the Automatic fix PRs section and set the options accordingly:

Commit signing

All the commits in Snyk's pull requests are done by [email protected] (a verified user on GitHub), and signed with a PGP key. All Snyk pull requests appear as verified on GitHub, thus providing your developers with the confidence that the fix and upgrade pull requests are generated by a trusted source.

Pull request status checks

The Snyk PR Checks feature allows Snyk to test any new PR in your repositories for security vulnerabilities and sends a status check to GitHub. This lets you see, directly in GitHub, whether the pull request introduces new security issues.

This example shows how Snyk PR checks appear on the GitHub pull request page.

You can review and adjust the pull request test settings via the Snyk GitHub Integration settings page in Organization Settings > Integrations > Source control > GitHub.

Required permissions scope for the GitHub integration

If you are on a Snyk Enterprise plan, you can use Snyk Broker as a proxy between Snyk and your Source Code Management (SCM) system on-premise platforms, including Snyk Code Support, or your publicly-accessible Git-based repositories.

Snyk Broker lets you view and control Snyk activity in those repositories for increased data security.

Brokered GitHub integrations

All the operations, both those that are triggered via the Snyk Web UI and the automatic operations, are performed for a GitHub service account that has its token configured with the Broker.

The table below provides a summary of the required access scopes for the configured token.

Non-brokered GitHub integrations

1. Operations that are triggered via the Snyk Web UI, for example, opening a Fix PR or retesting a project, are performed on behalf of the acting user. Therefore, a user who wants to perform this operation on GitHub via the Snyk UI must connect their GitHub account to Snyk, and have the required permissions scope for the repositories they want to perform these operations for. See the Required permissions scope for repositories section for details.

2. Operations that are not triggered via the Snyk Web UI, such as daily / weekly tests and automatic PRs (fix and upgrade), are performed on behalf of random Snyk Organization members who have connected their GitHub accounts to Snyk and have the required permission scope for the repository.

3. For public repositories that are non-brokered, some operations, such as creating the PR, may occasionally be performed by [email protected].

Required permission scope for repositories

For Snyk to perform the required operation on monitored repositories, that is, reading manifest files on a frequent basis and opening fix or upgrade PRs, the accounts that are connected to Snyk, either directly or via Snyk Broker, must have the following access to the repositories:

Setting an account to open Snyk PRs

Snyk lets you designate a specific GitHub account to open fix and upgrade pull requests.

To use this feature, follow the steps below:

1. Go to the GitHub Integrations settings page in the Snyk Web UI, via Organization Settings > Integrations > Source control > GitHub.

2. In the Open Snyk automatic PRs from a fixed GitHub account section, enter your GitHub personal access token (you can generate this from your GitHub account)

3. Click Save to enable this feature.

Assigning pull requests to users

Snyk can automatically assign the pull requests it creates to ensure that they are handled by the right team members.

Auto-assign for PRs can be enabled for the GitHub integration and all projects imported via GitHub, or on a per-project basis.

Users can either be manually specified, and all will be assigned, or automatically selected based on the last commit user account.

Enable Auto-assign for all Projects in the GitHub integration

To configure the Auto-assign settings for all the Projects from an imported private repository, go to the Github integration settings via Organization Settings > Integrations > Source control > GitHub, enable Auto-assign PRs in private repos, and choose to assign PRs to the last user to change the manifest file or specified contributors.

Enable Auto-assign for a single Project

To configure the Auto-assign settings for a specific Project from an imported private repository.

1. In the Projects tab for your Organization, select and expand the relevant private repository, select a Target, and click the Settings cog. The Project page opens.

2. On the Project page, to apply unique settings for that specific Project, select the Settings tab in the upper right, and the Github integration __ option in the left sidebar.

3. Go to the Pull request assignees for private repos section at the bottom of the page and choose to Inherit from integration settings or Customize only for this project. Ensure Auto-assign PRs for this private project is enabled. Choose to assign PRs to the last user to change the manifest file or named contributors.

Disconnecting the GitHub integration

Snyk’s GitHub SCM integration leverages the OAuth app integration. If you integrated GitHub without using Snyk Broker, you can disconnect it by following these steps:

1. In GitHub, log in to the GitHub account that you used to create the integration.

2. Go to your GitHub account settings and select the Applications option in the left sidebar.

3. Select the Authorized OAuth Apps tab. You can also reach the Authorized OAuth Apps tab directly.

4. Find the Snyk entry, click the three (3) dots on the right, and select Revoke.

Revoking this access effectively disconnects Snyk’s access to that GitHub account. Existing imported snapshots will persist in Snyk and continue to be re-scanned based on the existing snapshots until deleted. Snyk will no longer be able to import new projects from the GitHub integration and will no longer re-scan on new code merges.

In addition, you must confirm that Snyk is not enabled on any existing Branch protection rules: From the main page of your GitHub repository, go to Settings > Branches > Branch protection rules, and make sure there are no Status checks found in the last week for this repository.

GitHub badges

Once you are vulnerability-free, you can put a badge on your README page to let the world know that your package has no known security holes. This shows your users that you care about security, and tells them that they should care too.

The badge indicates the vulnerability state of the latest commit on the master branch.

Repository badges

To show a badge for a specific Node.js, Ruby, or Java GitHub repository, copy the relevant HTML or markdown snippet below and replace {username}/{repo} with the GitHub username and repo you want to test.

HTML

<a href="https://snyk.io/test/github/{username}/{repo}">

Markdown

[![Known Vulnerabilities](https://snyk.io/test/github/{username}/{repo}/badge.svg)](https://snyk.io/test/github/{username}/{repo})

Badges for a branch, release version, or other tag

To show the vulnerability state of a specific branch, release, or tag, add its name after the repo name in the URL.

For example, to show a badge for the 4.x branch of the express repo, you would use the URL: https://snyk.io/test/github/expressjs/express/4.x/badge.svg.

Badge results

• A green badge indicates that there are no vulnerabilities.

• A red badge indicates how many vulnerabilities were found.

• A grey badge indicates that the repository has not been scanned.

Badge styles

To change the style of the badge, you can add the following query parameters after badge.svg:

• Flat rectangle with squared edges: ?style=flat-square

• "Plastic" rectangle with rounded edges and shading ?style=plastic

npm badges

To show a badge for a given npm package, copy the relevant snippet that follows, and replace {name} with the name of your package.

HTML

<img src="https://snyk.io/test/npm/{name}/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/npm/{name}" style="max-width:100%;"/>

Markdown

[![Known Vulnerabilities](https://snyk.io/test/npm/{name}/badge.svg)](https://snyk.io/test/npm/{name})

The badge shows the vulnerability state of the latest version of this package. To show the vulnerability state of a specific package, you can specify the version in the URL.

For example, to test version 1.2.3 of package name, you would use the URL: https://snyk.io/test/npm/name/1.2.3/badge.svg.

Badges for private packages and repos

Badges currently work only for public npm packages and GitHub repositories, and fail if pointed at a private repository. To continuously watch for vulnerabilities in your GitHub repositories, both public and private, consider integrating them with Snyk.

Badges for custom manifest file locations

By default, the badge will test against the first valid manifest file it detects in the root of your project.

If your manifest file is in different location from the root of the repository, or if you have multiple manifest files for which you would like to show a badge , you can pass a targetFile query string parameter to direct the badge to test against another supported manifest file.

HTML

<a href="https://snyk.io/test/github/{username}/{repo}">

Markdown

[![Known Vulnerabilities](https://snyk.io/test/github/{username}/{repo}/badge.svg?targetFile={path-to-target-file})](https://snyk.io/test/github/{username}/{repo})