View Javadoc
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  public class DependencyCheckMojo extends AbstractMojo implements MavenMultiPageReport {
71  
72      /**
73       * Logger field reference.
74       */
75      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      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     @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     @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     @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     @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     @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     @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     @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     @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
198     @Parameter(property = "proxyPassword", defaultValue = "", required = false)
199     @Deprecated
200     private String proxyPassword = null;
201     /**
202      * The Connection Timeout.
203      */
204     @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     @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     @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     @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     @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     @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     @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     @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     @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     @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     @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     @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         final InputStream in = DependencyCheckMojo.class.getClassLoader().getResourceAsStream(LOG_PROPERTIES_FILE);
361         LogUtils.prepareLogger(in, logFile);
362 
363         populateSettings();
364         final Engine engine = new Engine();
365 
366         final Set<Artifact> artifacts = project.getArtifacts();
367         for (Artifact a : artifacts) {
368             if (skipTestScope && Artifact.SCOPE_TEST.equals(a.getScope())) {
369                 continue;
370             }
371 
372             if (skipProvidedScope && Artifact.SCOPE_PROVIDED.equals(a.getScope())) {
373                 continue;
374             }
375 
376             if (skipRuntimeScope && !Artifact.SCOPE_RUNTIME.equals(a.getScope())) {
377                 continue;
378             }
379 
380             engine.scan(a.getFile().getAbsolutePath());
381         }
382         engine.analyzeDependencies();
383 
384         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         DatabaseProperties prop = null;
395         CveDB cve = null;
396         try {
397             cve = new CveDB();
398             cve.open();
399             prop = cve.getDatabaseProperties();
400         } catch (DatabaseException ex) {
401             logger.log(Level.FINE, "Unable to retrieve DB Properties", ex);
402         } finally {
403             if (cve != null) {
404                 cve.close();
405             }
406         }
407         final ReportGenerator r = new ReportGenerator(project.getName(), engine.getDependencies(), engine.getAnalyzers(), prop);
408         try {
409             r.generateReports(outDirectory.getCanonicalPath(), format);
410         } catch (IOException ex) {
411             logger.log(Level.SEVERE,
412                     "Unexpected exception occurred during analysis; please see the verbose error log for more details.");
413             logger.log(Level.FINE, null, ex);
414         } catch (Throwable ex) {
415             logger.log(Level.SEVERE,
416                     "Unexpected exception occurred during analysis; please see the verbose error log for more details.");
417             logger.log(Level.FINE, null, ex);
418         }
419     }
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         final List<Dependency> dependencies = engine.getDependencies();
429 
430         writeSiteReportHeader(sink, project.getName());
431         writeSiteReportTOC(sink, dependencies);
432 
433         int cnt = 0;
434         for (Dependency d : dependencies) {
435             writeSiteReportDependencyHeader(sink, d);
436             cnt = writeSiteReportDependencyEvidenceUsed(d, cnt, sink);
437             cnt = writeSiteReportDependencyRelatedDependencies(d, cnt, sink);
438             writeSiteReportDependencyIdentifiers(d, sink);
439             writeSiteReportDependencyVulnerabilities(d, sink, cnt);
440         }
441         sink.body_();
442     }
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         int cnt = collapsibleHeaderCount;
454         if (d.getVulnerabilities() != null && !d.getVulnerabilities().isEmpty()) {
455             for (Vulnerability v : d.getVulnerabilities()) {
456 
457                 sink.paragraph();
458                 sink.bold();
459                 try {
460                     sink.link("http://web.nvd.nist.gov/view/vuln/detail?vulnId=" + URLEncoder.encode(v.getName(), "US-ASCII"));
461                     sink.text(v.getName());
462                     sink.link_();
463                     sink.bold_();
464                 } catch (UnsupportedEncodingException ex) {
465                     sink.text(v.getName());
466                     sink.bold_();
467                     sink.lineBreak();
468                     sink.text("http://web.nvd.nist.gov/view/vuln/detail?vulnId=" + v.getName());
469                 }
470                 sink.paragraph_();
471                 sink.paragraph();
472                 sink.text("Severity: ");
473                 if (v.getCvssScore() < 4.0) {
474                     sink.text("Low");
475                 } else {
476                     if (v.getCvssScore() >= 7.0) {
477                         sink.text("High");
478                     } else {
479                         sink.text("Medium");
480                     }
481                 }
482                 sink.lineBreak();
483                 sink.text("CVSS Score: " + v.getCvssScore());
484                 if (v.getCwe() != null && !v.getCwe().isEmpty()) {
485                     sink.lineBreak();
486                     sink.text("CWE: ");
487                     sink.text(v.getCwe());
488                 }
489                 sink.paragraph_();
490                 sink.paragraph();
491                 sink.text(v.getDescription());
492                 if (v.getReferences() != null && !v.getReferences().isEmpty()) {
493                     sink.list();
494                     for (Reference ref : v.getReferences()) {
495                         sink.listItem();
496                         sink.text(ref.getSource());
497                         sink.text(" - ");
498                         sink.link(ref.getUrl());
499                         sink.text(ref.getName());
500                         sink.link_();
501                         sink.listItem_();
502                     }
503                     sink.list_();
504                 }
505                 sink.paragraph_();
506                 if (v.getVulnerableSoftware() != null && !v.getVulnerableSoftware().isEmpty()) {
507                     sink.paragraph();
508 
509                     cnt += 1;
510                     sink.rawText("Vulnerable Software <a href=\"javascript:toggleElement(this, 'vulnSoft" + cnt + "')\">[-]</a>");
511                     sink.rawText("<div id=\"vulnSoft" + cnt + "\" style=\"display:block\">");
512                     sink.list();
513                     for (VulnerableSoftware vs : v.getVulnerableSoftware()) {
514                         sink.listItem();
515                         try {
516                             sink.link("http://web.nvd.nist.gov/view/vuln/search-results?cpe=" + URLEncoder.encode(vs.getName(), "US-ASCII"));
517                             sink.text(vs.getName());
518                             sink.link_();
519                             if (vs.hasPreviousVersion()) {
520                                 sink.text(" and all previous versions.");
521                             }
522                         } catch (UnsupportedEncodingException ex) {
523                             sink.text(vs.getName());
524                             if (vs.hasPreviousVersion()) {
525                                 sink.text(" and all previous versions.");
526                             }
527                             sink.text(" (http://web.nvd.nist.gov/view/vuln/search-results?cpe=" + vs.getName() + ")");
528                         }
529 
530                         sink.listItem_();
531                     }
532                     sink.list_();
533                     sink.rawText("</div>");
534                     sink.paragraph_();
535                 }
536             }
537         }
538     }
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         if (d.getIdentifiers() != null && !d.getIdentifiers().isEmpty()) {
548             sink.sectionTitle4();
549             sink.text("Identifiers");
550             sink.sectionTitle4_();
551             sink.list();
552             for (Identifier i : d.getIdentifiers()) {
553                 sink.listItem();
554                 sink.text(i.getType());
555                 sink.text(": ");
556                 if (i.getUrl() != null && i.getUrl().length() > 0) {
557                     sink.link(i.getUrl());
558                     sink.text(i.getValue());
559                     sink.link_();
560                 } else {
561                     sink.text(i.getValue());
562                 }
563                 if (i.getDescription() != null && i.getDescription().length() > 0) {
564                     sink.lineBreak();
565                     sink.text(i.getDescription());
566                 }
567                 sink.listItem_();
568             }
569             sink.list_();
570         }
571     }
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         int cnt = collapsibleHeaderCount;
583         if (d.getRelatedDependencies() != null && !d.getRelatedDependencies().isEmpty()) {
584             cnt += 1;
585             sink.sectionTitle4();
586             sink.rawText("Related Dependencies <a href=\"javascript:toggleElement(this, 'related" + cnt + "')\">[+]</a>");
587             sink.sectionTitle4_();
588             sink.rawText("<div id=\"related" + cnt + "\" style=\"display:none\">");
589             sink.list();
590             for (Dependency r : d.getRelatedDependencies()) {
591                 sink.listItem();
592                 sink.text(r.getFileName());
593                 sink.list();
594                 writeListItem(sink, "File Path: " + r.getFilePath());
595                 writeListItem(sink, "SHA1: " + r.getSha1sum());
596                 writeListItem(sink, "MD5: " + r.getMd5sum());
597                 sink.list_();
598                 sink.listItem_();
599             }
600             sink.list_();
601             sink.rawText("</div>");
602         }
603         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         int cnt = collapsibleHeaderCount;
616         if (d.getEvidenceUsed() != null && d.getEvidenceUsed().size() > 0) {
617             cnt += 1;
618             sink.sectionTitle4();
619             sink.rawText("Evidence Collected <a href=\"javascript:toggleElement(this, 'evidence" + cnt + "')\">[+]</a>");
620             sink.sectionTitle4_();
621             sink.rawText("<div id=\"evidence" + cnt + "\" style=\"display:none\">");
622             sink.table();
623             sink.tableRow();
624             writeTableHeaderCell(sink, "Source");
625             writeTableHeaderCell(sink, "Name");
626             writeTableHeaderCell(sink, "Value");
627             sink.tableRow_();
628             for (Evidence e : d.getEvidenceUsed()) {
629                 sink.tableRow();
630                 writeTableCell(sink, e.getSource());
631                 writeTableCell(sink, e.getName());
632                 writeTableCell(sink, e.getValue());
633                 sink.tableRow_();
634             }
635             sink.table_();
636             sink.rawText("</div>");
637         }
638         return cnt;
639     }
640 
641     /**
642      * Writes the dependency header to the site report.
643      *
644      * @param d the dependency
645      * @param sink the sink to write the data to
646      */
647     private void writeSiteReportDependencyHeader(Sink sink, Dependency d) {
648         sink.sectionTitle2();
649         sink.anchor("sha1" + d.getSha1sum());
650         sink.text(d.getFileName());
651         sink.anchor_();
652         sink.sectionTitle2_();
653         if (d.getDescription() != null && d.getDescription().length() > 0) {
654             sink.paragraph();
655             sink.bold();
656             sink.text("Description: ");
657             sink.bold_();
658             sink.text(d.getDescription());
659             sink.paragraph_();
660         }
661         if (d.getLicense() != null && d.getLicense().length() > 0) {
662             sink.paragraph();
663             sink.bold();
664             sink.text("License: ");
665             sink.bold_();
666             if (d.getLicense().startsWith("http://") && !d.getLicense().contains(" ")) {
667                 sink.link(d.getLicense());
668                 sink.text(d.getLicense());
669                 sink.link_();
670             } else {
671                 sink.text(d.getLicense());
672             }
673             sink.paragraph_();
674         }
675     }
676 
677     /**
678      * Adds a list item to the site report.
679      *
680      * @param sink the sink to write the data to
681      * @param text the text to write
682      */
683     private void writeListItem(Sink sink, String text) {
684         sink.listItem();
685         sink.text(text);
686         sink.listItem_();
687     }
688 
689     /**
690      * Adds a table cell to the site report.
691      *
692      * @param sink the sink to write the data to
693      * @param text the text to write
694      */
695     private void writeTableCell(Sink sink, String text) {
696         sink.tableCell();
697         sink.text(text);
698         sink.tableCell_();
699     }
700 
701     /**
702      * Adds a table header cell to the site report.
703      *
704      * @param sink the sink to write the data to
705      * @param text the text to write
706      */
707     private void writeTableHeaderCell(Sink sink, String text) {
708         sink.tableHeaderCell();
709         sink.text(text);
710         sink.tableHeaderCell_();
711     }
712 
713     /**
714      * Writes the TOC for the site report.
715      *
716      * @param sink the sink to write the data to
717      * @param dependencies the dependencies that are being reported on
718      */
719     private void writeSiteReportTOC(Sink sink, final List<Dependency> dependencies) {
720         sink.list();
721         for (Dependency d : dependencies) {
722             sink.listItem();
723             sink.link("#sha1" + d.getSha1sum());
724             sink.text(d.getFileName());
725             sink.link_();
726             if (!d.getVulnerabilities().isEmpty()) {
727                 sink.rawText(" <font style=\"color:red\">•</font>");
728             }
729             if (!d.getRelatedDependencies().isEmpty()) {
730                 sink.list();
731                 for (Dependency r : d.getRelatedDependencies()) {
732                     writeListItem(sink, r.getFileName());
733                 }
734                 sink.list_();
735             }
736             sink.listItem_();
737         }
738         sink.list_();
739     }
740 
741     /**
742      * Writes the site report header.
743      *
744      * @param sink the sink to write the data to
745      * @param projectName the name of the project
746      */
747     private void writeSiteReportHeader(Sink sink, String projectName) {
748         sink.head();
749         sink.title();
750         sink.text("Dependency-Check Report: " + projectName);
751         sink.title_();
752         sink.head_();
753         sink.body();
754         sink.rawText("<script type=\"text/javascript\">");
755         sink.rawText("function toggleElement(el, targetId) {");
756         sink.rawText("if (el.innerText == '[+]') {");
757         sink.rawText("    el.innerText = '[-]';");
758         sink.rawText("    document.getElementById(targetId).style.display='block';");
759         sink.rawText("} else {");
760         sink.rawText("    el.innerText = '[+]';");
761         sink.rawText("    document.getElementById(targetId).style.display='none';");
762         sink.rawText("}");
763 
764         sink.rawText("}");
765         sink.rawText("</script>");
766         sink.section1();
767         sink.sectionTitle1();
768         sink.text("Project: " + projectName);
769         sink.sectionTitle1_();
770         sink.date();
771         final Date now = new Date();
772         sink.text(DateFormat.getDateTimeInstance().format(now));
773         sink.date_();
774         sink.section1_();
775     }
776     // </editor-fold>
777 
778     /**
779      * Returns the maven settings proxy url.
780      *
781      * @param proxy the maven proxy
782      * @return the proxy url
783      */
784     private String getMavenSettingsProxyUrl(Proxy proxy) {
785         return new StringBuilder(proxy.getProtocol()).append("://").append(proxy.getHost()).toString();
786     }
787 
788     /**
789      * Returns the maven proxy.
790      *
791      * @return the maven proxy
792      */
793     private Proxy getMavenProxy() {
794         if (mavenSettings != null) {
795             final List<Proxy> proxies = mavenSettings.getProxies();
796             if (proxies != null && proxies.size() > 0) {
797                 if (mavenSettingsProxyId != null) {
798                     for (Proxy proxy : proxies) {
799                         if (mavenSettingsProxyId.equalsIgnoreCase(proxy.getId())) {
800                             return proxy;
801                         }
802                     }
803                 } else if (proxies.size() == 1) {
804                     return proxies.get(0);
805                 } else {
806                     throw new IllegalStateException("Ambiguous proxy definition");
807                 }
808             }
809         }
810         return null;
811     }
812 
813     /**
814      * Takes the properties supplied and updates the dependency-check settings. Additionally, this sets the system
815      * properties required to change the proxy url, port, and connection timeout.
816      */
817     private void populateSettings() {
818         Settings.initialize();
819         InputStream mojoProperties = null;
820         try {
821             mojoProperties = this.getClass().getClassLoader().getResourceAsStream(PROPERTIES_FILE);
822             Settings.mergeProperties(mojoProperties);
823         } catch (IOException ex) {
824             logger.log(Level.WARNING, "Unable to load the dependency-check ant task.properties file.");
825             logger.log(Level.FINE, null, ex);
826         } finally {
827             if (mojoProperties != null) {
828                 try {
829                     mojoProperties.close();
830                 } catch (IOException ex) {
831                     logger.log(Level.FINEST, null, ex);
832                 }
833             }
834         }
835 
836         Settings.setBoolean(Settings.KEYS.AUTO_UPDATE, autoUpdate);
837 
838         final Proxy proxy = getMavenProxy();
839         if (proxy != null) {
840             Settings.setString(Settings.KEYS.PROXY_URL, getMavenSettingsProxyUrl(proxy));
841             Settings.setString(Settings.KEYS.PROXY_PORT, Integer.toString(proxy.getPort()));
842             final String userName = proxy.getUsername();
843             final String password = proxy.getPassword();
844             if (userName != null && password != null) {
845                 Settings.setString(Settings.KEYS.PROXY_USERNAME, userName);
846                 Settings.setString(Settings.KEYS.PROXY_PASSWORD, password);
847             }
848         }
849 
850         if (proxyUrl != null && !proxyUrl.isEmpty()) {
851             Settings.setString(Settings.KEYS.PROXY_URL, proxyUrl);
852         }
853         if (proxyPort != null && !proxyPort.isEmpty()) {
854             Settings.setString(Settings.KEYS.PROXY_PORT, proxyPort);
855         }
856         if (proxyUsername != null && !proxyUsername.isEmpty()) {
857             Settings.setString(Settings.KEYS.PROXY_USERNAME, proxyUsername);
858         }
859         if (proxyPassword != null && !proxyPassword.isEmpty()) {
860             Settings.setString(Settings.KEYS.PROXY_PASSWORD, proxyPassword);
861         }
862         if (connectionTimeout != null && !connectionTimeout.isEmpty()) {
863             Settings.setString(Settings.KEYS.CONNECTION_TIMEOUT, connectionTimeout);
864         }
865         if (suppressionFile != null && !suppressionFile.isEmpty()) {
866             Settings.setString(Settings.KEYS.SUPPRESSION_FILE, suppressionFile);
867         }
868 
869         //File Type Analyzer Settings
870         //JAR ANALYZER
871         Settings.setBoolean(Settings.KEYS.ANALYZER_JAR_ENABLED, jarAnalyzerEnabled);
872         //NUSPEC ANALYZER
873         Settings.setBoolean(Settings.KEYS.ANALYZER_NUSPEC_ENABLED, nuspecAnalyzerEnabled);
874         //NEXUS ANALYZER
875         Settings.setBoolean(Settings.KEYS.ANALYZER_NEXUS_ENABLED, nexusAnalyzerEnabled);
876         if (nexusUrl != null && !nexusUrl.isEmpty()) {
877             Settings.setString(Settings.KEYS.ANALYZER_NEXUS_URL, nexusUrl);
878         }
879         Settings.setBoolean(Settings.KEYS.ANALYZER_NEXUS_PROXY, nexusUsesProxy);
880         //ARCHIVE ANALYZER
881         Settings.setBoolean(Settings.KEYS.ANALYZER_ARCHIVE_ENABLED, archiveAnalyzerEnabled);
882         if (zipExtensions != null && !zipExtensions.isEmpty()) {
883             Settings.setString(Settings.KEYS.ADDITIONAL_ZIP_EXTENSIONS, zipExtensions);
884         }
885         //ASSEMBLY ANALYZER
886         Settings.setBoolean(Settings.KEYS.ANALYZER_ASSEMBLY_ENABLED, assemblyAnalyzerEnabled);
887         if (pathToMono != null && !pathToMono.isEmpty()) {
888             Settings.setString(Settings.KEYS.ANALYZER_ASSEMBLY_MONO_PATH, pathToMono);
889         }
890 
891         //Database configuration
892         if (databaseDriverName != null && !databaseDriverName.isEmpty()) {
893             Settings.setString(Settings.KEYS.DB_DRIVER_NAME, databaseDriverName);
894         }
895         if (databaseDriverPath != null && !databaseDriverPath.isEmpty()) {
896             Settings.setString(Settings.KEYS.DB_DRIVER_PATH, databaseDriverPath);
897         }
898         if (connectionString != null && !connectionString.isEmpty()) {
899             Settings.setString(Settings.KEYS.DB_CONNECTION_STRING, connectionString);
900         }
901         if (databaseUser != null && !databaseUser.isEmpty()) {
902             Settings.setString(Settings.KEYS.DB_USER, databaseUser);
903         }
904         if (databasePassword != null && !databasePassword.isEmpty()) {
905             Settings.setString(Settings.KEYS.DB_PASSWORD, databasePassword);
906         }
907         // Data Directory
908         if (dataDirectory != null && !dataDirectory.isEmpty()) {
909             Settings.setString(Settings.KEYS.DATA_DIRECTORY, dataDirectory);
910         }
911 
912         // Scope Exclusion
913         Settings.setBoolean(Settings.KEYS.SKIP_TEST_SCOPE, skipTestScope);
914         Settings.setBoolean(Settings.KEYS.SKIP_RUNTIME_SCOPE, skipRuntimeScope);
915         Settings.setBoolean(Settings.KEYS.SKIP_PROVIDED_SCOPE, skipProvidedScope);
916 
917         // CVE Data Mirroring
918         if (cveUrl12Modified != null && !cveUrl12Modified.isEmpty()) {
919             Settings.setString(Settings.KEYS.CVE_MODIFIED_12_URL, cveUrl12Modified);
920         }
921         if (cveUrl20Modified != null && !cveUrl20Modified.isEmpty()) {
922             Settings.setString(Settings.KEYS.CVE_MODIFIED_20_URL, cveUrl20Modified);
923         }
924         if (cveUrl12Base != null && !cveUrl12Base.isEmpty()) {
925             Settings.setString(Settings.KEYS.CVE_SCHEMA_1_2, cveUrl12Base);
926         }
927         if (cveUrl20Base != null && !cveUrl20Base.isEmpty()) {
928             Settings.setString(Settings.KEYS.CVE_SCHEMA_2_0, cveUrl20Base);
929         }
930 
931     }
932 
933     /**
934      * Executes the dependency-check and generates the report.
935      *
936      * @throws MojoExecutionException if a maven exception occurs
937      * @throws MojoFailureException thrown if a CVSS score is found that is higher then the configured level
938      */
939     public void execute() throws MojoExecutionException, MojoFailureException {
940         Engine engine = null;
941         try {
942             engine = executeDependencyCheck();
943             generateExternalReports(engine, outputDirectory);
944             if (this.showSummary) {
945                 showSummary(engine.getDependencies());
946             }
947             if (this.failBuildOnCVSS <= 10) {
948                 checkForFailure(engine.getDependencies());
949             }
950         } catch (DatabaseException ex) {
951             logger.log(Level.SEVERE,
952                     "Unable to connect to the dependency-check database; analysis has stopped");
953             logger.log(Level.FINE, "", ex);
954         } finally {
955             Settings.cleanup();
956             if (engine != null) {
957                 engine.cleanup();
958             }
959         }
960     }
961 
962     /**
963      * Generates the Dependency-Check Site Report.
964      *
965      * @param sink the sink to write the report to
966      * @param locale the locale to use when generating the report
967      * @throws MavenReportException if a Maven report exception occurs
968      */
969     public void generate(@SuppressWarnings("deprecation") org.codehaus.doxia.sink.Sink sink,
970             Locale locale) throws MavenReportException {
971         generate((Sink) sink, null, locale);
972     }
973 
974     /**
975      * Generates the Dependency-Check Site Report.
976      *
977      * @param sink the sink to write the report to
978      * @param sinkFactory the sink factory
979      * @param locale the locale to use when generating the report
980      * @throws MavenReportException if a maven report exception occurs
981      */
982     public void generate(Sink sink, SinkFactory sinkFactory, Locale locale) throws MavenReportException {
983         Engine engine = null;
984         try {
985             engine = executeDependencyCheck();
986             if (this.externalReport) {
987                 generateExternalReports(engine, reportOutputDirectory);
988             } else {
989                 generateMavenSiteReport(engine, sink);
990             }
991         } catch (DatabaseException ex) {
992             logger.log(Level.SEVERE,
993                     "Unable to connect to the dependency-check database; analysis has stopped");
994             logger.log(Level.FINE, "", ex);
995         } finally {
996             Settings.cleanup();
997             if (engine != null) {
998                 engine.cleanup();
999             }
1000         }
1001     }
1002 
1003     // <editor-fold defaultstate="collapsed" desc="required setter/getter methods">
1004     /**
1005      * Returns the output name.
1006      *
1007      * @return the output name
1008      */
1009     public String getOutputName() {
1010         if ("HTML".equalsIgnoreCase(this.format)
1011                 || "ALL".equalsIgnoreCase(this.format)) {
1012             return "dependency-check-report";
1013         } else if ("XML".equalsIgnoreCase(this.format)) {
1014             return "dependency-check-report.xml#";
1015         } else if ("VULN".equalsIgnoreCase(this.format)) {
1016             return "dependency-check-vulnerability";
1017         } else {
1018             logger.log(Level.WARNING, "Unknown report format used during site generation.");
1019             return "dependency-check-report";
1020         }
1021     }
1022 
1023     /**
1024      * Returns the category name.
1025      *
1026      * @return the category name
1027      */
1028     public String getCategoryName() {
1029         return MavenReport.CATEGORY_PROJECT_REPORTS;
1030     }
1031 
1032     /**
1033      * Returns the report name.
1034      *
1035      * @param locale the location
1036      * @return the report name
1037      */
1038     public String getName(Locale locale) {
1039         return name;
1040     }
1041 
1042     /**
1043      * Sets the Reporting output directory.
1044      *
1045      * @param directory the output directory
1046      */
1047     public void setReportOutputDirectory(File directory) {
1048         reportOutputDirectory = directory;
1049     }
1050 
1051     /**
1052      * Returns the output directory.
1053      *
1054      * @return the output directory
1055      */
1056     public File getReportOutputDirectory() {
1057         return reportOutputDirectory;
1058     }
1059 
1060     /**
1061      * Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.
1062      *
1063      * @param locale The Locale to get the description for
1064      * @return the description
1065      */
1066     public String getDescription(Locale locale) {
1067         return description;
1068     }
1069 
1070     /**
1071      * Returns whether this is an external report.
1072      *
1073      * @return true or false;
1074      */
1075     public boolean isExternalReport() {
1076         return externalReport;
1077     }
1078 
1079     /**
1080      * Returns whether or not the plugin can generate a report.
1081      *
1082      * @return true
1083      */
1084     public boolean canGenerateReport() {
1085         return true;
1086     }
1087     // </editor-fold>
1088 
1089     /**
1090      * Checks to see if a vulnerability has been identified with a CVSS score that is above the threshold set in the
1091      * configuration.
1092      *
1093      * @param dependencies the list of dependency objects
1094      * @throws MojoFailureException thrown if a CVSS score is found that is higher then the threshold set
1095      */
1096     private void checkForFailure(List<Dependency> dependencies) throws MojoFailureException {
1097         final StringBuilder ids = new StringBuilder();
1098         for (Dependency d : dependencies) {
1099             boolean addName = true;
1100             for (Vulnerability v : d.getVulnerabilities()) {
1101                 if (v.getCvssScore() >= failBuildOnCVSS) {
1102                     if (addName) {
1103                         addName = false;
1104                         ids.append(NEW_LINE).append(d.getFileName()).append(": ");
1105                         ids.append(v.getName());
1106                     } else {
1107                         ids.append(", ").append(v.getName());
1108                     }
1109                 }
1110             }
1111         }
1112         if (ids.length() > 0) {
1113             final String msg = String.format("%n%nDependency-Check Failure:%n"
1114                     + "One or more dependencies were identified with vulnerabilities that have a CVSS score greater then '%.1f': %s%n"
1115                     + "See the dependency-check report for more details.%n%n", failBuildOnCVSS, ids.toString());
1116             throw new MojoFailureException(msg);
1117         }
1118     }
1119 
1120     /**
1121      * Generates a warning message listing a summary of dependencies and their associated CPE and CVE entries.
1122      *
1123      * @param dependencies a list of dependency objects
1124      */
1125     private void showSummary(List<Dependency> dependencies) {
1126         final StringBuilder summary = new StringBuilder();
1127         for (Dependency d : dependencies) {
1128             boolean firstEntry = true;
1129             final StringBuilder ids = new StringBuilder();
1130             for (Vulnerability v : d.getVulnerabilities()) {
1131                 if (firstEntry) {
1132                     firstEntry = false;
1133                 } else {
1134                     ids.append(", ");
1135                 }
1136                 ids.append(v.getName());
1137             }
1138             if (ids.length() > 0) {
1139                 summary.append(d.getFileName()).append(" (");
1140                 firstEntry = true;
1141                 for (Identifier id : d.getIdentifiers()) {
1142                     if (firstEntry) {
1143                         firstEntry = false;
1144                     } else {
1145                         summary.append(", ");
1146                     }
1147                     summary.append(id.getValue());
1148                 }
1149                 summary.append(") : ").append(ids).append(NEW_LINE);
1150             }
1151         }
1152         if (summary.length() > 0) {
1153             final String msg = String.format("%n%n"
1154                     + "One or more dependencies were identified with known vulnerabilities:%n%n%s"
1155                     + "%n%nSee the dependency-check report for more details.%n%n", summary.toString());
1156             logger.log(Level.WARNING, msg);
1157         }
1158     }
1159 }