github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-03-24 18:11:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

version 1.0.6

Browse Source
This commit is contained in:
Jeremy Long
2013-12-01 10:05:10 -05:00
parent f15b1f84b1
commit b4f90c9816
1264 changed files with 297862 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

129
dependency-check-core/xref/org/owasp/dependencycheck/analyzer/AbstractSuppressionAnalyzer.html Normal file
View File

@@ -0,0 +1,129 @@
<!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>AbstractSuppressionAnalyzer xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/analyzer/AbstractSuppressionAnalyzer.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * This file is part of dependency-check-core.</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Dependency-check-core is free software: you can redistribute it and/or modify it</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * under the terms of the GNU General Public License as published by the Free</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * Software Foundation, either version 3 of the License, or (at your option) any</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * later version.</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * Dependency-check-core is distributed in the hope that it will be useful, but</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * details.</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * You should have received a copy of the GNU General Public License along with</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * dependency-check-core. If not, see <a href="http://www.gnu.org/licenses/." target="alexandria_uri">http://www.gnu.org/licenses/.</a></em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * Copyright (c) 2013 Jeremy Long. All Rights Reserved.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.analyzer;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.Set;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.logging.Level;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.logging.Logger;
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.suppression.SuppressionParseException;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.suppression.SuppressionParser;
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.suppression.SuppressionRule;
<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Settings;
<a class="jxr_linenumber" name="30" href="#30">30</a>
<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Abstract base suppression analyzer that contains methods for parsing the</em>
<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * suppression xml file.</em>
<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * @author Jeremy Long (jeremy.long@owasp.org)</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="37" href="#37">37</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/AbstractSuppressionAnalyzer.html">AbstractSuppressionAnalyzer</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/AbstractAnalyzer.html">AbstractAnalyzer</a> {
<a class="jxr_linenumber" name="38" href="#38">38</a>
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_comment">//&lt;editor-fold defaultstate="collapsed" desc="All standard implmentation details of Analyzer"&gt;</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * Returns a list of file EXTENSIONS supported by this analyzer.</em>
<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @return a list of file EXTENSIONS supported by this analyzer.</em>
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> Set&lt;String&gt; getSupportedExtensions() {
<a class="jxr_linenumber" name="46" href="#46">46</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="47" href="#47">47</a> }
<a class="jxr_linenumber" name="48" href="#48">48</a>
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * Returns whether or not this analyzer can process the given extension.</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * @param extension the file extension to test for support.</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @return whether or not the specified file extension is supported by this</em>
<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * analyzer.</em>
<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="56" href="#56">56</a> @Override
<a class="jxr_linenumber" name="57" href="#57">57</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> supportsExtension(String extension) {
<a class="jxr_linenumber" name="58" href="#58">58</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="59" href="#59">59</a> }
<a class="jxr_linenumber" name="60" href="#60">60</a>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_comment">//&lt;/editor-fold&gt;</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * The initialize method loads the suppression XML file.</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * @throws Exception thrown if there is an exception</em>
<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="67" href="#67">67</a> @Override
<a class="jxr_linenumber" name="68" href="#68">68</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> initialize() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="69" href="#69">69</a> <strong class="jxr_keyword">super</strong>.initialize();
<a class="jxr_linenumber" name="70" href="#70">70</a> loadSuppressionData();
<a class="jxr_linenumber" name="71" href="#71">71</a> }
<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * The list of suppression rules</em>
<a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="75" href="#75">75</a> <strong class="jxr_keyword">private</strong> List&lt;SuppressionRule&gt; rules;
<a class="jxr_linenumber" name="76" href="#76">76</a>
<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * Get the value of rules.</em>
<a class="jxr_linenumber" name="79" href="#79">79</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @return the value of rules</em>
<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="82" href="#82">82</a> <strong class="jxr_keyword">public</strong> List&lt;SuppressionRule&gt; getRules() {
<a class="jxr_linenumber" name="83" href="#83">83</a> <strong class="jxr_keyword">return</strong> rules;
<a class="jxr_linenumber" name="84" href="#84">84</a> }
<a class="jxr_linenumber" name="85" href="#85">85</a>
<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * Set the value of rules.</em>
<a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @param rules new value of rules</em>
<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="91" href="#91">91</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRules(List&lt;SuppressionRule&gt; rules) {
<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">this</strong>.rules = rules;
<a class="jxr_linenumber" name="93" href="#93">93</a> }
<a class="jxr_linenumber" name="94" href="#94">94</a>
<a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * Loads the suppression rules file.</em>
<a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @throws SuppressionParseException thrown if the XML cannot be parsed.</em>
<a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="100" href="#100">100</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> loadSuppressionData() <strong class="jxr_keyword">throws</strong> SuppressionParseException {
<a class="jxr_linenumber" name="101" href="#101">101</a> <strong class="jxr_keyword">final</strong> File file = Settings.getFile(Settings.KEYS.SUPPRESSION_FILE);
<a class="jxr_linenumber" name="102" href="#102">102</a> <strong class="jxr_keyword">if</strong> (file != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="103" href="#103">103</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionParser.html">SuppressionParser</a> parser = <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionParser.html">SuppressionParser</a>();
<a class="jxr_linenumber" name="104" href="#104">104</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="105" href="#105">105</a> rules = parser.parseSuppressionRules(file);
<a class="jxr_linenumber" name="106" href="#106">106</a> } <strong class="jxr_keyword">catch</strong> (SuppressionParseException ex) {
<a class="jxr_linenumber" name="107" href="#107">107</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Unable to parse suppression xml file '%s'"</span>, file.getPath());
<a class="jxr_linenumber" name="108" href="#108">108</a> Logger.getLogger(AbstractSuppressionAnalyzer.<strong class="jxr_keyword">class</strong>.getName()).log(Level.WARNING, msg);
<a class="jxr_linenumber" name="109" href="#109">109</a> Logger.getLogger(AbstractSuppressionAnalyzer.<strong class="jxr_keyword">class</strong>.getName()).log(Level.WARNING, ex.getMessage());
<a class="jxr_linenumber" name="110" href="#110">110</a> Logger.getLogger(AbstractSuppressionAnalyzer.<strong class="jxr_keyword">class</strong>.getName()).log(Level.FINE, <strong class="jxr_keyword">null</strong>, ex);
<a class="jxr_linenumber" name="111" href="#111">111</a> <strong class="jxr_keyword">throw</strong> ex;
<a class="jxr_linenumber" name="112" href="#112">112</a> }
<a class="jxr_linenumber" name="113" href="#113">113</a> }
<a class="jxr_linenumber" name="114" href="#114">114</a> }
<a class="jxr_linenumber" name="115" href="#115">115</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

90
dependency-check-core/xref/org/owasp/dependencycheck/analyzer/CpeSuppressionAnalyzer.html Normal file
View File

@@ -0,0 +1,90 @@
<!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>CpeSuppressionAnalyzer xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/analyzer/CpeSuppressionAnalyzer.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * This file is part of dependency-check-core.</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Dependency-check-core is free software: you can redistribute it and/or modify it</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * under the terms of the GNU General Public License as published by the Free</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * Software Foundation, either version 3 of the License, or (at your option) any</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * later version.</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * Dependency-check-core is distributed in the hope that it will be useful, but</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * details.</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * You should have received a copy of the GNU General Public License along with</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * dependency-check-core. If not, see <a href="http://www.gnu.org/licenses/." target="alexandria_uri">http://www.gnu.org/licenses/.</a></em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * Copyright (c) 2013 Jeremy Long. All Rights Reserved.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.analyzer;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.Engine;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Dependency;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.suppression.SuppressionRule;
<a class="jxr_linenumber" name="24" href="#24">24</a>
<a class="jxr_linenumber" name="25" href="#25">25</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * The suppression analyzer processes an externally defined XML document that</em>
<a class="jxr_linenumber" name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * complies with the suppressions.xsd schema. Any identified CPE entries within</em>
<a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * the dependencies that match will be removed.</em>
<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * @author Jeremy Long (jeremy.long@owasp.org)</em>
<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/CpeSuppressionAnalyzer.html">CpeSuppressionAnalyzer</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/AbstractSuppressionAnalyzer.html">AbstractSuppressionAnalyzer</a> {
<a class="jxr_linenumber" name="33" href="#33">33</a>
<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_comment">//&lt;editor-fold defaultstate="collapsed" desc="All standard implmentation details of Analyzer"&gt;</em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * The name of the analyzer.</em>
<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="38" href="#38">38</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">"Cpe Suppression Analyzer"</span>;
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * The phase that this analyzer is intended to run in.</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="42" href="#42">42</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.POST_IDENTIFIER_ANALYSIS;
<a class="jxr_linenumber" name="43" href="#43">43</a>
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * Returns the name of the analyzer.</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @return the name of the analyzer.</em>
<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="49" href="#49">49</a> @Override
<a class="jxr_linenumber" name="50" href="#50">50</a> <strong class="jxr_keyword">public</strong> String getName() {
<a class="jxr_linenumber" name="51" href="#51">51</a> <strong class="jxr_keyword">return</strong> ANALYZER_NAME;
<a class="jxr_linenumber" name="52" href="#52">52</a> }
<a class="jxr_linenumber" name="53" href="#53">53</a>
<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * Returns the phase that the analyzer is intended to run in.</em>
<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * @return the phase that the analyzer is intended to run in.</em>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> @Override
<a class="jxr_linenumber" name="60" href="#60">60</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/AnalysisPhase.html">AnalysisPhase</a> getAnalysisPhase() {
<a class="jxr_linenumber" name="61" href="#61">61</a> <strong class="jxr_keyword">return</strong> ANALYSIS_PHASE;
<a class="jxr_linenumber" name="62" href="#62">62</a> }
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_comment">//&lt;/editor-fold&gt;</em>
<a class="jxr_linenumber" name="64" href="#64">64</a>
<a class="jxr_linenumber" name="65" href="#65">65</a> @Override
<a class="jxr_linenumber" name="66" href="#66">66</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> analyze(<strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/dependency/Dependency.html">Dependency</a> dependency, <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/Engine.html">Engine</a> engine) <strong class="jxr_keyword">throws</strong> AnalysisException {
<a class="jxr_linenumber" name="67" href="#67">67</a>
<a class="jxr_linenumber" name="68" href="#68">68</a> <strong class="jxr_keyword">if</strong> (getRules() == <strong class="jxr_keyword">null</strong> || getRules().size() &lt;= 0) {
<a class="jxr_linenumber" name="69" href="#69">69</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="70" href="#70">70</a> }
<a class="jxr_linenumber" name="71" href="#71">71</a>
<a class="jxr_linenumber" name="72" href="#72">72</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> SuppressionRule rule : getRules()) {
<a class="jxr_linenumber" name="73" href="#73">73</a> rule.process(dependency);
<a class="jxr_linenumber" name="74" href="#74">74</a> }
<a class="jxr_linenumber" name="75" href="#75">75</a> }
<a class="jxr_linenumber" name="76" href="#76">76</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

90
dependency-check-core/xref/org/owasp/dependencycheck/analyzer/VulnerabilitySuppressionAnalyzer.html Normal file
View File

@@ -0,0 +1,90 @@
<!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>VulnerabilitySuppressionAnalyzer xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/analyzer/VulnerabilitySuppressionAnalyzer.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * This file is part of dependency-check-core.</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Dependency-check-core is free software: you can redistribute it and/or modify it</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * under the terms of the GNU General Public License as published by the Free</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * Software Foundation, either version 3 of the License, or (at your option) any</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * later version.</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * Dependency-check-core is distributed in the hope that it will be useful, but</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * details.</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * You should have received a copy of the GNU General Public License along with</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * dependency-check-core. If not, see <a href="http://www.gnu.org/licenses/." target="alexandria_uri">http://www.gnu.org/licenses/.</a></em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * Copyright (c) 2013 Jeremy Long. All Rights Reserved.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.analyzer;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.Engine;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Dependency;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.suppression.SuppressionRule;
<a class="jxr_linenumber" name="24" href="#24">24</a>
<a class="jxr_linenumber" name="25" href="#25">25</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * The suppression analyzer processes an externally defined XML document that</em>
<a class="jxr_linenumber" name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * complies with the suppressions.xsd schema. Any identified Vulnerability</em>
<a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * entries within the dependencies that match will be removed.</em>
<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * @author Jeremy Long (jeremy.long@owasp.org)</em>
<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/VulnerabilitySuppressionAnalyzer.html">VulnerabilitySuppressionAnalyzer</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/AbstractSuppressionAnalyzer.html">AbstractSuppressionAnalyzer</a> {
<a class="jxr_linenumber" name="33" href="#33">33</a>
<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_comment">//&lt;editor-fold defaultstate="collapsed" desc="All standard implmentation details of Analyzer"&gt;</em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * The name of the analyzer.</em>
<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="38" href="#38">38</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">"Vulnerability Suppression Analyzer"</span>;
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * The phase that this analyzer is intended to run in.</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="42" href="#42">42</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.POST_FINDING_ANALYSIS;
<a class="jxr_linenumber" name="43" href="#43">43</a>
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * Returns the name of the analyzer.</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @return the name of the analyzer.</em>
<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="49" href="#49">49</a> @Override
<a class="jxr_linenumber" name="50" href="#50">50</a> <strong class="jxr_keyword">public</strong> String getName() {
<a class="jxr_linenumber" name="51" href="#51">51</a> <strong class="jxr_keyword">return</strong> ANALYZER_NAME;
<a class="jxr_linenumber" name="52" href="#52">52</a> }
<a class="jxr_linenumber" name="53" href="#53">53</a>
<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * Returns the phase that the analyzer is intended to run in.</em>
<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * @return the phase that the analyzer is intended to run in.</em>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> @Override
<a class="jxr_linenumber" name="60" href="#60">60</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/AnalysisPhase.html">AnalysisPhase</a> getAnalysisPhase() {
<a class="jxr_linenumber" name="61" href="#61">61</a> <strong class="jxr_keyword">return</strong> ANALYSIS_PHASE;
<a class="jxr_linenumber" name="62" href="#62">62</a> }
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_comment">//&lt;/editor-fold&gt;</em>
<a class="jxr_linenumber" name="64" href="#64">64</a>
<a class="jxr_linenumber" name="65" href="#65">65</a> @Override
<a class="jxr_linenumber" name="66" href="#66">66</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> analyze(<strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/dependency/Dependency.html">Dependency</a> dependency, <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/Engine.html">Engine</a> engine) <strong class="jxr_keyword">throws</strong> AnalysisException {
<a class="jxr_linenumber" name="67" href="#67">67</a>
<a class="jxr_linenumber" name="68" href="#68">68</a> <strong class="jxr_keyword">if</strong> (getRules() == <strong class="jxr_keyword">null</strong> || getRules().size() &lt;= 0) {
<a class="jxr_linenumber" name="69" href="#69">69</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="70" href="#70">70</a> }
<a class="jxr_linenumber" name="71" href="#71">71</a>
<a class="jxr_linenumber" name="72" href="#72">72</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> SuppressionRule rule : getRules()) {
<a class="jxr_linenumber" name="73" href="#73">73</a> rule.process(dependency);
<a class="jxr_linenumber" name="74" href="#74">74</a> }
<a class="jxr_linenumber" name="75" href="#75">75</a> }
<a class="jxr_linenumber" name="76" href="#76">76</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

259
dependency-check-core/xref/org/owasp/dependencycheck/data/BaseDB.html Normal file
View File

