Bitbucket Data Center/Server integration

The Snyk Bitbucket Data Center/Server integration allows you to continuously perform security scanning across all the integrated repositories, detect vulnerabilities in your open-source components, and use automated fixing. This integration supports Bitbucket Data Center/Server versions 4.0 and above.

For a quick reference, see the Snyk and Bitbucket best practices cheat sheet on the Snyk blog.

Setting up a Bitbucket DC/Server Integration

1. To give Snyk access to your Bitbucket DC/Server account, set up a dedicated service account in Bitbucket DC/Server with admin permissions. Visit Bitbucket Server documentation to learn more about creating users. Make sure the newly-created user has Admin permissions to all the repositories you need to monitor with Snyk.

2. In Snyk, go to the Integrations page and click on the Bitbucket Server card.

3. Enter your Bitbucket DC/Server URL and the username and password for the service account you created. Alternatively, you can create a personal access token and use it instead of a password.

4. Save your changes. Snyk connects to your Bitbucket DC/Server instance. When the connection succeeds, a confirmation message appears on your integrations screen.

Importing Projects

To select the repositories for Snyk to monitor:

1. Click Add your Bitbucket Server repositories to Snyk to start importing repositories to Snyk.

2. When prompted, select the repositories to import to Snyk and click Add selected repositories.

After you add them, Snyk scans the selected repositories for dependency files in the entire directory tree, (that is, package.json, pom.xml, and so on) and imports them to Snyk as projects. The imported projects appear in your Projects page and are continuously checked for vulnerabilities.

Bitbucket DC/Server Integration Features

After the integration is in place, you can use capabilities such as:

• Project-level security reports

• Project monitoring and automatic fix pull requests

• 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 immediately by opening a fix pull request directly to your repository, with the required upgrades or patches.

The example that follows showsa 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 by email and by opening automated Snyk 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:

1. In Snyk, go to (Organization settings) > Integrations > Source control > Bitbucket Server, and click Edit Settings.

2. Scroll to the Automatic fix PRs section and configure the relevant options.

Pull request tests

Snyk tests any newly-created pull request in your repositories for security vulnerabilities and sends a build check to Bitbucket DC/Server. You can see directly from Bitbucket DC/Server whether or not the pull request introduces new security issues.

The example that follows shows a Snyk pull request build check on the Bitbucket DC/Server Pull Request page.

To review and adjust the pull request tests settings:

1. In Snyk, go to (Organization settings) > Integrations > Source control > Bitbucket Server and click Edit Settings.

2. Scroll to Default Snyk test for pull requests > Open Source Security & Licenses, and configure the relevant options.

Required permissions scope for the Bitbucket DC/Server integration

Snyk performs all the operations in Bitbucket DC/Server on behalf of the integrated service account.

For Snyk to perform the required operations on monitored repositories, such as reading manifest files on a frequent basis and opening fix or upgrade PRs, the integrated Bitbucket DC/Server service account needs Admin permissions on the imported repositories.

Disabling the Bitbucket Data Center/Server integration

To disable this integration, in (Organization settings) > Integrations, follow these steps:

1. In your list of integrations, select the Bitbucket integration you want to deactivate and click Edit settings to open a page with the current status of your integration. The page includes sections that are specific to each integration, where you can manage your credentials, API key, Service Principal, or connection details.

2. Scroll to the relevant section and click Remove Bitbucket Server.