github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-04-09 18:33:54 +02: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

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>