You can add the Veracode Flaw Importer task to your Azure DevOps and Team Foundation Server (TFS) build pipelines. The task uses the Veracode Azure DevOps Extension to automate the import of flaws from Veracode Static Analysis in your Software Development Life Cycle.
- Ensure these projects are in the same Azure DevOps organization or TFS team
- The project to which the running release or build job belongs, where the Flaw Importer task is running
- The project to which you want to import the flaws
- You have installed the Veracode Azure DevOps Extension.
- You have generated Veracode API credentials. If your credentials contain variables, you must start each variable with a $ and wrap the variable value in parentheses. For example, you enter the id variable as $(Id).
The Veracode Flaw Importer task supports generating work items based on the Agile, Scrum, and CMMI process templates in Azure DevOps. You can customize the default fields in the process templates, such as changing the state names to match the names of your actual states and their transitions.
You can Use YAML to Configure Azure DevOps Pipelines for Importing Flaws. The task uses the Veracode Azure DevOps Extension to automate the import of flaws from Veracode Static Analysis in your Software Development Life Cycle.
The Flaw Importer task does not support new, required custom fields. If you add new, required custom fields to a process template, the import task fails.
- In your Azure DevOps or TFS project, go to your build definition.
- Add Veracode Flaw Importer as a build task.
- Click the Import flaws task to open the Veracode Flaw Importer window.
In the Flaw Importer window, from the Connection Details section, select a
connection source for connecting to Veracode:
- Service Connection
- Select an existing service connection that uses your Veracode API credentials or click New to create a new service connection. For a new connection, in the New service connection window, by default, the Server URL is populated with the URL for accessing Veracode. Enter your Veracode API credentials, a name for the service connection and, then, click Save. The new connection is selected in the Select Service Connection dropdown menu.
- Enter your Veracode API credentials. If you use variables for your credentials, you must start each variable with a $ and wrap the variable value in parentheses. For example, for a variable named id, enter $(Id).
- In the Flaw Source section, enter the application name and sandbox name, if applicable, for which you want to import flaws from Veracode.
In the Work Item Settings section, configure these options:
- Import: select the type of flaws you want to import:
- All Flaws
- Includes mitigated and remediated flaws, from all scans. During the import process, the extension changes the state of the work items for all mitigated and remediated flaws to resolved or closed. This option imports all flaws without any restrictions.
- All Unmitigated Flaws
- Includes flaws from all scans.
- All Flaws Violating Policy
- Includes all open flaws from all scans that affect policy.
- All Unmitigated Flaws Violating Policy
- Includes open flaws from all scans that affect policy. Selected
by default. Note: The Flaw Importer task does not import vulnerabilities from Veracode Software Composition Analysis (SCA) scans as work items.
When generating new work items for imported flaws, the extension also imports mitigation and annotation comments. If you add comments to a previously imported flaw with work items, the extension does not import the new comments to work items during subsequent flaw imports.
- Work Item Type: select a work item type to apply to all imported
flaws:Note: The Scrum process template does not support the Issue work item type. Also, the Veracode Flaw Importer task can only import flaws to customized work item types that do not contain required fields. If your customized work item types contain required fields, you must select different work item types that do not contain required fields, or the flaws fail to import.
- Area: enter the path to the area where you want to group the work items. You can enter up to five levels in the path. To enter the area paths, use the format <project name>\<area 1>\<area 2>. The value in <project name> is the name of the project in the Build Pipeline or Release Pipeline task for which you want to import flaws.
- Import: select the type of flaws you want to import:
- Use the Add CWE as a Tag checkbox to add a tag with the CWE number to all the work items generated from the current build.
- In the Add Custom Tag section, enter a custom tag name to add user-defined tags to all work items generated from current build.
- Use the Add Found in Build checkbox to add a tag to the work item showing the build number of the build that contains the flaw.
- In the Flaw Import Limit section, enter the maximum number of flaws to import at one time. The default is 1000.
In the Advanced Scan Settings section configure these options:
- Proxy Settings
- If you use a proxy to access Veracode, enter the proxy settings. For
-phost abc.com - pport 5252 -puser proxyuser -ppassword proxypasswordNote: Do not enclose any of the values in single or double quotations.
- Team Foundation Server Password
- Do not change this value from the default of $(password).
Optionally, to add debugging to your pipeline, add a new variable
and enter these values in the New variable window:
- Name: system.debug
- Value: true
- Click Save & queue to save your configurations and add the build to your queue.