documentation update v1.4.4

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

View File

@@ -46,151 +46,158 @@
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.xml.sax.SAXException;
<a class="jxr_linenumber" name="L39" href="#L39">39</a>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * A callable task that will process a given set of NVD CVE xml files and update the Cve Database accordingly.</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/ProcessTask.html">ProcessTask</a> <strong class="jxr_keyword">implements</strong> Callable&lt;ProcessTask&gt; {
<a class="jxr_linenumber" name="L46" href="#L46">46</a>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * The logger.</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = LoggerFactory.getLogger(ProcessTask.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * A field to store any update exceptions that occur during the "call".</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a> exception = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L55" href="#L55">55</a>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * Get the value of exception.</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * @return the value of exception</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a> getException() {
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">return</strong> exception;
<a class="jxr_linenumber" name="L63" href="#L63">63</a> }
<a class="jxr_linenumber" name="L64" href="#L64">64</a>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * Set the value of exception.</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * @param exception new value of exception</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setException(<a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a> exception) {
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">this</strong>.exception = exception;
<a class="jxr_linenumber" name="L72" href="#L72">72</a> }
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * A reference to the CveDB.</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/owasp/dependencycheck/data/nvdcve/CveDB.html">CveDB</a> cveDB;
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * A reference to the callable download task.</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/DownloadTask.html">DownloadTask</a> filePair;
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * A reference to the properties.</em>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/owasp/dependencycheck/data/nvdcve/DatabaseProperties.html">DatabaseProperties</a> properties;
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * A reference to the global settings object.</em>
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/owasp/dependencycheck/utils/Settings.html">Settings</a> settings;
<a class="jxr_linenumber" name="L89" href="#L89">89</a>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * Constructs a new ProcessTask used to process an NVD CVE update.</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * @param cveDB the data store object</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @param filePair the download task that contains the URL references to download</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @param settings a reference to the global settings object; this is necessary so that when the thread is started the</em>
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * dependencies have a correct reference to the global settings.</em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/ProcessTask.html">ProcessTask</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/owasp/dependencycheck/data/nvdcve/CveDB.html">CveDB</a> cveDB, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/DownloadTask.html">DownloadTask</a> filePair, <a href="../../../../../../org/owasp/dependencycheck/utils/Settings.html">Settings</a> settings) {
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">this</strong>.cveDB = cveDB;
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">this</strong>.filePair = filePair;
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">this</strong>.properties = cveDB.getDatabaseProperties();
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">this</strong>.settings = settings;
<a class="jxr_linenumber" name="L103" href="#L103">103</a> }
<a class="jxr_linenumber" name="L104" href="#L104">104</a>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * Implements the callable interface.</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * @return this object</em>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @throws Exception thrown if there is an exception; note that any UpdateExceptions are simply added to the tasks exception</em>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * collection</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> @Override
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/ProcessTask.html">ProcessTask</a> call() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L115" href="#L115">115</a> Settings.setInstance(settings);
<a class="jxr_linenumber" name="L116" href="#L116">116</a> processFiles();
<a class="jxr_linenumber" name="L117" href="#L117">117</a> } <strong class="jxr_keyword">catch</strong> (UpdateException ex) {
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">this</strong>.exception = ex;
<a class="jxr_linenumber" name="L119" href="#L119">119</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L120" href="#L120">120</a> Settings.cleanup(false);
<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="L123" href="#L123">123</a> }
<a class="jxr_linenumber" name="L124" href="#L124">124</a>
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * Imports the NVD CVE XML File into the Lucene Index.</em>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * @param file the file containing the NVD CVE XML</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * @param oldVersion contains the file containing the NVD CVE XML 1.2</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * @throws ParserConfigurationException is thrown if there is a parser configuration exception</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * @throws SAXException is thrown if there is a SAXException</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * @throws IOException is thrown if there is a IO Exception</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * @throws SQLException is thrown if there is a SQL exception</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @throws DatabaseException is thrown if there is a database exception</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * @throws ClassNotFoundException thrown if the h2 database driver cannot be loaded</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> importXML(File file, File oldVersion) <strong class="jxr_keyword">throws</strong> ParserConfigurationException,
<a class="jxr_linenumber" name="L138" href="#L138">138</a> SAXException, IOException, SQLException, DatabaseException, ClassNotFoundException {
<a class="jxr_linenumber" name="L139" href="#L139">139</a>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">final</strong> SAXParserFactory factory = SAXParserFactory.newInstance();
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">final</strong> SAXParser saxParser = factory.newSAXParser();
<a class="jxr_linenumber" name="L142" href="#L142">142</a>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/NvdCve12Handler.html">NvdCve12Handler</a> cve12Handler = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/NvdCve12Handler.html">NvdCve12Handler</a>();
<a class="jxr_linenumber" name="L144" href="#L144">144</a> saxParser.parse(oldVersion, cve12Handler);
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">final</strong> Map&lt;String, List&lt;VulnerableSoftware&gt;&gt; prevVersionVulnMap = cve12Handler.getVulnerabilities();
<a class="jxr_linenumber" name="L146" href="#L146">146</a>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/NvdCve20Handler.html">NvdCve20Handler</a> cve20Handler = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/NvdCve20Handler.html">NvdCve20Handler</a>();
<a class="jxr_linenumber" name="L148" href="#L148">148</a> cve20Handler.setCveDB(cveDB);
<a class="jxr_linenumber" name="L149" href="#L149">149</a> cve20Handler.setPrevVersionVulnMap(prevVersionVulnMap);
<a class="jxr_linenumber" name="L150" href="#L150">150</a> saxParser.parse(file, cve20Handler);
<a class="jxr_linenumber" name="L151" href="#L151">151</a> }
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * A callable task that will process a given set of NVD CVE xml files and update</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * the Cve Database accordingly.</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/ProcessTask.html">ProcessTask</a> <strong class="jxr_keyword">implements</strong> Callable&lt;ProcessTask&gt; {
<a class="jxr_linenumber" name="L47" href="#L47">47</a>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * The logger.</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = LoggerFactory.getLogger(ProcessTask.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * A field to store any update exceptions that occur during the "call".</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a> exception = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L56" href="#L56">56</a>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * Get the value of exception.</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @return the value of exception</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a> getException() {
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">return</strong> exception;
<a class="jxr_linenumber" name="L64" href="#L64">64</a> }
<a class="jxr_linenumber" name="L65" href="#L65">65</a>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * Set the value of exception.</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * @param exception new value of exception</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setException(<a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a> exception) {
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">this</strong>.exception = exception;
<a class="jxr_linenumber" name="L73" href="#L73">73</a> }
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * A reference to the CveDB.</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/owasp/dependencycheck/data/nvdcve/CveDB.html">CveDB</a> cveDB;
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * A reference to the callable download task.</em>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/DownloadTask.html">DownloadTask</a> filePair;
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * A reference to the properties.</em>
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/owasp/dependencycheck/data/nvdcve/DatabaseProperties.html">DatabaseProperties</a> properties;
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * A reference to the global settings object.</em>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/owasp/dependencycheck/utils/Settings.html">Settings</a> settings;
<a class="jxr_linenumber" name="L90" href="#L90">90</a>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * Constructs a new ProcessTask used to process an NVD CVE update.</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @param cveDB the data store object</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @param filePair the download task that contains the URL references to</em>
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * download</em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @param settings a reference to the global settings object; this is</em>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * necessary so that when the thread is started the dependencies have a</em>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * correct reference to the global settings.</em>
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/ProcessTask.html">ProcessTask</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/owasp/dependencycheck/data/nvdcve/CveDB.html">CveDB</a> cveDB, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/DownloadTask.html">DownloadTask</a> filePair, <a href="../../../../../../org/owasp/dependencycheck/utils/Settings.html">Settings</a> settings) {
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">this</strong>.cveDB = cveDB;
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">this</strong>.filePair = filePair;
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">this</strong>.properties = cveDB.getDatabaseProperties();
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">this</strong>.settings = settings;
<a class="jxr_linenumber" name="L106" href="#L106">106</a> }
<a class="jxr_linenumber" name="L107" href="#L107">107</a>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * Implements the callable interface.</em>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * @return this object</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * @throws Exception thrown if there is an exception; note that any</em>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * UpdateExceptions are simply added to the tasks exception collection</em>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> @Override
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/ProcessTask.html">ProcessTask</a> call() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L118" href="#L118">118</a> Settings.setInstance(settings);
<a class="jxr_linenumber" name="L119" href="#L119">119</a> processFiles();
<a class="jxr_linenumber" name="L120" href="#L120">120</a> } <strong class="jxr_keyword">catch</strong> (UpdateException ex) {
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">this</strong>.exception = ex;
<a class="jxr_linenumber" name="L122" href="#L122">122</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L123" href="#L123">123</a> Settings.cleanup(false);
<a class="jxr_linenumber" name="L124" href="#L124">124</a> }
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="L126" href="#L126">126</a> }
<a class="jxr_linenumber" name="L127" href="#L127">127</a>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * Imports the NVD CVE XML File into the Lucene Index.</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * @param file the file containing the NVD CVE XML</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * @param oldVersion contains the file containing the NVD CVE XML 1.2</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * @throws ParserConfigurationException is thrown if there is a parser</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * configuration exception</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * @throws SAXException is thrown if there is a SAXException</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * @throws IOException is thrown if there is a IO Exception</em>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * @throws SQLException is thrown if there is a SQL exception</em>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * @throws DatabaseException is thrown if there is a database exception</em>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * @throws ClassNotFoundException thrown if the h2 database driver cannot be</em>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * loaded</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> importXML(File file, File oldVersion) <strong class="jxr_keyword">throws</strong> ParserConfigurationException,
<a class="jxr_linenumber" name="L143" href="#L143">143</a> SAXException, IOException, SQLException, DatabaseException, ClassNotFoundException {
<a class="jxr_linenumber" name="L144" href="#L144">144</a>
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">final</strong> SAXParserFactory factory = SAXParserFactory.newInstance();
<a class="jxr_linenumber" name="L146" href="#L146">146</a> factory.setFeature(<span class="jxr_string">"http://apache.org/xml/features/disallow-doctype-decl"</span>, <strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">final</strong> SAXParser saxParser = factory.newSAXParser();
<a class="jxr_linenumber" name="L148" href="#L148">148</a>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/NvdCve12Handler.html">NvdCve12Handler</a> cve12Handler = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/NvdCve12Handler.html">NvdCve12Handler</a>();
<a class="jxr_linenumber" name="L150" href="#L150">150</a> saxParser.parse(oldVersion, cve12Handler);
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">final</strong> Map&lt;String, List&lt;VulnerableSoftware&gt;&gt; prevVersionVulnMap = cve12Handler.getVulnerabilities();
<a class="jxr_linenumber" name="L152" href="#L152">152</a>
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * Processes the NVD CVE XML file and imports the data into the DB.</em>
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * @throws UpdateException thrown if there is an error loading the data into the database</em>
<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> processFiles() <strong class="jxr_keyword">throws</strong> UpdateException {
<a class="jxr_linenumber" name="L159" href="#L159">159</a> LOGGER.info(<span class="jxr_string">"Processing Started for NVD CVE - {}"</span>, filePair.getNvdCveInfo().getId());
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> startProcessing = System.currentTimeMillis();
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L162" href="#L162">162</a> importXML(filePair.getFirst(), filePair.getSecond());
<a class="jxr_linenumber" name="L163" href="#L163">163</a> cveDB.commit();
<a class="jxr_linenumber" name="L164" href="#L164">164</a> properties.save(filePair.getNvdCveInfo());
<a class="jxr_linenumber" name="L165" href="#L165">165</a> } <strong class="jxr_keyword">catch</strong> (FileNotFoundException ex) {
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a>(ex);
<a class="jxr_linenumber" name="L167" href="#L167">167</a> } <strong class="jxr_keyword">catch</strong> (ParserConfigurationException ex) {
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a>(ex);
<a class="jxr_linenumber" name="L169" href="#L169">169</a> } <strong class="jxr_keyword">catch</strong> (SAXException ex) {
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a>(ex);
<a class="jxr_linenumber" name="L171" href="#L171">171</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a>(ex);
<a class="jxr_linenumber" name="L173" href="#L173">173</a> } <strong class="jxr_keyword">catch</strong> (SQLException ex) {
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a>(ex);
<a class="jxr_linenumber" name="L175" href="#L175">175</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a>(ex);
<a class="jxr_linenumber" name="L177" href="#L177">177</a> } <strong class="jxr_keyword">catch</strong> (ClassNotFoundException ex) {
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a>(ex);
<a class="jxr_linenumber" name="L179" href="#L179">179</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L180" href="#L180">180</a> filePair.cleanup();
<a class="jxr_linenumber" name="L181" href="#L181">181</a> }
<a class="jxr_linenumber" name="L182" href="#L182">182</a> LOGGER.info(<span class="jxr_string">"Processing Complete for NVD CVE - {} ({} ms)"</span>, filePair.getNvdCveInfo().getId(),
<a class="jxr_linenumber" name="L183" href="#L183">183</a> System.currentTimeMillis() - startProcessing);
<a class="jxr_linenumber" name="L184" href="#L184">184</a> }
<a class="jxr_linenumber" name="L185" href="#L185">185</a> }
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/NvdCve20Handler.html">NvdCve20Handler</a> cve20Handler = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/nvd/NvdCve20Handler.html">NvdCve20Handler</a>();
<a class="jxr_linenumber" name="L154" href="#L154">154</a> cve20Handler.setCveDB(cveDB);
<a class="jxr_linenumber" name="L155" href="#L155">155</a> cve20Handler.setPrevVersionVulnMap(prevVersionVulnMap);
<a class="jxr_linenumber" name="L156" href="#L156">156</a> saxParser.parse(file, cve20Handler);
<a class="jxr_linenumber" name="L157" href="#L157">157</a> }
<a class="jxr_linenumber" name="L158" href="#L158">158</a>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * Processes the NVD CVE XML file and imports the data into the DB.</em>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * @throws UpdateException thrown if there is an error loading the data into</em>
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * the database</em>
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> processFiles() <strong class="jxr_keyword">throws</strong> UpdateException {
<a class="jxr_linenumber" name="L166" href="#L166">166</a> LOGGER.info(<span class="jxr_string">"Processing Started for NVD CVE - {}"</span>, filePair.getNvdCveInfo().getId());
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> startProcessing = System.currentTimeMillis();
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L169" href="#L169">169</a> importXML(filePair.getFirst(), filePair.getSecond());
<a class="jxr_linenumber" name="L170" href="#L170">170</a> cveDB.commit();
<a class="jxr_linenumber" name="L171" href="#L171">171</a> properties.save(filePair.getNvdCveInfo());
<a class="jxr_linenumber" name="L172" href="#L172">172</a> } <strong class="jxr_keyword">catch</strong> (FileNotFoundException ex) {
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a>(ex);
<a class="jxr_linenumber" name="L174" href="#L174">174</a> } <strong class="jxr_keyword">catch</strong> (ParserConfigurationException ex) {
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a>(ex);
<a class="jxr_linenumber" name="L176" href="#L176">176</a> } <strong class="jxr_keyword">catch</strong> (SAXException ex) {
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a>(ex);
<a class="jxr_linenumber" name="L178" href="#L178">178</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a>(ex);
<a class="jxr_linenumber" name="L180" href="#L180">180</a> } <strong class="jxr_keyword">catch</strong> (SQLException ex) {
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a>(ex);
<a class="jxr_linenumber" name="L182" href="#L182">182</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a>(ex);
<a class="jxr_linenumber" name="L184" href="#L184">184</a> } <strong class="jxr_keyword">catch</strong> (ClassNotFoundException ex) {
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/owasp/dependencycheck/data/update/exception/UpdateException.html">UpdateException</a>(ex);
<a class="jxr_linenumber" name="L186" href="#L186">186</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L187" href="#L187">187</a> filePair.cleanup();
<a class="jxr_linenumber" name="L188" href="#L188">188</a> }
<a class="jxr_linenumber" name="L189" href="#L189">189</a> LOGGER.info(<span class="jxr_string">"Processing Complete for NVD CVE - {} ({} ms)"</span>, filePair.getNvdCveInfo().getId(),
<a class="jxr_linenumber" name="L190" href="#L190">190</a> System.currentTimeMillis() - startProcessing);
<a class="jxr_linenumber" name="L191" href="#L191">191</a> }
<a class="jxr_linenumber" name="L192" href="#L192">192</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2012&#x2013;2016 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>

View File

@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Dependency-Check 1.4.3 Reference Package org.owasp.dependencycheck.data.update.nvd</title>
<title>Dependency-Check 1.4.4 Reference Package org.owasp.dependencycheck.data.update.nvd</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
</head>
<body>

View File

@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Dependency-Check 1.4.3 Reference Package org.owasp.dependencycheck.data.update.nvd</title>
<title>Dependency-Check 1.4.4 Reference Package org.owasp.dependencycheck.data.update.nvd</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
</head>
<body>