org.owasp.dependencycheck.taskdefs

Class Check

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.owasp.dependencycheck.taskdefs.Purge

org.owasp.dependencycheck.taskdefs.Update

org.owasp.dependencycheck.taskdefs.Check

All Implemented Interfaces:

Cloneable

public class Check
extends Update

An Ant task definition to execute dependency-check during an Ant build.

Author:

Jeremy Long

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Check.ReportFormats An enumeration of supported report formats: "ALL", "HTML", "XML", "VULN", etc..

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
Check() Construct a new DependencyCheckTask.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(org.apache.tools.ant.types.ResourceCollection rc) Add an arbitrary ResourceCollection.
void	execute() Executes the update by initializing the settings, downloads the NVD XML data, and then processes the data storing it in the local database.
String	getApplicationName() Deprecated. use projectName instead.
float	getFailBuildOnCVSS() Get the value of failBuildOnCVSS.
String	getNexusUrl() Get the value of nexusUrl.
String	getPathToMono() Get the value of pathToMono.
String	getProjectName() Get the value of projectName.
String	getReportFormat() Get the value of reportFormat.
String	getReportOutputDirectory() Get the value of reportOutputDirectory.
String	getSuppressionFile() Get the value of suppressionFile.
String	getZipExtensions() Get the value of zipExtensions.
Boolean	isArchiveAnalyzerEnabled() Returns whether or not the analyzer is enabled.
Boolean	isAssemblyAnalyzerEnabled() Returns whether or not the analyzer is enabled.
Boolean	isAutoconfAnalyzerEnabled() Get the value of autoconfAnalyzerEnabled.
Boolean	isAutoUpdate() Get the value of autoUpdate.
Boolean	isCentralAnalyzerEnabled() Get the value of centralAnalyzerEnabled.
Boolean	isCMakeAnalyzerEnabled() Get the value of cmakeAnalyzerEnabled.
Boolean	isComposerAnalyzerEnabled() Get the value of composerAnalyzerEnabled.
Boolean	isJarAnalyzerEnabled() Returns whether or not the analyzer is enabled.
Boolean	isNexusAnalyzerEnabled() Get the value of nexusAnalyzerEnabled.
Boolean	isNexusUsesProxy() Get the value of nexusUsesProxy.
Boolean	isNodeAnalyzerEnabled() Get the value of nodeAnalyzerEnabled.
Boolean	isNuspecAnalyzerEnabled() Returns whether or not the analyzer is enabled.
Boolean	isOpensslAnalyzerEnabled() Get the value of opensslAnalyzerEnabled.
Boolean	isPyDistributionAnalyzerEnabled() Get the value of pyDistributionAnalyzerEnabled.
Boolean	isPyPackageAnalyzerEnabled() Get the value of pyPackageAnalyzerEnabled.
boolean	isReference() Learn whether the refid attribute of this element been set.
Boolean	isRubygemsAnalyzerEnabled() Get the value of rubygemsAnalyzerEnabled.
boolean	isShowSummary() Get the value of showSummary.
boolean	isUpdateOnly() Deprecated. Use the update task instead
protected void	populateSettings() Takes the properties supplied and updates the dependency-check settings.
void	setApplicationName(String applicationName) Deprecated. use projectName instead.
void	setArchiveAnalyzerEnabled(Boolean archiveAnalyzerEnabled) Sets whether or not the analyzer is enabled.
void	setAssemblyAnalyzerEnabled(Boolean assemblyAnalyzerEnabled) Sets whether or not the analyzer is enabled.
void	setAutoconfAnalyzerEnabled(Boolean autoconfAnalyzerEnabled) Set the value of autoconfAnalyzerEnabled.
void	setAutoUpdate(Boolean autoUpdate) Set the value of autoUpdate.
void	setCentralAnalyzerEnabled(Boolean centralAnalyzerEnabled) Set the value of centralAnalyzerEnabled.
void	setCMakeAnalyzerEnabled(Boolean cmakeAnalyzerEnabled) Set the value of cmakeAnalyzerEnabled.
void	setComposerAnalyzerEnabled(Boolean composerAnalyzerEnabled) Set the value of composerAnalyzerEnabled.
void	setFailBuildOnCVSS(float failBuildOnCVSS) Set the value of failBuildOnCVSS.
void	setJarAnalyzerEnabled(Boolean jarAnalyzerEnabled) Sets whether or not the analyzer is enabled.
void	setNexusAnalyzerEnabled(Boolean nexusAnalyzerEnabled) Set the value of nexusAnalyzerEnabled.
void	setNexusUrl(String nexusUrl) Set the value of nexusUrl.
void	setNexusUsesProxy(Boolean nexusUsesProxy) Set the value of nexusUsesProxy.
void	setNodeAnalyzerEnabled(Boolean nodeAnalyzerEnabled) Set the value of nodeAnalyzerEnabled.
void	setNuspecAnalyzerEnabled(Boolean nuspecAnalyzerEnabled) Sets whether or not the analyzer is enabled.
void	setOpensslAnalyzerEnabled(Boolean opensslAnalyzerEnabled) Set the value of opensslAnalyzerEnabled.
void	setPathToMono(String pathToMono) Set the value of pathToMono.
void	setProjectName(String projectName) Set the value of projectName.
void	setPyDistributionAnalyzerEnabled(Boolean pyDistributionAnalyzerEnabled) Set the value of pyDistributionAnalyzerEnabled.
void	setPyPackageAnalyzerEnabled(Boolean pyPackageAnalyzerEnabled) Set the value of pyPackageAnalyzerEnabled.
void	setRefid(org.apache.tools.ant.types.Reference r) Add a reference to a Path, FileSet, DirSet, or FileList defined elsewhere.
void	setReportFormat(Check.ReportFormats reportFormat) Set the value of reportFormat.
void	setReportOutputDirectory(String reportOutputDirectory) Set the value of reportOutputDirectory.
void	setRubygemsAnalyzerEnabled(Boolean rubygemsAnalyzerEnabled) Set the value of rubygemsAnalyzerEnabled.
void	setShowSummary(boolean showSummary) Set the value of showSummary.
void	setSuppressionFile(String suppressionFile) Set the value of suppressionFile.
void	setUpdateOnly(boolean updateOnly) Deprecated. Use the update task instead
void	setZipExtensions(String zipExtensions) Set the value of zipExtensions.

