1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18 package org.owasp.dependencycheck.taskdefs;
19
20 import java.io.File;
21 import java.io.IOException;
22 import java.io.InputStream;
23 import java.util.List;
24 import java.util.logging.Level;
25 import java.util.logging.Logger;
26 import org.apache.tools.ant.BuildException;
27 import org.apache.tools.ant.Task;
28 import org.apache.tools.ant.types.EnumeratedAttribute;
29 import org.apache.tools.ant.types.Reference;
30 import org.apache.tools.ant.types.Resource;
31 import org.apache.tools.ant.types.ResourceCollection;
32 import org.apache.tools.ant.types.resources.FileProvider;
33 import org.apache.tools.ant.types.resources.Resources;
34 import org.owasp.dependencycheck.Engine;
35 import org.owasp.dependencycheck.data.nvdcve.CveDB;
36 import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
37 import org.owasp.dependencycheck.data.nvdcve.DatabaseProperties;
38 import org.owasp.dependencycheck.dependency.Dependency;
39 import org.owasp.dependencycheck.dependency.Identifier;
40 import org.owasp.dependencycheck.dependency.Vulnerability;
41 import org.owasp.dependencycheck.reporting.ReportGenerator;
42 import org.owasp.dependencycheck.reporting.ReportGenerator.Format;
43 import org.owasp.dependencycheck.utils.LogUtils;
44 import org.owasp.dependencycheck.utils.Settings;
45
46
47
48
49
50
51 public class DependencyCheckTask extends Task {
52
53
54
55
56 private static final String PROPERTIES_FILE = "task.properties";
57
58
59
60 private static final String LOG_PROPERTIES_FILE = "log.properties";
61
62
63
64 private static final String NEW_LINE = System.getProperty("line.separator", "\n").intern();
65
66
67
68 private static final Logger LOGGER = Logger.getLogger(DependencyCheckTask.class.getName());
69
70
71
72
73 public DependencyCheckTask() {
74 super();
75 }
76
77
78
79
80
81 private Resources path = null;
82
83
84
85 private Reference refid = null;
86
87
88
89
90
91
92
93 public void add(ResourceCollection rc) {
94 if (isReference()) {
95 throw new BuildException("Nested elements are not allowed when using the refid attribute.");
96 }
97 getPath().add(rc);
98 }
99
100
101
102
103
104
105
106 private synchronized Resources getPath() {
107 if (path == null) {
108 path = new Resources(getProject());
109 path.setCache(true);
110 }
111 return path;
112 }
113
114
115
116
117
118
119 public boolean isReference() {
120 return refid != null;
121 }
122
123
124
125
126
127
128 public void setRefid(Reference r) {
129 if (path != null) {
130 throw new BuildException("Nested elements are not allowed when using the refid attribute.");
131 }
132 refid = r;
133 }
134
135
136
137
138
139
140 private void dealWithReferences() throws BuildException {
141 if (isReference()) {
142 final Object o = refid.getReferencedObject(getProject());
143 if (!(o instanceof ResourceCollection)) {
144 throw new BuildException("refid '" + refid.getRefId()
145 + "' does not refer to a resource collection.");
146 }
147 getPath().add((ResourceCollection) o);
148 }
149 }
150
151
152
153
154 private String applicationName = "Dependency-Check";
155
156
157
158
159
160
161 public String getApplicationName() {
162 return applicationName;
163 }
164
165
166
167
168
169
170 public void setApplicationName(String applicationName) {
171 this.applicationName = applicationName;
172 }
173
174
175
176 private String dataDirectory = null;
177
178
179
180
181
182
183 public String getDataDirectory() {
184 return dataDirectory;
185 }
186
187
188
189
190
191
192 public void setDataDirectory(String dataDirectory) {
193 this.dataDirectory = dataDirectory;
194 }
195
196
197
198 private String reportOutputDirectory = ".";
199
200
201
202
203
204
205 public String getReportOutputDirectory() {
206 return reportOutputDirectory;
207 }
208
209
210
211
212
213
214 public void setReportOutputDirectory(String reportOutputDirectory) {
215 this.reportOutputDirectory = reportOutputDirectory;
216 }
217
218
219
220
221
222 private float failBuildOnCVSS = 11;
223
224
225
226
227
228
229 public float getFailBuildOnCVSS() {
230 return failBuildOnCVSS;
231 }
232
233
234
235
236
237
238 public void setFailBuildOnCVSS(float failBuildOnCVSS) {
239 this.failBuildOnCVSS = failBuildOnCVSS;
240 }
241
242
243
244
245 private boolean autoUpdate = true;
246
247
248
249
250
251
252 public boolean isAutoUpdate() {
253 return autoUpdate;
254 }
255
256
257
258
259
260
261 public void setAutoUpdate(boolean autoUpdate) {
262 this.autoUpdate = autoUpdate;
263 }
264
265
266
267
268 private String reportFormat = "HTML";
269
270
271
272
273
274
275 public String getReportFormat() {
276 return reportFormat;
277 }
278
279
280
281
282
283
284 public void setReportFormat(ReportFormats reportFormat) {
285 this.reportFormat = reportFormat.getValue();
286 }
287
288
289
290 private String proxyUrl;
291
292
293
294
295
296
297 public String getProxyUrl() {
298 return proxyUrl;
299 }
300
301
302
303
304
305
306 public void setProxyUrl(String proxyUrl) {
307 this.proxyUrl = proxyUrl;
308 }
309
310
311
312 private String proxyPort;
313
314
315
316
317
318
319 public String getProxyPort() {
320 return proxyPort;
321 }
322
323
324
325
326
327
328 public void setProxyPort(String proxyPort) {
329 this.proxyPort = proxyPort;
330 }
331
332
333
334 private String proxyUsername;
335
336
337
338
339
340
341 public String getProxyUsername() {
342 return proxyUsername;
343 }
344
345
346
347
348
349
350 public void setProxyUsername(String proxyUsername) {
351 this.proxyUsername = proxyUsername;
352 }
353
354
355
356 private String proxyPassword;
357
358
359
360
361
362
363 public String getProxyPassword() {
364 return proxyPassword;
365 }
366
367
368
369
370
371
372 public void setProxyPassword(String proxyPassword) {
373 this.proxyPassword = proxyPassword;
374 }
375
376
377
378 private String connectionTimeout;
379
380
381
382
383
384
385 public String getConnectionTimeout() {
386 return connectionTimeout;
387 }
388
389
390
391
392
393
394 public void setConnectionTimeout(String connectionTimeout) {
395 this.connectionTimeout = connectionTimeout;
396 }
397
398
399
400 private String logFile = null;
401
402
403
404
405
406
407 public String getLogFile() {
408 return logFile;
409 }
410
411
412
413
414
415
416 public void setLogFile(String logFile) {
417 this.logFile = logFile;
418 }
419
420
421
422 private String suppressionFile;
423
424
425
426
427
428
429 public String getSuppressionFile() {
430 return suppressionFile;
431 }
432
433
434
435
436
437
438 public void setSuppressionFile(String suppressionFile) {
439 this.suppressionFile = suppressionFile;
440 }
441
442
443
444 private boolean showSummary = true;
445
446
447
448
449
450
451 public boolean isShowSummary() {
452 return showSummary;
453 }
454
455
456
457
458
459
460 public void setShowSummary(boolean showSummary) {
461 this.showSummary = showSummary;
462 }
463
464
465
466
467
468
469 public void setJarAnalyzerEnabled(boolean jarAnalyzerEnabled) {
470 this.jarAnalyzerEnabled = jarAnalyzerEnabled;
471 }
472
473
474
475 private boolean archiveAnalyzerEnabled = true;
476
477
478
479
480
481
482 public boolean isArchiveAnalyzerEnabled() {
483 return archiveAnalyzerEnabled;
484 }
485
486
487
488 private boolean assemblyAnalyzerEnabled = true;
489
490
491
492
493
494
495 public void setArchiveAnalyzerEnabled(boolean archiveAnalyzerEnabled) {
496 this.archiveAnalyzerEnabled = archiveAnalyzerEnabled;
497 }
498
499
500
501
502
503
504 public boolean isAssemblyAnalyzerEnabled() {
505 return assemblyAnalyzerEnabled;
506 }
507
508
509
510
511
512
513 public void setAssemblyAnalyzerEnabled(boolean assemblyAnalyzerEnabled) {
514 this.assemblyAnalyzerEnabled = assemblyAnalyzerEnabled;
515 }
516
517
518
519 private boolean nuspecAnalyzerEnabled = true;
520
521
522
523
524
525
526 public boolean isNuspecAnalyzerEnabled() {
527 return nuspecAnalyzerEnabled;
528 }
529
530
531
532
533
534
535 public void setNuspecAnalyzerEnabled(boolean nuspecAnalyzerEnabled) {
536 this.nuspecAnalyzerEnabled = nuspecAnalyzerEnabled;
537 }
538
539
540
541
542 private boolean nexusAnalyzerEnabled = true;
543
544
545
546
547
548
549 public boolean isNexusAnalyzerEnabled() {
550 return nexusAnalyzerEnabled;
551 }
552
553
554
555
556
557
558 public void setNexusAnalyzerEnabled(boolean nexusAnalyzerEnabled) {
559 this.nexusAnalyzerEnabled = nexusAnalyzerEnabled;
560 }
561
562
563
564
565 private String nexusUrl;
566
567
568
569
570
571
572 public String getNexusUrl() {
573 return nexusUrl;
574 }
575
576
577
578
579
580
581 public void setNexusUrl(String nexusUrl) {
582 this.nexusUrl = nexusUrl;
583 }
584
585
586
587 private boolean nexusUsesProxy = true;
588
589
590
591
592
593
594 public boolean isNexusUsesProxy() {
595 return nexusUsesProxy;
596 }
597
598
599
600
601
602
603 public void setNexusUsesProxy(boolean nexusUsesProxy) {
604 this.nexusUsesProxy = nexusUsesProxy;
605 }
606
607
608
609
610 private String databaseDriverName;
611
612
613
614
615
616
617 public String getDatabaseDriverName() {
618 return databaseDriverName;
619 }
620
621
622
623
624
625
626 public void setDatabaseDriverName(String databaseDriverName) {
627 this.databaseDriverName = databaseDriverName;
628 }
629
630
631
632
633 private String databaseDriverPath;
634
635
636
637
638
639
640 public String getDatabaseDriverPath() {
641 return databaseDriverPath;
642 }
643
644
645
646
647
648
649 public void setDatabaseDriverPath(String databaseDriverPath) {
650 this.databaseDriverPath = databaseDriverPath;
651 }
652
653
654
655 private String connectionString;
656
657
658
659
660
661
662 public String getConnectionString() {
663 return connectionString;
664 }
665
666
667
668
669
670
671 public void setConnectionString(String connectionString) {
672 this.connectionString = connectionString;
673 }
674
675
676
677 private String databaseUser;
678
679
680
681
682
683
684 public String getDatabaseUser() {
685 return databaseUser;
686 }
687
688
689
690
691
692
693 public void setDatabaseUser(String databaseUser) {
694 this.databaseUser = databaseUser;
695 }
696
697
698
699
700 private String databasePassword;
701
702
703
704
705
706
707 public String getDatabasePassword() {
708 return databasePassword;
709 }
710
711
712
713
714
715
716 public void setDatabasePassword(String databasePassword) {
717 this.databasePassword = databasePassword;
718 }
719
720
721
722
723
724 private String zipExtensions;
725
726
727
728
729
730
731 public String getZipExtensions() {
732 return zipExtensions;
733 }
734
735
736
737
738
739
740 public void setZipExtensions(String zipExtensions) {
741 this.zipExtensions = zipExtensions;
742 }
743
744
745
746
747 private String cveUrl12Modified;
748
749
750
751
752
753
754 public String getCveUrl12Modified() {
755 return cveUrl12Modified;
756 }
757
758
759
760
761
762
763 public void setCveUrl12Modified(String cveUrl12Modified) {
764 this.cveUrl12Modified = cveUrl12Modified;
765 }
766
767
768
769
770 private String cveUrl20Modified;
771
772
773
774
775
776
777 public String getCveUrl20Modified() {
778 return cveUrl20Modified;
779 }
780
781
782
783
784
785
786 public void setCveUrl20Modified(String cveUrl20Modified) {
787 this.cveUrl20Modified = cveUrl20Modified;
788 }
789
790
791
792
793 private String cveUrl12Base;
794
795
796
797
798
799
800 public String getCveUrl12Base() {
801 return cveUrl12Base;
802 }
803
804
805
806
807
808
809 public void setCveUrl12Base(String cveUrl12Base) {
810 this.cveUrl12Base = cveUrl12Base;
811 }
812
813
814
815
816 private String cveUrl20Base;
817
818
819
820
821
822
823 public String getCveUrl20Base() {
824 return cveUrl20Base;
825 }
826
827
828
829
830
831
832 public void setCveUrl20Base(String cveUrl20Base) {
833 this.cveUrl20Base = cveUrl20Base;
834 }
835
836
837
838 private String pathToMono;
839
840
841
842
843
844
845 public String getPathToMono() {
846 return pathToMono;
847 }
848
849
850
851
852
853
854 public void setPathToMono(String pathToMono) {
855 this.pathToMono = pathToMono;
856 }
857
858 @Override
859 public void execute() throws BuildException {
860 final InputStream in = DependencyCheckTask.class.getClassLoader().getResourceAsStream(LOG_PROPERTIES_FILE);
861 LogUtils.prepareLogger(in, logFile);
862
863 dealWithReferences();
864 validateConfiguration();
865 populateSettings();
866
867 Engine engine = null;
868 try {
869 engine = new Engine(DependencyCheckTask.class.getClassLoader());
870
871 for (Resource resource : path) {
872 final FileProvider provider = resource.as(FileProvider.class);
873 if (provider != null) {
874 final File file = provider.getFile();
875 if (file != null && file.exists()) {
876 engine.scan(file);
877 }
878 }
879 }
880 try {
881 engine.analyzeDependencies();
882 DatabaseProperties prop = null;
883 CveDB cve = null;
884 try {
885 cve = new CveDB();
886 cve.open();
887 prop = cve.getDatabaseProperties();
888 } catch (DatabaseException ex) {
889 LOGGER.log(Level.FINE, "Unable to retrieve DB Properties", ex);
890 } finally {
891 if (cve != null) {
892 cve.close();
893 }
894 }
895 final ReportGenerator reporter = new ReportGenerator(applicationName, engine.getDependencies(), engine.getAnalyzers(), prop);
896 reporter.generateReports(reportOutputDirectory, reportFormat);
897
898 if (this.failBuildOnCVSS <= 10) {
899 checkForFailure(engine.getDependencies());
900 }
901 if (this.showSummary) {
902 showSummary(engine.getDependencies());
903 }
904 } catch (IOException ex) {
905 LOGGER.log(Level.FINE, "Unable to generate dependency-check report", ex);
906 throw new BuildException("Unable to generate dependency-check report", ex);
907 } catch (Exception ex) {
908 LOGGER.log(Level.FINE, "An exception occurred; unable to continue task", ex);
909 throw new BuildException("An exception occurred; unable to continue task", ex);
910 }
911 } catch (DatabaseException ex) {
912 LOGGER.log(Level.SEVERE, "Unable to connect to the dependency-check database; analysis has stopped");
913 LOGGER.log(Level.FINE, "", ex);
914 } finally {
915 Settings.cleanup(true);
916 if (engine != null) {
917 engine.cleanup();
918 }
919 }
920 }
921
922
923
924
925
926
927 private void validateConfiguration() throws BuildException {
928 if (path == null) {
929 throw new BuildException("No project dependencies have been defined to analyze.");
930 }
931 if (failBuildOnCVSS < 0 || failBuildOnCVSS > 11) {
932 throw new BuildException("Invalid configuration, failBuildOnCVSS must be between 0 and 11.");
933 }
934 }
935
936
937
938
939
940 private void populateSettings() {
941 Settings.initialize();
942 InputStream taskProperties = null;
943 try {
944 taskProperties = this.getClass().getClassLoader().getResourceAsStream(PROPERTIES_FILE);
945 Settings.mergeProperties(taskProperties);
946 } catch (IOException ex) {
947 LOGGER.log(Level.WARNING, "Unable to load the dependency-check ant task.properties file.");
948 LOGGER.log(Level.FINE, null, ex);
949 } finally {
950 if (taskProperties != null) {
951 try {
952 taskProperties.close();
953 } catch (IOException ex) {
954 LOGGER.log(Level.FINEST, null, ex);
955 }
956 }
957 }
958 if (dataDirectory != null) {
959 Settings.setString(Settings.KEYS.DATA_DIRECTORY, dataDirectory);
960 } else {
961 final File jarPath = new File(DependencyCheckTask.class.getProtectionDomain().getCodeSource().getLocation().getPath());
962 final File base = jarPath.getParentFile();
963 final String sub = Settings.getString(Settings.KEYS.DATA_DIRECTORY);
964 final File dataDir = new File(base, sub);
965 Settings.setString(Settings.KEYS.DATA_DIRECTORY, dataDir.getAbsolutePath());
966 }
967
968 Settings.setBoolean(Settings.KEYS.AUTO_UPDATE, autoUpdate);
969
970 if (proxyUrl != null && !proxyUrl.isEmpty()) {
971 Settings.setString(Settings.KEYS.PROXY_URL, proxyUrl);
972 }
973 if (proxyPort != null && !proxyPort.isEmpty()) {
974 Settings.setString(Settings.KEYS.PROXY_PORT, proxyPort);
975 }
976 if (proxyUsername != null && !proxyUsername.isEmpty()) {
977 Settings.setString(Settings.KEYS.PROXY_USERNAME, proxyUsername);
978 }
979 if (proxyPassword != null && !proxyPassword.isEmpty()) {
980 Settings.setString(Settings.KEYS.PROXY_PASSWORD, proxyPassword);
981 }
982 if (connectionTimeout != null && !connectionTimeout.isEmpty()) {
983 Settings.setString(Settings.KEYS.CONNECTION_TIMEOUT, connectionTimeout);
984 }
985 if (suppressionFile != null && !suppressionFile.isEmpty()) {
986 Settings.setString(Settings.KEYS.SUPPRESSION_FILE, suppressionFile);
987 }
988
989
990
991 Settings.setBoolean(Settings.KEYS.ANALYZER_JAR_ENABLED, jarAnalyzerEnabled);
992
993 Settings.setBoolean(Settings.KEYS.ANALYZER_NUSPEC_ENABLED, nuspecAnalyzerEnabled);
994
995 Settings.setBoolean(Settings.KEYS.ANALYZER_NEXUS_ENABLED, nexusAnalyzerEnabled);
996 if (nexusUrl != null && !nexusUrl.isEmpty()) {
997 Settings.setString(Settings.KEYS.ANALYZER_NEXUS_URL, nexusUrl);
998 }
999 Settings.setBoolean(Settings.KEYS.ANALYZER_NEXUS_PROXY, nexusUsesProxy);
1000
1001 Settings.setBoolean(Settings.KEYS.ANALYZER_ARCHIVE_ENABLED, archiveAnalyzerEnabled);
1002 if (zipExtensions != null && !zipExtensions.isEmpty()) {
1003 Settings.setString(Settings.KEYS.ADDITIONAL_ZIP_EXTENSIONS, zipExtensions);
1004 }
1005
1006 Settings.setBoolean(Settings.KEYS.ANALYZER_ASSEMBLY_ENABLED, assemblyAnalyzerEnabled);
1007 if (pathToMono != null && !pathToMono.isEmpty()) {
1008 Settings.setString(Settings.KEYS.ANALYZER_ASSEMBLY_MONO_PATH, pathToMono);
1009 }
1010
1011 if (databaseDriverName != null && !databaseDriverName.isEmpty()) {
1012 Settings.setString(Settings.KEYS.DB_DRIVER_NAME, databaseDriverName);
1013 }
1014 if (databaseDriverPath != null && !databaseDriverPath.isEmpty()) {
1015 Settings.setString(Settings.KEYS.DB_DRIVER_PATH, databaseDriverPath);
1016 }
1017 if (connectionString != null && !connectionString.isEmpty()) {
1018 Settings.setString(Settings.KEYS.DB_CONNECTION_STRING, connectionString);
1019 }
1020 if (databaseUser != null && !databaseUser.isEmpty()) {
1021 Settings.setString(Settings.KEYS.DB_USER, databaseUser);
1022 }
1023 if (databasePassword != null && !databasePassword.isEmpty()) {
1024 Settings.setString(Settings.KEYS.DB_PASSWORD, databasePassword);
1025 }
1026 if (cveUrl12Modified != null && !cveUrl12Modified.isEmpty()) {
1027 Settings.setString(Settings.KEYS.CVE_MODIFIED_12_URL, cveUrl12Modified);
1028 }
1029 if (cveUrl20Modified != null && !cveUrl20Modified.isEmpty()) {
1030 Settings.setString(Settings.KEYS.CVE_MODIFIED_20_URL, cveUrl20Modified);
1031 }
1032 if (cveUrl12Base != null && !cveUrl12Base.isEmpty()) {
1033 Settings.setString(Settings.KEYS.CVE_SCHEMA_1_2, cveUrl12Base);
1034 }
1035 if (cveUrl20Base != null && !cveUrl20Base.isEmpty()) {
1036 Settings.setString(Settings.KEYS.CVE_SCHEMA_2_0, cveUrl20Base);
1037 }
1038 }
1039
1040
1041
1042
1043
1044
1045
1046
1047 private void checkForFailure(List<Dependency> dependencies) throws BuildException {
1048 final StringBuilder ids = new StringBuilder();
1049 for (Dependency d : dependencies) {
1050 for (Vulnerability v : d.getVulnerabilities()) {
1051 if (v.getCvssScore() >= failBuildOnCVSS) {
1052 if (ids.length() == 0) {
1053 ids.append(v.getName());
1054 } else {
1055 ids.append(", ").append(v.getName());
1056 }
1057 }
1058 }
1059 }
1060 if (ids.length() > 0) {
1061 final String msg = String.format("%n%nDependency-Check Failure:%n"
1062 + "One or more dependencies were identified with vulnerabilities that have a CVSS score greater then '%.1f': %s%n"
1063 + "See the dependency-check report for more details.%n%n", failBuildOnCVSS, ids.toString());
1064 throw new BuildException(msg);
1065 }
1066 }
1067
1068
1069
1070
1071
1072
1073 private void showSummary(List<Dependency> dependencies) {
1074 final StringBuilder summary = new StringBuilder();
1075 for (Dependency d : dependencies) {
1076 boolean firstEntry = true;
1077 final StringBuilder ids = new StringBuilder();
1078 for (Vulnerability v : d.getVulnerabilities()) {
1079 if (firstEntry) {
1080 firstEntry = false;
1081 } else {
1082 ids.append(", ");
1083 }
1084 ids.append(v.getName());
1085 }
1086 if (ids.length() > 0) {
1087 summary.append(d.getFileName()).append(" (");
1088 firstEntry = true;
1089 for (Identifier id : d.getIdentifiers()) {
1090 if (firstEntry) {
1091 firstEntry = false;
1092 } else {
1093 summary.append(", ");
1094 }
1095 summary.append(id.getValue());
1096 }
1097 summary.append(") : ").append(ids).append(NEW_LINE);
1098 }
1099 }
1100 if (summary.length() > 0) {
1101 final String msg = String.format("%n%n"
1102 + "One or more dependencies were identified with known vulnerabilities:%n%n%s"
1103 + "%n%nSee the dependency-check report for more details.%n%n", summary.toString());
1104 LOGGER.log(Level.WARNING, msg);
1105 }
1106 }
1107
1108
1109
1110
1111 public static class ReportFormats extends EnumeratedAttribute {
1112
1113
1114
1115
1116
1117
1118 @Override
1119 public String[] getValues() {
1120 int i = 0;
1121 final Format[] formats = Format.values();
1122 final String[] values = new String[formats.length];
1123 for (Format format : formats) {
1124 values[i++] = format.name();
1125 }
1126 return values;
1127 }
1128 }
1129
1130
1131
1132
1133 private boolean jarAnalyzerEnabled = true;
1134
1135
1136
1137
1138
1139
1140 public boolean isJarAnalyzerEnabled() {
1141 return jarAnalyzerEnabled;
1142 }
1143 }