github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-03-23 17:41:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

documentation version 1.4.2

Browse Source
This commit is contained in:
Jeremy Long
2016-07-31 08:10:07 -04:00
parent 6193968089
commit 44917ad0d3
1319 changed files with 93942 additions and 60498 deletions
Download Patch File Download Diff File Expand all files Collapse all files

299
xref/org/owasp/dependencycheck/analyzer/NodePackageAnalyzer.html
View File

@@ -46,154 +46,157 @@
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> javax.json.JsonReader;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> javax.json.JsonString;
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> javax.json.JsonValue;
<a class="jxr_linenumber" name="L41" href="#L41">41</a>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * Used to analyze Node Package Manager (npm) package.json files, and collect information that can be used to determine the</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * associated CPE.</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * @author Dale Visser</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> @Experimental
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/NodePackageAnalyzer.html">NodePackageAnalyzer</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/AbstractFileTypeAnalyzer.html">AbstractFileTypeAnalyzer</a> {
<a class="jxr_linenumber" name="L50" href="#L50">50</a>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * The logger.</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = LoggerFactory.getLogger(NodePackageAnalyzer.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L55" href="#L55">55</a>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * The name of the analyzer.</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</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">"Node.js Package Analyzer"</span>;
<a class="jxr_linenumber" name="L60" href="#L60">60</a>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * The phase that this analyzer is intended to run in.</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/AnalysisPhase.html">AnalysisPhase</a> ANALYSIS_PHASE = AnalysisPhase.INFORMATION_COLLECTION;
<a class="jxr_linenumber" name="L65" href="#L65">65</a>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * The file name to scan.</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PACKAGE_JSON = <span class="jxr_string">"package.json"</span>;
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * Filter that detects files named "package.json".</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> FileFilter PACKAGE_JSON_FILTER = FileFilterBuilder.newInstance()
<a class="jxr_linenumber" name="L74" href="#L74">74</a> .addFilenames(PACKAGE_JSON).build();
<a class="jxr_linenumber" name="L75" href="#L75">75</a>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * Returns the FileFilter</em>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @return the FileFilter</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> @Override
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">protected</strong> FileFilter getFileFilter() {
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">return</strong> PACKAGE_JSON_FILTER;
<a class="jxr_linenumber" name="L84" href="#L84">84</a> }
<a class="jxr_linenumber" name="L85" href="#L85">85</a>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> @Override
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initializeFileTypeAnalyzer() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_comment">// NO-OP</em>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> }
<a class="jxr_linenumber" name="L90" href="#L90">90</a>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * Returns the name of the analyzer.</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @return the name of the analyzer.</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> */</em>
<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">public</strong> String getName() {
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">return</strong> ANALYZER_NAME;
<a class="jxr_linenumber" name="L99" href="#L99">99</a> }
<a class="jxr_linenumber" name="L100" href="#L100">100</a>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * Returns the phase that the analyzer is intended to run in.</em>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * @return the phase that the analyzer is intended to run in.</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> @Override
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/AnalysisPhase.html">AnalysisPhase</a> getAnalysisPhase() {
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">return</strong> ANALYSIS_PHASE;
<a class="jxr_linenumber" name="L109" href="#L109">109</a> }
<a class="jxr_linenumber" name="L110" href="#L110">110</a>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * Returns the key used in the properties file to reference the analyzer's enabled property.</em>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @return the analyzer's enabled property setting key</em>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L116" href="#L116">116</a> @Override
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">protected</strong> String getAnalyzerEnabledSettingKey() {
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">return</strong> Settings.KEYS.ANALYZER_NODE_PACKAGE_ENABLED;
<a class="jxr_linenumber" name="L119" href="#L119">119</a> }
<a class="jxr_linenumber" name="L120" href="#L120">120</a>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> @Override
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> analyzeFileType(<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="L123" href="#L123">123</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/exception/AnalysisException.html">AnalysisException</a> {
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">final</strong> File file = dependency.getActualFile();
<a class="jxr_linenumber" name="L125" href="#L125">125</a> JsonReader jsonReader;
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L127" href="#L127">127</a> jsonReader = Json.createReader(FileUtils.openInputStream(file));
<a class="jxr_linenumber" name="L128" href="#L128">128</a> } <strong class="jxr_keyword">catch</strong> (IOException e) {
<a class="jxr_linenumber" name="L129" href="#L129">129</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="L130" href="#L130">130</a> <span class="jxr_string">"Problem occurred while reading dependency file."</span>, e);
<a class="jxr_linenumber" name="L131" href="#L131">131</a> }
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">final</strong> JsonObject json = jsonReader.readObject();
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/dependency/EvidenceCollection.html">EvidenceCollection</a> productEvidence = dependency.getProductEvidence();
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/dependency/EvidenceCollection.html">EvidenceCollection</a> vendorEvidence = dependency.getVendorEvidence();
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">if</strong> (json.containsKey(<span class="jxr_string">"name"</span>)) {
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">final</strong> Object value = json.get(<span class="jxr_string">"name"</span>);
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">if</strong> (value instanceof JsonString) {
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">final</strong> String valueString = ((JsonString) value).getString();
<a class="jxr_linenumber" name="L140" href="#L140">140</a> productEvidence.addEvidence(PACKAGE_JSON, <span class="jxr_string">"name"</span>, valueString, Confidence.HIGHEST);
<a class="jxr_linenumber" name="L141" href="#L141">141</a> vendorEvidence.addEvidence(PACKAGE_JSON, <span class="jxr_string">"name_project"</span>, String.format(<span class="jxr_string">"%s_project"</span>, valueString), Confidence.LOW);
<a class="jxr_linenumber" name="L142" href="#L142">142</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L143" href="#L143">143</a> LOGGER.warn(<span class="jxr_string">"JSON value not string as expected: {}"</span>, value);
<a class="jxr_linenumber" name="L144" href="#L144">144</a> }
<a class="jxr_linenumber" name="L145" href="#L145">145</a> }
<a class="jxr_linenumber" name="L146" href="#L146">146</a> addToEvidence(json, productEvidence, <span class="jxr_string">"description"</span>);
<a class="jxr_linenumber" name="L147" href="#L147">147</a> addToEvidence(json, vendorEvidence, <span class="jxr_string">"author"</span>);
<a class="jxr_linenumber" name="L148" href="#L148">148</a> addToEvidence(json, dependency.getVersionEvidence(), <span class="jxr_string">"version"</span>);
<a class="jxr_linenumber" name="L149" href="#L149">149</a> dependency.setDisplayFileName(String.format(<span class="jxr_string">"%s/%s"</span>, file.getParentFile().getName(), file.getName()));
<a class="jxr_linenumber" name="L150" href="#L150">150</a> } <strong class="jxr_keyword">catch</strong> (JsonException e) {
<a class="jxr_linenumber" name="L151" href="#L151">151</a> LOGGER.warn(<span class="jxr_string">"Failed to parse package.json file."</span>, e);
<a class="jxr_linenumber" name="L152" href="#L152">152</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L153" href="#L153">153</a> jsonReader.close();
<a class="jxr_linenumber" name="L154" href="#L154">154</a> }
<a class="jxr_linenumber" name="L155" href="#L155">155</a> }
<a class="jxr_linenumber" name="L156" href="#L156">156</a>
<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * Adds information to an evidence collection from the node json configuration.</em>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * @param json information from node.js</em>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * @param collection a set of evidence about a dependency</em>
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * @param key the key to obtain the data from the json information</em>
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> addToEvidence(JsonObject json, <a href="../../../../org/owasp/dependencycheck/dependency/EvidenceCollection.html">EvidenceCollection</a> collection, String key) {
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">if</strong> (json.containsKey(key)) {
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">final</strong> JsonValue value = json.get(key);
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">if</strong> (value instanceof JsonString) {
<a class="jxr_linenumber" name="L168" href="#L168">168</a> collection.addEvidence(PACKAGE_JSON, key, ((JsonString) value).getString(), Confidence.HIGHEST);
<a class="jxr_linenumber" name="L169" href="#L169">169</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (value instanceof JsonObject) {
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">final</strong> JsonObject jsonObject = (JsonObject) value;
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Map.Entry&lt;String, JsonValue&gt; entry : jsonObject.entrySet()) {
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">final</strong> String property = entry.getKey();
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">final</strong> JsonValue subValue = entry.getValue();
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">if</strong> (subValue instanceof JsonString) {
<a class="jxr_linenumber" name="L175" href="#L175">175</a> collection.addEvidence(PACKAGE_JSON,
<a class="jxr_linenumber" name="L176" href="#L176">176</a> String.format(<span class="jxr_string">"%s.%s"</span>, key, property),
<a class="jxr_linenumber" name="L177" href="#L177">177</a> ((JsonString) subValue).getString(),
<a class="jxr_linenumber" name="L178" href="#L178">178</a> Confidence.HIGHEST);
<a class="jxr_linenumber" name="L179" href="#L179">179</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L180" href="#L180">180</a> LOGGER.warn(<span class="jxr_string">"JSON sub-value not string as expected: {}"</span>, subValue);
<a class="jxr_linenumber" name="L181" href="#L181">181</a> }
<a class="jxr_linenumber" name="L182" href="#L182">182</a> }
<a class="jxr_linenumber" name="L183" href="#L183">183</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L184" href="#L184">184</a> LOGGER.warn(<span class="jxr_string">"JSON value not string or JSON object as expected: {}"</span>, value);
<a class="jxr_linenumber" name="L185" href="#L185">185</a> }
<a class="jxr_linenumber" name="L186" href="#L186">186</a> }
<a class="jxr_linenumber" name="L187" href="#L187">187</a> }
<a class="jxr_linenumber" name="L188" href="#L188">188</a> }
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.exception.InitializationException;
<a class="jxr_linenumber" name="L42" href="#L42">42</a>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * Used to analyze Node Package Manager (npm) package.json files, and collect</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * information that can be used to determine the associated CPE.</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 Dale Visser</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/NodePackageAnalyzer.html">NodePackageAnalyzer</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/AbstractFileTypeAnalyzer.html">AbstractFileTypeAnalyzer</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 logger.</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> Logger LOGGER = LoggerFactory.getLogger(NodePackageAnalyzer.<strong class="jxr_keyword">class</strong>);
<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"> * The name of the analyzer.</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 ANALYZER_NAME = <span class="jxr_string">"Node.js Package Analyzer"</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"> * The phase that this analyzer is intended to run in.</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> <a href="../../../../org/owasp/dependencycheck/analyzer/AnalysisPhase.html">AnalysisPhase</a> ANALYSIS_PHASE = AnalysisPhase.INFORMATION_COLLECTION;
<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"> * The file name to scan.</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PACKAGE_JSON = <span class="jxr_string">"package.json"</span>;
<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> <em class="jxr_javadoccomment"> * Filter that detects files named "package.json".</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> FileFilter PACKAGE_JSON_FILTER = FileFilterBuilder.newInstance()
<a class="jxr_linenumber" name="L75" href="#L75">75</a> .addFilenames(PACKAGE_JSON).build();
<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"> * Returns the FileFilter</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * @return the FileFilter</em>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> @Override
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">protected</strong> FileFilter getFileFilter() {
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">return</strong> PACKAGE_JSON_FILTER;
<a class="jxr_linenumber" name="L85" href="#L85">85</a> }
<a class="jxr_linenumber" name="L86" href="#L86">86</a>
<a class="jxr_linenumber" name="L87" href="#L87">87</a> @Override
<a class="jxr_linenumber" name="L88" href="#L88">88</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="L89" href="#L89">89</a> <em class="jxr_comment">// NO-OP</em>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> }
<a class="jxr_linenumber" name="L91" href="#L91">91</a>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * Returns the name of the analyzer.</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @return the name of the analyzer.</em>
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> @Override
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">public</strong> String getName() {
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">return</strong> ANALYZER_NAME;
<a class="jxr_linenumber" name="L100" href="#L100">100</a> }
<a class="jxr_linenumber" name="L101" href="#L101">101</a>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * Returns the phase that the analyzer is intended to run in.</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @return the phase that the analyzer is intended to run in.</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> @Override
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/AnalysisPhase.html">AnalysisPhase</a> getAnalysisPhase() {
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">return</strong> ANALYSIS_PHASE;
<a class="jxr_linenumber" name="L110" href="#L110">110</a> }
<a class="jxr_linenumber" name="L111" href="#L111">111</a>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * Returns the key used in the properties file to reference the analyzer's</em>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * enabled property.</em>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * @return the analyzer's enabled property setting key</em>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> @Override
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">protected</strong> String getAnalyzerEnabledSettingKey() {
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">return</strong> Settings.KEYS.ANALYZER_NODE_PACKAGE_ENABLED;
<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
<a class="jxr_linenumber" name="L122" href="#L122">122</a>
<a class="jxr_linenumber" name="L123" href="#L123">123</a> @Override
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> analyzeFileType(<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="L125" href="#L125">125</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/exception/AnalysisException.html">AnalysisException</a> {
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">final</strong> File file = dependency.getActualFile();
<a class="jxr_linenumber" name="L127" href="#L127">127</a> JsonReader jsonReader;
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L129" href="#L129">129</a> jsonReader = Json.createReader(FileUtils.openInputStream(file));
<a class="jxr_linenumber" name="L130" href="#L130">130</a> } <strong class="jxr_keyword">catch</strong> (IOException e) {
<a class="jxr_linenumber" name="L131" href="#L131">131</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="L132" href="#L132">132</a> <span class="jxr_string">"Problem occurred while reading dependency file."</span>, e);
<a class="jxr_linenumber" name="L133" href="#L133">133</a> }
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">final</strong> JsonObject json = jsonReader.readObject();
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/dependency/EvidenceCollection.html">EvidenceCollection</a> productEvidence = dependency.getProductEvidence();
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/dependency/EvidenceCollection.html">EvidenceCollection</a> vendorEvidence = dependency.getVendorEvidence();
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">if</strong> (json.containsKey(<span class="jxr_string">"name"</span>)) {
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">final</strong> Object value = json.get(<span class="jxr_string">"name"</span>);
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">if</strong> (value instanceof JsonString) {
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">final</strong> String valueString = ((JsonString) value).getString();
<a class="jxr_linenumber" name="L142" href="#L142">142</a> productEvidence.addEvidence(PACKAGE_JSON, <span class="jxr_string">"name"</span>, valueString, Confidence.HIGHEST);
<a class="jxr_linenumber" name="L143" href="#L143">143</a> vendorEvidence.addEvidence(PACKAGE_JSON, <span class="jxr_string">"name_project"</span>, String.format(<span class="jxr_string">"%s_project"</span>, valueString), Confidence.LOW);
<a class="jxr_linenumber" name="L144" href="#L144">144</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L145" href="#L145">145</a> LOGGER.warn(<span class="jxr_string">"JSON value not string as expected: {}"</span>, value);
<a class="jxr_linenumber" name="L146" href="#L146">146</a> }
<a class="jxr_linenumber" name="L147" href="#L147">147</a> }
<a class="jxr_linenumber" name="L148" href="#L148">148</a> addToEvidence(json, productEvidence, <span class="jxr_string">"description"</span>);
<a class="jxr_linenumber" name="L149" href="#L149">149</a> addToEvidence(json, vendorEvidence, <span class="jxr_string">"author"</span>);
<a class="jxr_linenumber" name="L150" href="#L150">150</a> addToEvidence(json, dependency.getVersionEvidence(), <span class="jxr_string">"version"</span>);
<a class="jxr_linenumber" name="L151" href="#L151">151</a> dependency.setDisplayFileName(String.format(<span class="jxr_string">"%s/%s"</span>, file.getParentFile().getName(), file.getName()));
<a class="jxr_linenumber" name="L152" href="#L152">152</a> } <strong class="jxr_keyword">catch</strong> (JsonException e) {
<a class="jxr_linenumber" name="L153" href="#L153">153</a> LOGGER.warn(<span class="jxr_string">"Failed to parse package.json file."</span>, e);
<a class="jxr_linenumber" name="L154" href="#L154">154</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L155" href="#L155">155</a> jsonReader.close();
<a class="jxr_linenumber" name="L156" href="#L156">156</a> }
<a class="jxr_linenumber" name="L157" href="#L157">157</a> }
<a class="jxr_linenumber" name="L158" href="#L158">158</a>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * Adds information to an evidence collection from the node json</em>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * configuration.</em>
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * @param json information from node.js</em>
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * @param collection a set of evidence about a dependency</em>
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * @param key the key to obtain the data from the json information</em>
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> addToEvidence(JsonObject json, <a href="../../../../org/owasp/dependencycheck/dependency/EvidenceCollection.html">EvidenceCollection</a> collection, String key) {
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">if</strong> (json.containsKey(key)) {
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">final</strong> JsonValue value = json.get(key);
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">if</strong> (value instanceof JsonString) {
<a class="jxr_linenumber" name="L171" href="#L171">171</a> collection.addEvidence(PACKAGE_JSON, key, ((JsonString) value).getString(), Confidence.HIGHEST);
<a class="jxr_linenumber" name="L172" href="#L172">172</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (value instanceof JsonObject) {
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">final</strong> JsonObject jsonObject = (JsonObject) value;
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Map.Entry&lt;String, JsonValue&gt; entry : jsonObject.entrySet()) {
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">final</strong> String property = entry.getKey();
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">final</strong> JsonValue subValue = entry.getValue();
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">if</strong> (subValue instanceof JsonString) {
<a class="jxr_linenumber" name="L178" href="#L178">178</a> collection.addEvidence(PACKAGE_JSON,
<a class="jxr_linenumber" name="L179" href="#L179">179</a> String.format(<span class="jxr_string">"%s.%s"</span>, key, property),
<a class="jxr_linenumber" name="L180" href="#L180">180</a> ((JsonString) subValue).getString(),
<a class="jxr_linenumber" name="L181" href="#L181">181</a> Confidence.HIGHEST);
<a class="jxr_linenumber" name="L182" href="#L182">182</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L183" href="#L183">183</a> LOGGER.warn(<span class="jxr_string">"JSON sub-value not string as expected: {}"</span>, subValue);
<a class="jxr_linenumber" name="L184" href="#L184">184</a> }
<a class="jxr_linenumber" name="L185" href="#L185">185</a> }
<a class="jxr_linenumber" name="L186" href="#L186">186</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L187" href="#L187">187</a> LOGGER.warn(<span class="jxr_string">"JSON value not string or JSON object as expected: {}"</span>, value);
<a class="jxr_linenumber" name="L188" href="#L188">188</a> }
<a class="jxr_linenumber" name="L189" href="#L189">189</a> }
<a class="jxr_linenumber" name="L190" href="#L190">190</a> }
<a class="jxr_linenumber" name="L191" href="#L191">191</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2012&#x2013;2016 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>