README-legacy.md

Sysdig Secure Jenkins Plugin - Legacy Documentation

Sysdig Secure is a container security platform that brings together Docker image scanning and run-time protection to identify vulnerabilities, block threats, enforce compliance, and audit activity across your microservices. The Sysdig Secure Jenkins plugin can be used in a Pipeline job, or added as a build step to a Freestyle job to automate the process of running an image analysis, evaluating custom policies against images, and performing security scans.

Getting Started

Backend scanning or Inline scanning

The Sysdig Secure plugin supports two different operation modes:

• Backend Scanning: Image scanning happens in the Sysdig Secure Backend
• Inline Scanning: Image scanning happens in the Jenkins worker nodes

Backend Scanning

PRO:

• Jenkins workers do not need to communicate with the host-local Docker daemon

CON:

• Sysdig Secure Backend needs to have network visibility in order to fetch and scan the images during the pipeline

Inline Scanning

PRO:

• No need to configure registry credentials in the Sysdig Secure Backend
• No need to expose your registry externally, so it can be reached by Sysdig Secure (see CON in the section above)
• Image contents are never transmitted outside the pipeline, just the image metadata

CON:

• The job performing the inline scanning needs to have access to the Docker daemon

Pre-requisites

Both modes require a valid Sysdig Secure API token

For Backend mode, the Sysdig Backend (SaaS or Onprem) needs to be able to fetch the images produced by this pipeline, usually accessing a buffer Docker repository.

For Inline mode, Jenkins workers need to have access to the Docker daemon, in the most common case, by mounting or linking the Docker socket or connecting as specified by DOCKER_HOST environment variable. The Jenkins worker user needs to be able to read and write the socket, and for TCP connections TLS and certificated might be required, depending on the daemon configuration.

Alternatives for inline scanning without docker

Support for dockerless environments is coming soon.

Meanwhile, inline scanning can be integrated (without the integrated Jenkins reporting features) by executing the inline-scan container as part of a podTemplate.

See some examples in https://github.com/sysdiglabs/secure-inline-scan-examples/tree/main/jenkins

Installation

The Sysdig Secure plugin is published as a Jenkins plugin and is available for installation on any Jenkins server using the Plugin Manager in the web UI through the Manage Jenkins > Manage Plugins view, available to administrators of a Jenkins environment.

See https://www.jenkins.io/doc/book/managing/plugins/

Global configuration

To configure the Sysdig Secure plugin:

1. Complete these steps after installing the hpi file from the installation link above.

2. From the main Jenkins menu, select Manage Jenkins.

3. Click the Configure System link.

   

4. Scroll down to the Sysdig Secure Plugin section.

5. In the Sysdig Secure API Credentials drop-down, click Add button to create a new credential containing the Sysdig Secure API Token that you can find in Sysdig Secure -> Settings -> User Profile. You only need to fill the password field and keep the user blank. Oncre created, select the new credential in the Sysdig Secure API Credentials drop-down.

6. Enter the Sysdig Secure API endpoint in the Sysdig Secure Engine URL field. For On-Prem installations, this is the URL where your Secure API is exposed. For SaaS service:

   • Default region US East (North Virginia): https://secure.sysdig.com
   • US West (Oregon): https://us2.app.sysdig.com
   • European Union: https://eu1.app.sysdig.com
   • Check SaaS Regions and IP Ranges for a complete list of regions

7. If you are connecting to an On-Prem instance using an invalid TLS certificate, then you need to either configure Jenkins to trust the certificate, or uncheck the Verify SSL checkbox.

8. Click Save.

Usage

Images file

The Sysdig Secure plugin reads a file called sysdig_secure_images (by default) for the list of images to scan.

This simple file follows the following format:

<imagename1> <Dockerfile path1>
<imagename2> <Dockerfile path2>
...

Dockerfile path is optional, can be included if we want to forward this information to the evaluation process.

Example:

myimage:3.11 ./build/Dockerfile
alpine:latest

Example 1: Integrate the Sysdig Secure Plugin with a Freestyle Project

1. Using the Jenkins Docker plugin for this example, you could start by building the image and writing the image name to the sysdig_secure_images file

   

2. Open the Add build step drop-down menu, and select Sysdig Secure Container Image Scanner. This creates a new build step labeled Sysdig Secure Build Options.

3. Configure the available options, and click Save.

💬 Take into account that this example is using the Inline scanning mode, in case you want to use Backend scanning, you would need to push the image to a registry that is pulleable by the Sysdig Backend.

Example 2: Executing the Sysdig plugin inside a pipeline

The following is a simplified example executing the Sysdig plugin as a stage inside a pipeline

stages {
    stage('Checkout') {
        steps {
            checkout scm
        }
    }
    stage('Build Image') {
        steps {
            sh "docker build -f Dockerfile -t ${params.DOCKER_REPOSITORY} ."
            sh "echo ${params.DOCKER_REPOSITORY} > sysdig_secure_images"
        }
    }
    stage('Scanning Image') {
        steps {
            sysdig engineCredentialsId: 'sysdig-secure-api-credentials', name: 'sysdig_secure_images', inlineScanning: true
        }
    }
}

The table below describes each of the configuration options.

Execution options

