Overview

This page describes the Unified Agent configuration parameters used when running a scan via either the Azure DevOps Services integration or Repo integrations.

NOTE: When using a self config file in the Repo integration or when overriding WhiteSource configuration in the Azure DevOps Services integration, the scanner defaults are not valid anymore and UA defaults are the ones that are valid.

Configuration File Parameters

Package Manager Dependency Resolvers

Except for the below parameters, configuration parameters and their default value used in this integration can be found here.

Java

Maven

• maven.runPreStep=true

• maven.ignoreSourceFiles=true

• maven.ignoreMvnTreeErrors=true

Gradle

• gradle.ignoreSourceFiles=true

• gradle.runPreStep=true

JavaScript

NPM + Yarn

• npm.includeDevDependencies=true

• npm.runPreStep=true

• npm.ignoreNpmLsErrors=true

• npm.yarnProject=false

Bower

• bower.runPreStep=true

• bower.ignoreSourceFiles=true

C#

NuGet

• nuget.runPreStep=true

Paket

• paket.runPreStep=true

• paket.ignoreSourceFiles=true

Python 

• python.ignorePipInstallErrors=true

• python.installVirtualenv=true

• python.resolveSetupPyFiles=true

• python.runPipenvPreStep=true

• python.pipenvDevDependencies=true

• python.IgnorePipenvInstallErrors=true

• python.runPoetryPreStep=true

Go

• go.collectDependenciesAtRuntime=true

• go.ignoreSourceFiles=true

Scala

• sbt.runPreStep=true

R

• r.runPreStep=true

• r.cranMirrorUrl=https=//cloud.r-project.org/

PHP

• php.runPreStep=true

• php.includeDevDependencies=true

Ruby

• ruby.installMissingGems=true

• ruby.runBundleInstall=true

Objective C, Swift

CocoaPods

• cocoapods.runPreStep=true

Elixir, Erlang

Hex

• hex.runPreStep=true

Haskell

• haskell.runPreStep=true

• haskell.ignorePreStepErrors=true

Includes/Excludes Glob Patterns

Except for the below parameters, configuration parameters and their default value used in this integration can be found here.

• includes=**/*c **/*cc **/*cp **/*cpp **/*cxx **/*c++ **/*h **/*hh **/*hpp **/*hxx **/*h++ **/*m **/*mm **/*pch **/*c# **/*cs **/*csharp **/*go **/*goc **/*js **/*pl **/*plx **/*pm **/*ph **/*cgi **/*fcgi **/*pod **/*psgi **/*al **/*perl **/*t **/*pl6 **/*p6m **/*p6l **/*pm6 **/*nqp **/*6pl **/*6pm **/*p6 **/*php **/*py **/*rb **/*swift **/*java **/*clj **/*cljx **/*cljs **/*cljc **/*jar **/*egg **/*dll **/*tar.gz **/*tgz **/*zip **/*whl **/*gem **/*apk **/*air **/*dmg **/*exe **/*gem **/*gzip **/*msi **/*nupkg **/*swc **/*swf **/tar.bz2 **/pkg.tar.xz **/(u)?deb **/(a)?rpm

• excludes=**/*sources.jar **/*javadoc.jar /tests/

Archive Properties

Except for the below parameters, configuration parameters and their default value used in this integration can be found here.

• archiveExtractionDepth=2

• archiveIncludes=**/*war **/*ear **/*zip **/*whl **/*tar.gz **/*tgz **/*tar **/*car

• archiveExcludes=**/*sources.jar **/*javadoc.jar /tests/

Ignored Configuration File Parameters

This section contains a list of all Unified Agent configuration sections (including their parameters) which are ignored when running a scan via the Azure DevOps Services integration or Repo integrations.

• Organization Vitals

• Policies 

• General

• Scan Modes

• SCM Settings