documentation update v1.4.4

This commit is contained in:
Jeremy Long
2016-11-05 09:41:16 -04:00
parent e1a447f722
commit a1b5e3f7b0
1217 changed files with 79708 additions and 51391 deletions

View File

@@ -32,19 +32,19 @@
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.composer.ComposerLockParser;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Confidence;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Dependency;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Checksum;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.FileFilterBuilder;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Settings;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L32" href="#L32">32</a>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.io.FileFilter;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> java.io.FileNotFoundException;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> java.nio.charset.Charset;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> java.security.MessageDigest;
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> java.security.NoSuchAlgorithmException;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.exception.InitializationException;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.exception.InitializationException;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Checksum;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.FileFilterBuilder;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Settings;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L33" href="#L33">33</a>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> java.io.FileFilter;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> java.io.FileNotFoundException;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> java.nio.charset.Charset;
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> java.security.MessageDigest;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> java.security.NoSuchAlgorithmException;
<a class="jxr_linenumber" name="L40" href="#L40">40</a>
<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"> * Used to analyze a composer.lock file for a composer PHP app.</em>
@@ -93,91 +93,100 @@
<a class="jxr_linenumber" name="L85" href="#L85">85</a> @Override
<a class="jxr_linenumber" name="L86" href="#L86">86</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="L87" href="#L87">87</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L88" href="#L88">88</a> sha1 = MessageDigest.getInstance(<span class="jxr_string">"SHA1"</span>);
<a class="jxr_linenumber" name="L89" href="#L89">89</a> } <strong class="jxr_keyword">catch</strong> (NoSuchAlgorithmException ex) {
<a class="jxr_linenumber" name="L88" href="#L88">88</a> getSha1MessageDigest();
<a class="jxr_linenumber" name="L89" href="#L89">89</a> } <strong class="jxr_keyword">catch</strong> (IllegalStateException ex) {
<a class="jxr_linenumber" name="L90" href="#L90">90</a> setEnabled(false);
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/exception/InitializationException.html">InitializationException</a>(<span class="jxr_string">"Unable to create SHA1 MmessageDigest"</span>, ex);
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/exception/InitializationException.html">InitializationException</a>(<span class="jxr_string">"Unable to create SHA1 MessageDigest"</span>, ex);
<a class="jxr_linenumber" name="L92" href="#L92">92</a> }
<a class="jxr_linenumber" name="L93" href="#L93">93</a> }
<a class="jxr_linenumber" name="L94" href="#L94">94</a>
<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> <em class="jxr_javadoccomment"> * The MessageDigest for calculating a new digest for the new dependencies</em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * added.</em>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">private</strong> MessageDigest sha1 = <strong class="jxr_keyword">null</strong>;
<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"> * Entry point for the analyzer.</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"> * @param dependency the dependency to analyze</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @param engine the engine scanning</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * @throws AnalysisException if there's a failure during analysis</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> @Override
<a class="jxr_linenumber" name="L109" href="#L109">109</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) <strong class="jxr_keyword">throws</strong> AnalysisException {
<a class="jxr_linenumber" name="L110" href="#L110">110</a> FileInputStream fis = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L112" href="#L112">112</a> fis = <strong class="jxr_keyword">new</strong> FileInputStream(dependency.getActualFile());
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/data/composer/ComposerLockParser.html">ComposerLockParser</a> clp = <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/data/composer/ComposerLockParser.html">ComposerLockParser</a>(fis);
<a class="jxr_linenumber" name="L114" href="#L114">114</a> LOGGER.info(<span class="jxr_string">"Checking composer.lock file {}"</span>, dependency.getActualFilePath());
<a class="jxr_linenumber" name="L115" href="#L115">115</a> clp.process();
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">for</strong> (ComposerDependency dep : clp.getDependencies()) {
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/dependency/Dependency.html">Dependency</a> d = <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/dependency/Dependency.html">Dependency</a>(dependency.getActualFile());
<a class="jxr_linenumber" name="L118" href="#L118">118</a> d.setDisplayFileName(String.format(<span class="jxr_string">"%s:%s/%s"</span>, dependency.getDisplayFileName(), dep.getGroup(), dep.getProject()));
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">final</strong> String filePath = String.format(<span class="jxr_string">"%s:%s/%s"</span>, dependency.getFilePath(), dep.getGroup(), dep.getProject());
<a class="jxr_linenumber" name="L120" href="#L120">120</a> d.setFilePath(filePath);
<a class="jxr_linenumber" name="L121" href="#L121">121</a> d.setSha1sum(Checksum.getHex(sha1.digest(filePath.getBytes(Charset.defaultCharset()))));
<a class="jxr_linenumber" name="L122" href="#L122">122</a> d.getVendorEvidence().addEvidence(COMPOSER_LOCK, <span class="jxr_string">"vendor"</span>, dep.getGroup(), Confidence.HIGHEST);
<a class="jxr_linenumber" name="L123" href="#L123">123</a> d.getProductEvidence().addEvidence(COMPOSER_LOCK, <span class="jxr_string">"product"</span>, dep.getProject(), Confidence.HIGHEST);
<a class="jxr_linenumber" name="L124" href="#L124">124</a> d.getVersionEvidence().addEvidence(COMPOSER_LOCK, <span class="jxr_string">"version"</span>, dep.getVersion(), Confidence.HIGHEST);
<a class="jxr_linenumber" name="L125" href="#L125">125</a> LOGGER.info(<span class="jxr_string">"Adding dependency {}"</span>, d);
<a class="jxr_linenumber" name="L126" href="#L126">126</a> engine.getDependencies().add(d);
<a class="jxr_linenumber" name="L127" href="#L127">127</a> }
<a class="jxr_linenumber" name="L128" href="#L128">128</a> } <strong class="jxr_keyword">catch</strong> (FileNotFoundException fnfe) {
<a class="jxr_linenumber" name="L129" href="#L129">129</a> LOGGER.warn(<span class="jxr_string">"Error opening dependency {}"</span>, dependency.getActualFilePath());
<a class="jxr_linenumber" name="L130" href="#L130">130</a> } <strong class="jxr_keyword">catch</strong> (ComposerException ce) {
<a class="jxr_linenumber" name="L131" href="#L131">131</a> LOGGER.warn(<span class="jxr_string">"Error parsing composer.json {}"</span>, dependency.getActualFilePath(), ce);
<a class="jxr_linenumber" name="L132" href="#L132">132</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">if</strong> (fis != <strong class="jxr_keyword">null</strong>) {
<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> fis.close();
<a class="jxr_linenumber" name="L136" href="#L136">136</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a class="jxr_linenumber" name="L137" href="#L137">137</a> LOGGER.debug(<span class="jxr_string">"Unable to close file"</span>, e);
<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> }
<a class="jxr_linenumber" name="L142" href="#L142">142</a>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * Gets the key to determine whether the analyzer is enabled.</em>
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * @return the key specifying whether the analyzer is enabled</em>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L148" href="#L148">148</a> @Override
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">protected</strong> String getAnalyzerEnabledSettingKey() {
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">return</strong> Settings.KEYS.ANALYZER_COMPOSER_LOCK_ENABLED;
<a class="jxr_linenumber" name="L151" href="#L151">151</a> }
<a class="jxr_linenumber" name="L152" href="#L152">152</a>
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * Returns the analyzer's name.</em>
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * @return the analyzer's name</em>
<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> @Override
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">public</strong> String getName() {
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">return</strong> ANALYZER_NAME;
<a class="jxr_linenumber" name="L161" href="#L161">161</a> }
<a class="jxr_linenumber" name="L162" href="#L162">162</a>
<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> <em class="jxr_javadoccomment"> * Returns the phase this analyzer should run under.</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"> * @return the analysis phase</em>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L168" href="#L168">168</a> @Override
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/AnalysisPhase.html">AnalysisPhase</a> getAnalysisPhase() {
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">return</strong> AnalysisPhase.INFORMATION_COLLECTION;
<a class="jxr_linenumber" name="L171" href="#L171">171</a> }
<a class="jxr_linenumber" name="L172" href="#L172">172</a> }
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * Entry point for the analyzer.</em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * @param dependency the dependency to analyze</em>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * @param engine the engine scanning</em>
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * @throws AnalysisException if there's a failure during analysis</em>
<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> @Override
<a class="jxr_linenumber" name="L103" href="#L103">103</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) <strong class="jxr_keyword">throws</strong> AnalysisException {
<a class="jxr_linenumber" name="L104" href="#L104">104</a> FileInputStream fis = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L106" href="#L106">106</a> fis = <strong class="jxr_keyword">new</strong> FileInputStream(dependency.getActualFile());
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/data/composer/ComposerLockParser.html">ComposerLockParser</a> clp = <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/data/composer/ComposerLockParser.html">ComposerLockParser</a>(fis);
<a class="jxr_linenumber" name="L108" href="#L108">108</a> LOGGER.info(<span class="jxr_string">"Checking composer.lock file {}"</span>, dependency.getActualFilePath());
<a class="jxr_linenumber" name="L109" href="#L109">109</a> clp.process();
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">for</strong> (ComposerDependency dep : clp.getDependencies()) {
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/dependency/Dependency.html">Dependency</a> d = <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/dependency/Dependency.html">Dependency</a>(dependency.getActualFile());
<a class="jxr_linenumber" name="L112" href="#L112">112</a> d.setDisplayFileName(String.format(<span class="jxr_string">"%s:%s/%s"</span>, dependency.getDisplayFileName(), dep.getGroup(), dep.getProject()));
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">final</strong> String filePath = String.format(<span class="jxr_string">"%s:%s/%s"</span>, dependency.getFilePath(), dep.getGroup(), dep.getProject());
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">final</strong> MessageDigest sha1 = getSha1MessageDigest();
<a class="jxr_linenumber" name="L115" href="#L115">115</a> d.setFilePath(filePath);
<a class="jxr_linenumber" name="L116" href="#L116">116</a> d.setSha1sum(Checksum.getHex(sha1.digest(filePath.getBytes(Charset.defaultCharset()))));
<a class="jxr_linenumber" name="L117" href="#L117">117</a> d.getVendorEvidence().addEvidence(COMPOSER_LOCK, <span class="jxr_string">"vendor"</span>, dep.getGroup(), Confidence.HIGHEST);
<a class="jxr_linenumber" name="L118" href="#L118">118</a> d.getProductEvidence().addEvidence(COMPOSER_LOCK, <span class="jxr_string">"product"</span>, dep.getProject(), Confidence.HIGHEST);
<a class="jxr_linenumber" name="L119" href="#L119">119</a> d.getVersionEvidence().addEvidence(COMPOSER_LOCK, <span class="jxr_string">"version"</span>, dep.getVersion(), Confidence.HIGHEST);
<a class="jxr_linenumber" name="L120" href="#L120">120</a> LOGGER.info(<span class="jxr_string">"Adding dependency {}"</span>, d);
<a class="jxr_linenumber" name="L121" href="#L121">121</a> engine.getDependencies().add(d);
<a class="jxr_linenumber" name="L122" href="#L122">122</a> }
<a class="jxr_linenumber" name="L123" href="#L123">123</a> } <strong class="jxr_keyword">catch</strong> (FileNotFoundException fnfe) {
<a class="jxr_linenumber" name="L124" href="#L124">124</a> LOGGER.warn(<span class="jxr_string">"Error opening dependency {}"</span>, dependency.getActualFilePath());
<a class="jxr_linenumber" name="L125" href="#L125">125</a> } <strong class="jxr_keyword">catch</strong> (ComposerException ce) {
<a class="jxr_linenumber" name="L126" href="#L126">126</a> LOGGER.warn(<span class="jxr_string">"Error parsing composer.json {}"</span>, dependency.getActualFilePath(), ce);
<a class="jxr_linenumber" name="L127" href="#L127">127</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">if</strong> (fis != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L130" href="#L130">130</a> fis.close();
<a class="jxr_linenumber" name="L131" href="#L131">131</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a class="jxr_linenumber" name="L132" href="#L132">132</a> LOGGER.debug(<span class="jxr_string">"Unable to close file"</span>, e);
<a class="jxr_linenumber" name="L133" href="#L133">133</a> }
<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> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * Gets the key to determine whether the analyzer is enabled.</em>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * @return the key specifying whether the analyzer is enabled</em>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> @Override
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">protected</strong> String getAnalyzerEnabledSettingKey() {
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">return</strong> Settings.KEYS.ANALYZER_COMPOSER_LOCK_ENABLED;
<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> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * Returns the analyzer's name.</em>
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * @return the analyzer's name</em>
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L153" href="#L153">153</a> @Override
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">public</strong> String getName() {
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">return</strong> ANALYZER_NAME;
<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> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * Returns the phase this analyzer should run under.</em>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * @return the analysis phase</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> @Override
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/AnalysisPhase.html">AnalysisPhase</a> getAnalysisPhase() {
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">return</strong> AnalysisPhase.INFORMATION_COLLECTION;
<a class="jxr_linenumber" name="L166" href="#L166">166</a> }
<a class="jxr_linenumber" name="L167" href="#L167">167</a>
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * Returns the sha1 message digest.</em>
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * @return the sha1 message digest</em>
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">private</strong> MessageDigest getSha1MessageDigest() {
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">return</strong> MessageDigest.getInstance(<span class="jxr_string">"SHA1"</span>);
<a class="jxr_linenumber" name="L176" href="#L176">176</a> } <strong class="jxr_keyword">catch</strong> (NoSuchAlgorithmException e) {
<a class="jxr_linenumber" name="L177" href="#L177">177</a> LOGGER.error(e.getMessage());
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Failed to obtain the SHA1 message digest."</span>, e);
<a class="jxr_linenumber" name="L179" href="#L179">179</a> }
<a class="jxr_linenumber" name="L180" href="#L180">180</a> }
<a class="jxr_linenumber" name="L181" href="#L181">181</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2012&#x2013;2016 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>