Coverage Report - org.owasp.dependencycheck.maven.DependencyCheckMojo
 
Classes in this File Line Coverage Branch Coverage Complexity
DependencyCheckMojo
0%
0/457
0%
0/234
5.586
 
 1  
 /*
 2  
  * This file is part of dependency-check-maven.
 3  
  *
 4  
  * Licensed under the Apache License, Version 2.0 (the "License");
 5  
  * you may not use this file except in compliance with the License.
 6  
  * You may obtain a copy of the License at
 7  
  *
 8  
  *     http://www.apache.org/licenses/LICENSE-2.0
 9  
  *
 10  
  * Unless required by applicable law or agreed to in writing, software
 11  
  * distributed under the License is distributed on an "AS IS" BASIS,
 12  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 13  
  * See the License for the specific language governing permissions and
 14  
  * limitations under the License.
 15  
  *
 16  
  * Copyright (c) 2013 Jeremy Long. All Rights Reserved.
 17  
  */
 18  
 package org.owasp.dependencycheck.maven;
 19  
 
 20  
 import java.io.File;
 21  
 import java.io.IOException;
 22  
 import java.io.InputStream;
 23  
 import java.io.UnsupportedEncodingException;
 24  
 import java.net.URLEncoder;
 25  
 import java.text.DateFormat;
 26  
 import java.util.Date;
 27  
 import java.util.List;
 28  
 import java.util.Locale;
 29  
 import java.util.Set;
 30  
 import java.util.logging.Level;
 31  
 import java.util.logging.Logger;
 32  
 import org.apache.maven.artifact.Artifact;
 33  
 import org.apache.maven.doxia.sink.Sink;
 34  
 import org.apache.maven.doxia.sink.SinkFactory;
 35  
 import org.apache.maven.plugin.AbstractMojo;
 36  
 import org.apache.maven.plugin.MojoExecutionException;
 37  
 import org.apache.maven.plugin.MojoFailureException;
 38  
 import org.apache.maven.plugins.annotations.Component;
 39  
 import org.apache.maven.plugins.annotations.LifecyclePhase;
 40  
 import org.apache.maven.plugins.annotations.Mojo;
 41  
 import org.apache.maven.plugins.annotations.Parameter;
 42  
 import org.apache.maven.plugins.annotations.ResolutionScope;
 43  
 import org.apache.maven.project.MavenProject;
 44  
 import org.apache.maven.reporting.MavenMultiPageReport;
 45  
 import org.apache.maven.reporting.MavenReport;
 46  
 import org.apache.maven.reporting.MavenReportException;
 47  
 import org.apache.maven.settings.Proxy;
 48  
 import org.owasp.dependencycheck.Engine;
 49  
 import org.owasp.dependencycheck.data.nvdcve.CveDB;
 50  
 import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
 51  
 import org.owasp.dependencycheck.data.nvdcve.DatabaseProperties;
 52  
 import org.owasp.dependencycheck.dependency.Dependency;
 53  
 import org.owasp.dependencycheck.dependency.Evidence;
 54  
 import org.owasp.dependencycheck.dependency.Identifier;
 55  
 import org.owasp.dependencycheck.dependency.Reference;
 56  
 import org.owasp.dependencycheck.dependency.Vulnerability;
 57  
 import org.owasp.dependencycheck.dependency.VulnerableSoftware;
 58  
 import org.owasp.dependencycheck.reporting.ReportGenerator;
 59  
 import org.owasp.dependencycheck.utils.LogUtils;
 60  
 import org.owasp.dependencycheck.utils.Settings;
 61  
 
 62  
 /**
 63  
  * Maven Plugin that checks project dependencies to see if they have any known published vulnerabilities.
 64  
  *
 65  
  * @author Jeremy Long <jeremy.long@owasp.org>
 66  
  */
 67  
 @Mojo(name = "check", defaultPhase = LifecyclePhase.COMPILE, threadSafe = true,
 68  
         requiresDependencyResolution = ResolutionScope.RUNTIME_PLUS_SYSTEM,
 69  
         requiresOnline = true)
 70  0
 public class DependencyCheckMojo extends AbstractMojo implements MavenMultiPageReport {
 71  
 
 72  
     /**
 73  
      * Logger field reference.
 74  
      */
 75  0
     private final Logger logger = Logger.getLogger(DependencyCheckMojo.class.getName());
 76  
 
 77  
     /**
 78  
      * The properties file location.
 79  
      */
 80  
     private static final String PROPERTIES_FILE = "mojo.properties";
 81  
     /**
 82  
      * Name of the logging properties file.
 83  
      */
 84  
     private static final String LOG_PROPERTIES_FILE = "log.properties";
 85  
     /**
 86  
      * System specific new line character.
 87  
      */
 88  0
     private static final String NEW_LINE = System.getProperty("line.separator", "\n").intern();
 89  
     // <editor-fold defaultstate="collapsed" desc="Maven bound parameters and components">
 90  
     /**
 91  
      * The Maven Project Object.
 92  
      */
 93  
     @Component
 94  
     private MavenProject project;
 95  
     /**
 96  
      * The path to the verbose log.
 97  
      */
 98  
     @Parameter(property = "logfile", defaultValue = "")
 99  
     private String logFile;
 100  
     /**
 101  
      * The name of the report to be displayed in the Maven Generated Reports page.
 102  
      */
 103  
     @Parameter(property = "name", defaultValue = "Dependency-Check")
 104  
     private String name;
 105  
     /**
 106  
      * The description of the Dependency-Check report to be displayed in the Maven Generated Reports page.
 107  
      */
 108  
     @Parameter(property = "description", defaultValue = "A report providing details on any published "
 109  
             + "vulnerabilities within project dependencies. This report is a best effort but may contain "
 110  
             + "false positives and false negatives.")
 111  
     private String description;
 112  
     /**
 113  
      * Specifies the destination directory for the generated Dependency-Check report. This generally maps to
 114  
      * "target/site".
 115  
      */
 116  
     @Parameter(property = "reportOutputDirectory", defaultValue = "${project.reporting.outputDirectory}", required = true)
 117  
     private File reportOutputDirectory;
 118  
     /**
 119  
      * The output directory. This generally maps to "target".
 120  
      */
 121  
     @Parameter(defaultValue = "${project.build.directory}", required = true)
 122  
     private File outputDirectory;
 123  
     /**
 124  
      * Specifies if the build should be failed if a CVSS score above a specified level is identified. The default is 11
 125  
      * which means since the CVSS scores are 0-10, by default the build will never fail.
 126  
      */
 127  0
     @SuppressWarnings("CanBeFinal")
 128  
     @Parameter(property = "failBuildOnCVSS", defaultValue = "11", required = true)
 129  
     private float failBuildOnCVSS = 11;
 130  
     /**
 131  
      * Sets whether auto-updating of the NVD CVE/CPE data is enabled. It is not recommended that this be turned to
 132  
      * false. Default is true.
 133  
      */
 134  0
     @SuppressWarnings("CanBeFinal")
 135  
     @Parameter(property = "autoupdate", defaultValue = "true", required = true)
 136  
     private boolean autoUpdate = true;
 137  
     /**
 138  
      * The report format to be generated (HTML, XML, VULN, ALL). This configuration option has no affect if using this
 139  
      * within the Site plugin unless the externalReport is set to true. Default is HTML.
 140  
      */
 141  0
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 142  
     @Parameter(property = "format", defaultValue = "HTML", required = true)
 143  
     private String format = "HTML";
 144  
     /**
 145  
      * Sets whether or not the external report format should be used.
 146  
      */
 147  0
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 148  
     @Parameter(property = "externalReport", defaultValue = "false", required = true)
 149  
     private boolean externalReport = false;
 150  
     /**
 151  
      * The Proxy URL.
 152  
      *
 153  
      * @deprecated Please use mavenSettings instead
 154  
      */
 155  0
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 156  
     @Parameter(property = "proxyUrl", defaultValue = "", required = false)
 157  
     @Deprecated
 158  
     private String proxyUrl = null;
 159  
 
 160  
     /**
 161  
      * The maven settings.
 162  
      */
 163  
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 164  
     @Parameter(property = "mavenSettings", defaultValue = "${settings}", required = false)
 165  
     private org.apache.maven.settings.Settings mavenSettings;
 166  
 
 167  
     /**
 168  
      * The maven settings proxy id.
 169  
      */
 170  
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 171  
     @Parameter(property = "mavenSettingsProxyId", required = false)
 172  
     private String mavenSettingsProxyId;
 173  
 
 174  
     /**
 175  
      * The Proxy Port.
 176  
      *
 177  
      * @deprecated Please use mavenSettings instead
 178  
      */
 179  0
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 180  
     @Parameter(property = "proxyPort", defaultValue = "", required = false)
 181  
     @Deprecated
 182  
     private String proxyPort = null;
 183  
     /**
 184  
      * The Proxy username.
 185  
      *
 186  
      * @deprecated Please use mavenSettings instead
 187  
      */
 188  0
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 189  
     @Parameter(property = "proxyUsername", defaultValue = "", required = false)
 190  
     @Deprecated
 191  
     private String proxyUsername = null;
 192  
     /**
 193  
      * The Proxy password.
 194  
      *
 195  
      * @deprecated Please use mavenSettings instead
 196  
      */
 197  0
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 198  
     @Parameter(property = "proxyPassword", defaultValue = "", required = false)
 199  
     @Deprecated
 200  
     private String proxyPassword = null;
 201  
     /**
 202  
      * The Connection Timeout.
 203  
      */
 204  0
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 205  
     @Parameter(property = "connectionTimeout", defaultValue = "", required = false)
 206  
     private String connectionTimeout = null;
 207  
     /**
 208  
      * The path to the suppression file.
 209  
      */
 210  0
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 211  
     @Parameter(property = "suppressionFile", defaultValue = "", required = false)
 212  
     private String suppressionFile = null;
 213  
     /**
 214  
      * Flag indicating whether or not to show a summary in the output.
 215  
      */
 216  0
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 217  
     @Parameter(property = "showSummary", defaultValue = "true", required = false)
 218  
     private boolean showSummary = true;
 219  
 
 220  
     /**
 221  
      * Whether or not the Jar Analyzer is enabled.
 222  
      */
 223  0
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 224  
     @Parameter(property = "jarAnalyzerEnabled", defaultValue = "true", required = false)
 225  
     private boolean jarAnalyzerEnabled = true;
 226  
 
 227  
     /**
 228  
      * Whether or not the Archive Analyzer is enabled.
 229  
      */
 230  0
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 231  
     @Parameter(property = "archiveAnalyzerEnabled", defaultValue = "true", required = false)
 232  
     private boolean archiveAnalyzerEnabled = true;
 233  
 
 234  
     /**
 235  
      * Whether or not the .NET Assembly Analyzer is enabled.
 236  
      */
 237  0
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 238  
     @Parameter(property = "assemblyAnalyzerEnabled", defaultValue = "true", required = false)
 239  
     private boolean assemblyAnalyzerEnabled = true;
 240  
 
 241  
     /**
 242  
      * Whether or not the .NET Nuspec Analyzer is enabled.
 243  
      */
 244  0
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 245  
     @Parameter(property = "nuspecAnalyzerEnabled", defaultValue = "true", required = false)
 246  
     private boolean nuspecAnalyzerEnabled = true;
 247  
 
 248  
     /**
 249  
      * Whether or not the Nexus Analyzer is enabled.
 250  
      */
 251  0
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 252  
     @Parameter(property = "nexusAnalyzerEnabled", defaultValue = "true", required = false)
 253  
     private boolean nexusAnalyzerEnabled = true;
 254  
     /**
 255  
      * Whether or not the Nexus Analyzer is enabled.
 256  
      */
 257  
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 258  
     @Parameter(property = "nexusUrl", defaultValue = "", required = false)
 259  
     private String nexusUrl;
 260  
     /**
 261  
      * Whether or not the configured proxy is used to connect to Nexus.
 262  
      */
 263  0
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 264  
     @Parameter(property = "nexusUsesProxy", defaultValue = "true", required = false)
 265  
     private boolean nexusUsesProxy = true;
 266  
     /**
 267  
      * The database connection string.
 268  
      */
 269  
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 270  
     @Parameter(property = "connectionString", defaultValue = "", required = false)
 271  
     private String connectionString;
 272  
     /**
 273  
      * The database driver name. An example would be org.h2.Driver.
 274  
      */
 275  
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 276  
     @Parameter(property = "databaseDriverName", defaultValue = "", required = false)
 277  
     private String databaseDriverName;
 278  
     /**
 279  
      * The path to the database driver if it is not on the class path.
 280  
      */
 281  
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 282  
     @Parameter(property = "databaseDriverPath", defaultValue = "", required = false)
 283  
     private String databaseDriverPath;
 284  
     /**
 285  
      * The database user name.
 286  
      */
 287  
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 288  
     @Parameter(property = "databaseUser", defaultValue = "", required = false)
 289  
     private String databaseUser;
 290  
     /**
 291  
      * The password to use when connecting to the database.
 292  
      */
 293  
     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
 294  
     @Parameter(property = "databasePassword", defaultValue = "", required = false)
 295  
     private String databasePassword;
 296  
     /**
 297  
      * A comma-separated list of file extensions to add to analysis next to jar, zip, ....
 298  
      */
 299  
     @Parameter(property = "zipExtensions", required = false)
 300  
     private String zipExtensions;
 301  
     /**
 302  
      * Skip Analysis for Test Scope Dependencies.
 303  
      */
 304  0
     @SuppressWarnings("CanBeFinal")
 305  
     @Parameter(property = "skipTestScope", defaultValue = "true", required = false)
 306  
     private boolean skipTestScope = true;
 307  
     /**
 308  
      * Skip Analysis for Runtime Scope Dependencies.
 309  
      */
 310  0
     @SuppressWarnings("CanBeFinal")
 311  
     @Parameter(property = "skipRuntimeScope", defaultValue = "false", required = false)
 312  
     private boolean skipRuntimeScope = false;
 313  
     /**
 314  
      * Skip Analysis for Provided Scope Dependencies.
 315  
      */
 316  0
     @SuppressWarnings("CanBeFinal")
 317  
     @Parameter(property = "skipProvidedScope", defaultValue = "false", required = false)
 318  
     private boolean skipProvidedScope = false;
 319  
     /**
 320  
      * The data directory, hold DC SQL DB.
 321  
      */
 322  
     @Parameter(property = "dataDirectory", defaultValue = "", required = false)
 323  
     private String dataDirectory;
 324  
     /**
 325  
      * Data Mirror URL for CVE 1.2.
 326  
      */
 327  
     @Parameter(property = "cveUrl12Modified", defaultValue = "", required = false)
 328  
     private String cveUrl12Modified;
 329  
     /**
 330  
      * Data Mirror URL for CVE 2.0.
 331  
      */
 332  
     @Parameter(property = "cveUrl20Modified", defaultValue = "", required = false)
 333  
     private String cveUrl20Modified;
 334  
     /**
 335  
      * Base Data Mirror URL for CVE 1.2.
 336  
      */
 337  
     @Parameter(property = "cveUrl12Base", defaultValue = "", required = false)
 338  
     private String cveUrl12Base;
 339  
     /**
 340  
      * Data Mirror URL for CVE 2.0.
 341  
      */
 342  
     @Parameter(property = "cveUrl20Base", defaultValue = "", required = false)
 343  
     private String cveUrl20Base;
 344  
 
 345  
     /**
 346  
      * The path to mono for .NET Assembly analysis on non-windows systems.
 347  
      */
 348  
     @Parameter(property = "pathToMono", defaultValue = "", required = false)
 349  
     private String pathToMono;
 350  
 
 351  
     // </editor-fold>
 352  
     /**
 353  
      * Executes the Dependency-Check on the dependent libraries.
 354  
      *
 355  
      * @return the Engine used to scan the dependencies.
 356  
      * @throws DatabaseException thrown if there is an exception connecting to the database
 357  
      */
 358  
     private Engine executeDependencyCheck() throws DatabaseException {
 359  
 
 360  0
         final InputStream in = DependencyCheckMojo.class.getClassLoader().getResourceAsStream(LOG_PROPERTIES_FILE);
 361  0
         LogUtils.prepareLogger(in, logFile);
 362  
 
 363  0
         populateSettings();
 364  0
         final Engine engine = new Engine();
 365  
 
 366  0
         final Set<Artifact> artifacts = project.getArtifacts();
 367  0
         for (Artifact a : artifacts) {
 368  0
             if (skipTestScope && Artifact.SCOPE_TEST.equals(a.getScope())) {
 369  0
                 continue;
 370  
             }
 371  
 
 372  0
             if (skipProvidedScope && Artifact.SCOPE_PROVIDED.equals(a.getScope())) {
 373  0
                 continue;
 374  
             }
 375  
 
 376  0
             if (skipRuntimeScope && !Artifact.SCOPE_RUNTIME.equals(a.getScope())) {
 377  0
                 continue;
 378  
             }
 379  
 
 380  0
             engine.scan(a.getFile().getAbsolutePath());
 381  0
         }
 382  0
         engine.analyzeDependencies();
 383  
 
 384  0
         return engine;
 385  
     }
 386  
 
 387  
     /**
 388  
      * Generates the reports for a given dependency-check engine.
 389  
      *
 390  
      * @param engine a dependency-check engine
 391  
      * @param outDirectory the directory to write the reports to
 392  
      */
 393  
     private void generateExternalReports(Engine engine, File outDirectory) {
 394  0
         DatabaseProperties prop = null;
 395  0
         CveDB cve = null;
 396  
         try {
 397  0
             cve = new CveDB();
 398  0
             cve.open();
 399  0
             prop = cve.getDatabaseProperties();
 400  0
         } catch (DatabaseException ex) {
 401  0
             logger.log(Level.FINE, "Unable to retrieve DB Properties", ex);
 402  
         } finally {
 403  0
             if (cve != null) {
 404  0
                 cve.close();
 405  
             }
 406  
         }
 407  0
         final ReportGenerator r = new ReportGenerator(project.getName(), engine.getDependencies(), engine.getAnalyzers(), prop);
 408  
         try {
 409  0
             r.generateReports(outDirectory.getCanonicalPath(), format);
 410  0
         } catch (IOException ex) {
 411  0
             logger.log(Level.SEVERE,
 412  
                     "Unexpected exception occurred during analysis; please see the verbose error log for more details.");
 413  0
             logger.log(Level.FINE, null, ex);
 414  0
         } catch (Throwable ex) {
 415  0
             logger.log(Level.SEVERE,
 416  
                     "Unexpected exception occurred during analysis; please see the verbose error log for more details.");
 417  0
             logger.log(Level.FINE, null, ex);
 418  0
         }
 419  0
     }
 420  
 
 421  
     /**
 422  
      * Generates a dependency-check report using the Maven Site format.
 423  
      *
 424  
      * @param engine the engine used to scan the dependencies
 425  
      * @param sink the sink to write the data to
 426  
      */
 427  
     private void generateMavenSiteReport(final Engine engine, Sink sink) {
 428  0
         final List<Dependency> dependencies = engine.getDependencies();
 429  
 
 430  0
         writeSiteReportHeader(sink, project.getName());
 431  0
         writeSiteReportTOC(sink, dependencies);
 432  
 
 433  0
         int cnt = 0;
 434  0
         for (Dependency d : dependencies) {
 435  0
             writeSiteReportDependencyHeader(sink, d);
 436  0
             cnt = writeSiteReportDependencyEvidenceUsed(d, cnt, sink);
 437  0
             cnt = writeSiteReportDependencyRelatedDependencies(d, cnt, sink);
 438  0
             writeSiteReportDependencyIdentifiers(d, sink);
 439  0
             writeSiteReportDependencyVulnerabilities(d, sink, cnt);
 440  0
         }
 441  0
         sink.body_();
 442  0
     }
 443  
 
 444  
     // <editor-fold defaultstate="collapsed" desc="various writeXXXXX methods to generate the Site Report">
 445  
     /**
 446  
      * Writes the vulnerabilities to the site report.
 447  
      *
 448  
      * @param d the dependency
 449  
      * @param sink the sink to write the data to
 450  
      * @param collapsibleHeaderCount the collapsible header count
 451  
      */
 452  
     private void writeSiteReportDependencyVulnerabilities(Dependency d, Sink sink, int collapsibleHeaderCount) {
 453  0
         int cnt = collapsibleHeaderCount;
 454  0
         if (d.getVulnerabilities() != null && !d.getVulnerabilities().isEmpty()) {
 455  0
             for (Vulnerability v : d.getVulnerabilities()) {
 456  
 
 457  0
                 sink.paragraph();
 458  0
                 sink.bold();
 459  
                 try {
 460  0
                     sink.link("http://web.nvd.nist.gov/view/vuln/detail?vulnId=" + URLEncoder.encode(v.getName(), "US-ASCII"));
 461  0
                     sink.text(v.getName());
 462  0
                     sink.link_();
 463  0
                     sink.bold_();
 464  0
                 } catch (UnsupportedEncodingException ex) {
 465  0
                     sink.text(v.getName());
 466  0
                     sink.bold_();
 467  0
                     sink.lineBreak();
 468  0
                     sink.text("http://web.nvd.nist.gov/view/vuln/detail?vulnId=" + v.getName());
 469  0
                 }
 470  0
                 sink.paragraph_();
 471  0
                 sink.paragraph();
 472  0
                 sink.text("Severity: ");
 473  0
                 if (v.getCvssScore() < 4.0) {
 474  0
                     sink.text("Low");
 475  
                 } else {
 476  0
                     if (v.getCvssScore() >= 7.0) {
 477  0
                         sink.text("High");
 478  
                     } else {
 479  0
                         sink.text("Medium");
 480  
                     }
 481  
                 }
 482  0
                 sink.lineBreak();
 483  0
                 sink.text("CVSS Score: " + v.getCvssScore());
 484  0
                 if (v.getCwe() != null && !v.getCwe().isEmpty()) {
 485  0
                     sink.lineBreak();
 486  0
                     sink.text("CWE: ");
 487  0
                     sink.text(v.getCwe());
 488  
                 }
 489  0
                 sink.paragraph_();
 490  0
                 sink.paragraph();
 491  0
                 sink.text(v.getDescription());
 492  0
                 if (v.getReferences() != null && !v.getReferences().isEmpty()) {
 493  0
                     sink.list();
 494  0
                     for (Reference ref : v.getReferences()) {
 495  0
                         sink.listItem();
 496  0
                         sink.text(ref.getSource());
 497  0
                         sink.text(" - ");
 498  0
                         sink.link(ref.getUrl());
 499  0
                         sink.text(ref.getName());
 500  0
                         sink.link_();
 501  0
                         sink.listItem_();
 502  0
                     }
 503  0
                     sink.list_();
 504  
                 }
 505  0
                 sink.paragraph_();
 506  0
                 if (v.getVulnerableSoftware() != null && !v.getVulnerableSoftware().isEmpty()) {
 507  0
                     sink.paragraph();
 508  
 
 509  0
                     cnt += 1;
 510  0
                     sink.rawText("Vulnerable Software <a href=\"javascript:toggleElement(this, 'vulnSoft" + cnt + "')\">[-]</a>");
 511  0
                     sink.rawText("<div id=\"vulnSoft" + cnt + "\" style=\"display:block\">");
 512  0
                     sink.list();
 513  0
                     for (VulnerableSoftware vs : v.getVulnerableSoftware()) {
 514  0
                         sink.listItem();
 515  
                         try {
 516  0
                             sink.link("http://web.nvd.nist.gov/view/vuln/search-results?cpe=" + URLEncoder.encode(vs.getName(), "US-ASCII"));
 517  0
                             sink.text(vs.getName());
 518  0
                             sink.link_();
 519  0
                             if (vs.hasPreviousVersion()) {
 520  0
                                 sink.text(" and all previous versions.");
 521  
                             }
 522  0
                         } catch (UnsupportedEncodingException ex) {
 523  0
                             sink.text(vs.getName());
 524  0
                             if (vs.hasPreviousVersion()) {
 525  0
                                 sink.text(" and all previous versions.");
 526  
                             }
 527  0
                             sink.text(" (http://web.nvd.nist.gov/view/vuln/search-results?cpe=" + vs.getName() + ")");
 528  0
                         }
 529  
 
 530  0
                         sink.listItem_();
 531  0
                     }
 532  0
                     sink.list_();
 533  0
                     sink.rawText("</div>");
 534  0
                     sink.paragraph_();
 535  
                 }
 536  0
             }
 537  
         }
 538  0
     }
 539  
 
 540  
     /**
 541  
      * Writes the identifiers to the site report.
 542  
      *
 543  
      * @param d the dependency
 544  
      * @param sink the sink to write the data to
 545  
      */
 546  
     private void writeSiteReportDependencyIdentifiers(Dependency d, Sink sink) {
 547  0
         if (d.getIdentifiers() != null && !d.getIdentifiers().isEmpty()) {
 548  0
             sink.sectionTitle4();
 549  0
             sink.text("Identifiers");
 550  0
             sink.sectionTitle4_();
 551  0
             sink.list();
 552  0
             for (Identifier i : d.getIdentifiers()) {
 553  0
                 sink.listItem();
 554  0
                 sink.text(i.getType());
 555  0
                 sink.text(": ");
 556  0
                 if (i.getUrl() != null && i.getUrl().length() > 0) {
 557  0
                     sink.link(i.getUrl());
 558  0
                     sink.text(i.getValue());
 559  0
                     sink.link_();
 560  
                 } else {
 561  0
                     sink.text(i.getValue());
 562  
                 }
 563  0
                 if (i.getDescription() != null && i.getDescription().length() > 0) {
 564  0
                     sink.lineBreak();
 565  0
                     sink.text(i.getDescription());
 566  
                 }
 567  0
                 sink.listItem_();
 568  0
             }
 569  0
             sink.list_();
 570  
         }
 571  0
     }
 572  
 
 573  
     /**
 574  
      * Writes the related dependencies to the site report.
 575  
      *
 576  
      * @param d the dependency
 577  
      * @param sink the sink to write the data to
 578  
      * @param collapsibleHeaderCount the collapsible header count
 579  
      * @return the collapsible header count
 580  
      */
 581  
     private int writeSiteReportDependencyRelatedDependencies(Dependency d, int collapsibleHeaderCount, Sink sink) {
 582  0
         int cnt = collapsibleHeaderCount;
 583  0
         if (d.getRelatedDependencies() != null && !d.getRelatedDependencies().isEmpty()) {
 584  0
             cnt += 1;
 585  0
             sink.sectionTitle4();
 586  0
             sink.rawText("Related Dependencies <a href=\"javascript:toggleElement(this, 'related" + cnt + "')\">[+]</a>");
 587  0
             sink.sectionTitle4_();
 588  0
             sink.rawText("<div id=\"related" + cnt + "\" style=\"display:none\">");
 589  0
             sink.list();
 590  0
             for (Dependency r : d.getRelatedDependencies()) {
 591  0
                 sink.listItem();
 592  0
                 sink.text(r.getFileName());
 593  0
                 sink.list();
 594  0
                 writeListItem(sink, "File Path: " + r.getFilePath());
 595  0
                 writeListItem(sink, "SHA1: " + r.getSha1sum());
 596  0
                 writeListItem(sink, "MD5: " + r.getMd5sum());
 597  0
                 sink.list_();
 598  0
                 sink.listItem_();
 599  0
             }
 600  0
             sink.list_();
 601  0
             sink.rawText("</div>");
 602  
         }
 603  0
         return cnt;
 604  
     }
 605  
 
 606  
     /**
 607  
      * Writes the evidence used to the site report.
 608  
      *
 609  
      * @param d the dependency
 610  
      * @param sink the sink to write the data to
 611  
      * @param collapsibleHeaderCount the collapsible header count
 612  
      * @return the collapsible header count
 613  
      */
 614  
     private int writeSiteReportDependencyEvidenceUsed(Dependency d, int collapsibleHeaderCount, Sink sink) {
 615  0
         int cnt = collapsibleHeaderCount;
 616  0
         final Set<Evidence> evidence = d.getEvidenceForDisplay();
 617  0
         if (evidence != null && evidence.size() > 0) {
 618  0
             cnt += 1;
 619  0
             sink.sectionTitle4();
 620  0
             sink.rawText("Evidence Collected <a href=\"javascript:toggleElement(this, 'evidence" + cnt + "')\">[+]</a>");
 621  0
             sink.sectionTitle4_();
 622  0
             sink.rawText("<div id=\"evidence" + cnt + "\" style=\"display:none\">");
 623  0
             sink.table();
 624  0
             sink.tableRow();
 625  0
             writeTableHeaderCell(sink, "Source");
 626  0
             writeTableHeaderCell(sink, "Name");
 627  0
             writeTableHeaderCell(sink, "Value");
 628  0
             sink.tableRow_();
 629  0
             for (Evidence e : evidence) {
 630  0
                 sink.tableRow();
 631  0
                 writeTableCell(sink, e.getSource());
 632  0
                 writeTableCell(sink, e.getName());
 633  0
                 writeTableCell(sink, e.getValue());
 634  0
                 sink.tableRow_();
 635  0
             }
 636  0
             sink.table_();
 637  0
             sink.rawText("</div>");
 638  
         }
 639  0
         return cnt;
 640  
     }
 641  
 
 642  
     /**
 643  
      * Writes the dependency header to the site report.
 644  
      *
 645  
      * @param d the dependency
 646  
      * @param sink the sink to write the data to
 647  
      */
 648  
     private void writeSiteReportDependencyHeader(Sink sink, Dependency d) {
 649  0
         sink.sectionTitle2();
 650  0
         sink.anchor("sha1" + d.getSha1sum());
 651  0
         sink.text(d.getFileName());
 652  0
         sink.anchor_();
 653  0
         sink.sectionTitle2_();
 654  0
         if (d.getDescription() != null && d.getDescription().length() > 0) {
 655  0
             sink.paragraph();
 656  0
             sink.bold();
 657  0
             sink.text("Description: ");
 658  0
             sink.bold_();
 659  0
             sink.text(d.getDescription());
 660  0
             sink.paragraph_();
 661  
         }
 662  0
         if (d.getLicense() != null && d.getLicense().length() > 0) {
 663  0
             sink.paragraph();
 664  0
             sink.bold();
 665  0
             sink.text("License: ");
 666  0
             sink.bold_();
 667  0
             if (d.getLicense().startsWith("http://") && !d.getLicense().contains(" ")) {
 668  0
                 sink.link(d.getLicense());
 669  0
                 sink.text(d.getLicense());
 670  0
                 sink.link_();
 671  
             } else {
 672  0
                 sink.text(d.getLicense());
 673  
             }
 674  0
             sink.paragraph_();
 675  
         }
 676  0
     }
 677  
 
 678  
     /**
 679  
      * Adds a list item to the site report.
 680  
      *
 681  
      * @param sink the sink to write the data to
 682  
      * @param text the text to write
 683  
      */
 684  
     private void writeListItem(Sink sink, String text) {
 685  0
         sink.listItem();
 686  0
         sink.text(text);
 687  0
         sink.listItem_();
 688  0
     }
 689  
 
 690  
     /**
 691  
      * Adds a table cell to the site report.
 692  
      *
 693  
      * @param sink the sink to write the data to
 694  
      * @param text the text to write
 695  
      */
 696  
     private void writeTableCell(Sink sink, String text) {
 697  0
         sink.tableCell();
 698  0
         sink.text(text);
 699  0
         sink.tableCell_();
 700  0
     }
 701  
 
 702  
     /**
 703  
      * Adds a table header cell to the site report.
 704  
      *
 705  
      * @param sink the sink to write the data to
 706  
      * @param text the text to write
 707  
      */
 708  
     private void writeTableHeaderCell(Sink sink, String text) {
 709  0
         sink.tableHeaderCell();
 710  0
         sink.text(text);
 711  0
         sink.tableHeaderCell_();
 712  0
     }
 713  
 
 714  
     /**
 715  
      * Writes the TOC for the site report.
 716  
      *
 717  
      * @param sink the sink to write the data to
 718  
      * @param dependencies the dependencies that are being reported on
 719  
      */
 720  
     private void writeSiteReportTOC(Sink sink, final List<Dependency> dependencies) {
 721  0
         sink.list();
 722  0
         for (Dependency d : dependencies) {
 723  0
             sink.listItem();
 724  0
             sink.link("#sha1" + d.getSha1sum());
 725  0
             sink.text(d.getFileName());
 726  0
             sink.link_();
 727  0
             if (!d.getVulnerabilities().isEmpty()) {
 728  0
                 sink.rawText(" <font style=\"color:red\">•</font>");
 729  
             }
 730  0
             if (!d.getRelatedDependencies().isEmpty()) {
 731  0
                 sink.list();
 732  0
                 for (Dependency r : d.getRelatedDependencies()) {
 733  0
                     writeListItem(sink, r.getFileName());
 734  0
                 }
 735  0
                 sink.list_();
 736  
             }
 737  0
             sink.listItem_();
 738  0
         }
 739  0
         sink.list_();
 740  0
     }
 741  
 
 742  
     /**
 743  
      * Writes the site report header.
 744  
      *
 745  
      * @param sink the sink to write the data to
 746  
      * @param projectName the name of the project
 747  
      */
 748  
     private void writeSiteReportHeader(Sink sink, String projectName) {
 749  0
         sink.head();
 750  0
         sink.title();
 751  0
         sink.text("Dependency-Check Report: " + projectName);
 752  0
         sink.title_();
 753  0
         sink.head_();
 754  0
         sink.body();
 755  0
         sink.rawText("<script type=\"text/javascript\">");
 756  0
         sink.rawText("function toggleElement(el, targetId) {");
 757  0
         sink.rawText("if (el.innerText == '[+]') {");
 758  0
         sink.rawText("    el.innerText = '[-]';");
 759  0
         sink.rawText("    document.getElementById(targetId).style.display='block';");
 760  0
         sink.rawText("} else {");
 761  0
         sink.rawText("    el.innerText = '[+]';");
 762  0
         sink.rawText("    document.getElementById(targetId).style.display='none';");
 763  0
         sink.rawText("}");
 764  
 
 765  0
         sink.rawText("}");
 766  0
         sink.rawText("</script>");
 767  0
         sink.section1();
 768  0
         sink.sectionTitle1();
 769  0
         sink.text("Project: " + projectName);
 770  0
         sink.sectionTitle1_();
 771  0
         sink.date();
 772  0
         final Date now = new Date();
 773  0
         sink.text(DateFormat.getDateTimeInstance().format(now));
 774  0
         sink.date_();
 775  0
         sink.section1_();
 776  0
     }
 777  
     // </editor-fold>
 778  
 
 779  
     /**
 780  
      * Returns the maven settings proxy url.
 781  
      *
 782  
      * @param proxy the maven proxy
 783  
      * @return the proxy url
 784  
      */
 785  
     private String getMavenSettingsProxyUrl(Proxy proxy) {
 786  0
         return new StringBuilder(proxy.getProtocol()).append("://").append(proxy.getHost()).toString();
 787  
     }
 788  
 
 789  
     /**
 790  
      * Returns the maven proxy.
 791  
      *
 792  
      * @return the maven proxy
 793  
      */
 794  
     private Proxy getMavenProxy() {
 795  0
         if (mavenSettings != null) {
 796  0
             final List<Proxy> proxies = mavenSettings.getProxies();
 797  0
             if (proxies != null && proxies.size() > 0) {
 798  0
                 if (mavenSettingsProxyId != null) {
 799  0
                     for (Proxy proxy : proxies) {
 800  0
                         if (mavenSettingsProxyId.equalsIgnoreCase(proxy.getId())) {
 801  0
                             return proxy;
 802  
                         }
 803  0
                     }
 804  0
                 } else if (proxies.size() == 1) {
 805  0
                     return proxies.get(0);
 806  
                 } else {
 807  0
                     throw new IllegalStateException("Ambiguous proxy definition");
 808  
                 }
 809  
             }
 810  
         }
 811  0
         return null;
 812  
     }
 813  
 
 814  
     /**
 815  
      * Takes the properties supplied and updates the dependency-check settings. Additionally, this sets the system
 816  
      * properties required to change the proxy url, port, and connection timeout.
 817  
      */
 818  
     private void populateSettings() {
 819  0
         Settings.initialize();
 820  0
         InputStream mojoProperties = null;
 821  
         try {
 822  0
             mojoProperties = this.getClass().getClassLoader().getResourceAsStream(PROPERTIES_FILE);
 823  0
             Settings.mergeProperties(mojoProperties);
 824  0
         } catch (IOException ex) {
 825  0
             logger.log(Level.WARNING, "Unable to load the dependency-check ant task.properties file.");
 826  0
             logger.log(Level.FINE, null, ex);
 827  
         } finally {
 828  0
             if (mojoProperties != null) {
 829  
                 try {
 830  0
                     mojoProperties.close();
 831  0
                 } catch (IOException ex) {
 832  0
                     logger.log(Level.FINEST, null, ex);
 833  0
                 }
 834  
             }
 835  
         }
 836  
 
 837  0
         Settings.setBoolean(Settings.KEYS.AUTO_UPDATE, autoUpdate);
 838  
 
 839  0
         final Proxy proxy = getMavenProxy();
 840  0
         if (proxy != null) {
 841  0
             Settings.setString(Settings.KEYS.PROXY_URL, getMavenSettingsProxyUrl(proxy));
 842  0
             Settings.setString(Settings.KEYS.PROXY_PORT, Integer.toString(proxy.getPort()));
 843  0
             final String userName = proxy.getUsername();
 844  0
             final String password = proxy.getPassword();
 845  0
             if (userName != null && password != null) {
 846  0
                 Settings.setString(Settings.KEYS.PROXY_USERNAME, userName);
 847  0
                 Settings.setString(Settings.KEYS.PROXY_PASSWORD, password);
 848  
             }
 849  
         }
 850  
 
 851  0
         if (proxyUrl != null && !proxyUrl.isEmpty()) {
 852  0
             Settings.setString(Settings.KEYS.PROXY_URL, proxyUrl);
 853  
         }
 854  0
         if (proxyPort != null && !proxyPort.isEmpty()) {
 855  0
             Settings.setString(Settings.KEYS.PROXY_PORT, proxyPort);
 856  
         }
 857  0
         if (proxyUsername != null && !proxyUsername.isEmpty()) {
 858  0
             Settings.setString(Settings.KEYS.PROXY_USERNAME, proxyUsername);
 859  
         }
 860  0
         if (proxyPassword != null && !proxyPassword.isEmpty()) {
 861  0
             Settings.setString(Settings.KEYS.PROXY_PASSWORD, proxyPassword);
 862  
         }
 863  0
         if (connectionTimeout != null && !connectionTimeout.isEmpty()) {
 864  0
             Settings.setString(Settings.KEYS.CONNECTION_TIMEOUT, connectionTimeout);
 865  
         }
 866  0
         if (suppressionFile != null && !suppressionFile.isEmpty()) {
 867  0
             Settings.setString(Settings.KEYS.SUPPRESSION_FILE, suppressionFile);
 868  
         }
 869  
 
 870  
         //File Type Analyzer Settings
 871  
         //JAR ANALYZER
 872  0
         Settings.setBoolean(Settings.KEYS.ANALYZER_JAR_ENABLED, jarAnalyzerEnabled);
 873  
         //NUSPEC ANALYZER
 874  0
         Settings.setBoolean(Settings.KEYS.ANALYZER_NUSPEC_ENABLED, nuspecAnalyzerEnabled);
 875  
         //NEXUS ANALYZER
 876  0
         Settings.setBoolean(Settings.KEYS.ANALYZER_NEXUS_ENABLED, nexusAnalyzerEnabled);
 877  0
         if (nexusUrl != null && !nexusUrl.isEmpty()) {
 878  0
             Settings.setString(Settings.KEYS.ANALYZER_NEXUS_URL, nexusUrl);
 879  
         }
 880  0
         Settings.setBoolean(Settings.KEYS.ANALYZER_NEXUS_PROXY, nexusUsesProxy);
 881  
         //ARCHIVE ANALYZER
 882  0
         Settings.setBoolean(Settings.KEYS.ANALYZER_ARCHIVE_ENABLED, archiveAnalyzerEnabled);
 883  0
         if (zipExtensions != null && !zipExtensions.isEmpty()) {
 884  0
             Settings.setString(Settings.KEYS.ADDITIONAL_ZIP_EXTENSIONS, zipExtensions);
 885  
         }
 886  
         //ASSEMBLY ANALYZER
 887  0
         Settings.setBoolean(Settings.KEYS.ANALYZER_ASSEMBLY_ENABLED, assemblyAnalyzerEnabled);
 888  0
         if (pathToMono != null && !pathToMono.isEmpty()) {
 889  0
             Settings.setString(Settings.KEYS.ANALYZER_ASSEMBLY_MONO_PATH, pathToMono);
 890  
         }
 891  
 
 892  
         //Database configuration
 893  0
         if (databaseDriverName != null && !databaseDriverName.isEmpty()) {
 894  0
             Settings.setString(Settings.KEYS.DB_DRIVER_NAME, databaseDriverName);
 895  
         }
 896  0
         if (databaseDriverPath != null && !databaseDriverPath.isEmpty()) {
 897  0
             Settings.setString(Settings.KEYS.DB_DRIVER_PATH, databaseDriverPath);
 898  
         }
 899  0
         if (connectionString != null && !connectionString.isEmpty()) {
 900  0
             Settings.setString(Settings.KEYS.DB_CONNECTION_STRING, connectionString);
 901  
         }
 902  0
         if (databaseUser != null && !databaseUser.isEmpty()) {
 903  0
             Settings.setString(Settings.KEYS.DB_USER, databaseUser);
 904  
         }
 905  0
         if (databasePassword != null && !databasePassword.isEmpty()) {
 906  0
             Settings.setString(Settings.KEYS.DB_PASSWORD, databasePassword);
 907  
         }
 908  
         // Data Directory
 909  0
         if (dataDirectory != null && !dataDirectory.isEmpty()) {
 910  0
             Settings.setString(Settings.KEYS.DATA_DIRECTORY, dataDirectory);
 911  
         }
 912  
 
 913  
         // Scope Exclusion
 914  0
         Settings.setBoolean(Settings.KEYS.SKIP_TEST_SCOPE, skipTestScope);
 915  0
         Settings.setBoolean(Settings.KEYS.SKIP_RUNTIME_SCOPE, skipRuntimeScope);
 916  0
         Settings.setBoolean(Settings.KEYS.SKIP_PROVIDED_SCOPE, skipProvidedScope);
 917  
 
 918  
         // CVE Data Mirroring
 919  0
         if (cveUrl12Modified != null && !cveUrl12Modified.isEmpty()) {
 920  0
             Settings.setString(Settings.KEYS.CVE_MODIFIED_12_URL, cveUrl12Modified);
 921  
         }
 922  0
         if (cveUrl20Modified != null && !cveUrl20Modified.isEmpty()) {
 923  0
             Settings.setString(Settings.KEYS.CVE_MODIFIED_20_URL, cveUrl20Modified);
 924  
         }
 925  0
         if (cveUrl12Base != null && !cveUrl12Base.isEmpty()) {
 926  0
             Settings.setString(Settings.KEYS.CVE_SCHEMA_1_2, cveUrl12Base);
 927  
         }
 928  0
         if (cveUrl20Base != null && !cveUrl20Base.isEmpty()) {
 929  0
             Settings.setString(Settings.KEYS.CVE_SCHEMA_2_0, cveUrl20Base);
 930  
         }
 931  
 
 932  0
     }
 933  
 
 934  
     /**
 935  
      * Executes the dependency-check and generates the report.
 936  
      *
 937  
      * @throws MojoExecutionException if a maven exception occurs
 938  
      * @throws MojoFailureException thrown if a CVSS score is found that is higher then the configured level
 939  
      */
 940  
     public void execute() throws MojoExecutionException, MojoFailureException {
 941  0
         Engine engine = null;
 942  
         try {
 943  0
             engine = executeDependencyCheck();
 944  0
             generateExternalReports(engine, outputDirectory);
 945  0
             if (this.showSummary) {
 946  0
                 showSummary(engine.getDependencies());
 947  
             }
 948  0
             if (this.failBuildOnCVSS <= 10) {
 949  0
                 checkForFailure(engine.getDependencies());
 950  
             }
 951  0
         } catch (DatabaseException ex) {
 952  0
             logger.log(Level.SEVERE,
 953  
                     "Unable to connect to the dependency-check database; analysis has stopped");
 954  0
             logger.log(Level.FINE, "", ex);
 955  
         } finally {
 956  0
             Settings.cleanup(true);
 957  0
             if (engine != null) {
 958  0
                 engine.cleanup();
 959  
             }
 960  
         }
 961  0
     }
 962  
 
 963  
     /**
 964  
      * Generates the Dependency-Check Site Report.
 965  
      *
 966  
      * @param sink the sink to write the report to
 967  
      * @param locale the locale to use when generating the report
 968  
      * @throws MavenReportException if a Maven report exception occurs
 969  
      */
 970  
     public void generate(@SuppressWarnings("deprecation") org.codehaus.doxia.sink.Sink sink,
 971  
             Locale locale) throws MavenReportException {
 972  0
         generate((Sink) sink, null, locale);
 973  0
     }
 974  
 
 975  
     /**
 976  
      * Generates the Dependency-Check Site Report.
 977  
      *
 978  
      * @param sink the sink to write the report to
 979  
      * @param sinkFactory the sink factory
 980  
      * @param locale the locale to use when generating the report
 981  
      * @throws MavenReportException if a maven report exception occurs
 982  
      */
 983  
     public void generate(Sink sink, SinkFactory sinkFactory, Locale locale) throws MavenReportException {
 984  0
         Engine engine = null;
 985  
         try {
 986  0
             engine = executeDependencyCheck();
 987  0
             if (this.externalReport) {
 988  0
                 generateExternalReports(engine, reportOutputDirectory);
 989  
             } else {
 990  0
                 generateMavenSiteReport(engine, sink);
 991  
             }
 992  0
         } catch (DatabaseException ex) {
 993  0
             logger.log(Level.SEVERE,
 994  
                     "Unable to connect to the dependency-check database; analysis has stopped");
 995  0
             logger.log(Level.FINE, "", ex);
 996  
         } finally {
 997  0
             Settings.cleanup(true);
 998  0
             if (engine != null) {
 999  0
                 engine.cleanup();
 1000  
             }
 1001  
         }
 1002  0
     }
 1003  
 
 1004  
     // <editor-fold defaultstate="collapsed" desc="required setter/getter methods">
 1005  
     /**
 1006  
      * Returns the output name.
 1007  
      *
 1008  
      * @return the output name
 1009  
      */
 1010  
     public String getOutputName() {
 1011  0
         if ("HTML".equalsIgnoreCase(this.format)
 1012  
                 || "ALL".equalsIgnoreCase(this.format)) {
 1013  0
             return "dependency-check-report";
 1014  0
         } else if ("XML".equalsIgnoreCase(this.format)) {
 1015  0
             return "dependency-check-report.xml#";
 1016  0
         } else if ("VULN".equalsIgnoreCase(this.format)) {
 1017  0
             return "dependency-check-vulnerability";
 1018  
         } else {
 1019  0
             logger.log(Level.WARNING, "Unknown report format used during site generation.");
 1020  0
             return "dependency-check-report";
 1021  
         }
 1022  
     }
 1023  
 
 1024  
     /**
 1025  
      * Returns the category name.
 1026  
      *
 1027  
      * @return the category name
 1028  
      */
 1029  
     public String getCategoryName() {
 1030  0
         return MavenReport.CATEGORY_PROJECT_REPORTS;
 1031  
     }
 1032  
 
 1033  
     /**
 1034  
      * Returns the report name.
 1035  
      *
 1036  
      * @param locale the location
 1037  
      * @return the report name
 1038  
      */
 1039  
     public String getName(Locale locale) {
 1040  0
         return name;
 1041  
     }
 1042  
 
 1043  
     /**
 1044  
      * Sets the Reporting output directory.
 1045  
      *
 1046  
      * @param directory the output directory
 1047  
      */
 1048  
     public void setReportOutputDirectory(File directory) {
 1049  0
         reportOutputDirectory = directory;
 1050  0
     }
 1051  
 
 1052  
     /**
 1053  
      * Returns the output directory.
 1054  
      *
 1055  
      * @return the output directory
 1056  
      */
 1057  
     public File getReportOutputDirectory() {
 1058  0
         return reportOutputDirectory;
 1059  
     }
 1060  
 
 1061  
     /**
 1062  
      * Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.
 1063  
      *
 1064  
      * @param locale The Locale to get the description for
 1065  
      * @return the description
 1066  
      */
 1067  
     public String getDescription(Locale locale) {
 1068  0
         return description;
 1069  
     }
 1070  
 
 1071  
     /**
 1072  
      * Returns whether this is an external report.
 1073  
      *
 1074  
      * @return true or false;
 1075  
      */
 1076  
     public boolean isExternalReport() {
 1077  0
         return externalReport;
 1078  
     }
 1079  
 
 1080  
     /**
 1081  
      * Returns whether or not the plugin can generate a report.
 1082  
      *
 1083  
      * @return true
 1084  
      */
 1085  
     public boolean canGenerateReport() {
 1086  0
         return true;
 1087  
     }
 1088  
     // </editor-fold>
 1089  
 
 1090  
     /**
 1091  
      * Checks to see if a vulnerability has been identified with a CVSS score that is above the threshold set in the
 1092  
      * configuration.
 1093  
      *
 1094  
      * @param dependencies the list of dependency objects
 1095  
      * @throws MojoFailureException thrown if a CVSS score is found that is higher then the threshold set
 1096  
      */
 1097  
     private void checkForFailure(List<Dependency> dependencies) throws MojoFailureException {
 1098  0
         final StringBuilder ids = new StringBuilder();
 1099  0
         for (Dependency d : dependencies) {
 1100  0
             boolean addName = true;
 1101  0
             for (Vulnerability v : d.getVulnerabilities()) {
 1102  0
                 if (v.getCvssScore() >= failBuildOnCVSS) {
 1103  0
                     if (addName) {
 1104  0
                         addName = false;
 1105  0
                         ids.append(NEW_LINE).append(d.getFileName()).append(": ");
 1106  0
                         ids.append(v.getName());
 1107  
                     } else {
 1108  0
                         ids.append(", ").append(v.getName());
 1109  
                     }
 1110  
                 }
 1111  0
             }
 1112  0
         }
 1113  0
         if (ids.length() > 0) {
 1114  0
             final String msg = String.format("%n%nDependency-Check Failure:%n"
 1115  
                     + "One or more dependencies were identified with vulnerabilities that have a CVSS score greater then '%.1f': %s%n"
 1116  
                     + "See the dependency-check report for more details.%n%n", failBuildOnCVSS, ids.toString());
 1117  0
             throw new MojoFailureException(msg);
 1118  
         }
 1119  0
     }
 1120  
 
 1121  
     /**
 1122  
      * Generates a warning message listing a summary of dependencies and their associated CPE and CVE entries.
 1123  
      *
 1124  
      * @param dependencies a list of dependency objects
 1125  
      */
 1126  
     private void showSummary(List<Dependency> dependencies) {
 1127  0
         final StringBuilder summary = new StringBuilder();
 1128  0
         for (Dependency d : dependencies) {
 1129  0
             boolean firstEntry = true;
 1130  0
             final StringBuilder ids = new StringBuilder();
 1131  0
             for (Vulnerability v : d.getVulnerabilities()) {
 1132  0
                 if (firstEntry) {
 1133  0
                     firstEntry = false;
 1134  
                 } else {
 1135  0
                     ids.append(", ");
 1136  
                 }
 1137  0
                 ids.append(v.getName());
 1138  0
             }
 1139  0
             if (ids.length() > 0) {
 1140  0
                 summary.append(d.getFileName()).append(" (");
 1141  0
                 firstEntry = true;
 1142  0
                 for (Identifier id : d.getIdentifiers()) {
 1143  0
                     if (firstEntry) {
 1144  0
                         firstEntry = false;
 1145  
                     } else {
 1146  0
                         summary.append(", ");
 1147  
                     }
 1148  0
                     summary.append(id.getValue());
 1149  0
                 }
 1150  0
                 summary.append(") : ").append(ids).append(NEW_LINE);
 1151  
             }
 1152  0
         }
 1153  0
         if (summary.length() > 0) {
 1154  0
             final String msg = String.format("%n%n"
 1155  
                     + "One or more dependencies were identified with known vulnerabilities:%n%n%s"
 1156  
                     + "%n%nSee the dependency-check report for more details.%n%n", summary.toString());
 1157  0
             logger.log(Level.WARNING, msg);
 1158  
         }
 1159  0
     }
 1160  
 }