@@ -0,0 +1,259 @@
<!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>BaseDB xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/data/BaseDB.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * This file is part of dependency-check-core.</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Dependency-check-core is free software: you can redistribute it and/or modify it</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * under the terms of the GNU General Public License as published by the Free</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * Software Foundation, either version 3 of the License, or (at your option) any</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * later version.</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * Dependency-check-core is distributed in the hope that it will be useful, but</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * details.</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * You should have received a copy of the GNU General Public License along with</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * dependency-check-core. If not, see <a href="http://www.gnu.org/licenses/." target="alexandria_uri">http://www.gnu.org/licenses/.</a></em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * Copyright (c) 2013 Jeremy Long. All Rights Reserved.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.data;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.io.BufferedReader;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.io.InputStreamReader;
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.sql.Connection;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.sql.DriverManager;
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.sql.PreparedStatement;
<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.sql.ResultSet;
<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.sql.SQLException;
<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.sql.Statement;
<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> java.util.logging.Level;
<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.util.logging.Logger;
<a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.CveDB;
<a class="jxr_linenumber" name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.owasp.dependencycheck.data.nvdcve.CveDB.DB_SCHEMA_VERSION;
<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.DatabaseException;
<a class="jxr_linenumber" name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Settings;
<a class="jxr_linenumber" name="38" href="#38">38</a>
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @author Jeremy Long (jeremy.long@owasp.org)</em>
<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/data/BaseDB.html">BaseDB</a> {
<a class="jxr_linenumber" name="44" href="#44">44</a>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Resource location for SQL file used to create the database schema.</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="48" href="#48">48</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DB_STRUCTURE_RESOURCE = <span class="jxr_string">"data/initialize.sql"</span>;
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * The version of the current DB Schema.</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DB_SCHEMA_VERSION = <span class="jxr_string">"2.7"</span>;
<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * Database connection</em>
<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="56" href="#56">56</a> <strong class="jxr_keyword">private</strong> Connection conn;
<a class="jxr_linenumber" name="57" href="#57">57</a>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * Returns the database connection.</em>
<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @return the database connection</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <strong class="jxr_keyword">protected</strong> Connection getConnection() {
<a class="jxr_linenumber" name="64" href="#64">64</a> <strong class="jxr_keyword">return</strong> conn;
<a class="jxr_linenumber" name="65" href="#65">65</a> }
<a class="jxr_linenumber" name="66" href="#66">66</a>
<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * Opens the database connection. If the database does not exist, it will</em>
<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * create a new one.</em>
<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @throws IOException thrown if there is an IO Exception</em>
<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @throws SQLException thrown if there is a SQL Exception</em>
<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown if there is an error initializing a new</em>
<a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * database</em>
<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * @throws ClassNotFoundException thrown if the h2 database driver cannot be</em>
<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * loaded</em>
<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="78" href="#78">78</a> @edu.umd.cs.findbugs.annotations.SuppressWarnings(
<a class="jxr_linenumber" name="79" href="#79">79</a> value = <span class="jxr_string">"DMI_EMPTY_DB_PASSWORD"</span>,
<a class="jxr_linenumber" name="80" href="#80">80</a> justification = <span class="jxr_string">"Yes, I know... Blank password."</span>)
<a class="jxr_linenumber" name="81" href="#81">81</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> open() <strong class="jxr_keyword">throws</strong> IOException, SQLException, DatabaseException, ClassNotFoundException {
<a class="jxr_linenumber" name="82" href="#82">82</a> <strong class="jxr_keyword">final</strong> String fileName = CveDB.getDataDirectory().getCanonicalPath();
<a class="jxr_linenumber" name="83" href="#83">83</a> <strong class="jxr_keyword">final</strong> File f = <strong class="jxr_keyword">new</strong> File(fileName, <span class="jxr_string">"cve."</span> + DB_SCHEMA_VERSION);
<a class="jxr_linenumber" name="84" href="#84">84</a> <strong class="jxr_keyword">final</strong> File check = <strong class="jxr_keyword">new</strong> File(f.getAbsolutePath() + <span class="jxr_string">".h2.db"</span>);
<a class="jxr_linenumber" name="85" href="#85">85</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> createTables = !check.exists();
<a class="jxr_linenumber" name="86" href="#86">86</a> <strong class="jxr_keyword">final</strong> String connStr = String.format(<span class="jxr_string">"jdbc:h2:file:%s;AUTO_SERVER=TRUE"</span>, f.getAbsolutePath());
<a class="jxr_linenumber" name="87" href="#87">87</a> Class.forName(<span class="jxr_string">"org.h2.Driver"</span>);
<a class="jxr_linenumber" name="88" href="#88">88</a> conn = DriverManager.getConnection(connStr, <span class="jxr_string">"sa"</span>, <span class="jxr_string">""</span>);
<a class="jxr_linenumber" name="89" href="#89">89</a> <strong class="jxr_keyword">if</strong> (createTables) {
<a class="jxr_linenumber" name="90" href="#90">90</a> createTables();
<a class="jxr_linenumber" name="91" href="#91">91</a> }
<a class="jxr_linenumber" name="92" href="#92">92</a> }
<a class="jxr_linenumber" name="93" href="#93">93</a>
<a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * Closes the DB4O database. Close should be called on this object when it</em>
<a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * is done being used.</em>
<a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="98" href="#98">98</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> close() {
<a class="jxr_linenumber" name="99" href="#99">99</a> <strong class="jxr_keyword">if</strong> (conn != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="100" href="#100">100</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="101" href="#101">101</a> conn.close();
<a class="jxr_linenumber" name="102" href="#102">102</a> } <strong class="jxr_keyword">catch</strong> (SQLException ex) {
<a class="jxr_linenumber" name="103" href="#103">103</a> <strong class="jxr_keyword">final</strong> String msg = <span class="jxr_string">"There was an error attempting to close the CveDB, see the log for more details."</span>;
<a class="jxr_linenumber" name="104" href="#104">104</a> Logger.getLogger(BaseDB.<strong class="jxr_keyword">class</strong>.getName()).log(Level.SEVERE, msg, ex);
<a class="jxr_linenumber" name="105" href="#105">105</a> Logger.getLogger(BaseDB.<strong class="jxr_keyword">class</strong>.getName()).log(Level.FINE, <strong class="jxr_keyword">null</strong>, ex);
<a class="jxr_linenumber" name="106" href="#106">106</a> }
<a class="jxr_linenumber" name="107" href="#107">107</a> conn = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="108" href="#108">108</a> }
<a class="jxr_linenumber" name="109" href="#109">109</a> }
<a class="jxr_linenumber" name="110" href="#110">110</a>
<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * Commits all completed transactions.</em>
<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * @throws SQLException thrown if a SQL Exception occurs</em>
<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="116" href="#116">116</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> commit() <strong class="jxr_keyword">throws</strong> SQLException {
<a class="jxr_linenumber" name="117" href="#117">117</a> <strong class="jxr_keyword">if</strong> (conn != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="118" href="#118">118</a> conn.commit();
<a class="jxr_linenumber" name="119" href="#119">119</a> }
<a class="jxr_linenumber" name="120" href="#120">120</a> }
<a class="jxr_linenumber" name="121" href="#121">121</a>
<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * Cleans up the object and ensures that "close" has been called.</em>
<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * @throws Throwable thrown if there is a problem</em>
<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="127" href="#127">127</a> @Override
<a class="jxr_linenumber" name="128" href="#128">128</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> finalize() <strong class="jxr_keyword">throws</strong> Throwable {
<a class="jxr_linenumber" name="129" href="#129">129</a> close();
<a class="jxr_linenumber" name="130" href="#130">130</a> <strong class="jxr_keyword">super</strong>.finalize(); <em class="jxr_comment">//not necessary if extending Object.</em>
<a class="jxr_linenumber" name="131" href="#131">131</a> }
<a class="jxr_linenumber" name="132" href="#132">132</a>
<a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * Creates the database structure (tables and indexes) to store the CVE data</em>
<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * @throws SQLException thrown if there is a sql exception</em>
<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown if there is a database exception</em>
<a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="139" href="#139">139</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> createTables() <strong class="jxr_keyword">throws</strong> SQLException, DatabaseException {
<a class="jxr_linenumber" name="140" href="#140">140</a> InputStream is;
<a class="jxr_linenumber" name="141" href="#141">141</a> InputStreamReader reader;
<a class="jxr_linenumber" name="142" href="#142">142</a> BufferedReader in = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="143" href="#143">143</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="144" href="#144">144</a> is = <strong class="jxr_keyword">this</strong>.getClass().getClassLoader().getResourceAsStream(DB_STRUCTURE_RESOURCE);
<a class="jxr_linenumber" name="145" href="#145">145</a> reader = <strong class="jxr_keyword">new</strong> InputStreamReader(is, <span class="jxr_string">"UTF-8"</span>);
<a class="jxr_linenumber" name="146" href="#146">146</a> in = <strong class="jxr_keyword">new</strong> BufferedReader(reader);
<a class="jxr_linenumber" name="147" href="#147">147</a> <strong class="jxr_keyword">final</strong> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(2110);
<a class="jxr_linenumber" name="148" href="#148">148</a> String tmp;
<a class="jxr_linenumber" name="149" href="#149">149</a> <strong class="jxr_keyword">while</strong> ((tmp = in.readLine()) != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="150" href="#150">150</a> sb.append(tmp);
<a class="jxr_linenumber" name="151" href="#151">151</a> }
<a class="jxr_linenumber" name="152" href="#152">152</a> Statement statement = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="153" href="#153">153</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="154" href="#154">154</a> statement = conn.createStatement();
<a class="jxr_linenumber" name="155" href="#155">155</a> statement.execute(sb.toString());
<a class="jxr_linenumber" name="156" href="#156">156</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="157" href="#157">157</a> closeStatement(statement);
<a class="jxr_linenumber" name="158" href="#158">158</a> }
<a class="jxr_linenumber" name="159" href="#159">159</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="160" href="#160">160</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/data/nvdcve/DatabaseException.html">DatabaseException</a>(<span class="jxr_string">"Unable to create database schema"</span>, ex);
<a class="jxr_linenumber" name="161" href="#161">161</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="162" href="#162">162</a> <strong class="jxr_keyword">if</strong> (in != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="163" href="#163">163</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="164" href="#164">164</a> in.close();
<a class="jxr_linenumber" name="165" href="#165">165</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="166" href="#166">166</a> Logger.getLogger(CveDB.<strong class="jxr_keyword">class</strong>
<a class="jxr_linenumber" name="167" href="#167">167</a> .getName()).log(Level.FINEST, <strong class="jxr_keyword">null</strong>, ex);
<a class="jxr_linenumber" name="168" href="#168">168</a> }
<a class="jxr_linenumber" name="169" href="#169">169</a> }
<a class="jxr_linenumber" name="170" href="#170">170</a> }
<a class="jxr_linenumber" name="171" href="#171">171</a> }
<a class="jxr_linenumber" name="172" href="#172">172</a>
<a class="jxr_linenumber" name="173" href="#173">173</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * Retrieves the directory that the JAR file exists in so that we can ensure</em>
<a class="jxr_linenumber" name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * we always use a common data directory.</em>
<a class="jxr_linenumber" name="176" href="#176">176</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="177" href="#177">177</a> <em class="jxr_javadoccomment"> * @return the data directory for this index.</em>
<a class="jxr_linenumber" name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * @throws IOException is thrown if an IOException occurs of course...</em>
<a class="jxr_linenumber" name="179" href="#179">179</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="180" href="#180">180</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> File getDataDirectory() <strong class="jxr_keyword">throws</strong> IOException {
<a class="jxr_linenumber" name="181" href="#181">181</a> <strong class="jxr_keyword">final</strong> File path = Settings.getDataFile(Settings.KEYS.CVE_DATA_DIRECTORY);
<a class="jxr_linenumber" name="182" href="#182">182</a> <strong class="jxr_keyword">if</strong> (!path.exists()) {
<a class="jxr_linenumber" name="183" href="#183">183</a> <strong class="jxr_keyword">if</strong> (!path.mkdirs()) {
<a class="jxr_linenumber" name="184" href="#184">184</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(<span class="jxr_string">"Unable to create NVD CVE Data directory"</span>);
<a class="jxr_linenumber" name="185" href="#185">185</a> }
<a class="jxr_linenumber" name="186" href="#186">186</a> }
<a class="jxr_linenumber" name="187" href="#187">187</a> <strong class="jxr_keyword">return</strong> path;
<a class="jxr_linenumber" name="188" href="#188">188</a> }
<a class="jxr_linenumber" name="189" href="#189">189</a>
<a class="jxr_linenumber" name="190" href="#190">190</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * Returns the generated integer primary key for a newly inserted row.</em>
<a class="jxr_linenumber" name="192" href="#192">192</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * @param statement a prepared statement that just executed an insert</em>
<a class="jxr_linenumber" name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * @return a primary key</em>
<a class="jxr_linenumber" name="195" href="#195">195</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown if there is an exception obtaining the</em>
<a class="jxr_linenumber" name="196" href="#196">196</a> <em class="jxr_javadoccomment"> * key</em>
<a class="jxr_linenumber" name="197" href="#197">197</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="198" href="#198">198</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">int</strong> getGeneratedKey(PreparedStatement statement) <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="199" href="#199">199</a> ResultSet rs = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="200" href="#200">200</a> <strong class="jxr_keyword">int</strong> id = 0;
<a class="jxr_linenumber" name="201" href="#201">201</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="202" href="#202">202</a> rs = statement.getGeneratedKeys();
<a class="jxr_linenumber" name="203" href="#203">203</a> rs.next();
<a class="jxr_linenumber" name="204" href="#204">204</a> id = rs.getInt(1);
<a class="jxr_linenumber" name="205" href="#205">205</a> } <strong class="jxr_keyword">catch</strong> (SQLException ex) {
<a class="jxr_linenumber" name="206" href="#206">206</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/data/nvdcve/DatabaseException.html">DatabaseException</a>(<span class="jxr_string">"Unable to get primary key for inserted row"</span>);
<a class="jxr_linenumber" name="207" href="#207">207</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="208" href="#208">208</a> closeResultSet(rs);
<a class="jxr_linenumber" name="209" href="#209">209</a> }
<a class="jxr_linenumber" name="210" href="#210">210</a> <strong class="jxr_keyword">return</strong> id;
<a class="jxr_linenumber" name="211" href="#211">211</a> }
<a class="jxr_linenumber" name="212" href="#212">212</a>
<a class="jxr_linenumber" name="213" href="#213">213</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * Closes the given statement object ignoring any exceptions that occur.</em>
<a class="jxr_linenumber" name="215" href="#215">215</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * @param statement a Statement object</em>
<a class="jxr_linenumber" name="217" href="#217">217</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="218" href="#218">218</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> closeStatement(Statement statement) {
<a class="jxr_linenumber" name="219" href="#219">219</a> <strong class="jxr_keyword">if</strong> (statement != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="220" href="#220">220</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="221" href="#221">221</a> statement.close();
<a class="jxr_linenumber" name="222" href="#222">222</a> } <strong class="jxr_keyword">catch</strong> (SQLException ex) {
<a class="jxr_linenumber" name="223" href="#223">223</a> Logger.getLogger(CveDB.<strong class="jxr_keyword">class</strong>
<a class="jxr_linenumber" name="224" href="#224">224</a> .getName()).log(Level.FINEST, statement.toString(), ex);
<a class="jxr_linenumber" name="225" href="#225">225</a> }
<a class="jxr_linenumber" name="226" href="#226">226</a> }
<a class="jxr_linenumber" name="227" href="#227">227</a> }
<a class="jxr_linenumber" name="228" href="#228">228</a>
<a class="jxr_linenumber" name="229" href="#229">229</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * Closes the result set capturing and ignoring any SQLExceptions that</em>
<a class="jxr_linenumber" name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * occur.</em>
<a class="jxr_linenumber" name="232" href="#232">232</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * @param rs a ResultSet to close</em>
<a class="jxr_linenumber" name="234" href="#234">234</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="235" href="#235">235</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> closeResultSet(ResultSet rs) {
<a class="jxr_linenumber" name="236" href="#236">236</a> <strong class="jxr_keyword">if</strong> (rs != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="237" href="#237">237</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="238" href="#238">238</a> rs.close();
<a class="jxr_linenumber" name="239" href="#239">239</a> } <strong class="jxr_keyword">catch</strong> (SQLException ex) {
<a class="jxr_linenumber" name="240" href="#240">240</a> Logger.getLogger(CveDB.<strong class="jxr_keyword">class</strong>
<a class="jxr_linenumber" name="241" href="#241">241</a> .getName()).log(Level.FINEST, rs.toString(), ex);
<a class="jxr_linenumber" name="242" href="#242">242</a> }
<a class="jxr_linenumber" name="243" href="#243">243</a> }
<a class="jxr_linenumber" name="244" href="#244">244</a> }
<a class="jxr_linenumber" name="245" href="#245">245</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

342
dependency-check-core/xref/org/owasp/dependencycheck/data/cpe/CpeMemoryIndex.html Normal file
View File

