Skip to main content

Bitbucket Self-Hosted

Notice

It is possible to add the Checkmarx One external IP addresses to the customer Firewall allowlist - For more information see Checkmarx One External IPs

In addition, if the code repository is not internet accessible, it is possible to configure the code repository IP address instead of its hostname during the initial integration with the code repository - as it is not resolved via DNS.

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.

Retrieving Bitbucket Username & Token

Important

The example below relates to Bitbucket server v7.1 and below.

In newer versions (Above 7.1) the Personal access tokens are replaced with HTTP access tokens.

Checkmarx One doesn't support HTTP access tokens for projects or repositories.

For additional information on how to create HTTP access tokens see Bitbucket HTTP access tokens.

To retrieve your Bitbucket Username & Token, perform the following steps:

  1. In your Bitbucket account, click on your user > View Profile.

    Bitbucket_View_Profile.png

  2. Retrieve your Username.

    Bitbucket_Username.png

  3. To create a Token, click on your user > Manage account.

    Bitbucket_Manage_Account.png

  4. Click on Personal access tokens.

    Bitbucket_Personal_Access_Tokens.png

  5. Click on Create a token.

    Bitbucket_Create_Token.png

  6. Give the token at least Read permissions for Projects and Repositories.

    Bitbucket_SH_PAT.png

  7. Click Create.

Setting up the Integration and Initiating a Scan

To integrate your self hosted (on-prem) Bitbucket organization with Checkmarx One, perform the following:

  1. In the Applications and Projects home page, click on New > New Project - Code Repository Integration.

    Code_Repo_Integration.png

    The Import From window opens.

    Image_946.png

  2. Select Self-hosted → Bitbucket.

  3. Configure the following fields and click Next:

  4. 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.

    Bitbucket_Select_Org.png

  5. 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.

    6427967602.png

  6. 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.

    • 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.

      Bitbucket_Repo_Settings.png

  7. Select which Protected Branches to scan for each Repository and click Next.

    Note

    For additional information about Protected Branches see About Protected Branches

    Bitbucket_Select_Branches.png

  8. 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.

    Bitbucket_Advanced_Options.png

  9. The Project is successfully added to the Applications and Projects home page.

    Note

    In order to update the scanners see Imported Project Settings

    Bitbucket_Scan_initiated.png

Updating Project Settings

See Code Repository Settings.

In this section: