Skip to content

Latest commit

 

History

History
303 lines (221 loc) · 18.8 KB

RELEASE_NOTES.md

File metadata and controls

303 lines (221 loc) · 18.8 KB
Raw

Release Notes

Please see the dependency-check google group for the release notes on versions not listed below.

Version 5.0.0-M3 (2019-05-06)

Breaking Changes

  • OWASP dependency-check now uses the NVD Meta files in addition to the *.json.gz files. If you have a local mirror of the NVD you must now mirror the meta data files. The nist-data-mirror has been updated to include these files.

Changes

  • Several bug fixes and minor enhancements have been made; see the related issues and pull requests.
  • Multiple report formats can be specified; if you wanted just two of the reports you no longer need to use ALL.
  • A new JUNIT formatted report has been added; this provides a different way to integrate with Jenkins builds; the following example creates a JUNIT report with failures for any CVE with a CVSS score greater than or equal to 7.0 the Jenkins pipeline script shows how to publish the report: pom.xml 
    <plugin>
  <groupId>org.owasp</groupId>
  <artifactId>dependency-check-maven</artifactId>
  <version>5.0.0-M3</version>
  <configuration>
    <formats>
        <format>HTML</format>
        <format>JUNIT</format>
    </formats>
    <junitFailOnCVSS>7.0</junitFailOnCVSS>
  </configuration>
  <executions>
    <execution>
      <goals>
        <goal>verify</goal>
      </goals>
    </execution>
  </executions>
</plugin>
    Jenkinsfile 
    stage ('Build') {
  steps {
    sh 'mvn verify'
  }
  post {
    success {
      junit 'target/dependency-check-junit.xml'
    }
  }
}

Version 5.0.0-M2 (2019-03-11)

Breaking Changes

  • dotnet core must be installed to analyze .NET assemblies.
  • The retire.js analyzer is no longer considered experimental and is enabled by default.

Version 5.0.0-M1 (2019-02-17)

Breaking Changes

  • All previously deprecated arguments to the plugins and CLI have been removed.
  • The NVD CVE data import now uses the JSON data feeds instead of the XML data feeds.
    • The parameter names have changed if you are mirroring the data feeds locally.
  • For developers using the core engine the identifiers have been drastically changed; ODC now uses Package URL for software identifiers and CPE objects from CPE-Parser for vulnerable library identifiers.
  • All of the report formats have been updated to include the additional data from the NVD CVE JSON data feeds.

Changes

  • Major re-working of the dependency to CPE matching algorithm.
  • Introduced ecosystem filtering - this is an internal process that tries to ensure vulnerabilities from one technology stack do not appear on a dependency built using a completely different stack (e.g. NodeJS vulnerabilities should not show up on a .NET DLL).

Version 4.0.2 (2019-01-01)

Enhancements

  • Added the ability for the dependency-check-maven plugin to scan the dependencyManagement section of the pom.xml. Note that in the default configuration the dependency management section is skipped. To enable this feature set <skipDependencyManagement>false</skipDependencyManagement>.
  • If using a local Nexus server (v2 or v3 pro) it is now possible to provide authentication credentials.
    • Previous versions only worked with anonymous/unauthenticated access.
    • See issue #977

Bug Fixes

  • Updated fix for transitive dependencies with known vulnerabilities (guava and commons-collections) so that the upgrade occurs correctly in other integrations that utilize core; see issue #1562.
  • Resolved several false positives

Version 4.0.1 (2018-12-17)

Bug Fixes

  • Fixed issue with false positives due to Lucene upgrade. See #1531.
  • Resolved several false positives.
  • Resolved typo in documentation.

Version 4.0.0 (2018-11-21)

Breaking Changes

  • OWASP dependency-check no longer supports running in JRE/JDK 7; JRE/JDK 8 or higher is required run dependency-check. See #1531.

Bug Fixes

  • Upgraded dependencies to resolve published vulnerabilities (Guava and Lucene); See #1561.

Version 3.3.4 (2018-10-28)

Bug Fixes

  • Resolved bug with parsing license information during analysis of Node.js modules.

Version 3.3.3 (2018-10-27)

Enhancements

  • Migrated the NSP Analyzer to use the Node Audit APIs instead; see #1366.
    • Note that the analyzer and configuration was changed to NodeAuditAnalyzer.
    • Configurations for the NSP analyzer have been deprecated and will control the NodeAuditAnalyzer if used; note that the NSP configuration options will be removed in a future release.
  • The dependency-check-gradle plugin was updated to include a default scan set of ['src/main/resources','src/main/webapp'] and any dependencies contained in these directories will be analyzed. The purpose of this enhancement is to enable the RetireJS Analyzer to scan JavaScript files that may be included.

Bug Fixes

  • Resolved false negative on Bouncy Castle JAR files; see #1500.
  • Resolved false negatives that may occur when using the Maven plugin if transitive dependencies of a library in use and is also declared as a primary dependency in a scope that is not used; see #1512.
  • Resolved false negatives on libraries that contain an update version or timestamp tacked onto the end of the version number; see #1537.
    • The resolution for these false negatives may generate some false positives, please continue to report false positives and the engine can continue to be tuned.
  • Fixed bug preventing multiple proxies from being defined for Maven; see #831.
  • Updated the suppress buttons in the HTML report to generate the XML using the latest suppression schema; see #489.
  • Added the --artifactoryUrl argument to the CLI - this was missed when the Artifactory Analyzer was previously added; see #1492.
  • Updated test cases so that they no longer fail behind a proxy; see #1493.
  • Resolved several reported false positives; see #1504, #1513, #1515, #1529, #1535, and #1437.
  • Fixed copy/paste error in JavaDoc; see #1509.

Version 3.3.2 (2018-09-14)

Bug Fixes

  • Gradle plugin was updated to include backward compatability with gradle < v4.0; see #95.
  • Gradle plugin improved handling of Android project; see #94
  • CLI used an incorrect key for RetireJS causing the analyzer to not be loaded in some cases; see #1440.
  • Resolved failure in the CentralAnalyzer when the pom.xml is not available in Central; see #1439.
  • Resolved exception when JAR files contain invalid pom.xml files outside of META-INF; see #1438.
  • Resolved several reported false positives.

Version 3.3.1 (2018-08-06)

Bug Fixes

  • Fixed error handling with regard to invalid manifest files contained within JAR files; see #1024.
  • Fixed parsing of pom.xml files, in some cases a SAX Exception would be thrown; see #1400.
  • Fixed bug that caused dependency-check to crash if the temporary directory and data directory were on different drives; see #1394.
  • Fixed bug in dependency-check-maven where an aggregate analysis did not scan all files defined in the ScanSet; see #1421.
  • Fixed NPE in dependency-check-gradle that occurred when artifacts where included using implementation files("./lib/some.jar"); see #91.

Enhancements

  • An Nuget Packages.config Analyzer was added; see #1412.

Version 3.3.0 (2018-07-22)

Bug Fixes

  • The dependency-check-gradle plugin can now analyze multi-project android builds. See PR #09 for more information.
  • In some cases extremely large project may cause dependency-check to fail due to the analysis time. Previously, the analysis was capped at 10 minutes; the timeout was increased to 20 minutes and made configurable if this continues to be an issue for some users. See issue #936 for more information.
  • Some pom.xml files could not be analyzed because they contained a doctype definition. The parser has been enhanced to strip the doctype definitions.
  • Fixed issue where, in some cases, temporary files were not correctly cleaned up in Jenkins and gradle builds.
  • Fixed issue where, in some cases, files were retrieved from Maven Central using HTTP instead of HTTPS. See issue #1325 for more information.
    • Additionally, a retry count was added when attempting to download pom.xml files during analysis.
  • Fixed issue where nodejs dependencies were not correctly analyzed. See issue #1355 for more information.
  • Fixed issue where the CWE was not written to the CSV report.
  • In addition, general bug fixes, code cleanup, and false positive/negatives updates were made.

Enhancements

  • An Artifactory Analyzer was added that can be used to in-place of the Central Analyzer for organizations that use Artifactory.
    • Note, for maven and gradle builds the Artifactory analyzer will not improve the analysis. The information gained by using the Central, Artifactory, or Nexus Analyzers is already obtained from the build system.
  • An experimental Retire JS analyzer has been added to analyze client side JavaScript.
    • This utilizes information from the RetireJS repo on github. If you have a proxy that prevents access you will either need to have access granted to https://raw.githubusercontent.com/Retirejs/retire.js/master/repository/jsrepository.json or host the file internally, update the environment variable analyzer.retirejs.repo.js.ur, and periodically update the file.
    • This analyzer is considered experimental, but the team expects this to be promoted quickly.
  • NuGet dependencies contained in MSBuild files are now included in the scan. See Issue #1131 for more details.
  • Cocoapod's Podfile.lock is now analyzed when present. See PR #1324 for more information.

