Configure Veracode scans on your pipeline
Summarize
Summary of Configure Veracode scans on your pipeline
This guide explains how ServiceNow customers can integrate Veracode security scans into their CI/CD pipelines across various orchestration tools including Azure DevOps, Jenkins, GitHub Actions, GitLab, and Harness. Incorporating Veracode scans enables automated retrieval of scan details into ServiceNow DevOps Change Velocity, enhancing security visibility and compliance during development.
Show less
Key Configuration Details
- Azure DevOps: Add the ServiceNow DevOps Security Results extension task in the pipeline’s YAML file. Provide the ServiceNow endpoint and specify security attributes such as
scanner,applicationName,buildVersion, and optionallysecurityToolId. This custom action must always be added. - Jenkins: Use the Pipeline Syntax generator to insert the
snDevOpsSecurityResultstep with the necessary Veracode attributes. Ensure any existing Veracode scan step includeswaitForScan: truefor proper scan result retrieval. - GitHub Actions: Insert the ServiceNow DevOps Security Results custom action in the workflow YAML. Provide credentials via GitHub secrets and specify Veracode attributes in the
security-result-attributesJSON block. - GitLab: Configure Veracode scans either by adding a generic Docker container image step or by following the prescribed integration steps for GitLab pipelines.
- Harness: Use the generic Docker container image method to run the Veracode scan integration script. Define the custom action stage and set environment variables for ServiceNow connectivity. This method is currently the only supported approach for Harness pipelines.
Practical Considerations
- The
scannerattribute must always be set to "Veracode". applicationNameis required and should match the Veracode application name.buildVersionis optional and can be used to specify the Veracode scan or build version.securityToolIdis optional and should reference the sysid of the onboarded Veracode tool in ServiceNow.- Adding these configurations ensures that Veracode scan results are automatically fetched and integrated into ServiceNow, supporting faster security feedback loops and governance.
Next Steps
After configuring the pipeline with the appropriate custom action or step, run the pipeline to trigger the Veracode scan and automatically retrieve the scan results into ServiceNow DevOps Change Velocity for review and action.
Configure Veracode scans on your Azure DevOps, Jenkins, GitHub, GitLab, or Harness pipelines.
You can configure Veracode scans on any stage of the pipeline and the scan details are retrieved from the corresponding stage to DevOps Change Velocity. If you are using Azure DevOps or GitHub Actions orchestration tools then you need to add the custom action code in your pipeline always. If you are using Jenkins, and your pipeline already has a Veracode security scan step, you do not have to add the custom action code in your pipeline. Ensure that your Veracode security scan step has waitForScan: true. This is required for the system to retrieve the scan information.
If you want to configure Veracode for the GitLab tool, you can either use the generic Docker container image to add the Veracode security step or perform the steps specified in the Integrate security tools with GitLab topic.
For Harness pipelines, you can configure Veracode scans only through the generic Docker Container Image. For more information, see Implement custom actions for pipelines using a generic Docker container image.
- Navigate to the step in your pipeline and add the custom action.
Azure DevOps - Navigate to your pipeline .yml file.
- In the Tasks section on the right side, search for the ServiceNow DevOps Security Results extension task.
- Enter the ServiceNow endpoint.
- Enter the Security results attributes as the following.
{ "scanner": "Veracode", "applicationName": "", "buildVersion": "", "securityToolId": "" }// scanner: Scanning tool and is required e.g. Veracode.
// applicationName: Name of your Veracode application and is required. This attribute is applicable only for Veracode.
// buildVersion: Veracode Scan name / build version and is optional. This attribute is applicable only for Veracode.
// securityToolId: Security tool onboarded in ServiceNow (sys_id of the onboarded security tool) and is optional.
- Select Add to add the custom action code to your pipeline.
Jenkins - Navigate to the Pipeline Syntax from a configured pipeline.
- Select the snDevOpsSecurityResult step from the Sample Step list, and update the values for the security scan attributes in the step.
- Select Generate Pipeline Script to create a snippet. You can copy and paste the snippet into the pipeline.
snDevOpsSecurityResult { securityResultAttributes:{"scanner":"Veracode", "applicationName": "", "buildVersion": "", "securityToolId": ""}}// scanner: Scanning tool and is required e.g. Veracode.
// applicationName: Name of your Veracode application and is required. This attribute is applicable only for Veracode.
// buildVersion: Veracode Scan name / build version and is optional. This attribute is applicable only for Veracode.
// securityToolId: Security tool onboarded in ServiceNow (sys_id of the onboarded security tool) and is optional.
GitHub Actions - Navigate to your workflow .yml file.
- In the Marketplace section on the right side, search for the ServiceNow DevOps Security Results custom action.
- Add the following snippet into your .yml file.
SecurityScanResults: needs: build runs-on: ubuntu-latest name: Servicenow Security Scan Results steps: - name: ServiceNow DevOps Security Results uses: ServiceNow/servicenow-devops-security-result@v1.39.0 with: devops-integration-user-name: ${{ secrets.SN_DEVOPS_USER }} devops-integration-user-password: ${{ secrets.SN_DEVOPS_PASSWORD }} instance-url: ${{ secrets.SN_INSTANCE_URL }} tool-id: ${{ secrets.SN_ORCHESTRATION_TOOL_ID }} context-github: ${{ toJSON(github) }} job-name: 'Servicenow Security Scan Results' security-result-attributes: '{ "scanner": "Veracode", "applicationName": "", "buildVersion": "", "securityToolId": ""}// scanner: Scanning tool and is required e.g. Veracode.
// applicationName: Name of your Veracode application and is required. This attribute is applicable only for Veracode.
// buildVersion: Veracode Scan name / build version and is optional. This attribute is applicable only for Veracode.
// securityToolId: Security tool onboarded in ServiceNow (sys_id of the onboarded security tool) and is optional.
Harness Run the generic Docker Container Image to use the following script. For more information, see Implement custom actions for pipelines using a generic Docker container image. - stage: name: ServiceNow DevOps Security Result identifier: Security description: "" type: Custom spec: execution: steps: - stepGroup: name: Security identifier: Security steps: - step: type: Run name: ServiceNow DevOps Security Result identifier: ServiceNow_DevOps_Security_Result spec: connectorRef: docker_hub_connector_for_harness image: servicenowdocker/sndevops:5.0.0 shell: Sh command: |- sndevopscli create securityScan -p "{"pipelineInfo":{ "buildNumber":"<+stage.nodeExecutionId>", "taskExecutionUrl":"<+pipeline.executionUrl>?stage=<+stage.nodeExecutionId>", "orchestrationPipeline":"<+org.identifier>/<+project.identifier>/<+pipeline.name>" }, "securityResultAttributes":{ "scanner":"Veracode", "applicationName":"", "buildVersion":"", "securityToolId":"" } }" envVariables: SNOW_URL: <+variable.SNOW_URL> SNOW_TOOLID: <+variable.SNOW_TOOLID> SNOW_TOKEN: <+variable.SNOW_TOKEN> stepGroupInfra: type: KubernetesDirect spec: connectorRef: kubernates_connector namespace: harness-delegate-ng tags: {} - Run the pipeline to retrieve the security scan results.