Use VulnCheck Exploit Intelligence to fix vulnerabilities

io.moderne.vulncheck.FixVulnCheckVulnerabilities

This software composition analysis (SCA) tool detects and upgrades dependencies with publicly disclosed vulnerabilities. This recipe both generates a report of vulnerable dependencies and upgrades to newer versions with fixes. This recipe by default only upgrades to the latest patch version. If a minor or major upgrade is required to reach the fixed version, this can be controlled using the maximumUpgradeDelta option. Vulnerability information comes from VulnCheck Vulnerability Intelligence. The recipe has an option to limit fixes to only those vulnerabilities that have evidence of exploitation at various levels of severity.

Recipe source

This recipe is only available to users of Moderne.

This recipe is available under the Moderne Proprietary License.

Options

Type	Name	Description	Example
String	apiToken	The API token for the VulnCheck api	A_TOKEN_GENERATED_FROM_VULNCHECK
String	scope	Optional. Match dependencies with the specified scope. Default is compile. An explanation of what each scope means can be found in the Apache Maven documentation. Valid options: compile, test, runtime, provided	compile
Boolean	overrideTransitive	Optional. When enabled transitive dependencies with vulnerabilities will have their versions overridden. By default only direct dependencies have their version numbers upgraded.	false
UpgradeDelta	maximumUpgradeDelta	Optional. The maximum difference to allow when suggesting a dependency version upgrade. Patch version upgrades are the default and safest option, as patch releases assert full backwards compatibility with no breaking changes. Minor version upgrades can introduce new features but do not typically include breaking changes. Major version upgrades will typically require code changes above and beyond this recipe. Valid options: patch, minor, major	patch
String	exploitMaturity	Optional. Fix only those vulnerabilities that have an exploit maturity level equal to or greater than the specified level. Valid options: public, commercial, weaponized	weaponized

Usage

This recipe has required configuration parameters and can only be run by users of Moderne. To run this recipe, you will need to provide the Moderne CLI run command with the required options. Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:

rewrite.yml

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.FixVulnCheckVulnerabilitiesExample
displayName: Use [VulnCheck Exploit Intelligence](https://docs.vulncheck.com/products/exploit-and-vulnerability-intelligence/exploit-intelligence) to fix vulnerabilities example
recipeList:
  - io.moderne.vulncheck.FixVulnCheckVulnerabilities: 
      apiToken: A_TOKEN_GENERATED_FROM_VULNCHECK
      scope: compile
      overrideTransitive: false
      maximumUpgradeDelta: patch
      exploitMaturity: weaponized

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe FixVulnCheckVulnerabilities --recipe-option "apiToken=A_TOKEN_GENERATED_FROM_VULNCHECK" --recipe-option "scope=compile" --recipe-option "overrideTransitive=false" --recipe-option "maximumUpgradeDelta=patch" --recipe-option "exploitMaturity=weaponized"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install io.moderne.recipe:rewrite-vulncheck:0.2.0

See how this recipe works across multiple open-source repositories

Run this recipe on OSS repos at scale with the Moderne SaaS.

Run this recipe here

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables

MavenMetadataFailures

Maven metadata failures

org.openrewrite.maven.table.MavenMetadataFailures

Attempts to resolve maven metadata that failed.

Column Name	Description
Group id	The groupId of the artifact for which the metadata download failed.
Artifact id	The artifactId of the artifact for which the metadata download failed.
Version	The version of the artifact for which the metadata download failed.
Maven repository	The URL of the Maven repository that the metadata download failed on.
Snapshots	Does the repository support snapshots.
Releases	Does the repository support releases.
Failure	The reason the metadata download failed.

VulnerabilityReport

Vulnerability report

org.openrewrite.java.dependencies.table.VulnerabilityReport

A vulnerability report that includes detailed information about the affected artifact and the corresponding CVEs.

Column Name	Description
Project	The name of the project / module taking the dependency. Relevant in repositories with multiple modules.
CVE	The CVE number.
Group	The first part of a dependency coordinate com.google.guava:guava:VERSION.
Artifact	The second part of a dependency coordinate com.google.guava:guava:VERSION.
Version	The resolved version.
Fixed in version	The minimum version that is no longer vulnerable.
Last affected version	The last version which was vulnerable.
Version within delta	The difference between the version in use and the fixed version is within the configured maximum version delta. The recipe attempted to upgrade the version in use to a fixed version.
Summary	The summary of the CVE.
Base score	The calculated base score.
Depth	Zero for direct dependencies.
CWEs	Common Weakness Enumeration (CWE) identifiers; semicolon separated.

VulnerabilityReportWithExploits

Vulnerability report with exploit intelligence

io.moderne.vulncheck.table.VulnerabilityReportWithExploits

A vulnerability report that includes detailed information about the affected artifact and the corresponding CVEs and enriched by VulnCheck exploit data.

Column Name	Description
Project	The name of the project / module taking the dependency. Relevant in repositories with multiple modules.
CVE	The CVE number.
Group	The first part of a dependency coordinate com.google.guava:guava:VERSION.
Artifact	The second part of a dependency coordinate com.google.guava:guava:VERSION.
Version	The resolved version.
Fixed in version	The minimum version that is no longer vulnerable.
Fixable with version update only	Whether the vulnerability is likely to be fixed by increasing the dependency version only, with no code modifications required. This is a heuristic which assumes that the dependency is accurately versioned according to semver.
Summary	The summary of the CVE.
Base score	The calculated base score.
Depth	Zero for direct dependencies.
CWEs	Common Weakness Enumeration (CWE) identifiers; semicolon separated.
Exploit maturity	The maturity of the exploit.
Reported exploit	Whether the vulnerability has been exploited.
Reported exploited by threat actors	Whether the vulnerability has been exploited by threat actors.
Reported exploited by ransomware	Whether the vulnerability has been exploited by ransomware.
Reported exploited by botnets	Whether the vulnerability has been exploited by botnets.

SourcesFileResults

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column Name	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

SourcesFileErrors

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column Name	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

RecipeRunStats

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column Name	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
99th percentile scanning time (ns)	99 out of 100 scans completed in this amount of time.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
99th percentile edit time (ns)	99 out of 100 edits completed in this amount of time.
Max edit time (ns)	The max time editing any one source file.