@@ -0,0 +1,342 @@
<!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>CpeMemoryIndex xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/owasp/dependencycheck/data/cpe/CpeMemoryIndex.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * This file is part of dependency-check-core.</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Dependency-check-core is free software: you can redistribute it and/or modify it</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * under the terms of the GNU General Public License as published by the Free</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * Software Foundation, either version 3 of the License, or (at your option) any</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * later version.</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * Dependency-check-core is distributed in the hope that it will be useful, but</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * details.</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * You should have received a copy of the GNU General Public License along with</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * dependency-check-core. If not, see <a href="http://www.gnu.org/licenses/." target="alexandria_uri">http://www.gnu.org/licenses/.</a></em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * Copyright (c) 2013 Jeremy Long. All Rights Reserved.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.data.cpe;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.sql.ResultSet;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.sql.SQLException;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.logging.Level;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.logging.Logger;
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.analysis.Analyzer;
<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.analysis.core.KeywordAnalyzer;
<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.analysis.miscellaneous.PerFieldAnalyzerWrapper;
<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.document.Document;
<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.document.Field;
<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.document.TextField;
<a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.index.CorruptIndexException;
<a class="jxr_linenumber" name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.index.DirectoryReader;
<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.index.IndexReader;
<a class="jxr_linenumber" name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.index.IndexWriter;
<a class="jxr_linenumber" name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.index.IndexWriterConfig;
<a class="jxr_linenumber" name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.queryparser.classic.ParseException;
<a class="jxr_linenumber" name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.queryparser.classic.QueryParser;
<a class="jxr_linenumber" name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.search.IndexSearcher;
<a class="jxr_linenumber" name="42" href="#42">42</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.search.Query;
<a class="jxr_linenumber" name="43" href="#43">43</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.search.TopDocs;
<a class="jxr_linenumber" name="44" href="#44">44</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.lucene.FieldAnalyzer;
<a class="jxr_linenumber" name="45" href="#45">45</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.CveDB;
<a class="jxr_linenumber" name="46" href="#46">46</a> <strong class="jxr_keyword">import</strong> org.apache.lucene.store.RAMDirectory;
<a class="jxr_linenumber" name="47" href="#47">47</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.lucene.LuceneUtils;
<a class="jxr_linenumber" name="48" href="#48">48</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.lucene.SearchFieldAnalyzer;
<a class="jxr_linenumber" name="49" href="#49">49</a>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * An in memory lucene index that contains the vendor/product combinations from</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * the CPE (application) identifiers within the NVD CVE data.</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @author Jeremy Long (jeremy.long@owasp.org)</em>
<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="56" href="#56">56</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/CpeMemoryIndex.html">CpeMemoryIndex</a> {
<a class="jxr_linenumber" name="57" href="#57">57</a>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * singleton instance.</em>
<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="61" href="#61">61</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/CpeMemoryIndex.html">CpeMemoryIndex</a> instance = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/CpeMemoryIndex.html">CpeMemoryIndex</a>();
<a class="jxr_linenumber" name="62" href="#62">62</a>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * private constructor for singleton.</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="66" href="#66">66</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/CpeMemoryIndex.html">CpeMemoryIndex</a>() {
<a class="jxr_linenumber" name="67" href="#67">67</a> }
<a class="jxr_linenumber" name="68" href="#68">68</a>
<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * Gets the singleton instance of the CpeMemoryIndex.</em>
<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @return the instance of the CpeMemoryIndex</em>
<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="74" href="#74">74</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/CpeMemoryIndex.html">CpeMemoryIndex</a> getInstance() {
<a class="jxr_linenumber" name="75" href="#75">75</a> <strong class="jxr_keyword">return</strong> instance;
<a class="jxr_linenumber" name="76" href="#76">76</a> }
<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * The in memory Lucene index.</em>
<a class="jxr_linenumber" name="79" href="#79">79</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="80" href="#80">80</a> <strong class="jxr_keyword">private</strong> RAMDirectory index;
<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * The Lucene IndexReader.</em>
<a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="84" href="#84">84</a> <strong class="jxr_keyword">private</strong> IndexReader indexReader;
<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * The Lucene IndexSearcher.</em>
<a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="88" href="#88">88</a> <strong class="jxr_keyword">private</strong> IndexSearcher indexSearcher;
<a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * The Lucene Analyzer used for Searching.</em>
<a class="jxr_linenumber" name="91" href="#91">91</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">private</strong> Analyzer searchingAnalyzer;
<a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * The Lucene QueryParser used for Searching.</em>
<a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="96" href="#96">96</a> <strong class="jxr_keyword">private</strong> QueryParser queryParser;
<a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * The search field analyzer for the product field.</em>
<a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="100" href="#100">100</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/SearchFieldAnalyzer.html">SearchFieldAnalyzer</a> productSearchFieldAnalyzer;
<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * The search field analyzer for the vendor field.</em>
<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="104" href="#104">104</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/SearchFieldAnalyzer.html">SearchFieldAnalyzer</a> vendorSearchFieldAnalyzer;
<a class="jxr_linenumber" name="105" href="#105">105</a>
<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * Creates and loads data into an in memory index.</em>
<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * @param cve the data source to retrieve the cpe data</em>
<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * @throws IndexException thrown if there is an error creating the index</em>
<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="112" href="#112">112</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> open(<a href="../../../../../org/owasp/dependencycheck/data/nvdcve/CveDB.html">CveDB</a> cve) <strong class="jxr_keyword">throws</strong> IndexException {
<a class="jxr_linenumber" name="113" href="#113">113</a> <strong class="jxr_keyword">if</strong> (!openState) {
<a class="jxr_linenumber" name="114" href="#114">114</a> index = <strong class="jxr_keyword">new</strong> RAMDirectory();
<a class="jxr_linenumber" name="115" href="#115">115</a> buildIndex(cve);
<a class="jxr_linenumber" name="116" href="#116">116</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="117" href="#117">117</a> indexReader = DirectoryReader.open(index);
<a class="jxr_linenumber" name="118" href="#118">118</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="119" href="#119">119</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(ex);
<a class="jxr_linenumber" name="120" href="#120">120</a> }
<a class="jxr_linenumber" name="121" href="#121">121</a> indexSearcher = <strong class="jxr_keyword">new</strong> IndexSearcher(indexReader);
<a class="jxr_linenumber" name="122" href="#122">122</a> searchingAnalyzer = createSearchingAnalyzer();
<a class="jxr_linenumber" name="123" href="#123">123</a> queryParser = <strong class="jxr_keyword">new</strong> QueryParser(LuceneUtils.CURRENT_VERSION, Fields.DOCUMENT_KEY, searchingAnalyzer);
<a class="jxr_linenumber" name="124" href="#124">124</a> openState = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="125" href="#125">125</a> }
<a class="jxr_linenumber" name="126" href="#126">126</a> }
<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * A flag indicating whether or not the index is open.</em>
<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="130" href="#130">130</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> openState = false;
<a class="jxr_linenumber" name="131" href="#131">131</a>
<a class="jxr_linenumber" name="132" href="#132">132</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * returns whether or not the index is open.</em>
<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * @return whether or not the index is open</em>
<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="137" href="#137">137</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isOpen() {
<a class="jxr_linenumber" name="138" href="#138">138</a> <strong class="jxr_keyword">return</strong> openState;
<a class="jxr_linenumber" name="139" href="#139">139</a> }
<a class="jxr_linenumber" name="140" href="#140">140</a>
<a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * Creates the indexing analyzer for the CPE Index.</em>
<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * @return the CPE Analyzer.</em>
<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="146" href="#146">146</a> @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a class="jxr_linenumber" name="147" href="#147">147</a> <strong class="jxr_keyword">private</strong> Analyzer createIndexingAnalyzer() {
<a class="jxr_linenumber" name="148" href="#148">148</a> <strong class="jxr_keyword">final</strong> Map fieldAnalyzers = <strong class="jxr_keyword">new</strong> HashMap();
<a class="jxr_linenumber" name="149" href="#149">149</a> fieldAnalyzers.put(Fields.DOCUMENT_KEY, <strong class="jxr_keyword">new</strong> KeywordAnalyzer());
<a class="jxr_linenumber" name="150" href="#150">150</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> PerFieldAnalyzerWrapper(<strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/FieldAnalyzer.html">FieldAnalyzer</a>(LuceneUtils.CURRENT_VERSION), fieldAnalyzers);
<a class="jxr_linenumber" name="151" href="#151">151</a> }
<a class="jxr_linenumber" name="152" href="#152">152</a>
<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * Creates an Analyzer for searching the CPE Index.</em>
<a class="jxr_linenumber" name="155" href="#155">155</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * @return the CPE Analyzer.</em>
<a class="jxr_linenumber" name="157" href="#157">157</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="158" href="#158">158</a> @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a class="jxr_linenumber" name="159" href="#159">159</a> <strong class="jxr_keyword">private</strong> Analyzer createSearchingAnalyzer() {
<a class="jxr_linenumber" name="160" href="#160">160</a> <strong class="jxr_keyword">final</strong> Map fieldAnalyzers = <strong class="jxr_keyword">new</strong> HashMap();
<a class="jxr_linenumber" name="161" href="#161">161</a> fieldAnalyzers.put(Fields.DOCUMENT_KEY, <strong class="jxr_keyword">new</strong> KeywordAnalyzer());
<a class="jxr_linenumber" name="162" href="#162">162</a> productSearchFieldAnalyzer = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/SearchFieldAnalyzer.html">SearchFieldAnalyzer</a>(LuceneUtils.CURRENT_VERSION);
<a class="jxr_linenumber" name="163" href="#163">163</a> vendorSearchFieldAnalyzer = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/SearchFieldAnalyzer.html">SearchFieldAnalyzer</a>(LuceneUtils.CURRENT_VERSION);
<a class="jxr_linenumber" name="164" href="#164">164</a> fieldAnalyzers.put(Fields.PRODUCT, productSearchFieldAnalyzer);
<a class="jxr_linenumber" name="165" href="#165">165</a> fieldAnalyzers.put(Fields.VENDOR, vendorSearchFieldAnalyzer);
<a class="jxr_linenumber" name="166" href="#166">166</a>
<a class="jxr_linenumber" name="167" href="#167">167</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> PerFieldAnalyzerWrapper(<strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/FieldAnalyzer.html">FieldAnalyzer</a>(LuceneUtils.CURRENT_VERSION), fieldAnalyzers);
<a class="jxr_linenumber" name="168" href="#168">168</a> }
<a class="jxr_linenumber" name="169" href="#169">169</a>
<a class="jxr_linenumber" name="170" href="#170">170</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * Saves a CPE IndexEntry into the Lucene index.</em>
<a class="jxr_linenumber" name="172" href="#172">172</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="173" href="#173">173</a> <em class="jxr_javadoccomment"> * @param vendor the vendor to index</em>
<a class="jxr_linenumber" name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * @param product the product to index</em>
<a class="jxr_linenumber" name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * @param indexWriter the index writer to write the entry into</em>
<a class="jxr_linenumber" name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * @throws CorruptIndexException is thrown if the index is corrupt</em>
<a class="jxr_linenumber" name="177" href="#177">177</a> <em class="jxr_javadoccomment"> * @throws IOException is thrown if an IOException occurs</em>
<a class="jxr_linenumber" name="178" href="#178">178</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="179" href="#179">179</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> saveEntry(String vendor, String product, IndexWriter indexWriter) <strong class="jxr_keyword">throws</strong> CorruptIndexException, IOException {
<a class="jxr_linenumber" name="180" href="#180">180</a> <strong class="jxr_keyword">final</strong> Document doc = <strong class="jxr_keyword">new</strong> Document();
<a class="jxr_linenumber" name="181" href="#181">181</a> <strong class="jxr_keyword">final</strong> Field v = <strong class="jxr_keyword">new</strong> TextField(Fields.VENDOR, vendor, Field.Store.YES);
<a class="jxr_linenumber" name="182" href="#182">182</a> <strong class="jxr_keyword">final</strong> Field p = <strong class="jxr_keyword">new</strong> TextField(Fields.PRODUCT, product, Field.Store.YES);
<a class="jxr_linenumber" name="183" href="#183">183</a> doc.add(v);
<a class="jxr_linenumber" name="184" href="#184">184</a> doc.add(p);
<a class="jxr_linenumber" name="185" href="#185">185</a> indexWriter.addDocument(doc);
<a class="jxr_linenumber" name="186" href="#186">186</a> }
<a class="jxr_linenumber" name="187" href="#187">187</a>
<a class="jxr_linenumber" name="188" href="#188">188</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * Closes the CPE Index.</em>
<a class="jxr_linenumber" name="190" href="#190">190</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="191" href="#191">191</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> close() {
<a class="jxr_linenumber" name="192" href="#192">192</a> <strong class="jxr_keyword">if</strong> (searchingAnalyzer != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="193" href="#193">193</a> searchingAnalyzer.close();
<a class="jxr_linenumber" name="194" href="#194">194</a> searchingAnalyzer = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="195" href="#195">195</a> }
<a class="jxr_linenumber" name="196" href="#196">196</a> <strong class="jxr_keyword">if</strong> (indexReader != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="197" href="#197">197</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="198" href="#198">198</a> indexReader.close();
<a class="jxr_linenumber" name="199" href="#199">199</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="200" href="#200">200</a> Logger.getLogger(CpeMemoryIndex.<strong class="jxr_keyword">class</strong>.getName()).log(Level.FINEST, <strong class="jxr_keyword">null</strong>, ex);
<a class="jxr_linenumber" name="201" href="#201">201</a> }
<a class="jxr_linenumber" name="202" href="#202">202</a> indexReader = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="203" href="#203">203</a> }
<a class="jxr_linenumber" name="204" href="#204">204</a> queryParser = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="205" href="#205">205</a> indexSearcher = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="206" href="#206">206</a> <strong class="jxr_keyword">if</strong> (index != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="207" href="#207">207</a> index.close();
<a class="jxr_linenumber" name="208" href="#208">208</a> index = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="209" href="#209">209</a> }
<a class="jxr_linenumber" name="210" href="#210">210</a> openState = false;
<a class="jxr_linenumber" name="211" href="#211">211</a> }
<a class="jxr_linenumber" name="212" href="#212">212</a>
<a class="jxr_linenumber" name="213" href="#213">213</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * Builds the lucene index based off of the data within the CveDB.</em>
<a class="jxr_linenumber" name="215" href="#215">215</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * @param cve the data base containing the CPE data</em>
<a class="jxr_linenumber" name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * @throws IndexException thrown if there is an issue creating the index</em>
<a class="jxr_linenumber" name="218" href="#218">218</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="219" href="#219">219</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> buildIndex(<a href="../../../../../org/owasp/dependencycheck/data/nvdcve/CveDB.html">CveDB</a> cve) <strong class="jxr_keyword">throws</strong> IndexException {
<a class="jxr_linenumber" name="220" href="#220">220</a> Analyzer analyzer = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="221" href="#221">221</a> IndexWriter indexWriter = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="222" href="#222">222</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="223" href="#223">223</a> analyzer = createIndexingAnalyzer();
<a class="jxr_linenumber" name="224" href="#224">224</a> <strong class="jxr_keyword">final</strong> IndexWriterConfig conf = <strong class="jxr_keyword">new</strong> IndexWriterConfig(LuceneUtils.CURRENT_VERSION, analyzer);
<a class="jxr_linenumber" name="225" href="#225">225</a> indexWriter = <strong class="jxr_keyword">new</strong> IndexWriter(index, conf);
<a class="jxr_linenumber" name="226" href="#226">226</a> <strong class="jxr_keyword">final</strong> ResultSet rs = cve.getVendorProductList();
<a class="jxr_linenumber" name="227" href="#227">227</a> <strong class="jxr_keyword">if</strong> (rs == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="228" href="#228">228</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(<span class="jxr_string">"No data exists"</span>);
<a class="jxr_linenumber" name="229" href="#229">229</a> }
<a class="jxr_linenumber" name="230" href="#230">230</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="231" href="#231">231</a> <strong class="jxr_keyword">while</strong> (rs.next()) {
<a class="jxr_linenumber" name="232" href="#232">232</a> saveEntry(rs.getString(1), rs.getString(2), indexWriter);
<a class="jxr_linenumber" name="233" href="#233">233</a> }
<a class="jxr_linenumber" name="234" href="#234">234</a> } <strong class="jxr_keyword">catch</strong> (SQLException ex) {
<a class="jxr_linenumber" name="235" href="#235">235</a> Logger.getLogger(CpeMemoryIndex.<strong class="jxr_keyword">class</strong>.getName()).log(Level.FINE, <strong class="jxr_keyword">null</strong>, ex);
<a class="jxr_linenumber" name="236" href="#236">236</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(<span class="jxr_string">"Error reading CPE data"</span>, ex);
<a class="jxr_linenumber" name="237" href="#237">237</a> }
<a class="jxr_linenumber" name="238" href="#238">238</a> } <strong class="jxr_keyword">catch</strong> (CorruptIndexException ex) {
<a class="jxr_linenumber" name="239" href="#239">239</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(<span class="jxr_string">"Unable to close an in-memory index"</span>, ex);
<a class="jxr_linenumber" name="240" href="#240">240</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="241" href="#241">241</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(<span class="jxr_string">"Unable to close an in-memory index"</span>, ex);
<a class="jxr_linenumber" name="242" href="#242">242</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="243" href="#243">243</a> <strong class="jxr_keyword">if</strong> (indexWriter != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="244" href="#244">244</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="245" href="#245">245</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="246" href="#246">246</a> indexWriter.commit();
<a class="jxr_linenumber" name="247" href="#247">247</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="248" href="#248">248</a> indexWriter.close(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="249" href="#249">249</a> }
<a class="jxr_linenumber" name="250" href="#250">250</a> } <strong class="jxr_keyword">catch</strong> (CorruptIndexException ex) {
<a class="jxr_linenumber" name="251" href="#251">251</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(<span class="jxr_string">"Unable to close an in-memory index"</span>, ex);
<a class="jxr_linenumber" name="252" href="#252">252</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="253" href="#253">253</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(<span class="jxr_string">"Unable to close an in-memory index"</span>, ex);
<a class="jxr_linenumber" name="254" href="#254">254</a> }
<a class="jxr_linenumber" name="255" href="#255">255</a> <strong class="jxr_keyword">if</strong> (analyzer != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="256" href="#256">256</a> analyzer.close();
<a class="jxr_linenumber" name="257" href="#257">257</a> }
<a class="jxr_linenumber" name="258" href="#258">258</a> }
<a class="jxr_linenumber" name="259" href="#259">259</a> }
<a class="jxr_linenumber" name="260" href="#260">260</a> }
<a class="jxr_linenumber" name="261" href="#261">261</a>
<a class="jxr_linenumber" name="262" href="#262">262</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * Resets the searching analyzers</em>
<a class="jxr_linenumber" name="264" href="#264">264</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="265" href="#265">265</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> resetSearchingAnalyzer() {
<a class="jxr_linenumber" name="266" href="#266">266</a> <strong class="jxr_keyword">if</strong> (productSearchFieldAnalyzer != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="267" href="#267">267</a> productSearchFieldAnalyzer.clear();
<a class="jxr_linenumber" name="268" href="#268">268</a> }
<a class="jxr_linenumber" name="269" href="#269">269</a> <strong class="jxr_keyword">if</strong> (vendorSearchFieldAnalyzer != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="270" href="#270">270</a> vendorSearchFieldAnalyzer.clear();
<a class="jxr_linenumber" name="271" href="#271">271</a> }
<a class="jxr_linenumber" name="272" href="#272">272</a> }
<a class="jxr_linenumber" name="273" href="#273">273</a>
<a class="jxr_linenumber" name="274" href="#274">274</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="275" href="#275">275</a> <em class="jxr_javadoccomment"> * Searches the index using the given search string.</em>
<a class="jxr_linenumber" name="276" href="#276">276</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="277" href="#277">277</a> <em class="jxr_javadoccomment"> * @param searchString the query text</em>
<a class="jxr_linenumber" name="278" href="#278">278</a> <em class="jxr_javadoccomment"> * @param maxQueryResults the maximum number of documents to return</em>
<a class="jxr_linenumber" name="279" href="#279">279</a> <em class="jxr_javadoccomment"> * @return the TopDocs found by the search</em>
<a class="jxr_linenumber" name="280" href="#280">280</a> <em class="jxr_javadoccomment"> * @throws ParseException thrown when the searchString is invalid</em>
<a class="jxr_linenumber" name="281" href="#281">281</a> <em class="jxr_javadoccomment"> * @throws IOException is thrown if there is an issue with the underlying</em>
<a class="jxr_linenumber" name="282" href="#282">282</a> <em class="jxr_javadoccomment"> * Index</em>
<a class="jxr_linenumber" name="283" href="#283">283</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="284" href="#284">284</a> <strong class="jxr_keyword">public</strong> TopDocs search(String searchString, <strong class="jxr_keyword">int</strong> maxQueryResults) <strong class="jxr_keyword">throws</strong> ParseException, IOException {
<a class="jxr_linenumber" name="285" href="#285">285</a> <strong class="jxr_keyword">if</strong> (searchString == <strong class="jxr_keyword">null</strong> || searchString.trim().isEmpty()) {
<a class="jxr_linenumber" name="286" href="#286">286</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ParseException(<span class="jxr_string">"Query is null or empty"</span>);
<a class="jxr_linenumber" name="287" href="#287">287</a> }
<a class="jxr_linenumber" name="288" href="#288">288</a> <strong class="jxr_keyword">final</strong> Query query = queryParser.parse(searchString);
<a class="jxr_linenumber" name="289" href="#289">289</a> <strong class="jxr_keyword">return</strong> indexSearcher.search(query, maxQueryResults);
<a class="jxr_linenumber" name="290" href="#290">290</a> }
<a class="jxr_linenumber" name="291" href="#291">291</a>
<a class="jxr_linenumber" name="292" href="#292">292</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="293" href="#293">293</a> <em class="jxr_javadoccomment"> * Searches the index using the given query.</em>
<a class="jxr_linenumber" name="294" href="#294">294</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * @param query the query used to search the index</em>
<a class="jxr_linenumber" name="296" href="#296">296</a> <em class="jxr_javadoccomment"> * @param maxQueryResults the max number of results to return</em>
<a class="jxr_linenumber" name="297" href="#297">297</a> <em class="jxr_javadoccomment"> * @return the TopDocs found be the query</em>
<a class="jxr_linenumber" name="298" href="#298">298</a> <em class="jxr_javadoccomment"> * @throws CorruptIndexException thrown if the Index is corrupt</em>
<a class="jxr_linenumber" name="299" href="#299">299</a> <em class="jxr_javadoccomment"> * @throws IOException thrown if there is an IOException</em>
<a class="jxr_linenumber" name="300" href="#300">300</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="301" href="#301">301</a> <strong class="jxr_keyword">public</strong> TopDocs search(Query query, <strong class="jxr_keyword">int</strong> maxQueryResults) <strong class="jxr_keyword">throws</strong> CorruptIndexException, IOException {
<a class="jxr_linenumber" name="302" href="#302">302</a> resetSearchingAnalyzer();
<a class="jxr_linenumber" name="303" href="#303">303</a> <strong class="jxr_keyword">return</strong> indexSearcher.search(query, maxQueryResults);
<a class="jxr_linenumber" name="304" href="#304">304</a> }
<a class="jxr_linenumber" name="305" href="#305">305</a>
<a class="jxr_linenumber" name="306" href="#306">306</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="307" href="#307">307</a> <em class="jxr_javadoccomment"> * Retrieves a document from the Index.</em>
<a class="jxr_linenumber" name="308" href="#308">308</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="309" href="#309">309</a> <em class="jxr_javadoccomment"> * @param documentId the id of the document to retrieve</em>
<a class="jxr_linenumber" name="310" href="#310">310</a> <em class="jxr_javadoccomment"> * @return the Document</em>
<a class="jxr_linenumber" name="311" href="#311">311</a> <em class="jxr_javadoccomment"> * @throws IOException thrown if there is an IOException</em>
<a class="jxr_linenumber" name="312" href="#312">312</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="313" href="#313">313</a> <strong class="jxr_keyword">public</strong> Document getDocument(<strong class="jxr_keyword">int</strong> documentId) <strong class="jxr_keyword">throws</strong> IOException {
<a class="jxr_linenumber" name="314" href="#314">314</a> <strong class="jxr_keyword">return</strong> indexSearcher.doc(documentId);
<a class="jxr_linenumber" name="315" href="#315">315</a> }
<a class="jxr_linenumber" name="316" href="#316">316</a>
<a class="jxr_linenumber" name="317" href="#317">317</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="318" href="#318">318</a> <em class="jxr_javadoccomment"> * Returns the number of CPE entries stored in the index.</em>
<a class="jxr_linenumber" name="319" href="#319">319</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="320" href="#320">320</a> <em class="jxr_javadoccomment"> * @return the number of CPE entries stored in the index</em>
<a class="jxr_linenumber" name="321" href="#321">321</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="322" href="#322">322</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> numDocs() {
<a class="jxr_linenumber" name="323" href="#323">323</a> <strong class="jxr_keyword">if</strong> (indexReader == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="324" href="#324">324</a> <strong class="jxr_keyword">return</strong> -1;
<a class="jxr_linenumber" name="325" href="#325">325</a> }
<a class="jxr_linenumber" name="326" href="#326">326</a> <strong class="jxr_keyword">return</strong> indexReader.numDocs();
<a class="jxr_linenumber" name="327" href="#327">327</a> }
<a class="jxr_linenumber" name="328" href="#328">328</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