Methods inherited from class org.owasp.dependencycheck.taskdefs.Update

getConnectionString, getConnectionTimeout, getCveUrl12Base, getCveUrl12Modified, getCveUrl20Base, getCveUrl20Modified, getCveValidForHours, getDatabaseDriverName, getDatabaseDriverPath, getDatabasePassword, getDatabaseUser, getProxyPassword, getProxyPort, getProxyServer, getProxyUsername, setConnectionString, setConnectionTimeout, setCveUrl12Base, setCveUrl12Modified, setCveUrl20Base, setCveUrl20Modified, setCveValidForHours, setDatabaseDriverName, setDatabaseDriverPath, setDatabasePassword, setDatabaseUser, setProxyPassword, setProxyPort, setProxyServer, setProxyUsername

Methods inherited from class org.owasp.dependencycheck.taskdefs.Purge

getDataDirectory, setDataDirectory

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Check

public Check()

Construct a new DependencyCheckTask.

Method Detail

add

public void add(org.apache.tools.ant.types.ResourceCollection rc)

Add an arbitrary ResourceCollection.

Parameters:

rc - the ResourceCollection to add.

Since:

Ant 1.7

isReference

public boolean isReference()

Learn whether the refid attribute of this element been set.

Returns:

true if refid is valid.

setRefid

public void setRefid(org.apache.tools.ant.types.Reference r)

Add a reference to a Path, FileSet, DirSet, or FileList defined elsewhere.

Parameters:

r - the reference to a path, fileset, dirset or filelist.

getApplicationName

@Deprecated
public String getApplicationName()

Deprecated. use projectName instead.

Get the value of applicationName.

Returns:

the value of applicationName

setApplicationName

@Deprecated
public void setApplicationName(String applicationName)

Deprecated. use projectName instead.

Set the value of applicationName.

Parameters:

applicationName - new value of applicationName

getProjectName

public String getProjectName()

Get the value of projectName.

Returns:

the value of projectName

setProjectName

public void setProjectName(String projectName)

Set the value of projectName.

Parameters:

projectName - new value of projectName

getReportOutputDirectory

public String getReportOutputDirectory()

Get the value of reportOutputDirectory.

Returns:

the value of reportOutputDirectory

setReportOutputDirectory

public void setReportOutputDirectory(String reportOutputDirectory)

Set the value of reportOutputDirectory.

Parameters:

reportOutputDirectory - new value of reportOutputDirectory

getFailBuildOnCVSS

public float getFailBuildOnCVSS()

Get the value of failBuildOnCVSS.

Returns:

the value of failBuildOnCVSS

setFailBuildOnCVSS

public void setFailBuildOnCVSS(float failBuildOnCVSS)

Set the value of failBuildOnCVSS.

Parameters:

failBuildOnCVSS - new value of failBuildOnCVSS

isAutoUpdate

public Boolean isAutoUpdate()

Get the value of autoUpdate.

Returns:

the value of autoUpdate

setAutoUpdate

public void setAutoUpdate(Boolean autoUpdate)

Set the value of autoUpdate.

Parameters:

autoUpdate - new value of autoUpdate

isUpdateOnly

