BitBucket Integration

Install App

On the Integrations page, click on BitBucket to start integration.

Integrations home

Before moving on to the next step in the FlyingDuck make sure to login to the bitbucket website so that it will navigate to the bitbucket website and shows the available workspaces of that specific user. And need to have a work space in the bitbucket, move to workspace settings and make sure to enable the enable development mode in the installed apps section in the settings of bitbucket for all the required workspaces.

enabling Developer mode

Under install app click on Go to Proceed to install button.

Proceed to install

Click on grant access button on the bitbucket website to grant permission for FlyingDuck app in selected workspace.

Grant Access to the workspace

After granting the acces to the respective workspace flyingduck will intimate you that flyingduck will have only read access. Then click on Grant access button.

Grant Read Access to the workspace

when you click on Grant access button, App will get installed.

Grant Read Access to the workspace

click Next button.

Active Branches

Under active branches, specify the branch name as shown in the image.

Integration successful

By clicking on the Save & Continue button, the branch name that you gave will be saved.

Integration successful

click Next button.

API Key

If you've created API Key previously you can click on Skip or else you can create a new API Key.

Provide a name to your API Key that you are about to create and click on Generate API key

Integration successful

A new API Key will be generated that will be shown once, so store it with you confidentially.

Integration successful

Clicking on Next step will take you to code scan section.

Code Scan

The code scan can be done in two ways

Workflows
On-premise runner

Grant Read Access to the workspace

BitBucket workflow

Select BitBucket workflow to configure DuckDefender in BitBucket by adding the yml file, that you need to download from the flyingduck portal for Libraries and Secrets information.

Grant Read Access to the workspace

click Go to dashboard

After selecting BitBucket workflow, then click the Download. This will download the bitbucket-pipelines.yml file which looks like this.

bitbucket-pipelines.yml

# Version: '0.0.1'
pipelines:
  branches:
    main:
      - step: &DuckDefender
          name: DuckDefender scanner
          image: flyingduckio/duckdefender:latest
          caches:
            - docker
          script:
            # Define the DOCKER_TAG environment variable
            - export DOCKER_TAG="flyingduckio/duckdefender:latest"
            # Download image from docker hub
            - docker pull $DOCKER_TAG
            # Run the docker image
            - docker run  -e BITBUCKET_REPO_OWNER="$BITBUCKET_REPO_OWNER"
            -e BITBUCKET_REPO_SLUG="$BITBUCKET_REPO_SLUG"
            -e BITBUCKET_BRANCH="$BITBUCKET_BRANCH"
            -e BITBUCKET_COMMIT="$BITBUCKET_COMMIT"
            -e FD_API_KEY="$FD_API_KEY"
            -e PIPELINES_JWT_TOKEN="$PIPELINES_JWT_TOKEN"
            -e BITBUCKET_CLONE_DIR="$BITBUCKET_CLONE_DIR"
            -e ONLY_LATEST=True
            -v /opt/atlassian/pipelines/agent/build:/src  $DOCKER_TAG
          services:
            - docker
 
# Triggers the workflow on push events        
    master:
      - step: *DuckDefender
    develop:
      - step: *DuckDefender
    release:
      - step: *DuckDefender

Add API Key to the Repository

After downloading the file go to BitBucket website -> workspaces (select your workspace) -> Repositories (select your repo) -> Repository settings. In the Repo settings:

Go to Pipelines -> settings and enable the pipelines.

Enable pipelines

Go to Pipelines -> Repository variables and enter the Api key name FD_API_KEY and Api Key value

Configure Api Key

After adding the file you should commit. Based on which branch you've commited, if the branch is included in the given file, the respective data like libraries, secrets will be sent to FlyingDuck portal.

Custom Branch

If you want to commit to the custom branch like feature/* or bug/* and to check the findings of that branch then include that specific branch into the branches in bitbucket-pipelines.yml file.

bitbucket-pipelines.yml

 
# Triggers the workflow on push events        
    master:
      - step: *DuckDefender
    develop:
      - step: *DuckDefender
    release:
      - step: *DuckDefender
    feature/*:
      - step: *DuckDefender
    bug/*:
      - step: *DuckDefender

Troubleshoot

The debug option is used to understand what is happening within a particular command. If you need to troubleshoot, include this command LOG_LEVEL="debug" in the file.

bitbucket-pipelines.yml

# Version: '0.0.1'
pipelines:
  branches:
    main:
      - step: &DuckDefender
          name: DuckDefender scanner
          image: flyingduckio/duckdefender:latest
          caches:
            - docker
          script:
            # Define the DOCKER_TAG environment variable
            - export DOCKER_TAG="flyingduckio/duckdefender:latest"
            # Download image from docker hub
            - docker pull $DOCKER_TAG
            # Run the docker image
            - docker run  -e BITBUCKET_REPO_OWNER="$BITBUCKET_REPO_OWNER"
            -e BITBUCKET_REPO_SLUG="$BITBUCKET_REPO_SLUG"
            -e BITBUCKET_BRANCH="$BITBUCKET_BRANCH"
            -e BITBUCKET_COMMIT="$BITBUCKET_COMMIT"
            -e FD_API_KEY="$FD_API_KEY"
            -e PIPELINES_JWT_TOKEN="$PIPELINES_JWT_TOKEN"
            -e LOG_LEVEL="debug"
            -e BITBUCKET_CLONE_DIR="$BITBUCKET_CLONE_DIR"
            -e ONLY_LATEST=True
            -v /opt/atlassian/pipelines/agent/build:/src  $DOCKER_TAG
          services:
            - docker
 
# Triggers the workflow on push events        
    master:
      - step: *DuckDefender
    develop:
      - step: *DuckDefender
    release:
      - step: *DuckDefender

On-premise Runner

Grant Read Access to the workspace

Refer this for On-premise Runner

GitHub GitLab