81
dependency-check-core/xref/org/owasp/dependencycheck/data/cpe/IndexException.html Normal file
View File

@@ -0,0 +1,81 @@
<!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>IndexException xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/owasp/dependencycheck/data/cpe/IndexException.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * This file is part of dependency-check-core.</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Dependency-check-core is free software: you can redistribute it and/or modify it</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * under the terms of the GNU General Public License as published by the Free</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * Software Foundation, either version 3 of the License, or (at your option) any</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * later version.</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * Dependency-check-core is distributed in the hope that it will be useful, but</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * details.</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * You should have received a copy of the GNU General Public License along with</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * dependency-check-core. If not, see <a href="http://www.gnu.org/licenses/." target="alexandria_uri">http://www.gnu.org/licenses/.</a></em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * Copyright (c) 2012 Jeremy Long. All Rights Reserved.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.data.cpe;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * An exception thrown when the there is an issue using the in-memory CPE Index.</em>
<a class="jxr_linenumber" name="23" href="#23">23</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * @author Jeremy Long (jeremy.long@owasp.org)</em>
<a class="jxr_linenumber" name="25" href="#25">25</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a> <strong class="jxr_keyword">extends</strong> Exception {
<a class="jxr_linenumber" name="27" href="#27">27</a>
<a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * The serial version UID for serialization.</em>
<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 1L;
<a class="jxr_linenumber" name="32" href="#32">32</a>
<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * Creates a new IndexException.</em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>() {
<a class="jxr_linenumber" name="37" href="#37">37</a> <strong class="jxr_keyword">super</strong>();
<a class="jxr_linenumber" name="38" href="#38">38</a> }
<a class="jxr_linenumber" name="39" href="#39">39</a>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * Creates a new IndexException.</em>
<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @param msg a message for the exception.</em>
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(String msg) {
<a class="jxr_linenumber" name="46" href="#46">46</a> <strong class="jxr_keyword">super</strong>(msg);
<a class="jxr_linenumber" name="47" href="#47">47</a> }
<a class="jxr_linenumber" name="48" href="#48">48</a>
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * Creates a new IndexException.</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * @param ex the cause of the failure.</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="54" href="#54">54</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(Throwable ex) {
<a class="jxr_linenumber" name="55" href="#55">55</a> <strong class="jxr_keyword">super</strong>(ex);
<a class="jxr_linenumber" name="56" href="#56">56</a> }
<a class="jxr_linenumber" name="57" href="#57">57</a>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * Creates a new IndexException.</em>
<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @param msg a message for the exception.</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @param ex the cause of the failure.</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(String msg, Throwable ex) {
<a class="jxr_linenumber" name="65" href="#65">65</a> <strong class="jxr_keyword">super</strong>(msg, ex);
<a class="jxr_linenumber" name="66" href="#66">66</a> }
<a class="jxr_linenumber" name="67" href="#67">67</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

193
dependency-check-core/xref/org/owasp/dependencycheck/data/update/CallableDownloadTask.html Normal file
View File

@@ -0,0 +1,193 @@
<!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>CallableDownloadTask xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/owasp/dependencycheck/data/update/CallableDownloadTask.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * This file is part of dependency-check-core.</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Dependency-check-core is free software: you can redistribute it and/or modify it</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * under the terms of the GNU General Public License as published by the Free</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * Software Foundation, either version 3 of the License, or (at your option) any</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * later version.</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * Dependency-check-core is distributed in the hope that it will be useful, but</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * details.</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * You should have received a copy of the GNU General Public License along with</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * dependency-check-core. If not, see <a href="http://www.gnu.org/licenses/." target="alexandria_uri">http://www.gnu.org/licenses/.</a></em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * Copyright (c) 2013 Jeremy Long. All Rights Reserved.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.data.update;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.net.URL;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.Callable;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.logging.Level;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.logging.Logger;
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.DownloadFailedException;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Downloader;
<a class="jxr_linenumber" name="28" href="#28">28</a>
<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * A callable object to download two files.</em>
<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * @author Jeremy Long (jeremy.long@owasp.org)</em>
<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/owasp/dependencycheck/data/update/CallableDownloadTask.html">CallableDownloadTask</a> <strong class="jxr_keyword">implements</strong> Callable&lt;CallableDownloadTask&gt; {
<a class="jxr_linenumber" name="35" href="#35">35</a>
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * Simple constructor for the callable download task.</em>
<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @param nvdCveInfo the nvd cve info</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @param first the first file</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @param second the second file</em>
<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/owasp/dependencycheck/data/update/CallableDownloadTask.html">CallableDownloadTask</a>(<a href="../../../../../org/owasp/dependencycheck/data/update/NvdCveInfo.html">NvdCveInfo</a> nvdCveInfo, File first, File second) {
<a class="jxr_linenumber" name="44" href="#44">44</a> <strong class="jxr_keyword">this</strong>.nvdCveInfo = nvdCveInfo;
<a class="jxr_linenumber" name="45" href="#45">45</a> <strong class="jxr_keyword">this</strong>.first = first;
<a class="jxr_linenumber" name="46" href="#46">46</a> <strong class="jxr_keyword">this</strong>.second = second;
<a class="jxr_linenumber" name="47" href="#47">47</a> }
<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * The NVD CVE Meta Data.</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/owasp/dependencycheck/data/update/NvdCveInfo.html">NvdCveInfo</a> nvdCveInfo;
<a class="jxr_linenumber" name="52" href="#52">52</a>
<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * Get the value of nvdCveInfo.</em>
<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * @return the value of nvdCveInfo</em>
<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="58" href="#58">58</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/owasp/dependencycheck/data/update/NvdCveInfo.html">NvdCveInfo</a> getNvdCveInfo() {
<a class="jxr_linenumber" name="59" href="#59">59</a> <strong class="jxr_keyword">return</strong> nvdCveInfo;
<a class="jxr_linenumber" name="60" href="#60">60</a> }
<a class="jxr_linenumber" name="61" href="#61">61</a>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * Set the value of nvdCveInfo.</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * @param nvdCveInfo new value of nvdCveInfo</em>
<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="67" href="#67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setNvdCveInfo(<a href="../../../../../org/owasp/dependencycheck/data/update/NvdCveInfo.html">NvdCveInfo</a> nvdCveInfo) {
<a class="jxr_linenumber" name="68" href="#68">68</a> <strong class="jxr_keyword">this</strong>.nvdCveInfo = nvdCveInfo;
<a class="jxr_linenumber" name="69" href="#69">69</a> }
<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * a file.</em>
<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="73" href="#73">73</a> <strong class="jxr_keyword">private</strong> File first;
<a class="jxr_linenumber" name="74" href="#74">74</a>
<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * Get the value of first.</em>
<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * @return the value of first</em>
<a class="jxr_linenumber" name="79" href="#79">79</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="80" href="#80">80</a> <strong class="jxr_keyword">public</strong> File getFirst() {
<a class="jxr_linenumber" name="81" href="#81">81</a> <strong class="jxr_keyword">return</strong> first;
<a class="jxr_linenumber" name="82" href="#82">82</a> }
<a class="jxr_linenumber" name="83" href="#83">83</a>
<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * Set the value of first.</em>
<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * @param first new value of first</em>
<a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="89" href="#89">89</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFirst(File first) {
<a class="jxr_linenumber" name="90" href="#90">90</a> <strong class="jxr_keyword">this</strong>.first = first;
<a class="jxr_linenumber" name="91" href="#91">91</a> }
<a class="jxr_linenumber" name="92" href="#92">92</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * a file.</em>
<a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">private</strong> File second;
<a class="jxr_linenumber" name="96" href="#96">96</a>
<a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * Get the value of second.</em>
<a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * @return the value of second</em>
<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="102" href="#102">102</a> <strong class="jxr_keyword">public</strong> File getSecond() {
<a class="jxr_linenumber" name="103" href="#103">103</a> <strong class="jxr_keyword">return</strong> second;
<a class="jxr_linenumber" name="104" href="#104">104</a> }
<a class="jxr_linenumber" name="105" href="#105">105</a>
<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * Set the value of second.</em>
<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * @param second new value of second</em>
<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="111" href="#111">111</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSecond(File second) {
<a class="jxr_linenumber" name="112" href="#112">112</a> <strong class="jxr_keyword">this</strong>.second = second;
<a class="jxr_linenumber" name="113" href="#113">113</a> }
<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * A placeholder for an exception.</em>
<a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="117" href="#117">117</a> <strong class="jxr_keyword">private</strong> Exception exception = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="118" href="#118">118</a>
<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * Get the value of exception.</em>
<a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * @return the value of exception</em>
<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="124" href="#124">124</a> <strong class="jxr_keyword">public</strong> Exception getException() {
<a class="jxr_linenumber" name="125" href="#125">125</a> <strong class="jxr_keyword">return</strong> exception;
<a class="jxr_linenumber" name="126" href="#126">126</a> }
<a class="jxr_linenumber" name="127" href="#127">127</a>
<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * returns whether or not an exception occurred during download.</em>
<a class="jxr_linenumber" name="130" href="#130">130</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * @return whether or not an exception occurred during download</em>
<a class="jxr_linenumber" name="132" href="#132">132</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="133" href="#133">133</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasException() {
<a class="jxr_linenumber" name="134" href="#134">134</a> <strong class="jxr_keyword">return</strong> exception != <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="135" href="#135">135</a> }
<a class="jxr_linenumber" name="136" href="#136">136</a>
<a class="jxr_linenumber" name="137" href="#137">137</a> @Override
<a class="jxr_linenumber" name="138" href="#138">138</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/owasp/dependencycheck/data/update/CallableDownloadTask.html">CallableDownloadTask</a> call() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="139" href="#139">139</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="140" href="#140">140</a> <strong class="jxr_keyword">final</strong> URL url1 = <strong class="jxr_keyword">new</strong> URL(nvdCveInfo.getUrl());
<a class="jxr_linenumber" name="141" href="#141">141</a> <strong class="jxr_keyword">final</strong> URL url2 = <strong class="jxr_keyword">new</strong> URL(nvdCveInfo.getOldSchemaVersionUrl());
<a class="jxr_linenumber" name="142" href="#142">142</a> String msg = String.format(<span class="jxr_string">"Download Started for NVD CVE - %s"</span>, nvdCveInfo.getId());
<a class="jxr_linenumber" name="143" href="#143">143</a> Logger.getLogger(CallableDownloadTask.<strong class="jxr_keyword">class</strong>.getName()).log(Level.INFO, msg);
<a class="jxr_linenumber" name="144" href="#144">144</a> Downloader.fetchFile(url1, first);
<a class="jxr_linenumber" name="145" href="#145">145</a> Downloader.fetchFile(url2, second);
<a class="jxr_linenumber" name="146" href="#146">146</a> msg = String.format(<span class="jxr_string">"Download Complete for NVD CVE - %s"</span>, nvdCveInfo.getId());
<a class="jxr_linenumber" name="147" href="#147">147</a> Logger.getLogger(CallableDownloadTask.<strong class="jxr_keyword">class</strong>.getName()).log(Level.INFO, msg);
<a class="jxr_linenumber" name="148" href="#148">148</a> } <strong class="jxr_keyword">catch</strong> (DownloadFailedException ex) {
<a class="jxr_linenumber" name="149" href="#149">149</a> <strong class="jxr_keyword">this</strong>.exception = ex;
<a class="jxr_linenumber" name="150" href="#150">150</a> }
<a class="jxr_linenumber" name="151" href="#151">151</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="152" href="#152">152</a> }
<a class="jxr_linenumber" name="153" href="#153">153</a>
<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * Attempts to delete the files that were downloaded.</em>
<a class="jxr_linenumber" name="156" href="#156">156</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="157" href="#157">157</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> cleanup() {
<a class="jxr_linenumber" name="158" href="#158">158</a> <strong class="jxr_keyword">boolean</strong> deleted = false;
<a class="jxr_linenumber" name="159" href="#159">159</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="160" href="#160">160</a> <strong class="jxr_keyword">if</strong> (first != <strong class="jxr_keyword">null</strong> &amp;&amp; first.exists()) {
<a class="jxr_linenumber" name="161" href="#161">161</a> deleted = first.delete();
<a class="jxr_linenumber" name="162" href="#162">162</a> }
<a class="jxr_linenumber" name="163" href="#163">163</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="164" href="#164">164</a> <strong class="jxr_keyword">if</strong> (first != <strong class="jxr_keyword">null</strong> &amp;&amp; (first.exists() || !deleted)) {
<a class="jxr_linenumber" name="165" href="#165">165</a> first.deleteOnExit();
<a class="jxr_linenumber" name="166" href="#166">166</a> }
<a class="jxr_linenumber" name="167" href="#167">167</a> }
<a class="jxr_linenumber" name="168" href="#168">168</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="169" href="#169">169</a> deleted = false;
<a class="jxr_linenumber" name="170" href="#170">170</a> <strong class="jxr_keyword">if</strong> (second != <strong class="jxr_keyword">null</strong> &amp;&amp; second.exists()) {
<a class="jxr_linenumber" name="171" href="#171">171</a> deleted = second.delete();
<a class="jxr_linenumber" name="172" href="#172">172</a> }
<a class="jxr_linenumber" name="173" href="#173">173</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="174" href="#174">174</a> <strong class="jxr_keyword">if</strong> (second != <strong class="jxr_keyword">null</strong> &amp;&amp; (second.exists() || !deleted)) {
<a class="jxr_linenumber" name="175" href="#175">175</a> second.deleteOnExit();
<a class="jxr_linenumber" name="176" href="#176">176</a> }
<a class="jxr_linenumber" name="177" href="#177">177</a> }
<a class="jxr_linenumber" name="178" href="#178">178</a> }
<a class="jxr_linenumber" name="179" href="#179">179</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

