Contrast Integration

Azure Pipeline Plugin integrates the threshold calculation of vulnerabilities associated with Projects and Applications. This feature will enable the user to perform the build/release pipeline execution.

Features

• Assess
• Assess-Library
• Both

Create a new service connection to connect to Contrast

The Contrast Server Connection service connection allows Azure DevOps to integrate with Contrast Security’s TeamServer. Here, you can specify your Contrast URL and credentials so that our tasks can retrieve security insights and vulnerability data from Contrast.

These credentials (Organization UUID, Service Key, API Key, and Username) are available in the Contrast Security website under User Settings.

Additionally, there is an optional Logging toggle. If enabled, logs will be stored in the pipeline artifact, providing visibility into the task execution and Contrast API interactions.

Pipeline Task

Step one - Enter Edit mode

The task can be used in a Build or Release pipeline

Release Pipeline

• Enter Edit mode for the release pipeline you wish to add the task.
• Select a stage for which you wish to add the task

Build Pipeline

• Enter Edit mode for the build pipeline you wish to add the task.

Step two - add the task

• Now that you are in edit mode for a Release Pipeline or Build Pipeline, click on the ellipsis (...) menu and add an agent job.

• Click on the + button next to you agentless job and add the Contrast Assess Security task.

Step three - choose connection and application

• Select a Service Connection from the Contrast Service Connection field. You can also click on the Manage option to go to the Service connections settings in your Project Settings.
• Select one of your applications from the Application dropdown. This enables more fields for configuring the task.

Step four - configure the task

• You can use the Allowed Status and Build Number fields to filter your results from Contrast, leave them blank if you don't want to filter. The values set in these fields will be validated against the conditions you configure in the following fields.

• If the threshold definition is set to split, you must specify the maximum allowed vulnerabilities for each severity level. The evaluation will be conducted by independently comparing each severity value against its defined threshold. (OR)

• If the threshold definition is set to combined, you must specify the total allowed threshold for the sum of all severity levels. The evaluation will be performed by comparing the combined severity count against the defined total threshold.

• The Threshold Criteria allows you to select or deselect severity levels to include or exclude from the evaluation.

Release Gate

Adding a new gate

1. Enter Edit mode for the release pipeline you wish to add the gate to.

2. Choose the stage and deployment conditions to which you'll be adding the gate, either pre or post conditions. You may later add more gates of the same type to the same stage or deployment conditions.

3. Go to the Gates section and enable them if you haven't already.

4. Click on + Add text and select Verify application vulnerabilities. Now you are ready to configure the gate.

Gate Configuration

1. You should have created a Contrast service connection first, if you don't have yet you can click on the New button next to the Service Connection dropdown. Fill all the fields with the correct data and click on Ok. Click on the refresh list next to the dropdown button and select your newly created connection.

2. Proceed to load the applications list either by clicking over the field or the refresh button next to it and select the application to which this artifact belongs.

3. You may choose to be more specific with the severity counters by selecting which vulnerability status or build numbers will be used for filtering when retrieving the data for the gate evaluation.

4. Now set the maximum amount of vulnerabilities per severity or total threshold based on the threshold definition split or combined. Do mind that whenever your pipeline reaches this gate if one or all the validations fail your pipeline will keep requesting for samples until it is valid or the evaluation timeout is reached.

Logging

1. To enable logging of pipeline task details in the pipeline artifact, navigate to the service connection and select the logging checkbox.

2. Once the pipeline is executed the task result will be captured and stored in a log file, the log file will be stored as a pipeline artifact.

3. These artifacts are stored separately from the console logs.

Location in Azure DevOps (Build Pipeline):

1. Go to Azure DevOps → Pipelines → Runs.

2. Click on a pipeline run.

3. Go to the "Artifacts" section (top-right).

4. Click on the "Logs" artifact

5. Download the log file (e.g.,..log).

Location in Azure DevOps (Release Pipeline):

1. Go to Azure DevOps Portal.

2. Navigate to your project.

3. Click on Pipelines > Releases.

4. Open the specific release for which you need the logs.

5. Hover on the stage, select Logs.

6. Click on the Download all logs button.

You may look for more info on Microsoft Docs Site on articles related to gates like Define a gate for a stage or Configure a gate.