Configure Veracode scans on your pipeline
Summarize
Summary of Configure Veracode scans on your pipeline
This guide provides instructions for configuring Veracode scans across various CI/CD pipelines including Azure DevOps, Jenkins, GitHub, GitLab, and Harness. Proper configuration of these scans is essential for integrating security checks into your development workflow.
Show less
Key Features
- Pipeline Integration: Configure Veracode scans at any stage of your pipeline.
- Custom Actions: Required for Azure DevOps and GitHub Actions; Jenkins users with existing Veracode steps do not need additional code.
- Docker Container Usage: GitLab and Harness users can utilize a generic Docker container image to add Veracode security steps.
Key Outcomes
By following these configurations, you will:
- Automatically retrieve and manage scan details within your DevOps environment.
- Ensure effective integration of security scans into your CI/CD processes, which enhances your code security practices.
- Facilitate compliance and security reporting through ServiceNow by properly attributing scan results.
For each platform, ensure to fill in mandatory attributes such as scanner and applicationName while optional attributes can include buildVersion and securityToolId for enhanced reporting and integration.
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.