200
dependency-check-core/xref/org/owasp/dependencycheck/suppression/PropertyType.html Normal file
View File

@@ -0,0 +1,200 @@
<!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>PropertyType xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/suppression/PropertyType.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * This file is part of dependency-check-core.</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Dependency-check-core is free software: you can redistribute it and/or modify it</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * under the terms of the GNU General Public License as published by the Free</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * Software Foundation, either version 3 of the License, or (at your option) any</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * later version.</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * Dependency-check-core is distributed in the hope that it will be useful, but</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * details.</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * You should have received a copy of the GNU General Public License along with</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * dependency-check-core. If not, see <a href="http://www.gnu.org/licenses/." target="alexandria_uri">http://www.gnu.org/licenses/.</a></em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * Copyright (c) 2013 Jeremy Long. All Rights Reserved.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.suppression;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.util.regex.Pattern;
<a class="jxr_linenumber" name="22" href="#22">22</a>
<a class="jxr_linenumber" name="23" href="#23">23</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * A simple PropertyType used to represent a string value that could be used as</em>
<a class="jxr_linenumber" name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * a regular expression or could be case insensitive. The equals method has been</em>
<a class="jxr_linenumber" name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * over-ridden so that the object will correctly compare to strings.</em>
<a class="jxr_linenumber" name="27" href="#27">27</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * @author Jeremy Long (jeremy.long@owasp.org)</em>
<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/suppression/PropertyType.html">PropertyType</a> {
<a class="jxr_linenumber" name="31" href="#31">31</a>
<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_comment">//&lt;editor-fold defaultstate="collapsed" desc="properties"&gt;</em>
<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * The value.</em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">private</strong> String value;
<a class="jxr_linenumber" name="37" href="#37">37</a>
<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * Gets the value of the value property.</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @return the value of the value property</em>
<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="44" href="#44">44</a> <strong class="jxr_keyword">public</strong> String getValue() {
<a class="jxr_linenumber" name="45" href="#45">45</a> <strong class="jxr_keyword">return</strong> value;
<a class="jxr_linenumber" name="46" href="#46">46</a> }
<a class="jxr_linenumber" name="47" href="#47">47</a>
<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Sets the value of the value property.</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * @param value the value of the value property</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setValue(String value) {
<a class="jxr_linenumber" name="54" href="#54">54</a> <strong class="jxr_keyword">this</strong>.value = value;
<a class="jxr_linenumber" name="55" href="#55">55</a> }
<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * Whether or not the expression is a regex.</em>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> regex = false;
<a class="jxr_linenumber" name="60" href="#60">60</a>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * Returns whether or not the value is a regex.</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @return true if the value is a regex, otherwise false</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="67" href="#67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isRegex() {
<a class="jxr_linenumber" name="68" href="#68">68</a> <strong class="jxr_keyword">return</strong> regex;
<a class="jxr_linenumber" name="69" href="#69">69</a> }
<a class="jxr_linenumber" name="70" href="#70">70</a>
<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * Sets whether the value property is a regex.</em>
<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @param value true if the value is a regex, otherwise false</em>
<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="77" href="#77">77</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRegex(<strong class="jxr_keyword">boolean</strong> value) {
<a class="jxr_linenumber" name="78" href="#78">78</a> <strong class="jxr_keyword">this</strong>.regex = value;
<a class="jxr_linenumber" name="79" href="#79">79</a> }
<a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * Indicates case sensitivity.</em>
<a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="83" href="#83">83</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> caseSensitive = false;
<a class="jxr_linenumber" name="84" href="#84">84</a>
<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * Gets the value of the caseSensitive property.</em>
<a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @return true if the value is case sensitive</em>
<a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="91" href="#91">91</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isCaseSensitive() {
<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">return</strong> caseSensitive;
<a class="jxr_linenumber" name="93" href="#93">93</a> }
<a class="jxr_linenumber" name="94" href="#94">94</a>
<a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * Sets the value of the caseSensitive property.</em>
<a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @param value whether the value is case sensitive</em>
<a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="101" href="#101">101</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCaseSensitive(<strong class="jxr_keyword">boolean</strong> value) {
<a class="jxr_linenumber" name="102" href="#102">102</a> <strong class="jxr_keyword">this</strong>.caseSensitive = value;
<a class="jxr_linenumber" name="103" href="#103">103</a> }
<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_comment">//&lt;/editor-fold&gt;</em>
<a class="jxr_linenumber" name="105" href="#105">105</a>
<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * Uses the object's properties to determine if the supplied string matches</em>
<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * the value of this property.</em>
<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * @param text the String to validate</em>
<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * @return whether the text supplied is matched by the value of the property</em>
<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="113" href="#113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> matches(String text) {
<a class="jxr_linenumber" name="114" href="#114">114</a> <strong class="jxr_keyword">if</strong> (text == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="115" href="#115">115</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="116" href="#116">116</a> }
<a class="jxr_linenumber" name="117" href="#117">117</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.regex) {
<a class="jxr_linenumber" name="118" href="#118">118</a> Pattern rx;
<a class="jxr_linenumber" name="119" href="#119">119</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.caseSensitive) {
<a class="jxr_linenumber" name="120" href="#120">120</a> rx = Pattern.compile(<strong class="jxr_keyword">this</strong>.value);
<a class="jxr_linenumber" name="121" href="#121">121</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="122" href="#122">122</a> rx = Pattern.compile(<strong class="jxr_keyword">this</strong>.value, Pattern.CASE_INSENSITIVE);
<a class="jxr_linenumber" name="123" href="#123">123</a> }
<a class="jxr_linenumber" name="124" href="#124">124</a> <strong class="jxr_keyword">return</strong> rx.matcher(text).matches();
<a class="jxr_linenumber" name="125" href="#125">125</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="126" href="#126">126</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.caseSensitive) {
<a class="jxr_linenumber" name="127" href="#127">127</a> <strong class="jxr_keyword">return</strong> value.equals(text);
<a class="jxr_linenumber" name="128" href="#128">128</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="129" href="#129">129</a> <strong class="jxr_keyword">return</strong> value.equalsIgnoreCase(text);
<a class="jxr_linenumber" name="130" href="#130">130</a> }
<a class="jxr_linenumber" name="131" href="#131">131</a> }
<a class="jxr_linenumber" name="132" href="#132">132</a> }
<a class="jxr_linenumber" name="133" href="#133">133</a>
<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_comment">//&lt;editor-fold defaultstate="collapsed" desc="standard implmentations of hashCode, equals, and toString"&gt;</em>
<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * Default implementation of hashCode.</em>
<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * @return the hash code</em>
<a class="jxr_linenumber" name="139" href="#139">139</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="140" href="#140">140</a> @Override
<a class="jxr_linenumber" name="141" href="#141">141</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode() {
<a class="jxr_linenumber" name="142" href="#142">142</a> <strong class="jxr_keyword">int</strong> hash = 3;
<a class="jxr_linenumber" name="143" href="#143">143</a> hash = 59 * hash + (<strong class="jxr_keyword">this</strong>.value != <strong class="jxr_keyword">null</strong> ? <strong class="jxr_keyword">this</strong>.value.hashCode() : 0);
<a class="jxr_linenumber" name="144" href="#144">144</a> hash = 59 * hash + (<strong class="jxr_keyword">this</strong>.regex ? 1 : 0);
<a class="jxr_linenumber" name="145" href="#145">145</a> hash = 59 * hash + (<strong class="jxr_keyword">this</strong>.caseSensitive ? 1 : 0);
<a class="jxr_linenumber" name="146" href="#146">146</a> <strong class="jxr_keyword">return</strong> hash;
<a class="jxr_linenumber" name="147" href="#147">147</a> }
<a class="jxr_linenumber" name="148" href="#148">148</a>
<a class="jxr_linenumber" name="149" href="#149">149</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * Default implementation of equals.</em>
<a class="jxr_linenumber" name="151" href="#151">151</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * @param obj the object to compare</em>
<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * @return whether the objects are equivalent</em>
<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="155" href="#155">155</a> @Override
<a class="jxr_linenumber" name="156" href="#156">156</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(Object obj) {
<a class="jxr_linenumber" name="157" href="#157">157</a> <strong class="jxr_keyword">if</strong> (obj == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="158" href="#158">158</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="159" href="#159">159</a> }
<a class="jxr_linenumber" name="160" href="#160">160</a> <strong class="jxr_keyword">if</strong> (getClass() != obj.getClass()) {
<a class="jxr_linenumber" name="161" href="#161">161</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="162" href="#162">162</a> }
<a class="jxr_linenumber" name="163" href="#163">163</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/suppression/PropertyType.html">PropertyType</a> other = (PropertyType) obj;
<a class="jxr_linenumber" name="164" href="#164">164</a> <strong class="jxr_keyword">if</strong> ((<strong class="jxr_keyword">this</strong>.value == <strong class="jxr_keyword">null</strong>) ? (other.value != <strong class="jxr_keyword">null</strong>) : !<strong class="jxr_keyword">this</strong>.value.equals(other.value)) {
<a class="jxr_linenumber" name="165" href="#165">165</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="166" href="#166">166</a> }
<a class="jxr_linenumber" name="167" href="#167">167</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.regex != other.regex) {
<a class="jxr_linenumber" name="168" href="#168">168</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="169" href="#169">169</a> }
<a class="jxr_linenumber" name="170" href="#170">170</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.caseSensitive != other.caseSensitive) {
<a class="jxr_linenumber" name="171" href="#171">171</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="172" href="#172">172</a> }
<a class="jxr_linenumber" name="173" href="#173">173</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="174" href="#174">174</a> }
<a class="jxr_linenumber" name="175" href="#175">175</a>
<a class="jxr_linenumber" name="176" href="#176">176</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="177" href="#177">177</a> <em class="jxr_javadoccomment"> * Default implementation of toString().</em>
<a class="jxr_linenumber" name="178" href="#178">178</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * @return the string representation of the object</em>
<a class="jxr_linenumber" name="180" href="#180">180</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="181" href="#181">181</a> @Override
<a class="jxr_linenumber" name="182" href="#182">182</a> <strong class="jxr_keyword">public</strong> String toString() {
<a class="jxr_linenumber" name="183" href="#183">183</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"PropertyType{"</span> + <span class="jxr_string">"value="</span> + value + <span class="jxr_string">", regex="</span> + regex + <span class="jxr_string">", caseSensitive="</span> + caseSensitive + '}';
<a class="jxr_linenumber" name="184" href="#184">184</a> }
<a class="jxr_linenumber" name="185" href="#185">185</a> <em class="jxr_comment">//&lt;/editor-fold&gt;</em>
<a class="jxr_linenumber" name="186" href="#186">186</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

107
dependency-check-core/xref/org/owasp/dependencycheck/suppression/SuppressionErrorHandler.html Normal file
View File

@@ -0,0 +1,107 @@
<!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>SuppressionErrorHandler xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/suppression/SuppressionErrorHandler.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * This file is part of dependency-check-core.</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Dependency-check-core is free software: you can redistribute it and/or modify it</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * under the terms of the GNU General Public License as published by the Free</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * Software Foundation, either version 3 of the License, or (at your option) any</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * later version.</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * Dependency-check-core is distributed in the hope that it will be useful, but</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * details.</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * You should have received a copy of the GNU General Public License along with</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * dependency-check-core. If not, see <a href="http://www.gnu.org/licenses/." target="alexandria_uri">http://www.gnu.org/licenses/.</a></em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * Copyright (c) 2013 Jeremy Long. All Rights Reserved.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.suppression;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.util.logging.Level;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.logging.Logger;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.xml.sax.ErrorHandler;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.xml.sax.SAXException;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.xml.sax.SAXParseException;
<a class="jxr_linenumber" name="26" href="#26">26</a>
<a class="jxr_linenumber" name="27" href="#27">27</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * An XML parsing error handler.</em>
<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * @author Jeremy Long (jeremy.long@owasp.org)</em>
<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionErrorHandler.html">SuppressionErrorHandler</a> <strong class="jxr_keyword">implements</strong> ErrorHandler {
<a class="jxr_linenumber" name="33" href="#33">33</a>
<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * Builds a prettier exception message.</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * @param ex the SAXParseException</em>
<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * @return an easier to read exception message</em>
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <strong class="jxr_keyword">private</strong> String getPrettyParseExceptionInfo(SAXParseException ex) {
<a class="jxr_linenumber" name="41" href="#41">41</a>
<a class="jxr_linenumber" name="42" href="#42">42</a> <strong class="jxr_keyword">final</strong> StringBuffer sb = <strong class="jxr_keyword">new</strong> StringBuffer();
<a class="jxr_linenumber" name="43" href="#43">43</a>
<a class="jxr_linenumber" name="44" href="#44">44</a> <strong class="jxr_keyword">if</strong> (ex.getSystemId() != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="45" href="#45">45</a> sb.append(<span class="jxr_string">"systemId="</span>).append(ex.getSystemId()).append(<span class="jxr_string">", "</span>);
<a class="jxr_linenumber" name="46" href="#46">46</a> }
<a class="jxr_linenumber" name="47" href="#47">47</a> <strong class="jxr_keyword">if</strong> (ex.getPublicId() != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="48" href="#48">48</a> sb.append(<span class="jxr_string">"publicId="</span>).append(ex.getPublicId()).append(<span class="jxr_string">", "</span>);
<a class="jxr_linenumber" name="49" href="#49">49</a> }
<a class="jxr_linenumber" name="50" href="#50">50</a> <strong class="jxr_keyword">if</strong> (ex.getLineNumber() &gt; 0) {
<a class="jxr_linenumber" name="51" href="#51">51</a> sb.append(<span class="jxr_string">"Line="</span>).append(ex.getLineNumber());
<a class="jxr_linenumber" name="52" href="#52">52</a> }
<a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">if</strong> (ex.getColumnNumber() &gt; 0) {
<a class="jxr_linenumber" name="54" href="#54">54</a> sb.append(<span class="jxr_string">", Column="</span>).append(ex.getColumnNumber());
<a class="jxr_linenumber" name="55" href="#55">55</a> }
<a class="jxr_linenumber" name="56" href="#56">56</a> sb.append(<span class="jxr_string">": "</span>).append(ex.getMessage());
<a class="jxr_linenumber" name="57" href="#57">57</a>
<a class="jxr_linenumber" name="58" href="#58">58</a> <strong class="jxr_keyword">return</strong> sb.toString();
<a class="jxr_linenumber" name="59" href="#59">59</a> }
<a class="jxr_linenumber" name="60" href="#60">60</a>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * Logs warnings.</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @param ex the warning to log</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * @throws SAXException is never thrown</em>
<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="67" href="#67">67</a> @Override
<a class="jxr_linenumber" name="68" href="#68">68</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> warning(SAXParseException ex) <strong class="jxr_keyword">throws</strong> SAXException {
<a class="jxr_linenumber" name="69" href="#69">69</a> Logger.getLogger(SuppressionErrorHandler.<strong class="jxr_keyword">class</strong>.getName()).log(Level.FINE, <strong class="jxr_keyword">null</strong>, ex);
<a class="jxr_linenumber" name="70" href="#70">70</a> }
<a class="jxr_linenumber" name="71" href="#71">71</a>
<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * Handles errors.</em>
<a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * @param ex the error to handle</em>
<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * @throws SAXException is always thrown</em>
<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="78" href="#78">78</a> @Override
<a class="jxr_linenumber" name="79" href="#79">79</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> error(SAXParseException ex) <strong class="jxr_keyword">throws</strong> SAXException {
<a class="jxr_linenumber" name="80" href="#80">80</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> SAXException(getPrettyParseExceptionInfo(ex));
<a class="jxr_linenumber" name="81" href="#81">81</a> }
<a class="jxr_linenumber" name="82" href="#82">82</a>
<a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * Handles fatal exceptions.</em>
<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * @param ex a fatal exception</em>
<a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * @throws SAXException is always</em>
<a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="89" href="#89">89</a> @Override
<a class="jxr_linenumber" name="90" href="#90">90</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> fatalError(SAXParseException ex) <strong class="jxr_keyword">throws</strong> SAXException {
<a class="jxr_linenumber" name="91" href="#91">91</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> SAXException(getPrettyParseExceptionInfo(ex));
<a class="jxr_linenumber" name="92" href="#92">92</a> }
<a class="jxr_linenumber" name="93" href="#93">93</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