@Deprecated
public boolean isUpdateOnly()

Deprecated. Use the update task instead

Get the value of updateOnly.

Returns:

the value of updateOnly

setUpdateOnly

@Deprecated
public void setUpdateOnly(boolean updateOnly)

Deprecated. Use the update task instead

Set the value of updateOnly.

Parameters:

updateOnly - new value of updateOnly

getReportFormat

public String getReportFormat()

Get the value of reportFormat.

Returns:

the value of reportFormat

setReportFormat

public void setReportFormat(Check.ReportFormats reportFormat)

Set the value of reportFormat.

Parameters:

reportFormat - new value of reportFormat

getSuppressionFile

public String getSuppressionFile()

Get the value of suppressionFile.

Returns:

the value of suppressionFile

setSuppressionFile

public void setSuppressionFile(String suppressionFile)

Set the value of suppressionFile.

Parameters:

suppressionFile - new value of suppressionFile

isShowSummary

public boolean isShowSummary()

Get the value of showSummary.

Returns:

the value of showSummary

setShowSummary

public void setShowSummary(boolean showSummary)

Set the value of showSummary.

Parameters:

showSummary - new value of showSummary

isJarAnalyzerEnabled

public Boolean isJarAnalyzerEnabled()

Returns whether or not the analyzer is enabled.

Returns:

true if the analyzer is enabled

setJarAnalyzerEnabled

public void setJarAnalyzerEnabled(Boolean jarAnalyzerEnabled)

Sets whether or not the analyzer is enabled.

Parameters:

jarAnalyzerEnabled - the value of the new setting

isArchiveAnalyzerEnabled

public Boolean isArchiveAnalyzerEnabled()

Returns whether or not the analyzer is enabled.

Returns:

true if the analyzer is enabled

setArchiveAnalyzerEnabled

public void setArchiveAnalyzerEnabled(Boolean archiveAnalyzerEnabled)

Sets whether or not the analyzer is enabled.

Parameters:

archiveAnalyzerEnabled - the value of the new setting

isAssemblyAnalyzerEnabled

public Boolean isAssemblyAnalyzerEnabled()

Returns whether or not the analyzer is enabled.

Returns:

true if the analyzer is enabled

setAssemblyAnalyzerEnabled

public void setAssemblyAnalyzerEnabled(Boolean assemblyAnalyzerEnabled)

Sets whether or not the analyzer is enabled.

Parameters:

assemblyAnalyzerEnabled - the value of the new setting

isNuspecAnalyzerEnabled

public Boolean isNuspecAnalyzerEnabled()

Returns whether or not the analyzer is enabled.

Returns:

true if the analyzer is enabled

setNuspecAnalyzerEnabled

public void setNuspecAnalyzerEnabled(Boolean nuspecAnalyzerEnabled)

Sets whether or not the analyzer is enabled.

Parameters:

nuspecAnalyzerEnabled - the value of the new setting

isComposerAnalyzerEnabled

public Boolean isComposerAnalyzerEnabled()

Get the value of composerAnalyzerEnabled.

Returns:

the value of composerAnalyzerEnabled

setComposerAnalyzerEnabled

public void setComposerAnalyzerEnabled(Boolean composerAnalyzerEnabled)

Set the value of composerAnalyzerEnabled.

Parameters:

composerAnalyzerEnabled - new value of composerAnalyzerEnabled

isAutoconfAnalyzerEnabled

public Boolean isAutoconfAnalyzerEnabled()

Get the value of autoconfAnalyzerEnabled.

Returns:

the value of autoconfAnalyzerEnabled

setAutoconfAnalyzerEnabled

public void setAutoconfAnalyzerEnabled(Boolean autoconfAnalyzerEnabled)

Set the value of autoconfAnalyzerEnabled.

Parameters:

autoconfAnalyzerEnabled - new value of autoconfAnalyzerEnabled

isCMakeAnalyzerEnabled

public Boolean isCMakeAnalyzerEnabled()

Get the value of cmakeAnalyzerEnabled.

Returns:

the value of cmakeAnalyzerEnabled

setCMakeAnalyzerEnabled

public void setCMakeAnalyzerEnabled(Boolean cmakeAnalyzerEnabled)

Set the value of cmakeAnalyzerEnabled.

Parameters:

cmakeAnalyzerEnabled - new value of cmakeAnalyzerEnabled

isOpensslAnalyzerEnabled

public Boolean isOpensslAnalyzerEnabled()

Get the value of opensslAnalyzerEnabled.

Returns:

the value of opensslAnalyzerEnabled

setOpensslAnalyzerEnabled

public void setOpensslAnalyzerEnabled(Boolean opensslAnalyzerEnabled)

Set the value of opensslAnalyzerEnabled.

Parameters:

opensslAnalyzerEnabled - new value of opensslAnalyzerEnabled

