TABLE OF CONTENTS

Overview

This article explains the process of integrating your code repositories with Aqua. Your repositories may be hosted on different Source Code Management tools such as GitHub, Bitbucket, and GitLab. Once you integrate the required code repositories, Aqua will scan them and display the security findings such as vulnerabilities, sensitive data, and misconfigurations in the Code Repositories page.


You can integrate your code repositories using one of the following methods:

  • Source Code Management: to integrate with the source code management tools directly by granting their access to Aqua. Through this method, you can also integrate code repositories hosted on on-premises platforms: Azure Server, Bitbucket Server, GitHub Server, and GitLab Server.
  • CI Integration: by adding the Aqua Trivy Premium Scanner to your build pipeline, by following instructions on the UI. Through his method, the source code management tools connected to the pipeline will be scanned and security findings will be detected.

Once you integrate the required code repositories using either the Source Code Management or CI Integration method, all the pipelines and dependencies associated with code repositories are discovered and displayed in the code repository detailed view.

You can connect Aqua to multiple organizations of the same provider.

You can integrate your code repositories with Aqua from the Supply Chain Security module > Integrations page.


From the Integrations page, you can also integrate with CI/CD build systems to detect any security issues in the configurations of the platform. For more information, refer to Integration with Build Platforms.


Prerequisites

  • Network access to https://codesec.aquasec.comfor the customers who want to integrate the on-premises source code management tools: Azure Server, Bitbucket Server, GitHub Server, and GitLab Server. For the cloud-based source code management tools, this access is available by default.
  • Outbound HTTPS traffic should be allowed from your server to integrate with the on-premises source code management tools. To check Aqua's connectivity from your server, run the following commands from the connector host:
curl https://connect.codesec.aquasec.com/
curl https://scan.codesec.aquasec.com/
  • Admin-level privileges to the "Controller" in Jenkins and "Organization" in the other source code management tools, that you want to integrate with Aqua. For example, if you want to integrate a GitHub Organization with Aqua through the Automatic method, you must have "Owner" privilege in the Organization.


Code Repository Integrations page

Once you integrate with a few code repositories through the Source Code Management or CI Integration methods, all the connections are displayed in the Integrations page as shown below:



You can see the following information in this page:

  • Provider: such as GitHub, GitLab, or GitHub Server
  • Organization Name: in the provider to which Aqua has been connected
  • Status: shows the health of the connection with Aqua: Good or Issue (not good)


You can search or filter the connections using the following options:

  • Search: with organization name to find any connection
  • Provider: to filter the connections by provider
  • Status: to filter the connections by their health: Good, Issue, or All

Add a new code repository

You can add the required code repositories available in the connected source code management tools for scanning them. When the repositories are scanned, Aqua displays scan results in the Code Repositories page.


On the top right side of the Integrations page, click Connect and select either Source Code Management or CI Integrations as required to integrate using the respective method.


Refer to either the Source Code Management or CI Integrations section below for instructions on integrating your code repositories.



Source Code Management

To integrate your code repository in the source code management tool using this method:

  1. On the top right side of the Integrations page, click Connect and select Source Code Management. The Source Code Management selection page will appear.
  2. Select the required source code management tool. You can click Show More Options to see more tools. The Authentication section appears.


      3. In the Authentication section, complete the authentication to the source code management tool as instructed on the UI. This is required to grant Aqua the read/write access to the source code management tool for scanning your code repositories. The authentication process and details required for each source code management tool are different, as explained below.


Source code management toolAuthentication details
Azure
  • Install App: It will navigate you to the Azure page where you can grant the read/write access to your code in the Azure application.
  • Organization name: Once access is granted, you should enter the organization name in Azure to proceed with connecting to your Azure account.
Azure ServerYou can connect to your Azure Server (on-premises) account by providing the required permissions on the hosting platform. You should complete authentication on either the Docker or Kubernetes platform by following instructions in the UI. For more information, refer to Integration with On-Premises Code Repositories.
BitbucketEnter the following details:
  • Username
  • App Password: Create an app password in your Bitbucket environment by granting the permissions shown below, and add the app password to the Aqua Bitbucket Integrations page. Refer to the Bitbucket document App passwords to learn how to create a Bitbucket app password. 
  • Workspace name

While creating an app password in Bitbucket:
  • Set the app password name to "Aqua Supply Chain"
  • Grant access to the followingwith either "Read" or "Read and Write" permissions:
    • Account (Read)
    • Pipelines (Read)
    • Projects (Read)
    • Repositories (Read)
    • Webhooks (Read and Write)
Bitbucket ServerYou can connect to your Bitbucket Server (on-premises) account by providing the required permissions on the hosting platform. You should complete authentication on either the Docker or Kubernetes platform by following the instructions in the UI. For more information, refer to Integration with On-Premises Code Repositories.
GitHubYou should have the GitHub permission as "Organization Owner" to connect Aqua with your repositories.

In the Authentication section, click Connect to navigate to GitHub where you can perform the following:
  1. Login with your GitHub credentials.
  2. Select either "All repositories" or only the selected repositories to grant permissions to Aqua to access these repositories.
  3. Click Install to complete the authentication process.
