github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-03-18 07:14:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

version 1.4.3 documentation

Browse Source
This commit is contained in:
Jeremy Long
2016-09-06 08:48:40 -04:00
parent 44917ad0d3
commit e1a447f722
1225 changed files with 44138 additions and 39411 deletions
Download Patch File Download Diff File Expand all files Collapse all files

625
dependency-check-maven/xref/org/owasp/dependencycheck/maven/AggregateMojo.html
View File

@@ -27,366 +27,273 @@
<a class="jxr_linenumber" name="L19" href="#L19">19</a>
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.Collections;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.HashSet;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.Set;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.ResolutionScope;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.DependencyBundlingAnalyzer;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.exception.AnalysisException;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.DatabaseException;
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Dependency;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.exception.ExceptionCollection;
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.exception.ReportException;
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Settings;
<a class="jxr_linenumber" name="L42" href="#L42">42</a>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * Maven Plugin that checks project dependencies and the dependencies of all</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * child modules to see if they have any known published vulnerabilities.</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> @Mojo(
<a class="jxr_linenumber" name="L50" href="#L50">50</a> name = <span class="jxr_string">"aggregate"</span>,
<a class="jxr_linenumber" name="L51" href="#L51">51</a> defaultPhase = LifecyclePhase.VERIFY,
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_comment">/*aggregator = true,*/</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> threadSafe = false,
<a class="jxr_linenumber" name="L54" href="#L54">54</a> requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME,
<a class="jxr_linenumber" name="L55" href="#L55">55</a> requiresOnline = <strong class="jxr_keyword">true</strong>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> )
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html">AggregateMojo</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html">BaseDependencyCheckMojo</a> {
<a class="jxr_linenumber" name="L58" href="#L58">58</a>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * The key to store aggregate exception in the root Maven execution context.</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String AGGREGATE_EXCEPTIONS = <span class="jxr_string">"AggregateExceptions"</span>;
<a class="jxr_linenumber" name="L63" href="#L63">63</a>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * Executes the aggregate dependency-check goal. This runs dependency-check</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * and generates the subsequent reports.</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException thrown if there is ane exception running</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * the mojo</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if dependency-check is configured to</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * fail the build</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> @Override
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> runCheck() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html">MavenEngine</a> engine = generateDataFile();
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">if</strong> (engine == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="L78" href="#L78">78</a> }
<a class="jxr_linenumber" name="L79" href="#L79">79</a>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">if</strong> (getProject() == getLastProject()) {
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_comment">//ensure that the .ser file was created for each.</em>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">for</strong> (MavenProject current : getReactorProjects()) {
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">final</strong> File dataFile = getDataFile(current);
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">if</strong> (dataFile == <strong class="jxr_keyword">null</strong> &amp;&amp; !skipProject(current)) { <em class="jxr_comment">//dc was never run on this project. write the ser to the target.</em>
<a class="jxr_linenumber" name="L85" href="#L85">85</a> getLog().error(String.format(<span class="jxr_string">"Module '%s' did not execute dependency-check; an attempt will be made to perform "</span>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> + <span class="jxr_string">"the check but dependencies may be missed resulting in false negatives."</span>, current.getName()));
<a class="jxr_linenumber" name="L87" href="#L87">87</a> generateDataFile(engine, current);
<a class="jxr_linenumber" name="L88" href="#L88">88</a> }
<a class="jxr_linenumber" name="L89" href="#L89">89</a> }
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">for</strong> (MavenProject current : getReactorProjects()) {
<a class="jxr_linenumber" name="L91" href="#L91">91</a> List&lt;Dependency&gt; dependencies = readDataFile(current);
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">if</strong> (dependencies == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L93" href="#L93">93</a> dependencies = <strong class="jxr_keyword">new</strong> ArrayList&lt;Dependency&gt;();
<a class="jxr_linenumber" name="L94" href="#L94">94</a> }
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">final</strong> Set&lt;MavenProject&gt; childProjects = getDescendants(current);
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">for</strong> (MavenProject reportOn : childProjects) {
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">final</strong> List&lt;Dependency&gt; childDeps = readDataFile(reportOn);
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">if</strong> (childDeps != <strong class="jxr_keyword">null</strong> &amp;&amp; !childDeps.isEmpty()) {
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L100" href="#L100">100</a> getLog().debug(String.format(<span class="jxr_string">"Adding %d dependencies from %s"</span>, childDeps.size(), reportOn.getName()));
<a class="jxr_linenumber" name="L101" href="#L101">101</a> }
<a class="jxr_linenumber" name="L102" href="#L102">102</a> dependencies.addAll(childDeps);
<a class="jxr_linenumber" name="L103" href="#L103">103</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L104" href="#L104">104</a> getLog().debug(String.format(<span class="jxr_string">"No dependencies read for %s"</span>, reportOn.getName()));
<a class="jxr_linenumber" name="L105" href="#L105">105</a> }
<a class="jxr_linenumber" name="L106" href="#L106">106</a> }
<a class="jxr_linenumber" name="L107" href="#L107">107</a> engine.getDependencies().clear();
<a class="jxr_linenumber" name="L108" href="#L108">108</a> engine.getDependencies().addAll(dependencies);
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">final</strong> DependencyBundlingAnalyzer bundler = <strong class="jxr_keyword">new</strong> DependencyBundlingAnalyzer();
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L112" href="#L112">112</a> getLog().debug(String.format(<span class="jxr_string">"Dependency count pre-bundler: %s"</span>, engine.getDependencies().size()));
<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
<a class="jxr_linenumber" name="L114" href="#L114">114</a> bundler.analyze(<strong class="jxr_keyword">null</strong>, engine);
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L116" href="#L116">116</a> getLog().debug(String.format(<span class="jxr_string">"Dependency count post-bundler: %s"</span>, engine.getDependencies().size()));
<a class="jxr_linenumber" name="L117" href="#L117">117</a> }
<a class="jxr_linenumber" name="L118" href="#L118">118</a> } <strong class="jxr_keyword">catch</strong> (AnalysisException ex) {
<a class="jxr_linenumber" name="L119" href="#L119">119</a> getLog().warn(<span class="jxr_string">"An error occurred grouping the dependencies; duplicate entries may exist in the report"</span>, ex);
<a class="jxr_linenumber" name="L120" href="#L120">120</a> getLog().debug(<span class="jxr_string">"Bundling Exception"</span>, ex);
<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
<a class="jxr_linenumber" name="L122" href="#L122">122</a>
<a class="jxr_linenumber" name="L123" href="#L123">123</a> File outputDir = getCorrectOutputDirectory(current);
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">if</strong> (outputDir == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_comment">//in some regards we shouldn't be writting this, but we are anyway.</em>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_comment">//we shouldn't write this because nothing is configured to generate this report.</em>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> outputDir = <strong class="jxr_keyword">new</strong> File(current.getBuild().getDirectory());
<a class="jxr_linenumber" name="L128" href="#L128">128</a> }
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L130" href="#L130">130</a> writeReports(engine, current, outputDir);
<a class="jxr_linenumber" name="L131" href="#L131">131</a> } <strong class="jxr_keyword">catch</strong> (ReportException ex) {
<a class="jxr_linenumber" name="L132" href="#L132">132</a> ExceptionCollection exCol = (ExceptionCollection) engine.getExecutionRoot().getContextValue(AGGREGATE_EXCEPTIONS);
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">if</strong> (exCol == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L134" href="#L134">134</a> exCol = <strong class="jxr_keyword">new</strong> ExceptionCollection(<span class="jxr_string">"Error writing aggregate report"</span>, ex);
<a class="jxr_linenumber" name="L135" href="#L135">135</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L136" href="#L136">136</a> exCol.addException(ex);
<a class="jxr_linenumber" name="L137" href="#L137">137</a> }
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"One or more exceptions occured during dependency-check analysis"</span>, exCol);
<a class="jxr_linenumber" name="L140" href="#L140">140</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L141" href="#L141">141</a> getLog().debug(<span class="jxr_string">"One or more exceptions occured during dependency-check analysis"</span>, exCol);
<a class="jxr_linenumber" name="L142" href="#L142">142</a> }
<a class="jxr_linenumber" name="L143" href="#L143">143</a> }
<a class="jxr_linenumber" name="L144" href="#L144">144</a> }
<a class="jxr_linenumber" name="L145" href="#L145">145</a> }
<a class="jxr_linenumber" name="L146" href="#L146">146</a> engine.cleanup();
<a class="jxr_linenumber" name="L147" href="#L147">147</a> Settings.cleanup();
<a class="jxr_linenumber" name="L148" href="#L148">148</a> }
<a class="jxr_linenumber" name="L149" href="#L149">149</a>
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * Gets the last project in the reactor - taking into account skipped</em>
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * projects.</em>
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * @return the last project in the reactor</em>
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">private</strong> MavenProject getLastProject() {
<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> x = getReactorProjects().size() - 1; x &gt;= 0; x--) {
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">final</strong> MavenProject p = getReactorProjects().get(x);
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">if</strong> (!skipProject(p)) {
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">return</strong> p;
<a class="jxr_linenumber" name="L161" href="#L161">161</a> }
<a class="jxr_linenumber" name="L162" href="#L162">162</a> }
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L164" href="#L164">164</a> }
<a class="jxr_linenumber" name="L165" href="#L165">165</a>
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * Tests if the project is being skipped in the Maven site report.</em>
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * @param project a project in the reactor</em>
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * @return true if the project is skipped; otherwise false</em>
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipProject(MavenProject project) {
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">final</strong> String skip = (String) project.getProperties().get(<span class="jxr_string">"maven.site.skip"</span>);
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"true"</span>.equalsIgnoreCase(skip) &amp;&amp; isGeneratingSite();
<a class="jxr_linenumber" name="L175" href="#L175">175</a> }
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.Collections;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.HashSet;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.Set;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.ResolutionScope;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.DatabaseException;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.exception.ExceptionCollection;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.exception.ReportException;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Settings;
<a class="jxr_linenumber" name="L37" href="#L37">37</a>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * Maven Plugin that checks project dependencies and the dependencies of all</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * child modules to see if they have any known published vulnerabilities.</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> @Mojo(
<a class="jxr_linenumber" name="L45" href="#L45">45</a> name = <span class="jxr_string">"aggregate"</span>,
<a class="jxr_linenumber" name="L46" href="#L46">46</a> defaultPhase = LifecyclePhase.VERIFY,
<a class="jxr_linenumber" name="L47" href="#L47">47</a> aggregator = <strong class="jxr_keyword">true</strong>,
<a class="jxr_linenumber" name="L48" href="#L48">48</a> threadSafe = false,
<a class="jxr_linenumber" name="L49" href="#L49">49</a> requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME,
<a class="jxr_linenumber" name="L50" href="#L50">50</a> requiresOnline = <strong class="jxr_keyword">true</strong>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> )
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html">AggregateMojo</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html">BaseDependencyCheckMojo</a> {
<a class="jxr_linenumber" name="L53" href="#L53">53</a>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * Executes the aggregate dependency-check goal. This runs dependency-check</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * and generates the subsequent reports.</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException thrown if there is ane exception running</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * the mojo</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if dependency-check is configured to</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * fail the build</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> @Override
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> runCheck() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html">MavenEngine</a> engine = loadEngine();
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">if</strong> (engine == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="L68" href="#L68">68</a> }
<a class="jxr_linenumber" name="L69" href="#L69">69</a>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> ExceptionCollection exCol = scanArtifacts(getProject(), engine);
<a class="jxr_linenumber" name="L71" href="#L71">71</a>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">for</strong> (MavenProject childProject : getDescendants(<strong class="jxr_keyword">this</strong>.getProject())) {
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">final</strong> ExceptionCollection ex = scanArtifacts(childProject, engine);
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">if</strong> (ex != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">if</strong> (exCol == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L76" href="#L76">76</a> exCol = ex;
<a class="jxr_linenumber" name="L77" href="#L77">77</a> }
<a class="jxr_linenumber" name="L78" href="#L78">78</a> exCol.getExceptions().addAll(ex.getExceptions());
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">if</strong> (ex.isFatal()) {
<a class="jxr_linenumber" name="L80" href="#L80">80</a> exCol.setFatal(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="L81" href="#L81">81</a> }
<a class="jxr_linenumber" name="L82" href="#L82">82</a> }
<a class="jxr_linenumber" name="L83" href="#L83">83</a> }
<a class="jxr_linenumber" name="L84" href="#L84">84</a>
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L86" href="#L86">86</a> engine.analyzeDependencies();
<a class="jxr_linenumber" name="L87" href="#L87">87</a> } <strong class="jxr_keyword">catch</strong> (ExceptionCollection ex) {
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">if</strong> (exCol == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L89" href="#L89">89</a> exCol = ex;
<a class="jxr_linenumber" name="L90" href="#L90">90</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (ex.isFatal()) {
<a class="jxr_linenumber" name="L91" href="#L91">91</a> exCol.setFatal(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="L92" href="#L92">92</a> exCol.getExceptions().addAll(ex.getExceptions());
<a class="jxr_linenumber" name="L93" href="#L93">93</a> }
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">if</strong> (exCol.isFatal()) {
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Fatal exception(s) analyzing %s"</span>, getProject().getName());
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(msg, exCol);
<a class="jxr_linenumber" name="L98" href="#L98">98</a> }
<a class="jxr_linenumber" name="L99" href="#L99">99</a> getLog().error(msg);
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L101" href="#L101">101</a> getLog().debug(exCol);
<a class="jxr_linenumber" name="L102" href="#L102">102</a> }
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="L104" href="#L104">104</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Exception(s) analyzing %s"</span>, getProject().getName());
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L107" href="#L107">107</a> getLog().debug(msg, exCol);
<a class="jxr_linenumber" name="L108" href="#L108">108</a> }
<a class="jxr_linenumber" name="L109" href="#L109">109</a> }
<a class="jxr_linenumber" name="L110" href="#L110">110</a> }
<a class="jxr_linenumber" name="L111" href="#L111">111</a> File outputDir = getCorrectOutputDirectory(<strong class="jxr_keyword">this</strong>.getProject());
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">if</strong> (outputDir == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_comment">//in some regards we shouldn't be writting this, but we are anyway.</em>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_comment">//we shouldn't write this because nothing is configured to generate this report.</em>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> outputDir = <strong class="jxr_keyword">new</strong> File(<strong class="jxr_keyword">this</strong>.getProject().getBuild().getDirectory());
<a class="jxr_linenumber" name="L116" href="#L116">116</a> }
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L118" href="#L118">118</a> writeReports(engine, <strong class="jxr_keyword">this</strong>.getProject(), outputDir);
<a class="jxr_linenumber" name="L119" href="#L119">119</a> } <strong class="jxr_keyword">catch</strong> (ReportException ex) {
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">if</strong> (exCol == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L121" href="#L121">121</a> exCol = <strong class="jxr_keyword">new</strong> ExceptionCollection(<span class="jxr_string">"Error writing aggregate report"</span>, ex);
<a class="jxr_linenumber" name="L122" href="#L122">122</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L123" href="#L123">123</a> exCol.addException(ex);
<a class="jxr_linenumber" name="L124" href="#L124">124</a> }
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"One or more exceptions occured during dependency-check analysis"</span>, exCol);
<a class="jxr_linenumber" name="L127" href="#L127">127</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L128" href="#L128">128</a> getLog().debug(<span class="jxr_string">"One or more exceptions occured during dependency-check analysis"</span>, exCol);
<a class="jxr_linenumber" name="L129" href="#L129">129</a> }
<a class="jxr_linenumber" name="L130" href="#L130">130</a> }
<a class="jxr_linenumber" name="L131" href="#L131">131</a> showSummary(<strong class="jxr_keyword">this</strong>.getProject(), engine.getDependencies());
<a class="jxr_linenumber" name="L132" href="#L132">132</a> checkForFailure(engine.getDependencies());
<a class="jxr_linenumber" name="L133" href="#L133">133</a> engine.cleanup();
<a class="jxr_linenumber" name="L134" href="#L134">134</a> Settings.cleanup();
<a class="jxr_linenumber" name="L135" href="#L135">135</a> }
<a class="jxr_linenumber" name="L136" href="#L136">136</a>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * Returns a set containing all the descendant projects of the given</em>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * project.</em>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * @param project the project for which all descendants will be returned</em>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * @return the set of descendant projects</em>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">protected</strong> Set&lt;MavenProject&gt; getDescendants(MavenProject project) {
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">if</strong> (project == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">return</strong> Collections.emptySet();
<a class="jxr_linenumber" name="L147" href="#L147">147</a> }
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">final</strong> Set&lt;MavenProject&gt; descendants = <strong class="jxr_keyword">new</strong> HashSet&lt;MavenProject&gt;();
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">int</strong> size = 0;
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L151" href="#L151">151</a> getLog().debug(String.format(<span class="jxr_string">"Collecting descendants of %s"</span>, project.getName()));
<a class="jxr_linenumber" name="L152" href="#L152">152</a> }
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">for</strong> (String m : project.getModules()) {
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">for</strong> (MavenProject mod : getReactorProjects()) {
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L156" href="#L156">156</a> File mpp = <strong class="jxr_keyword">new</strong> File(project.getBasedir(), m);
<a class="jxr_linenumber" name="L157" href="#L157">157</a> mpp = mpp.getCanonicalFile();
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">if</strong> (mpp.compareTo(mod.getBasedir()) == 0 &amp;&amp; descendants.add(mod)
<a class="jxr_linenumber" name="L159" href="#L159">159</a> &amp;&amp; getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L160" href="#L160">160</a> getLog().debug(String.format(<span class="jxr_string">"Decendent module %s added"</span>, mod.getName()));
<a class="jxr_linenumber" name="L161" href="#L161">161</a>
<a class="jxr_linenumber" name="L162" href="#L162">162</a> }
<a class="jxr_linenumber" name="L163" href="#L163">163</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L165" href="#L165">165</a> getLog().debug(<span class="jxr_string">"Unable to determine module path"</span>, ex);
<a class="jxr_linenumber" name="L166" href="#L166">166</a> }
<a class="jxr_linenumber" name="L167" href="#L167">167</a> }
<a class="jxr_linenumber" name="L168" href="#L168">168</a> }
<a class="jxr_linenumber" name="L169" href="#L169">169</a> }
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">do</strong> {
<a class="jxr_linenumber" name="L171" href="#L171">171</a> size = descendants.size();
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">for</strong> (MavenProject p : getReactorProjects()) {
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">if</strong> (project.equals(p.getParent()) || descendants.contains(p.getParent())) {
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">if</strong> (descendants.add(p) &amp;&amp; getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L175" href="#L175">175</a> getLog().debug(String.format(<span class="jxr_string">"Decendent %s added"</span>, p.getName()));
<a class="jxr_linenumber" name="L176" href="#L176">176</a>
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * Returns a set containing all the descendant projects of the given</em>
<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * project.</em>
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * @param project the project for which all descendants will be returned</em>
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * @return the set of descendant projects</em>
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">protected</strong> Set&lt;MavenProject&gt; getDescendants(MavenProject project) {
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">if</strong> (project == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">return</strong> Collections.emptySet();
<a class="jxr_linenumber" name="L187" href="#L187">187</a> }
<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">final</strong> Set&lt;MavenProject&gt; descendants = <strong class="jxr_keyword">new</strong> HashSet&lt;MavenProject&gt;();
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">int</strong> size = 0;
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L191" href="#L191">191</a> getLog().debug(String.format(<span class="jxr_string">"Collecting descendants of %s"</span>, project.getName()));
<a class="jxr_linenumber" name="L192" href="#L192">192</a> }
<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">for</strong> (String m : project.getModules()) {
<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">for</strong> (MavenProject mod : getReactorProjects()) {
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L196" href="#L196">196</a> File mpp = <strong class="jxr_keyword">new</strong> File(project.getBasedir(), m);
<a class="jxr_linenumber" name="L197" href="#L197">197</a> mpp = mpp.getCanonicalFile();
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">if</strong> (mpp.compareTo(mod.getBasedir()) == 0 &amp;&amp; descendants.add(mod)
<a class="jxr_linenumber" name="L199" href="#L199">199</a> &amp;&amp; getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L200" href="#L200">200</a> getLog().debug(String.format(<span class="jxr_string">"Decendent module %s added"</span>, mod.getName()));
<a class="jxr_linenumber" name="L201" href="#L201">201</a>
<a class="jxr_linenumber" name="L202" href="#L202">202</a> }
<a class="jxr_linenumber" name="L203" href="#L203">203</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L205" href="#L205">205</a> getLog().debug(<span class="jxr_string">"Unable to determine module path"</span>, ex);
<a class="jxr_linenumber" name="L206" href="#L206">206</a> }
<a class="jxr_linenumber" name="L207" href="#L207">207</a> }
<a class="jxr_linenumber" name="L208" href="#L208">208</a> }
<a class="jxr_linenumber" name="L209" href="#L209">209</a> }
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">do</strong> {
<a class="jxr_linenumber" name="L211" href="#L211">211</a> size = descendants.size();
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">for</strong> (MavenProject p : getReactorProjects()) {
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">if</strong> (project.equals(p.getParent()) || descendants.contains(p.getParent())) {
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">if</strong> (descendants.add(p) &amp;&amp; getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L215" href="#L215">215</a> getLog().debug(String.format(<span class="jxr_string">"Decendent %s added"</span>, p.getName()));
<a class="jxr_linenumber" name="L216" href="#L216">216</a>
<a class="jxr_linenumber" name="L217" href="#L217">217</a> }
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">for</strong> (MavenProject modTest : getReactorProjects()) {
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">if</strong> (p.getModules() != <strong class="jxr_keyword">null</strong> &amp;&amp; p.getModules().contains(modTest.getName())
<a class="jxr_linenumber" name="L220" href="#L220">220</a> &amp;&amp; descendants.add(modTest)
<a class="jxr_linenumber" name="L221" href="#L221">221</a> &amp;&amp; getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L222" href="#L222">222</a> getLog().debug(String.format(<span class="jxr_string">"Decendent %s added"</span>, modTest.getName()));
<a class="jxr_linenumber" name="L223" href="#L223">223</a> }
<a class="jxr_linenumber" name="L224" href="#L224">224</a> }
<a class="jxr_linenumber" name="L225" href="#L225">225</a> }
<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">final</strong> Set&lt;MavenProject&gt; addedDescendants = <strong class="jxr_keyword">new</strong> HashSet&lt;MavenProject&gt;();
<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">for</strong> (MavenProject dec : descendants) {
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">for</strong> (String mod : dec.getModules()) {
<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L230" href="#L230">230</a> File mpp = <strong class="jxr_keyword">new</strong> File(dec.getBasedir(), mod);
<a class="jxr_linenumber" name="L231" href="#L231">231</a> mpp = mpp.getCanonicalFile();
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">if</strong> (mpp.compareTo(p.getBasedir()) == 0) {
<a class="jxr_linenumber" name="L233" href="#L233">233</a> addedDescendants.add(p);
<a class="jxr_linenumber" name="L234" href="#L234">234</a> }
<a class="jxr_linenumber" name="L235" href="#L235">235</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L237" href="#L237">237</a> getLog().debug(<span class="jxr_string">"Unable to determine module path"</span>, ex);
<a class="jxr_linenumber" name="L238" href="#L238">238</a> }
<a class="jxr_linenumber" name="L239" href="#L239">239</a> }
<a class="jxr_linenumber" name="L240" href="#L240">240</a> }
<a class="jxr_linenumber" name="L241" href="#L241">241</a> }
<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">for</strong> (MavenProject addedDescendant : addedDescendants) {
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">if</strong> (descendants.add(addedDescendant) &amp;&amp; getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L244" href="#L244">244</a> getLog().debug(String.format(<span class="jxr_string">"Decendent module %s added"</span>, addedDescendant.getName()));
<a class="jxr_linenumber" name="L245" href="#L245">245</a> }
<a class="jxr_linenumber" name="L246" href="#L246">246</a> }
<a class="jxr_linenumber" name="L247" href="#L247">247</a> }
<a class="jxr_linenumber" name="L248" href="#L248">248</a> } <strong class="jxr_keyword">while</strong> (size != 0 &amp;&amp; size != descendants.size());
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L250" href="#L250">250</a> getLog().debug(String.format(<span class="jxr_string">"%s has %d children"</span>, project, descendants.size()));
<a class="jxr_linenumber" name="L251" href="#L251">251</a> }
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">return</strong> descendants;
<a class="jxr_linenumber" name="L253" href="#L253">253</a> }
<a class="jxr_linenumber" name="L254" href="#L254">254</a>
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * Test if the project has pom packaging</em>
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * @param mavenProject Project to test</em>
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * @return &lt;code&gt;true&lt;/code&gt; if it has a pom packaging; otherwise</em>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> * &lt;code&gt;false&lt;/code&gt;</em>
<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isMultiModule(MavenProject mavenProject) {
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"pom"</span>.equals(mavenProject.getPackaging());
<a class="jxr_linenumber" name="L264" href="#L264">264</a> }
<a class="jxr_linenumber" name="L265" href="#L265">265</a>
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * Initializes the engine, runs a scan, and writes the serialized</em>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * dependencies to disk.</em>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> * @return the MavenEngine used to execute dependency-check</em>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException thrown if there is an exception running</em>
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * the mojo</em>
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if dependency-check is configured to</em>
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> * fail the build if severe CVEs are identified.</em>
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html">MavenEngine</a> generateDataFile() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
<a class="jxr_linenumber" name="L277" href="#L277">277</a> <a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html">MavenEngine</a> engine = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L279" href="#L279">279</a> engine = initializeEngine();
<a class="jxr_linenumber" name="L280" href="#L280">280</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L282" href="#L282">282</a> getLog().debug(<span class="jxr_string">"Database connection error"</span>, ex);
<a class="jxr_linenumber" name="L283" href="#L283">283</a> }
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">final</strong> String msg = <span class="jxr_string">"An exception occured connecting to the local database. Please see the log file for more details."</span>;
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(msg, ex);
<a class="jxr_linenumber" name="L287" href="#L287">287</a> }
<a class="jxr_linenumber" name="L288" href="#L288">288</a> getLog().error(msg, ex);
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L290" href="#L290">290</a> }
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">return</strong> generateDataFile(engine, getProject());
<a class="jxr_linenumber" name="L292" href="#L292">292</a> }
<a class="jxr_linenumber" name="L293" href="#L293">293</a>
<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment"> * Runs dependency-check's MavenEngine and writes the serialized</em>
<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> * dependencies to disk.</em>
<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> * @param engine the MavenEngine to use when scanning.</em>
<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment"> * @param project the project to scan and generate the data file for</em>
<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> * @return the MavenEngine used to execute dependency-check</em>
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException thrown if there is an exception running</em>
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> * the mojo</em>
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if dependency-check is configured to</em>
<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> * fail the build if severe CVEs are identified.</em>
<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html">MavenEngine</a> generateDataFile(<a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html">MavenEngine</a> engine, MavenProject project) <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
<a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L308" href="#L308">308</a> getLog().debug(String.format(<span class="jxr_string">"Begin Scanning: %s"</span>, project.getName()));
<a class="jxr_linenumber" name="L309" href="#L309">309</a> }
<a class="jxr_linenumber" name="L310" href="#L310">310</a> engine.getDependencies().clear();
<a class="jxr_linenumber" name="L311" href="#L311">311</a> engine.resetFileTypeAnalyzers();
<a class="jxr_linenumber" name="L312" href="#L312">312</a> scanArtifacts(project, engine);
<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L314" href="#L314">314</a> engine.analyzeDependencies();
<a class="jxr_linenumber" name="L315" href="#L315">315</a> } <strong class="jxr_keyword">catch</strong> (ExceptionCollection ex) {
<a class="jxr_linenumber" name="L316" href="#L316">316</a> ExceptionCollection col = (ExceptionCollection) engine.getExecutionRoot().getContextValue(AGGREGATE_EXCEPTIONS);
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <strong class="jxr_keyword">if</strong> (col == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L318" href="#L318">318</a> col = ex;
<a class="jxr_linenumber" name="L319" href="#L319">319</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (ex.isFatal()) {
<a class="jxr_linenumber" name="L320" href="#L320">320</a> col.setFatal(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="L321" href="#L321">321</a> col.getExceptions().addAll(ex.getExceptions());
<a class="jxr_linenumber" name="L322" href="#L322">322</a> }
<a class="jxr_linenumber" name="L323" href="#L323">323</a> <strong class="jxr_keyword">if</strong> (col.isFatal()) {
<a class="jxr_linenumber" name="L324" href="#L324">324</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Fatal exception(s) analyzing %s"</span>, project.getName());
<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(msg, ex);
<a class="jxr_linenumber" name="L327" href="#L327">327</a> }
<a class="jxr_linenumber" name="L328" href="#L328">328</a> getLog().error(msg, col);
<a class="jxr_linenumber" name="L329" href="#L329">329</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L330" href="#L330">330</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Exception(s) analyzing %s"</span>, project.getName());
<a class="jxr_linenumber" name="L332" href="#L332">332</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L333" href="#L333">333</a> getLog().debug(msg, ex);
<a class="jxr_linenumber" name="L334" href="#L334">334</a> }
<a class="jxr_linenumber" name="L335" href="#L335">335</a> engine.getExecutionRoot().setContextValue(AGGREGATE_EXCEPTIONS, col);
<a class="jxr_linenumber" name="L336" href="#L336">336</a> }
<a class="jxr_linenumber" name="L337" href="#L337">337</a> }
<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">final</strong> File target = <strong class="jxr_keyword">new</strong> File(project.getBuild().getDirectory());
<a class="jxr_linenumber" name="L339" href="#L339">339</a> writeDataFile(project, target, engine.getDependencies());
<a class="jxr_linenumber" name="L340" href="#L340">340</a> showSummary(project, engine.getDependencies());
<a class="jxr_linenumber" name="L341" href="#L341">341</a> checkForFailure(engine.getDependencies());
<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">return</strong> engine;
<a class="jxr_linenumber" name="L343" href="#L343">343</a> }
<a class="jxr_linenumber" name="L344" href="#L344">344</a>
<a class="jxr_linenumber" name="L345" href="#L345">345</a> @Override
<a class="jxr_linenumber" name="L346" href="#L346">346</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() {
<a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; <em class="jxr_comment">//aggregate always returns true for now - we can look at a more complicated/acurate solution later</em>
<a class="jxr_linenumber" name="L348" href="#L348">348</a> }
<a class="jxr_linenumber" name="L349" href="#L349">349</a>
<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> * The name of the report in the site.</em>
<a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L353" href="#L353">353</a> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L354" href="#L354">354</a> @Parameter(property = <span class="jxr_string">"name"</span>, defaultValue = <span class="jxr_string">"dependency-check:aggregate"</span>, required = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong class="jxr_keyword">private</strong> String name = <span class="jxr_string">"dependency-check:aggregate"</span>;
<a class="jxr_linenumber" name="L356" href="#L356">356</a>
<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_javadoccomment"> * Returns the report name.</em>
<a class="jxr_linenumber" name="L359" href="#L359">359</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L360" href="#L360">360</a> <em class="jxr_javadoccomment"> * @param locale the location</em>
<a class="jxr_linenumber" name="L361" href="#L361">361</a> <em class="jxr_javadoccomment"> * @return the report name</em>
<a class="jxr_linenumber" name="L362" href="#L362">362</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L363" href="#L363">363</a> @Override
<a class="jxr_linenumber" name="L364" href="#L364">364</a> <strong class="jxr_keyword">public</strong> String getName(Locale locale) {
<a class="jxr_linenumber" name="L365" href="#L365">365</a> <strong class="jxr_keyword">return</strong> name;
<a class="jxr_linenumber" name="L366" href="#L366">366</a> }
<a class="jxr_linenumber" name="L367" href="#L367">367</a>
<a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment"> * Gets the description of the Dependency-Check report to be displayed in</em>
<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> * the Maven Generated Reports page.</em>
<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em class="jxr_javadoccomment"> * @param locale The Locale to get the description for</em>
<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em class="jxr_javadoccomment"> * @return the description</em>
<a class="jxr_linenumber" name="L374" href="#L374">374</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L375" href="#L375">375</a> @Override
<a class="jxr_linenumber" name="L376" href="#L376">376</a> <strong class="jxr_keyword">public</strong> String getDescription(Locale locale) {
<a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"Generates an aggregate report of all child Maven projects providing details on any "</span>
<a class="jxr_linenumber" name="L378" href="#L378">378</a> + <span class="jxr_string">"published vulnerabilities within project dependencies. This report is a best "</span>
<a class="jxr_linenumber" name="L379" href="#L379">379</a> + <span class="jxr_string">"effort and may contain false positives and false negatives."</span>;
<a class="jxr_linenumber" name="L380" href="#L380">380</a> }
<a class="jxr_linenumber" name="L381" href="#L381">381</a> }
<a class="jxr_linenumber" name="L177" href="#L177">177</a> }
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">for</strong> (MavenProject modTest : getReactorProjects()) {
<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">if</strong> (p.getModules() != <strong class="jxr_keyword">null</strong> &amp;&amp; p.getModules().contains(modTest.getName())
<a class="jxr_linenumber" name="L180" href="#L180">180</a> &amp;&amp; descendants.add(modTest)
<a class="jxr_linenumber" name="L181" href="#L181">181</a> &amp;&amp; getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L182" href="#L182">182</a> getLog().debug(String.format(<span class="jxr_string">"Decendent %s added"</span>, modTest.getName()));
<a class="jxr_linenumber" name="L183" href="#L183">183</a> }
<a class="jxr_linenumber" name="L184" href="#L184">184</a> }
<a class="jxr_linenumber" name="L185" href="#L185">185</a> }
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">final</strong> Set&lt;MavenProject&gt; addedDescendants = <strong class="jxr_keyword">new</strong> HashSet&lt;MavenProject&gt;();
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">for</strong> (MavenProject dec : descendants) {
<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">for</strong> (String mod : dec.getModules()) {
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L190" href="#L190">190</a> File mpp = <strong class="jxr_keyword">new</strong> File(dec.getBasedir(), mod);
<a class="jxr_linenumber" name="L191" href="#L191">191</a> mpp = mpp.getCanonicalFile();
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">if</strong> (mpp.compareTo(p.getBasedir()) == 0) {
<a class="jxr_linenumber" name="L193" href="#L193">193</a> addedDescendants.add(p);
<a class="jxr_linenumber" name="L194" href="#L194">194</a> }
<a class="jxr_linenumber" name="L195" href="#L195">195</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L197" href="#L197">197</a> getLog().debug(<span class="jxr_string">"Unable to determine module path"</span>, ex);
<a class="jxr_linenumber" name="L198" href="#L198">198</a> }
<a class="jxr_linenumber" name="L199" href="#L199">199</a> }
<a class="jxr_linenumber" name="L200" href="#L200">200</a> }
<a class="jxr_linenumber" name="L201" href="#L201">201</a> }
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">for</strong> (MavenProject addedDescendant : addedDescendants) {
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">if</strong> (descendants.add(addedDescendant) &amp;&amp; getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L204" href="#L204">204</a> getLog().debug(String.format(<span class="jxr_string">"Decendent module %s added"</span>, addedDescendant.getName()));
<a class="jxr_linenumber" name="L205" href="#L205">205</a> }
<a class="jxr_linenumber" name="L206" href="#L206">206</a> }
<a class="jxr_linenumber" name="L207" href="#L207">207</a> }
<a class="jxr_linenumber" name="L208" href="#L208">208</a> } <strong class="jxr_keyword">while</strong> (size != 0 &amp;&amp; size != descendants.size());
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L210" href="#L210">210</a> getLog().debug(String.format(<span class="jxr_string">"%s has %d children"</span>, project, descendants.size()));
<a class="jxr_linenumber" name="L211" href="#L211">211</a> }
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">return</strong> descendants;
<a class="jxr_linenumber" name="L213" href="#L213">213</a> }
<a class="jxr_linenumber" name="L214" href="#L214">214</a>
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * Test if the project has pom packaging</em>
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> * @param mavenProject Project to test</em>
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * @return &lt;code&gt;true&lt;/code&gt; if it has a pom packaging; otherwise</em>
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * &lt;code&gt;false&lt;/code&gt;</em>
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isMultiModule(MavenProject mavenProject) {
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"pom"</span>.equals(mavenProject.getPackaging());
<a class="jxr_linenumber" name="L224" href="#L224">224</a> }
<a class="jxr_linenumber" name="L225" href="#L225">225</a>
<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * Initializes the engine.</em>
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * @return the MavenEngine used to execute dependency-check</em>
<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException thrown if there is an exception running</em>
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> * the Mojo</em>
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if dependency-check is configured to</em>
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * fail the build if severe CVEs are identified.</em>
<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html">MavenEngine</a> loadEngine() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
<a class="jxr_linenumber" name="L236" href="#L236">236</a> <a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html">MavenEngine</a> engine = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L238" href="#L238">238</a> engine = initializeEngine();
<a class="jxr_linenumber" name="L239" href="#L239">239</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">if</strong> (getLog().isDebugEnabled()) {
<a class="jxr_linenumber" name="L241" href="#L241">241</a> getLog().debug(<span class="jxr_string">"Database connection error"</span>, ex);
<a class="jxr_linenumber" name="L242" href="#L242">242</a> }
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">final</strong> String msg = <span class="jxr_string">"An exception occured connecting to the local database. Please see the log file for more details."</span>;
<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(msg, ex);
<a class="jxr_linenumber" name="L246" href="#L246">246</a> }
<a class="jxr_linenumber" name="L247" href="#L247">247</a> getLog().error(msg, ex);
<a class="jxr_linenumber" name="L248" href="#L248">248</a> }
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">return</strong> engine;
<a class="jxr_linenumber" name="L250" href="#L250">250</a> }
<a class="jxr_linenumber" name="L251" href="#L251">251</a>
<a class="jxr_linenumber" name="L252" href="#L252">252</a> @Override
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() {
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; <em class="jxr_comment">//aggregate always returns true for now - we can look at a more complicated/acurate solution later</em>
<a class="jxr_linenumber" name="L255" href="#L255">255</a> }
<a class="jxr_linenumber" name="L256" href="#L256">256</a>
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * The name of the report in the site.</em>
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L261" href="#L261">261</a> @Parameter(property = <span class="jxr_string">"name"</span>, defaultValue = <span class="jxr_string">"dependency-check:aggregate"</span>, required = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong class="jxr_keyword">private</strong> String name = <span class="jxr_string">"dependency-check:aggregate"</span>;
<a class="jxr_linenumber" name="L263" href="#L263">263</a>
<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * Returns the report name.</em>
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * @param locale the location</em>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * @return the report name</em>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> @Override
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">public</strong> String getName(Locale locale) {
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">return</strong> name;
<a class="jxr_linenumber" name="L273" href="#L273">273</a> }
<a class="jxr_linenumber" name="L274" href="#L274">274</a>
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> * Gets the description of the Dependency-Check report to be displayed in</em>
<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> * the Maven Generated Reports page.</em>
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> * @param locale The Locale to get the description for</em>
<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> * @return the description</em>
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L282" href="#L282">282</a> @Override
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">public</strong> String getDescription(Locale locale) {
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"Generates an aggregate report of all child Maven projects providing details on any "</span>
<a class="jxr_linenumber" name="L285" href="#L285">285</a> + <span class="jxr_string">"published vulnerabilities within project dependencies. This report is a best "</span>
<a class="jxr_linenumber" name="L286" href="#L286">286</a> + <span class="jxr_string">"effort and may contain false positives and false negatives."</span>;
<a class="jxr_linenumber" name="L287" href="#L287">287</a> }
<a class="jxr_linenumber" name="L288" href="#L288">288</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2013&#x2013;2016 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>

