mirror of
https://github.com/ysoftdevs/DependencyCheck.git
synced 2026-01-15 08:13:43 +01:00
155 lines
20 KiB
HTML
155 lines
20 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
|
|
<title>RubyBundlerAnalyzer xref</title>
|
|
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
|
|
</head>
|
|
<body>
|
|
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/analyzer/RubyBundlerAnalyzer.html">View Javadoc</a></div><pre>
|
|
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
|
|
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * This file is part of dependency-check-core.</em>
|
|
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> *</em>
|
|
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
|
|
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * you may not use this file except in compliance with the License.</em>
|
|
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * You may obtain a copy of the License at</em>
|
|
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> *</em>
|
|
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
|
|
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
|
|
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
|
|
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
|
|
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
|
|
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
|
|
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * limitations under the License.</em>
|
|
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> *</em>
|
|
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * Copyright (c) 2016 IBM Corporation. All Rights Reserved.</em>
|
|
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> */</em>
|
|
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.analyzer;
|
|
<a class="jxr_linenumber" name="L19" href="#L19">19</a>
|
|
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.io.File;
|
|
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.FilenameFilter;
|
|
<a class="jxr_linenumber" name="L22" href="#L22">22</a>
|
|
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.Engine;
|
|
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.exception.AnalysisException;
|
|
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Dependency;
|
|
<a class="jxr_linenumber" name="L26" href="#L26">26</a>
|
|
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment">/**</em>
|
|
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * This analyzer accepts the fully resolved .gemspec created by the Ruby bundler</em>
|
|
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * (<a href="http://bundler.io)" target="alexandria_uri">http://bundler.io)</a> for better evidence results. It also tries to resolve the</em>
|
|
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * dependency packagePath to where the gem is actually installed. Then during</em>
|
|
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * the {@link org.owasp.dependencycheck.analyzer.AnalysisPhase#PRE_FINDING_ANALYSIS}</em>
|
|
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * {@link DependencyMergingAnalyzer} will merge two .gemspec dependencies</em>
|
|
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * together if <code>Dependency.getPackagePath()</code> are the same.</em>
|
|
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> *</em>
|
|
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * Ruby bundler creates new .gemspec files under a folder called</em>
|
|
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * "specifications" at deploy time, in addition to the original .gemspec files</em>
|
|
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * from source. The bundler generated .gemspec files always contain fully</em>
|
|
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * resolved attributes thus provide more accurate evidences, whereas the</em>
|
|
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * original .gemspec from source often contain variables for attributes that</em>
|
|
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * can't be used for evidences.</em>
|
|
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> *</em>
|
|
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * Note this analyzer share the same</em>
|
|
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * {@link org.owasp.dependencycheck.utils.Settings.KEYS#ANALYZER_RUBY_GEMSPEC_ENABLED}</em>
|
|
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * as {@link RubyGemspecAnalyzer}, so it will enabled/disabled with</em>
|
|
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * {@link RubyGemspecAnalyzer}.</em>
|
|
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> *</em>
|
|
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @author Bianca Jiang (https://twitter.com/biancajiang)</em>
|
|
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> */</em>
|
|
<a class="jxr_linenumber" name="L49" href="#L49">49</a> @Experimental
|
|
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/RubyBundlerAnalyzer.html">RubyBundlerAnalyzer</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/RubyGemspecAnalyzer.html">RubyGemspecAnalyzer</a> {
|
|
<a class="jxr_linenumber" name="L51" href="#L51">51</a>
|
|
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment">/**</em>
|
|
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * The name of the analyzer.</em>
|
|
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> */</em>
|
|
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ANALYZER_NAME = <span class="jxr_string">"Ruby Bundler Analyzer"</span>;
|
|
<a class="jxr_linenumber" name="L56" href="#L56">56</a>
|
|
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment">/**</em>
|
|
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * Folder name that contains .gemspec files created by "bundle install"</em>
|
|
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> */</em>
|
|
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SPECIFICATIONS = <span class="jxr_string">"specifications"</span>;
|
|
<a class="jxr_linenumber" name="L61" href="#L61">61</a>
|
|
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment">/**</em>
|
|
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * Folder name that contains the gems by "bundle install"</em>
|
|
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> */</em>
|
|
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String GEMS = <span class="jxr_string">"gems"</span>;
|
|
<a class="jxr_linenumber" name="L66" href="#L66">66</a>
|
|
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment">/**</em>
|
|
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * Returns the name of the analyzer.</em>
|
|
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> *</em>
|
|
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * @return the name of the analyzer.</em>
|
|
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> */</em>
|
|
<a class="jxr_linenumber" name="L72" href="#L72">72</a> @Override
|
|
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">public</strong> String getName() {
|
|
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">return</strong> ANALYZER_NAME;
|
|
<a class="jxr_linenumber" name="L75" href="#L75">75</a> }
|
|
<a class="jxr_linenumber" name="L76" href="#L76">76</a>
|
|
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment">/**</em>
|
|
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * Only accept *.gemspec files generated by "bundle install --deployment"</em>
|
|
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * under "specifications" folder.</em>
|
|
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> *</em>
|
|
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * @param pathname the path name to test</em>
|
|
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * @return true if the analyzer can process the given file; otherwise false</em>
|
|
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> */</em>
|
|
<a class="jxr_linenumber" name="L84" href="#L84">84</a> @Override
|
|
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> accept(File pathname) {
|
|
<a class="jxr_linenumber" name="L86" href="#L86">86</a>
|
|
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">boolean</strong> accepted = <strong class="jxr_keyword">super</strong>.accept(pathname);
|
|
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">if</strong> (accepted) {
|
|
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">final</strong> File parentDir = pathname.getParentFile();
|
|
<a class="jxr_linenumber" name="L90" href="#L90">90</a> accepted = parentDir != <strong class="jxr_keyword">null</strong> && parentDir.getName().equals(SPECIFICATIONS);
|
|
<a class="jxr_linenumber" name="L91" href="#L91">91</a> }
|
|
<a class="jxr_linenumber" name="L92" href="#L92">92</a>
|
|
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">return</strong> accepted;
|
|
<a class="jxr_linenumber" name="L94" href="#L94">94</a> }
|
|
<a class="jxr_linenumber" name="L95" href="#L95">95</a>
|
|
<a class="jxr_linenumber" name="L96" href="#L96">96</a> @Override
|
|
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> analyzeDependency(<a href="../../../../org/owasp/dependencycheck/dependency/Dependency.html">Dependency</a> dependency, <a href="../../../../org/owasp/dependencycheck/Engine.html">Engine</a> engine)
|
|
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/exception/AnalysisException.html">AnalysisException</a> {
|
|
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">super</strong>.analyzeDependency(dependency, engine);
|
|
<a class="jxr_linenumber" name="L100" href="#L100">100</a>
|
|
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_comment">//find the corresponding gem folder for this .gemspec stub by "bundle install --deployment"</em>
|
|
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">final</strong> File gemspecFile = dependency.getActualFile();
|
|
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">final</strong> String gemFileName = gemspecFile.getName();
|
|
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">final</strong> String gemName = gemFileName.substring(0, gemFileName.lastIndexOf(<span class="jxr_string">".gemspec"</span>));
|
|
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">final</strong> File specificationsDir = gemspecFile.getParentFile();
|
|
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">if</strong> (specificationsDir != <strong class="jxr_keyword">null</strong> && specificationsDir.getName().equals(SPECIFICATIONS) && specificationsDir.exists()) {
|
|
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">final</strong> File parentDir = specificationsDir.getParentFile();
|
|
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">if</strong> (parentDir != <strong class="jxr_keyword">null</strong> && parentDir.exists()) {
|
|
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">final</strong> File gemsDir = <strong class="jxr_keyword">new</strong> File(parentDir, GEMS);
|
|
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">if</strong> (gemsDir.exists()) {
|
|
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">final</strong> File[] matchingFiles = gemsDir.listFiles(<strong class="jxr_keyword">new</strong> FilenameFilter() {
|
|
<a class="jxr_linenumber" name="L112" href="#L112">112</a> @Override
|
|
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> accept(File dir, String name) {
|
|
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">return</strong> name.equals(gemName);
|
|
<a class="jxr_linenumber" name="L115" href="#L115">115</a> }
|
|
<a class="jxr_linenumber" name="L116" href="#L116">116</a> });
|
|
<a class="jxr_linenumber" name="L117" href="#L117">117</a>
|
|
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">if</strong> (matchingFiles != <strong class="jxr_keyword">null</strong> && matchingFiles.length > 0) {
|
|
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">final</strong> String gemPath = matchingFiles[0].getAbsolutePath();
|
|
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">if</strong> (dependency.getActualFilePath().equals(dependency.getFilePath())) {
|
|
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">if</strong> (gemPath != <strong class="jxr_keyword">null</strong>) {
|
|
<a class="jxr_linenumber" name="L122" href="#L122">122</a> dependency.setPackagePath(gemPath);
|
|
<a class="jxr_linenumber" name="L123" href="#L123">123</a> }
|
|
<a class="jxr_linenumber" name="L124" href="#L124">124</a> } <strong class="jxr_keyword">else</strong> {
|
|
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_comment">//.gemspec's actualFilePath and filePath are different when it's from a compressed file</em>
|
|
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_comment">//in which case actualFilePath is the temp directory used by decompression.</em>
|
|
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_comment">//packagePath should use the filePath of the identified gem file in "gems" folder</em>
|
|
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">final</strong> File gemspecStub = <strong class="jxr_keyword">new</strong> File(dependency.getFilePath());
|
|
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">final</strong> File specDir = gemspecStub.getParentFile();
|
|
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">if</strong> (specDir != <strong class="jxr_keyword">null</strong> && specDir.getName().equals(SPECIFICATIONS)) {
|
|
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">final</strong> File gemsDir2 = <strong class="jxr_keyword">new</strong> File(specDir.getParentFile(), GEMS);
|
|
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">final</strong> File packageDir = <strong class="jxr_keyword">new</strong> File(gemsDir2, gemName);
|
|
<a class="jxr_linenumber" name="L133" href="#L133">133</a> dependency.setPackagePath(packageDir.getAbsolutePath());
|
|
<a class="jxr_linenumber" name="L134" href="#L134">134</a> }
|
|
<a class="jxr_linenumber" name="L135" href="#L135">135</a> }
|
|
<a class="jxr_linenumber" name="L136" href="#L136">136</a> }
|
|
<a class="jxr_linenumber" name="L137" href="#L137">137</a> }
|
|
<a class="jxr_linenumber" name="L138" href="#L138">138</a> }
|
|
<a class="jxr_linenumber" name="L139" href="#L139">139</a> }
|
|
<a class="jxr_linenumber" name="L140" href="#L140">140</a> }
|
|
<a class="jxr_linenumber" name="L141" href="#L141">141</a> }
|
|
</pre>
|
|
<hr/>
|
|
<div id="footer">Copyright © 2012–2017 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
|
|
</body>
|
|
</html>
|