https://github.com/dependency-check/dependency-check-sonar-plugin
Integrates Dependency-Check reports into SonarQube
https://github.com/dependency-check/dependency-check-sonar-plugin
appsec component-analysis nvd owasp security software-security sonar-plugin sonarqube visibility vulnerabilities vulnerable-components
Last synced: 5 months ago
JSON representation
Integrates Dependency-Check reports into SonarQube
- Host: GitHub
- URL: https://github.com/dependency-check/dependency-check-sonar-plugin
- Owner: dependency-check
- Created: 2015-01-12T15:56:34.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-18T09:15:04.000Z (10 months ago)
- Last Synced: 2024-08-04T05:01:30.903Z (9 months ago)
- Topics: appsec, component-analysis, nvd, owasp, security, software-security, sonar-plugin, sonarqube, visibility, vulnerabilities, vulnerable-components
- Language: Java
- Homepage:
- Size: 8.03 MB
- Stars: 578
- Watchers: 18
- Forks: 133
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Dependency-Check Plugin for SonarQube 10.2 or higher
[](https://www.codacy.com/gh/dependency-check/dependency-check-sonar-plugin/dashboard?utm_source=github.com&utm_medium=referral&utm_content=dependency-check/dependency-check-sonar-plugin&utm_campaign=Badge_Grade)
[](https://github.com/dependency-check/dependency-check-sonar-plugin/releases/latest)
[](https://sonarcloud.io/dashboard?id=dependency-check_dependency-check-sonar-plugin)
[](https://sonarcloud.io/dashboard?id=dependency-check_dependency-check-sonar-plugin)
[](https://sonarcloud.io/dashboard?id=dependency-check_dependency-check-sonar-plugin)
Integrates [Dependency-Check][] reports into SonarQube v10.2 or higher.
The project will try to backport all code from master branch to last supported LTS. Please see the [SonarQube 6.x][] or [SonarQube 7.x][] branch for old supported version.
## About Dependency-Check
Dependency-Check is a utility that attempts to detect publicly disclosed vulnerabilities contained within project dependencies. It does this by determining if there is a Common Platform Enumeration (CPE) identifier for a given dependency. If found, it will generate a report linking to the associated CVE entries.
Dependency-Check supports the identification of project dependencies in a number of different languages including Java, .NET, Node.js, Ruby, and Python.
## Note
**This SonarQube plugin does not perform analysis**, rather, it reads existing Dependency-Check reports. Use one of the other available methods to scan project dependencies and generate the necessary JSON report which can then be consumed by this plugin. Refer to the [Dependency-Check project](https://github.com/jeremylong/DependencyCheck) for relevant [documentation](https://jeremylong.github.io/DependencyCheck/).
## Metrics
The plugin keeps track of a number of statistics including:
- Total number of dependencies scanned
- Total number of vulnerabilities found across all dependencies
- Total number of vulnerable components
- Total number of critical, high, medium, and low severity vulnerabilities
Additionally, the following two metrics are defined:
### Inherited Risk Score (IRS)
```java
(high * 5) + (medium * 3) + (low * 1)
```
The IRS is simply a weighted measurement of the vulnerabilities inherited by the application through the use of vulnerable components. It does not measure the applications actual risk due to those components. The higher the score the more risk the application inherits.
### Vulnerable Component Ratio
(vulnerabilities / vulnerableComponents)
This is simply a measurement of the number of vulnerabilities to the vulnerable components (as a percentage). A higher percentage indicates that a large number of components contain vulnerabilities. Lower percentages are better.
## Compiling
> $ mvn clean package
### Working with NodeJS
- Start SonarQube Server
- Run `npm start` inside `sonar-dependency-check-plugin`
- Adjust `DEFAULT_PORT`, `PROXY_URL`, `PROXY_CONTEXT_PATH` for your environment
## Distribution
Ready to use binaries are available from [GitHub][].
## Plugin version compatibility
Please use the newest version. Please keep in mind that this plugin only supports the latest SonarQube LTS version, and the latest non SonarQube LTS version.
| Plugin Version | SonarQube version |
|----------------|-----------------------------|
| 5.0.0 and up | SonarQube 10.2 and up |
| 4.0.0 - 4.0.1 | SonarQube 9.9 LTS - 10.2 |
| 3.0.0 - 3.1.0 | SonarQube 8.9 LTS - 9.9 LTS |
| 2.0.6 - 2.0.8 | SonarQube 7.9 LTS - 8.9 LTS |
| 1.2.x - 2.0.5 | SonarQube 7.6 - 7.9 LTS |
| 1.1.x | SonarQube 6.7 LTS |
| 1.0.3 | SonarQube 5.6 LTS |
## Installation
Copy the plugin (jar file) to $SONAR_INSTALL_DIR/extensions/plugins and restart SonarQube or install via SonarQube Marketplace.
## Using
Create aggregate reports with Dependency-Check. Dependency-Check will output a file named 'dependency-check-report.json'. The Dependency-Check SonarQube plugin reads an existing Dependency-Check JSON report.
## Plugin Configuration
A typical SonarQube configuration will have the following parameter. This example assumes the use of a Jenkins workspace, but can easily be altered for other CI/CD systems.
```ini
sonar.dependencyCheck.jsonReportPath=${WORKSPACE}/dependency-check-report.json
sonar.dependencyCheck.htmlReportPath=${WORKSPACE}/dependency-check-report.html
```
In this example, all supported reports (JSON and HTML) are specified. Only the JSON report is required, however, if the HTML report is also available, it greatly enhances the usability of the SonarQube plugin by incorporating the actual Dependency-Check HTML report in the SonarQube project.
This plugin tries to add SonarQube issues to your project configuration files (e.g. pom.xml, \*.gradle, package-json.lock). Please make sure, that these files are part of `sonar.sources`.
To configure the severity of the created issues you can optionally specify the minimum score for each severity with the following parameter. Specify a score of `-1` to completely disable a severity.
```ini
sonar.dependencyCheck.severity.high=7.0
sonar.dependencyCheck.severity.medium=4.0
sonar.dependencyCheck.severity.low=0.0
```
In large projects you have many dependencies with (hopefully) no vulnerabilities. The following configuration summarize all vulnerabilities of one dependency into one issue.
```ini
sonar.dependencyCheck.summarize=true
sonar.dependencyCheck.summarize=false (default)
```
If you want skip this plugin, it's possible with following configuration.
```ini
sonar.dependencyCheck.skip=true
sonar.dependencyCheck.skip=false (default)
```
If you want to work with [Security-Hotspots][Security-Hotspot] to enable a review process in your team, use the following configuration.
```ini
sonar.dependencyCheck.securityHotspot=true
sonar.dependencyCheck.securityHotspot=false (default)
```
If you want to have the complete jar file path instead of the name, use the following configuration.
```ini
sonar.dependencyCheck.useFilePath=true
sonar.dependencyCheck.useFilePath=false (default)
```
## Ecosystem
Dependency-Check is available as a:
- Command-line utility
- Ant Task
- Gradle Plugin
- Jenkins Plugin
- Maven Plugin
- SonarQube Plugin
## Copyright & License
Dependency-Check Sonar Plugin is Copyright (c) dependency-check. All Rights Reserved.
Dependency-Check is Copyright (c) Jeremy Long. All Rights Reserved.
Permission to modify and redistribute is granted under the terms of the [LGPLv3][] license.
[lgplv3]: http://www.gnu.org/licenses/lgpl.txt
[github]: https://github.com/dependency-check/dependency-check-sonar-plugin/releases
[dependency-check]: https://www.owasp.org/index.php/OWASP_Dependency_Check
[sonarqube 6.x]: https://github.com/dependency-check/dependency-check-sonar-plugin/tree/SonarQube_6.x
[sonarqube 7.x]: https://github.com/dependency-check/dependency-check-sonar-plugin/tree/SonarQube_7.x
[sonar-custom-plugin-example]: https://github.com/SonarSource/sonar-custom-plugin-example
[security-hotspot]: https://docs.sonarqube.org/latest/user-guide/security-hotspots/