github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-01-18 17:47:05 +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

342
xref/org/owasp/dependencycheck/analyzer/PythonDistributionAnalyzer.html
View File

@@ -32,9 +32,9 @@
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.FileNotFoundException;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.io.FilenameFilter;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.commons.io.filefilter.NameFileFilter;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.commons.io.filefilter.SuffixFileFilter;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.commons.io.input.AutoCloseInputStream;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.commons.io.filefilter.NameFileFilter;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.commons.io.filefilter.SuffixFileFilter;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.StringUtils;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.Engine;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.exception.AnalysisException;
@@ -236,168 +236,180 @@
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/exception/AnalysisException.html">AnalysisException</a>(ex);
<a class="jxr_linenumber" name="L229" href="#L229">229</a> }
<a class="jxr_linenumber" name="L230" href="#L230">230</a>
<a class="jxr_linenumber" name="L231" href="#L231">231</a> collectWheelMetadata(
<a class="jxr_linenumber" name="L232" href="#L232">232</a> dependency,
<a class="jxr_linenumber" name="L233" href="#L233">233</a> getMatchingFile(getMatchingFile(temp, folderFilter),
<a class="jxr_linenumber" name="L234" href="#L234">234</a> metadataFilter));
<a class="jxr_linenumber" name="L235" href="#L235">235</a> }
<a class="jxr_linenumber" name="L236" href="#L236">236</a>
<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * Makes sure a usable temporary directory is available.</em>
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * @throws InitializationException an AnalyzeException is thrown when the</em>
<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * temp directory cannot be created</em>
<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L243" href="#L243">243</a> @Override
<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initializeFileTypeAnalyzer() <strong class="jxr_keyword">throws</strong> InitializationException {
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">final</strong> File baseDir = Settings.getTempDirectory();
<a class="jxr_linenumber" name="L247" href="#L247">247</a> tempFileLocation = File.createTempFile(<span class="jxr_string">"check"</span>, <span class="jxr_string">"tmp"</span>, baseDir);
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">if</strong> (!tempFileLocation.delete()) {
<a class="jxr_linenumber" name="L249" href="#L249">249</a> setEnabled(false);
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">final</strong> String msg = String.format(
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <span class="jxr_string">"Unable to delete temporary file '%s'."</span>,
<a class="jxr_linenumber" name="L252" href="#L252">252</a> tempFileLocation.getAbsolutePath());
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/exception/InitializationException.html">InitializationException</a>(msg);
<a class="jxr_linenumber" name="L254" href="#L254">254</a> }
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">if</strong> (!tempFileLocation.mkdirs()) {
<a class="jxr_linenumber" name="L256" href="#L256">256</a> setEnabled(false);
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">final</strong> String msg = String.format(
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <span class="jxr_string">"Unable to create directory '%s'."</span>,
<a class="jxr_linenumber" name="L259" href="#L259">259</a> tempFileLocation.getAbsolutePath());
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/exception/InitializationException.html">InitializationException</a>(msg);
<a class="jxr_linenumber" name="L261" href="#L261">261</a> }
<a class="jxr_linenumber" name="L262" href="#L262">262</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L263" href="#L263">263</a> setEnabled(false);
<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/exception/InitializationException.html">InitializationException</a>(<span class="jxr_string">"Unable to create a temporary file"</span>, ex);
<a class="jxr_linenumber" name="L265" href="#L265">265</a> }
<a class="jxr_linenumber" name="L266" href="#L266">266</a> }
<a class="jxr_linenumber" name="L267" href="#L267">267</a>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * Deletes any files extracted from the Wheel during analysis.</em>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> @Override
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> close() {
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">if</strong> (tempFileLocation != <strong class="jxr_keyword">null</strong> &amp;&amp; tempFileLocation.exists()) {
<a class="jxr_linenumber" name="L274" href="#L274">274</a> LOGGER.debug(<span class="jxr_string">"Attempting to delete temporary files"</span>);
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> success = FileUtils.delete(tempFileLocation);
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">if</strong> (!success) {
<a class="jxr_linenumber" name="L277" href="#L277">277</a> LOGGER.warn(
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <span class="jxr_string">"Failed to delete some temporary files, see the log for more details"</span>);
<a class="jxr_linenumber" name="L279" href="#L279">279</a> }
<a class="jxr_linenumber" name="L280" href="#L280">280</a> }
<a class="jxr_linenumber" name="L281" href="#L281">281</a> }
<a class="jxr_linenumber" name="L282" href="#L282">282</a>
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * Gathers evidence from the METADATA file.</em>
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * @param dependency the dependency being analyzed</em>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * @param file a reference to the manifest/properties file</em>
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> collectWheelMetadata(<a href="../../../../org/owasp/dependencycheck/dependency/Dependency.html">Dependency</a> dependency, File file) {
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">final</strong> InternetHeaders headers = getManifestProperties(file);
<a class="jxr_linenumber" name="L291" href="#L291">291</a> addPropertyToEvidence(headers, dependency.getVersionEvidence(),
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <span class="jxr_string">"Version"</span>, Confidence.HIGHEST);
<a class="jxr_linenumber" name="L293" href="#L293">293</a> addPropertyToEvidence(headers, dependency.getProductEvidence(), <span class="jxr_string">"Name"</span>,
<a class="jxr_linenumber" name="L294" href="#L294">294</a> Confidence.HIGHEST);
<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">final</strong> String url = headers.getHeader(<span class="jxr_string">"Home-page"</span>, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/dependency/EvidenceCollection.html">EvidenceCollection</a> vendorEvidence = dependency
<a class="jxr_linenumber" name="L297" href="#L297">297</a> .getVendorEvidence();
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotBlank(url)) {
<a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong class="jxr_keyword">if</strong> (UrlStringUtils.isUrl(url)) {
<a class="jxr_linenumber" name="L300" href="#L300">300</a> vendorEvidence.addEvidence(METADATA, <span class="jxr_string">"vendor"</span>, url,
<a class="jxr_linenumber" name="L301" href="#L301">301</a> Confidence.MEDIUM);
<a class="jxr_linenumber" name="L302" href="#L302">302</a> }
<a class="jxr_linenumber" name="L303" href="#L303">303</a> }
<a class="jxr_linenumber" name="L304" href="#L304">304</a> addPropertyToEvidence(headers, vendorEvidence, <span class="jxr_string">"Author"</span>, Confidence.LOW);
<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">final</strong> String summary = headers.getHeader(<span class="jxr_string">"Summary"</span>, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotBlank(summary)) {
<a class="jxr_linenumber" name="L307" href="#L307">307</a> <a href="../../../../org/owasp/dependencycheck/analyzer/JarAnalyzer.html">JarAnalyzer</a>
<a class="jxr_linenumber" name="L308" href="#L308">308</a> .addDescription(dependency, summary, METADATA, <span class="jxr_string">"summary"</span>);
<a class="jxr_linenumber" name="L309" href="#L309">309</a> }
<a class="jxr_linenumber" name="L310" href="#L310">310</a> }
<a class="jxr_linenumber" name="L311" href="#L311">311</a>
<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> * Adds a value to the evidence collection.</em>
<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> * @param headers the properties collection</em>
<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> * @param evidence the evidence collection to add the value</em>
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> * @param property the property name</em>
<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> * @param confidence the confidence of the evidence</em>
<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> addPropertyToEvidence(InternetHeaders headers,
<a class="jxr_linenumber" name="L321" href="#L321">321</a> <a href="../../../../org/owasp/dependencycheck/dependency/EvidenceCollection.html">EvidenceCollection</a> evidence, String property, <a href="../../../../org/owasp/dependencycheck/dependency/Confidence.html">Confidence</a> confidence) {
<a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong class="jxr_keyword">final</strong> String value = headers.getHeader(property, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L323" href="#L323">323</a> LOGGER.debug(<span class="jxr_string">"Property: {}, Value: {}"</span>, property, value);
<a class="jxr_linenumber" name="L324" href="#L324">324</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotBlank(value)) {
<a class="jxr_linenumber" name="L325" href="#L325">325</a> evidence.addEvidence(METADATA, property, value, confidence);
<a class="jxr_linenumber" name="L326" href="#L326">326</a> }
<a class="jxr_linenumber" name="L327" href="#L327">327</a> }
<a class="jxr_linenumber" name="L328" href="#L328">328</a>
<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * Returns a list of files that match the given filter, this does not</em>
<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> * recursively scan the directory.</em>
<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> * @param folder the folder to filter</em>
<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> * @param filter the filter to apply to the files in the directory</em>
<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * @return the list of Files in the directory that match the provided filter</em>
<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L337" href="#L337">337</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> File getMatchingFile(File folder, FilenameFilter filter) {
<a class="jxr_linenumber" name="L338" href="#L338">338</a> File result = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong class="jxr_keyword">final</strong> File[] matches = folder.listFiles(filter);
<a class="jxr_linenumber" name="L340" href="#L340">340</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> != matches &amp;&amp; 1 == matches.length) {
<a class="jxr_linenumber" name="L341" href="#L341">341</a> result = matches[0];
<a class="jxr_linenumber" name="L342" href="#L342">342</a> }
<a class="jxr_linenumber" name="L343" href="#L343">343</a> <strong class="jxr_keyword">return</strong> result;
<a class="jxr_linenumber" name="L344" href="#L344">344</a> }
<a class="jxr_linenumber" name="L345" href="#L345">345</a>
<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment"> * Reads the manifest entries from the provided file.</em>
<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment"> * @param manifest the manifest</em>
<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment"> * @return the manifest entries</em>
<a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L352" href="#L352">352</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> InternetHeaders getManifestProperties(File manifest) {
<a class="jxr_linenumber" name="L353" href="#L353">353</a> <strong class="jxr_keyword">final</strong> InternetHeaders result = <strong class="jxr_keyword">new</strong> InternetHeaders();
<a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == manifest) {
<a class="jxr_linenumber" name="L355" href="#L355">355</a> LOGGER.debug(<span class="jxr_string">"Manifest file not found."</span>);
<a class="jxr_linenumber" name="L356" href="#L356">356</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L358" href="#L358">358</a> result.load(<strong class="jxr_keyword">new</strong> AutoCloseInputStream(<strong class="jxr_keyword">new</strong> BufferedInputStream(
<a class="jxr_linenumber" name="L359" href="#L359">359</a> <strong class="jxr_keyword">new</strong> FileInputStream(manifest))));
<a class="jxr_linenumber" name="L360" href="#L360">360</a> } <strong class="jxr_keyword">catch</strong> (MessagingException e) {
<a class="jxr_linenumber" name="L361" href="#L361">361</a> LOGGER.warn(e.getMessage(), e);
<a class="jxr_linenumber" name="L362" href="#L362">362</a> } <strong class="jxr_keyword">catch</strong> (FileNotFoundException e) {
<a class="jxr_linenumber" name="L363" href="#L363">363</a> LOGGER.warn(e.getMessage(), e);
<a class="jxr_linenumber" name="L364" href="#L364">364</a> }
<a class="jxr_linenumber" name="L365" href="#L365">365</a> }
<a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong class="jxr_keyword">return</strong> result;
<a class="jxr_linenumber" name="L367" href="#L367">367</a> }
<a class="jxr_linenumber" name="L368" href="#L368">368</a>
<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> * Retrieves the next temporary destination directory for extracting an</em>
<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> * archive.</em>
<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em class="jxr_javadoccomment"> * @return a directory</em>
<a class="jxr_linenumber" name="L374" href="#L374">374</a> <em class="jxr_javadoccomment"> * @throws AnalysisException thrown if unable to create temporary directory</em>
<a class="jxr_linenumber" name="L375" href="#L375">375</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L376" href="#L376">376</a> <strong class="jxr_keyword">private</strong> File getNextTempDirectory() <strong class="jxr_keyword">throws</strong> AnalysisException {
<a class="jxr_linenumber" name="L377" href="#L377">377</a> File directory;
<a class="jxr_linenumber" name="L378" href="#L378">378</a>
<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_comment">// getting an exception for some directories not being able to be</em>
<a class="jxr_linenumber" name="L380" href="#L380">380</a> <em class="jxr_comment">// created; might be because the directory already exists?</em>
<a class="jxr_linenumber" name="L381" href="#L381">381</a> <strong class="jxr_keyword">do</strong> {
<a class="jxr_linenumber" name="L382" href="#L382">382</a> dirCount += 1;
<a class="jxr_linenumber" name="L383" href="#L383">383</a> directory = <strong class="jxr_keyword">new</strong> File(tempFileLocation, String.valueOf(dirCount));
<a class="jxr_linenumber" name="L384" href="#L384">384</a> } <strong class="jxr_keyword">while</strong> (directory.exists());
<a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong class="jxr_keyword">if</strong> (!directory.mkdirs()) {
<a class="jxr_linenumber" name="L386" href="#L386">386</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/exception/AnalysisException.html">AnalysisException</a>(String.format(
<a class="jxr_linenumber" name="L387" href="#L387">387</a> <span class="jxr_string">"Unable to create temp directory '%s'."</span>,
<a class="jxr_linenumber" name="L388" href="#L388">388</a> directory.getAbsolutePath()));
<a class="jxr_linenumber" name="L389" href="#L389">389</a> }
<a class="jxr_linenumber" name="L390" href="#L390">390</a> <strong class="jxr_keyword">return</strong> directory;
<a class="jxr_linenumber" name="L391" href="#L391">391</a> }
<a class="jxr_linenumber" name="L392" href="#L392">392</a> }
<a class="jxr_linenumber" name="L231" href="#L231">231</a> File matchingFile = getMatchingFile(temp, folderFilter);
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">if</strong> (matchingFile != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L233" href="#L233">233</a> matchingFile = getMatchingFile(matchingFile, metadataFilter);
<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong class="jxr_keyword">if</strong> (matchingFile != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L235" href="#L235">235</a> collectWheelMetadata(dependency, matchingFile);
<a class="jxr_linenumber" name="L236" href="#L236">236</a> }
<a class="jxr_linenumber" name="L237" href="#L237">237</a> }
<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> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * Makes sure a usable temporary directory is available.</em>
<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> * @throws InitializationException an AnalyzeException is thrown when the</em>
<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * temp directory cannot be created</em>
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L246" href="#L246">246</a> @Override
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initializeFileTypeAnalyzer() <strong class="jxr_keyword">throws</strong> InitializationException {
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">final</strong> File baseDir = Settings.getTempDirectory();
<a class="jxr_linenumber" name="L250" href="#L250">250</a> tempFileLocation = File.createTempFile(<span class="jxr_string">"check"</span>, <span class="jxr_string">"tmp"</span>, baseDir);
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">if</strong> (!tempFileLocation.delete()) {
<a class="jxr_linenumber" name="L252" href="#L252">252</a> setEnabled(false);
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">final</strong> String msg = String.format(
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <span class="jxr_string">"Unable to delete temporary file '%s'."</span>,
<a class="jxr_linenumber" name="L255" href="#L255">255</a> tempFileLocation.getAbsolutePath());
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/exception/InitializationException.html">InitializationException</a>(msg);
<a class="jxr_linenumber" name="L257" href="#L257">257</a> }
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">if</strong> (!tempFileLocation.mkdirs()) {
<a class="jxr_linenumber" name="L259" href="#L259">259</a> setEnabled(false);
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">final</strong> String msg = String.format(
<a class="jxr_linenumber" name="L261" href="#L261">261</a> <span class="jxr_string">"Unable to create directory '%s'."</span>,
<a class="jxr_linenumber" name="L262" href="#L262">262</a> tempFileLocation.getAbsolutePath());
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/exception/InitializationException.html">InitializationException</a>(msg);
<a class="jxr_linenumber" name="L264" href="#L264">264</a> }
<a class="jxr_linenumber" name="L265" href="#L265">265</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L266" href="#L266">266</a> setEnabled(false);
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/exception/InitializationException.html">InitializationException</a>(<span class="jxr_string">"Unable to create a temporary file"</span>, ex);
<a class="jxr_linenumber" name="L268" href="#L268">268</a> }
<a class="jxr_linenumber" name="L269" href="#L269">269</a> }
<a class="jxr_linenumber" name="L270" href="#L270">270</a>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * Deletes any files extracted from the Wheel during analysis.</em>
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L274" href="#L274">274</a> @Override
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> close() {
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">if</strong> (tempFileLocation != <strong class="jxr_keyword">null</strong> &amp;&amp; tempFileLocation.exists()) {
<a class="jxr_linenumber" name="L277" href="#L277">277</a> LOGGER.debug(<span class="jxr_string">"Attempting to delete temporary files"</span>);
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> success = FileUtils.delete(tempFileLocation);
<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">if</strong> (!success) {
<a class="jxr_linenumber" name="L280" href="#L280">280</a> LOGGER.warn(
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <span class="jxr_string">"Failed to delete some temporary files, see the log for more details"</span>);
<a class="jxr_linenumber" name="L282" href="#L282">282</a> }
<a class="jxr_linenumber" name="L283" href="#L283">283</a> }
<a class="jxr_linenumber" name="L284" href="#L284">284</a> }
<a class="jxr_linenumber" name="L285" href="#L285">285</a>
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * Gathers evidence from the METADATA file.</em>
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * @param dependency the dependency being analyzed</em>
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * @param file a reference to the manifest/properties file</em>
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> collectWheelMetadata(<a href="../../../../org/owasp/dependencycheck/dependency/Dependency.html">Dependency</a> dependency, File file) {
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">final</strong> InternetHeaders headers = getManifestProperties(file);
<a class="jxr_linenumber" name="L294" href="#L294">294</a> addPropertyToEvidence(headers, dependency.getVersionEvidence(),
<a class="jxr_linenumber" name="L295" href="#L295">295</a> <span class="jxr_string">"Version"</span>, Confidence.HIGHEST);
<a class="jxr_linenumber" name="L296" href="#L296">296</a> addPropertyToEvidence(headers, dependency.getProductEvidence(), <span class="jxr_string">"Name"</span>,
<a class="jxr_linenumber" name="L297" href="#L297">297</a> Confidence.HIGHEST);
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">final</strong> String url = headers.getHeader(<span class="jxr_string">"Home-page"</span>, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/dependency/EvidenceCollection.html">EvidenceCollection</a> vendorEvidence = dependency
<a class="jxr_linenumber" name="L300" href="#L300">300</a> .getVendorEvidence();
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotBlank(url)) {
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">if</strong> (UrlStringUtils.isUrl(url)) {
<a class="jxr_linenumber" name="L303" href="#L303">303</a> vendorEvidence.addEvidence(METADATA, <span class="jxr_string">"vendor"</span>, url,
<a class="jxr_linenumber" name="L304" href="#L304">304</a> Confidence.MEDIUM);
<a class="jxr_linenumber" name="L305" href="#L305">305</a> }
<a class="jxr_linenumber" name="L306" href="#L306">306</a> }
<a class="jxr_linenumber" name="L307" href="#L307">307</a> addPropertyToEvidence(headers, vendorEvidence, <span class="jxr_string">"Author"</span>, Confidence.LOW);
<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">final</strong> String summary = headers.getHeader(<span class="jxr_string">"Summary"</span>, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L309" href="#L309">309</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotBlank(summary)) {
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <a href="../../../../org/owasp/dependencycheck/analyzer/JarAnalyzer.html">JarAnalyzer</a>
<a class="jxr_linenumber" name="L311" href="#L311">311</a> .addDescription(dependency, summary, METADATA, <span class="jxr_string">"summary"</span>);
<a class="jxr_linenumber" name="L312" href="#L312">312</a> }
<a class="jxr_linenumber" name="L313" href="#L313">313</a> }
<a class="jxr_linenumber" name="L314" href="#L314">314</a>
<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> * Adds a value to the evidence collection.</em>
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> * @param headers the properties collection</em>
<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> * @param evidence the evidence collection to add the value</em>
<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * @param property the property name</em>
<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> * @param confidence the confidence of the evidence</em>
<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L323" href="#L323">323</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> addPropertyToEvidence(InternetHeaders headers,
<a class="jxr_linenumber" name="L324" href="#L324">324</a> <a href="../../../../org/owasp/dependencycheck/dependency/EvidenceCollection.html">EvidenceCollection</a> evidence, String property, <a href="../../../../org/owasp/dependencycheck/dependency/Confidence.html">Confidence</a> confidence) {
<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">final</strong> String value = headers.getHeader(property, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L326" href="#L326">326</a> LOGGER.debug(<span class="jxr_string">"Property: {}, Value: {}"</span>, property, value);
<a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotBlank(value)) {
<a class="jxr_linenumber" name="L328" href="#L328">328</a> evidence.addEvidence(METADATA, property, value, confidence);
<a class="jxr_linenumber" name="L329" href="#L329">329</a> }
<a class="jxr_linenumber" name="L330" href="#L330">330</a> }
<a class="jxr_linenumber" name="L331" href="#L331">331</a>
<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> * Returns a list of files that match the given filter, this does not</em>
<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> * recursively scan the directory.</em>
<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * @param folder the folder to filter</em>
<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> * @param filter the filter to apply to the files in the directory</em>
<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment"> * @return the list of Files in the directory that match the provided filter</em>
<a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L340" href="#L340">340</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> File getMatchingFile(File folder, FilenameFilter filter) {
<a class="jxr_linenumber" name="L341" href="#L341">341</a> File result = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">final</strong> File[] matches = folder.listFiles(filter);
<a class="jxr_linenumber" name="L343" href="#L343">343</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> != matches &amp;&amp; 1 == matches.length) {
<a class="jxr_linenumber" name="L344" href="#L344">344</a> result = matches[0];
<a class="jxr_linenumber" name="L345" href="#L345">345</a> }
<a class="jxr_linenumber" name="L346" href="#L346">346</a> <strong class="jxr_keyword">return</strong> result;
<a class="jxr_linenumber" name="L347" href="#L347">347</a> }
<a class="jxr_linenumber" name="L348" href="#L348">348</a>
<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment"> * Reads the manifest entries from the provided file.</em>
<a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> * @param manifest the manifest</em>
<a class="jxr_linenumber" name="L353" href="#L353">353</a> <em class="jxr_javadoccomment"> * @return the manifest entries</em>
<a class="jxr_linenumber" name="L354" href="#L354">354</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> InternetHeaders getManifestProperties(File manifest) {
<a class="jxr_linenumber" name="L356" href="#L356">356</a> <strong class="jxr_keyword">final</strong> InternetHeaders result = <strong class="jxr_keyword">new</strong> InternetHeaders();
<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == manifest) {
<a class="jxr_linenumber" name="L358" href="#L358">358</a> LOGGER.debug(<span class="jxr_string">"Manifest file not found."</span>);
<a class="jxr_linenumber" name="L359" href="#L359">359</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L360" href="#L360">360</a> InputStream in = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L362" href="#L362">362</a> in = <strong class="jxr_keyword">new</strong> BufferedInputStream(<strong class="jxr_keyword">new</strong> FileInputStream(manifest));
<a class="jxr_linenumber" name="L363" href="#L363">363</a> result.load(in);
<a class="jxr_linenumber" name="L364" href="#L364">364</a> } <strong class="jxr_keyword">catch</strong> (MessagingException e) {
<a class="jxr_linenumber" name="L365" href="#L365">365</a> LOGGER.warn(e.getMessage(), e);
<a class="jxr_linenumber" name="L366" href="#L366">366</a> } <strong class="jxr_keyword">catch</strong> (FileNotFoundException e) {
<a class="jxr_linenumber" name="L367" href="#L367">367</a> LOGGER.warn(e.getMessage(), e);
<a class="jxr_linenumber" name="L368" href="#L368">368</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L369" href="#L369">369</a> <strong class="jxr_keyword">if</strong> (in != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L370" href="#L370">370</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L371" href="#L371">371</a> in.close();
<a class="jxr_linenumber" name="L372" href="#L372">372</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L373" href="#L373">373</a> LOGGER.debug(<span class="jxr_string">"failed to close input stream"</span>, ex);
<a class="jxr_linenumber" name="L374" href="#L374">374</a> }
<a class="jxr_linenumber" name="L375" href="#L375">375</a> }
<a class="jxr_linenumber" name="L376" href="#L376">376</a> }
<a class="jxr_linenumber" name="L377" href="#L377">377</a> }
<a class="jxr_linenumber" name="L378" href="#L378">378</a> <strong class="jxr_keyword">return</strong> result;
<a class="jxr_linenumber" name="L379" href="#L379">379</a> }
<a class="jxr_linenumber" name="L380" href="#L380">380</a>
<a class="jxr_linenumber" name="L381" href="#L381">381</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_javadoccomment"> * Retrieves the next temporary destination directory for extracting an</em>
<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_javadoccomment"> * archive.</em>
<a class="jxr_linenumber" name="L384" href="#L384">384</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_javadoccomment"> * @return a directory</em>
<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment"> * @throws AnalysisException thrown if unable to create temporary directory</em>
<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L388" href="#L388">388</a> <strong class="jxr_keyword">private</strong> File getNextTempDirectory() <strong class="jxr_keyword">throws</strong> AnalysisException {
<a class="jxr_linenumber" name="L389" href="#L389">389</a> File directory;
<a class="jxr_linenumber" name="L390" href="#L390">390</a>
<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_comment">// getting an exception for some directories not being able to be</em>
<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_comment">// created; might be because the directory already exists?</em>
<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">do</strong> {
<a class="jxr_linenumber" name="L394" href="#L394">394</a> dirCount += 1;
<a class="jxr_linenumber" name="L395" href="#L395">395</a> directory = <strong class="jxr_keyword">new</strong> File(tempFileLocation, String.valueOf(dirCount));
<a class="jxr_linenumber" name="L396" href="#L396">396</a> } <strong class="jxr_keyword">while</strong> (directory.exists());
<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">if</strong> (!directory.mkdirs()) {
<a class="jxr_linenumber" name="L398" href="#L398">398</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/exception/AnalysisException.html">AnalysisException</a>(String.format(
<a class="jxr_linenumber" name="L399" href="#L399">399</a> <span class="jxr_string">"Unable to create temp directory '%s'."</span>,
<a class="jxr_linenumber" name="L400" href="#L400">400</a> directory.getAbsolutePath()));
<a class="jxr_linenumber" name="L401" href="#L401">401</a> }
<a class="jxr_linenumber" name="L402" href="#L402">402</a> <strong class="jxr_keyword">return</strong> directory;
<a class="jxr_linenumber" name="L403" href="#L403">403</a> }
<a class="jxr_linenumber" name="L404" href="#L404">404</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2012&#x2013;2016 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>