Files
wpscan/doc_yard/Vulnerability.html
Christian Mehlmauer a38c709d74 Updated documentation
2013-04-30 23:06:37 +02:00

808 lines
19 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: Vulnerability
&mdash; Documentation by YARD 0.8.6.1
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '';
framesUrl = "frames.html#!" + escape(window.location.href);
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="_index.html">Index (V)</a> &raquo;
<span class="title">Vulnerability</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Vulnerability
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Vulnerability</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2">Includes:</dt>
<dd class="r2"><span class='object_link'><a href="Vulnerability/Output.html" title="Vulnerability::Output (module)">Output</a></span></dd>
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/common/models/vulnerability.rb<span class="defines">,<br />
lib/common/models/vulnerability/output.rb</span>
</dd>
</dl>
<div class="clear"></div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Vulnerability/Output.html" title="Vulnerability::Output (module)">Output</a></span>
</p>
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#metasploit_modules-instance_method" title="#metasploit_modules (instance method)">- (Object) <strong>metasploit_modules</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute metasploit_modules.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#references-instance_method" title="#references (instance method)">- (Object) <strong>references</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute references.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#title-instance_method" title="#title (instance method)">- (Object) <strong>title</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute title.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#type-instance_method" title="#type (instance method)">- (Object) <strong>type</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute type.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#load_from_xml_node-class_method" title="load_from_xml_node (class method)">+ (Vulnerability) <strong>load_from_xml_node</strong>(xml_node) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Create the Vulnerability from the xml_node.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#%3D%3D-instance_method" title="#== (instance method)">- (Boolean) <strong>==</strong>(other) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>:nocov:.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Vulnerability) <strong>initialize</strong>(title, type, references, metasploit_modules = []) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="Vulnerability/Output.html" title="Vulnerability::Output (module)">Output</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Vulnerability/Output.html#metasploit_module_url-class_method" title="Vulnerability::Output.metasploit_module_url (method)">metasploit_module_url</a></span>, <span class='object_link'><a href="Vulnerability/Output.html#output-instance_method" title="Vulnerability::Output#output (method)">#output</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="Vulnerability (class)">Vulnerability</a></span></tt>) <strong>initialize</strong>(title, type, references, metasploit_modules = [])
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>title</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The title of the vulnerability</p>
</div>
</li>
<li>
<span class='name'>type</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The type of the vulnerability</p>
</div>
</li>
<li>
<span class='name'>references</span>
<span class='type'>(<tt><span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>References urls</p>
</div>
</li>
<li>
<span class='name'>metasploit_modules</span>
<span class='type'>(<tt><span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span></tt>)</span>
<em class="default">(defaults to: <tt>[]</tt>)</em>
&mdash;
<div class='inline'>
<p>Metasploit modules for the vulnerability</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/vulnerability.rb', line 17</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_title'>title</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_references'>references</span><span class='comma'>,</span> <span class='id identifier rubyid_metasploit_modules'>metasploit_modules</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='ivar'>@title</span> <span class='op'>=</span> <span class='id identifier rubyid_title'>title</span>
<span class='ivar'>@type</span> <span class='op'>=</span> <span class='id identifier rubyid_type'>type</span>
<span class='ivar'>@references</span> <span class='op'>=</span> <span class='id identifier rubyid_references'>references</span>
<span class='ivar'>@metasploit_modules</span> <span class='op'>=</span> <span class='id identifier rubyid_metasploit_modules'>metasploit_modules</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="metasploit_modules=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="metasploit_modules-instance_method">
- (<tt>Object</tt>) <strong>metasploit_modules</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute metasploit_modules</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/vulnerability.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_metasploit_modules'>metasploit_modules</span>
<span class='ivar'>@metasploit_modules</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="references=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="references-instance_method">
- (<tt>Object</tt>) <strong>references</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute references</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/vulnerability.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_references'>references</span>
<span class='ivar'>@references</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="title=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="title-instance_method">
- (<tt>Object</tt>) <strong>title</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute title</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/vulnerability.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_title'>title</span>
<span class='ivar'>@title</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="type=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="type-instance_method">
- (<tt>Object</tt>) <strong>type</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute type</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/vulnerability.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
<span class='ivar'>@type</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="load_from_xml_node-class_method">
+ (<tt><span class='object_link'><a href="" title="Vulnerability (class)">Vulnerability</a></span></tt>) <strong>load_from_xml_node</strong>(xml_node)
</h3><div class="docstring">
<div class="discussion">
<p>Create the Vulnerability from the xml_node</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>xml_node</span>
<span class='type'>(<tt>Nokogiri::XML::Node</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Vulnerability (class)">Vulnerability</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
38
39
40
41
42
43
44
45</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/vulnerability.rb', line 38</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load_from_xml_node'>load_from_xml_node</span><span class='lparen'>(</span><span class='id identifier rubyid_xml_node'>xml_node</span><span class='rparen'>)</span>
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
<span class='id identifier rubyid_xml_node'>xml_node</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>title</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_text'>text</span><span class='comma'>,</span>
<span class='id identifier rubyid_xml_node'>xml_node</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>type</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_text'>text</span><span class='comma'>,</span>
<span class='id identifier rubyid_xml_node'>xml_node</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>reference</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:text</span><span class='rparen'>)</span><span class='comma'>,</span>
<span class='id identifier rubyid_xml_node'>xml_node</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>metasploit</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:text</span><span class='rparen'>)</span>
<span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="==-instance_method">
- (<tt>Boolean</tt>) <strong>==</strong>(other)
</h3><div class="docstring">
<div class="discussion">
<p>:nocov:</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>other</span>
<span class='type'>(<tt><span class='object_link'><a href="" title="Vulnerability (class)">Vulnerability</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/common/models/vulnerability.rb', line 28</span>
<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
<span class='id identifier rubyid_title'>title</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_title'>title</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_references'>references</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_references'>references</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 30 23:05:06 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.6.1 (ruby-1.9.3).
</div>
</body>
</html>