1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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
64
65
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
74
75 private final Logger logger = Logger.getLogger(DependencyCheckMojo.class.getName());
76
77
78
79
80 private static final String PROPERTIES_FILE = "mojo.properties";
81
82
83
84 private static final String LOG_PROPERTIES_FILE = "log.properties";
85
86
87
88 private static final String NEW_LINE = System.getProperty("line.separator", "\n").intern();
89
90
91
92
93 @Component
94 private MavenProject project;
95
96
97
98 @Parameter(property = "logfile", defaultValue = "")
99 private String logFile;
100
101
102
103 @Parameter(property = "name", defaultValue = "Dependency-Check")
104 private String name;
105
106
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
114
115
116 @Parameter(property = "reportOutputDirectory", defaultValue = "${project.reporting.outputDirectory}", required = true)
117 private File reportOutputDirectory;
118
119
120
121 @Parameter(defaultValue = "${project.build.directory}", required = true)
122 private File outputDirectory;
123
124
125
126
127 @SuppressWarnings("CanBeFinal")
128 @Parameter(property = "failBuildOnCVSS", defaultValue = "11", required = true)
129 private float failBuildOnCVSS = 11;
130
131
132
133
134 @SuppressWarnings("CanBeFinal")
135 @Parameter(property = "autoupdate", defaultValue = "true", required = true)
136 private boolean autoUpdate = true;
137
138
139
140
141 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
142 @Parameter(property = "format", defaultValue = "HTML", required = true)
143 private String format = "HTML";
144
145
146
147 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
148 @Parameter(property = "externalReport", defaultValue = "false", required = true)
149 private boolean externalReport = false;
150
151
152
153
154
155 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
156 @Parameter(property = "proxyUrl", defaultValue = "", required = false)
157 @Deprecated
158 private String proxyUrl = null;
159
160
161
162
163 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
164 @Parameter(property = "mavenSettings", defaultValue = "${settings}", required = false)
165 private org.apache.maven.settings.Settings mavenSettings;
166
167
168
169
170 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
171 @Parameter(property = "mavenSettingsProxyId", required = false)
172 private String mavenSettingsProxyId;
173
174
175
176
177
178
179 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
180 @Parameter(property = "proxyPort", defaultValue = "", required = false)
181 @Deprecated
182 private String proxyPort = null;
183
184
185
186
187
188 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
189 @Parameter(property = "proxyUsername", defaultValue = "", required = false)
190 @Deprecated
191 private String proxyUsername = null;
192
193
194
195
196
197 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
198 @Parameter(property = "proxyPassword", defaultValue = "", required = false)
199 @Deprecated
200 private String proxyPassword = null;
201
202
203
204 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
205 @Parameter(property = "connectionTimeout", defaultValue = "", required = false)
206 private String connectionTimeout = null;
207
208
209
210 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
211 @Parameter(property = "suppressionFile", defaultValue = "", required = false)
212 private String suppressionFile = null;
213
214
215
216 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
217 @Parameter(property = "showSummary", defaultValue = "true", required = false)
218 private boolean showSummary = true;
219
220
221
222
223 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
224 @Parameter(property = "jarAnalyzerEnabled", defaultValue = "true", required = false)
225 private boolean jarAnalyzerEnabled = true;
226
227
228
229
230 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
231 @Parameter(property = "archiveAnalyzerEnabled", defaultValue = "true", required = false)
232 private boolean archiveAnalyzerEnabled = true;
233
234
235
236
237 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
238 @Parameter(property = "assemblyAnalyzerEnabled", defaultValue = "true", required = false)
239 private boolean assemblyAnalyzerEnabled = true;
240
241
242
243
244 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
245 @Parameter(property = "nuspecAnalyzerEnabled", defaultValue = "true", required = false)
246 private boolean nuspecAnalyzerEnabled = true;
247
248
249
250
251 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
252 @Parameter(property = "nexusAnalyzerEnabled", defaultValue = "true", required = false)
253 private boolean nexusAnalyzerEnabled = true;
254
255
256
257 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
258 @Parameter(property = "nexusUrl", defaultValue = "", required = false)
259 private String nexusUrl;
260
261
262
263 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
264 @Parameter(property = "nexusUsesProxy", defaultValue = "true", required = false)
265 private boolean nexusUsesProxy = true;
266
267
268
269 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
270 @Parameter(property = "connectionString", defaultValue = "", required = false)
271 private String connectionString;
272
273
274
275 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
276 @Parameter(property = "databaseDriverName", defaultValue = "", required = false)
277 private String databaseDriverName;
278
279
280
281 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
282 @Parameter(property = "databaseDriverPath", defaultValue = "", required = false)
283 private String databaseDriverPath;
284
285
286
287 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
288 @Parameter(property = "databaseUser", defaultValue = "", required = false)
289 private String databaseUser;
290
291
292
293 @SuppressWarnings({"CanBeFinal", "FieldCanBeLocal"})
294 @Parameter(property = "databasePassword", defaultValue = "", required = false)
295 private String databasePassword;
296
297
298
299 @Parameter(property = "zipExtensions", required = false)
300 private String zipExtensions;
301
302
303
304 @SuppressWarnings("CanBeFinal")
305 @Parameter(property = "skipTestScope", defaultValue = "true", required = false)
306 private boolean skipTestScope = true;
307
308
309
310 @SuppressWarnings("CanBeFinal")
311 @Parameter(property = "skipRuntimeScope", defaultValue = "false", required = false)
312 private boolean skipRuntimeScope = false;
313
314
315
316 @SuppressWarnings("CanBeFinal")
317 @Parameter(property = "skipProvidedScope", defaultValue = "false", required = false)
318 private boolean skipProvidedScope = false;
319
320
321
322 @Parameter(property = "dataDirectory", defaultValue = "", required = false)
323 private String dataDirectory;
324
325
326
327 @Parameter(property = "cveUrl12Modified", defaultValue = "", required = false)
328 private String cveUrl12Modified;
329
330
331
332 @Parameter(property = "cveUrl20Modified", defaultValue = "", required = false)
333 private String cveUrl20Modified;
334
335
336
337 @Parameter(property = "cveUrl12Base", defaultValue = "", required = false)
338 private String cveUrl12Base;
339
340
341
342 @Parameter(property = "cveUrl20Base", defaultValue = "", required = false)
343 private String cveUrl20Base;
344
345
346
347
348 @Parameter(property = "pathToMono", defaultValue = "", required = false)
349 private String pathToMono;
350
351
352
353
354
355
356
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
389
390
391
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
423
424
425
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
445
446
447
448
449
450
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
542
543
544
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
575
576
577
578
579
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
608
609
610
611
612
613
614 private int writeSiteReportDependencyEvidenceUsed(Dependency d, int collapsibleHeaderCount, Sink sink) {
615 int cnt = collapsibleHeaderCount;
616 final Set<Evidence> evidence = d.getEvidenceForDisplay();
617 if (evidence != null && evidence.size() > 0) {
618 cnt += 1;
619 sink.sectionTitle4();
620 sink.rawText("Evidence Collected <a href=\"javascript:toggleElement(this, 'evidence" + cnt + "')\">[+]</a>");
621 sink.sectionTitle4_();
622 sink.rawText("<div id=\"evidence" + cnt + "\" style=\"display:none\">");
623 sink.table();
624 sink.tableRow();
625 writeTableHeaderCell(sink, "Source");
626 writeTableHeaderCell(sink, "Name");
627 writeTableHeaderCell(sink, "Value");
628 sink.tableRow_();
629 for (Evidence e : evidence) {
630 sink.tableRow();
631 writeTableCell(sink, e.getSource());
632 writeTableCell(sink, e.getName());
633 writeTableCell(sink, e.getValue());
634 sink.tableRow_();
635 }
636 sink.table_();
637 sink.rawText("</div>");
638 }
639 return cnt;
640 }
641
642
643
644
645
646
647
648 private void writeSiteReportDependencyHeader(Sink sink, Dependency d) {
649 sink.sectionTitle2();
650 sink.anchor("sha1" + d.getSha1sum());
651 sink.text(d.getFileName());
652 sink.anchor_();
653 sink.sectionTitle2_();
654 if (d.getDescription() != null && d.getDescription().length() > 0) {
655 sink.paragraph();
656 sink.bold();
657 sink.text("Description: ");
658 sink.bold_();
659 sink.text(d.getDescription());
660 sink.paragraph_();
661 }
662 if (d.getLicense() != null && d.getLicense().length() > 0) {
663 sink.paragraph();
664 sink.bold();
665 sink.text("License: ");
666 sink.bold_();
667 if (d.getLicense().startsWith("http://") && !d.getLicense().contains(" ")) {
668 sink.link(d.getLicense());
669 sink.text(d.getLicense());
670 sink.link_();
671 } else {
672 sink.text(d.getLicense());
673 }
674 sink.paragraph_();
675 }
676 }
677
678
679
680
681
682
683
684 private void writeListItem(Sink sink, String text) {
685 sink.listItem();
686 sink.text(text);
687 sink.listItem_();
688 }
689
690
691
692
693
694
695
696 private void writeTableCell(Sink sink, String text) {
697 sink.tableCell();
698 sink.text(text);
699 sink.tableCell_();
700 }
701
702
703
704
705
706
707
708 private void writeTableHeaderCell(Sink sink, String text) {
709 sink.tableHeaderCell();
710 sink.text(text);
711 sink.tableHeaderCell_();
712 }
713
714
715
716
717
718
719
720 private void writeSiteReportTOC(Sink sink, final List<Dependency> dependencies) {
721 sink.list();
722 for (Dependency d : dependencies) {
723 sink.listItem();
724 sink.link("#sha1" + d.getSha1sum());
725 sink.text(d.getFileName());
726 sink.link_();
727 if (!d.getVulnerabilities().isEmpty()) {
728 sink.rawText(" <font style=\"color:red\">•</font>");
729 }
730 if (!d.getRelatedDependencies().isEmpty()) {
731 sink.list();
732 for (Dependency r : d.getRelatedDependencies()) {
733 writeListItem(sink, r.getFileName());
734 }
735 sink.list_();
736 }
737 sink.listItem_();
738 }
739 sink.list_();
740 }
741
742
743
744
745
746
747
748 private void writeSiteReportHeader(Sink sink, String projectName) {
749 sink.head();
750 sink.title();
751 sink.text("Dependency-Check Report: " + projectName);
752 sink.title_();
753 sink.head_();
754 sink.body();
755 sink.rawText("<script type=\"text/javascript\">");
756 sink.rawText("function toggleElement(el, targetId) {");
757 sink.rawText("if (el.innerText == '[+]') {");
758 sink.rawText(" el.innerText = '[-]';");
759 sink.rawText(" document.getElementById(targetId).style.display='block';");
760 sink.rawText("} else {");
761 sink.rawText(" el.innerText = '[+]';");
762 sink.rawText(" document.getElementById(targetId).style.display='none';");
763 sink.rawText("}");
764
765 sink.rawText("}");
766 sink.rawText("</script>");
767 sink.section1();
768 sink.sectionTitle1();
769 sink.text("Project: " + projectName);
770 sink.sectionTitle1_();
771 sink.date();
772 final Date now = new Date();
773 sink.text(DateFormat.getDateTimeInstance().format(now));
774 sink.date_();
775 sink.section1_();
776 }
777
778
779
780
781
782
783
784
785 private String getMavenSettingsProxyUrl(Proxy proxy) {
786 return new StringBuilder(proxy.getProtocol()).append("://").append(proxy.getHost()).toString();
787 }
788
789
790
791
792
793
794 private Proxy getMavenProxy() {
795 if (mavenSettings != null) {
796 final List<Proxy> proxies = mavenSettings.getProxies();
797 if (proxies != null && proxies.size() > 0) {
798 if (mavenSettingsProxyId != null) {
799 for (Proxy proxy : proxies) {
800 if (mavenSettingsProxyId.equalsIgnoreCase(proxy.getId())) {
801 return proxy;
802 }
803 }
804 } else if (proxies.size() == 1) {
805 return proxies.get(0);
806 } else {
807 throw new IllegalStateException("Ambiguous proxy definition");
808 }
809 }
810 }
811 return null;
812 }
813
814
815
816
817
818 private void populateSettings() {
819 Settings.initialize();
820 InputStream mojoProperties = null;
821 try {
822 mojoProperties = this.getClass().getClassLoader().getResourceAsStream(PROPERTIES_FILE);
823 Settings.mergeProperties(mojoProperties);
824 } catch (IOException ex) {
825 logger.log(Level.WARNING, "Unable to load the dependency-check ant task.properties file.");
826 logger.log(Level.FINE, null, ex);
827 } finally {
828 if (mojoProperties != null) {
829 try {
830 mojoProperties.close();
831 } catch (IOException ex) {
832 logger.log(Level.FINEST, null, ex);
833 }
834 }
835 }
836
837 Settings.setBoolean(Settings.KEYS.AUTO_UPDATE, autoUpdate);
838
839 final Proxy proxy = getMavenProxy();
840 if (proxy != null) {
841 Settings.setString(Settings.KEYS.PROXY_URL, getMavenSettingsProxyUrl(proxy));
842 Settings.setString(Settings.KEYS.PROXY_PORT, Integer.toString(proxy.getPort()));
843 final String userName = proxy.getUsername();
844 final String password = proxy.getPassword();
845 if (userName != null && password != null) {
846 Settings.setString(Settings.KEYS.PROXY_USERNAME, userName);
847 Settings.setString(Settings.KEYS.PROXY_PASSWORD, password);
848 }
849 }
850
851 if (proxyUrl != null && !proxyUrl.isEmpty()) {
852 Settings.setString(Settings.KEYS.PROXY_URL, proxyUrl);
853 }
854 if (proxyPort != null && !proxyPort.isEmpty()) {
855 Settings.setString(Settings.KEYS.PROXY_PORT, proxyPort);
856 }
857 if (proxyUsername != null && !proxyUsername.isEmpty()) {
858 Settings.setString(Settings.KEYS.PROXY_USERNAME, proxyUsername);
859 }
860 if (proxyPassword != null && !proxyPassword.isEmpty()) {
861 Settings.setString(Settings.KEYS.PROXY_PASSWORD, proxyPassword);
862 }
863 if (connectionTimeout != null && !connectionTimeout.isEmpty()) {
864 Settings.setString(Settings.KEYS.CONNECTION_TIMEOUT, connectionTimeout);
865 }
866 if (suppressionFile != null && !suppressionFile.isEmpty()) {
867 Settings.setString(Settings.KEYS.SUPPRESSION_FILE, suppressionFile);
868 }
869
870
871
872 Settings.setBoolean(Settings.KEYS.ANALYZER_JAR_ENABLED, jarAnalyzerEnabled);
873
874 Settings.setBoolean(Settings.KEYS.ANALYZER_NUSPEC_ENABLED, nuspecAnalyzerEnabled);
875
876 Settings.setBoolean(Settings.KEYS.ANALYZER_NEXUS_ENABLED, nexusAnalyzerEnabled);
877 if (nexusUrl != null && !nexusUrl.isEmpty()) {
878 Settings.setString(Settings.KEYS.ANALYZER_NEXUS_URL, nexusUrl);
879 }
880 Settings.setBoolean(Settings.KEYS.ANALYZER_NEXUS_PROXY, nexusUsesProxy);
881
882 Settings.setBoolean(Settings.KEYS.ANALYZER_ARCHIVE_ENABLED, archiveAnalyzerEnabled);
883 if (zipExtensions != null && !zipExtensions.isEmpty()) {
884 Settings.setString(Settings.KEYS.ADDITIONAL_ZIP_EXTENSIONS, zipExtensions);
885 }
886
887 Settings.setBoolean(Settings.KEYS.ANALYZER_ASSEMBLY_ENABLED, assemblyAnalyzerEnabled);
888 if (pathToMono != null && !pathToMono.isEmpty()) {
889 Settings.setString(Settings.KEYS.ANALYZER_ASSEMBLY_MONO_PATH, pathToMono);
890 }
891
892
893 if (databaseDriverName != null && !databaseDriverName.isEmpty()) {
894 Settings.setString(Settings.KEYS.DB_DRIVER_NAME, databaseDriverName);
895 }
896 if (databaseDriverPath != null && !databaseDriverPath.isEmpty()) {
897 Settings.setString(Settings.KEYS.DB_DRIVER_PATH, databaseDriverPath);
898 }
899 if (connectionString != null && !connectionString.isEmpty()) {
900 Settings.setString(Settings.KEYS.DB_CONNECTION_STRING, connectionString);
901 }
902 if (databaseUser != null && !databaseUser.isEmpty()) {
903 Settings.setString(Settings.KEYS.DB_USER, databaseUser);
904 }
905 if (databasePassword != null && !databasePassword.isEmpty()) {
906 Settings.setString(Settings.KEYS.DB_PASSWORD, databasePassword);
907 }
908
909 if (dataDirectory != null && !dataDirectory.isEmpty()) {
910 Settings.setString(Settings.KEYS.DATA_DIRECTORY, dataDirectory);
911 }
912
913
914 Settings.setBoolean(Settings.KEYS.SKIP_TEST_SCOPE, skipTestScope);
915 Settings.setBoolean(Settings.KEYS.SKIP_RUNTIME_SCOPE, skipRuntimeScope);
916 Settings.setBoolean(Settings.KEYS.SKIP_PROVIDED_SCOPE, skipProvidedScope);
917
918
919 if (cveUrl12Modified != null && !cveUrl12Modified.isEmpty()) {
920 Settings.setString(Settings.KEYS.CVE_MODIFIED_12_URL, cveUrl12Modified);
921 }
922 if (cveUrl20Modified != null && !cveUrl20Modified.isEmpty()) {
923 Settings.setString(Settings.KEYS.CVE_MODIFIED_20_URL, cveUrl20Modified);
924 }
925 if (cveUrl12Base != null && !cveUrl12Base.isEmpty()) {
926 Settings.setString(Settings.KEYS.CVE_SCHEMA_1_2, cveUrl12Base);
927 }
928 if (cveUrl20Base != null && !cveUrl20Base.isEmpty()) {
929 Settings.setString(Settings.KEYS.CVE_SCHEMA_2_0, cveUrl20Base);
930 }
931
932 }
933
934
935
936
937
938
939
940 public void execute() throws MojoExecutionException, MojoFailureException {
941 Engine engine = null;
942 try {
943 engine = executeDependencyCheck();
944 generateExternalReports(engine, outputDirectory);
945 if (this.showSummary) {
946 showSummary(engine.getDependencies());
947 }
948 if (this.failBuildOnCVSS <= 10) {
949 checkForFailure(engine.getDependencies());
950 }
951 } catch (DatabaseException ex) {
952 logger.log(Level.SEVERE,
953 "Unable to connect to the dependency-check database; analysis has stopped");
954 logger.log(Level.FINE, "", ex);
955 } finally {
956 Settings.cleanup(true);
957 if (engine != null) {
958 engine.cleanup();
959 }
960 }
961 }
962
963
964
965
966
967
968
969
970 public void generate(@SuppressWarnings("deprecation") org.codehaus.doxia.sink.Sink sink,
971 Locale locale) throws MavenReportException {
972 generate((Sink) sink, null, locale);
973 }
974
975
976
977
978
979
980
981
982
983 public void generate(Sink sink, SinkFactory sinkFactory, Locale locale) throws MavenReportException {
984 Engine engine = null;
985 try {
986 engine = executeDependencyCheck();
987 if (this.externalReport) {
988 generateExternalReports(engine, reportOutputDirectory);
989 } else {
990 generateMavenSiteReport(engine, sink);
991 }
992 } catch (DatabaseException ex) {
993 logger.log(Level.SEVERE,
994 "Unable to connect to the dependency-check database; analysis has stopped");
995 logger.log(Level.FINE, "", ex);
996 } finally {
997 Settings.cleanup(true);
998 if (engine != null) {
999 engine.cleanup();
1000 }
1001 }
1002 }
1003
1004
1005
1006
1007
1008
1009
1010 public String getOutputName() {
1011 if ("HTML".equalsIgnoreCase(this.format)
1012 || "ALL".equalsIgnoreCase(this.format)) {
1013 return "dependency-check-report";
1014 } else if ("XML".equalsIgnoreCase(this.format)) {
1015 return "dependency-check-report.xml#";
1016 } else if ("VULN".equalsIgnoreCase(this.format)) {
1017 return "dependency-check-vulnerability";
1018 } else {
1019 logger.log(Level.WARNING, "Unknown report format used during site generation.");
1020 return "dependency-check-report";
1021 }
1022 }
1023
1024
1025
1026
1027
1028
1029 public String getCategoryName() {
1030 return MavenReport.CATEGORY_PROJECT_REPORTS;
1031 }
1032
1033
1034
1035
1036
1037
1038
1039 public String getName(Locale locale) {
1040 return name;
1041 }
1042
1043
1044
1045
1046
1047
1048 public void setReportOutputDirectory(File directory) {
1049 reportOutputDirectory = directory;
1050 }
1051
1052
1053
1054
1055
1056
1057 public File getReportOutputDirectory() {
1058 return reportOutputDirectory;
1059 }
1060
1061
1062
1063
1064
1065
1066
1067 public String getDescription(Locale locale) {
1068 return description;
1069 }
1070
1071
1072
1073
1074
1075
1076 public boolean isExternalReport() {
1077 return externalReport;
1078 }
1079
1080
1081
1082
1083
1084
1085 public boolean canGenerateReport() {
1086 return true;
1087 }
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097 private void checkForFailure(List<Dependency> dependencies) throws MojoFailureException {
1098 final StringBuilder ids = new StringBuilder();
1099 for (Dependency d : dependencies) {
1100 boolean addName = true;
1101 for (Vulnerability v : d.getVulnerabilities()) {
1102 if (v.getCvssScore() >= failBuildOnCVSS) {
1103 if (addName) {
1104 addName = false;
1105 ids.append(NEW_LINE).append(d.getFileName()).append(": ");
1106 ids.append(v.getName());
1107 } else {
1108 ids.append(", ").append(v.getName());
1109 }
1110 }
1111 }
1112 }
1113 if (ids.length() > 0) {
1114 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 throw new MojoFailureException(msg);
1118 }
1119 }
1120
1121
1122
1123
1124
1125
1126 private void showSummary(List<Dependency> dependencies) {
1127 final StringBuilder summary = new StringBuilder();
1128 for (Dependency d : dependencies) {
1129 boolean firstEntry = true;
1130 final StringBuilder ids = new StringBuilder();
1131 for (Vulnerability v : d.getVulnerabilities()) {
1132 if (firstEntry) {
1133 firstEntry = false;
1134 } else {
1135 ids.append(", ");
1136 }
1137 ids.append(v.getName());
1138 }
1139 if (ids.length() > 0) {
1140 summary.append(d.getFileName()).append(" (");
1141 firstEntry = true;
1142 for (Identifier id : d.getIdentifiers()) {
1143 if (firstEntry) {
1144 firstEntry = false;
1145 } else {
1146 summary.append(", ");
1147 }
1148 summary.append(id.getValue());
1149 }
1150 summary.append(") : ").append(ids).append(NEW_LINE);
1151 }
1152 }
1153 if (summary.length() > 0) {
1154 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 logger.log(Level.WARNING, msg);
1158 }
1159 }
1160 }