Option	Parameter	Description	Default
Image list file	name	The name of the file, present in the workspace that contains the image(s) name, and optionally the Dockerfile location.	sysdig_secure_images
Fail build on policy check STOP result	bailOnFail	If the Sysdig Secure policy evaluate returns a fail (STOP), then the Jenkins job should be failed. If this is not selected then a failed policy evaluation will allow the build to continue.	true
Fail build on critical plugin error	bailOnPluginFail	If selected, and the Sysdig Secure Plugin experiences a critical error, the build will be failed. This is typically used to ensure that a fault with Sysdig Secure (eg. service not available) does not permit a failing image to be promoted to production.	true
Inline Scanning	inlineScanning	Executes the scanning in the same host where the image has been built without needing to push it to a staging registry. It requires a runner with access to the Docker socket at /var/run/docker.sock and read-write privileges in it.	false
Force re-scanning	forceScan	When using backend scan, force re-scanning of the image even if the image tag is known in the backend.	false

The following is an example of executing the Sysdig Secure plugin as a Jenkinsfile step, modifying the default parameters

sysdig bailOnFail: false, bailOnPluginFail: false, engineCredentialsId: 'sysdig-secure-api-credentials', engineurl: 'https://secure.sysdig.com', inlineScanning: true, forceScan: false, name: 'sysdig_secure_images'

Other settings

Proxy configuration

Backend scan

Backend scan connects to Sysdig Secure backend from the Jenkins master node, so it uses the Jenkins proxy configuration.

Inline scan

Inline scan is executed in the worker node, so proxy is configured with the standard environment variables http_proxy , https_proxy and no_proxy.

Environment variables must be defined in the worker node. See Configuring environment variables in workers section.

Docker connection configuration

Connection to the Docker daemon uses the FIFO socket at /var/run/docker.sock by default, but you can use the following standard Docker environment variables to override the default connection:

• DOCKER_HOST: Daemon socket to connect to (i.e. unix:///var/run/docker.sock or tcp://192.168.59.106)
• DOCKER_TLS_VERIFY: When set Docker uses TLS and verifies the remote
• DOCKER_CERT_PATH: The location of your authentication keys

Additional environment variables can be set to apply a more customized behaviour:

• DOCKER_CONNECTION_TIMEOUT: The time (in seconds) the docker client will wait for connection to be established before a timeout. (Default: 3 minutes)
• DOCKER_RESPONSE_TIMEOUT: The time (in seconds) the docker client will wait for a response before a timeout. (Default: 10 minutes)
• DOCKER_CMD_EXEC_PING_DELAY: The delay (in seconds) between ping requests made by the docker client during the scan-command execution. (Default: no ping)

See Docker environment variables documentation for more information.

Environment variables must be defined in the worker node. See Configuring environment variables in workers section.

When using a FIFO socket, the user that is executing the Jenkins agent and the plugin must have read and write permissions on the socket.

The inline-scan container will run with UID 1000 by default, but you can change it with the option Run inline-scan container as this UID in order to match the UID executing and get read and write permissions in the Docker socket.

Inline-scan container image override (air-gapped environments)

By default, the plugin uses the image quay.io/sysdig/secure-inline-scan:2 to execute in the inline scan. This tag points to the latest 2.x available version.

The default container image can be overridden in the plugin global configuration, or by setting the environment variable SYSDIG_OVERRIDE_INLINE_SCAN_IMAGE.

This can be useful in situations where you want to use a version different to the latest 2.x, or for air-gapped environments, where the inline-scan is pulled from a private registry.

Environment variables must be defined in the worker node. See Configuring environment variables in workers section.

Run inline-scan container as this UID

Specify an UID to run the inline-scan container with that specific UID. It might be necessary to match the owner of the Docker socket and provide read and write permissions to the inline-scan container.

Extra parameters for inline-scan container execution

Provide additional extra parameters when executing the inline-scan container.

Configuring environment variables in workers

Static agent configuration

For static agents, go to Manage Jenkins -> Manage Nodes and select the corresponding agent, then click Configure.

Check Environment variables under Node Properties and define the variables in there as required, for example http_proxy, https_proxy and no_proxy, or DOCKER_HOST.

Kubernetes cloud configuration (pod templates)

For agents using pods and containers provided by the Kubernetes cloud plugin, the environment variables are defined in the pod template.

Go to the Kubernetes plugin configuration (Manage Jenkins -> Manage Nodes and Clouds -> Configure Clouds).

There, check the Pod Template details to display the available pod templates:

Edit the desired pod template, and add the environment variables to the container where the Inline scan will run:

For pod templates defined in the pipeline, you can add the environment variables directly in the YAML:

pipeline {
    agent {
    kubernetes {
    yaml """
apiVersion: v
kind: Pod
metadata:
    name: custom-pod
spec:
    containers:
        - name: my-worker
          image: custom-jenkins-builder:latest
          securityContext:
              privileged: true
            ...
          env:
              # Set the environment variables for the container
              - name: http_proxy
                value: http://my-proxy:8080
              - name: DOCKER_HOST
                value: tcp://didn-jenkins:2376
              - name: DOCKER_TLS_VERIFY
                value: true
              - name: DOCKER_CERT_PATH
                value: /mounted_certs
...
    """
}
}

Plugin outputs

Once the scanning and evaluation is complete, you will have the following build artifacts and reports in the workspace

sysdig_secure_gates.json Scanning results for the Sysdig policy evaluation.

sysdig_secure_security.json Detected vulnerability data

Additionally, the plugin offers you an HTML formatted table output that you can directly display from the interface (Sysdig Secure Report (FAIL) in the image above)

Local development and installation

Use docker to build the sysdig-secure.hpi file:

docker run -it --rm --name maven-jenkins-builder -v "$(pwd)":/usr/src/app -w /usr/src/app maven:3.3-jdk-8 mvn package

You can then install the plugin via the Jenkins UI, or by copying it into $JENKINS_HOME/plugins.