Version 3.2.1 (2018-05-28)

Bug Fixes

  • In some cases when using the Maven or Gradle plugins the GAV coordinates were not being added as an Identifier causing suppression rules to fail; this has been resolved (#1298)
  • Documentation Update (SCM links in the maven site were broken) (#1297)
  • False positive reduction (#1290)
  • Enhanced logging output for TLS failures to better assist with debugging (#1269)
  • Resolved a Null Pointer Exception (#1296)

Version 3.2.0 (2018-05-21)

Security Fix

  • Unsafe unzip operations (zip slip), as reported by the Snyk Security Research Team, have been corrected. CVE-2018-12036 allows attackers to write to arbitrary files via a crafted archive that holds directory traversal filenames.

Bug Fixes

  • The dependency-check-maven plugin no longer uses the Central Analyzer by default
  • Updated dependency-check-maven so that it will not fail when your multi-module build has dependencies that have not yet been built in the reactor (See #740)
    • Note if the required dependency has not yet been built in the reactor and the dependency is available in a configured repository dependency-check-maven, as expected, would pull the dependency from the repository for analysis.
  • Minor documentation updates
  • False positive reduction
  • Fixed the Gradle Plugin and Ant Task so that the temp directory is properly cleaned up after execution
  • Removed TLSv1 from the list of protocols used by default (See #1237)

Enhancements

  • Excess white space has been removed from the XML and HTML reports; the JSON report is still pretty printed (a future release will convert this to a configurable option)
  • Better error reporting
  • Changed to use commons-text instead of commons-lang3 as a portion of commons-lang3 was moved to commonts-text
  • Added more flexible suppression rules with the introduction of the until attribute (see #1145 and dependency-suppression.1.2.xsd

Version 3.1.2 (2018-04-02)

Bug fixes

  • Updated the NVD URLs
  • Updated documentation
  • Add project references to the JSON and XML report; in aggregate scans using Maven or Gradle the dependencies will include a reference to the project/module where they were found
  • The configuration option versionCheckEnabled was added to Maven to allow users to disable the check for new versions of dependency-check; this will be added to gradle plugin, Ant Task, and the CLI in a future release
  • The XML and JSON reports were fixed so that the correct version number is displayed see issue #1109
  • The initial database creation time for H2 databases was improved
  • Changes made to decrease false positive and false negatives

Version 3.1.1 (2018-01-29)

Bug fixes

  • Fixed the Central Analyzer to use the updated SHA1 query syntax.
  • Reverted change that broke Maven 3.1.0 compatability; Maven 3.1.0 and beyond is once again supported.
  • False positive reduction.
  • Minor documentation cleanup.

Version 3.1.0 (2018-01-02)

Enhancements

  • Major enhancements to the Node and NSP analyzer - the analyzers are now considered production ready and should be used in combination.
  • Added a shutdown hook so that if the update process is interrupted while using an H2 database the lock files will be properly removed allowing future executions of ODC to succeed.
  • UNC paths can now be scanned using the CLI.
  • Batch updates are now used which may help with the update speed when using some DBMS instead of the embedded H2.
  • Upgrade Lucene to 5.5.5, the highest version that will allow us to maintain Java 7 support

Bug fixes

  • Fixed the CSV report output to correctly list all fields.
  • Invalid suppression files will now break the build instead of causing ODC to skip the usage of the suppression analyzer.
  • Fixed bug in Lucene query where LARGE entries in the pom.xml or manifest caused the query to break.
  • General cleanup, false positive, and false negative reduction.

Version 3.0.2 (2017-11-13)

Bug fixes

  • Updated the query format for the CentralAnalyzer; the old format caused the CentralAnalyzer to fail

Version 3.0.1 (2017-10-20)

Bug fixes

  • Fixed a database connection issue that affected some usages.

Version 3.0.0 (2017-10-16)

  • Several bug fixes and false positive reduction
    • The 2.x branch introduced several new false positives – but also reduced the false negatives
  • Java 9 compatibility update
  • Stability issues with the Central Analyzer resolved
    • This comes at a cost of a longer analysis time
  • The CSV report now includes the GAV and CPE
  • The Hint Analyzer now supports regular expressions
  • If show summary is disabled and vulnerable libraries are found that fail the build details are no longer displayed in the console – only that vulnerable libraries were identified
  • Resolved issues with threading and multiple connections to the embedded H2 database
    • This allows the Jenkins pipeline, Maven Plugin, etc. to safely run parallel executions of dependency-check