Snyk integrates with Bitbucket Pipelines using a Snyk pipe, seamlessly scanning your application dependencies and Docker images for open source security vulnerabilities as part of the continuous integration/continuous delivery (CI/CD) workflow.
Bitbucket Pipes enables users to customize and automate a Bitbucket Pipeline CI/CD workflow with a group of ready-to-use tasks that can be added inside of your pipelines by copying and pasting them from the Bitbucket interface.
With the Snyk pipe, you can quickly add Snyk scanning to your pipelines to test and monitor for vulnerabilities at different points of the CI/CD workflow, based on your configurations. Results are then displayed from the Bitbucket Pipelines output view and can also be monitored from Snyk.io.
From the build directory, Bitbucket Pipelines displays a list of available pipes customized for you directly, similar to the following image:
 |
From this list, find and click Snyk to view the pipe, examples, parameters, and values:
Snyk integration with Bitbucket pipes is supported for the following languages:
-
JavaScript (npm)
-
.NET (NuGet)
-
PHP Composer
-
Ruby
-
Docker
Once the user has added the Snyk pipe to the pipeline, each time the pipeline executes (by any trigger type) the Snyk pipe does the following.
To enable Snyk to test and monitor your code as an integral part of your CI/CD workflow in Bitbucket, add the Snyk pipe into your bitbucket-pipelines.yml (YAML) file. The bitbucket-pipelines.yml file should be located in the root of your repository, and it is this file that defines all your build configurations (pipelines for your CI/CD workflow).
-
For your Bitbucket Pipelines, ensure you have build minutes in your account, which are necessary to enable ongoing CI/CD workflows.
-
Create a Snyk account and retrieve the Snyk API token from your Account settings.
-
Create a Repository variable from Bitbucket for your Snyk API token. Call the variable SNYK_TOKEN.
-
For npm projects, if you would like to enable automatic remediation for the CI/CD workflow as well, run the Snyk wizard first.
-
Add the Snyk pipe while originally creating your pipeline, or while editing an existing pipeline. See the Bitbucket documentation for more information about pipelines and pipes. When adding the Snyk pipe, follow these guidelines:
-
Use the Bitbucket pipeline editor to update the .yml file configuration, select the correct language and use the Bitbucket Pipes build directory when adding the Snyk pipe.
-
Paste the Snyk pipe into the Bitbucket editor interface, after all, build steps. Build steps are commands such as these:
npm install / composer install / bundle install / dotnet restore / docker build -
Ensure you paste the pipe before a deployment step, such as npm publish or docker push.
-
Configure the LANGUAGE, choose whether to fail the pipeline on vulnerabilities found with DONT_BREAK_BUILD (you can also use SEVERITY_THRESHOLD), and consider enabling MONITOR and PROTECT (Protect for Node.js projects only). See Snyk pipe parameters and values for more information.
-
Once included in your pipeline commands, Snyk looks for the manifest files in that repository (package.json, package-lock.json) and performs the scan.
-
Results appear in the Bitbucket Pipelines output interface, similar to the following:
Note
If the build fails, even if MONITOR is set to True, Snyk does not continue to the Monitor stage (because no projects are deployed until the build succeeds). To enable monitoring on Snyk.io of projects with vulnerabilities, set DONT_BREAK_BUILD to True. You can use SEVERITY_THRESHOLD to tell the pipe the severity threshold from which to fail the pipe at the scanning stage. See Snyk pipe parameters and values for more information.
Following is the Snyk pipe that should be configured as part of a pipeline YAML file in order to include vulnerability scanning as part of your CI/CD workflow:
- pipe: snyk/snyk-scan:0.4.6
variables:
SNYK_TOKEN: '<string>': It's preferable to encrypt this value and enter the string $SNYK_TOKEN only in the pipeline. See the table below for more information.
LANGUAGE: '<string>' # Required unless you use the snyk-cli image.
# IMAGE_NAME: '<string>' # Only required if LANGUAGE set to 'docker'
# CODE_INSIGHTS_RESULTS: '<string>' # Optional. Default: false.
# SNYK_TEST_JSON_INPUT: "<string>" # Optional. Default: false.
# DONT_BREAK_BUILD: '<boolean>' # Optional.
# MONITOR: '<boolean>' # Optional.
# SEVERITY_THRESHOLD: '<low|medium|high>' # Optional
# ORGANIZATION: '<string>' # Optional.
# PROJECT_FOLDER: '<string>' # Optional.
# TARGET_FILE: '<string>' # Optional.
# EXTRA_ARGS: '<string>' # Optional.
# DEBUG: '<boolean>' # Optional.
The following table describes the Snyk pipe parameters.
|
Parameter |
Description |
|
SNYK_TOKEN (*) |
Enter the Snyk API token, which you can retrieve from your Snyk Account settings. We recommend you encrypt the token: you can add it as a predefined variable in a separate part of the Bitbucket pipes directory:
See Bitbucket documentation for more information about predefined variables. |
|
LANGUAGE (*) |
Configure the package manager of the app (for example, npm, maven, rubygems, composer, nuget or docker). See Dockerhub for a full list of possible tags. |
|
IMAGE_NAME (*) |
For docker language only, configure the image name for which to perform a docker scan. |
|
CODE_INSIGHTS_RESULTS |
Create Code Insight report with Snyk test results. Default: `false`. |
|
SNYK_TEST_JSON_INPUT |
Use if you just want to create a Code Insights report from a previously generated `snyk test --json` output. See example below in the "Generating the Code Insights report from existing Snyk JSON output" section. |
|
PROTECT |
Supported only for JavaScript (npm) currently. This parameter applies the patches specified in your .snyk file to the local file system when set to True. Default: false. Automatic remediation is disabled. In order to enable automatic remediation, first run the Snyk Wizard, which creates and adds the .snyk file to your project. |
|
DONT_BREAK_BUILD |
When set to true, continues the build even when vulnerabilities are discovered. Default: false. The build fails. |
|
MONITOR |
Records a snapshot of the project for the Snyk UI and then continues monitoring the project after the build is run. If the test succeeds, this records a snapshot of the app’s dependencies in the Snyk app and allows you to see the state of your deployed code, have it monitored and receive alerts when new vulns are found in the code. Default: false. The project is not monitored after the initial scan. |
|
SEVERITY_THRESHOLD |
Reports issues equal to or higher than the configured level. Possible values: low, med, high Default: low. All vulnerabilities are reported. |
|
ORGANIZATION |
Configures the organization from your Snyk account to which to associate the repository. Default: none. |
|
PROJECT_FOLDER |
The folder in which the project resides. Default: .. |
|
TARGET_FILE |
The package file (for example package.json); equivalent to --file= in the CLI. For Docker enter the Dockerfile as the value. Default: none. |
|
EXTRA_ARGS |
Extra arguments to be passed to the Snyk CLI. Use the parameters and arguments as described here. Default: none. |
|
DEBUG |
Turn on extra debug information. Default: false |
Example of a Snyk pipe for Docker
Following is an example of the Snyk pipe set up for a Docker image:
 |
Example of a Snyk pipe for npm
Following is an example of the Snyk pipe set up for npm:
 |