2234
dependency-check-maven/xref/org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html
View File

File diff suppressed because it is too large Load Diff

135
dependency-check-maven/xref/org/owasp/dependencycheck/maven/CheckMojo.html
View File

@@ -63,7 +63,7 @@
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() {
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">boolean</strong> isCapable = false;
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">for</strong> (Artifact a : getProject().getArtifacts()) {
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">if</strong> (!excludeFromScan(a)) {
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">if</strong> (!excludeFromScan(a.getScope())) {
<a class="jxr_linenumber" name="L59" href="#L59">59</a> isCapable = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L61" href="#L61">61</a> }
@@ -96,76 +96,75 @@
<a class="jxr_linenumber" name="L88" href="#L88">88</a> getLog().error(msg);
<a class="jxr_linenumber" name="L89" href="#L89">89</a> }
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">if</strong> (engine != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L91" href="#L91">91</a> scanArtifacts(getProject(), engine);
<a class="jxr_linenumber" name="L91" href="#L91">91</a> ExceptionCollection exCol = scanArtifacts(getProject(), engine);
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">if</strong> (engine.getDependencies().isEmpty()) {
<a class="jxr_linenumber" name="L93" href="#L93">93</a> getLog().info(<span class="jxr_string">"No dependencies were identified that could be analyzed by dependency-check"</span>);
<a class="jxr_linenumber" name="L94" href="#L94">94</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L95" href="#L95">95</a> ExceptionCollection exCol = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L97" href="#L97">97</a> engine.analyzeDependencies();
<a class="jxr_linenumber" name="L98" href="#L98">98</a> } <strong class="jxr_keyword">catch</strong> (ExceptionCollection ex) {
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError() &amp;&amp; ex.isFatal()) {
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"One or more exceptions occured during analysis"</span>, ex);
<a class="jxr_linenumber" name="L101" href="#L101">101</a> }
<a class="jxr_linenumber" name="L102" href="#L102">102</a> exCol = ex;
<a class="jxr_linenumber" name="L103" href="#L103">103</a> }
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">if</strong> (exCol == <strong class="jxr_keyword">null</strong> || !exCol.isFatal()) {
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L106" href="#L106">106</a> writeReports(engine, getProject(), getCorrectOutputDirectory());
<a class="jxr_linenumber" name="L107" href="#L107">107</a> } <strong class="jxr_keyword">catch</strong> (ReportException ex) {
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">if</strong> (exCol != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L110" href="#L110">110</a> exCol.addException(ex);
<a class="jxr_linenumber" name="L111" href="#L111">111</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L112" href="#L112">112</a> exCol = <strong class="jxr_keyword">new</strong> ExceptionCollection(<span class="jxr_string">"Unable to write the dependency-check report"</span>, ex);
<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
<a class="jxr_linenumber" name="L114" href="#L114">114</a> }
<a class="jxr_linenumber" name="L115" href="#L115">115</a> }
<a class="jxr_linenumber" name="L116" href="#L116">116</a> writeDataFile(getProject(), <strong class="jxr_keyword">null</strong>, engine.getDependencies());
<a class="jxr_linenumber" name="L117" href="#L117">117</a> showSummary(getProject(), engine.getDependencies());
<a class="jxr_linenumber" name="L118" href="#L118">118</a> checkForFailure(engine.getDependencies());
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">if</strong> (exCol != <strong class="jxr_keyword">null</strong> &amp;&amp; <strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"One or more exceptions occured during dependency-check analysis"</span>, exCol);
<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
<a class="jxr_linenumber" name="L122" href="#L122">122</a> }
<a class="jxr_linenumber" name="L123" href="#L123">123</a> }
<a class="jxr_linenumber" name="L124" href="#L124">124</a> engine.cleanup();
<a class="jxr_linenumber" name="L125" href="#L125">125</a> }
<a class="jxr_linenumber" name="L126" href="#L126">126</a> Settings.cleanup();
<a class="jxr_linenumber" name="L127" href="#L127">127</a> }
<a class="jxr_linenumber" name="L128" href="#L128">128</a>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * The name of the report in the site.</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L133" href="#L133">133</a> @Parameter(property = <span class="jxr_string">"name"</span>, defaultValue = <span class="jxr_string">"dependency-check"</span>, required = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">private</strong> String name = <span class="jxr_string">"dependency-check"</span>;
<a class="jxr_linenumber" name="L135" href="#L135">135</a>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * Returns the report name.</em>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * @param locale the location</em>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * @return the report name</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> @Override
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">public</strong> String getName(Locale locale) {
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">return</strong> name;
<a class="jxr_linenumber" name="L145" href="#L145">145</a> }
<a class="jxr_linenumber" name="L146" href="#L146">146</a>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * Gets the description of the Dependency-Check report to be displayed in</em>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * the Maven Generated Reports page.</em>
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * @param locale The Locale to get the description for</em>
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * @return the description</em>
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L154" href="#L154">154</a> @Override
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">public</strong> String getDescription(Locale locale) {
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"Generates a report providing details on any published vulnerabilities within project dependencies. "</span>
<a class="jxr_linenumber" name="L157" href="#L157">157</a> + <span class="jxr_string">"This report is a best effort and may contain false positives and false negatives."</span>;
<a class="jxr_linenumber" name="L158" href="#L158">158</a> }
<a class="jxr_linenumber" name="L159" href="#L159">159</a>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> }
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L96" href="#L96">96</a> engine.analyzeDependencies();
<a class="jxr_linenumber" name="L97" href="#L97">97</a> } <strong class="jxr_keyword">catch</strong> (ExceptionCollection ex) {
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError() &amp;&amp; ex.isFatal()) {
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"One or more exceptions occured during analysis"</span>, ex);
<a class="jxr_linenumber" name="L100" href="#L100">100</a> }
<a class="jxr_linenumber" name="L101" href="#L101">101</a> exCol = ex;
<a class="jxr_linenumber" name="L102" href="#L102">102</a> }
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">if</strong> (exCol == <strong class="jxr_keyword">null</strong> || !exCol.isFatal()) {
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L105" href="#L105">105</a> writeReports(engine, getProject(), getCorrectOutputDirectory());
<a class="jxr_linenumber" name="L106" href="#L106">106</a> } <strong class="jxr_keyword">catch</strong> (ReportException ex) {
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">if</strong> (exCol != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L109" href="#L109">109</a> exCol.addException(ex);
<a class="jxr_linenumber" name="L110" href="#L110">110</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L111" href="#L111">111</a> exCol = <strong class="jxr_keyword">new</strong> ExceptionCollection(<span class="jxr_string">"Unable to write the dependency-check report"</span>, ex);
<a class="jxr_linenumber" name="L112" href="#L112">112</a> }
<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
<a class="jxr_linenumber" name="L114" href="#L114">114</a> }
<a class="jxr_linenumber" name="L115" href="#L115">115</a> writeDataFile(getProject(), <strong class="jxr_keyword">null</strong>, engine.getDependencies());
<a class="jxr_linenumber" name="L116" href="#L116">116</a> showSummary(getProject(), engine.getDependencies());
<a class="jxr_linenumber" name="L117" href="#L117">117</a> checkForFailure(engine.getDependencies());
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">if</strong> (exCol != <strong class="jxr_keyword">null</strong> &amp;&amp; <strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"One or more exceptions occured during dependency-check analysis"</span>, exCol);
<a class="jxr_linenumber" name="L120" href="#L120">120</a> }
<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
<a class="jxr_linenumber" name="L122" href="#L122">122</a> }
<a class="jxr_linenumber" name="L123" href="#L123">123</a> engine.cleanup();
<a class="jxr_linenumber" name="L124" href="#L124">124</a> }
<a class="jxr_linenumber" name="L125" href="#L125">125</a> Settings.cleanup();
<a class="jxr_linenumber" name="L126" href="#L126">126</a> }
<a class="jxr_linenumber" name="L127" href="#L127">127</a>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * The name of the report in the site.</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L132" href="#L132">132</a> @Parameter(property = <span class="jxr_string">"name"</span>, defaultValue = <span class="jxr_string">"dependency-check"</span>, required = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">private</strong> String name = <span class="jxr_string">"dependency-check"</span>;
<a class="jxr_linenumber" name="L134" href="#L134">134</a>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * Returns the report name.</em>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * @param locale the location</em>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * @return the report name</em>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> @Override
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">public</strong> String getName(Locale locale) {
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">return</strong> name;
<a class="jxr_linenumber" name="L144" href="#L144">144</a> }
<a class="jxr_linenumber" name="L145" href="#L145">145</a>
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * Gets the description of the Dependency-Check report to be displayed in</em>
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * the Maven Generated Reports page.</em>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * @param locale The Locale to get the description for</em>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * @return the description</em>
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L153" href="#L153">153</a> @Override
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">public</strong> String getDescription(Locale locale) {
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"Generates a report providing details on any published vulnerabilities within project dependencies. "</span>
<a class="jxr_linenumber" name="L156" href="#L156">156</a> + <span class="jxr_string">"This report is a best effort and may contain false positives and false negatives."</span>;
<a class="jxr_linenumber" name="L157" href="#L157">157</a> }
<a class="jxr_linenumber" name="L158" href="#L158">158</a>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2013&#x2013;2016 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>