isNodeAnalyzerEnabled

public Boolean isNodeAnalyzerEnabled()

Get the value of nodeAnalyzerEnabled.

Returns:

the value of nodeAnalyzerEnabled

setNodeAnalyzerEnabled

public void setNodeAnalyzerEnabled(Boolean nodeAnalyzerEnabled)

Set the value of nodeAnalyzerEnabled.

Parameters:

nodeAnalyzerEnabled - new value of nodeAnalyzerEnabled

isRubygemsAnalyzerEnabled

public Boolean isRubygemsAnalyzerEnabled()

Get the value of rubygemsAnalyzerEnabled.

Returns:

the value of rubygemsAnalyzerEnabled

setRubygemsAnalyzerEnabled

public void setRubygemsAnalyzerEnabled(Boolean rubygemsAnalyzerEnabled)

Set the value of rubygemsAnalyzerEnabled.

Parameters:

rubygemsAnalyzerEnabled - new value of rubygemsAnalyzerEnabled

isPyPackageAnalyzerEnabled

public Boolean isPyPackageAnalyzerEnabled()

Get the value of pyPackageAnalyzerEnabled.

Returns:

the value of pyPackageAnalyzerEnabled

setPyPackageAnalyzerEnabled

public void setPyPackageAnalyzerEnabled(Boolean pyPackageAnalyzerEnabled)

Set the value of pyPackageAnalyzerEnabled.

Parameters:

pyPackageAnalyzerEnabled - new value of pyPackageAnalyzerEnabled

isPyDistributionAnalyzerEnabled

public Boolean isPyDistributionAnalyzerEnabled()

Get the value of pyDistributionAnalyzerEnabled.

Returns:

the value of pyDistributionAnalyzerEnabled

setPyDistributionAnalyzerEnabled

public void setPyDistributionAnalyzerEnabled(Boolean pyDistributionAnalyzerEnabled)

Set the value of pyDistributionAnalyzerEnabled.

Parameters:

pyDistributionAnalyzerEnabled - new value of pyDistributionAnalyzerEnabled

isCentralAnalyzerEnabled

public Boolean isCentralAnalyzerEnabled()

Get the value of centralAnalyzerEnabled.

Returns:

the value of centralAnalyzerEnabled

setCentralAnalyzerEnabled

public void setCentralAnalyzerEnabled(Boolean centralAnalyzerEnabled)

Set the value of centralAnalyzerEnabled.

Parameters:

centralAnalyzerEnabled - new value of centralAnalyzerEnabled

isNexusAnalyzerEnabled

public Boolean isNexusAnalyzerEnabled()

Get the value of nexusAnalyzerEnabled.

Returns:

the value of nexusAnalyzerEnabled

setNexusAnalyzerEnabled

public void setNexusAnalyzerEnabled(Boolean nexusAnalyzerEnabled)

Set the value of nexusAnalyzerEnabled.

Parameters:

nexusAnalyzerEnabled - new value of nexusAnalyzerEnabled

getNexusUrl

public String getNexusUrl()

Get the value of nexusUrl.

Returns:

the value of nexusUrl

setNexusUrl

public void setNexusUrl(String nexusUrl)

Set the value of nexusUrl.

Parameters:

nexusUrl - new value of nexusUrl

isNexusUsesProxy

public Boolean isNexusUsesProxy()

Get the value of nexusUsesProxy.

Returns:

the value of nexusUsesProxy

setNexusUsesProxy

public void setNexusUsesProxy(Boolean nexusUsesProxy)

Set the value of nexusUsesProxy.

Parameters:

nexusUsesProxy - new value of nexusUsesProxy

getZipExtensions

public String getZipExtensions()

Get the value of zipExtensions.

Returns:

the value of zipExtensions

setZipExtensions

public void setZipExtensions(String zipExtensions)

Set the value of zipExtensions.

Parameters:

zipExtensions - new value of zipExtensions

getPathToMono

public String getPathToMono()

Get the value of pathToMono.

Returns:

the value of pathToMono

setPathToMono

public void setPathToMono(String pathToMono)

Set the value of pathToMono.

Parameters:

pathToMono - new value of pathToMono

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Description copied from class: Update

Executes the update by initializing the settings, downloads the NVD XML data, and then processes the data storing it in the local database.

Overrides:

execute in class Update

Throws:

org.apache.tools.ant.BuildException - thrown if a connection to the local database cannot be made.

populateSettings

protected void populateSettings()
                         throws org.apache.tools.ant.BuildException

Takes the properties supplied and updates the dependency-check settings. Additionally, this sets the system properties required to change the proxy server, port, and connection timeout.

Overrides:

populateSettings in class Update

Throws:

org.apache.tools.ant.BuildException - thrown when an invalid setting is configured.