Additional Jenkins configuration

Bridge CLI parameters

Air-gapped usage

You can set up the Black Duck Security Scan Plugin for Jenkins to use a cached version of Bridge rather than downloading from our internet-accessible repository. This is useful for any of the following situations:

• Your scans run in an air-gapped environment.
• You don't want your build machine to make a connection through the firewall.
• Black Duck Support directed you to use a custom version of Bridge.

To use the plug-in without an internet connection, do the following:

1. Store an uncompressed version of Bridge locally. (Extract the ZIP file that you downloaded from Black Duck.) The latest version is available at: repo.blackduck.com.
2. Set bridgecli_download_url with the location of your stored copy. This URL should be your internal instance of repo.blackduck.com or a similar repository service.
3. Set the value of network_airgap to true.

Proxy support

Here are two common methods for declaring proxy settings in Jenkins:

1. Utilize the environment block in the Jenkinsfile.

   environment { HTTP_PROXY = 'http://proxyIP:proxyPort' }

2. Employ the export keyword.

   export HTTP_PROXY=http://proxyIP:proxyPort

Black Duck Security Scan Plugin supports the following environment variables.

• Proxy with auth: Users need to pass a username and password for authentication.

  Example: http://user:password@proxyIP:proxyPort/

• Proxy with no auth: Users do not need to pass credentials for authentication.

  Example: http://proxyIP:proxyPort/

If proxy configuration requires authentication and the agent needs to run behind the proxy, pass parameters with authentication data when connecting the agent to the controller.

Using Docker containers

This guide explains how to configure the Black Duck Security Scan Plugin in Jenkins pipelines that use Docker agents. When using Docker agents, it is essential to mount specific directories into the container to ensure the the plugin functions correctly.

Required environment variable: -e HOME=$HOME must be provided. The Bridge CLI needs this variable so it can download and execute the necessary tools in the default $HOME path.

Refer to the Docker documentation for more information.

Jenkins pipeline configuration

Use the args field in the docker block to mount the required volumes.

pipeline {
    agent {
        docker {
            ...
            args '-e HOME=$HOME -v $HOME/bridge-cli-bundle:$HOME/bridge-cli-bundle -v $HOME/.blackduck:$HOME/.blackduck -v $JENKINS_HOME:$JENKINS_HOME'
        }
    ...
...

Example 2: Using custom Bridge CLI path

pipeline {
    agent {
        docker {
            ...
            args '-e HOME=$HOME -v /opt/blackduck/bridge-cli-bundle:/opt/blackduck/bridge-cli-bundle -v $HOME/.blackduck:$HOME/.blackduck -v $JENKINS_HOME:$JENKINS_HOME'
        }
    ...
...