2
dependency-check-maven/xref/org/owasp/dependencycheck/maven/package-frame.html
View File

@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Dependency-Check Maven Plugin 1.4.2 Reference Package org.owasp.dependencycheck.maven</title>
<title>Dependency-Check Maven Plugin 1.4.3 Reference Package org.owasp.dependencycheck.maven</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
</head>
<body>

2
dependency-check-maven/xref/org/owasp/dependencycheck/maven/package-summary.html
View File

@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Dependency-Check Maven Plugin 1.4.2 Reference Package org.owasp.dependencycheck.maven</title>
<title>Dependency-Check Maven Plugin 1.4.3 Reference Package org.owasp.dependencycheck.maven</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
</head>
<body>

2
dependency-check-maven/xref/org/owasp/dependencycheck/maven/slf4j/package-frame.html
View File

@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Dependency-Check Maven Plugin 1.4.2 Reference Package org.owasp.dependencycheck.maven.slf4j</title>
<title>Dependency-Check Maven Plugin 1.4.3 Reference Package org.owasp.dependencycheck.maven.slf4j</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
</head>
<body>

2
dependency-check-maven/xref/org/owasp/dependencycheck/maven/slf4j/package-summary.html
View File

@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Dependency-Check Maven Plugin 1.4.2 Reference Package org.owasp.dependencycheck.maven.slf4j</title>
<title>Dependency-Check Maven Plugin 1.4.3 Reference Package org.owasp.dependencycheck.maven.slf4j</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
</head>
<body>