Dependency-Check-Gradle

The dependency-check gradle plugin allows projects to monitor dependent libraries for known, published vulnerabilities.

Compatibility

• Gradle 7.6.4 → 9.x (see test matrix)
• Gradle running with Java 11+

Mandatory upgrade to 12.1.0+

Due to NVD API compatibility changes, an upgrade is mandatory. See #7463 for more information.

Upgrading to 11.0.0+

• The dependency-check-gradle plugin now requires Java 11 or higher.
• The dependency-check-gradle plugin will no longer be published to Maven Central; it will continue to be published to the Gradle plugin portal.

Usage

Below are the quick start instructions. Please see the documentation site for more detailed information on configuration and usage.

Step 1, Apply dependency check gradle plugin

Add the plugin to your build.gradle file:

plugins {
  id "org.owasp.dependencycheck" version "13.0.0"
}

Step 2, Run gradle task

Once gradle plugin applied, run following gradle task to check dependencies:

gradle dependencyCheckAnalyze --info

The reports will be generated automatically under build/reports/dependency-check by default; resolved via Gradle's reporting directory (project.reporting.baseDirectory.dir("dependency-check")).

If your project includes multiple sub-projects, the report will be generated for each sub-project in their own project.reporting.baseDirectory.dir("dependency-check") location.

Multiple Configurations

Some projects may require multiple dependency-check configurations. This is supported by registering multiple tasks:

plugins {
  id 'java'
  id 'org.owasp.dependencycheck' version '13.0.0'
}

tasks.register('dependencyCheckRelease', org.owasp.dependencycheck.gradle.tasks.Analyze) {
  dependencyCheck {
    failBuildOnCVSS = 9.0
  }
}

tasks.register('dependencyCheckCI', org.owasp.dependencycheck.gradle.tasks.Analyze) {
  dependencyCheck {
    failBuildOnCVSS = 3.0
  }
}

Gradle Build Environment conflicts

Sometimes users may encounter issues with NoSuchMethodError exceptions due to dependency resolution conflicts with other plugins. If you encounter this issue you will need to use buildSrc to pin some of the transitive dependencies of dependency-check to specific versions compatible with all plugins in your build.

For example in buildSrc/build.gradle

dependencies {
  constraints {
    // org.owasp.dependencycheck needs at least this version of jackson. Other plugins pull in older versions..
    add("implementation", "com.fasterxml.jackson:jackson-bom:2.21.2")
    // org.owasp.dependencycheck needs these versions. Other plugins pull in older versions..
    add("implementation", "org.apache.commons:commons-lang3:3.20.0")
    add("implementation", "org.apache.commons:commons-text:1.15.0")
  }
}

FAQ

Questions List:

• What if my project includes multiple sub-project? How can I use this plugin for each of them including the root project?
• How to customize the report directory?

What if my project includes multiple sub-project? How can I use this plugin for each of them including the root project?

For non-aggregate scans

Try put 'apply plugin: "dependency-check"' inside the 'allprojects' or 'subprojects' if you'd like to check all sub-projects only, see below:

(1) For all projects including root project:

buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
  }
  dependencies {
    classpath "org.owasp:dependency-check-gradle:13.0.0"
  }
}

allprojects {
  apply plugin: 'org.owasp.dependencycheck'
}

(2) For all sub-projects:

buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
  }
  dependencies {
    classpath "org.owasp:dependency-check-gradle:13.0.0"
  }
}

subprojects {
  apply plugin: 'org.owasp.dependencycheck'
}

In this way, the dependency check will be executed for all projects (including root project) or just sub projects.

For aggregate scans

For aggregate scan, apply the plugin either on the root project or alternatively if you multi-project build is libraries and an application you can apply the plugin on the application.

How to customize the report directory?

To change the default report folder, modify the configuration section like this:

subprojects {
  apply plugin: 'org.owasp.dependencycheck'

  dependencyCheck {
    // To somewhere in the build directory
    outputDirectory = layout.buildDirectory.dir('security-report')
  
    // or relative to the global reporting directory:
    outputDirectory = reporting.baseDirectory.dir('security-report')
  }
}

How do I use the plugin with Gradle Kotlin DSL?

plugins {
  id("org.owasp.dependencycheck") version "13.0.0" apply false
}

allprojects {
  apply(plugin = "org.owasp.dependencycheck")
}

configure<org.owasp.dependencycheck.gradle.extension.DependencyCheckExtension> {
  format = org.owasp.dependencycheck.reporting.ReportGenerator.Format.ALL.toString()
}