Bitbucket Cloud
Overview
Checkmarx One supports Bitbucket integration, enabling automated scanning of your Bitbucket projects whenever the code is updated. Checkmarx One’s Bitbucket integration listens for Bitbucket commit events and uses a webhook to trigger Checkmarx scans when a push, or a pull request occurs. Once a scan is completed, the results can be viewed in Checkmarx One.
In addition, for pull requests, a comment is created in Bitbucket, which includes a scan summary, list of vulnerabilities and a link to view the scan results in Checkmarx One.
Notice
This integration supports both public and private git based repos.
The integration is done on a per project basis, with a specific Checkmarx One Project corresponding to a specific Bitbucket repo.
Notice
You can select several repos to create multiple integrations in a bulk action.
Prerequisites
The source code for your project is hosted on a Bitbucket repo.
You have a Checkmarx One account and have credentials to log in to your account.
The Bitbucket user has admin privileges for this repository, see Code Repository Integrations.
Setting up the Integration and Initiating a Scan
To integrate your Bitbucket organization with Checkmarx One, perform the following:
In the Applications and Projects home page, click on New > New Project - Code Repository Integration.
The Import From window opens.
Select Bitbucket.
Sign in to Bitbucket using one of the following options:
Approve the Checkmarx One request to access the Bitbucket account by clicking Grant Access.
Select the Bitbucket Organization or Group (for the requested repository) and click Select Organization.
The screen contains the following functionalities:
Search bar - Auto-complete is implemented. The search is not case sensitive.
Infinite scroll - For enterprises with a large amount of organizations.
Select the Repository inside the Bitbucket organization and click Next.
Note
A separate Checkmarx One Project will be created for each repo that you import.
There can’t be more than one Checkmarx One Project per repo. Therefore, once a Project has been created for a repo, that repo is greyed out in the Import dialog.
In the Repositories Settings screen, perform the following and click Next.
Permissions:
Scan Trigger: Push, Pull request - Enable/disable automatic scans for every push event or pull request.
Pull Request Decoration - Enable/disable pull request decoration.
For additional information see Code Repository Integration Usage & Results.
Scanners: Select the scanners for All/Specific repositories. At lease 1 scanner must be selected for each repository.
Protected Branches: Select which Protected Branches to scan for each repository.
Note
For additional information about Protected Branches see About Protected Branches
Add SSH key.
Assign Groups: Specify the Groups to which you would like to assign the project.
Assign Tags: Add Tags to the Project. Tags can be added as a simple strings or as key:value pairs.
Set Criticality Level: Manually set the project criticality level.
Note
If multiple repositories are selected, an additional configuration option will appear at the top of the wizard for applying settings to all selected repositories. Configure the necessary parameters, then scroll down on the right-side panel and click Apply to all.
For example:
Select which Protected Branches to scan for each Repository and click Next.
Note
For additional information about Protected Branches see About Protected Branches
In the Advanced Options screen it is possible to select Scanning the default branch upon the creation of the Project.
You also must select the default branch for the automatic scan, as Bitbucket doesn't have a default one.
Click Create Project.
The Project is successfully added to the Applications and Projects home page.
Note
In order to update the scanners see Imported Project Settings
