Class CliParser.ARGUMENT

java.lang.Object
org.owasp.dependencycheck.CliParser.ARGUMENT
Enclosing class:
CliParser
public static class CliParser.ARGUMENT extends Object
A collection of static final strings that represent the possible command line arguments.
Author:
Jeremy Long

  • Field Details

    • SCAN

      public static final String SCAN
      The long CLI argument name specifying the directory/file to scan.
      See Also:

    • SCAN_SHORT

      public static final String SCAN_SHORT
      The short CLI argument name specifying the directory/file to scan.
      See Also:

    • DISABLE_AUTO_UPDATE

      public static final String DISABLE_AUTO_UPDATE
      The long CLI argument name specifying that the CPE/CVE/etc. data should not be automatically updated.
      See Also:

    • DISABLE_VERSION_CHECK

      public static final String DISABLE_VERSION_CHECK
      The long CLI argument name specifying that the version check should not be performed.
      See Also:

    • DISABLE_AUTO_UPDATE_SHORT

      public static final String DISABLE_AUTO_UPDATE_SHORT
      The short CLI argument name specifying that the CPE/CVE/etc. data should not be automatically updated.
      See Also:

    • UPDATE_ONLY

      public static final String UPDATE_ONLY
      The long CLI argument name specifying that only the update phase should be executed; no scan should be run.
      See Also:

    • PURGE_NVD

      public static final String PURGE_NVD
      The long CLI argument name specifying that only the update phase should be executed; no scan should be run.
      See Also:

    • OUT

      public static final String OUT
      The long CLI argument name specifying the directory to write the reports to.
      See Also:

    • OUT_SHORT

      public static final String OUT_SHORT
      The short CLI argument name specifying the directory to write the reports to.
      See Also:

    • OUTPUT_FORMAT

      public static final String OUTPUT_FORMAT
      The long CLI argument name specifying the output format to write the reports to.
      See Also:

    • OUTPUT_FORMAT_SHORT

      public static final String OUTPUT_FORMAT_SHORT
      The short CLI argument name specifying the output format to write the reports to.
      See Also:

    • PROJECT

      public static final String PROJECT
      The long CLI argument name specifying the name of the project to be scanned.
      See Also:

    • HELP

      public static final String HELP
      The long CLI argument name asking for help.
      See Also:

    • ADVANCED_HELP

      public static final String ADVANCED_HELP
      The long CLI argument name asking for advanced help.
      See Also:

    • HELP_SHORT

      public static final String HELP_SHORT
      The short CLI argument name asking for help.
      See Also:

    • VERSION_SHORT

      public static final String VERSION_SHORT
      The long CLI argument name asking for the version.
      See Also:

    • VERSION

      public static final String VERSION
      The short CLI argument name asking for the version.
      See Also:

    • PROXY_PORT

      public static final String PROXY_PORT
      The CLI argument name indicating the proxy port.
      See Also:

    • PROXY_SERVER

      public static final String PROXY_SERVER
      The CLI argument name indicating the proxy server.
      See Also:

    • PROXY_USERNAME

      public static final String PROXY_USERNAME
      The CLI argument name indicating the proxy username.
      See Also:

    • PROXY_PASSWORD

      public static final String PROXY_PASSWORD
      The CLI argument name indicating the proxy password.
      See Also:

    • NON_PROXY_HOSTS

      public static final String NON_PROXY_HOSTS
      The CLI argument name indicating the proxy proxy exclusion list.
      See Also:

    • CONNECTION_TIMEOUT_SHORT

      public static final String CONNECTION_TIMEOUT_SHORT
      The short CLI argument name indicating the connection timeout.
      See Also:

    • CONNECTION_TIMEOUT

      public static final String CONNECTION_TIMEOUT
      The CLI argument name indicating the connection timeout.
      See Also:

    • CONNECTION_READ_TIMEOUT

      public static final String CONNECTION_READ_TIMEOUT
      The CLI argument name indicating the connection read timeout.
      See Also:

    • PROP_SHORT

      public static final String PROP_SHORT
      The short CLI argument name for setting the location of an additional properties file.
      See Also:

    • PROP

      public static final String PROP
      The CLI argument name for setting the location of an additional properties file.
      See Also:

    • DATA_DIRECTORY

      public static final String DATA_DIRECTORY
      The CLI argument name for setting the location of the data directory.
      See Also:

    • NVD_API_ENDPOINT

      public static final String NVD_API_ENDPOINT
      The CLI argument name for setting the URL for the NVD API Endpoint.
      See Also:

    • NVD_API_KEY

      public static final String NVD_API_KEY
      The CLI argument name for setting the URL for the NVD API Key.
      See Also:

    • NVD_API_MAX_RETRY_COUNT

      public static final String NVD_API_MAX_RETRY_COUNT
      The CLI argument name for setting the maximum number of retry requests for a single call to the NVD API.
      See Also:

    • NVD_API_VALID_FOR_HOURS

      public static final String NVD_API_VALID_FOR_HOURS
      The CLI argument name for setting the number of hours to wait before checking for new updates from the NVD.
      See Also:

    • NVD_API_DATAFEED_URL

      public static final String NVD_API_DATAFEED_URL
      The CLI argument name for the NVD API Data Feed URL.
      See Also:

    • NVD_API_DATAFEED_USER

      public static final String NVD_API_DATAFEED_USER
      The username for basic auth to the CVE data.
      See Also:

    • NVD_API_DATAFEED_PASSWORD

      public static final String NVD_API_DATAFEED_PASSWORD
      The password for basic auth to the CVE data.
      See Also:

    • NVD_API_DATAFEED_BEARER_TOKEN

      public static final String NVD_API_DATAFEED_BEARER_TOKEN
      The token for bearer auth to the CVE data.
      See Also:

    • SUPPRESSION_FILE_USER

      public static final String SUPPRESSION_FILE_USER
      The username for basic auth to web-hosted suppression files.
      See Also:

    • SUPPRESSION_FILE_PASSWORD

      public static final String SUPPRESSION_FILE_PASSWORD
      The passwored for basic auth to web-hosted suppression files.
      See Also:

    • SUPPRESSION_FILE_BEARER_TOKEN

      public static final String SUPPRESSION_FILE_BEARER_TOKEN
      The toke for bearer auth to web-hosted suppression files.
      See Also:

    • NVD_API_DELAY

      public static final String NVD_API_DELAY
      The time in milliseconds to wait between downloading NVD API data.
      See Also:

    • NVD_API_RESULTS_PER_PAGE

      public static final String NVD_API_RESULTS_PER_PAGE
      The number records for a single page from NVD API.
      See Also:

    • DATA_DIRECTORY_SHORT

      public static final String DATA_DIRECTORY_SHORT
      The short CLI argument name for setting the location of the data directory.
      See Also:

    • VERBOSE_LOG

      public static final String VERBOSE_LOG
      The CLI argument name for setting the location of the data directory.
      See Also:

    • VERBOSE_LOG_SHORT

      public static final String VERBOSE_LOG_SHORT
      The short CLI argument name for setting the location of the data directory.
      See Also:

    • SUPPRESSION_FILES

      public static final String SUPPRESSION_FILES
      The CLI argument name for setting the location of the suppression file(s).
      See Also:

    • HINTS_FILE

      public static final String HINTS_FILE
      The CLI argument name for setting the location of the hint file.
      See Also:

    • DISABLE_JAR

      public static final String DISABLE_JAR
      Disables the Jar Analyzer.
      See Also:

    • DISABLE_MSBUILD

      public static final String DISABLE_MSBUILD
      Disable the MS Build Analyzer.
      See Also:

    • DISABLE_ARCHIVE

      public static final String DISABLE_ARCHIVE
      Disables the Archive Analyzer.
      See Also:

    • DISABLE_KEV

      public static final String DISABLE_KEV
      Disables the Known Exploited Analyzer.
      See Also:

    • KEV_URL

      public static final String KEV_URL
      The URL to the CISA Known Exploited Vulnerability JSON datafeed.
      See Also:

    • KEV_USER

      public static final String KEV_USER
      The user for basic auth towards a CISA Known Exploited Vulnerability JSON datafeed mirror.
      See Also:

    • KEV_PASSWORD

      public static final String KEV_PASSWORD
      The password for basic auth towards a CISA Known Exploited Vulnerability JSON datafeed mirror.
      See Also:

    • KEV_BEARER_TOKEN

      public static final String KEV_BEARER_TOKEN
      The token for bearer auth towards a CISA Known Exploited Vulnerability JSON datafeed mirror.
      See Also:

    • DISABLE_PY_DIST

      public static final String DISABLE_PY_DIST
      Disables the Python Distribution Analyzer.
      See Also:

    • DISABLE_PY_PKG

      public static final String DISABLE_PY_PKG
      Disables the Python Package Analyzer.
      See Also:

    • DISABLE_MIX_AUDIT

      public static final String DISABLE_MIX_AUDIT
      Disables the Elixir mix audit Analyzer.
      See Also:

    • DISABLE_GO_DEP

      public static final String DISABLE_GO_DEP
      Disables the Golang Dependency Analyzer.
      See Also:

    • DISABLE_COMPOSER

      public static final String DISABLE_COMPOSER
      Disables the PHP Composer Analyzer.
      See Also:

    • COMPOSER_LOCK_SKIP_DEV

      public static final String COMPOSER_LOCK_SKIP_DEV
      Whether the PHP Composer Analyzer skips dev packages.
      See Also:

    • DISABLE_CPAN

      public static final String DISABLE_CPAN
      Disables the Perl CPAN File Analyzer.
      See Also:

    • DISABLE_GOLANG_MOD

      public static final String DISABLE_GOLANG_MOD
      Disables the Golang Mod Analyzer.
      See Also:

    • DISABLE_DART

      public static final String DISABLE_DART
      Disables the Dart Analyzer.
      See Also:

    • PATH_TO_GO

      public static final String PATH_TO_GO
      The CLI argument name for setting the path to `go`.
      See Also:

    • PATH_TO_YARN

      public static final String PATH_TO_YARN
      The CLI argument name for setting the path to `yarn`.
      See Also:

    • PATH_TO_PNPM

      public static final String PATH_TO_PNPM
      The CLI argument name for setting the path to `pnpm`.
      See Also:

    • DISABLE_RUBYGEMS

      public static final String DISABLE_RUBYGEMS
      Disables the Ruby Gemspec Analyzer.
      See Also:

    • DISABLE_AUTOCONF

      public static final String DISABLE_AUTOCONF
      Disables the Autoconf Analyzer.
      See Also:

    • DISABLE_MAVEN_INSTALL

      public static final String DISABLE_MAVEN_INSTALL
      Disables the Maven install Analyzer.
      See Also:

    • DISABLE_PIP

      public static final String DISABLE_PIP
      Disables the pip Analyzer.
      See Also:

    • DISABLE_PIPFILE

      public static final String DISABLE_PIPFILE
      Disables the Pipfile Analyzer.
      See Also:

    • DISABLE_POETRY

      public static final String DISABLE_POETRY
      Disables the Poetry Analyzer.
      See Also:

    • DISABLE_CMAKE

      public static final String DISABLE_CMAKE
      Disables the Cmake Analyzer.
      See Also:

    • DISABLE_COCOAPODS

      public static final String DISABLE_COCOAPODS
      Disables the cocoapods analyzer.
      See Also:

    • DISABLE_CARTHAGE

      public static final String DISABLE_CARTHAGE
      Disables the Carthage analyzer.
      See Also:

    • DISABLE_SWIFT

      public static final String DISABLE_SWIFT
      Disables the swift package manager analyzer.
      See Also:

    • DISABLE_SWIFT_RESOLVED

      public static final String DISABLE_SWIFT_RESOLVED
      Disables the swift package resolved analyzer.
      See Also:

    • DISABLE_ASSEMBLY

      public static final String DISABLE_ASSEMBLY
      Disables the Assembly Analyzer.
      See Also:

    • DISABLE_PE

      public static final String DISABLE_PE
      Disables the PE Analyzer.
      See Also:

    • DISABLE_BUNDLE_AUDIT

      public static final String DISABLE_BUNDLE_AUDIT
      Disables the Ruby Bundler Audit Analyzer.
      See Also:

    • DISABLE_FILENAME

      public static final String DISABLE_FILENAME
      Disables the File Name Analyzer.
      See Also:

    • DISABLE_NUSPEC

      public static final String DISABLE_NUSPEC
      Disables the Nuspec Analyzer.
      See Also:

    • DISABLE_NUGETCONF

      public static final String DISABLE_NUGETCONF
      Disables the Nuget packages.config Analyzer.
      See Also:

    • DISABLE_CENTRAL

      public static final String DISABLE_CENTRAL
      Disables the Central Analyzer.
      See Also:

    • DISABLE_CENTRAL_CACHE

      public static final String DISABLE_CENTRAL_CACHE
      Disables the Central Analyzer's ability to cache results locally.
      See Also:

    • CENTRAL_URL

      public static final String CENTRAL_URL
      The alternative URL for Maven Central Search.
      See Also:

    • CENTRAL_USERNAME

      public static final String CENTRAL_USERNAME
      The username for basic authentication to the alternative Maven Central Search.
      See Also:

    • CENTRAL_PASSWORD

      public static final String CENTRAL_PASSWORD
      The password for basic authentication to the alternative Maven Central Search.
      See Also:

    • CENTRAL_BEARER_TOKEN

      public static final String CENTRAL_BEARER_TOKEN
      The token for bearer authentication to the alternative Maven Central Search.
      See Also:

    • ENABLE_NEXUS

      public static final String ENABLE_NEXUS
      Disables the Nexus Analyzer.
      See Also:

    • DISABLE_OSSINDEX

      public static final String DISABLE_OSSINDEX
      Disables the Sonatype OSS Index Analyzer.
      See Also:

    • DISABLE_OSSINDEX_CACHE

      public static final String DISABLE_OSSINDEX_CACHE
      Disables the Sonatype OSS Index Analyzer's ability to cache results locally.
      See Also:

    • OSSINDEX_URL

      public static final String OSSINDEX_URL
      The alternative URL for the Sonatype OSS Index.
      See Also:

    • OSSINDEX_USERNAME

      public static final String OSSINDEX_USERNAME
      The username for the Sonatype OSS Index.
      See Also:

    • OSSINDEX_PASSWORD

      public static final String OSSINDEX_PASSWORD
      The password for the Sonatype OSS Index.
      See Also:

    • OSSINDEX_WARN_ONLY_ON_REMOTE_ERRORS

      public static final String OSSINDEX_WARN_ONLY_ON_REMOTE_ERRORS
      The password for the Sonatype OSS Index.
      See Also:

    • DISABLE_OPENSSL

      public static final String DISABLE_OPENSSL
      Disables the OpenSSL Analyzer.
      See Also:

    • DISABLE_NODE_JS

      public static final String DISABLE_NODE_JS
      Disables the Node.js Package Analyzer.
      See Also:

    • NODE_PACKAGE_SKIP_DEV_DEPENDENCIES

      public static final String NODE_PACKAGE_SKIP_DEV_DEPENDENCIES
      Skips dev dependencies in Node Package Analyzer.
      See Also:

    • DISABLE_NODE_AUDIT

      public static final String DISABLE_NODE_AUDIT
      Disables the Node Audit Analyzer.
      See Also:

    • DISABLE_YARN_AUDIT

      public static final String DISABLE_YARN_AUDIT
      Disables the Yarn Audit Analyzer.
      See Also:

    • DISABLE_PNPM_AUDIT

      public static final String DISABLE_PNPM_AUDIT
      Disables the Pnpm Audit Analyzer.
      See Also:

    • DISABLE_NODE_AUDIT_CACHE

      public static final String DISABLE_NODE_AUDIT_CACHE
      Disables the Node Audit Analyzer's ability to cache results locally.
      See Also:

    • DISABLE_NODE_AUDIT_SKIPDEV

      public static final String DISABLE_NODE_AUDIT_SKIPDEV
      Configures the Node Audit Analyzer to skip the dev dependencies.
      See Also:

    • DISABLE_RETIREJS_DEPRECATED

      @Deprecated public static final String DISABLE_RETIREJS_DEPRECATED
      Deprecated.
      Use DISABLE_RETIRE_JS instead.
      Disables the RetireJS Analyzer.
      See Also:

    • DISABLE_RETIRE_JS

      public static final String DISABLE_RETIRE_JS
      Disables the RetireJS Analyzer.
      See Also:

    • RETIRE_JS_FORCEUPDATE

      public static final String RETIRE_JS_FORCEUPDATE
      Whether the RetireJS Analyzer will update regardless of the `autoupdate` setting.
      See Also:

    • RETIREJS_URL

      public static final String RETIREJS_URL
      The URL to the retire JS repository.
      See Also:

    • RETIREJS_URL_USER

      public static final String RETIREJS_URL_USER
      The username for basic auth to the retire JS repository.
      See Also:

    • RETIREJS_URL_PASSWORD

      public static final String RETIREJS_URL_PASSWORD
      The password for basic auth to the retire JS repository.
      See Also:

    • RETIREJS_URL_BEARER_TOKEN

      public static final String RETIREJS_URL_BEARER_TOKEN
      The token for bearer auth to the retire JS repository.
      See Also:

    • NEXUS_URL

      public static final String NEXUS_URL
      The URL of the nexus server.
      See Also:

    • NEXUS_USERNAME

      public static final String NEXUS_USERNAME
      The username for the nexus server.
      See Also:

    • NEXUS_PASSWORD

      public static final String NEXUS_PASSWORD
      The password for the nexus server.
      See Also:

    • NEXUS_USES_PROXY

      public static final String NEXUS_USES_PROXY
      Whether or not the defined proxy should be used when connecting to Nexus.
      See Also:

    • CONNECTION_STRING

      public static final String CONNECTION_STRING
      The CLI argument name for setting the connection string.
      See Also:

    • DB_NAME

      public static final String DB_NAME
      The CLI argument name for setting the database user name.
      See Also:

    • DB_PASSWORD

      public static final String DB_PASSWORD
      The CLI argument name for setting the database password.
      See Also:

    • DB_DRIVER

      public static final String DB_DRIVER
      The CLI argument name for setting the database driver name.
      See Also:

    • DB_DRIVER_PATH

      public static final String DB_DRIVER_PATH
      The CLI argument name for setting the path to the database driver; in case it is not on the class path.
      See Also:

    • PATH_TO_CORE

      public static final String PATH_TO_CORE
      The CLI argument name for setting the path to dotnet core.
      See Also:

    • ADDITIONAL_ZIP_EXTENSIONS

      public static final String ADDITIONAL_ZIP_EXTENSIONS
      The CLI argument name for setting extra extensions.
      See Also:

    • EXCLUDE

      public static final String EXCLUDE
      Exclude path argument.
      See Also:

    • PATH_TO_BUNDLE_AUDIT

      public static final String PATH_TO_BUNDLE_AUDIT
      The CLI argument name for setting the path to bundle-audit for Ruby bundle analysis.
      See Also:

    • PATH_TO_BUNDLE_AUDIT_WORKING_DIRECTORY

      public static final String PATH_TO_BUNDLE_AUDIT_WORKING_DIRECTORY
      The CLI argument name for setting the path that should be used as the working directory that the bundle-audit command used for Ruby bundle analysis should be executed from. This will allow for the usage of rbenv
      See Also:

    • PATH_TO_MIX_AUDIT

      public static final String PATH_TO_MIX_AUDIT
      The CLI argument name for setting the path to mix_audit for Elixir analysis.
      See Also:

    • EXPERIMENTAL

      public static final String EXPERIMENTAL
      The CLI argument to enable the experimental analyzers.
      See Also:

    • RETIRED

      public static final String RETIRED
      The CLI argument to enable the retired analyzers.
      See Also:

    • RETIREJS_FILTERS_DEPRECATED

      @Deprecated public static final String RETIREJS_FILTERS_DEPRECATED
      Deprecated.
      Use RETIRE_JS_FILTERS instead.
      The CLI argument for the retire js content filters.
      See Also:

    • RETIRE_JS_FILTERS

      public static final String RETIRE_JS_FILTERS
      The CLI argument for the retire JS content filters.
      See Also:

    • RETIREJS_FILTER_NON_VULNERABLE_DEPRECATED

      @Deprecated public static final String RETIREJS_FILTER_NON_VULNERABLE_DEPRECATED
      Deprecated.
      Use RETIRE_JS_FILTER_NON_VULNERABLE instead.
      The CLI argument for the retire js content filters.
      See Also:

    • RETIRE_JS_FILTER_NON_VULNERABLE

      public static final String RETIRE_JS_FILTER_NON_VULNERABLE
      The CLI argument for the retire JS content filter for non-vulnerable.
      See Also:

    • ARTIFACTORY_ENABLED

      public static final String ARTIFACTORY_ENABLED
      The CLI argument for indicating if the Artifactory analyzer should be enabled.
      See Also:

    • ARTIFACTORY_URL

      public static final String ARTIFACTORY_URL
      The CLI argument for indicating if the Artifactory analyzer should use the proxy.
      See Also:

    • ARTIFACTORY_USERNAME

      public static final String ARTIFACTORY_USERNAME
      The CLI argument for indicating the Artifactory username.
      See Also:

    • ARTIFACTORY_API_TOKEN

      public static final String ARTIFACTORY_API_TOKEN
      The CLI argument for indicating the Artifactory API token.
      See Also:

    • ARTIFACTORY_BEARER_TOKEN

      public static final String ARTIFACTORY_BEARER_TOKEN
      The CLI argument for indicating the Artifactory bearer token.
      See Also:

    • ARTIFACTORY_USES_PROXY

      public static final String ARTIFACTORY_USES_PROXY
      The CLI argument for indicating if the Artifactory analyzer should use the proxy.
      See Also:

    • ARTIFACTORY_PARALLEL_ANALYSIS

      public static final String ARTIFACTORY_PARALLEL_ANALYSIS
      The CLI argument for indicating if the Artifactory analyzer should use the parallel analysis.
      See Also:

    • FAIL_ON_CVSS

      public static final String FAIL_ON_CVSS
      The CLI argument to configure when the execution should be considered a failure.
      See Also:

    • PRETTY_PRINT

      public static final String PRETTY_PRINT
      The CLI argument to configure if the XML and JSON reports should be pretty printed.
      See Also:

    • FAIL_JUNIT_ON_CVSS

      public static final String FAIL_JUNIT_ON_CVSS
      The CLI argument to set the threshold that is considered a failure when generating the JUNIT report format.
      See Also:

    • DISABLE_HOSTED_SUPPRESSIONS

      public static final String DISABLE_HOSTED_SUPPRESSIONS
      The CLI argument to set the number of hours to wait before re-checking hosted suppressions file for updates.
      See Also:

    • HOSTED_SUPPRESSIONS_VALID_FOR_HOURS

      public static final String HOSTED_SUPPRESSIONS_VALID_FOR_HOURS
      The CLI argument to set the number of hours to wait before re-checking hosted suppressions file for updates.
      See Also:

    • HOSTED_SUPPRESSIONS_FORCEUPDATE

      public static final String HOSTED_SUPPRESSIONS_FORCEUPDATE
      The CLI argument to set Whether the hosted suppressions file will update regardless of the `noupdate` argument.
      See Also:

    • HOSTED_SUPPRESSIONS_URL

      public static final String HOSTED_SUPPRESSIONS_URL
      The CLI argument to set the location of a mirrored hosted suppressions file .
      See Also:

    • HOSTED_SUPPRESSIONS_USER

      public static final String HOSTED_SUPPRESSIONS_USER
      The username for basic auth to a mirrored hosted suppressions file.
      See Also:

    • HOSTED_SUPPRESSIONS_PASSWORD

      public static final String HOSTED_SUPPRESSIONS_PASSWORD
      The passwored for basic auth to a mirrored hosted suppressions file.
      See Also:

    • HOSTED_SUPPRESSIONS_BEARER_TOKEN

      public static final String HOSTED_SUPPRESSIONS_BEARER_TOKEN
      The toke for bearer auth to a mirrored hosted suppressions file.
      See Also:

  • Constructor Details

    • ARGUMENT

      public ARGUMENT()