Snyk Broker

Feature availability

Snyk Broker is available only for Enterprise plans. For more information, see plans and pricing.

Snyk Broker is an open-source tool that acts as a proxy between Snyk and special integrations, allowing for access by snyk.io to your code to scan it and return results to you. SCM integrations with Broker support Snyk Open Source, Snyk Code, Snyk Container (Dockerfile), Snyk IaC. and Snyk AppRisk. For more information, see How Snyk Broker works.

How to download and install Snyk Broker

Snyk Broker is hosted on GitHub and published as a set of Docker images for specific integrations. If you are using Kubernetes, Snyk provides a Helm Chart to deploy Snyk Broker. To deploy Broker, you must install and configure an integration.

You can install and configure using Helm or Docker. You can install using Docker to run the Snyk Broker Client or run npm install snyk-broker. Snyk recommends using Helm as the simplest way to deploy Snyk Broker.

Integrations with Snyk Broker

Install each type of integration and configure using environment variables, as explained for Docker and Helm.

Types of integrations supported with Broker are:

• Your Source Code Management (SCM) system (GitHub, GitHub Enterprise, BitBucket Server/Data Center, GitLab, Azure Repos)

  • SCM that is not internet-reachable

  • Publicly-accessible SCM, allowing you to view and control Snyk activity for increased data security

• Your on-premise Jira, JFrog Artifactory, or Nexus installation

• Network-restricted container registries

• Infrastructure as code (IaC) configuration files on private Git-based repositories

You can also use derived Docker images for each integration and the Container Registry Agent.

For information about advanced configuration as needed for your installation, see Advanced configuration for Snyk Broker Docker installation and Advanced setup for Helm Chart installation.

Using Snyk Broker to scan your code

To use Snyk Open Source with Snyk Broker, you need only the Broker Server and Broker Client components. The Broker Client is published as a set of Docker images, each configured for a specific Git service. Configure each type of integration using environment variables following the links in the section Integrations with Snyk Broker.

To scan other types of code with Snyk Broker, you must add a component or configurations and add parameters to the Broker Client setup:

• Snyk Code – Grant Broker access to perform a Git clone of your repository by adding an environment variable: ACCEPT_CODE=true.

• Snyk Container – add the Container Registry Agent to enable the connection to network-restricted container registries and the analysis of container images. There are instructions for installing with Docker and installing with Helm.

• Snyk Infrastructure as Code – configure the accept.json file with additional parameters to detect and analyze Terraform, CloudFormation, and Kubernetes configuration files through Snyk Broker.

How Snyk Broker works

Snyk Broker is designed to connect Snyk products to self-hosted integrations that are not publicly accessible from the internet. Snyk Broker also allows you to do the following:

• Control Snyk access to your network by limiting the files to which Snyk has access and the actions that Snyk can perform.

• Manage a fixed private IP for your integration, targeting the Broker.

Snyk Broker includes a Server and a Client, basic components that are the same across all integrations. The Broker Server runs on the Snyk SaaS backend and is provided by Snyk; no installation is required. The Broker Client is a Docker image deployed in your infrastructure. For more information, see Components of Snyk Broker and Connections with Snyk Broker.

See Prepare Snyk Broker for deployment for information about prerequisites, choosing components, network configuration, and credentials.

Common questions about Snyk Broker

How often is Snyk Broker updated? Snyk Broker is updated each time new features become available and when there are fixes.

How often is Snyk Broker checked for vulnerabilities? The Snyk Broker application and images are tested daily for vulnerabilities.

What is the SLA to fix vulnerabilities? There is a 14-day SLA for fixing high vulnerabilities and a five-day SLA for fixing critical vulnerabilities in public images.