GitHub ServerYou can connect to your GitHub Server (on-premises) account by providing the required permissions on the hosting platform. You should complete authentication on either Docker or Kubernetes platform by following the instructions in the UI. For more information, refer to Integration with On-Premises Code Repositories.
GitLab
  • Group ID
  • Personal Access Token: Generate this in GitLab and copy it to the Aqua UI. Refer to the GitLab document Personal access tokens for more information.

While creating a personal access token in GitLab:
  • Set the name for personal access token to "Aqua Supply Chain"
  • Grant access to the following with the "Check" permissions:
    • read-api
    • read-repository
    • read-user

GitLab ServerYou can connect to your GitLab Server (on-premises) account by providing the required permissions on the hosting platform. You should complete authentication on either the Docker or Kubernetes platform by following the instructions in the UI. For more information, refer to Integration with On-Premises Code Repositories.

Authentication section of the Azure integration is shown below for your reference:



       4. In the Repositories section, select the required code repositories that you want Aqua to scan and detect security findings.

       5. Click Start Scanning. The repositories will be added, and security findings will be displayed on the Code Repositories page.


You can add any number of repositories to Aqua from an "Organization" in the source code management tool.


Once the selected code repositories are added and scanned, you can see these repositories and their security findings on the Code Repositories page. You can also add more repositories of the connected source code management tool in the Code Repositories page later. For more information, refer to Code Repositories and Checks.


By default, code repositories having activities in the last six months are automatically selected for scanning, while integrating with its source code management tool for the first time. If required, Admins can check these code repositories and remove their selection. 


Example: Source Code Management connection with a code repository in GitHub

Watch the video below to see an example on how to connect a code repository in GitHub.



CI Integrations

You can integrate a new code repository manually by adding a code block displayed in the UI to your project in the CI build system. Different code blocks are displayed in the UI, depending on where you want to apply them, as explained below:

  • Pull Request: to scan the specific code changes in a pull request. When a new pull request is triggered, Aqua scans the code changes in the pull request automatically and displays scan results in the Code Repositories page. If you select this option, the existing code repository on which the pull request is raised will not be scanned. If you want to scan the full code repository, select the Push option.
  • Push: to scan the full code repository. When a new build is triggered, Aqua scans the newly built code repository and displays scan results in the Code Repositories page.

To integrate a code repository in the source code management tool:

  1. On the top right side of the Integrations page, click Connect and select CI Integrations. The CI Integration page will appear.
  2. Select the repository hosting platform relevant to your organization, such as GitHub Actions or Bitbucket Pipelines. The Integration Instructions section will appear.


3. Perform the following actions to integrate your code repository with the repository hosting platformDetailed integration instructions are displayed in the UI for the selected source code management tool.
  1. In your pipeline settings, add Aqua Key and Aqua Secret as secrets or variables. You can get these details from the CSPM module > Settings > API Keys. These secrets are required to identify the Aqua environment to which the repository will be integrated, and security findings will be generated. The secrets or variables that should be added to your pipeline settings vary depending on the selected repository hosting platform, as explained below:


CI build systemSecrets or variables required
Azure PipelinesAdd the following variables to your Azure secret variables:Refer to the Azure document, Secret variable in the UI for more information on how to add variables to the pipeline settings.
Bitbucket PipelinesAdd the following variables to your Bitbucket workspace variables:
  • AQUA_KEY=<Aqua Key>
  • AQUA_SECRET=<Aqua Secret>
  • BITBUCKET_TOKEN=The app password generated with the `pull request read` scope
  • BITBUCKET_USER=Your Bitbucket username collected from your personal settings
Refer to the Bitbucket document, Workspace variables for more information on how to add variables to the pipeline settings.
CircleCIAdd the following variables to your Azure secret variables:
  • AQUA_KEY=<Aqua Key>
  • AQUA_SECRET=<Aqua Secret>
  • PROVIDER_TOKEN=<Provider token or personal access token>
Refer to the CircleCI document Set an environment variable in a project for more information on how to add variables to the CircleCI project settings.
JenkinsAdd the following variables to your Jenkins Global Credentials:
  • AQUA_KEY=<Aqua Key>
  • AQUA_SECRET=<Aqua Secret>
  • PROVIDER_CREDETIALS=Your provider credentials (Username and password)
Refer to the Jenkins document, Adding new global credentials for more information on how to add the variables to your Jenkins Global Credentials.

Note: Aqua supports integrating with Jenkins pipelines of both the types: Multibranch Pipeline and Pipeline.
GitHub ActionsAdd the following variables to your Organization Encrypted Secrets:
  • AQUA_KEY=<Aqua Key>
  • AQUA_SECRET=<Aqua Secret>
Refer to the GitHub document, Organization Encrypted secrets for more information on how to add the variables as encrypted secrets to your GitHub Organization.
GitLab CI/CD

Add the following variables to your CI/CD variables:

Refer to the GitLab document, Add a CI/CD variable to a group for more information on how to add a variable to your GitLab group.

Note: Make sure your CI/CD variables are not marked as protected, otherwise you will not be able to use them.


        b. Follow the instructions displayed on the UI for each CI build system to establish a connection with the pipeline.

        c. Select either Pull request or Push, depending on whether you want to scan the specific code changes in a pull request or full code repository.


The CI Integration page for Azure Pipelines is shown here for your reference:



           d. Copy the code block and add it to the workflow in your project or pipeline. Once the CI integration is successful, you will see the integrated code repository on the Code Repositories page.