Coverage Report

Coverage Report - org.owasp.dependencycheck.maven.AggregateMojo

Classes in this File

0/113

0/84

 /*
  * This file is part of dependency-check-maven.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
  * Copyright (c) 2013 Jeremy Long. All Rights Reserved.
  */
 package org.owasp.dependencycheck.maven;
 
 import java.io.File;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Locale;
 import java.util.Set;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugins.annotations.LifecyclePhase;
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.ResolutionScope;
 import org.apache.maven.project.MavenProject;
 import org.owasp.dependencycheck.analyzer.DependencyBundlingAnalyzer;
 import org.owasp.dependencycheck.analyzer.exception.AnalysisException;
 import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
 import org.owasp.dependencycheck.dependency.Dependency;
 import org.owasp.dependencycheck.utils.Settings;
 
 /**
  * Maven Plugin that checks project dependencies and the dependencies of all child modules to see if they have any known published
  * vulnerabilities.
  *
  * @author Jeremy Long
  */
 @Mojo(
         name = "aggregate",
         defaultPhase = LifecyclePhase.COMPILE,
         /*aggregator = true,*/
         threadSafe = true,
         requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME,
         requiresOnline = true
 )
 public class AggregateMojo extends BaseDependencyCheckMojo {
 
     /**
      * Executes the aggregate dependency-check goal. This runs dependency-check and generates the subsequent reports.
      *
      * @throws MojoExecutionException thrown if there is ane exception running the mojo
      * @throws MojoFailureException thrown if dependency-check is configured to fail the build
      */
     @Override
     public void runCheck() throws MojoExecutionException, MojoFailureException {
         final Engine engine = generateDataFile();
 
         if (getProject() == getReactorProjects().get(getReactorProjects().size() - 1)) {
 
             //ensure that the .ser file was created for each.
             for (MavenProject current : getReactorProjects()) {
                 final File dataFile = getDataFile(current);
                 if (dataFile == null) { //dc was never run on this project. write the ser to the target.
                     getLog().error(String.format("Module '%s' did not execute dependency-check; an attempt will be made to perform "
                             + "the check but dependencies may be missed resulting in false negatives.", current.getName()));
                     generateDataFile(engine, current);
                 }
             }
 
             for (MavenProject current : getReactorProjects()) {
                 List<Dependency> dependencies = readDataFile(current);
                 if (dependencies == null) {
                     dependencies = new ArrayList<Dependency>();
                 }
                 final Set<MavenProject> childProjects = getDescendants(current);
                 for (MavenProject reportOn : childProjects) {
                     final List<Dependency> childDeps = readDataFile(reportOn);
                     if (childDeps != null && !childDeps.isEmpty()) {
                         if (getLog().isDebugEnabled()) {
                             getLog().debug(String.format("Adding %d dependencies from %s", childDeps.size(), reportOn.getName()));
                         }
                         dependencies.addAll(childDeps);
                     } else {
                         if (getLog().isDebugEnabled()) {
                             getLog().debug(String.format("No dependencies read for %s", reportOn.getName()));
                         }
                     }
                 }
                 engine.getDependencies().clear();
                 engine.getDependencies().addAll(dependencies);
                 final DependencyBundlingAnalyzer bundler = new DependencyBundlingAnalyzer();
                 try {
                     if (getLog().isDebugEnabled()) {
                         getLog().debug(String.format("Dependency count pre-bundler: %s", engine.getDependencies().size()));
                     }
                     bundler.analyze(null, engine);
                     if (getLog().isDebugEnabled()) {
                         getLog().debug(String.format("Dependency count post-bundler: %s", engine.getDependencies().size()));
                     }
                 } catch (AnalysisException ex) {
                     getLog().warn("An error occured grouping the dependencies; duplicate entries may exist in the report", ex);
                     getLog().debug("Bundling Exception", ex);
                 }
 
                 File outputDir = getCorrectOutputDirectory(current);
                 if (outputDir == null) {
                     //in some regards we shouldn't be writting this, but we are anyway.
                     //we shouldn't write this because nothing is configured to generate this report.
                     outputDir = new File(current.getBuild().getDirectory());
                 }
                 writeReports(engine, current, outputDir);
             }
         }
         engine.cleanup();
         Settings.cleanup();
     }
 
     /**
      * Returns a set containing all the descendant projects of the given project.
      *
      * @param project the project for which all descendants will be returned
      * @return the set of descendant projects
      */
     protected Set<MavenProject> getDescendants(MavenProject project) {
         if (project == null) {
             return Collections.emptySet();
         }
         final Set<MavenProject> descendants = new HashSet<MavenProject>();
         int size = 0;
         if (getLog().isDebugEnabled()) {
             getLog().debug(String.format("Collecting descendants of %s", project.getName()));
         }
         for (String m : project.getModules()) {
             for (MavenProject mod : getReactorProjects()) {
                 try {
                     File mpp = new File(project.getBasedir(), m);
                     mpp = mpp.getCanonicalFile();
                     if (mpp.compareTo(mod.getBasedir()) == 0 && descendants.add(mod)) {
                         if (getLog().isDebugEnabled()) {
                             getLog().debug(String.format("Decendent module %s added", mod.getName()));
                         }
                     }
                 } catch (IOException ex) {
                     if (getLog().isDebugEnabled()) {
                         getLog().debug("Unable to determine module path", ex);
                     }
                 }
             }
         }
         do {
             size = descendants.size();
             for (MavenProject p : getReactorProjects()) {
                 if (project.equals(p.getParent()) || descendants.contains(p.getParent())) {
                     if (descendants.add(p)) {
                         if (getLog().isDebugEnabled()) {
                             getLog().debug(String.format("Decendent %s added", p.getName()));
                         }
                     }
                     for (MavenProject modTest : getReactorProjects()) {
                         if (p.getModules() != null && p.getModules().contains(modTest.getName())
                                 && descendants.add(modTest)) {
                             if (getLog().isDebugEnabled()) {
                                 getLog().debug(String.format("Decendent %s added", modTest.getName()));
                             }
                         }
                     }
                 }
                 for (MavenProject dec : descendants) {
                     for (String mod : dec.getModules()) {
                         try {
                             File mpp = new File(dec.getBasedir(), mod);
                             mpp = mpp.getCanonicalFile();
                             if (mpp.compareTo(p.getBasedir()) == 0 && descendants.add(p)) {
                                 if (getLog().isDebugEnabled()) {
                                     getLog().debug(String.format("Decendent module %s added", p.getName()));
                                 }
                             }
                         } catch (IOException ex) {
                             if (getLog().isDebugEnabled()) {
                                 getLog().debug("Unable to determine module path", ex);
                             }
                         }
                     }
                 }
             }
         } while (size != 0 && size != descendants.size());
         if (getLog().isDebugEnabled()) {
             getLog().debug(String.format("%s has %d children", project, descendants.size()));
         }
         return descendants;
     }
 
     /**
      * Test if the project has pom packaging
      *
      * @param mavenProject Project to test
      * @return <code>true</code> if it has a pom packaging; otherwise <code>false</code>
      */
     protected boolean isMultiModule(MavenProject mavenProject) {
         return "pom".equals(mavenProject.getPackaging());
     }
 
     /**
      * Initilizes the engine, runs a scan, and writes the serialized dependencies to disk.
      *
      * @return the Engine used to execute dependency-check
      * @throws MojoExecutionException thrown if there is an exception running the mojo
      * @throws MojoFailureException thrown if dependency-check is configured to fail the build if severe CVEs are identified.
      */
     protected Engine generateDataFile() throws MojoExecutionException, MojoFailureException {
         final Engine engine;
         try {
             engine = initializeEngine();
         } catch (DatabaseException ex) {
             if (getLog().isDebugEnabled()) {
                 getLog().debug("Database connection error", ex);
             }
             throw new MojoExecutionException("An exception occured connecting to the local database. Please see the log file for more details.", ex);
         }
         return generateDataFile(engine, getProject());
     }
 
     /**
      * Runs dependency-check's Engine and writes the serialized dependencies to disk.
      *
      * @param engine the Engine to use when scanning.
      * @param project the project to scan and generate the data file for
      * @return the Engine used to execute dependency-check
      * @throws MojoExecutionException thrown if there is an exception running the mojo
      * @throws MojoFailureException thrown if dependency-check is configured to fail the build if severe CVEs are identified.
      */
     protected Engine generateDataFile(Engine engine, MavenProject project) throws MojoExecutionException, MojoFailureException {
         if (getLog().isDebugEnabled()) {
             getLog().debug(String.format("Begin Scanning: %s", project.getName()));
         }
         engine.getDependencies().clear();
         engine.resetFileTypeAnalyzers();
         scanArtifacts(project, engine);
         engine.analyzeDependencies();
         final File target = new File(project.getBuild().getDirectory());
         writeDataFile(project, target, engine.getDependencies());
         showSummary(project, engine.getDependencies());
         checkForFailure(engine.getDependencies());
         return engine;
     }
 
     @Override
     public boolean canGenerateReport() {
         return true; //aggregate always returns true for now - we can look at a more complicated/acurate solution later
     }
 
     /**
      * Returns the report name.
      *
      * @param locale the location
      * @return the report name
      */
     @Override
     public String getName(Locale locale) {
         return "dependency-check:aggregate";
     }
 
     /**
      * Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.
      *
      * @param locale The Locale to get the description for
      * @return the description
      */
     @Override
     public String getDescription(Locale locale) {
         return "Generates an aggregate report of all child Maven projects providing details on any "
                 + "published vulnerabilities within project dependencies. This report is a best "
                 + "effort and may contain false positives and false negatives.";
     }
 }

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.util.ArrayList;
23		import java.util.Collections;
24		import java.util.HashSet;
25		import java.util.List;
26		import java.util.Locale;
27		import java.util.Set;
28		import org.apache.maven.plugin.MojoExecutionException;
29		import org.apache.maven.plugin.MojoFailureException;
30		import org.apache.maven.plugins.annotations.LifecyclePhase;
31		import org.apache.maven.plugins.annotations.Mojo;
32		import org.apache.maven.plugins.annotations.ResolutionScope;
33		import org.apache.maven.project.MavenProject;
34		import org.owasp.dependencycheck.analyzer.DependencyBundlingAnalyzer;
35		import org.owasp.dependencycheck.analyzer.exception.AnalysisException;
36		import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
37		import org.owasp.dependencycheck.dependency.Dependency;
38		import org.owasp.dependencycheck.utils.Settings;
39
40		/**
41		* Maven Plugin that checks project dependencies and the dependencies of all child modules to see if they have any known published
42		* vulnerabilities.
43		*
44		* @author Jeremy Long
45		*/
46		@Mojo(
47		name = "aggregate",
48		defaultPhase = LifecyclePhase.COMPILE,
49		/aggregator = true,/
50		threadSafe = true,
51		requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME,
52		requiresOnline = true
53		)
54	0	public class AggregateMojo extends BaseDependencyCheckMojo {
55
56		/**
57		* Executes the aggregate dependency-check goal. This runs dependency-check and generates the subsequent reports.
58		*
59		* @throws MojoExecutionException thrown if there is ane exception running the mojo
60		* @throws MojoFailureException thrown if dependency-check is configured to fail the build
61		*/
62		@Override
63		public void runCheck() throws MojoExecutionException, MojoFailureException {
64	0	final Engine engine = generateDataFile();
65
66	0	if (getProject() == getReactorProjects().get(getReactorProjects().size() - 1)) {
67
68		//ensure that the .ser file was created for each.
69	0	for (MavenProject current : getReactorProjects()) {
70	0	final File dataFile = getDataFile(current);
71	0	if (dataFile == null) { //dc was never run on this project. write the ser to the target.
72	0	getLog().error(String.format("Module '%s' did not execute dependency-check; an attempt will be made to perform "
73		+ "the check but dependencies may be missed resulting in false negatives.", current.getName()));
74	0	generateDataFile(engine, current);
75		}
76	0	}
77
78	0	for (MavenProject current : getReactorProjects()) {
79	0	List<Dependency> dependencies = readDataFile(current);
80	0	if (dependencies == null) {
81	0	dependencies = new ArrayList<Dependency>();
82		}
83	0	final Set<MavenProject> childProjects = getDescendants(current);
84	0	for (MavenProject reportOn : childProjects) {
85	0	final List<Dependency> childDeps = readDataFile(reportOn);
86	0	if (childDeps != null && !childDeps.isEmpty()) {
87	0	if (getLog().isDebugEnabled()) {
88	0	getLog().debug(String.format("Adding %d dependencies from %s", childDeps.size(), reportOn.getName()));
89		}
90	0	dependencies.addAll(childDeps);
91		} else {
92	0	if (getLog().isDebugEnabled()) {
93	0	getLog().debug(String.format("No dependencies read for %s", reportOn.getName()));
94		}
95		}
96	0	}
97	0	engine.getDependencies().clear();
98	0	engine.getDependencies().addAll(dependencies);
99	0	final DependencyBundlingAnalyzer bundler = new DependencyBundlingAnalyzer();
100		try {
101	0	if (getLog().isDebugEnabled()) {
102	0	getLog().debug(String.format("Dependency count pre-bundler: %s", engine.getDependencies().size()));
103		}
104	0	bundler.analyze(null, engine);
105	0	if (getLog().isDebugEnabled()) {
106	0	getLog().debug(String.format("Dependency count post-bundler: %s", engine.getDependencies().size()));
107		}
108	0	} catch (AnalysisException ex) {
109	0	getLog().warn("An error occured grouping the dependencies; duplicate entries may exist in the report", ex);
110	0	getLog().debug("Bundling Exception", ex);
111	0	}
112
113	0	File outputDir = getCorrectOutputDirectory(current);
114	0	if (outputDir == null) {
115		//in some regards we shouldn't be writting this, but we are anyway.
116		//we shouldn't write this because nothing is configured to generate this report.
117	0	outputDir = new File(current.getBuild().getDirectory());
118		}
119	0	writeReports(engine, current, outputDir);
120	0	}
121		}
122	0	engine.cleanup();
123	0	Settings.cleanup();
124	0	}
125
126		/**
127		* Returns a set containing all the descendant projects of the given project.
128		*
129		* @param project the project for which all descendants will be returned
130		* @return the set of descendant projects
131		*/
132		protected Set<MavenProject> getDescendants(MavenProject project) {
133	0	if (project == null) {
134	0	return Collections.emptySet();
135		}
136	0	final Set<MavenProject> descendants = new HashSet<MavenProject>();
137	0	int size = 0;
138	0	if (getLog().isDebugEnabled()) {
139	0	getLog().debug(String.format("Collecting descendants of %s", project.getName()));
140		}
141	0	for (String m : project.getModules()) {
142	0	for (MavenProject mod : getReactorProjects()) {
143		try {
144	0	File mpp = new File(project.getBasedir(), m);
145	0	mpp = mpp.getCanonicalFile();
146	0	if (mpp.compareTo(mod.getBasedir()) == 0 && descendants.add(mod)) {
147	0	if (getLog().isDebugEnabled()) {
148	0	getLog().debug(String.format("Decendent module %s added", mod.getName()));
149		}
150		}
151	0	} catch (IOException ex) {
152	0	if (getLog().isDebugEnabled()) {
153	0	getLog().debug("Unable to determine module path", ex);
154		}
155	0	}
156	0	}
157	0	}
158		do {
159	0	size = descendants.size();
160	0	for (MavenProject p : getReactorProjects()) {
161	0	if (project.equals(p.getParent()) \|\| descendants.contains(p.getParent())) {
162	0	if (descendants.add(p)) {
163	0	if (getLog().isDebugEnabled()) {
164	0	getLog().debug(String.format("Decendent %s added", p.getName()));
165		}
166		}
167	0	for (MavenProject modTest : getReactorProjects()) {
168	0	if (p.getModules() != null && p.getModules().contains(modTest.getName())
169		&& descendants.add(modTest)) {
170	0	if (getLog().isDebugEnabled()) {
171	0	getLog().debug(String.format("Decendent %s added", modTest.getName()));
172		}
173		}
174	0	}
175		}
176	0	for (MavenProject dec : descendants) {
177	0	for (String mod : dec.getModules()) {
178		try {
179	0	File mpp = new File(dec.getBasedir(), mod);
180	0	mpp = mpp.getCanonicalFile();
181	0	if (mpp.compareTo(p.getBasedir()) == 0 && descendants.add(p)) {
182	0	if (getLog().isDebugEnabled()) {
183	0	getLog().debug(String.format("Decendent module %s added", p.getName()));
184		}
185		}
186	0	} catch (IOException ex) {
187	0	if (getLog().isDebugEnabled()) {
188	0	getLog().debug("Unable to determine module path", ex);
189		}
190	0	}
191	0	}
192	0	}
193	0	}
194	0	} while (size != 0 && size != descendants.size());
195	0	if (getLog().isDebugEnabled()) {
196	0	getLog().debug(String.format("%s has %d children", project, descendants.size()));
197		}
198	0	return descendants;
199		}
200
201		/**
202		* Test if the project has pom packaging
203		*
204		* @param mavenProject Project to test
205		* @return <code>true</code> if it has a pom packaging; otherwise <code>false</code>
206		*/
207		protected boolean isMultiModule(MavenProject mavenProject) {
208	0	return "pom".equals(mavenProject.getPackaging());
209		}
210
211		/**
212		* Initilizes the engine, runs a scan, and writes the serialized dependencies to disk.
213		*
214		* @return the Engine used to execute dependency-check
215		* @throws MojoExecutionException thrown if there is an exception running the mojo
216		* @throws MojoFailureException thrown if dependency-check is configured to fail the build if severe CVEs are identified.
217		*/
218		protected Engine generateDataFile() throws MojoExecutionException, MojoFailureException {
219		final Engine engine;
220		try {
221	0	engine = initializeEngine();
222	0	} catch (DatabaseException ex) {
223	0	if (getLog().isDebugEnabled()) {
224	0	getLog().debug("Database connection error", ex);
225		}
226	0	throw new MojoExecutionException("An exception occured connecting to the local database. Please see the log file for more details.", ex);
227	0	}
228	0	return generateDataFile(engine, getProject());
229		}
230
231		/**
232		* Runs dependency-check's Engine and writes the serialized dependencies to disk.
233		*
234		* @param engine the Engine to use when scanning.
235		* @param project the project to scan and generate the data file for
236		* @return the Engine used to execute dependency-check
237		* @throws MojoExecutionException thrown if there is an exception running the mojo
238		* @throws MojoFailureException thrown if dependency-check is configured to fail the build if severe CVEs are identified.
239		*/
240		protected Engine generateDataFile(Engine engine, MavenProject project) throws MojoExecutionException, MojoFailureException {
241	0	if (getLog().isDebugEnabled()) {
242	0	getLog().debug(String.format("Begin Scanning: %s", project.getName()));
243		}
244	0	engine.getDependencies().clear();
245	0	engine.resetFileTypeAnalyzers();
246	0	scanArtifacts(project, engine);
247	0	engine.analyzeDependencies();
248	0	final File target = new File(project.getBuild().getDirectory());
249	0	writeDataFile(project, target, engine.getDependencies());
250	0	showSummary(project, engine.getDependencies());
251	0	checkForFailure(engine.getDependencies());
252	0	return engine;
253		}
254
255		@Override
256		public boolean canGenerateReport() {
257	0	return true; //aggregate always returns true for now - we can look at a more complicated/acurate solution later
258		}
259
260		/**
261		* Returns the report name.
262		*
263		* @param locale the location
264		* @return the report name
265		*/
266		@Override
267		public String getName(Locale locale) {
268	0	return "dependency-check:aggregate";
269		}
270
271		/**
272		* Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.
273		*
274		* @param locale The Locale to get the description for
275		* @return the description
276		*/
277		@Override
278		public String getDescription(Locale locale) {
279	0	return "Generates an aggregate report of all child Maven projects providing details on any "
280		+ "published vulnerabilities within project dependencies. This report is a best "
281		+ "effort and may contain false positives and false negatives.";
282		}
283		}