188
dependency-check-core/xref/org/owasp/dependencycheck/suppression/SuppressionHandler.html Normal file
View File

@@ -0,0 +1,188 @@
<!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>SuppressionHandler xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/suppression/SuppressionHandler.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * This file is part of dependency-check-core.</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Dependency-check-core is free software: you can redistribute it and/or modify it</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * under the terms of the GNU General Public License as published by the Free</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * Software Foundation, either version 3 of the License, or (at your option) any</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * later version.</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * Dependency-check-core is distributed in the hope that it will be useful, but</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * details.</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * You should have received a copy of the GNU General Public License along with</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * dependency-check-core. If not, see <a href="http://www.gnu.org/licenses/." target="alexandria_uri">http://www.gnu.org/licenses/.</a></em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * Copyright (c) 2013 Jeremy Long. All Rights Reserved.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.suppression;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.xml.sax.Attributes;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.xml.sax.SAXException;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.xml.sax.helpers.DefaultHandler;
<a class="jxr_linenumber" name="26" href="#26">26</a>
<a class="jxr_linenumber" name="27" href="#27">27</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * A handler to load suppression rules.</em>
<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * @author Jeremy Long (jeremy.long@owasp.org)</em>
<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionHandler.html">SuppressionHandler</a> <strong class="jxr_keyword">extends</strong> DefaultHandler {
<a class="jxr_linenumber" name="33" href="#33">33</a>
<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * The suppress node, indicates the start of a new rule.</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="37" href="#37">37</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SUPPRESS = <span class="jxr_string">"suppress"</span>;
<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * The file path element name.</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String FILE_PATH = <span class="jxr_string">"filePath"</span>;
<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * The sha1 hash element name.</em>
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SHA1 = <span class="jxr_string">"sha1"</span>;
<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * The CVE element name.</em>
<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="49" href="#49">49</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CVE = <span class="jxr_string">"cve"</span>;
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * The CPE element name.</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CPE = <span class="jxr_string">"cpe"</span>;
<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * The CWE element name.</em>
<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="57" href="#57">57</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CWE = <span class="jxr_string">"cwe"</span>;
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * The cvssBelow element name.</em>
<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="61" href="#61">61</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CVSS_BELOW = <span class="jxr_string">"cvssBelow"</span>;
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * A list of suppression rules.</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <strong class="jxr_keyword">private</strong> List&lt;SuppressionRule&gt; supressionRules = <strong class="jxr_keyword">new</strong> ArrayList&lt;SuppressionRule&gt;();
<a class="jxr_linenumber" name="66" href="#66">66</a>
<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * Get the value of supressionRules.</em>
<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @return the value of supressionRules</em>
<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="72" href="#72">72</a> <strong class="jxr_keyword">public</strong> List&lt;SuppressionRule&gt; getSupressionRules() {
<a class="jxr_linenumber" name="73" href="#73">73</a> <strong class="jxr_keyword">return</strong> supressionRules;
<a class="jxr_linenumber" name="74" href="#74">74</a> }
<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * The current rule being read.</em>
<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="78" href="#78">78</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionRule.html">SuppressionRule</a> rule;
<a class="jxr_linenumber" name="79" href="#79">79</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * The attributes of the node being read.</em>
<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="82" href="#82">82</a> <strong class="jxr_keyword">private</strong> Attributes currentAttributes;
<a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * The current node text being extracted from the element.</em>
<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="86" href="#86">86</a> <strong class="jxr_keyword">private</strong> StringBuffer currentText;
<a class="jxr_linenumber" name="87" href="#87">87</a>
<a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * Handles the start element event.</em>
<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * @param uri the uri of the element being processed</em>
<a class="jxr_linenumber" name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * @param localName the local name of the element being processed</em>
<a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * @param qName the qName of the element being processed</em>
<a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * @param attributes the attributes of the element being processed</em>
<a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * @throws SAXException thrown if there is an exception processing</em>
<a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="97" href="#97">97</a> @Override
<a class="jxr_linenumber" name="98" href="#98">98</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> startElement(String uri, String localName, String qName, Attributes attributes) <strong class="jxr_keyword">throws</strong> SAXException {
<a class="jxr_linenumber" name="99" href="#99">99</a> currentAttributes = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="100" href="#100">100</a> currentText = <strong class="jxr_keyword">new</strong> StringBuffer();
<a class="jxr_linenumber" name="101" href="#101">101</a>
<a class="jxr_linenumber" name="102" href="#102">102</a> <strong class="jxr_keyword">if</strong> (SUPPRESS.equals(qName)) {
<a class="jxr_linenumber" name="103" href="#103">103</a> rule = <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionRule.html">SuppressionRule</a>();
<a class="jxr_linenumber" name="104" href="#104">104</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (FILE_PATH.equals(qName)) {
<a class="jxr_linenumber" name="105" href="#105">105</a> currentAttributes = attributes;
<a class="jxr_linenumber" name="106" href="#106">106</a> }
<a class="jxr_linenumber" name="107" href="#107">107</a> }
<a class="jxr_linenumber" name="108" href="#108">108</a>
<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * Handles the end element event.</em>
<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * @param uri the uri of the element</em>
<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * @param localName the local name of the element</em>
<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * @param qName the qName of the element</em>
<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * @throws SAXException thrown if there is an exception processing</em>
<a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="117" href="#117">117</a> @Override
<a class="jxr_linenumber" name="118" href="#118">118</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> endElement(String uri, String localName, String qName) <strong class="jxr_keyword">throws</strong> SAXException {
<a class="jxr_linenumber" name="119" href="#119">119</a> <strong class="jxr_keyword">if</strong> (SUPPRESS.equals(qName)) {
<a class="jxr_linenumber" name="120" href="#120">120</a> supressionRules.add(rule);
<a class="jxr_linenumber" name="121" href="#121">121</a> rule = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="122" href="#122">122</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (FILE_PATH.equals(qName)) {
<a class="jxr_linenumber" name="123" href="#123">123</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/suppression/PropertyType.html">PropertyType</a> pt = processPropertyType();
<a class="jxr_linenumber" name="124" href="#124">124</a> rule.setFilePath(pt);
<a class="jxr_linenumber" name="125" href="#125">125</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (SHA1.equals(qName)) {
<a class="jxr_linenumber" name="126" href="#126">126</a> rule.setSha1(currentText.toString());
<a class="jxr_linenumber" name="127" href="#127">127</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (CPE.equals(qName)) {
<a class="jxr_linenumber" name="128" href="#128">128</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/suppression/PropertyType.html">PropertyType</a> pt = processPropertyType();
<a class="jxr_linenumber" name="129" href="#129">129</a> rule.addCpe(pt);
<a class="jxr_linenumber" name="130" href="#130">130</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (CWE.equals(qName)) {
<a class="jxr_linenumber" name="131" href="#131">131</a> rule.addCwe(currentText.toString());
<a class="jxr_linenumber" name="132" href="#132">132</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (CVE.equals(qName)) {
<a class="jxr_linenumber" name="133" href="#133">133</a> rule.addCve(currentText.toString());
<a class="jxr_linenumber" name="134" href="#134">134</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (CVSS_BELOW.equals(qName)) {
<a class="jxr_linenumber" name="135" href="#135">135</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">float</strong> cvss = Float.parseFloat(currentText.toString());
<a class="jxr_linenumber" name="136" href="#136">136</a> rule.addCvssBelow(cvss);
<a class="jxr_linenumber" name="137" href="#137">137</a> }
<a class="jxr_linenumber" name="138" href="#138">138</a> }
<a class="jxr_linenumber" name="139" href="#139">139</a>
<a class="jxr_linenumber" name="140" href="#140">140</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * Collects the body text of the node being processed.</em>
<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * @param ch the char array of text</em>
<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * @param start the start position to copy text from in the char array</em>
<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * @param length the number of characters to copy from the char array</em>
<a class="jxr_linenumber" name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * @throws SAXException thrown if there is a parsing exception</em>
<a class="jxr_linenumber" name="147" href="#147">147</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="148" href="#148">148</a> @Override
<a class="jxr_linenumber" name="149" href="#149">149</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> characters(<strong class="jxr_keyword">char</strong>[] ch, <strong class="jxr_keyword">int</strong> start, <strong class="jxr_keyword">int</strong> length) <strong class="jxr_keyword">throws</strong> SAXException {
<a class="jxr_linenumber" name="150" href="#150">150</a> currentText.append(ch, start, length);
<a class="jxr_linenumber" name="151" href="#151">151</a> }
<a class="jxr_linenumber" name="152" href="#152">152</a>
<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * Processes field members that have been collected during the characters</em>
<a class="jxr_linenumber" name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * and startElement method to construct a PropertyType object.</em>
<a class="jxr_linenumber" name="156" href="#156">156</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * @return a PropertyType object</em>
<a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="159" href="#159">159</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/owasp/dependencycheck/suppression/PropertyType.html">PropertyType</a> processPropertyType() {
<a class="jxr_linenumber" name="160" href="#160">160</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/suppression/PropertyType.html">PropertyType</a> pt = <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/suppression/PropertyType.html">PropertyType</a>();
<a class="jxr_linenumber" name="161" href="#161">161</a> pt.setValue(currentText.toString());
<a class="jxr_linenumber" name="162" href="#162">162</a> <strong class="jxr_keyword">if</strong> (currentAttributes != <strong class="jxr_keyword">null</strong> &amp;&amp; currentAttributes.getLength() &gt; 0) {
<a class="jxr_linenumber" name="163" href="#163">163</a> <strong class="jxr_keyword">final</strong> String regex = currentAttributes.getValue(<span class="jxr_string">"regex"</span>);
<a class="jxr_linenumber" name="164" href="#164">164</a> <strong class="jxr_keyword">if</strong> (regex != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="165" href="#165">165</a> pt.setRegex(Boolean.parseBoolean(regex));
<a class="jxr_linenumber" name="166" href="#166">166</a> }
<a class="jxr_linenumber" name="167" href="#167">167</a> <strong class="jxr_keyword">final</strong> String caseSensitive = currentAttributes.getValue(<span class="jxr_string">"caseSensitive"</span>);
<a class="jxr_linenumber" name="168" href="#168">168</a> <strong class="jxr_keyword">if</strong> (regex != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="169" href="#169">169</a> pt.setCaseSensitive(Boolean.parseBoolean(caseSensitive));
<a class="jxr_linenumber" name="170" href="#170">170</a> }
<a class="jxr_linenumber" name="171" href="#171">171</a> }
<a class="jxr_linenumber" name="172" href="#172">172</a> <strong class="jxr_keyword">return</strong> pt;
<a class="jxr_linenumber" name="173" href="#173">173</a> }
<a class="jxr_linenumber" name="174" href="#174">174</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

83
dependency-check-core/xref/org/owasp/dependencycheck/suppression/SuppressionParseException.html Normal file
View File

@@ -0,0 +1,83 @@
<!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>SuppressionParseException xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/suppression/SuppressionParseException.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * This file is part of dependency-check-core.</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Dependency-check-core is free software: you can redistribute it and/or modify it</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * under the terms of the GNU General Public License as published by the Free</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * Software Foundation, either version 3 of the License, or (at your option) any</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * later version.</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * Dependency-check-core is distributed in the hope that it will be useful, but</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * details.</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * You should have received a copy of the GNU General Public License along with</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * dependency-check-core. If not, see <a href="http://www.gnu.org/licenses/." target="alexandria_uri">http://www.gnu.org/licenses/.</a></em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * Copyright (c) 2013 Jeremy Long. All Rights Reserved.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.suppression;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="22" href="#22">22</a>
<a class="jxr_linenumber" name="23" href="#23">23</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * An exception used when parsing a suppression rule file fails.</em>
<a class="jxr_linenumber" name="25" href="#25">25</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * @author Jeremy Long (jeremy.long@owasp.org)</em>
<a class="jxr_linenumber" name="27" href="#27">27</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionParseException.html">SuppressionParseException</a> <strong class="jxr_keyword">extends</strong> IOException {
<a class="jxr_linenumber" name="29" href="#29">29</a>
<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * The serial version UID.</em>
<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 1L;
<a class="jxr_linenumber" name="34" href="#34">34</a>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * Creates a new SuppressionParseException.</em>
<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="38" href="#38">38</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionParseException.html">SuppressionParseException</a>() {
<a class="jxr_linenumber" name="39" href="#39">39</a> <strong class="jxr_keyword">super</strong>();
<a class="jxr_linenumber" name="40" href="#40">40</a> }
<a class="jxr_linenumber" name="41" href="#41">41</a>
<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * Creates a new SuppressionParseException.</em>
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * @param msg a message for the exception.</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionParseException.html">SuppressionParseException</a>(String msg) {
<a class="jxr_linenumber" name="48" href="#48">48</a> <strong class="jxr_keyword">super</strong>(msg);
<a class="jxr_linenumber" name="49" href="#49">49</a> }
<a class="jxr_linenumber" name="50" href="#50">50</a>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * Creates a new SuppressionParseException.</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @param ex the cause of the download failure.</em>
<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="56" href="#56">56</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionParseException.html">SuppressionParseException</a>(Throwable ex) {
<a class="jxr_linenumber" name="57" href="#57">57</a> <strong class="jxr_keyword">super</strong>(ex);
<a class="jxr_linenumber" name="58" href="#58">58</a> }
<a class="jxr_linenumber" name="59" href="#59">59</a>
<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * Creates a new SuppressionParseException.</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @param msg a message for the exception.</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @param ex the cause of the download failure.</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="66" href="#66">66</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionParseException.html">SuppressionParseException</a>(String msg, Throwable ex) {
<a class="jxr_linenumber" name="67" href="#67">67</a> <strong class="jxr_keyword">super</strong>(msg, ex);
<a class="jxr_linenumber" name="68" href="#68">68</a> }
<a class="jxr_linenumber" name="69" href="#69">69</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

121
dependency-check-core/xref/org/owasp/dependencycheck/suppression/SuppressionParser.html Normal file
View File

@@ -0,0 +1,121 @@
<!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>SuppressionParser xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/suppression/SuppressionParser.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * This file is part of dependency-check-core.</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Dependency-check-core is free software: you can redistribute it and/or modify it</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * under the terms of the GNU General Public License as published by the Free</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * Software Foundation, either version 3 of the License, or (at your option) any</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * later version.</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * Dependency-check-core is distributed in the hope that it will be useful, but</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * details.</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * You should have received a copy of the GNU General Public License along with</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * dependency-check-core. If not, see <a href="http://www.gnu.org/licenses/." target="alexandria_uri">http://www.gnu.org/licenses/.</a></em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * Copyright (c) 2013 Jeremy Long. All Rights Reserved.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.suppression;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.FileNotFoundException;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.io.InputStreamReader;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.io.Reader;
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.logging.Level;
<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.util.logging.Logger;
<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> javax.xml.parsers.ParserConfigurationException;
<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> javax.xml.parsers.SAXParser;
<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> javax.xml.parsers.SAXParserFactory;
<a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.xml.sax.InputSource;
<a class="jxr_linenumber" name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.xml.sax.SAXException;
<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.xml.sax.XMLReader;
<a class="jxr_linenumber" name="37" href="#37">37</a>
<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * A simple validating parser for XML Suppression Rules.</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @author Jeremy Long (jeremy.long@owasp.org)</em>
<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionParser.html">SuppressionParser</a> {
<a class="jxr_linenumber" name="44" href="#44">44</a>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * JAXP Schema Language. Source:</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <a href="http://docs.oracle.com/javase/tutorial/jaxp/sax/validation.html" target="alexandria_uri">http://docs.oracle.com/javase/tutorial/jaxp/sax/validation.html</a></em>
<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="49" href="#49">49</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String JAXP_SCHEMA_LANGUAGE = <span class="jxr_string">"http://java.sun.com/xml/jaxp/properties/schemaLanguage"</span>;
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * W3C XML Schema. Source:</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * <a href="http://docs.oracle.com/javase/tutorial/jaxp/sax/validation.html" target="alexandria_uri">http://docs.oracle.com/javase/tutorial/jaxp/sax/validation.html</a></em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="54" href="#54">54</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String W3C_XML_SCHEMA = <span class="jxr_string">"http://www.w3.org/2001/XMLSchema"</span>;
<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * JAXP Schema Source. Source:</em>
<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * <a href="http://docs.oracle.com/javase/tutorial/jaxp/sax/validation.html" target="alexandria_uri">http://docs.oracle.com/javase/tutorial/jaxp/sax/validation.html</a></em>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String JAXP_SCHEMA_SOURCE = <span class="jxr_string">"http://java.sun.com/xml/jaxp/properties/schemaSource"</span>;
<a class="jxr_linenumber" name="60" href="#60">60</a>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * Parses the given xml file and returns a list of the suppression rules</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * contained.</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * @param file an xml file containing suppression rules</em>
<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * @return a list of suppression rules</em>
<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @throws SuppressionParseException thrown if the xml file cannot be parsed</em>
<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="69" href="#69">69</a> <strong class="jxr_keyword">public</strong> List&lt;SuppressionRule&gt; parseSuppressionRules(File file) <strong class="jxr_keyword">throws</strong> SuppressionParseException {
<a class="jxr_linenumber" name="70" href="#70">70</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="71" href="#71">71</a> <strong class="jxr_keyword">final</strong> InputStream schemaStream = <strong class="jxr_keyword">this</strong>.getClass().getClassLoader().getResourceAsStream(<span class="jxr_string">"schema/suppression.xsd"</span>);
<a class="jxr_linenumber" name="72" href="#72">72</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionHandler.html">SuppressionHandler</a> handler = <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionHandler.html">SuppressionHandler</a>();
<a class="jxr_linenumber" name="73" href="#73">73</a>
<a class="jxr_linenumber" name="74" href="#74">74</a> <strong class="jxr_keyword">final</strong> SAXParserFactory factory = SAXParserFactory.newInstance();
<a class="jxr_linenumber" name="75" href="#75">75</a> factory.setNamespaceAware(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="76" href="#76">76</a> factory.setValidating(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="77" href="#77">77</a> <strong class="jxr_keyword">final</strong> SAXParser saxParser = factory.newSAXParser();
<a class="jxr_linenumber" name="78" href="#78">78</a> saxParser.setProperty(SuppressionParser.JAXP_SCHEMA_LANGUAGE, SuppressionParser.W3C_XML_SCHEMA);
<a class="jxr_linenumber" name="79" href="#79">79</a> saxParser.setProperty(SuppressionParser.JAXP_SCHEMA_SOURCE, <strong class="jxr_keyword">new</strong> InputSource(schemaStream));
<a class="jxr_linenumber" name="80" href="#80">80</a> <strong class="jxr_keyword">final</strong> XMLReader xmlReader = saxParser.getXMLReader();
<a class="jxr_linenumber" name="81" href="#81">81</a> xmlReader.setErrorHandler(<strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionErrorHandler.html">SuppressionErrorHandler</a>());
<a class="jxr_linenumber" name="82" href="#82">82</a> xmlReader.setContentHandler(handler);
<a class="jxr_linenumber" name="83" href="#83">83</a>
<a class="jxr_linenumber" name="84" href="#84">84</a> <strong class="jxr_keyword">final</strong> InputStream inputStream = <strong class="jxr_keyword">new</strong> FileInputStream(file);
<a class="jxr_linenumber" name="85" href="#85">85</a> <strong class="jxr_keyword">final</strong> Reader reader = <strong class="jxr_keyword">new</strong> InputStreamReader(inputStream, <span class="jxr_string">"UTF-8"</span>);
<a class="jxr_linenumber" name="86" href="#86">86</a> <strong class="jxr_keyword">final</strong> InputSource in = <strong class="jxr_keyword">new</strong> InputSource(reader);
<a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_comment">//in.setEncoding("UTF-8");</em>
<a class="jxr_linenumber" name="88" href="#88">88</a>
<a class="jxr_linenumber" name="89" href="#89">89</a> xmlReader.parse(in);
<a class="jxr_linenumber" name="90" href="#90">90</a>
<a class="jxr_linenumber" name="91" href="#91">91</a>
<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">return</strong> handler.getSupressionRules();
<a class="jxr_linenumber" name="93" href="#93">93</a> } <strong class="jxr_keyword">catch</strong> (ParserConfigurationException ex) {
<a class="jxr_linenumber" name="94" href="#94">94</a> Logger.getLogger(SuppressionParser.<strong class="jxr_keyword">class</strong>.getName()).log(Level.FINE, <strong class="jxr_keyword">null</strong>, ex);
<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionParseException.html">SuppressionParseException</a>(ex);
<a class="jxr_linenumber" name="96" href="#96">96</a> } <strong class="jxr_keyword">catch</strong> (SAXException ex) {
<a class="jxr_linenumber" name="97" href="#97">97</a> Logger.getLogger(SuppressionParser.<strong class="jxr_keyword">class</strong>.getName()).log(Level.FINE, <strong class="jxr_keyword">null</strong>, ex);
<a class="jxr_linenumber" name="98" href="#98">98</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionParseException.html">SuppressionParseException</a>(ex);
<a class="jxr_linenumber" name="99" href="#99">99</a> } <strong class="jxr_keyword">catch</strong> (FileNotFoundException ex) {
<a class="jxr_linenumber" name="100" href="#100">100</a> Logger.getLogger(SuppressionParser.<strong class="jxr_keyword">class</strong>.getName()).log(Level.FINE, <strong class="jxr_keyword">null</strong>, ex);
<a class="jxr_linenumber" name="101" href="#101">101</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionParseException.html">SuppressionParseException</a>(ex);
<a class="jxr_linenumber" name="102" href="#102">102</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="103" href="#103">103</a> Logger.getLogger(SuppressionParser.<strong class="jxr_keyword">class</strong>.getName()).log(Level.FINE, <strong class="jxr_keyword">null</strong>, ex);
<a class="jxr_linenumber" name="104" href="#104">104</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionParseException.html">SuppressionParseException</a>(ex);
<a class="jxr_linenumber" name="105" href="#105">105</a> }
<a class="jxr_linenumber" name="106" href="#106">106</a> }
<a class="jxr_linenumber" name="107" href="#107">107</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

379
dependency-check-core/xref/org/owasp/dependencycheck/suppression/SuppressionRule.html Normal file
View File

@@ -0,0 +1,379 @@
<!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>SuppressionRule xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/suppression/SuppressionRule.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * This file is part of dependency-check-core.</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Dependency-check-core is free software: you can redistribute it and/or modify it</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * under the terms of the GNU General Public License as published by the Free</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * Software Foundation, either version 3 of the License, or (at your option) any</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * later version.</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * Dependency-check-core is distributed in the hope that it will be useful, but</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * details.</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * You should have received a copy of the GNU General Public License along with</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * dependency-check-core. If not, see <a href="http://www.gnu.org/licenses/." target="alexandria_uri">http://www.gnu.org/licenses/.</a></em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * Copyright (c) 2013 Jeremy Long. All Rights Reserved.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.suppression;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Dependency;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Identifier;
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Vulnerability;
<a class="jxr_linenumber" name="27" href="#27">27</a>
<a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * @author Jeremy Long (jeremy.long@owasp.org)</em>
<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/suppression/SuppressionRule.html">SuppressionRule</a> {
<a class="jxr_linenumber" name="33" href="#33">33</a>
<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * The file path for the suppression.</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="37" href="#37">37</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/owasp/dependencycheck/suppression/PropertyType.html">PropertyType</a> filePath;
<a class="jxr_linenumber" name="38" href="#38">38</a>
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Get the value of filePath.</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @return the value of filePath</em>
<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="44" href="#44">44</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/owasp/dependencycheck/suppression/PropertyType.html">PropertyType</a> getFilePath() {
<a class="jxr_linenumber" name="45" href="#45">45</a> <strong class="jxr_keyword">return</strong> filePath;
<a class="jxr_linenumber" name="46" href="#46">46</a> }
<a class="jxr_linenumber" name="47" href="#47">47</a>
<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Set the value of filePath.</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * @param filePath new value of filePath</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFilePath(<a href="../../../../org/owasp/dependencycheck/suppression/PropertyType.html">PropertyType</a> filePath) {
<a class="jxr_linenumber" name="54" href="#54">54</a> <strong class="jxr_keyword">this</strong>.filePath = filePath;
<a class="jxr_linenumber" name="55" href="#55">55</a> }
<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * The sha1 hash.</em>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> <strong class="jxr_keyword">private</strong> String sha1;
<a class="jxr_linenumber" name="60" href="#60">60</a>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * Get the value of sha1.</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @return the value of sha1</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="66" href="#66">66</a> <strong class="jxr_keyword">public</strong> String getSha1() {
<a class="jxr_linenumber" name="67" href="#67">67</a> <strong class="jxr_keyword">return</strong> sha1;
<a class="jxr_linenumber" name="68" href="#68">68</a> }
<a class="jxr_linenumber" name="69" href="#69">69</a>
<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * Set the value of sha1.</em>
<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @param sha1 new value of sha1</em>
<a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="75" href="#75">75</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSha1(String sha1) {
<a class="jxr_linenumber" name="76" href="#76">76</a> <strong class="jxr_keyword">this</strong>.sha1 = sha1;
<a class="jxr_linenumber" name="77" href="#77">77</a> }
<a class="jxr_linenumber" name="78" href="#78">78</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * A list of CPEs to suppression</em>
<a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="81" href="#81">81</a> <strong class="jxr_keyword">private</strong> List&lt;PropertyType&gt; cpe = <strong class="jxr_keyword">new</strong> ArrayList&lt;PropertyType&gt;();
<a class="jxr_linenumber" name="82" href="#82">82</a>
<a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * Get the value of cpe.</em>
<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * @return the value of cpe</em>
<a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="88" href="#88">88</a> <strong class="jxr_keyword">public</strong> List&lt;PropertyType&gt; getCpe() {
<a class="jxr_linenumber" name="89" href="#89">89</a> <strong class="jxr_keyword">return</strong> cpe;
<a class="jxr_linenumber" name="90" href="#90">90</a> }
<a class="jxr_linenumber" name="91" href="#91">91</a>
<a class="jxr_linenumber" name="92" href="#92">92</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * Set the value of cpe.</em>
<a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * @param cpe new value of cpe</em>
<a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="97" href="#97">97</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCpe(List&lt;PropertyType&gt; cpe) {
<a class="jxr_linenumber" name="98" href="#98">98</a> <strong class="jxr_keyword">this</strong>.cpe = cpe;
<a class="jxr_linenumber" name="99" href="#99">99</a> }
<a class="jxr_linenumber" name="100" href="#100">100</a>
<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * Adds the cpe to the cpe list.</em>
<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @param cpe the cpe to add</em>
<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="106" href="#106">106</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addCpe(<a href="../../../../org/owasp/dependencycheck/suppression/PropertyType.html">PropertyType</a> cpe) {
<a class="jxr_linenumber" name="107" href="#107">107</a> <strong class="jxr_keyword">this</strong>.cpe.add(cpe);
<a class="jxr_linenumber" name="108" href="#108">108</a> }
<a class="jxr_linenumber" name="109" href="#109">109</a>
<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * Returns whether or not this suppression rule as CPE entries.</em>
<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * @return whether or not this suppression rule as CPE entries</em>
<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="115" href="#115">115</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasCpe() {
<a class="jxr_linenumber" name="116" href="#116">116</a> <strong class="jxr_keyword">return</strong> cpe.size() &gt; 0;
<a class="jxr_linenumber" name="117" href="#117">117</a> }
<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * The list of cvssBelow scores.</em>
<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="121" href="#121">121</a> <strong class="jxr_keyword">private</strong> List&lt;Float&gt; cvssBelow = <strong class="jxr_keyword">new</strong> ArrayList&lt;Float&gt;();
<a class="jxr_linenumber" name="122" href="#122">122</a>
<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * Get the value of cvssBelow.</em>
<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * @return the value of cvssBelow</em>
<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="128" href="#128">128</a> <strong class="jxr_keyword">public</strong> List&lt;Float&gt; getCvssBelow() {
<a class="jxr_linenumber" name="129" href="#129">129</a> <strong class="jxr_keyword">return</strong> cvssBelow;
<a class="jxr_linenumber" name="130" href="#130">130</a> }
<a class="jxr_linenumber" name="131" href="#131">131</a>
<a class="jxr_linenumber" name="132" href="#132">132</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * Set the value of cvssBelow.</em>
<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * @param cvssBelow new value of cvssBelow</em>
<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="137" href="#137">137</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCvssBelow(List&lt;Float&gt; cvssBelow) {
<a class="jxr_linenumber" name="138" href="#138">138</a> <strong class="jxr_keyword">this</strong>.cvssBelow = cvssBelow;
<a class="jxr_linenumber" name="139" href="#139">139</a> }
<a class="jxr_linenumber" name="140" href="#140">140</a>
<a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * Adds the cvss to the cvssBelow list.</em>
<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * @param cvss the cvss to add</em>
<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="146" href="#146">146</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addCvssBelow(Float cvss) {
<a class="jxr_linenumber" name="147" href="#147">147</a> <strong class="jxr_keyword">this</strong>.cvssBelow.add(cvss);
<a class="jxr_linenumber" name="148" href="#148">148</a> }
<a class="jxr_linenumber" name="149" href="#149">149</a>
<a class="jxr_linenumber" name="150" href="#150">150</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * Returns whether or not this suppression rule has cvss suppressions.</em>
<a class="jxr_linenumber" name="152" href="#152">152</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * @return whether or not this suppression rule has cvss suppressions</em>
<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="155" href="#155">155</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasCvssBelow() {
<a class="jxr_linenumber" name="156" href="#156">156</a> <strong class="jxr_keyword">return</strong> cvssBelow.size() &gt; 0;
<a class="jxr_linenumber" name="157" href="#157">157</a> }
<a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * The list of cwe entries to suppress.</em>
<a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="161" href="#161">161</a> <strong class="jxr_keyword">private</strong> List&lt;String&gt; cwe = <strong class="jxr_keyword">new</strong> ArrayList&lt;String&gt;();
<a class="jxr_linenumber" name="162" href="#162">162</a>
<a class="jxr_linenumber" name="163" href="#163">163</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * Get the value of cwe.</em>
<a class="jxr_linenumber" name="165" href="#165">165</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * @return the value of cwe</em>
<a class="jxr_linenumber" name="167" href="#167">167</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="168" href="#168">168</a> <strong class="jxr_keyword">public</strong> List&lt;String&gt; getCwe() {
<a class="jxr_linenumber" name="169" href="#169">169</a> <strong class="jxr_keyword">return</strong> cwe;
<a class="jxr_linenumber" name="170" href="#170">170</a> }
<a class="jxr_linenumber" name="171" href="#171">171</a>
<a class="jxr_linenumber" name="172" href="#172">172</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="173" href="#173">173</a> <em class="jxr_javadoccomment"> * Set the value of cwe.</em>
<a class="jxr_linenumber" name="174" href="#174">174</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * @param cwe new value of cwe</em>
<a class="jxr_linenumber" name="176" href="#176">176</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="177" href="#177">177</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCwe(List&lt;String&gt; cwe) {
<a class="jxr_linenumber" name="178" href="#178">178</a> <strong class="jxr_keyword">this</strong>.cwe = cwe;
<a class="jxr_linenumber" name="179" href="#179">179</a> }
<a class="jxr_linenumber" name="180" href="#180">180</a>
<a class="jxr_linenumber" name="181" href="#181">181</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * Adds the cwe to the cwe list.</em>
<a class="jxr_linenumber" name="183" href="#183">183</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * @param cwe the cwe to add</em>
<a class="jxr_linenumber" name="185" href="#185">185</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="186" href="#186">186</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addCwe(String cwe) {
<a class="jxr_linenumber" name="187" href="#187">187</a> <strong class="jxr_keyword">this</strong>.cwe.add(cwe);
<a class="jxr_linenumber" name="188" href="#188">188</a> }
<a class="jxr_linenumber" name="189" href="#189">189</a>
<a class="jxr_linenumber" name="190" href="#190">190</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * Returns whether this suppression rule has CWE entries.</em>
<a class="jxr_linenumber" name="192" href="#192">192</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * @return whether this suppression rule has CWE entries</em>
<a class="jxr_linenumber" name="194" href="#194">194</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="195" href="#195">195</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasCwe() {
<a class="jxr_linenumber" name="196" href="#196">196</a> <strong class="jxr_keyword">return</strong> cwe.size() &gt; 0;
<a class="jxr_linenumber" name="197" href="#197">197</a> }
<a class="jxr_linenumber" name="198" href="#198">198</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * The list of cve entries to suppress.</em>
<a class="jxr_linenumber" name="200" href="#200">200</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="201" href="#201">201</a> <strong class="jxr_keyword">private</strong> List&lt;String&gt; cve = <strong class="jxr_keyword">new</strong> ArrayList&lt;String&gt;();
<a class="jxr_linenumber" name="202" href="#202">202</a>
<a class="jxr_linenumber" name="203" href="#203">203</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="204" href="#204">204</a> <em class="jxr_javadoccomment"> * Get the value of cve.</em>
<a class="jxr_linenumber" name="205" href="#205">205</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * @return the value of cve</em>
<a class="jxr_linenumber" name="207" href="#207">207</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="208" href="#208">208</a> <strong class="jxr_keyword">public</strong> List&lt;String&gt; getCve() {
<a class="jxr_linenumber" name="209" href="#209">209</a> <strong class="jxr_keyword">return</strong> cve;
<a class="jxr_linenumber" name="210" href="#210">210</a> }
<a class="jxr_linenumber" name="211" href="#211">211</a>
<a class="jxr_linenumber" name="212" href="#212">212</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="213" href="#213">213</a> <em class="jxr_javadoccomment"> * Set the value of cve.</em>
<a class="jxr_linenumber" name="214" href="#214">214</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * @param cve new value of cve</em>
<a class="jxr_linenumber" name="216" href="#216">216</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="217" href="#217">217</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCve(List&lt;String&gt; cve) {
<a class="jxr_linenumber" name="218" href="#218">218</a> <strong class="jxr_keyword">this</strong>.cve = cve;
<a class="jxr_linenumber" name="219" href="#219">219</a> }
<a class="jxr_linenumber" name="220" href="#220">220</a>
<a class="jxr_linenumber" name="221" href="#221">221</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="222" href="#222">222</a> <em class="jxr_javadoccomment"> * Adds the cve to the cve list.</em>
<a class="jxr_linenumber" name="223" href="#223">223</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="224" href="#224">224</a> <em class="jxr_javadoccomment"> * @param cve the cve to add</em>
<a class="jxr_linenumber" name="225" href="#225">225</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="226" href="#226">226</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addCve(String cve) {
<a class="jxr_linenumber" name="227" href="#227">227</a> <strong class="jxr_keyword">this</strong>.cve.add(cve);
<a class="jxr_linenumber" name="228" href="#228">228</a> }
<a class="jxr_linenumber" name="229" href="#229">229</a>
<a class="jxr_linenumber" name="230" href="#230">230</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * Returns whether this suppression rule has CVE entries.</em>
<a class="jxr_linenumber" name="232" href="#232">232</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * @return whether this suppression rule has CVE entries</em>
<a class="jxr_linenumber" name="234" href="#234">234</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="235" href="#235">235</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasCve() {
<a class="jxr_linenumber" name="236" href="#236">236</a> <strong class="jxr_keyword">return</strong> cve.size() &gt; 0;
<a class="jxr_linenumber" name="237" href="#237">237</a> }
<a class="jxr_linenumber" name="238" href="#238">238</a>
<a class="jxr_linenumber" name="239" href="#239">239</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="240" href="#240">240</a> <em class="jxr_javadoccomment"> * Processes a given dependency to determine if any CPE, CVE, CWE, or CVSS</em>
<a class="jxr_linenumber" name="241" href="#241">241</a> <em class="jxr_javadoccomment"> * scores should be suppressed. If any should be, they are removed from the</em>
<a class="jxr_linenumber" name="242" href="#242">242</a> <em class="jxr_javadoccomment"> * dependency.</em>
<a class="jxr_linenumber" name="243" href="#243">243</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * @param dependency a project dependency to analyze</em>
<a class="jxr_linenumber" name="245" href="#245">245</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="246" href="#246">246</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> process(<a href="../../../../org/owasp/dependencycheck/dependency/Dependency.html">Dependency</a> dependency) {
<a class="jxr_linenumber" name="247" href="#247">247</a> <strong class="jxr_keyword">if</strong> (filePath != <strong class="jxr_keyword">null</strong> &amp;&amp; !filePath.matches(dependency.getFilePath())) {
<a class="jxr_linenumber" name="248" href="#248">248</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="249" href="#249">249</a> }
<a class="jxr_linenumber" name="250" href="#250">250</a> <strong class="jxr_keyword">if</strong> (sha1 != <strong class="jxr_keyword">null</strong> &amp;&amp; !sha1.equalsIgnoreCase(dependency.getSha1sum())) {
<a class="jxr_linenumber" name="251" href="#251">251</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="252" href="#252">252</a> }
<a class="jxr_linenumber" name="253" href="#253">253</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.hasCpe()) {
<a class="jxr_linenumber" name="254" href="#254">254</a> <strong class="jxr_keyword">final</strong> Iterator&lt;Identifier&gt; itr = dependency.getIdentifiers().iterator();
<a class="jxr_linenumber" name="255" href="#255">255</a> <strong class="jxr_keyword">while</strong> (itr.hasNext()) {
<a class="jxr_linenumber" name="256" href="#256">256</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/dependency/Identifier.html">Identifier</a> i = itr.next();
<a class="jxr_linenumber" name="257" href="#257">257</a> <strong class="jxr_keyword">for</strong> (PropertyType c : <strong class="jxr_keyword">this</strong>.cpe) {
<a class="jxr_linenumber" name="258" href="#258">258</a> <strong class="jxr_keyword">if</strong> (cpeMatches(c, i)) {
<a class="jxr_linenumber" name="259" href="#259">259</a> itr.remove();
<a class="jxr_linenumber" name="260" href="#260">260</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="261" href="#261">261</a> }
<a class="jxr_linenumber" name="262" href="#262">262</a> }
<a class="jxr_linenumber" name="263" href="#263">263</a> }
<a class="jxr_linenumber" name="264" href="#264">264</a> }
<a class="jxr_linenumber" name="265" href="#265">265</a> <strong class="jxr_keyword">if</strong> (hasCve() || hasCwe() || hasCvssBelow()) {
<a class="jxr_linenumber" name="266" href="#266">266</a> <strong class="jxr_keyword">final</strong> Iterator&lt;Vulnerability&gt; itr = dependency.getVulnerabilities().iterator();
<a class="jxr_linenumber" name="267" href="#267">267</a> <strong class="jxr_keyword">boolean</strong> remove = false;
<a class="jxr_linenumber" name="268" href="#268">268</a> <strong class="jxr_keyword">while</strong> (!remove &amp;&amp; itr.hasNext()) {
<a class="jxr_linenumber" name="269" href="#269">269</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/dependency/Vulnerability.html">Vulnerability</a> v = itr.next();
<a class="jxr_linenumber" name="270" href="#270">270</a> <strong class="jxr_keyword">for</strong> (String entry : <strong class="jxr_keyword">this</strong>.cve) {
<a class="jxr_linenumber" name="271" href="#271">271</a> <strong class="jxr_keyword">if</strong> (entry.equalsIgnoreCase(v.getName())) {
<a class="jxr_linenumber" name="272" href="#272">272</a> remove = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="273" href="#273">273</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="274" href="#274">274</a> }
<a class="jxr_linenumber" name="275" href="#275">275</a> }
<a class="jxr_linenumber" name="276" href="#276">276</a> <strong class="jxr_keyword">if</strong> (!remove) {
<a class="jxr_linenumber" name="277" href="#277">277</a> <strong class="jxr_keyword">for</strong> (String entry : <strong class="jxr_keyword">this</strong>.cwe) {
<a class="jxr_linenumber" name="278" href="#278">278</a> <strong class="jxr_keyword">if</strong> (v.getCwe() != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="279" href="#279">279</a> <strong class="jxr_keyword">final</strong> String toMatch = String.format(<span class="jxr_string">"CWE-%s "</span>, entry);
<a class="jxr_linenumber" name="280" href="#280">280</a> <strong class="jxr_keyword">final</strong> String toTest = v.getCwe().substring(0, toMatch.length()).toUpperCase();
<a class="jxr_linenumber" name="281" href="#281">281</a> <strong class="jxr_keyword">if</strong> (toTest.equals(toMatch)) {
<a class="jxr_linenumber" name="282" href="#282">282</a> remove = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="283" href="#283">283</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="284" href="#284">284</a> }
<a class="jxr_linenumber" name="285" href="#285">285</a> }
<a class="jxr_linenumber" name="286" href="#286">286</a> }
<a class="jxr_linenumber" name="287" href="#287">287</a> }
<a class="jxr_linenumber" name="288" href="#288">288</a> <strong class="jxr_keyword">if</strong> (!remove) {
<a class="jxr_linenumber" name="289" href="#289">289</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">float</strong> cvss : <strong class="jxr_keyword">this</strong>.cvssBelow) {
<a class="jxr_linenumber" name="290" href="#290">290</a> <strong class="jxr_keyword">if</strong> (v.getCvssScore() &lt; cvss) {
<a class="jxr_linenumber" name="291" href="#291">291</a> remove = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="292" href="#292">292</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="293" href="#293">293</a> }
<a class="jxr_linenumber" name="294" href="#294">294</a> }
<a class="jxr_linenumber" name="295" href="#295">295</a> }
<a class="jxr_linenumber" name="296" href="#296">296</a> <strong class="jxr_keyword">if</strong> (remove) {
<a class="jxr_linenumber" name="297" href="#297">297</a> itr.remove();
<a class="jxr_linenumber" name="298" href="#298">298</a> }
<a class="jxr_linenumber" name="299" href="#299">299</a> }
<a class="jxr_linenumber" name="300" href="#300">300</a> }
<a class="jxr_linenumber" name="301" href="#301">301</a> }
<a class="jxr_linenumber" name="302" href="#302">302</a>
<a class="jxr_linenumber" name="303" href="#303">303</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="304" href="#304">304</a> <em class="jxr_javadoccomment"> * Identifies if the cpe specified by the cpe suppression rule does not</em>
<a class="jxr_linenumber" name="305" href="#305">305</a> <em class="jxr_javadoccomment"> * specify a version.</em>
<a class="jxr_linenumber" name="306" href="#306">306</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="307" href="#307">307</a> <em class="jxr_javadoccomment"> * @param c a suppression rule identifier</em>
<a class="jxr_linenumber" name="308" href="#308">308</a> <em class="jxr_javadoccomment"> * @return true if the property type does not specify a version; otherwise</em>
<a class="jxr_linenumber" name="309" href="#309">309</a> <em class="jxr_javadoccomment"> * false</em>
<a class="jxr_linenumber" name="310" href="#310">310</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="311" href="#311">311</a> <strong class="jxr_keyword">boolean</strong> cpeHasNoVersion(<a href="../../../../org/owasp/dependencycheck/suppression/PropertyType.html">PropertyType</a> c) {
<a class="jxr_linenumber" name="312" href="#312">312</a> <strong class="jxr_keyword">if</strong> (c.isRegex()) {
<a class="jxr_linenumber" name="313" href="#313">313</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="314" href="#314">314</a> } <em class="jxr_comment">// cpe:/a:jboss:jboss:1.0.0:</em>
<a class="jxr_linenumber" name="315" href="#315">315</a> <strong class="jxr_keyword">if</strong> (countCharacter(c.getValue(), ':') == 3) {
<a class="jxr_linenumber" name="316" href="#316">316</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="317" href="#317">317</a> }
<a class="jxr_linenumber" name="318" href="#318">318</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="319" href="#319">319</a> }
<a class="jxr_linenumber" name="320" href="#320">320</a>
<a class="jxr_linenumber" name="321" href="#321">321</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="322" href="#322">322</a> <em class="jxr_javadoccomment"> * Counts the number of occurrences of the character found within the</em>
<a class="jxr_linenumber" name="323" href="#323">323</a> <em class="jxr_javadoccomment"> * string.</em>
<a class="jxr_linenumber" name="324" href="#324">324</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="325" href="#325">325</a> <em class="jxr_javadoccomment"> * @param str the string to check</em>
<a class="jxr_linenumber" name="326" href="#326">326</a> <em class="jxr_javadoccomment"> * @param c the character to count</em>
<a class="jxr_linenumber" name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * @return the number of times the character is found in the string</em>
<a class="jxr_linenumber" name="328" href="#328">328</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="329" href="#329">329</a> <strong class="jxr_keyword">int</strong> countCharacter(String str, <strong class="jxr_keyword">char</strong> c) {
<a class="jxr_linenumber" name="330" href="#330">330</a> <strong class="jxr_keyword">int</strong> count = 0;
<a class="jxr_linenumber" name="331" href="#331">331</a> <strong class="jxr_keyword">int</strong> pos = str.indexOf(c) + 1;
<a class="jxr_linenumber" name="332" href="#332">332</a> <strong class="jxr_keyword">while</strong> (pos &gt; 0) {
<a class="jxr_linenumber" name="333" href="#333">333</a> count += 1;
<a class="jxr_linenumber" name="334" href="#334">334</a> pos = str.indexOf(c, pos) + 1;
<a class="jxr_linenumber" name="335" href="#335">335</a> }
<a class="jxr_linenumber" name="336" href="#336">336</a> <strong class="jxr_keyword">return</strong> count;
<a class="jxr_linenumber" name="337" href="#337">337</a> }
<a class="jxr_linenumber" name="338" href="#338">338</a>
<a class="jxr_linenumber" name="339" href="#339">339</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="340" href="#340">340</a> <em class="jxr_javadoccomment"> * Determines if the cpeEntry specified as a PropertyType matches the given</em>
<a class="jxr_linenumber" name="341" href="#341">341</a> <em class="jxr_javadoccomment"> * Identifier.</em>
<a class="jxr_linenumber" name="342" href="#342">342</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="343" href="#343">343</a> <em class="jxr_javadoccomment"> * @param cpeEntry a suppression rule entry</em>
<a class="jxr_linenumber" name="344" href="#344">344</a> <em class="jxr_javadoccomment"> * @param identifier a CPE identifier to check</em>
<a class="jxr_linenumber" name="345" href="#345">345</a> <em class="jxr_javadoccomment"> * @return true if the entry matches; otherwise false</em>
<a class="jxr_linenumber" name="346" href="#346">346</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="347" href="#347">347</a> <strong class="jxr_keyword">boolean</strong> cpeMatches(<a href="../../../../org/owasp/dependencycheck/suppression/PropertyType.html">PropertyType</a> cpeEntry, <a href="../../../../org/owasp/dependencycheck/dependency/Identifier.html">Identifier</a> identifier) {
<a class="jxr_linenumber" name="348" href="#348">348</a> <strong class="jxr_keyword">if</strong> (cpeEntry.matches(identifier.getValue())) {
<a class="jxr_linenumber" name="349" href="#349">349</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="350" href="#350">350</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (cpeHasNoVersion(cpeEntry)) {
<a class="jxr_linenumber" name="351" href="#351">351</a> <strong class="jxr_keyword">if</strong> (cpeEntry.isCaseSensitive()) {
<a class="jxr_linenumber" name="352" href="#352">352</a> <strong class="jxr_keyword">if</strong> (identifier.getValue().startsWith(cpeEntry.getValue())) {
<a class="jxr_linenumber" name="353" href="#353">353</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="354" href="#354">354</a> }
<a class="jxr_linenumber" name="355" href="#355">355</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="356" href="#356">356</a> <strong class="jxr_keyword">final</strong> String id = identifier.getValue().toLowerCase();
<a class="jxr_linenumber" name="357" href="#357">357</a> <strong class="jxr_keyword">final</strong> String check = cpeEntry.getValue().toLowerCase();
<a class="jxr_linenumber" name="358" href="#358">358</a> <strong class="jxr_keyword">if</strong> (id.startsWith(check)) {
<a class="jxr_linenumber" name="359" href="#359">359</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="360" href="#360">360</a> }
<a class="jxr_linenumber" name="361" href="#361">361</a> }
<a class="jxr_linenumber" name="362" href="#362">362</a> }
<a class="jxr_linenumber" name="363" href="#363">363</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="364" href="#364">364</a> }
<a class="jxr_linenumber" name="365" href="#365">365</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

39
dependency-check-core/xref/org/owasp/dependencycheck/suppression/package-frame.html Normal file
View File

@@ -0,0 +1,39 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Dependency-Check Core 1.0.6 Reference Package org.owasp.dependencycheck.suppression</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
</head>
<body>
<h3>
<a href="package-summary.html" target="classFrame">org.owasp.dependencycheck.suppression</a>
</h3>
<h3>Classes</h3>
<ul>
<li>
<a href="PropertyType.html" target="classFrame">PropertyType</a>
</li>
<li>
<a href="SuppressionErrorHandler.html" target="classFrame">SuppressionErrorHandler</a>
</li>
<li>
<a href="SuppressionHandler.html" target="classFrame">SuppressionHandler</a>
</li>
<li>
<a href="SuppressionParseException.html" target="classFrame">SuppressionParseException</a>
</li>
<li>
<a href="SuppressionParser.html" target="classFrame">SuppressionParser</a>
</li>
<li>
<a href="SuppressionRule.html" target="classFrame">SuppressionRule</a>
</li>
</ul>
</body>
</html>

92
dependency-check-core/xref/org/owasp/dependencycheck/suppression/package-summary.html Normal file
View File

@@ -0,0 +1,92 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Dependency-Check Core 1.0.6 Reference Package org.owasp.dependencycheck.suppression</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
</head>
<body>
<div class="overview">
<ul>
<li>
<a href="../../../../overview-summary.html">Overview</a>
</li>
<li class="selected">Package</li>
</ul>
</div>
<div class="framenoframe">
<ul>
<li>
<a href="../../../../index.html" target="_top">FRAMES</a>
</li>
<li>
<a href="package-summary.html" target="_top">NO FRAMES</a>
</li>
</ul>
</div>
<h2>Package org.owasp.dependencycheck.suppression</h2>
<table class="summary">
<thead>
<tr>
<th>Class Summary</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="PropertyType.html" target="classFrame">PropertyType</a>
</td>
</tr>
<tr>
<td>
<a href="SuppressionErrorHandler.html" target="classFrame">SuppressionErrorHandler</a>
</td>
</tr>
<tr>
<td>
<a href="SuppressionHandler.html" target="classFrame">SuppressionHandler</a>
</td>
</tr>
<tr>
<td>
<a href="SuppressionParseException.html" target="classFrame">SuppressionParseException</a>
</td>
</tr>
<tr>
<td>
<a href="SuppressionParser.html" target="classFrame">SuppressionParser</a>
</td>
</tr>
<tr>
<td>
<a href="SuppressionRule.html" target="classFrame">SuppressionRule</a>
</td>
</tr>
</tbody>
</table>
<div class="overview">
<ul>
<li>
<a href="../../../../overview-summary.html">Overview</a>
</li>
<li class="selected">Package</li>
</ul>
</div>
<div class="framenoframe">
<ul>
<li>
<a href="../../../../index.html" target="_top">FRAMES</a>
</li>
<li>
<a href="package-summary.html" target="_top">NO FRAMES</a>
</li>
</ul>
</div>
<hr />
Copyright &#169; 2012-2013 OWASP. All Rights Reserved.
</body>
</html>