github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-03-13 05:35:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

documentation v1.3.2

Browse Source
This commit is contained in:
Jeremy Long
2015-11-29 07:44:14 -05:00
parent 191c5fae56
commit a426de69cd
1220 changed files with 51071 additions and 40455 deletions
Download Patch File Download Diff File Expand all files Collapse all files

277
xref/org/owasp/dependencycheck/analyzer/PythonPackageAnalyzer.html
View File

@@ -172,7 +172,7 @@
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * Analyzes python packages and adds evidence to the dependency.</em>
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @param dependency the dependency being analyzed</em>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @param engine the engine being used to perform the scan</em>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @param engine the engine being used to perform the scan</em>
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * @throws AnalysisException thrown if there is an unrecoverable error analyzing the dependency</em>
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L170" href="#L170">170</a> @Override
@@ -183,142 +183,145 @@
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">final</strong> String parentName = parent.getName();
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">boolean</strong> found = false;
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">if</strong> (INIT_PY_FILTER.accept(file)) {
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> File sourceFile : parent.listFiles(PY_FILTER)) {
<a class="jxr_linenumber" name="L179" href="#L179">179</a> found |= analyzeFileContents(dependency, sourceFile);
<a class="jxr_linenumber" name="L180" href="#L180">180</a> }
<a class="jxr_linenumber" name="L181" href="#L181">181</a> }
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">if</strong> (found) {
<a class="jxr_linenumber" name="L183" href="#L183">183</a> dependency.setDisplayFileName(parentName + <span class="jxr_string">"/__init__.py"</span>);
<a class="jxr_linenumber" name="L184" href="#L184">184</a> dependency.getProductEvidence().addEvidence(file.getName(),
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <span class="jxr_string">"PackageName"</span>, parentName, Confidence.MEDIUM);
<a class="jxr_linenumber" name="L186" href="#L186">186</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_comment">// copy, alter and set in case some other thread is iterating over</em>
<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">final</strong> List&lt;Dependency&gt; dependencies = <strong class="jxr_keyword">new</strong> ArrayList&lt;Dependency&gt;(
<a class="jxr_linenumber" name="L189" href="#L189">189</a> engine.getDependencies());
<a class="jxr_linenumber" name="L190" href="#L190">190</a> dependencies.remove(dependency);
<a class="jxr_linenumber" name="L191" href="#L191">191</a> engine.setDependencies(dependencies);
<a class="jxr_linenumber" name="L192" href="#L192">192</a> }
<a class="jxr_linenumber" name="L193" href="#L193">193</a> }
<a class="jxr_linenumber" name="L194" href="#L194">194</a>
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * This should gather information from leading docstrings, file comments, and assignments to __version__, __title__,</em>
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * __summary__, __uri__, __url__, __home*page__, __author__, and their all caps equivalents.</em>
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * @param dependency the dependency being analyzed</em>
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * @param file the file name to analyze</em>
<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * @return whether evidence was found</em>
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * @throws AnalysisException thrown if there is an unrecoverable error</em>
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> analyzeFileContents(<a href="../../../../org/owasp/dependencycheck/dependency/Dependency.html">Dependency</a> dependency, File file)
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/exception/AnalysisException.html">AnalysisException</a> {
<a class="jxr_linenumber" name="L206" href="#L206">206</a> String contents;
<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L208" href="#L208">208</a> contents = FileUtils.readFileToString(file).trim();
<a class="jxr_linenumber" name="L209" href="#L209">209</a> } <strong class="jxr_keyword">catch</strong> (IOException e) {
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/exception/AnalysisException.html">AnalysisException</a>(
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <span class="jxr_string">"Problem occurred while reading dependency file."</span>, e);
<a class="jxr_linenumber" name="L212" href="#L212">212</a> }
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">boolean</strong> found = false;
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">if</strong> (!contents.isEmpty()) {
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">final</strong> String source = file.getName();
<a class="jxr_linenumber" name="L216" href="#L216">216</a> found = gatherEvidence(VERSION_PATTERN, contents, source,
<a class="jxr_linenumber" name="L217" href="#L217">217</a> dependency.getVersionEvidence(), <span class="jxr_string">"SourceVersion"</span>,
<a class="jxr_linenumber" name="L218" href="#L218">218</a> Confidence.MEDIUM);
<a class="jxr_linenumber" name="L219" href="#L219">219</a> found |= addSummaryInfo(dependency, SUMMARY_PATTERN, 4, contents,
<a class="jxr_linenumber" name="L220" href="#L220">220</a> source, <span class="jxr_string">"summary"</span>);
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">if</strong> (INIT_PY_FILTER.accept(file)) {
<a class="jxr_linenumber" name="L222" href="#L222">222</a> found |= addSummaryInfo(dependency, MODULE_DOCSTRING, 2,
<a class="jxr_linenumber" name="L223" href="#L223">223</a> contents, source, <span class="jxr_string">"docstring"</span>);
<a class="jxr_linenumber" name="L224" href="#L224">224</a> }
<a class="jxr_linenumber" name="L225" href="#L225">225</a> found |= gatherEvidence(TITLE_PATTERN, contents, source,
<a class="jxr_linenumber" name="L226" href="#L226">226</a> dependency.getProductEvidence(), <span class="jxr_string">"SourceTitle"</span>,
<a class="jxr_linenumber" name="L227" href="#L227">227</a> Confidence.LOW);
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/dependency/EvidenceCollection.html">EvidenceCollection</a> vendorEvidence = dependency
<a class="jxr_linenumber" name="L229" href="#L229">229</a> .getVendorEvidence();
<a class="jxr_linenumber" name="L230" href="#L230">230</a> found |= gatherEvidence(AUTHOR_PATTERN, contents, source,
<a class="jxr_linenumber" name="L231" href="#L231">231</a> vendorEvidence, <span class="jxr_string">"SourceAuthor"</span>, Confidence.MEDIUM);
<a class="jxr_linenumber" name="L232" href="#L232">232</a> found |= gatherHomePageEvidence(URI_PATTERN, vendorEvidence,
<a class="jxr_linenumber" name="L233" href="#L233">233</a> source, <span class="jxr_string">"URL"</span>, contents);
<a class="jxr_linenumber" name="L234" href="#L234">234</a> found |= gatherHomePageEvidence(HOMEPAGE_PATTERN,
<a class="jxr_linenumber" name="L235" href="#L235">235</a> vendorEvidence, source, <span class="jxr_string">"HomePage"</span>, contents);
<a class="jxr_linenumber" name="L236" href="#L236">236</a> }
<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">return</strong> found;
<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"> * Adds summary information to the dependency</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"> * @param dependency the dependency being analyzed</em>
<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * @param pattern the pattern used to perform analysis</em>
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> * @param group the group from the pattern that indicates the data to use</em>
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> * @param contents the data being analyzed</em>
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * @param source the source name to use when recording the evidence</em>
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> * @param key the key name to use when recording the evidence</em>
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * @return true if evidence was collected; otherwise false</em>
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> addSummaryInfo(<a href="../../../../org/owasp/dependencycheck/dependency/Dependency.html">Dependency</a> dependency, Pattern pattern,
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">int</strong> group, String contents, String source, String key) {
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">final</strong> Matcher matcher = pattern.matcher(contents);
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> found = matcher.find();
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">if</strong> (found) {
<a class="jxr_linenumber" name="L256" href="#L256">256</a> JarAnalyzer.addDescription(dependency, matcher.group(group),
<a class="jxr_linenumber" name="L257" href="#L257">257</a> source, key);
<a class="jxr_linenumber" name="L258" href="#L258">258</a> }
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">return</strong> found;
<a class="jxr_linenumber" name="L260" href="#L260">260</a> }
<a class="jxr_linenumber" name="L261" href="#L261">261</a>
<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * Collects evidence from the home page URL.</em>
<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"> * @param pattern the pattern to match</em>
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * @param evidence the evidence collection to add the evidence to</em>
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * @param source the source of the evidence</em>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * @param name the name of the evidence</em>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * @param contents the home page URL</em>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> * @return true if evidence was collected; otherwise false</em>
<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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> gatherHomePageEvidence(Pattern pattern,
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <a href="../../../../org/owasp/dependencycheck/dependency/EvidenceCollection.html">EvidenceCollection</a> evidence, String source, String name,
<a class="jxr_linenumber" name="L274" href="#L274">274</a> String contents) {
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">final</strong> Matcher matcher = pattern.matcher(contents);
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">boolean</strong> found = false;
<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">if</strong> (matcher.find()) {
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">final</strong> String url = matcher.group(4);
<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">if</strong> (UrlStringUtils.isUrl(url)) {
<a class="jxr_linenumber" name="L280" href="#L280">280</a> found = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L281" href="#L281">281</a> evidence.addEvidence(source, name, url, Confidence.MEDIUM);
<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> <strong class="jxr_keyword">return</strong> found;
<a class="jxr_linenumber" name="L285" href="#L285">285</a> }
<a class="jxr_linenumber" name="L286" href="#L286">286</a>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * Gather evidence from a Python source file using the given string assignment regex pattern.</em>
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * @param pattern to scan contents with</em>
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> * @param contents of Python source file</em>
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> * @param source for storing evidence</em>
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * @param evidence to store evidence in</em>
<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> * @param name of evidence</em>
<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment"> * @param confidence in evidence</em>
<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> * @return whether evidence was found</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> gatherEvidence(Pattern pattern, String contents,
<a class="jxr_linenumber" name="L299" href="#L299">299</a> String source, <a href="../../../../org/owasp/dependencycheck/dependency/EvidenceCollection.html">EvidenceCollection</a> evidence, String name,
<a class="jxr_linenumber" name="L300" href="#L300">300</a> <a href="../../../../org/owasp/dependencycheck/dependency/Confidence.html">Confidence</a> confidence) {
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">final</strong> Matcher matcher = pattern.matcher(contents);
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> found = matcher.find();
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">if</strong> (found) {
<a class="jxr_linenumber" name="L304" href="#L304">304</a> evidence.addEvidence(source, name, matcher.group(4), confidence);
<a class="jxr_linenumber" name="L305" href="#L305">305</a> }
<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">return</strong> found;
<a class="jxr_linenumber" name="L307" href="#L307">307</a> }
<a class="jxr_linenumber" name="L308" href="#L308">308</a>
<a class="jxr_linenumber" name="L309" href="#L309">309</a> @Override
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">protected</strong> String getAnalyzerEnabledSettingKey() {
<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">return</strong> Settings.KEYS.ANALYZER_PYTHON_PACKAGE_ENABLED;
<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="L178" href="#L178">178</a> <strong class="jxr_keyword">final</strong> File[] fileList = parent.listFiles(PY_FILTER);
<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">if</strong> (fileList != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> File sourceFile : fileList) {
<a class="jxr_linenumber" name="L181" href="#L181">181</a> found |= analyzeFileContents(dependency, sourceFile);
<a class="jxr_linenumber" name="L182" href="#L182">182</a> }
<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> <strong class="jxr_keyword">if</strong> (found) {
<a class="jxr_linenumber" name="L186" href="#L186">186</a> dependency.setDisplayFileName(parentName + <span class="jxr_string">"/__init__.py"</span>);
<a class="jxr_linenumber" name="L187" href="#L187">187</a> dependency.getProductEvidence().addEvidence(file.getName(),
<a class="jxr_linenumber" name="L188" href="#L188">188</a> <span class="jxr_string">"PackageName"</span>, parentName, Confidence.MEDIUM);
<a class="jxr_linenumber" name="L189" href="#L189">189</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_comment">// copy, alter and set in case some other thread is iterating over</em>
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">final</strong> List&lt;Dependency&gt; dependencies = <strong class="jxr_keyword">new</strong> ArrayList&lt;Dependency&gt;(
<a class="jxr_linenumber" name="L192" href="#L192">192</a> engine.getDependencies());
<a class="jxr_linenumber" name="L193" href="#L193">193</a> dependencies.remove(dependency);
<a class="jxr_linenumber" name="L194" href="#L194">194</a> engine.setDependencies(dependencies);
<a class="jxr_linenumber" name="L195" href="#L195">195</a> }
<a class="jxr_linenumber" name="L196" href="#L196">196</a> }
<a class="jxr_linenumber" name="L197" href="#L197">197</a>
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * This should gather information from leading docstrings, file comments, and assignments to __version__, __title__,</em>
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * __summary__, __uri__, __url__, __home*page__, __author__, and their all caps equivalents.</em>
<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * @param dependency the dependency being analyzed</em>
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * @param file the file name to analyze</em>
<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * @return whether evidence was found</em>
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * @throws AnalysisException thrown if there is an unrecoverable error</em>
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> analyzeFileContents(<a href="../../../../org/owasp/dependencycheck/dependency/Dependency.html">Dependency</a> dependency, File file)
<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/exception/AnalysisException.html">AnalysisException</a> {
<a class="jxr_linenumber" name="L209" href="#L209">209</a> String contents;
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L211" href="#L211">211</a> contents = FileUtils.readFileToString(file).trim();
<a class="jxr_linenumber" name="L212" href="#L212">212</a> } <strong class="jxr_keyword">catch</strong> (IOException e) {
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/exception/AnalysisException.html">AnalysisException</a>(
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <span class="jxr_string">"Problem occurred while reading dependency file."</span>, e);
<a class="jxr_linenumber" name="L215" href="#L215">215</a> }
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">boolean</strong> found = false;
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">if</strong> (!contents.isEmpty()) {
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">final</strong> String source = file.getName();
<a class="jxr_linenumber" name="L219" href="#L219">219</a> found = gatherEvidence(VERSION_PATTERN, contents, source,
<a class="jxr_linenumber" name="L220" href="#L220">220</a> dependency.getVersionEvidence(), <span class="jxr_string">"SourceVersion"</span>,
<a class="jxr_linenumber" name="L221" href="#L221">221</a> Confidence.MEDIUM);
<a class="jxr_linenumber" name="L222" href="#L222">222</a> found |= addSummaryInfo(dependency, SUMMARY_PATTERN, 4, contents,
<a class="jxr_linenumber" name="L223" href="#L223">223</a> source, <span class="jxr_string">"summary"</span>);
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">if</strong> (INIT_PY_FILTER.accept(file)) {
<a class="jxr_linenumber" name="L225" href="#L225">225</a> found |= addSummaryInfo(dependency, MODULE_DOCSTRING, 2,
<a class="jxr_linenumber" name="L226" href="#L226">226</a> contents, source, <span class="jxr_string">"docstring"</span>);
<a class="jxr_linenumber" name="L227" href="#L227">227</a> }
<a class="jxr_linenumber" name="L228" href="#L228">228</a> found |= gatherEvidence(TITLE_PATTERN, contents, source,
<a class="jxr_linenumber" name="L229" href="#L229">229</a> dependency.getProductEvidence(), <span class="jxr_string">"SourceTitle"</span>,
<a class="jxr_linenumber" name="L230" href="#L230">230</a> Confidence.LOW);
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/dependency/EvidenceCollection.html">EvidenceCollection</a> vendorEvidence = dependency
<a class="jxr_linenumber" name="L232" href="#L232">232</a> .getVendorEvidence();
<a class="jxr_linenumber" name="L233" href="#L233">233</a> found |= gatherEvidence(AUTHOR_PATTERN, contents, source,
<a class="jxr_linenumber" name="L234" href="#L234">234</a> vendorEvidence, <span class="jxr_string">"SourceAuthor"</span>, Confidence.MEDIUM);
<a class="jxr_linenumber" name="L235" href="#L235">235</a> found |= gatherHomePageEvidence(URI_PATTERN, vendorEvidence,
<a class="jxr_linenumber" name="L236" href="#L236">236</a> source, <span class="jxr_string">"URL"</span>, contents);
<a class="jxr_linenumber" name="L237" href="#L237">237</a> found |= gatherHomePageEvidence(HOMEPAGE_PATTERN,
<a class="jxr_linenumber" name="L238" href="#L238">238</a> vendorEvidence, source, <span class="jxr_string">"HomePage"</span>, contents);
<a class="jxr_linenumber" name="L239" href="#L239">239</a> }
<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">return</strong> found;
<a class="jxr_linenumber" name="L241" href="#L241">241</a> }
<a class="jxr_linenumber" name="L242" href="#L242">242</a>
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * Adds summary information to the dependency</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> <em class="jxr_javadoccomment"> * @param dependency the dependency being analyzed</em>
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * @param pattern the pattern used to perform analysis</em>
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> * @param group the group from the pattern that indicates the data to use</em>
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * @param contents the data being analyzed</em>
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> * @param source the source name to use when recording the evidence</em>
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * @param key the key name to use when recording the evidence</em>
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> * @return true if evidence was collected; otherwise false</em>
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> addSummaryInfo(<a href="../../../../org/owasp/dependencycheck/dependency/Dependency.html">Dependency</a> dependency, Pattern pattern,
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">int</strong> group, String contents, String source, String key) {
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">final</strong> Matcher matcher = pattern.matcher(contents);
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> found = matcher.find();
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">if</strong> (found) {
<a class="jxr_linenumber" name="L259" href="#L259">259</a> JarAnalyzer.addDescription(dependency, matcher.group(group),
<a class="jxr_linenumber" name="L260" href="#L260">260</a> source, key);
<a class="jxr_linenumber" name="L261" href="#L261">261</a> }
<a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong class="jxr_keyword">return</strong> found;
<a class="jxr_linenumber" name="L263" href="#L263">263</a> }
<a class="jxr_linenumber" name="L264" href="#L264">264</a>
<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * Collects evidence from the home page URL.</em>
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * @param pattern the pattern to match</em>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * @param evidence the evidence collection to add the evidence to</em>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> * @param source the source of the evidence</em>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * @param name the name of the evidence</em>
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * @param contents the home page URL</em>
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> * @return true if evidence was collected; otherwise false</em>
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> gatherHomePageEvidence(Pattern pattern,
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <a href="../../../../org/owasp/dependencycheck/dependency/EvidenceCollection.html">EvidenceCollection</a> evidence, String source, String name,
<a class="jxr_linenumber" name="L277" href="#L277">277</a> String contents) {
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">final</strong> Matcher matcher = pattern.matcher(contents);
<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">boolean</strong> found = false;
<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">if</strong> (matcher.find()) {
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">final</strong> String url = matcher.group(4);
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong class="jxr_keyword">if</strong> (UrlStringUtils.isUrl(url)) {
<a class="jxr_linenumber" name="L283" href="#L283">283</a> found = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L284" href="#L284">284</a> evidence.addEvidence(source, name, url, Confidence.MEDIUM);
<a class="jxr_linenumber" name="L285" href="#L285">285</a> }
<a class="jxr_linenumber" name="L286" href="#L286">286</a> }
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">return</strong> found;
<a class="jxr_linenumber" name="L288" href="#L288">288</a> }
<a class="jxr_linenumber" name="L289" href="#L289">289</a>
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> * Gather evidence from a Python source file using the given string assignment regex pattern.</em>
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * @param pattern to scan contents with</em>
<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> * @param contents of Python source file</em>
<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment"> * @param source for storing evidence</em>
<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> * @param evidence to store evidence in</em>
<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * @param name of evidence</em>
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> * @param confidence in evidence</em>
<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment"> * @return whether evidence was found</em>
<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> gatherEvidence(Pattern pattern, String contents,
<a class="jxr_linenumber" name="L302" href="#L302">302</a> String source, <a href="../../../../org/owasp/dependencycheck/dependency/EvidenceCollection.html">EvidenceCollection</a> evidence, String name,
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <a href="../../../../org/owasp/dependencycheck/dependency/Confidence.html">Confidence</a> confidence) {
<a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong class="jxr_keyword">final</strong> Matcher matcher = pattern.matcher(contents);
<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> found = matcher.find();
<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">if</strong> (found) {
<a class="jxr_linenumber" name="L307" href="#L307">307</a> evidence.addEvidence(source, name, matcher.group(4), confidence);
<a class="jxr_linenumber" name="L308" href="#L308">308</a> }
<a class="jxr_linenumber" name="L309" href="#L309">309</a> <strong class="jxr_keyword">return</strong> found;
<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> @Override
<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">protected</strong> String getAnalyzerEnabledSettingKey() {
<a class="jxr_linenumber" name="L314" href="#L314">314</a> <strong class="jxr_keyword">return</strong> Settings.KEYS.ANALYZER_PYTHON_PACKAGE_ENABLED;
<a class="jxr_linenumber" name="L315" href="#L315">315</a> }
<a class="jxr_linenumber" name="L316" href="#L316">316</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2012&#x2013;2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>