infosecn1nja
/
metasploit-framework
mirror of https://github.com/infosecn1nja/metasploit-framework.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Reboot gh-pages

gh-pages
Metasploit 2019-04-23 22:44:32 -07:00
commit 1431f7c953
1849 changed files with 1534821 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

290
api/ApiDocsServlet.html Normal file
View File

@ -0,0 +1,290 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: ApiDocsServlet
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "ApiDocsServlet";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (A)</a> &raquo;
<span class="title">ApiDocsServlet</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: ApiDocsServlet
</h1>
<div class="box_info">
<dl>
<dt>Includes:</dt>
<dd>Swagger::Blocks</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/servlet/api_docs_servlet.rb</dd>
</dl>
</div>
<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="#html_path-class_method" title="html_path (class method)">.<strong>html_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#json_path-class_method" title="json_path (class method)">.<strong>json_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#registered-class_method" title="registered (class method)">.<strong>registered</strong>(app) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="html_path-class_method">
.<strong>html_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/api_docs_servlet.rb', line 32</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_html_path'>html_path</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api/v1/api-docs</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="json_path-class_method">
.<strong>json_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/api_docs_servlet.rb', line 28</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_json_path'>json_path</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api/v1/api-docs.json</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="registered-class_method">
.<strong>registered</strong>(app) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
36
37
38
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/api_docs_servlet.rb', line 36</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_registered'>registered</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='rparen'>)</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='const'><span class='object_link'><a href="" title="ApiDocsServlet (module)">ApiDocsServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_json_path'><span class='object_link'><a href="#json_path-class_method" title="ApiDocsServlet.json_path (method)">json_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_get_api_docs'>get_api_docs</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='const'><span class='object_link'><a href="" title="ApiDocsServlet (module)">ApiDocsServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_html_path'><span class='object_link'><a href="#html_path-class_method" title="ApiDocsServlet.html_path (method)">html_path</a></span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_erb'>erb</span> <span class='symbol'>:api_docs</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:35:57 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

500
api/AuthServlet.html Normal file
View File

@ -0,0 +1,500 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: AuthServlet
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "AuthServlet";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (A)</a> &raquo;
<span class="title">AuthServlet</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: AuthServlet
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/servlet/auth_servlet.rb</dd>
</dl>
</div>
<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="#api_account_path-class_method" title="api_account_path (class method)">.<strong>api_account_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#api_generate_token_path-class_method" title="api_generate_token_path (class method)">.<strong>api_generate_token_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#api_login_path-class_method" title="api_login_path (class method)">.<strong>api_login_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#api_logout_path-class_method" title="api_logout_path (class method)">.<strong>api_logout_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#api_path-class_method" title="api_path (class method)">.<strong>api_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#api_unauthenticated_path-class_method" title="api_unauthenticated_path (class method)">.<strong>api_unauthenticated_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#registered-class_method" title="registered (class method)">.<strong>registered</strong>(app) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="api_account_path-class_method">
.<strong>api_account_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/auth_servlet.rb', line 7</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_account_path'>api_account_path</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="" title="AuthServlet (module)">AuthServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="AuthServlet.api_path (method)">api_path</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/account</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="api_generate_token_path-class_method">
.<strong>api_generate_token_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/auth_servlet.rb', line 19</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_generate_token_path'>api_generate_token_path</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="" title="AuthServlet (module)">AuthServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="AuthServlet.api_path (method)">api_path</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/generate-token</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="api_login_path-class_method">
.<strong>api_login_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/auth_servlet.rb', line 11</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_login_path'>api_login_path</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="" title="AuthServlet (module)">AuthServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="AuthServlet.api_path (method)">api_path</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/login</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="api_logout_path-class_method">
.<strong>api_logout_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/auth_servlet.rb', line 15</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_logout_path'>api_logout_path</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="" title="AuthServlet (module)">AuthServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="AuthServlet.api_path (method)">api_path</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/logout</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="api_path-class_method">
.<strong>api_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/auth_servlet.rb', line 3</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_path'>api_path</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api/v1/auth</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="api_unauthenticated_path-class_method">
.<strong>api_unauthenticated_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/auth_servlet.rb', line 23</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_unauthenticated_path'>api_unauthenticated_path</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="" title="AuthServlet (module)">AuthServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="AuthServlet.api_path (method)">api_path</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/unauthenticated</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="registered-class_method">
.<strong>registered</strong>(app) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29
30
31
32
33
34
35
36</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/auth_servlet.rb', line 27</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_registered'>registered</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='rparen'>)</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='const'><span class='object_link'><a href="" title="AuthServlet (module)">AuthServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_account_path'><span class='object_link'><a href="#api_account_path-class_method" title="AuthServlet.api_account_path (method)">api_account_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_get_api_account'>get_api_account</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='const'><span class='object_link'><a href="" title="AuthServlet (module)">AuthServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_login_path'><span class='object_link'><a href="#api_login_path-class_method" title="AuthServlet.api_login_path (method)">api_login_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_get_login'>get_login</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span> <span class='const'><span class='object_link'><a href="" title="AuthServlet (module)">AuthServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_login_path'><span class='object_link'><a href="#api_login_path-class_method" title="AuthServlet.api_login_path (method)">api_login_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_post_login'>post_login</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='const'><span class='object_link'><a href="" title="AuthServlet (module)">AuthServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_logout_path'><span class='object_link'><a href="#api_logout_path-class_method" title="AuthServlet.api_logout_path (method)">api_logout_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_get_logout'>get_logout</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span> <span class='const'><span class='object_link'><a href="" title="AuthServlet (module)">AuthServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_generate_token_path'><span class='object_link'><a href="#api_generate_token_path-class_method" title="AuthServlet.api_generate_token_path (method)">api_generate_token_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_post_generate_token'>post_generate_token</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="" title="AuthServlet (module)">AuthServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_unauthenticated_path'><span class='object_link'><a href="#api_unauthenticated_path-class_method" title="AuthServlet.api_unauthenticated_path (method)">api_unauthenticated_path</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/?:scope?</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_post_unauthenticated'>post_unauthenticated</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:35:26 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

128
api/Authentication.html Normal file
View File

@ -0,0 +1,128 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Authentication
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Authentication";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (A)</a> &raquo;
<span class="title">Authentication</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Authentication
</h1>
<div class="box_info">
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="Authentication/Strategies.html" title="Authentication::Strategies (module)">Strategies</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/authentication.rb<span class="defines">,<br />
lib/msf/core/web_services/authentication/strategies.rb,<br /> lib/msf/core/web_services/authentication/strategies/api_token.rb,<br /> lib/msf/core/web_services/authentication/strategies/user_password.rb,<br /> lib/msf/core/web_services/authentication/strategies/admin_api_token.rb</span>
</dd>
</dl>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Authentication/Strategies.html" title="Authentication::Strategies (module)">Strategies</a></span>
</p>
</div>
<div id="footer">
Generated on Tue Apr 23 22:34:49 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

122
api/Authentication/Strategies.html Normal file
View File

@ -0,0 +1,122 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Authentication::Strategies
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Authentication::Strategies";
relpath = '../';
</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 class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (S)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Authentication.html" title="Authentication (module)">Authentication</a></span></span>
&raquo;
<span class="title">Strategies</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Authentication::Strategies
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../Authentication.html" title="Authentication (module)">Authentication</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/authentication/strategies.rb<span class="defines">,<br />
lib/msf/core/web_services/authentication/strategies/api_token.rb,<br /> lib/msf/core/web_services/authentication/strategies/user_password.rb,<br /> lib/msf/core/web_services/authentication/strategies/admin_api_token.rb</span>
</dd>
</dl>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Strategies/AdminApiToken.html" title="Authentication::Strategies::AdminApiToken (class)">AdminApiToken</a></span>, <span class='object_link'><a href="Strategies/ApiToken.html" title="Authentication::Strategies::ApiToken (class)">ApiToken</a></span>, <span class='object_link'><a href="Strategies/UserPassword.html" title="Authentication::Strategies::UserPassword (class)">UserPassword</a></span>
</p>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:05 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

307
api/Authentication/Strategies/AdminApiToken.html Normal file
View File

@ -0,0 +1,307 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Authentication::Strategies::AdminApiToken
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Authentication::Strategies::AdminApiToken";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (A)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Authentication.html" title="Authentication (module)">Authentication</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Strategies.html" title="Authentication::Strategies (module)">Strategies</a></span></span>
&raquo;
<span class="title">AdminApiToken</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Authentication::Strategies::AdminApiToken
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="ApiToken.html" title="Authentication::Strategies::ApiToken (class)">ApiToken</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Warden::Strategies::Base</li>
<li class="next"><span class='object_link'><a href="ApiToken.html" title="Authentication::Strategies::ApiToken (class)">ApiToken</a></span></li>
<li class="next">Authentication::Strategies::AdminApiToken</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/authentication/strategies/admin_api_token.rb</dd>
</dl>
</div>
<h2>Constant Summary</h2>
<h3 class="inherited">Constants inherited
from <span class='object_link'><a href="ApiToken.html" title="Authentication::Strategies::ApiToken (class)">ApiToken</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ApiToken.html#AUTHORIZATION-constant" title="Authentication::Strategies::ApiToken::AUTHORIZATION (constant)">Authentication::Strategies::ApiToken::AUTHORIZATION</a></span>, <span class='object_link'><a href="ApiToken.html#AUTHORIZATION_SCHEME-constant" title="Authentication::Strategies::ApiToken::AUTHORIZATION_SCHEME (constant)">Authentication::Strategies::ApiToken::AUTHORIZATION_SCHEME</a></span>, <span class='object_link'><a href="ApiToken.html#TOKEN_QUERY_PARAM-constant" title="Authentication::Strategies::ApiToken::TOKEN_QUERY_PARAM (constant)">Authentication::Strategies::ApiToken::TOKEN_QUERY_PARAM</a></span></p>
<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="#validate_user-instance_method" title="#validate_user (instance method)">#<strong>validate_user</strong>(user) &#x21d2; Hash </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Validates the user associated with the API token is an admin.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="ApiToken.html" title="Authentication::Strategies::ApiToken (class)">ApiToken</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ApiToken.html#authenticate!-instance_method" title="Authentication::Strategies::ApiToken#authenticate! (method)">#authenticate!</a></span>, <span class='object_link'><a href="ApiToken.html#valid%3F-instance_method" title="Authentication::Strategies::ApiToken#valid? (method)">#valid?</a></span></p>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="validate_user-instance_method">
#<strong>validate_user</strong>(user) &#x21d2; <tt>Hash</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Validates the user associated with the API token is an admin.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>:valid</span>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>a customizable set of options</p>
</div>
</li>
<li>
<span class='name'>:code</span>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>a customizable set of options</p>
</div>
</li>
<li>
<span class='name'>:message</span>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>a customizable set of options</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>User validation data</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13
14
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/authentication/strategies/admin_api_token.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_validate_user'>validate_user</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
<span class='comment'># perform parent validation first
</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='kw'>super</span>
<span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:valid</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_admin'>admin</span> <span class='op'>?</span> <span class='lbrace'>{</span><span class='label'>valid:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>code:</span> <span class='int'>0</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='kw'>nil</span><span class='rbrace'>}</span> <span class='op'>:</span> <span class='lbrace'>{</span><span class='label'>valid:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>code:</span> <span class='int'>403</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Invalid permissions.</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:38:56 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

502
api/Authentication/Strategies/ApiToken.html Normal file
View File

@ -0,0 +1,502 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Authentication::Strategies::ApiToken
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Authentication::Strategies::ApiToken";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (A)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Authentication.html" title="Authentication (module)">Authentication</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Strategies.html" title="Authentication::Strategies (module)">Strategies</a></span></span>
&raquo;
<span class="title">ApiToken</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Authentication::Strategies::ApiToken
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Warden::Strategies::Base</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Warden::Strategies::Base</li>
<li class="next">Authentication::Strategies::ApiToken</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/authentication/strategies/api_token.rb</dd>
</dl>
</div>
<div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="AdminApiToken.html" title="Authentication::Strategies::AdminApiToken (class)">AdminApiToken</a></span></p>
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="AUTHORIZATION-constant" class="">AUTHORIZATION =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>HTTP_AUTHORIZATION</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="AUTHORIZATION_SCHEME-constant" class="">AUTHORIZATION_SCHEME =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Bearer</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="TOKEN_QUERY_PARAM-constant" class="">TOKEN_QUERY_PARAM =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>token</span><span class='tstring_end'>&#39;</span></span></pre></dd>
</dl>
<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="#authenticate!-instance_method" title="#authenticate! (instance method)">#<strong>authenticate!</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Authenticate the request.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#valid%3F-instance_method" title="#valid? (instance method)">#<strong>valid?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Check if request contains valid data and should be authenticated.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#validate_user-instance_method" title="#validate_user (instance method)">#<strong>validate_user</strong>(user) &#x21d2; Hash </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Validates the user associated with the API token.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="authenticate!-instance_method">
#<strong>authenticate!</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Authenticate the request.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/authentication/strategies/api_token.rb', line 17</span>
<span class='kw'>def</span> <span class='id identifier rubyid_authenticate!'>authenticate!</span>
<span class='id identifier rubyid_auth_initialized'>auth_initialized</span> <span class='op'>=</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>msf.auth_initialized</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
<span class='id identifier rubyid_db_manager'>db_manager</span> <span class='op'>=</span> <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>msf.db_manager</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
<span class='id identifier rubyid_authorization'>authorization</span> <span class='op'>=</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="#AUTHORIZATION-constant" title="Authentication::Strategies::ApiToken::AUTHORIZATION (constant)">AUTHORIZATION</a></span></span><span class='rbracket'>]</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_auth_initialized'>auth_initialized</span>
<span class='id identifier rubyid_success!'>success!</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='label'>message:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Initialize authentication by creating an initial user account.</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='kw'>if</span> <span class='id identifier rubyid_authorization'>authorization</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_authorization'>authorization</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#AUTHORIZATION_SCHEME-constant" title="Authentication::Strategies::ApiToken::AUTHORIZATION_SCHEME (constant)">AUTHORIZATION_SCHEME</a></span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_token'>token</span> <span class='op'>=</span> <span class='id identifier rubyid_authorization'>authorization</span><span class='period'>.</span><span class='id identifier rubyid_sub'>sub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#AUTHORIZATION_SCHEME-constant" title="Authentication::Strategies::ApiToken::AUTHORIZATION_SCHEME (constant)">AUTHORIZATION_SCHEME</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>\s+</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_token'>token</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="#TOKEN_QUERY_PARAM-constant" title="Authentication::Strategies::ApiToken::TOKEN_QUERY_PARAM (constant)">TOKEN_QUERY_PARAM</a></span></span><span class='rbracket'>]</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_user'>user</span> <span class='op'>=</span> <span class='id identifier rubyid_db_manager'>db_manager</span><span class='period'>.</span><span class='id identifier rubyid_users'>users</span><span class='lparen'>(</span><span class='label'>persistence_token:</span> <span class='id identifier rubyid_token'>token</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='id identifier rubyid_validation_data'>validation_data</span> <span class='op'>=</span> <span class='id identifier rubyid_validate_user'>validate_user</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_validation_data'>validation_data</span><span class='lbracket'>[</span><span class='symbol'>:valid</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_success!'>success!</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_throw'>throw</span><span class='lparen'>(</span><span class='symbol'>:warden</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='id identifier rubyid_validation_data'>validation_data</span><span class='lbracket'>[</span><span class='symbol'>:message</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>code:</span> <span class='id identifier rubyid_validation_data'>validation_data</span><span class='lbracket'>[</span><span class='symbol'>:code</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="valid?-instance_method">
#<strong>valid?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Check if request contains valid data and should be authenticated.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'>
<p>true if strategy should be run for the request; otherwise, false.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
10
11
12
13
14</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/authentication/strategies/api_token.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_valid?'>valid?</span>
<span class='id identifier rubyid_auth_initialized'>auth_initialized</span> <span class='op'>=</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>msf.auth_initialized</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
<span class='id identifier rubyid_authorization'>authorization</span> <span class='op'>=</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="#AUTHORIZATION-constant" title="Authentication::Strategies::ApiToken::AUTHORIZATION (constant)">AUTHORIZATION</a></span></span><span class='rbracket'>]</span>
<span class='op'>!</span><span class='id identifier rubyid_auth_initialized'>auth_initialized</span> <span class='op'>||</span> <span class='lparen'>(</span><span class='id identifier rubyid_authorization'>authorization</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_authorization'>authorization</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#AUTHORIZATION_SCHEME-constant" title="Authentication::Strategies::ApiToken::AUTHORIZATION_SCHEME (constant)">AUTHORIZATION_SCHEME</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='op'>!</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="#TOKEN_QUERY_PARAM-constant" title="Authentication::Strategies::ApiToken::TOKEN_QUERY_PARAM (constant)">TOKEN_QUERY_PARAM</a></span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="validate_user-instance_method">
#<strong>validate_user</strong>(user) &#x21d2; <tt>Hash</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Validates the user associated with the API token.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>:valid</span>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>a customizable set of options</p>
</div>
</li>
<li>
<span class='name'>:code</span>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>a customizable set of options</p>
</div>
</li>
<li>
<span class='name'>:message</span>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>a customizable set of options</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>User validation data</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/authentication/strategies/api_token.rb', line 47</span>
<span class='kw'>def</span> <span class='id identifier rubyid_validate_user'>validate_user</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
<span class='op'>!</span><span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='lbrace'>{</span><span class='label'>valid:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>code:</span> <span class='int'>0</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='kw'>nil</span><span class='rbrace'>}</span> <span class='op'>:</span> <span class='lbrace'>{</span><span class='label'>valid:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>code:</span> <span class='int'>401</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Invalid API token.</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:38:56 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

325
api/Authentication/Strategies/UserPassword.html Normal file
View File

@ -0,0 +1,325 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Authentication::Strategies::UserPassword
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Authentication::Strategies::UserPassword";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (U)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Authentication.html" title="Authentication (module)">Authentication</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Strategies.html" title="Authentication::Strategies (module)">Strategies</a></span></span>
&raquo;
<span class="title">UserPassword</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Authentication::Strategies::UserPassword
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Warden::Strategies::Base</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Warden::Strategies::Base</li>
<li class="next">Authentication::Strategies::UserPassword</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/authentication/strategies/user_password.rb</dd>
</dl>
</div>
<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="#authenticate!-instance_method" title="#authenticate! (instance method)">#<strong>authenticate!</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Authenticate the request.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#valid%3F-instance_method" title="#valid? (instance method)">#<strong>valid?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Check if request contains valid data and should be authenticated.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="authenticate!-instance_method">
#<strong>authenticate!</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Authenticate the request.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/authentication/strategies/user_password.rb', line 30</span>
<span class='kw'>def</span> <span class='id identifier rubyid_authenticate!'>authenticate!</span>
<span class='kw'>begin</span>
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='comma'>,</span> <span class='label'>symbolize_names:</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='id identifier rubyid_db_manager'>db_manager</span> <span class='op'>=</span> <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>msf.db_manager</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
<span class='id identifier rubyid_user'>user</span> <span class='op'>=</span> <span class='id identifier rubyid_db_manager'>db_manager</span><span class='period'>.</span><span class='id identifier rubyid_users'>users</span><span class='lparen'>(</span><span class='label'>username:</span> <span class='id identifier rubyid_body'>body</span><span class='lbracket'>[</span><span class='symbol'>:username</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='kw'>if</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='op'>!</span><span class='id identifier rubyid_db_manager'>db_manager</span><span class='period'>.</span><span class='id identifier rubyid_authenticate_user'>authenticate_user</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='label'>password:</span> <span class='id identifier rubyid_body'>body</span><span class='lbracket'>[</span><span class='symbol'>:password</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='id identifier rubyid_fail'>fail</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Invalid username or password.</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_success!'>success!</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>ensure</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_rewind'>rewind</span> <span class='comment'># Reset the StringIO buffer so any further consumers can read the body
</span> <span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="valid?-instance_method">
#<strong>valid?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Check if request contains valid data and should be authenticated.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'>
<p>true if strategy should be run for the request; otherwise, false.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
20
21
22
23
24
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/authentication/strategies/user_password.rb', line 20</span>
<span class='kw'>def</span> <span class='id identifier rubyid_valid?'>valid?</span>
<span class='kw'>begin</span>
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='comma'>,</span> <span class='label'>symbolize_names:</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='id identifier rubyid_body'>body</span><span class='lbracket'>[</span><span class='symbol'>:username</span><span class='rbracket'>]</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_body'>body</span><span class='lbracket'>[</span><span class='symbol'>:password</span><span class='rbracket'>]</span>
<span class='kw'>ensure</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_rewind'>rewind</span> <span class='comment'># Reset the StringIO buffer so any further consumers can read the body
</span> <span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:38:56 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

547
api/CredentialDataProxy.html Normal file
View File

@ -0,0 +1,547 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: CredentialDataProxy
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "CredentialDataProxy";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (C)</a> &raquo;
<span class="title">CredentialDataProxy</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: CredentialDataProxy
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="DataProxyAutoLoader.html" title="DataProxyAutoLoader (module)">DataProxyAutoLoader</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/proxy/credential_data_proxy.rb</dd>
</dl>
</div>
<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="#create_cracked_credential-instance_method" title="#create_cracked_credential (instance method)">#<strong>create_cracked_credential</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create_credential-instance_method" title="#create_credential (instance method)">#<strong>create_credential</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create_credential_and_login-instance_method" title="#create_credential_and_login (instance method)">#<strong>create_credential_and_login</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#creds-instance_method" title="#creds (instance method)">#<strong>creds</strong>(opts = {}) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_credentials-instance_method" title="#delete_credentials (instance method)">#<strong>delete_credentials</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update_credential-instance_method" title="#update_credential (instance method)">#<strong>update_credential</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="create_cracked_credential-instance_method">
#<strong>create_cracked_credential</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/credential_data_proxy.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_cracked_credential'>create_cracked_credential</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:workspace_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_workspace'>workspace</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:private_data</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:password</span><span class='rparen'>)</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:private_type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:password</span>
<span class='id identifier rubyid_old_core'>old_core</span> <span class='op'>=</span> <span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_creds'>creds</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:core_id</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='kw'>if</span> <span class='id identifier rubyid_old_core'>old_core</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:originating_core_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_old_core'>old_core</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:origin_type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='symbol'>:cracked_password</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_new_core'>new_core</span> <span class='op'>=</span> <span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_create_credential'>create_credential</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_old_core'>old_core</span><span class='period'>.</span><span class='id identifier rubyid_logins'>logins</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_login'>login</span><span class='op'>|</span>
<span class='id identifier rubyid_service'>service</span> <span class='op'>=</span> <span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_services'>services</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='id identifier rubyid_login'>login</span><span class='period'>.</span><span class='id identifier rubyid_service_id'>service_id</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_create_credential_login'>create_credential_login</span><span class='lparen'>(</span><span class='label'>core:</span> <span class='id identifier rubyid_new_core'>new_core</span><span class='comma'>,</span> <span class='label'>service_id:</span> <span class='id identifier rubyid_service'>service</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='const'><span class='object_link'><a href="Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Login</span><span class='op'>::</span><span class='const'>Status</span><span class='op'>::</span><span class='const'>UNTRIED</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_new_core'>new_core</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem creating cracked credential</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="create_credential-instance_method">
#<strong>create_credential</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5
6
7
8
9
10
11</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/credential_data_proxy.rb', line 3</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_credential'>create_credential</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_create_credential'>create_credential</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem creating credential</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="create_credential_and_login-instance_method">
#<strong>create_credential_and_login</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
36
37
38
39
40
41
42
43
44
45
46
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/credential_data_proxy.rb', line 36</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_credential_and_login'>create_credential_and_login</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_core'>core</span> <span class='op'>=</span> <span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_create_credential'>create_credential</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:core</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_core'>core</span>
<span class='id identifier rubyid_login'>login</span> <span class='op'>=</span> <span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_create_credential_login'>create_credential_login</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_core'>core</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem creating credential and login</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="creds-instance_method">
#<strong>creds</strong>(opts = {}) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
49
50
51
52
53
54
55
56
57
58</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/credential_data_proxy.rb', line 49</span>
<span class='kw'>def</span> <span class='id identifier rubyid_creds'>creds</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_add_opts_workspace'>add_opts_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_creds'>creds</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem retrieving credentials</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete_credentials-instance_method">
#<strong>delete_credentials</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
71
72
73
74
75
76
77
78
79</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/credential_data_proxy.rb', line 71</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_credentials'>delete_credentials</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_delete_credentials'>delete_credentials</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem deleting credentials</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="update_credential-instance_method">
#<strong>update_credential</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
60
61
62
63
64
65
66
67
68
69</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/credential_data_proxy.rb', line 60</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update_credential'>update_credential</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_add_opts_workspace'>add_opts_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_update_credential'>update_credential</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem updating credential</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:49 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

330
api/CredentialDataService.html Normal file
View File

@ -0,0 +1,330 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: CredentialDataService
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "CredentialDataService";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (C)</a> &raquo;
<span class="title">CredentialDataService</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: CredentialDataService
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/stubs/credential_data_service.rb</dd>
</dl>
</div>
<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="#create_credential-instance_method" title="#create_credential (instance method)">#<strong>create_credential</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#creds-instance_method" title="#creds (instance method)">#<strong>creds</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_credential-instance_method" title="#delete_credential (instance method)">#<strong>delete_credential</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update_credential-instance_method" title="#update_credential (instance method)">#<strong>update_credential</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="create_credential-instance_method">
#<strong>create_credential</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/credential_data_service.rb', line 7</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_credential'>create_credential</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>CredentialDataService#create_credential is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="creds-instance_method">
#<strong>creds</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/credential_data_service.rb', line 3</span>
<span class='kw'>def</span> <span class='id identifier rubyid_creds'>creds</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>CredentialDataService#creds is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete_credential-instance_method">
#<strong>delete_credential</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/credential_data_service.rb', line 15</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_credential'>delete_credential</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>CredentialDataService#delete_credential is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="update_credential-instance_method">
#<strong>update_credential</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/credential_data_service.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update_credential'>update_credential</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>CredentialDataService#update_credential is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:49 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

284
api/CredentialServlet.html Normal file
View File

@ -0,0 +1,284 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: CredentialServlet
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "CredentialServlet";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (C)</a> &raquo;
<span class="title">CredentialServlet</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: CredentialServlet
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/servlet/credential_servlet.rb</dd>
</dl>
</div>
<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="#api_path-class_method" title="api_path (class method)">.<strong>api_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#api_path_with_id-class_method" title="api_path_with_id (class method)">.<strong>api_path_with_id</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#registered-class_method" title="registered (class method)">.<strong>registered</strong>(app) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="api_path-class_method">
.<strong>api_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/credential_servlet.rb', line 3</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_path'>api_path</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api/v1/credentials</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="api_path_with_id-class_method">
.<strong>api_path_with_id</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/credential_servlet.rb', line 7</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_path_with_id'>api_path_with_id</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="" title="CredentialServlet (module)">CredentialServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="CredentialServlet.api_path (method)">api_path</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/?:id?</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="registered-class_method">
.<strong>registered</strong>(app) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/credential_servlet.rb', line 11</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_registered'>registered</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='rparen'>)</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='const'><span class='object_link'><a href="" title="CredentialServlet (module)">CredentialServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path_with_id'><span class='object_link'><a href="#api_path_with_id-class_method" title="CredentialServlet.api_path_with_id (method)">api_path_with_id</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_get_credentials'>get_credentials</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span> <span class='const'><span class='object_link'><a href="" title="CredentialServlet (module)">CredentialServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="CredentialServlet.api_path (method)">api_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_create_credential'>create_credential</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</span> <span class='const'><span class='object_link'><a href="" title="CredentialServlet (module)">CredentialServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path_with_id'><span class='object_link'><a href="#api_path_with_id-class_method" title="CredentialServlet.api_path_with_id (method)">api_path_with_id</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_update_credential'>update_credential</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='const'><span class='object_link'><a href="" title="CredentialServlet (module)">CredentialServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="CredentialServlet.api_path (method)">api_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_delete_credentials'>delete_credentials</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:07 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

281
api/DBManagerProxy.html Normal file
View File

@ -0,0 +1,281 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: DBManagerProxy
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "DBManagerProxy";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (D)</a> &raquo;
<span class="title">DBManagerProxy</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: DBManagerProxy
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">DBManagerProxy</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd>Singleton</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/db_manager_proxy.rb</dd>
</dl>
</div>
<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="#db-instance_method" title="#db (instance method)">#<strong>db</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute db.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#modules-instance_method" title="#modules (instance method)">#<strong>modules</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute modules.</p>
</div></span>
</li>
</ul>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="db-instance_method">
#<strong>db</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute db</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/db_manager_proxy.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_db'>db</span>
<span class='ivar'>@db</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="modules-instance_method">
#<strong>modules</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute modules</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
12
13
14</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/db_manager_proxy.rb', line 12</span>
<span class='kw'>def</span> <span class='id identifier rubyid_modules'>modules</span>
<span class='ivar'>@modules</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:38:43 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

335
api/DataProxyAutoLoader.html Normal file
View File

@ -0,0 +1,335 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: DataProxyAutoLoader
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "DataProxyAutoLoader";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (D)</a> &raquo;
<span class="title">DataProxyAutoLoader</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: DataProxyAutoLoader
</h1>
<div class="box_info">
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="CredentialDataProxy.html" title="CredentialDataProxy (module)">CredentialDataProxy</a></span>, <span class='object_link'><a href="DbExportDataProxy.html" title="DbExportDataProxy (module)">DbExportDataProxy</a></span>, <span class='object_link'><a href="DbImportDataProxy.html" title="DbImportDataProxy (module)">DbImportDataProxy</a></span>, <span class='object_link'><a href="EventDataProxy.html" title="EventDataProxy (module)">EventDataProxy</a></span>, <span class='object_link'><a href="ExploitDataProxy.html" title="ExploitDataProxy (module)">ExploitDataProxy</a></span>, <span class='object_link'><a href="HostDataProxy.html" title="HostDataProxy (module)">HostDataProxy</a></span>, <span class='object_link'><a href="LoginDataProxy.html" title="LoginDataProxy (module)">LoginDataProxy</a></span>, <span class='object_link'><a href="LootDataProxy.html" title="LootDataProxy (module)">LootDataProxy</a></span>, <span class='object_link'><a href="MsfDataProxy.html" title="MsfDataProxy (module)">MsfDataProxy</a></span>, <span class='object_link'><a href="NmapDataProxy.html" title="NmapDataProxy (module)">NmapDataProxy</a></span>, <span class='object_link'><a href="NoteDataProxy.html" title="NoteDataProxy (module)">NoteDataProxy</a></span>, <span class='object_link'><a href="PayloadDataProxy.html" title="PayloadDataProxy (module)">PayloadDataProxy</a></span>, <span class='object_link'><a href="ServiceDataProxy.html" title="ServiceDataProxy (module)">ServiceDataProxy</a></span>, <span class='object_link'><a href="SessionDataProxy.html" title="SessionDataProxy (module)">SessionDataProxy</a></span>, <span class='object_link'><a href="SessionEventDataProxy.html" title="SessionEventDataProxy (module)">SessionEventDataProxy</a></span>, <span class='object_link'><a href="VulnAttemptDataProxy.html" title="VulnAttemptDataProxy (module)">VulnAttemptDataProxy</a></span>, <span class='object_link'><a href="VulnDataProxy.html" title="VulnDataProxy (module)">VulnDataProxy</a></span>, <span class='object_link'><a href="WebDataProxy.html" title="WebDataProxy (module)">WebDataProxy</a></span>, <span class='object_link'><a href="WorkspaceDataProxy.html" title="WorkspaceDataProxy (module)">WorkspaceDataProxy</a></span></dd>
</dl>
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="Metasploit/Framework/DataService/DataProxy.html" title="Metasploit::Framework::DataService::DataProxy (class)">Metasploit::Framework::DataService::DataProxy</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/proxy/data_proxy_auto_loader.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Autoloads specific data proxies</p>
</div>
</div>
<div class="tags">
</div>
<h2>Method Summary</h2>
<h3 class="inherited">Methods included from <span class='object_link'><a href="PayloadDataProxy.html" title="PayloadDataProxy (module)">PayloadDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="PayloadDataProxy.html#create_payload-instance_method" title="PayloadDataProxy#create_payload (method)">#create_payload</a></span>, <span class='object_link'><a href="PayloadDataProxy.html#delete_payload-instance_method" title="PayloadDataProxy#delete_payload (method)">#delete_payload</a></span>, <span class='object_link'><a href="PayloadDataProxy.html#payloads-instance_method" title="PayloadDataProxy#payloads (method)">#payloads</a></span>, <span class='object_link'><a href="PayloadDataProxy.html#update_payload-instance_method" title="PayloadDataProxy#update_payload (method)">#update_payload</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="MsfDataProxy.html" title="MsfDataProxy (module)">MsfDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="MsfDataProxy.html#get_msf_version-instance_method" title="MsfDataProxy#get_msf_version (method)">#get_msf_version</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="VulnAttemptDataProxy.html" title="VulnAttemptDataProxy (module)">VulnAttemptDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="VulnAttemptDataProxy.html#report_vuln_attempt-instance_method" title="VulnAttemptDataProxy#report_vuln_attempt (method)">#report_vuln_attempt</a></span>, <span class='object_link'><a href="VulnAttemptDataProxy.html#vuln_attempts-instance_method" title="VulnAttemptDataProxy#vuln_attempts (method)">#vuln_attempts</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DbImportDataProxy.html" title="DbImportDataProxy (module)">DbImportDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DbImportDataProxy.html#import-instance_method" title="DbImportDataProxy#import (method)">#import</a></span>, <span class='object_link'><a href="DbImportDataProxy.html#import_file-instance_method" title="DbImportDataProxy#import_file (method)">#import_file</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DbExportDataProxy.html" title="DbExportDataProxy (module)">DbExportDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DbExportDataProxy.html#run_db_export-instance_method" title="DbExportDataProxy#run_db_export (method)">#run_db_export</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="NmapDataProxy.html" title="NmapDataProxy (module)">NmapDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="NmapDataProxy.html#import_nmap_xml_file-instance_method" title="NmapDataProxy#import_nmap_xml_file (method)">#import_nmap_xml_file</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="LoginDataProxy.html" title="LoginDataProxy (module)">LoginDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="LoginDataProxy.html#create_credential_login-instance_method" title="LoginDataProxy#create_credential_login (method)">#create_credential_login</a></span>, <span class='object_link'><a href="LoginDataProxy.html#invalidate_login-instance_method" title="LoginDataProxy#invalidate_login (method)">#invalidate_login</a></span>, <span class='object_link'><a href="LoginDataProxy.html#logins-instance_method" title="LoginDataProxy#logins (method)">#logins</a></span>, <span class='object_link'><a href="LoginDataProxy.html#update_login-instance_method" title="LoginDataProxy#update_login (method)">#update_login</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="CredentialDataProxy.html" title="CredentialDataProxy (module)">CredentialDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="CredentialDataProxy.html#create_cracked_credential-instance_method" title="CredentialDataProxy#create_cracked_credential (method)">#create_cracked_credential</a></span>, <span class='object_link'><a href="CredentialDataProxy.html#create_credential-instance_method" title="CredentialDataProxy#create_credential (method)">#create_credential</a></span>, <span class='object_link'><a href="CredentialDataProxy.html#create_credential_and_login-instance_method" title="CredentialDataProxy#create_credential_and_login (method)">#create_credential_and_login</a></span>, <span class='object_link'><a href="CredentialDataProxy.html#creds-instance_method" title="CredentialDataProxy#creds (method)">#creds</a></span>, <span class='object_link'><a href="CredentialDataProxy.html#delete_credentials-instance_method" title="CredentialDataProxy#delete_credentials (method)">#delete_credentials</a></span>, <span class='object_link'><a href="CredentialDataProxy.html#update_credential-instance_method" title="CredentialDataProxy#update_credential (method)">#update_credential</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="SessionEventDataProxy.html" title="SessionEventDataProxy (module)">SessionEventDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="SessionEventDataProxy.html#report_session_event-instance_method" title="SessionEventDataProxy#report_session_event (method)">#report_session_event</a></span>, <span class='object_link'><a href="SessionEventDataProxy.html#session_events-instance_method" title="SessionEventDataProxy#session_events (method)">#session_events</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="LootDataProxy.html" title="LootDataProxy (module)">LootDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="LootDataProxy.html#find_or_create_loot-instance_method" title="LootDataProxy#find_or_create_loot (method)">#find_or_create_loot</a></span>, <span class='object_link'><a href="LootDataProxy.html#loots-instance_method" title="LootDataProxy#loots (method)">#loots</a></span>, <span class='object_link'><a href="LootDataProxy.html#report_loot-instance_method" title="LootDataProxy#report_loot (method)">#report_loot</a></span>, <span class='object_link'><a href="LootDataProxy.html#update_loot-instance_method" title="LootDataProxy#update_loot (method)">#update_loot</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="ExploitDataProxy.html" title="ExploitDataProxy (module)">ExploitDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ExploitDataProxy.html#report_exploit_attempt-instance_method" title="ExploitDataProxy#report_exploit_attempt (method)">#report_exploit_attempt</a></span>, <span class='object_link'><a href="ExploitDataProxy.html#report_exploit_failure-instance_method" title="ExploitDataProxy#report_exploit_failure (method)">#report_exploit_failure</a></span>, <span class='object_link'><a href="ExploitDataProxy.html#report_exploit_success-instance_method" title="ExploitDataProxy#report_exploit_success (method)">#report_exploit_success</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="SessionDataProxy.html" title="SessionDataProxy (module)">SessionDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="SessionDataProxy.html#convert_msf_session_to_hash-class_method" title="SessionDataProxy.convert_msf_session_to_hash (method)">convert_msf_session_to_hash</a></span>, <span class='object_link'><a href="SessionDataProxy.html#report_session-instance_method" title="SessionDataProxy#report_session (method)">#report_session</a></span>, <span class='object_link'><a href="SessionDataProxy.html#sessions-instance_method" title="SessionDataProxy#sessions (method)">#sessions</a></span>, <span class='object_link'><a href="SessionDataProxy.html#update_session-instance_method" title="SessionDataProxy#update_session (method)">#update_session</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="WebDataProxy.html" title="WebDataProxy (module)">WebDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="WebDataProxy.html#report_web_site-instance_method" title="WebDataProxy#report_web_site (method)">#report_web_site</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="NoteDataProxy.html" title="NoteDataProxy (module)">NoteDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="NoteDataProxy.html#delete_note-instance_method" title="NoteDataProxy#delete_note (method)">#delete_note</a></span>, <span class='object_link'><a href="NoteDataProxy.html#find_or_create_note-instance_method" title="NoteDataProxy#find_or_create_note (method)">#find_or_create_note</a></span>, <span class='object_link'><a href="NoteDataProxy.html#notes-instance_method" title="NoteDataProxy#notes (method)">#notes</a></span>, <span class='object_link'><a href="NoteDataProxy.html#report_note-instance_method" title="NoteDataProxy#report_note (method)">#report_note</a></span>, <span class='object_link'><a href="NoteDataProxy.html#update_note-instance_method" title="NoteDataProxy#update_note (method)">#update_note</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="WorkspaceDataProxy.html" title="WorkspaceDataProxy (module)">WorkspaceDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="WorkspaceDataProxy.html#add_workspace-instance_method" title="WorkspaceDataProxy#add_workspace (method)">#add_workspace</a></span>, <span class='object_link'><a href="WorkspaceDataProxy.html#default_workspace-instance_method" title="WorkspaceDataProxy#default_workspace (method)">#default_workspace</a></span>, <span class='object_link'><a href="WorkspaceDataProxy.html#delete_workspaces-instance_method" title="WorkspaceDataProxy#delete_workspaces (method)">#delete_workspaces</a></span>, <span class='object_link'><a href="WorkspaceDataProxy.html#find_workspace-instance_method" title="WorkspaceDataProxy#find_workspace (method)">#find_workspace</a></span>, <span class='object_link'><a href="WorkspaceDataProxy.html#update_workspace-instance_method" title="WorkspaceDataProxy#update_workspace (method)">#update_workspace</a></span>, <span class='object_link'><a href="WorkspaceDataProxy.html#workspace-instance_method" title="WorkspaceDataProxy#workspace (method)">#workspace</a></span>, <span class='object_link'><a href="WorkspaceDataProxy.html#workspace=-instance_method" title="WorkspaceDataProxy#workspace= (method)">#workspace=</a></span>, <span class='object_link'><a href="WorkspaceDataProxy.html#workspaces-instance_method" title="WorkspaceDataProxy#workspaces (method)">#workspaces</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="EventDataProxy.html" title="EventDataProxy (module)">EventDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="EventDataProxy.html#events-instance_method" title="EventDataProxy#events (method)">#events</a></span>, <span class='object_link'><a href="EventDataProxy.html#report_event-instance_method" title="EventDataProxy#report_event (method)">#report_event</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="VulnDataProxy.html" title="VulnDataProxy (module)">VulnDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="VulnDataProxy.html#delete_vuln-instance_method" title="VulnDataProxy#delete_vuln (method)">#delete_vuln</a></span>, <span class='object_link'><a href="VulnDataProxy.html#find_or_create_vuln-instance_method" title="VulnDataProxy#find_or_create_vuln (method)">#find_or_create_vuln</a></span>, <span class='object_link'><a href="VulnDataProxy.html#report_vuln-instance_method" title="VulnDataProxy#report_vuln (method)">#report_vuln</a></span>, <span class='object_link'><a href="VulnDataProxy.html#update_vuln-instance_method" title="VulnDataProxy#update_vuln (method)">#update_vuln</a></span>, <span class='object_link'><a href="VulnDataProxy.html#vulns-instance_method" title="VulnDataProxy#vulns (method)">#vulns</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="HostDataProxy.html" title="HostDataProxy (module)">HostDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="HostDataProxy.html#delete_host-instance_method" title="HostDataProxy#delete_host (method)">#delete_host</a></span>, <span class='object_link'><a href="HostDataProxy.html#find_or_create_host-instance_method" title="HostDataProxy#find_or_create_host (method)">#find_or_create_host</a></span>, <span class='object_link'><a href="HostDataProxy.html#get_host-instance_method" title="HostDataProxy#get_host (method)">#get_host</a></span>, <span class='object_link'><a href="HostDataProxy.html#hosts-instance_method" title="HostDataProxy#hosts (method)">#hosts</a></span>, <span class='object_link'><a href="HostDataProxy.html#report_host-instance_method" title="HostDataProxy#report_host (method)">#report_host</a></span>, <span class='object_link'><a href="HostDataProxy.html#update_host-instance_method" title="HostDataProxy#update_host (method)">#update_host</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="ServiceDataProxy.html" title="ServiceDataProxy (module)">ServiceDataProxy</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ServiceDataProxy.html#delete_service-instance_method" title="ServiceDataProxy#delete_service (method)">#delete_service</a></span>, <span class='object_link'><a href="ServiceDataProxy.html#find_or_create_service-instance_method" title="ServiceDataProxy#find_or_create_service (method)">#find_or_create_service</a></span>, <span class='object_link'><a href="ServiceDataProxy.html#report_service-instance_method" title="ServiceDataProxy#report_service (method)">#report_service</a></span>, <span class='object_link'><a href="ServiceDataProxy.html#services-instance_method" title="ServiceDataProxy#services (method)">#services</a></span>, <span class='object_link'><a href="ServiceDataProxy.html#update_service-instance_method" title="ServiceDataProxy#update_service (method)">#update_service</a></span></p>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:49 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

460
api/DataServiceAutoLoader.html Normal file
View File

@ -0,0 +1,460 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: DataServiceAutoLoader
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "DataServiceAutoLoader";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (D)</a> &raquo;
<span class="title">DataServiceAutoLoader</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: DataServiceAutoLoader
</h1>
<div class="box_info">
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="RemoteCredentialDataService.html" title="RemoteCredentialDataService (module)">RemoteCredentialDataService</a></span>, <span class='object_link'><a href="RemoteDbExportDataService.html" title="RemoteDbExportDataService (module)">RemoteDbExportDataService</a></span>, <span class='object_link'><a href="RemoteDbImportDataService.html" title="RemoteDbImportDataService (module)">RemoteDbImportDataService</a></span>, <span class='object_link'><a href="RemoteEventDataService.html" title="RemoteEventDataService (module)">RemoteEventDataService</a></span>, <span class='object_link'><a href="RemoteExploitDataService.html" title="RemoteExploitDataService (module)">RemoteExploitDataService</a></span>, <span class='object_link'><a href="RemoteHostDataService.html" title="RemoteHostDataService (module)">RemoteHostDataService</a></span>, <span class='object_link'><a href="RemoteLoginDataService.html" title="RemoteLoginDataService (module)">RemoteLoginDataService</a></span>, <span class='object_link'><a href="RemoteLootDataService.html" title="RemoteLootDataService (module)">RemoteLootDataService</a></span>, <span class='object_link'><a href="RemoteMsfDataService.html" title="RemoteMsfDataService (module)">RemoteMsfDataService</a></span>, <span class='object_link'><a href="RemoteNmapDataService.html" title="RemoteNmapDataService (module)">RemoteNmapDataService</a></span>, <span class='object_link'><a href="RemoteNoteDataService.html" title="RemoteNoteDataService (module)">RemoteNoteDataService</a></span>, <span class='object_link'><a href="RemotePayloadDataService.html" title="RemotePayloadDataService (module)">RemotePayloadDataService</a></span>, <span class='object_link'><a href="RemoteServiceDataService.html" title="RemoteServiceDataService (module)">RemoteServiceDataService</a></span>, <span class='object_link'><a href="RemoteSessionDataService.html" title="RemoteSessionDataService (module)">RemoteSessionDataService</a></span>, <span class='object_link'><a href="RemoteSessionEventDataService.html" title="RemoteSessionEventDataService (module)">RemoteSessionEventDataService</a></span>, <span class='object_link'><a href="RemoteVulnAttemptDataService.html" title="RemoteVulnAttemptDataService (module)">RemoteVulnAttemptDataService</a></span>, <span class='object_link'><a href="RemoteVulnDataService.html" title="RemoteVulnDataService (module)">RemoteVulnDataService</a></span>, <span class='object_link'><a href="RemoteWebDataService.html" title="RemoteWebDataService (module)">RemoteWebDataService</a></span>, <span class='object_link'><a href="RemoteWorkspaceDataService.html" title="RemoteWorkspaceDataService (module)">RemoteWorkspaceDataService</a></span></dd>
</dl>
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="Metasploit/Framework/DataService/RemoteHTTPDataService.html" title="Metasploit::Framework::DataService::RemoteHTTPDataService (class)">Metasploit::Framework::DataService::RemoteHTTPDataService</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/remote/http/data_service_auto_loader.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Autoloads specific remote data services</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemotePayloadDataService.html" title="RemotePayloadDataService (module)">RemotePayloadDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemotePayloadDataService.html#PAYLOAD_API_PATH-constant" title="RemotePayloadDataService::PAYLOAD_API_PATH (constant)">RemotePayloadDataService::PAYLOAD_API_PATH</a></span>, <span class='object_link'><a href="RemotePayloadDataService.html#PAYLOAD_MDM_CLASS-constant" title="RemotePayloadDataService::PAYLOAD_MDM_CLASS (constant)">RemotePayloadDataService::PAYLOAD_MDM_CLASS</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteDbImportDataService.html" title="RemoteDbImportDataService (module)">RemoteDbImportDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteDbImportDataService.html#DB_IMPORT_API_PATH-constant" title="RemoteDbImportDataService::DB_IMPORT_API_PATH (constant)">RemoteDbImportDataService::DB_IMPORT_API_PATH</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteMsfDataService.html" title="RemoteMsfDataService (module)">RemoteMsfDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteMsfDataService.html#MSF_API_PATH-constant" title="RemoteMsfDataService::MSF_API_PATH (constant)">RemoteMsfDataService::MSF_API_PATH</a></span>, <span class='object_link'><a href="RemoteMsfDataService.html#MSF_VERSION_API_PATH-constant" title="RemoteMsfDataService::MSF_VERSION_API_PATH (constant)">RemoteMsfDataService::MSF_VERSION_API_PATH</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteVulnAttemptDataService.html" title="RemoteVulnAttemptDataService (module)">RemoteVulnAttemptDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteVulnAttemptDataService.html#VULN_ATTEMPT_API_PATH-constant" title="RemoteVulnAttemptDataService::VULN_ATTEMPT_API_PATH (constant)">RemoteVulnAttemptDataService::VULN_ATTEMPT_API_PATH</a></span>, <span class='object_link'><a href="RemoteVulnAttemptDataService.html#VULN_ATTEMPT_MDM_CLASS-constant" title="RemoteVulnAttemptDataService::VULN_ATTEMPT_MDM_CLASS (constant)">RemoteVulnAttemptDataService::VULN_ATTEMPT_MDM_CLASS</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteDbExportDataService.html" title="RemoteDbExportDataService (module)">RemoteDbExportDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteDbExportDataService.html#DB_EXPORT_API_PATH-constant" title="RemoteDbExportDataService::DB_EXPORT_API_PATH (constant)">RemoteDbExportDataService::DB_EXPORT_API_PATH</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteNmapDataService.html" title="RemoteNmapDataService (module)">RemoteNmapDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteNmapDataService.html#NMAP_PATH-constant" title="RemoteNmapDataService::NMAP_PATH (constant)">RemoteNmapDataService::NMAP_PATH</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteLoginDataService.html" title="RemoteLoginDataService (module)">RemoteLoginDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteLoginDataService.html#LOGIN_API_PATH-constant" title="RemoteLoginDataService::LOGIN_API_PATH (constant)">RemoteLoginDataService::LOGIN_API_PATH</a></span>, <span class='object_link'><a href="RemoteLoginDataService.html#LOGIN_MDM_CLASS-constant" title="RemoteLoginDataService::LOGIN_MDM_CLASS (constant)">RemoteLoginDataService::LOGIN_MDM_CLASS</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteCredentialDataService.html" title="RemoteCredentialDataService (module)">RemoteCredentialDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteCredentialDataService.html#CREDENTIAL_API_PATH-constant" title="RemoteCredentialDataService::CREDENTIAL_API_PATH (constant)">RemoteCredentialDataService::CREDENTIAL_API_PATH</a></span>, <span class='object_link'><a href="RemoteCredentialDataService.html#CREDENTIAL_MDM_CLASS-constant" title="RemoteCredentialDataService::CREDENTIAL_MDM_CLASS (constant)">RemoteCredentialDataService::CREDENTIAL_MDM_CLASS</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteSessionEventDataService.html" title="RemoteSessionEventDataService (module)">RemoteSessionEventDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteSessionEventDataService.html#SESSION_EVENT_API_PATH-constant" title="RemoteSessionEventDataService::SESSION_EVENT_API_PATH (constant)">RemoteSessionEventDataService::SESSION_EVENT_API_PATH</a></span>, <span class='object_link'><a href="RemoteSessionEventDataService.html#SESSION_EVENT_MDM_CLASS-constant" title="RemoteSessionEventDataService::SESSION_EVENT_MDM_CLASS (constant)">RemoteSessionEventDataService::SESSION_EVENT_MDM_CLASS</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteLootDataService.html" title="RemoteLootDataService (module)">RemoteLootDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteLootDataService.html#LOOT_API_PATH-constant" title="RemoteLootDataService::LOOT_API_PATH (constant)">RemoteLootDataService::LOOT_API_PATH</a></span>, <span class='object_link'><a href="RemoteLootDataService.html#LOOT_MDM_CLASS-constant" title="RemoteLootDataService::LOOT_MDM_CLASS (constant)">RemoteLootDataService::LOOT_MDM_CLASS</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteExploitDataService.html" title="RemoteExploitDataService (module)">RemoteExploitDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteExploitDataService.html#EXPLOIT_API_PATH-constant" title="RemoteExploitDataService::EXPLOIT_API_PATH (constant)">RemoteExploitDataService::EXPLOIT_API_PATH</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteSessionDataService.html" title="RemoteSessionDataService (module)">RemoteSessionDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteSessionDataService.html#SESSION_API_PATH-constant" title="RemoteSessionDataService::SESSION_API_PATH (constant)">RemoteSessionDataService::SESSION_API_PATH</a></span>, <span class='object_link'><a href="RemoteSessionDataService.html#SESSION_MDM_CLASS-constant" title="RemoteSessionDataService::SESSION_MDM_CLASS (constant)">RemoteSessionDataService::SESSION_MDM_CLASS</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteServiceDataService.html" title="RemoteServiceDataService (module)">RemoteServiceDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteServiceDataService.html#SERVICE_API_PATH-constant" title="RemoteServiceDataService::SERVICE_API_PATH (constant)">RemoteServiceDataService::SERVICE_API_PATH</a></span>, <span class='object_link'><a href="RemoteServiceDataService.html#SERVICE_MDM_CLASS-constant" title="RemoteServiceDataService::SERVICE_MDM_CLASS (constant)">RemoteServiceDataService::SERVICE_MDM_CLASS</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteWebDataService.html" title="RemoteWebDataService (module)">RemoteWebDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteWebDataService.html#WEB_API_PATH-constant" title="RemoteWebDataService::WEB_API_PATH (constant)">RemoteWebDataService::WEB_API_PATH</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteVulnDataService.html" title="RemoteVulnDataService (module)">RemoteVulnDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteVulnDataService.html#VULN_API_PATH-constant" title="RemoteVulnDataService::VULN_API_PATH (constant)">RemoteVulnDataService::VULN_API_PATH</a></span>, <span class='object_link'><a href="RemoteVulnDataService.html#VULN_MDM_CLASS-constant" title="RemoteVulnDataService::VULN_MDM_CLASS (constant)">RemoteVulnDataService::VULN_MDM_CLASS</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteWorkspaceDataService.html" title="RemoteWorkspaceDataService (module)">RemoteWorkspaceDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteWorkspaceDataService.html#WORKSPACE_API_PATH-constant" title="RemoteWorkspaceDataService::WORKSPACE_API_PATH (constant)">RemoteWorkspaceDataService::WORKSPACE_API_PATH</a></span>, <span class='object_link'><a href="RemoteWorkspaceDataService.html#WORKSPACE_MDM_CLASS-constant" title="RemoteWorkspaceDataService::WORKSPACE_MDM_CLASS (constant)">RemoteWorkspaceDataService::WORKSPACE_MDM_CLASS</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteNoteDataService.html" title="RemoteNoteDataService (module)">RemoteNoteDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteNoteDataService.html#NOTE_API_PATH-constant" title="RemoteNoteDataService::NOTE_API_PATH (constant)">RemoteNoteDataService::NOTE_API_PATH</a></span>, <span class='object_link'><a href="RemoteNoteDataService.html#NOTE_MDM_CLASS-constant" title="RemoteNoteDataService::NOTE_MDM_CLASS (constant)">RemoteNoteDataService::NOTE_MDM_CLASS</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteEventDataService.html" title="RemoteEventDataService (module)">RemoteEventDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteEventDataService.html#EVENT_API_PATH-constant" title="RemoteEventDataService::EVENT_API_PATH (constant)">RemoteEventDataService::EVENT_API_PATH</a></span>, <span class='object_link'><a href="RemoteEventDataService.html#EVENT_MDM_CLASS-constant" title="RemoteEventDataService::EVENT_MDM_CLASS (constant)">RemoteEventDataService::EVENT_MDM_CLASS</a></span></p>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="RemoteHostDataService.html" title="RemoteHostDataService (module)">RemoteHostDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteHostDataService.html#HOST_API_PATH-constant" title="RemoteHostDataService::HOST_API_PATH (constant)">RemoteHostDataService::HOST_API_PATH</a></span>, <span class='object_link'><a href="RemoteHostDataService.html#HOST_MDM_CLASS-constant" title="RemoteHostDataService::HOST_MDM_CLASS (constant)">RemoteHostDataService::HOST_MDM_CLASS</a></span>, <span class='object_link'><a href="RemoteHostDataService.html#HOST_SEARCH_PATH-constant" title="RemoteHostDataService::HOST_SEARCH_PATH (constant)">RemoteHostDataService::HOST_SEARCH_PATH</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemotePayloadDataService.html" title="RemotePayloadDataService (module)">RemotePayloadDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemotePayloadDataService.html#create_payload-instance_method" title="RemotePayloadDataService#create_payload (method)">#create_payload</a></span>, <span class='object_link'><a href="RemotePayloadDataService.html#delete_payload-instance_method" title="RemotePayloadDataService#delete_payload (method)">#delete_payload</a></span>, <span class='object_link'><a href="RemotePayloadDataService.html#payloads-instance_method" title="RemotePayloadDataService#payloads (method)">#payloads</a></span>, <span class='object_link'><a href="RemotePayloadDataService.html#update_payload-instance_method" title="RemotePayloadDataService#update_payload (method)">#update_payload</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="ResponseDataHelper.html" title="ResponseDataHelper (module)">ResponseDataHelper</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ResponseDataHelper.html#json_to_hash-instance_method" title="ResponseDataHelper#json_to_hash (method)">#json_to_hash</a></span>, <span class='object_link'><a href="ResponseDataHelper.html#json_to_mdm_object-instance_method" title="ResponseDataHelper#json_to_mdm_object (method)">#json_to_mdm_object</a></span>, <span class='object_link'><a href="ResponseDataHelper.html#process_file-instance_method" title="ResponseDataHelper#process_file (method)">#process_file</a></span>, <span class='object_link'><a href="ResponseDataHelper.html#process_response-instance_method" title="ResponseDataHelper#process_response (method)">#process_response</a></span>, <span class='object_link'><a href="ResponseDataHelper.html#to_ar-instance_method" title="ResponseDataHelper#to_ar (method)">#to_ar</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteDbImportDataService.html" title="RemoteDbImportDataService (module)">RemoteDbImportDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteDbImportDataService.html#import_file-instance_method" title="RemoteDbImportDataService#import_file (method)">#import_file</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteMsfDataService.html" title="RemoteMsfDataService (module)">RemoteMsfDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteMsfDataService.html#get_msf_version-instance_method" title="RemoteMsfDataService#get_msf_version (method)">#get_msf_version</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteVulnAttemptDataService.html" title="RemoteVulnAttemptDataService (module)">RemoteVulnAttemptDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteVulnAttemptDataService.html#report_vuln_attempt-instance_method" title="RemoteVulnAttemptDataService#report_vuln_attempt (method)">#report_vuln_attempt</a></span>, <span class='object_link'><a href="RemoteVulnAttemptDataService.html#vuln_attempts-instance_method" title="RemoteVulnAttemptDataService#vuln_attempts (method)">#vuln_attempts</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteDbExportDataService.html" title="RemoteDbExportDataService (module)">RemoteDbExportDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteDbExportDataService.html#run_db_export-instance_method" title="RemoteDbExportDataService#run_db_export (method)">#run_db_export</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteNmapDataService.html" title="RemoteNmapDataService (module)">RemoteNmapDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteNmapDataService.html#import_nmap_xml_file-instance_method" title="RemoteNmapDataService#import_nmap_xml_file (method)">#import_nmap_xml_file</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteLoginDataService.html" title="RemoteLoginDataService (module)">RemoteLoginDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteLoginDataService.html#create_credential_login-instance_method" title="RemoteLoginDataService#create_credential_login (method)">#create_credential_login</a></span>, <span class='object_link'><a href="RemoteLoginDataService.html#logins-instance_method" title="RemoteLoginDataService#logins (method)">#logins</a></span>, <span class='object_link'><a href="RemoteLoginDataService.html#update_login-instance_method" title="RemoteLoginDataService#update_login (method)">#update_login</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteCredentialDataService.html" title="RemoteCredentialDataService (module)">RemoteCredentialDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteCredentialDataService.html#create_credential-instance_method" title="RemoteCredentialDataService#create_credential (method)">#create_credential</a></span>, <span class='object_link'><a href="RemoteCredentialDataService.html#creds-instance_method" title="RemoteCredentialDataService#creds (method)">#creds</a></span>, <span class='object_link'><a href="RemoteCredentialDataService.html#delete_credentials-instance_method" title="RemoteCredentialDataService#delete_credentials (method)">#delete_credentials</a></span>, <span class='object_link'><a href="RemoteCredentialDataService.html#update_credential-instance_method" title="RemoteCredentialDataService#update_credential (method)">#update_credential</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteSessionEventDataService.html" title="RemoteSessionEventDataService (module)">RemoteSessionEventDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteSessionEventDataService.html#report_session_event-instance_method" title="RemoteSessionEventDataService#report_session_event (method)">#report_session_event</a></span>, <span class='object_link'><a href="RemoteSessionEventDataService.html#session_events-instance_method" title="RemoteSessionEventDataService#session_events (method)">#session_events</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteLootDataService.html" title="RemoteLootDataService (module)">RemoteLootDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteLootDataService.html#delete_loot-instance_method" title="RemoteLootDataService#delete_loot (method)">#delete_loot</a></span>, <span class='object_link'><a href="RemoteLootDataService.html#loot-instance_method" title="RemoteLootDataService#loot (method)">#loot</a></span>, <span class='object_link'><a href="RemoteLootDataService.html#report_loot-instance_method" title="RemoteLootDataService#report_loot (method)">#report_loot</a></span>, <span class='object_link'><a href="RemoteLootDataService.html#update_loot-instance_method" title="RemoteLootDataService#update_loot (method)">#update_loot</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteExploitDataService.html" title="RemoteExploitDataService (module)">RemoteExploitDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteExploitDataService.html#report_exploit_attempt-instance_method" title="RemoteExploitDataService#report_exploit_attempt (method)">#report_exploit_attempt</a></span>, <span class='object_link'><a href="RemoteExploitDataService.html#report_exploit_failure-instance_method" title="RemoteExploitDataService#report_exploit_failure (method)">#report_exploit_failure</a></span>, <span class='object_link'><a href="RemoteExploitDataService.html#report_exploit_success-instance_method" title="RemoteExploitDataService#report_exploit_success (method)">#report_exploit_success</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteSessionDataService.html" title="RemoteSessionDataService (module)">RemoteSessionDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteSessionDataService.html#report_session-instance_method" title="RemoteSessionDataService#report_session (method)">#report_session</a></span>, <span class='object_link'><a href="RemoteSessionDataService.html#sessions-instance_method" title="RemoteSessionDataService#sessions (method)">#sessions</a></span>, <span class='object_link'><a href="RemoteSessionDataService.html#update_session-instance_method" title="RemoteSessionDataService#update_session (method)">#update_session</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteServiceDataService.html" title="RemoteServiceDataService (module)">RemoteServiceDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteServiceDataService.html#delete_service-instance_method" title="RemoteServiceDataService#delete_service (method)">#delete_service</a></span>, <span class='object_link'><a href="RemoteServiceDataService.html#report_service-instance_method" title="RemoteServiceDataService#report_service (method)">#report_service</a></span>, <span class='object_link'><a href="RemoteServiceDataService.html#services-instance_method" title="RemoteServiceDataService#services (method)">#services</a></span>, <span class='object_link'><a href="RemoteServiceDataService.html#update_service-instance_method" title="RemoteServiceDataService#update_service (method)">#update_service</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteWebDataService.html" title="RemoteWebDataService (module)">RemoteWebDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteWebDataService.html#report_web_site-instance_method" title="RemoteWebDataService#report_web_site (method)">#report_web_site</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteVulnDataService.html" title="RemoteVulnDataService (module)">RemoteVulnDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteVulnDataService.html#delete_vuln-instance_method" title="RemoteVulnDataService#delete_vuln (method)">#delete_vuln</a></span>, <span class='object_link'><a href="RemoteVulnDataService.html#report_vuln-instance_method" title="RemoteVulnDataService#report_vuln (method)">#report_vuln</a></span>, <span class='object_link'><a href="RemoteVulnDataService.html#update_vuln-instance_method" title="RemoteVulnDataService#update_vuln (method)">#update_vuln</a></span>, <span class='object_link'><a href="RemoteVulnDataService.html#vulns-instance_method" title="RemoteVulnDataService#vulns (method)">#vulns</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteWorkspaceDataService.html" title="RemoteWorkspaceDataService (module)">RemoteWorkspaceDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteWorkspaceDataService.html#add_workspace-instance_method" title="RemoteWorkspaceDataService#add_workspace (method)">#add_workspace</a></span>, <span class='object_link'><a href="RemoteWorkspaceDataService.html#default_workspace-instance_method" title="RemoteWorkspaceDataService#default_workspace (method)">#default_workspace</a></span>, <span class='object_link'><a href="RemoteWorkspaceDataService.html#delete_workspaces-instance_method" title="RemoteWorkspaceDataService#delete_workspaces (method)">#delete_workspaces</a></span>, <span class='object_link'><a href="RemoteWorkspaceDataService.html#update_workspace-instance_method" title="RemoteWorkspaceDataService#update_workspace (method)">#update_workspace</a></span>, <span class='object_link'><a href="RemoteWorkspaceDataService.html#workspace-instance_method" title="RemoteWorkspaceDataService#workspace (method)">#workspace</a></span>, <span class='object_link'><a href="RemoteWorkspaceDataService.html#workspace=-instance_method" title="RemoteWorkspaceDataService#workspace= (method)">#workspace=</a></span>, <span class='object_link'><a href="RemoteWorkspaceDataService.html#workspaces-instance_method" title="RemoteWorkspaceDataService#workspaces (method)">#workspaces</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteNoteDataService.html" title="RemoteNoteDataService (module)">RemoteNoteDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteNoteDataService.html#delete_note-instance_method" title="RemoteNoteDataService#delete_note (method)">#delete_note</a></span>, <span class='object_link'><a href="RemoteNoteDataService.html#notes-instance_method" title="RemoteNoteDataService#notes (method)">#notes</a></span>, <span class='object_link'><a href="RemoteNoteDataService.html#report_note-instance_method" title="RemoteNoteDataService#report_note (method)">#report_note</a></span>, <span class='object_link'><a href="RemoteNoteDataService.html#update_note-instance_method" title="RemoteNoteDataService#update_note (method)">#update_note</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteEventDataService.html" title="RemoteEventDataService (module)">RemoteEventDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteEventDataService.html#events-instance_method" title="RemoteEventDataService#events (method)">#events</a></span>, <span class='object_link'><a href="RemoteEventDataService.html#report_event-instance_method" title="RemoteEventDataService#report_event (method)">#report_event</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="RemoteHostDataService.html" title="RemoteHostDataService (module)">RemoteHostDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="RemoteHostDataService.html#delete_host-instance_method" title="RemoteHostDataService#delete_host (method)">#delete_host</a></span>, <span class='object_link'><a href="RemoteHostDataService.html#get_host-instance_method" title="RemoteHostDataService#get_host (method)">#get_host</a></span>, <span class='object_link'><a href="RemoteHostDataService.html#hosts-instance_method" title="RemoteHostDataService#hosts (method)">#hosts</a></span>, <span class='object_link'><a href="RemoteHostDataService.html#report_host-instance_method" title="RemoteHostDataService#report_host (method)">#report_host</a></span>, <span class='object_link'><a href="RemoteHostDataService.html#update_host-instance_method" title="RemoteHostDataService#update_host (method)">#update_host</a></span></p>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:49 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

201
api/DbExportDataProxy.html Normal file
View File

@ -0,0 +1,201 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: DbExportDataProxy
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "DbExportDataProxy";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (D)</a> &raquo;
<span class="title">DbExportDataProxy</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: DbExportDataProxy
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="DataProxyAutoLoader.html" title="DataProxyAutoLoader (module)">DataProxyAutoLoader</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/proxy/db_export_data_proxy.rb</dd>
</dl>
</div>
<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="#run_db_export-instance_method" title="#run_db_export (instance method)">#<strong>run_db_export</strong>(path, format) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="run_db_export-instance_method">
#<strong>run_db_export</strong>(path, format) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
2
3
4
5
6
7
8
9
10
11
12
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/db_export_data_proxy.rb', line 2</span>
<span class='kw'>def</span> <span class='id identifier rubyid_run_db_export'>run_db_export</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span>
<span class='label'>format:</span> <span class='id identifier rubyid_format'>format</span>
<span class='rbrace'>}</span>
<span class='id identifier rubyid_add_opts_workspace'>add_opts_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_run_db_export'>run_db_export</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem generating DB Export</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:48 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

174
api/DbExportDataService.html Normal file
View File

@ -0,0 +1,174 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: DbExportDataService
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "DbExportDataService";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (D)</a> &raquo;
<span class="title">DbExportDataService</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: DbExportDataService
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/stubs/db_export_service.rb</dd>
</dl>
</div>
<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="#run_db_export-instance_method" title="#run_db_export (instance method)">#<strong>run_db_export</strong>(path, format) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="run_db_export-instance_method">
#<strong>run_db_export</strong>(path, format) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
2
3
4</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/db_export_service.rb', line 2</span>
<span class='kw'>def</span> <span class='id identifier rubyid_run_db_export'>run_db_export</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DbExportDataService#run_db_export is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:48 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

226
api/DbExportServlet.html Normal file
View File

@ -0,0 +1,226 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: DbExportServlet
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "DbExportServlet";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (D)</a> &raquo;
<span class="title">DbExportServlet</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: DbExportServlet
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/servlet/db_export_servlet.rb</dd>
</dl>
</div>
<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="#api_path-class_method" title="api_path (class method)">.<strong>api_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#registered-class_method" title="registered (class method)">.<strong>registered</strong>(app) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="api_path-class_method">
.<strong>api_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/db_export_servlet.rb', line 3</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_path'>api_path</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api/v1/db-export</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="registered-class_method">
.<strong>registered</strong>(app) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/db_export_servlet.rb', line 7</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_registered'>registered</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='rparen'>)</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='const'><span class='object_link'><a href="" title="DbExportServlet (module)">DbExportServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="DbExportServlet.api_path (method)">api_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_get_db_export'>get_db_export</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:05 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

259
api/DbImportDataProxy.html Normal file
View File

@ -0,0 +1,259 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: DbImportDataProxy
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "DbImportDataProxy";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (D)</a> &raquo;
<span class="title">DbImportDataProxy</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: DbImportDataProxy
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="DataProxyAutoLoader.html" title="DataProxyAutoLoader (module)">DataProxyAutoLoader</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/proxy/db_import_data_proxy.rb</dd>
</dl>
</div>
<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="#import-instance_method" title="#import (instance method)">#<strong>import</strong>(opts, &amp;block) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#import_file-instance_method" title="#import_file (instance method)">#<strong>import_file</strong>(opts, &amp;block) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="import-instance_method">
#<strong>import</strong>(opts, &amp;block) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
2
3
4
5
6
7
8
9
10
11</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/db_import_data_proxy.rb', line 2</span>
<span class='kw'>def</span> <span class='id identifier rubyid_import'>import</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_add_opts_workspace'>add_opts_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_import'>import</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='const'>Exception</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem generating DB Import</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="import_file-instance_method">
#<strong>import_file</strong>(opts, &amp;block) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15
16
17
18
19
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/db_import_data_proxy.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_import_file'>import_file</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_add_opts_workspace'>add_opts_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_import_file'>import_file</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='const'>Exception</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem generating DB Import</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:48 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

226
api/DbImportDataService.html Normal file
View File

@ -0,0 +1,226 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: DbImportDataService
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "DbImportDataService";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (D)</a> &raquo;
<span class="title">DbImportDataService</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: DbImportDataService
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/stubs/db_import_service.rb</dd>
</dl>
</div>
<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="#import-instance_method" title="#import (instance method)">#<strong>import</strong>(opts, &amp;block) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#import_file-instance_method" title="#import_file (instance method)">#<strong>import_file</strong>(opts, &amp;block) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="import-instance_method">
#<strong>import</strong>(opts, &amp;block) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
2
3
4</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/db_import_service.rb', line 2</span>
<span class='kw'>def</span> <span class='id identifier rubyid_import'>import</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DbImportDataService#import is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="import_file-instance_method">
#<strong>import_file</strong>(opts, &amp;block) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
6
7
8</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/db_import_service.rb', line 6</span>
<span class='kw'>def</span> <span class='id identifier rubyid_import_file'>import_file</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DbImportDataService#import_file is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:48 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

226
api/DbImportServlet.html Normal file
View File

@ -0,0 +1,226 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: DbImportServlet
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "DbImportServlet";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (D)</a> &raquo;
<span class="title">DbImportServlet</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: DbImportServlet
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/servlet/db_import_servlet.rb</dd>
</dl>
</div>
<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="#api_path-class_method" title="api_path (class method)">.<strong>api_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#registered-class_method" title="registered (class method)">.<strong>registered</strong>(app) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="api_path-class_method">
.<strong>api_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/db_import_servlet.rb', line 3</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_path'>api_path</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api/v1/db-import</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="registered-class_method">
.<strong>registered</strong>(app) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/db_import_servlet.rb', line 7</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_registered'>registered</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='rparen'>)</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span> <span class='const'><span class='object_link'><a href="" title="DbImportServlet (module)">DbImportServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="DbImportServlet.api_path (method)">api_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_db_import'>db_import</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:05 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

259
api/EventDataProxy.html Normal file
View File

@ -0,0 +1,259 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: EventDataProxy
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "EventDataProxy";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (E)</a> &raquo;
<span class="title">EventDataProxy</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: EventDataProxy
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="DataProxyAutoLoader.html" title="DataProxyAutoLoader (module)">DataProxyAutoLoader</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/proxy/event_data_proxy.rb</dd>
</dl>
</div>
<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="#events-instance_method" title="#events (instance method)">#<strong>events</strong>(opts = {}) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#report_event-instance_method" title="#report_event (instance method)">#<strong>report_event</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="events-instance_method">
#<strong>events</strong>(opts = {}) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5
6
7
8
9
10
11
12</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/event_data_proxy.rb', line 3</span>
<span class='kw'>def</span> <span class='id identifier rubyid_events'>events</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_add_opts_workspace'>add_opts_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_events'>events</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem retrieving events</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="report_event-instance_method">
#<strong>report_event</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16
17
18
19
20
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/event_data_proxy.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_report_event'>report_event</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_add_opts_workspace'>add_opts_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_report_event'>report_event</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem reporting event</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:48 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

231
api/EventDataService.html Normal file
View File

@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: EventDataService
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "EventDataService";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (E)</a> &raquo;
<span class="title">EventDataService</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: EventDataService
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="Metasploit/Framework/DataService.html" title="Metasploit::Framework::DataService (module)">Metasploit::Framework::DataService</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/stubs/event_data_service.rb</dd>
</dl>
</div>
<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="#events-instance_method" title="#events (instance method)">#<strong>events</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#report_event-instance_method" title="#report_event (instance method)">#<strong>report_event</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="events-instance_method">
#<strong>events</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/event_data_service.rb', line 3</span>
<span class='kw'>def</span> <span class='id identifier rubyid_events'>events</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>EventDataService#events is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="report_event-instance_method">
#<strong>report_event</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/event_data_service.rb', line 7</span>
<span class='kw'>def</span> <span class='id identifier rubyid_report_event'>report_event</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>EventDataService#report_event is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:48 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

280
api/EventServlet.html Normal file
View File

@ -0,0 +1,280 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: EventServlet
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "EventServlet";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (E)</a> &raquo;
<span class="title">EventServlet</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: EventServlet
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/servlet/event_servlet.rb</dd>
</dl>
</div>
<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="#api_path-class_method" title="api_path (class method)">.<strong>api_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#api_path_with_id-class_method" title="api_path_with_id (class method)">.<strong>api_path_with_id</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#registered-class_method" title="registered (class method)">.<strong>registered</strong>(app) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="api_path-class_method">
.<strong>api_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/event_servlet.rb', line 3</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_path'>api_path</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api/v1/events</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="api_path_with_id-class_method">
.<strong>api_path_with_id</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/event_servlet.rb', line 7</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_path_with_id'>api_path_with_id</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="" title="EventServlet (module)">EventServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="EventServlet.api_path (method)">api_path</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/?:id?</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="registered-class_method">
.<strong>registered</strong>(app) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13
14</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/event_servlet.rb', line 11</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_registered'>registered</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='rparen'>)</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='const'><span class='object_link'><a href="" title="EventServlet (module)">EventServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path_with_id'><span class='object_link'><a href="#api_path_with_id-class_method" title="EventServlet.api_path_with_id (method)">api_path_with_id</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_get_event'>get_event</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span> <span class='const'><span class='object_link'><a href="" title="EventServlet (module)">EventServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="EventServlet.api_path (method)">api_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_report_event'>report_event</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:35:38 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

323
api/ExploitDataProxy.html Normal file
View File

@ -0,0 +1,323 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: ExploitDataProxy
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "ExploitDataProxy";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (E)</a> &raquo;
<span class="title">ExploitDataProxy</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: ExploitDataProxy
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="DataProxyAutoLoader.html" title="DataProxyAutoLoader (module)">DataProxyAutoLoader</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/proxy/exploit_data_proxy.rb</dd>
</dl>
</div>
<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="#report_exploit_attempt-instance_method" title="#report_exploit_attempt (instance method)">#<strong>report_exploit_attempt</strong>(host, opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#report_exploit_failure-instance_method" title="#report_exploit_failure (instance method)">#<strong>report_exploit_failure</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#report_exploit_success-instance_method" title="#report_exploit_success (instance method)">#<strong>report_exploit_success</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="report_exploit_attempt-instance_method">
#<strong>report_exploit_attempt</strong>(host, opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5
6
7
8
9
10
11</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/exploit_data_proxy.rb', line 3</span>
<span class='kw'>def</span> <span class='id identifier rubyid_report_exploit_attempt'>report_exploit_attempt</span><span class='lparen'>(</span><span class='id identifier rubyid_host'>host</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_report_exploit_attempt'>report_exploit_attempt</span><span class='lparen'>(</span><span class='id identifier rubyid_host'>host</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem reporting exploit attempt</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="report_exploit_failure-instance_method">
#<strong>report_exploit_failure</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15
16
17
18
19
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/exploit_data_proxy.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_report_exploit_failure'>report_exploit_failure</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_add_opts_workspace'>add_opts_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_report_exploit_failure'>report_exploit_failure</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem reporting exploit failure</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="report_exploit_success-instance_method">
#<strong>report_exploit_success</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
24
25
26
27
28
29
30
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/exploit_data_proxy.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_report_exploit_success'>report_exploit_success</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_add_opts_workspace'>add_opts_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_report_exploit_success'>report_exploit_success</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem reporting exploit success</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:48 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

283
api/ExploitDataService.html Normal file
View File

@ -0,0 +1,283 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: ExploitDataService
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "ExploitDataService";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (E)</a> &raquo;
<span class="title">ExploitDataService</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: ExploitDataService
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="Metasploit/Framework/DataService.html" title="Metasploit::Framework::DataService (module)">Metasploit::Framework::DataService</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/stubs/exploit_data_service.rb</dd>
</dl>
</div>
<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="#report_exploit_attempt-instance_method" title="#report_exploit_attempt (instance method)">#<strong>report_exploit_attempt</strong>(host, opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#report_exploit_failure-instance_method" title="#report_exploit_failure (instance method)">#<strong>report_exploit_failure</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#report_exploit_success-instance_method" title="#report_exploit_success (instance method)">#<strong>report_exploit_success</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="report_exploit_attempt-instance_method">
#<strong>report_exploit_attempt</strong>(host, opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/exploit_data_service.rb', line 3</span>
<span class='kw'>def</span> <span class='id identifier rubyid_report_exploit_attempt'>report_exploit_attempt</span><span class='lparen'>(</span><span class='id identifier rubyid_host'>host</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ExploitDataService#report_exploit_attempt is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="report_exploit_failure-instance_method">
#<strong>report_exploit_failure</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/exploit_data_service.rb', line 7</span>
<span class='kw'>def</span> <span class='id identifier rubyid_report_exploit_failure'>report_exploit_failure</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ExploitDataService#report_exploit_failure is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="report_exploit_success-instance_method">
#<strong>report_exploit_success</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/exploit_data_service.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_report_exploit_success'>report_exploit_success</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ExploitDataService#report_exploit_success is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:49 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

226
api/ExploitServlet.html Normal file
View File

@ -0,0 +1,226 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: ExploitServlet
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "ExploitServlet";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (E)</a> &raquo;
<span class="title">ExploitServlet</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: ExploitServlet
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/servlet/exploit_servlet.rb</dd>
</dl>
</div>
<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="#api_path-class_method" title="api_path (class method)">.<strong>api_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#registered-class_method" title="registered (class method)">.<strong>registered</strong>(app) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="api_path-class_method">
.<strong>api_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/exploit_servlet.rb', line 3</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_path'>api_path</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api/v1/exploits</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="registered-class_method">
.<strong>registered</strong>(app) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/exploit_servlet.rb', line 7</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_registered'>registered</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='rparen'>)</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span> <span class='const'><span class='object_link'><a href="" title="ExploitServlet (module)">ExploitServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="ExploitServlet.api_path (method)">api_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_report_exploit'>report_exploit</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:35:51 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

533
api/HostDataProxy.html Normal file
View File

@ -0,0 +1,533 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: HostDataProxy
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "HostDataProxy";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (H)</a> &raquo;
<span class="title">HostDataProxy</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: HostDataProxy
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="DataProxyAutoLoader.html" title="DataProxyAutoLoader (module)">DataProxyAutoLoader</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/proxy/host_data_proxy.rb</dd>
</dl>
</div>
<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="#delete_host-instance_method" title="#delete_host (instance method)">#<strong>delete_host</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#find_or_create_host-instance_method" title="#find_or_create_host (instance method)">#<strong>find_or_create_host</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#get_host-instance_method" title="#get_host (instance method)">#<strong>get_host</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#hosts-instance_method" title="#hosts (instance method)">#<strong>hosts</strong>(opts = {}) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#report_host-instance_method" title="#report_host (instance method)">#<strong>report_host</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update_host-instance_method" title="#update_host (instance method)">#<strong>update_host</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="delete_host-instance_method">
#<strong>delete_host</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
64
65
66
67
68
69
70
71
72</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/host_data_proxy.rb', line 64</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_host'>delete_host</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_delete_host'>delete_host</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem deleting host</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="find_or_create_host-instance_method">
#<strong>find_or_create_host</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19
20
21
22
23
24
25
26
27
28
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/host_data_proxy.rb', line 17</span>
<span class='kw'>def</span> <span class='id identifier rubyid_find_or_create_host'>find_or_create_host</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='id identifier rubyid_host'>host</span> <span class='op'>=</span> <span class='id identifier rubyid_hosts'>hosts</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_clone'>clone</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_host'>host</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_host'>host</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_host'>host</span> <span class='op'>=</span> <span class='id identifier rubyid_report_host'>report_host</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_clone'>clone</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_host'>host</span> <span class='op'>=</span> <span class='id identifier rubyid_host'>host</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_host'>host</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem finding or creating host</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="get_host-instance_method">
#<strong>get_host</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
31
32
33
34
35
36
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/host_data_proxy.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_get_host'>get_host</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_get_host'>get_host</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem retrieving host</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="hosts-instance_method">
#<strong>hosts</strong>(opts = {}) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5
6
7
8
9
10
11
12
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/host_data_proxy.rb', line 3</span>
<span class='kw'>def</span> <span class='id identifier rubyid_hosts'>hosts</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:non_dead</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='symbol'>:non_dead</span><span class='rparen'>)</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:address</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:address</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:host</span><span class='rparen'>)</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:search_term</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='kw'>unless</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='symbol'>:search_term</span><span class='rparen'>)</span>
<span class='id identifier rubyid_add_opts_workspace'>add_opts_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_hosts'>hosts</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem retrieving hosts</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="report_host-instance_method">
#<strong>report_host</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43
44
45
46
47
48
49
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/host_data_proxy.rb', line 41</span>
<span class='kw'>def</span> <span class='id identifier rubyid_report_host'>report_host</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_valid'>valid</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_add_opts_workspace'>add_opts_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_report_host'>report_host</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem reporting host</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="update_host-instance_method">
#<strong>update_host</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
54
55
56
57
58
59
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/host_data_proxy.rb', line 54</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update_host'>update_host</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_update_host'>update_host</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem updating host</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:47 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

491
api/HostDataService.html Normal file
View File

@ -0,0 +1,491 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: HostDataService
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "HostDataService";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (H)</a> &raquo;
<span class="title">HostDataService</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: HostDataService
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="Metasploit/Framework/DataService.html" title="Metasploit::Framework::DataService (module)">Metasploit::Framework::DataService</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/stubs/host_data_service.rb</dd>
</dl>
</div>
<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="#delete_host-instance_method" title="#delete_host (instance method)">#<strong>delete_host</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#find_or_create_host-instance_method" title="#find_or_create_host (instance method)">#<strong>find_or_create_host</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#get_host-instance_method" title="#get_host (instance method)">#<strong>get_host</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#hosts-instance_method" title="#hosts (instance method)">#<strong>hosts</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#report_host-instance_method" title="#report_host (instance method)">#<strong>report_host</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#report_hosts-instance_method" title="#report_hosts (instance method)">#<strong>report_hosts</strong>(hosts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update_host-instance_method" title="#update_host (instance method)">#<strong>update_host</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="delete_host-instance_method">
#<strong>delete_host</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/host_data_service.rb', line 27</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_host'>delete_host</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>HostDataService#delete_host is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="find_or_create_host-instance_method">
#<strong>find_or_create_host</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/host_data_service.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_find_or_create_host'>find_or_create_host</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>HostDataService#find_or_create_host is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="get_host-instance_method">
#<strong>get_host</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/host_data_service.rb', line 3</span>
<span class='kw'>def</span> <span class='id identifier rubyid_get_host'>get_host</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>HostDataService#get_host is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="hosts-instance_method">
#<strong>hosts</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/host_data_service.rb', line 15</span>
<span class='kw'>def</span> <span class='id identifier rubyid_hosts'>hosts</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>HostDataService#hosts is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="report_host-instance_method">
#<strong>report_host</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/host_data_service.rb', line 7</span>
<span class='kw'>def</span> <span class='id identifier rubyid_report_host'>report_host</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>HostDataService#report_host is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="report_hosts-instance_method">
#<strong>report_hosts</strong>(hosts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/host_data_service.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_report_hosts'>report_hosts</span><span class='lparen'>(</span><span class='id identifier rubyid_hosts'>hosts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>HostDataService#report_hosts is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="update_host-instance_method">
#<strong>update_host</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/host_data_service.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update_host'>update_host</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>HostDataService#update_host is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:48 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

338
api/HostServlet.html Normal file
View File

@ -0,0 +1,338 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: HostServlet
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "HostServlet";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (H)</a> &raquo;
<span class="title">HostServlet</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: HostServlet
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/servlet/host_servlet.rb</dd>
</dl>
</div>
<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="#api_path-class_method" title="api_path (class method)">.<strong>api_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#api_path_with_id-class_method" title="api_path_with_id (class method)">.<strong>api_path_with_id</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#api_search_path-class_method" title="api_search_path (class method)">.<strong>api_search_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#registered-class_method" title="registered (class method)">.<strong>registered</strong>(app) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="api_path-class_method">
.<strong>api_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/host_servlet.rb', line 3</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_path'>api_path</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api/v1/hosts</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="api_path_with_id-class_method">
.<strong>api_path_with_id</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/host_servlet.rb', line 7</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_path_with_id'>api_path_with_id</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="" title="HostServlet (module)">HostServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="HostServlet.api_path (method)">api_path</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/?:id?</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="api_search_path-class_method">
.<strong>api_search_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/host_servlet.rb', line 11</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_search_path'>api_search_path</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="" title="HostServlet (module)">HostServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="HostServlet.api_path (method)">api_path</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/search</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="registered-class_method">
.<strong>registered</strong>(app) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17
18
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/host_servlet.rb', line 15</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_registered'>registered</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='rparen'>)</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='const'><span class='object_link'><a href="" title="HostServlet (module)">HostServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path_with_id'><span class='object_link'><a href="#api_path_with_id-class_method" title="HostServlet.api_path_with_id (method)">api_path_with_id</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_get_host'>get_host</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span> <span class='const'><span class='object_link'><a href="" title="HostServlet (module)">HostServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="HostServlet.api_path (method)">api_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_report_host'>report_host</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</span> <span class='const'><span class='object_link'><a href="" title="HostServlet (module)">HostServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path_with_id'><span class='object_link'><a href="#api_path_with_id-class_method" title="HostServlet.api_path_with_id (method)">api_path_with_id</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_update_host'>update_host</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='const'><span class='object_link'><a href="" title="HostServlet (module)">HostServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="HostServlet.api_path (method)">api_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_delete_host'>delete_host</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span> <span class='const'><span class='object_link'><a href="" title="HostServlet (module)">HostServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_search_path'><span class='object_link'><a href="#api_search_path-class_method" title="HostServlet.api_search_path (method)">api_search_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_search'>search</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:35:26 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

216
api/HttpDBManagerService.html Normal file
View File

@ -0,0 +1,216 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: HttpDBManagerService
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "HttpDBManagerService";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (H)</a> &raquo;
<span class="title">HttpDBManagerService</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: HttpDBManagerService
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">HttpDBManagerService</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/http_db_manager_service.rb</dd>
</dl>
</div>
<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="#start-instance_method" title="#start (instance method)">#<strong>start</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="start-instance_method">
#<strong>start</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/http_db_manager_service.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_start'>start</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_parsed_options'>parsed_options</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metasploit/Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metasploit/Framework/ParsedOptions.html" title="Metasploit::Framework::ParsedOptions (module)">ParsedOptions</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metasploit/Framework/ParsedOptions/RemoteDB.html" title="Metasploit::Framework::ParsedOptions::RemoteDB (class)">RemoteDB</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Metasploit/Framework/ParsedOptions/Base.html#initialize-instance_method" title="Metasploit::Framework::ParsedOptions::Base#initialize (method)">new</a></span></span>
<span class='id identifier rubyid_require_environment!'>require_environment!</span><span class='lparen'>(</span><span class='id identifier rubyid_parsed_options'>parsed_options</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ssl</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_ssl_opts'>ssl_opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_ssl_opts'>ssl_opts</span><span class='lbracket'>[</span><span class='symbol'>:private_key_file</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ssl_key</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_ssl_opts'>ssl_opts</span><span class='lbracket'>[</span><span class='symbol'>:cert_chain_file</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ssl_cert</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_ssl_opts'>ssl_opts</span><span class='lbracket'>[</span><span class='symbol'>:verify_peer</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>false</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ssl</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>true</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:ssl_opts</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ssl_opts'>ssl_opts</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_init_db'>init_db</span>
<span class='id identifier rubyid_start_http_server'>start_http_server</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:38:55 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

126
api/IPSFilter.html Normal file
View File

@ -0,0 +1,126 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: IPSFilter
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "IPSFilter";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (I)</a> &raquo;
<span class="title">IPSFilter</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: IPSFilter
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>plugins/ips_filter.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This module extends the captured socket instance</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="IPSFilter/SocketTracer.html" title="IPSFilter::SocketTracer (module)">SocketTracer</a></span>
</p>
</div>
<div id="footer">
Generated on Tue Apr 23 22:37:15 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

514
api/IPSFilter/SocketTracer.html Normal file
View File

@ -0,0 +1,514 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: IPSFilter::SocketTracer
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "IPSFilter::SocketTracer";
relpath = '../';
</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 class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (S)</a> &raquo;
<span class='title'><span class='object_link'><a href="../IPSFilter.html" title="IPSFilter (module)">IPSFilter</a></span></span>
&raquo;
<span class="title">SocketTracer</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: IPSFilter::SocketTracer
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>plugins/ips_filter.rb</dd>
</dl>
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="SIGS-constant" class="">SIGS =
<div class="docstring">
<div class="discussion">
<p>Extend this as needed :-)</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbracket'>[</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DCOM.C</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.*\\\x5c\x00\\\x5c\x00\x46\x00\x58\x00\x4e\x00\x42\x00\x46\x00\x58\x00\x46\x00\x58\x00.*\xcc\xe0\xfd\x7f.*</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>BLASTER</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.*\\\x5c\x00\\\x5c\x00\x46\x00\x58\x00\x4e\x00\x42\x00\x46\x00\x58\x00\x46\x00\x58\x00.*\xcc\xe0\xfd\x7f.*</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>REMACT</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.*\xb8\x4a\x9f\x4d\x1c\\}\xcf\x11\x86\x1e\x00\x20\xaf\x6e.*</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>x86 NOP SLED</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\x90\x90</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='rbracket'>]</span></pre></dd>
</dl>
<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="#context-instance_method" title="#context (instance method)">#<strong>context</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute context.</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="#close-instance_method" title="#close (instance method)">#<strong>close</strong>(*args) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ips_match-instance_method" title="#ips_match (instance method)">#<strong>ips_match</strong>(data) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#read-instance_method" title="#read (instance method)">#<strong>read</strong>(length = nil, opts = {}) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Hook the read method.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#write-instance_method" title="#write (instance method)">#<strong>write</strong>(buf, opts = {}) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Hook the write method.</p>
</div></span>
</li>
</ul>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="context=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="context-instance_method">
#<strong>context</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute context</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
66
67
68</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'plugins/ips_filter.rb', line 66</span>
<span class='kw'>def</span> <span class='id identifier rubyid_context'>context</span>
<span class='ivar'>@context</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="close-instance_method">
#<strong>close</strong>(*args) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
86
87
88</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'plugins/ips_filter.rb', line 86</span>
<span class='kw'>def</span> <span class='id identifier rubyid_close'>close</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="ips_match-instance_method">
#<strong>ips_match</strong>(data) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'plugins/ips_filter.rb', line 90</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ips_match'>ips_match</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='id identifier rubyid_lp'>lp</span> <span class='op'>=</span> <span class='id identifier rubyid_localport'>localport</span>
<span class='id identifier rubyid_rp'>rp</span> <span class='op'>=</span> <span class='id identifier rubyid_peerport'>peerport</span>
<span class='const'><span class='object_link'><a href="#SIGS-constant" title="IPSFilter::SocketTracer::SIGS (constant)">SIGS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span>
<span class='kw'>begin</span>
<span class='id identifier rubyid_r'>r</span> <span class='op'>=</span> <span class='const'>Regexp</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_s'>s</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='id identifier rubyid_r'>r</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_print_error'><span class='object_link'><a href="../top-level-namespace.html#print_error-instance_method" title="#print_error (method)">print_error</a></span></span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Matched IPS signature </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_s'>s</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>return</span> <span class='kw'>true</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>::</span><span class='const'>Exception</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='id identifier rubyid_print_error'><span class='object_link'><a href="../top-level-namespace.html#print_error-instance_method" title="#print_error (method)">print_error</a></span></span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Compiled error: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_s'>s</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>return</span> <span class='kw'>false</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="read-instance_method">
#<strong>read</strong>(length = nil, opts = {}) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Hook the read method</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
78
79
80
81
82
83
84</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'plugins/ips_filter.rb', line 78</span>
<span class='kw'>def</span> <span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_length'>length</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_r'>r</span> <span class='op'>=</span> <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_length'>length</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_ips_match'>ips_match</span><span class='lparen'>(</span><span class='id identifier rubyid_r'>r</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_print_error'><span class='object_link'><a href="../top-level-namespace.html#print_error-instance_method" title="#print_error (method)">print_error</a></span></span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Incoming read may match a known signature</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>return</span> <span class='id identifier rubyid_r'>r</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="write-instance_method">
#<strong>write</strong>(buf, opts = {}) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Hook the write method</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
69
70
71
72
73
74
75</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'plugins/ips_filter.rb', line 69</span>
<span class='kw'>def</span> <span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_buf'>buf</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_ips_match'>ips_match</span><span class='lparen'>(</span><span class='id identifier rubyid_buf'>buf</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_print_error'><span class='object_link'><a href="../top-level-namespace.html#print_error-instance_method" title="#print_error (method)">print_error</a></span></span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Outbound write blocked due to possible signature match</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>return</span> <span class='int'>0</span>
<span class='kw'>end</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_buf'>buf</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:37:15 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

206
api/JobProcessor.html Normal file
View File

@ -0,0 +1,206 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: JobProcessor
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "JobProcessor";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (J)</a> &raquo;
<span class="title">JobProcessor</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: JobProcessor
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">JobProcessor</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd>Singleton</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/job_processor.rb</dd>
</dl>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="JobProcessor/JobWraper.html" title="JobProcessor::JobWraper (class)">JobWraper</a></span>
</p>
<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="#submit_job-instance_method" title="#submit_job (instance method)">#<strong>submit_job</strong>(job_args, &amp;job) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="submit_job-instance_method">
#<strong>submit_job</strong>(job_args, &amp;job) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
6
7
8</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/job_processor.rb', line 6</span>
<span class='kw'>def</span> <span class='id identifier rubyid_submit_job'>submit_job</span><span class='lparen'>(</span><span class='id identifier rubyid_job_args'>job_args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_job'>job</span><span class='rparen'>)</span>
<span class='ivar'>@job_queue</span> <span class='op'>&lt;&lt;</span> <span class='const'><span class='object_link'><a href="JobProcessor/JobWraper.html" title="JobProcessor::JobWraper (class)">JobWraper</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="JobProcessor/JobWraper.html#initialize-instance_method" title="JobProcessor::JobWraper#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_job_args'>job_args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_job'>job</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:38:37 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

359
api/JobProcessor/JobWraper.html Normal file
View File

@ -0,0 +1,359 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: JobProcessor::JobWraper
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "JobProcessor::JobWraper";
relpath = '../';
</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 class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (J)</a> &raquo;
<span class='title'><span class='object_link'><a href="../JobProcessor.html" title="JobProcessor (class)">JobProcessor</a></span></span>
&raquo;
<span class="title">JobWraper</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: JobProcessor::JobWraper
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">JobProcessor::JobWraper</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/job_processor.rb</dd>
</dl>
</div>
<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="#job-instance_method" title="#job (instance method)">#<strong>job</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute job.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#job_args-instance_method" title="#job_args (instance method)">#<strong>job_args</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute job_args.</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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(job_args, &amp;job) &#x21d2; JobWraper </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of JobWraper.</p>
</div></span>
</li>
</ul>
<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">
#<strong>initialize</strong>(job_args, &amp;job) &#x21d2; <tt><span class='object_link'><a href="" title="JobProcessor::JobWraper (class)">JobWraper</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of JobWraper</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
34
35
36
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/job_processor.rb', line 34</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_job_args'>job_args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_job'>job</span><span class='rparen'>)</span>
<span class='ivar'>@job_args</span> <span class='op'>=</span> <span class='id identifier rubyid_job_args'>job_args</span>
<span class='ivar'>@job</span> <span class='op'>=</span> <span class='id identifier rubyid_job'>job</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=""></span>
<div class="method_details first">
<h3 class="signature first" id="job-instance_method">
#<strong>job</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute job</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/job_processor.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_job'>job</span>
<span class='ivar'>@job</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="job_args-instance_method">
#<strong>job_args</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute job_args</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/job_processor.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_job_args'>job_args</span>
<span class='ivar'>@job_args</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:38:37 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

413
api/LoginDataProxy.html Normal file
View File

@ -0,0 +1,413 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: LoginDataProxy
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "LoginDataProxy";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (L)</a> &raquo;
<span class="title">LoginDataProxy</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: LoginDataProxy
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="DataProxyAutoLoader.html" title="DataProxyAutoLoader (module)">DataProxyAutoLoader</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/proxy/login_data_proxy.rb</dd>
</dl>
</div>
<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="#create_credential_login-instance_method" title="#create_credential_login (instance method)">#<strong>create_credential_login</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#invalidate_login-instance_method" title="#invalidate_login (instance method)">#<strong>invalidate_login</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#logins-instance_method" title="#logins (instance method)">#<strong>logins</strong>(opts = {}) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update_login-instance_method" title="#update_login (instance method)">#<strong>update_login</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="create_credential_login-instance_method">
#<strong>create_credential_login</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
12
13
14
15
16
17
18
19
20</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/login_data_proxy.rb', line 12</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_credential_login'>create_credential_login</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_create_credential_login'>create_credential_login</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem creating login</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="invalidate_login-instance_method">
#<strong>invalidate_login</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/login_data_proxy.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_invalidate_login'>invalidate_login</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='id identifier rubyid_add_opts_workspace'>add_opts_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='comment'># Search for an existing Metasploit::Credential::Core object. It requires specific attributes.
</span> <span class='id identifier rubyid_core_opts'>core_opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_core_opts'>core_opts</span><span class='lbracket'>[</span><span class='symbol'>:workspace</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:workspace</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_core_opts'>core_opts</span><span class='lbracket'>[</span><span class='symbol'>:user</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:username</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:username</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_core_opts'>core_opts</span><span class='lbracket'>[</span><span class='symbol'>:pass</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:private_data</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:private_data</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_core_opts'>core_opts</span><span class='lbracket'>[</span><span class='symbol'>:ports</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:port</span><span class='rparen'>)</span> <span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:port</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_core_opts'>core_opts</span><span class='lbracket'>[</span><span class='symbol'>:host_ranges</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:address</span><span class='rparen'>)</span> <span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:address</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_core_opts'>core_opts</span><span class='lbracket'>[</span><span class='symbol'>:svcs</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:service_name</span><span class='rparen'>)</span> <span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:service_name</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_core'>core</span> <span class='op'>=</span> <span class='id identifier rubyid_creds'>creds</span><span class='lparen'>(</span><span class='id identifier rubyid_core_opts'>core_opts</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='kw'>if</span> <span class='id identifier rubyid_core'>core</span>
<span class='id identifier rubyid_core'>core</span><span class='period'>.</span><span class='id identifier rubyid_logins'>logins</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_login'>login</span><span class='op'>|</span>
<span class='id identifier rubyid_login_opts'>login_opts</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_slice'>slice</span><span class='lparen'>(</span><span class='symbol'>:access_level</span><span class='comma'>,</span> <span class='symbol'>:status</span><span class='comma'>,</span> <span class='symbol'>:last_attempted_at</span><span class='rparen'>)</span>
<span class='id identifier rubyid_login_opts'>login_opts</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_login'>login</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
<span class='id identifier rubyid_update_login'>update_login</span><span class='lparen'>(</span><span class='id identifier rubyid_login_opts'>login_opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem invalidating login</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="logins-instance_method">
#<strong>logins</strong>(opts = {}) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
2
3
4
5
6
7
8
9
10</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/login_data_proxy.rb', line 2</span>
<span class='kw'>def</span> <span class='id identifier rubyid_logins'>logins</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_logins'>logins</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem retrieving logins</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="update_login-instance_method">
#<strong>update_login</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
22
23
24
25
26
27
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/login_data_proxy.rb', line 22</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update_login'>update_login</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_update_login'>update_login</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem updating login</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:48 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

278
api/LoginDataService.html Normal file
View File

@ -0,0 +1,278 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: LoginDataService
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "LoginDataService";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (L)</a> &raquo;
<span class="title">LoginDataService</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: LoginDataService
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/stubs/login_data_service.rb</dd>
</dl>
</div>
<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="#create_credential_login-instance_method" title="#create_credential_login (instance method)">#<strong>create_credential_login</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#logins-instance_method" title="#logins (instance method)">#<strong>logins</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update_login-instance_method" title="#update_login (instance method)">#<strong>update_login</strong>(hosts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="create_credential_login-instance_method">
#<strong>create_credential_login</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/login_data_service.rb', line 7</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_credential_login'>create_credential_login</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>LoginDataService#create_credential_login is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="logins-instance_method">
#<strong>logins</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/login_data_service.rb', line 3</span>
<span class='kw'>def</span> <span class='id identifier rubyid_logins'>logins</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>LoginDataService#logins is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="update_login-instance_method">
#<strong>update_login</strong>(hosts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/login_data_service.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update_login'>update_login</span><span class='lparen'>(</span><span class='id identifier rubyid_hosts'>hosts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>LoginDataService#update_login is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:48 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

284
api/LoginServlet.html Normal file
View File

@ -0,0 +1,284 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: LoginServlet
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "LoginServlet";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (L)</a> &raquo;
<span class="title">LoginServlet</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: LoginServlet
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/servlet/login_servlet.rb</dd>
</dl>
</div>
<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="#api_path-class_method" title="api_path (class method)">.<strong>api_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#api_path_with_id-class_method" title="api_path_with_id (class method)">.<strong>api_path_with_id</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#registered-class_method" title="registered (class method)">.<strong>registered</strong>(app) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="api_path-class_method">
.<strong>api_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/login_servlet.rb', line 3</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_path'>api_path</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api/v1/logins</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="api_path_with_id-class_method">
.<strong>api_path_with_id</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/login_servlet.rb', line 7</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_path_with_id'>api_path_with_id</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="" title="LoginServlet (module)">LoginServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="LoginServlet.api_path (method)">api_path</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/?:id?</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="registered-class_method">
.<strong>registered</strong>(app) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/login_servlet.rb', line 11</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_registered'>registered</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='rparen'>)</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='const'><span class='object_link'><a href="" title="LoginServlet (module)">LoginServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path_with_id'><span class='object_link'><a href="#api_path_with_id-class_method" title="LoginServlet.api_path_with_id (method)">api_path_with_id</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_get_logins'>get_logins</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span> <span class='const'><span class='object_link'><a href="" title="LoginServlet (module)">LoginServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="LoginServlet.api_path (method)">api_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_create_login'>create_login</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</span> <span class='const'><span class='object_link'><a href="" title="LoginServlet (module)">LoginServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path_with_id'><span class='object_link'><a href="#api_path_with_id-class_method" title="LoginServlet.api_path_with_id (method)">api_path_with_id</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_update_login'>update_login</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='const'><span class='object_link'><a href="" title="LoginServlet (module)">LoginServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="LoginServlet.api_path (method)">api_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_delete_logins'>delete_logins</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:35:38 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

423
api/LootDataProxy.html Normal file
View File

@ -0,0 +1,423 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: LootDataProxy
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "LootDataProxy";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (L)</a> &raquo;
<span class="title">LootDataProxy</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: LootDataProxy
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="DataProxyAutoLoader.html" title="DataProxyAutoLoader (module)">DataProxyAutoLoader</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/proxy/loot_data_proxy.rb</dd>
</dl>
</div>
<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="#find_or_create_loot-instance_method" title="#find_or_create_loot (instance method)">#<strong>find_or_create_loot</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#loots-instance_method" title="#loots (instance method)">#<strong>loots</strong>(opts = {}) &#x21d2; Object </a>
(also: #loot)
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#report_loot-instance_method" title="#report_loot (instance method)">#<strong>report_loot</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update_loot-instance_method" title="#update_loot (instance method)">#<strong>update_loot</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="find_or_create_loot-instance_method">
#<strong>find_or_create_loot</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/loot_data_proxy.rb', line 17</span>
<span class='kw'>def</span> <span class='id identifier rubyid_find_or_create_loot'>find_or_create_loot</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='comment'># create separate opts for find operation since the report operation uses slightly different keys
</span> <span class='comment'># TODO: standardize option keys used for the find and report operations
</span> <span class='id identifier rubyid_find_opts'>find_opts</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_clone'>clone</span>
<span class='comment'># convert type to ltype
</span> <span class='id identifier rubyid_find_opts'>find_opts</span><span class='lbracket'>[</span><span class='symbol'>:ltype</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_find_opts'>find_opts</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:type</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_find_opts'>find_opts</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:type</span><span class='rparen'>)</span>
<span class='comment'># convert host to nested hosts address
</span> <span class='id identifier rubyid_find_opts'>find_opts</span><span class='lbracket'>[</span><span class='symbol'>:hosts</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>address:</span> <span class='id identifier rubyid_find_opts'>find_opts</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:host</span><span class='rparen'>)</span><span class='rbrace'>}</span> <span class='kw'>if</span> <span class='id identifier rubyid_find_opts'>find_opts</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:host</span><span class='rparen'>)</span>
<span class='id identifier rubyid_loot'>loot</span> <span class='op'>=</span> <span class='id identifier rubyid_loots'>loots</span><span class='lparen'>(</span><span class='id identifier rubyid_find_opts'>find_opts</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_loot'>loot</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_loot'>loot</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_loot'>loot</span> <span class='op'>=</span> <span class='id identifier rubyid_report_loot'>report_loot</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_clone'>clone</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_loot'>loot</span> <span class='op'>=</span> <span class='id identifier rubyid_loot'>loot</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_loot'>loot</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem finding or creating loot</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="loots-instance_method">
#<strong>loots</strong>(opts = {}) &#x21d2; <tt>Object</tt>
<span class="aliases">Also known as:
<span class="names"><span id='loot-instance_method'>loot</span></span>
</span>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41
42
43
44
45
46
47
48</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/loot_data_proxy.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_loots'>loots</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_add_opts_workspace'>add_opts_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_loot'>loot</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem retrieving loot</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="report_loot-instance_method">
#<strong>report_loot</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5
6
7
8
9
10
11
12
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/loot_data_proxy.rb', line 3</span>
<span class='kw'>def</span> <span class='id identifier rubyid_report_loot'>report_loot</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Msf.html" title="Msf (module)">Msf</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Msf/DBManager.html" title="Msf::DBManager (class)">DBManager</a></span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:data</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Base64</span><span class='period'>.</span><span class='id identifier rubyid_urlsafe_encode64'>urlsafe_encode64</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:data</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:data</span><span class='rbracket'>]</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_add_opts_workspace'>add_opts_workspace</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_report_loot'>report_loot</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem reporting loot</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="update_loot-instance_method">
#<strong>update_loot</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
52
53
54
55
56
57
58
59
60</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/proxy/loot_data_proxy.rb', line 52</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update_loot'>update_loot</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_data_service_operation'>data_service_operation</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data_service'>data_service</span><span class='op'>|</span>
<span class='id identifier rubyid_data_service'>data_service</span><span class='period'>.</span><span class='id identifier rubyid_update_loot'>update_loot</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Problem updating loot</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:47 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

335
api/LootDataService.html Normal file
View File

@ -0,0 +1,335 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: LootDataService
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "LootDataService";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (L)</a> &raquo;
<span class="title">LootDataService</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: LootDataService
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="Metasploit/Framework/DataService.html" title="Metasploit::Framework::DataService (module)">Metasploit::Framework::DataService</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/stubs/loot_data_service.rb</dd>
</dl>
</div>
<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="#find_or_create_loot-instance_method" title="#find_or_create_loot (instance method)">#<strong>find_or_create_loot</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#loot-instance_method" title="#loot (instance method)">#<strong>loot</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#report_loot-instance_method" title="#report_loot (instance method)">#<strong>report_loot</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update_loot-instance_method" title="#update_loot (instance method)">#<strong>update_loot</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="find_or_create_loot-instance_method">
#<strong>find_or_create_loot</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/loot_data_service.rb', line 7</span>
<span class='kw'>def</span> <span class='id identifier rubyid_find_or_create_loot'>find_or_create_loot</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>LootDataService#find_or_create_loot is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="loot-instance_method">
#<strong>loot</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/loot_data_service.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_loot'>loot</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>LootDataService#loots is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="report_loot-instance_method">
#<strong>report_loot</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/loot_data_service.rb', line 3</span>
<span class='kw'>def</span> <span class='id identifier rubyid_report_loot'>report_loot</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>LootDataService#report_loot is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="update_loot-instance_method">
#<strong>update_loot</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/stubs/loot_data_service.rb', line 15</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update_loot'>update_loot</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>LootDataService#update_loot is not implemented</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:48 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

284
api/LootServlet.html Normal file
View File

@ -0,0 +1,284 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: LootServlet
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "LootServlet";
relpath = '';
</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 class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (L)</a> &raquo;
<span class="title">LootServlet</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: LootServlet
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/web_services/servlet/loot_servlet.rb</dd>
</dl>
</div>
<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="#api_path-class_method" title="api_path (class method)">.<strong>api_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#api_path_with_id-class_method" title="api_path_with_id (class method)">.<strong>api_path_with_id</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#registered-class_method" title="registered (class method)">.<strong>registered</strong>(app) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="api_path-class_method">
.<strong>api_path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
3
4
5</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/loot_servlet.rb', line 3</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_path'>api_path</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api/v1/loots</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="api_path_with_id-class_method">
.<strong>api_path_with_id</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/loot_servlet.rb', line 7</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_path_with_id'>api_path_with_id</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="" title="LootServlet (module)">LootServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="LootServlet.api_path (method)">api_path</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/?:id?</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="registered-class_method">
.<strong>registered</strong>(app) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/web_services/servlet/loot_servlet.rb', line 11</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_registered'>registered</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='rparen'>)</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='const'><span class='object_link'><a href="" title="LootServlet (module)">LootServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path_with_id'><span class='object_link'><a href="#api_path_with_id-class_method" title="LootServlet.api_path_with_id (method)">api_path_with_id</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_get_loot'>get_loot</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span> <span class='const'><span class='object_link'><a href="" title="LootServlet (module)">LootServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="LootServlet.api_path (method)">api_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_report_loot'>report_loot</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</span> <span class='const'><span class='object_link'><a href="" title="LootServlet (module)">LootServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path_with_id'><span class='object_link'><a href="#api_path_with_id-class_method" title="LootServlet.api_path_with_id (method)">api_path_with_id</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_update_loot'>update_loot</span>
<span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='const'><span class='object_link'><a href="" title="LootServlet (module)">LootServlet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_path'><span class='object_link'><a href="#api_path-class_method" title="LootServlet.api_path (method)">api_path</a></span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_delete_loot'>delete_loot</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:35:26 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

111
api/Mdm/Workspace/BoundaryRange.html Normal file
View File

@ -0,0 +1,111 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Mdm::Workspace::BoundaryRange
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Mdm::Workspace::BoundaryRange";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (B)</a> &raquo;
<span class='title'>Mdm</span> &raquo; <span class='title'>Workspace</span>
&raquo;
<span class="title">BoundaryRange</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Mdm::Workspace::BoundaryRange
</h1>
<div class="box_info">
<dl>
<dt>Extended by:</dt>
<dd>ActiveSupport::Concern</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>app/concerns/mdm/workspace/boundary_range.rb</dd>
</dl>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:30:02 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

776
api/Metasploit.html Normal file
View File

File diff suppressed because one or more lines are too long

111
api/Metasploit/Credential/Core/ToCredential.html Normal file
View File

@ -0,0 +1,111 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Credential::Core::ToCredential
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Credential::Core::ToCredential";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (T)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'>Credential</span> &raquo; <span class='title'>Core</span>
&raquo;
<span class="title">ToCredential</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Credential::Core::ToCredential
</h1>
<div class="box_info">
<dl>
<dt>Extended by:</dt>
<dd>ActiveSupport::Concern</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>app/concerns/metasploit/credential/core/to_credential.rb</dd>
</dl>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:30:02 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

265
api/Metasploit/Framework.html Normal file
View File

File diff suppressed because one or more lines are too long

115
api/Metasploit/Framework/AFP.html Normal file
View File

@ -0,0 +1,115 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::AFP
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::AFP";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (A)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span>
&raquo;
<span class="title">AFP</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::AFP
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/afp/client.rb</dd>
</dl>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="AFP/Client.html" title="Metasploit::Framework::AFP::Client (module)">Client</a></span>
</p>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:41 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

1483
api/Metasploit/Framework/AFP/Client.html Normal file
View File

File diff suppressed because it is too large Load Diff

138
api/Metasploit/Framework/API.html Normal file
View File

@ -0,0 +1,138 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::API
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::API";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (A)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span>
&raquo;
<span class="title">API</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::API
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/api.rb<span class="defines">,<br />
lib/metasploit/framework/api/version.rb</span>
</dd>
</dl>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="API/Version.html" title="Metasploit::Framework::API::Version (module)">Version</a></span>
</p>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="VERSION-constant" class="">VERSION =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="API/Version.html" title="Metasploit::Framework::API::Version (module)">Version</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="API/Version.html#MAJOR-constant" title="Metasploit::Framework::API::Version::MAJOR (constant)">MAJOR</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>.</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="API/Version.html" title="Metasploit::Framework::API::Version (module)">Version</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="API/Version.html#MINOR-constant" title="Metasploit::Framework::API::Version::MINOR (constant)">MINOR</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>.</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="API/Version.html" title="Metasploit::Framework::API::Version (module)">Version</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="API/Version.html#PATCH-constant" title="Metasploit::Framework::API::Version::PATCH (constant)">PATCH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span></pre></dd>
<dt id="GEM_VERSION-constant" class="">GEM_VERSION =
</dt>
<dd><pre class="code"><span class='const'>Gem</span><span class='op'>::</span><span class='const'>Version</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#VERSION-constant" title="Metasploit::Framework::API::VERSION (constant)">VERSION</a></span></span><span class='rparen'>)</span></pre></dd>
</dl>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:40 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

150
api/Metasploit/Framework/API/Version.html Normal file
View File

@ -0,0 +1,150 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::API::Version
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::API::Version";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (V)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../API.html" title="Metasploit::Framework::API (module)">API</a></span></span>
&raquo;
<span class="title">Version</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::API::Version
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/api/version.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'>
<p>This is a like. The API version is not semantically version and it&#39;s
version has actually never changed even though API changes have occured.
DO NOT base compatibility on this version.</p>
</div>
</div>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="MAJOR-constant" class="">MAJOR =
</dt>
<dd><pre class="code"><span class='int'>1</span></pre></dd>
<dt id="MINOR-constant" class="">MINOR =
</dt>
<dd><pre class="code"><span class='int'>0</span></pre></dd>
<dt id="PATCH-constant" class="">PATCH =
</dt>
<dd><pre class="code"><span class='int'>0</span></pre></dd>
</dl>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:42 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

115
api/Metasploit/Framework/Aws.html Normal file
View File

@ -0,0 +1,115 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::Aws
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::Aws";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (A)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span>
&raquo;
<span class="title">Aws</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::Aws
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/aws/client.rb</dd>
</dl>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Aws/Client.html" title="Metasploit::Framework::Aws::Client (module)">Client</a></span>
</p>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:41 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

1280
api/Metasploit/Framework/Aws/Client.html Normal file
View File

File diff suppressed because one or more lines are too long

121
api/Metasploit/Framework/Command.html Normal file
View File

@ -0,0 +1,121 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::Command
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::Command";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (C)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span>
&raquo;
<span class="title">Command</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::Command
</h1>
<div class="box_info">
<dl>
<dt>Extended by:</dt>
<dd>ActiveSupport::Autoload</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/command.rb</dd>
</dl>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Command/Base.html" title="Metasploit::Framework::Command::Base (class)">Base</a></span>, <span class='object_link'><a href="Command/Console.html" title="Metasploit::Framework::Command::Console (class)">Console</a></span>
</p>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:40 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

885
api/Metasploit/Framework/Command/Base.html Normal file
View File

@ -0,0 +1,885 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::Command::Base
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::Command::Base";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (B)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Command.html" title="Metasploit::Framework::Command (module)">Command</a></span></span>
&raquo;
<span class="title">Base</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::Command::Base
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Metasploit::Framework::Command::Base</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/command/base.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Based on pattern used for lib/rails/commands in the railties gem.</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="Console.html" title="Metasploit::Framework::Command::Console (class)">Console</a></span></p>
</div>
<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="#application-instance_method" title="#application (instance method)">#<strong>application</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute application.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parsed_options-instance_method" title="#parsed_options (instance method)">#<strong>parsed_options</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute parsed_options.</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="#parsed_options-class_method" title="parsed_options (class method)">.<strong>parsed_options</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parsed_options_class-class_method" title="parsed_options_class (class method)">.<strong>parsed_options_class</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parsed_options_class_name-class_method" title="parsed_options_class_name (class method)">.<strong>parsed_options_class_name</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#require_environment!-class_method" title="require_environment! (class method)">.<strong>require_environment!</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Parses `ARGV` for command line arguments to configure the
`Rails.application`.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#start-class_method" title="start (class method)">.<strong>start</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(attributes = {}) &#x21d2; Base </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of Base.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#start-instance_method" title="#start (instance method)">#<strong>start</strong> &#x21d2; void </a>
</span>
<span class="abstract note title">abstract</span>
<span class="summary_desc"><div class='inline'>
<p>Starts this command.</p>
</div></span>
</li>
</ul>
<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">
#<strong>initialize</strong>(attributes = {}) &#x21d2; <tt><span class='object_link'><a href="" title="Metasploit::Framework::Command::Base (class)">Base</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Base</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>attributes</span>
<span class='type'>(<tt>Hash{Symbol =&gt; ActiveSupport::OrderedOptions,Rails::Application}</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>attributes</tt>):</p>
<ul class="option">
<li>
<span class="name">:application</span>
<span class="type">(<tt>Rails::Application</tt>)</span>
<span class="default">
</span>
</li>
<li>
<span class="name">:parsed_options</span>
<span class="type">(<tt>ActiveSupport::OrderedOptions</tt>)</span>
<span class="default">
</span>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>KeyError</tt>)</span>
&mdash;
<div class='inline'>
<p>if :application is not given</p>
</div>
</li>
<li>
<span class='type'>(<tt>KeyError</tt>)</span>
&mdash;
<div class='inline'>
<p>if :parsed_options is not given</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
94
95
96
97</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/command/base.rb', line 94</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='ivar'>@application</span> <span class='op'>=</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:application</span><span class='rparen'>)</span>
<span class='ivar'>@parsed_options</span> <span class='op'>=</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:parsed_options</span><span class='rparen'>)</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=""></span>
<div class="method_details first">
<h3 class="signature first" id="application-instance_method">
#<strong>application</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute application</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/command/base.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_application'>application</span>
<span class='ivar'>@application</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="parsed_options-instance_method">
#<strong>parsed_options</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute parsed_options</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/command/base.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_parsed_options'>parsed_options</span>
<span class='ivar'>@parsed_options</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="parsed_options-class_method">
.<strong>parsed_options</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
68
69
70</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/command/base.rb', line 68</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parsed_options'>parsed_options</span>
<span class='id identifier rubyid_parsed_options_class'>parsed_options_class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="parsed_options_class-class_method">
.<strong>parsed_options_class</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
72
73
74</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/command/base.rb', line 72</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parsed_options_class'>parsed_options_class</span>
<span class='ivar'>@parsed_options_class</span> <span class='op'>||=</span> <span class='id identifier rubyid_parsed_options_class_name'>parsed_options_class_name</span><span class='period'>.</span><span class='id identifier rubyid_constantize'>constantize</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="parsed_options_class_name-class_method">
.<strong>parsed_options_class_name</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
76
77
78</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/command/base.rb', line 76</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parsed_options_class_name'>parsed_options_class_name</span>
<span class='ivar'>@parsed_options_class_name</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span><span class='embexpr_end'>}</span><span class='tstring_content'>::ParsedOptions::</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_demodulize'>demodulize</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="require_environment!-class_method">
.<strong>require_environment!</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'>
<p><span class='object_link'><a href="#require_environment!-class_method" title="Metasploit::Framework::Command::Base.require_environment! (method)">require_environment!</a></span> should be called to load `config/application.rb` to
so that the RAILS_ENV can be set from the command line options in `ARGV`
prior to `Rails.env` being set.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'>
<p>After returning, `Rails.application` will be defined and configured.</p>
</div>
</div>
<p>Parses `ARGV` for command line arguments to configure the
`Rails.application`.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/command/base.rb', line 46</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_require_environment!'>require_environment!</span>
<span class='id identifier rubyid_parsed_options'>parsed_options</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parsed_options'>parsed_options</span>
<span class='comment'># RAILS_ENV must be set before requiring &#39;config/application.rb&#39;
</span> <span class='id identifier rubyid_parsed_options'>parsed_options</span><span class='period'>.</span><span class='id identifier rubyid_environment!'>environment!</span>
<span class='const'>ARGV</span><span class='period'>.</span><span class='id identifier rubyid_replace'>replace</span><span class='lparen'>(</span><span class='id identifier rubyid_parsed_options'>parsed_options</span><span class='period'>.</span><span class='id identifier rubyid_positional'>positional</span><span class='rparen'>)</span>
<span class='comment'># allow other Rails::Applications to use this command
</span> <span class='kw'>if</span> <span class='op'>!</span><span class='kw'>defined?</span><span class='lparen'>(</span><span class='const'>Rails</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='const'>Rails</span><span class='period'>.</span><span class='id identifier rubyid_application'>application</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='comment'># @see https://github.com/rails/rails/blob/v3.2.17/railties/lib/rails/commands.rb#L39-L40
</span> <span class='id identifier rubyid_require'>require</span> <span class='const'>Pathname</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>config</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='comment'># have to configure before requiring environment because
</span> <span class='comment'># config/environment.rb calls initialize! and the initializers will use
</span> <span class='comment'># the configuration from the parsed options.
</span> <span class='id identifier rubyid_parsed_options'>parsed_options</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span><span class='lparen'>(</span><span class='const'>Rails</span><span class='period'>.</span><span class='id identifier rubyid_application'>application</span><span class='rparen'>)</span>
<span class='const'>Rails</span><span class='period'>.</span><span class='id identifier rubyid_application'>application</span><span class='period'>.</span><span class='id identifier rubyid_require_environment!'>require_environment!</span>
<span class='id identifier rubyid_parsed_options'>parsed_options</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="start-class_method">
.<strong>start</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82
83</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/command/base.rb', line 80</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_start'>start</span>
<span class='id identifier rubyid_parsed_options'>parsed_options</span> <span class='op'>=</span> <span class='id identifier rubyid_require_environment!'>require_environment!</span>
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>application:</span> <span class='const'>Rails</span><span class='period'>.</span><span class='id identifier rubyid_application'>application</span><span class='comma'>,</span> <span class='label'>parsed_options:</span> <span class='id identifier rubyid_parsed_options'>parsed_options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_start'>start</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="start-instance_method">
#<strong>start</strong> &#x21d2; <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note abstract">
<strong>This method is abstract.</strong>
<div class='inline'>
<p>Use <span class='object_link'><a href="#application-instance_method" title="Metasploit::Framework::Command::Base#application (method)">#application</a></span> to start this command.</p>
</div>
</div>
<p class="note returns_void">This method returns an undefined value.</p>
<p>Starts this command.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>NotImplementedError</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
105
106
107</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/command/base.rb', line 105</span>
<span class='kw'>def</span> <span class='id identifier rubyid_start'>start</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:38:57 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

347
api/Metasploit/Framework/Command/Console.html Normal file
View File

@ -0,0 +1,347 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::Command::Console
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::Command::Console";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (C)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Command.html" title="Metasploit::Framework::Command (module)">Command</a></span></span>
&raquo;
<span class="title">Console</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::Command::Console
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Base.html" title="Metasploit::Framework::Command::Base (class)">Base</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Base.html" title="Metasploit::Framework::Command::Base (class)">Base</a></span></li>
<li class="next">Metasploit::Framework::Command::Console</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/command/console.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Based on pattern used for lib/rails/commands in the railties gem.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Base.html" title="Metasploit::Framework::Command::Base (class)">Base</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Base.html#application-instance_method" title="Metasploit::Framework::Command::Base#application (method)">#application</a></span>, <span class='object_link'><a href="Base.html#parsed_options-instance_method" title="Metasploit::Framework::Command::Base#parsed_options (method)">#parsed_options</a></span></p>
<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="#spinner-instance_method" title="#spinner (instance method)">#<strong>spinner</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Provides an animated spinner in a seperate thread.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#start-instance_method" title="#start (instance method)">#<strong>start</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="Metasploit::Framework::Command::Base (class)">Base</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="Metasploit::Framework::Command::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#parsed_options-class_method" title="Metasploit::Framework::Command::Base.parsed_options (method)">parsed_options</a></span>, <span class='object_link'><a href="Base.html#parsed_options_class-class_method" title="Metasploit::Framework::Command::Base.parsed_options_class (method)">parsed_options_class</a></span>, <span class='object_link'><a href="Base.html#parsed_options_class_name-class_method" title="Metasploit::Framework::Command::Base.parsed_options_class_name (method)">parsed_options_class_name</a></span>, <span class='object_link'><a href="Base.html#require_environment!-class_method" title="Metasploit::Framework::Command::Base.require_environment! (method)">require_environment!</a></span>, <span class='object_link'><a href="Base.html#start-class_method" title="Metasploit::Framework::Command::Base.start (method)">start</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="Metasploit::Framework::Command::Base#initialize (method)">Metasploit::Framework::Command::Base</a></span></p>
</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="spinner-instance_method">
#<strong>spinner</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Provides an animated spinner in a seperate thread.</p>
<p>See GitHub issue #4147, as this may be blocking some Windows instances,
which is why Windows platforms should simply return immediately.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/command/console.rb', line 17</span>
<span class='kw'>def</span> <span class='id identifier rubyid_spinner'>spinner</span>
<span class='kw'>return</span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="../../../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'>Compat</span><span class='period'>.</span><span class='id identifier rubyid_is_windows'>is_windows</span>
<span class='kw'>return</span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="../../../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'>Compat</span><span class='period'>.</span><span class='id identifier rubyid_is_cygwin'>is_cygwin</span>
<span class='kw'>return</span> <span class='kw'>if</span> <span class='gvar'>$msf_spinner_thread</span>
<span class='gvar'>$msf_spinner_thread</span> <span class='op'>=</span> <span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span>
<span class='id identifier rubyid_base_line'>base_line</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>[*] Starting the Metasploit Framework console...</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_cycle'>cycle</span> <span class='op'>=</span> <span class='int'>0</span>
<span class='id identifier rubyid_loop'>loop</span> <span class='kw'>do</span>
<span class='tstring'><span class='tstring_beg'>%q{</span><span class='tstring_content'>/-\|</span><span class='tstring_end'>}</span></span><span class='period'>.</span><span class='id identifier rubyid_each_char'>each_char</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span>
<span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base_line'>base_line</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_c'>c</span><span class='embexpr_end'>}</span><span class='tstring_content'>\r</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_cycle'>cycle</span> <span class='op'>+=</span> <span class='int'>1</span>
<span class='id identifier rubyid_off'>off</span> <span class='op'>=</span> <span class='id identifier rubyid_cycle'>cycle</span> <span class='op'>%</span> <span class='id identifier rubyid_base_line'>base_line</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span>
<span class='kw'>case</span> <span class='id identifier rubyid_status'>status</span><span class='lbracket'>[</span><span class='id identifier rubyid_off'>off</span><span class='comma'>,</span> <span class='int'>1</span><span class='rbracket'>]</span>
<span class='kw'>when</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>[a-z]</span><span class='regexp_end'>/</span></span>
<span class='id identifier rubyid_status'>status</span><span class='lbracket'>[</span><span class='id identifier rubyid_off'>off</span><span class='comma'>,</span> <span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_status'>status</span><span class='lbracket'>[</span><span class='id identifier rubyid_off'>off</span><span class='comma'>,</span> <span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_upcase'>upcase</span>
<span class='kw'>when</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>[A-Z]</span><span class='regexp_end'>/</span></span>
<span class='id identifier rubyid_status'>status</span><span class='lbracket'>[</span><span class='id identifier rubyid_off'>off</span><span class='comma'>,</span> <span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_status'>status</span><span class='lbracket'>[</span><span class='id identifier rubyid_off'>off</span><span class='comma'>,</span> <span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span>
<span class='kw'>end</span>
<span class='gvar'>$stderr</span><span class='period'>.</span><span class='id identifier rubyid_print'>print</span> <span class='id identifier rubyid_status'>status</span>
<span class='op'>::</span><span class='const'>IO</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='float'>0.10</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="start-instance_method">
#<strong>start</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
42
43
44
45
46
47
48
49
50</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/command/console.rb', line 42</span>
<span class='kw'>def</span> <span class='id identifier rubyid_start'>start</span>
<span class='kw'>case</span> <span class='id identifier rubyid_parsed_options'>parsed_options</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_subcommand'>subcommand</span>
<span class='kw'>when</span> <span class='symbol'>:version</span>
<span class='gvar'>$stderr</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Framework Version: </span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Framework.html#VERSION-constant" title="Metasploit::Framework::VERSION (constant)">VERSION</a></span></span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>else</span>
<span class='id identifier rubyid_spinner'>spinner</span> <span class='kw'>unless</span> <span class='id identifier rubyid_parsed_options'>parsed_options</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_console'>console</span><span class='period'>.</span><span class='id identifier rubyid_quiet'>quiet</span>
<span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:38:59 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

128
api/Metasploit/Framework/CommonEngine.html Normal file
View File

@ -0,0 +1,128 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::CommonEngine
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::CommonEngine";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (C)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span>
&raquo;
<span class="title">CommonEngine</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::CommonEngine
</h1>
<div class="box_info">
<dl>
<dt>Extended by:</dt>
<dd>ActiveSupport::Concern</dd>
</dl>
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="Engine.html" title="Metasploit::Framework::Engine (class)">Engine</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/common_engine.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>`Rails::Engine` behavior common to both
Application and <span class='object_link'><a href="Engine.html" title="Metasploit::Framework::Engine (class)">Engine</a></span>.</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:44 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

856
api/Metasploit/Framework/CommunityStringCollection.html Normal file
View File

@ -0,0 +1,856 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::CommunityStringCollection
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::CommunityStringCollection";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (C)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span>
&raquo;
<span class="title">CommunityStringCollection</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::CommunityStringCollection
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Metasploit::Framework::CommunityStringCollection</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/community_string_collection.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This class is responsible for taking datastore options from the snmp_login
module and yielding appropriate <span class='object_link'><a href="Credential.html" title="Metasploit::Framework::Credential (class)">Credential</a></span>s to the
<span class='object_link'><a href="LoginScanner/SNMP.html" title="Metasploit::Framework::LoginScanner::SNMP (class)">LoginScanner::SNMP</a></span>. This one has to be different
from credentialCollection as it will only have a
<span class='object_link'><a href="Credential.html#public-instance_method" title="Metasploit::Framework::Credential#public (method)">Metasploit::Framework::Credential#public</a></span> It may be slightly confusing
that the attribues are called password and pass_file, because this is what
the legacy module used. However, community Strings are now considered more
to be public credentials than private ones.</p>
</div>
</div>
<div class="tags">
</div>
<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="#pass_file-instance_method" title="#pass_file (instance method)">#<strong>pass_file</strong> &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Path to a file containing passwords, one per line.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#password-instance_method" title="#password (instance method)">#<strong>password</strong> &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#prepended_creds-instance_method" title="#prepended_creds (instance method)">#<strong>prepended_creds</strong> &#x21d2; Array&lt;Credential&gt; </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>List of credentials to be tried before any others.</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="#each-instance_method" title="#each (instance method)">#<strong>each</strong> {|credential| ... } &#x21d2; void </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Combines all the provided credential sources into a stream of <span class='object_link'><a href="Credential.html" title="Metasploit::Framework::Credential (class)">Credential</a></span>
objects, yielding them one at a time.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#empty%3F-instance_method" title="#empty? (instance method)">#<strong>empty?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(opts = {}) &#x21d2; CommunityStringCollection </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of CommunityStringCollection.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#prepend_cred-instance_method" title="#prepend_cred (instance method)">#<strong>prepend_cred</strong>(cred) &#x21d2; self </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Add <span class='object_link'><a href="Credential.html" title="Metasploit::Framework::Credential (class)">credentials</a></span> that will be yielded by <span class='object_link'><a href="#each-instance_method" title="Metasploit::Framework::CommunityStringCollection#each (method)">#each</a></span>.</p>
</div></span>
</li>
</ul>
<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">
#<strong>initialize</strong>(opts = {}) &#x21d2; <tt><span class='object_link'><a href="" title="Metasploit::Framework::CommunityStringCollection (class)">CommunityStringCollection</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of CommunityStringCollection</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>opts</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
&mdash;
<div class='inline'>
<p>a customizable set of options</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
<ul class="option">
<li>
<span class="name">:pass_file</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
&mdash; <div class='inline'>
<p>See <span class='object_link'><a href="#pass_file-instance_method" title="Metasploit::Framework::CommunityStringCollection#pass_file (method)">#pass_file</a></span></p>
</div>
</li>
<li>
<span class="name">:password</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
&mdash; <div class='inline'>
<p>See <span class='object_link'><a href="#password-instance_method" title="Metasploit::Framework::CommunityStringCollection#password (method)">#password</a></span></p>
</div>
</li>
<li>
<span class="name">:prepended_creds</span>
<span class="type">(<tt>Array&lt;<span class='object_link'><a href="Credential.html" title="Metasploit::Framework::Credential (class)">Credential</a></span>&gt;</tt>)</span>
<span class="default">
&mdash; default:
<tt>[]</tt>
</span>
&mdash; <div class='inline'>
<p>See <span class='object_link'><a href="#prepended_creds-instance_method" title="Metasploit::Framework::CommunityStringCollection#prepended_creds (method)">#prepended_creds</a></span></p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
31
32
33
34
35
36</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/community_string_collection.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
<span class='id identifier rubyid_public_send'>public_send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_attribute'>attribute</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_prepended_creds'>prepended_creds</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</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="pass_file=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="pass_file-instance_method">
#<strong>pass_file</strong> &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Path to a file containing passwords, one per line</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/community_string_collection.rb', line 15</span>
<span class='kw'>def</span> <span class='id identifier rubyid_pass_file'>pass_file</span>
<span class='ivar'>@pass_file</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="password=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="password-instance_method">
#<strong>password</strong> &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/community_string_collection.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_password'>password</span>
<span class='ivar'>@password</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="prepended_creds=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="prepended_creds-instance_method">
#<strong>prepended_creds</strong> &#x21d2; <tt>Array&lt;<span class='object_link'><a href="Credential.html" title="Metasploit::Framework::Credential (class)">Credential</a></span>&gt;</tt>
</h3><div class="docstring">
<div class="discussion">
<p>List of credentials to be tried before any others</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array&lt;<span class='object_link'><a href="Credential.html" title="Metasploit::Framework::Credential (class)">Credential</a></span>&gt;</tt>)</span>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#prepend_cred-instance_method" title="Metasploit::Framework::CommunityStringCollection#prepend_cred (method)">#prepend_cred</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/community_string_collection.rb', line 26</span>
<span class='kw'>def</span> <span class='id identifier rubyid_prepended_creds'>prepended_creds</span>
<span class='ivar'>@prepended_creds</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="each-instance_method">
#<strong>each</strong> {|credential| ... } &#x21d2; <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p>
<p>Combines all the provided credential sources into a stream of <span class='object_link'><a href="Credential.html" title="Metasploit::Framework::Credential (class)">Metasploit::Framework::Credential</a></span>
objects, yielding them one at a time</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Yield Parameters:</p>
<ul class="yieldparam">
<li>
<span class='name'>credential</span>
<span class='type'>(<tt><span class='object_link'><a href="Credential.html" title="Metasploit::Framework::Credential (class)">Metasploit::Framework::Credential</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/community_string_collection.rb', line 43</span>
<span class='kw'>def</span> <span class='id identifier rubyid_each'>each</span>
<span class='kw'>begin</span>
<span class='kw'>if</span> <span class='id identifier rubyid_pass_file'>pass_file</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
<span class='id identifier rubyid_pass_fd'>pass_fd</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_pass_file'>pass_file</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>r:binary</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_pass_fd'>pass_fd</span><span class='period'>.</span><span class='id identifier rubyid_each_line'>each_line</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_line'>line</span><span class='op'>|</span>
<span class='id identifier rubyid_line'>line</span><span class='period'>.</span><span class='id identifier rubyid_chomp!'>chomp!</span>
<span class='kw'>yield</span> <span class='const'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Credential.html" title="Metasploit::Framework::Credential (class)">Credential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Credential.html#initialize-instance_method" title="Metasploit::Framework::Credential#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>public:</span> <span class='id identifier rubyid_line'>line</span><span class='comma'>,</span> <span class='label'>paired:</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_password'>password</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
<span class='kw'>yield</span> <span class='const'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Credential.html" title="Metasploit::Framework::Credential (class)">Credential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Credential.html#initialize-instance_method" title="Metasploit::Framework::Credential#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>public:</span> <span class='id identifier rubyid_password'>password</span><span class='comma'>,</span> <span class='label'>paired:</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>ensure</span>
<span class='id identifier rubyid_pass_fd'>pass_fd</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span> <span class='kw'>if</span> <span class='id identifier rubyid_pass_fd'>pass_fd</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_pass_fd'>pass_fd</span><span class='period'>.</span><span class='id identifier rubyid_closed?'>closed?</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="empty?-instance_method">
#<strong>empty?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<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">
62
63
64</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/community_string_collection.rb', line 62</span>
<span class='kw'>def</span> <span class='id identifier rubyid_empty?'>empty?</span>
<span class='id identifier rubyid_prepended_creds'>prepended_creds</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_pass_file'>pass_file</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_password'>password</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="prepend_cred-instance_method">
#<strong>prepend_cred</strong>(cred) &#x21d2; <tt>self</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Add <span class='object_link'><a href="Credential.html" title="Metasploit::Framework::Credential (class)">credentials</a></span> that will be yielded by <span class='object_link'><a href="#each-instance_method" title="Metasploit::Framework::CommunityStringCollection#each (method)">#each</a></span></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>cred</span>
<span class='type'>(<tt><span class='object_link'><a href="Credential.html" title="Metasploit::Framework::Credential (class)">Credential</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>self</tt>)</span>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#prepended_creds-instance_method" title="Metasploit::Framework::CommunityStringCollection#prepended_creds (method)">#prepended_creds</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
71
72
73
74</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/community_string_collection.rb', line 71</span>
<span class='kw'>def</span> <span class='id identifier rubyid_prepend_cred'>prepend_cred</span><span class='lparen'>(</span><span class='id identifier rubyid_cred'>cred</span><span class='rparen'>)</span>
<span class='id identifier rubyid_prepended_creds'>prepended_creds</span><span class='period'>.</span><span class='id identifier rubyid_unshift'>unshift</span> <span class='id identifier rubyid_cred'>cred</span>
<span class='kw'>self</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:39:19 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

119
api/Metasploit/Framework/Compiler.html Normal file
View File

@ -0,0 +1,119 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::Compiler
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::Compiler";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (C)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span>
&raquo;
<span class="title">Compiler</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::Compiler
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/compiler/utils.rb<span class="defines">,<br />
lib/metasploit/framework/compiler/windows.rb,<br /> lib/metasploit/framework/compiler/headers/base.rb,<br /> lib/metasploit/framework/compiler/headers/windows.rb</span>
</dd>
</dl>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Compiler/Headers.html" title="Metasploit::Framework::Compiler::Headers (module)">Headers</a></span>, <span class='object_link'><a href="Compiler/Utils.html" title="Metasploit::Framework::Compiler::Utils (module)">Utils</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Compiler/Windows.html" title="Metasploit::Framework::Compiler::Windows (class)">Windows</a></span>
</p>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:45 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

117
api/Metasploit/Framework/Compiler/Headers.html Normal file
View File

@ -0,0 +1,117 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::Compiler::Headers
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::Compiler::Headers";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (H)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Compiler.html" title="Metasploit::Framework::Compiler (module)">Compiler</a></span></span>
&raquo;
<span class="title">Headers</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::Compiler::Headers
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/compiler/headers/base.rb<span class="defines">,<br />
lib/metasploit/framework/compiler/headers/windows.rb</span>
</dd>
</dl>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Headers/Base.html" title="Metasploit::Framework::Compiler::Headers::Base (class)">Base</a></span>, <span class='object_link'><a href="Headers/Windows.html" title="Metasploit::Framework::Compiler::Headers::Windows (class)">Windows</a></span>
</p>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:47 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

427
api/Metasploit/Framework/Compiler/Headers/Base.html Normal file
View File

@ -0,0 +1,427 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::Compiler::Headers::Base
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::Compiler::Headers::Base";
relpath = '../../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../../_index.html">Index (B)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Compiler.html" title="Metasploit::Framework::Compiler (module)">Compiler</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Headers.html" title="Metasploit::Framework::Compiler::Headers (module)">Headers</a></span></span>
&raquo;
<span class="title">Base</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::Compiler::Headers::Base
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Metasploit::Framework::Compiler::Headers::Base</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/compiler/headers/base.rb</dd>
</dl>
</div>
<div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="Windows.html" title="Metasploit::Framework::Compiler::Headers::Windows (class)">Windows</a></span></p>
</div>
<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="#loaded_dep-instance_method" title="#loaded_dep (instance method)">#<strong>loaded_dep</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute loaded_dep.</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="#include-instance_method" title="#include (instance method)">#<strong>include</strong>(lib_name) &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the header source code.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> &#x21d2; Base </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Initializes the Base class for headers.</p>
</div></span>
</li>
</ul>
<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">
#<strong>initialize</strong> &#x21d2; <tt><span class='object_link'><a href="" title="Metasploit::Framework::Compiler::Headers::Base (class)">Base</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initializes the Base class for headers.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
10
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/headers/base.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
<span class='comment'># This is used to avoid loading the same dependency code twice
</span> <span class='ivar'>@loaded_dep</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</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="loaded_dep=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="loaded_dep-instance_method">
#<strong>loaded_dep</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute loaded_dep</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/headers/base.rb', line 7</span>
<span class='kw'>def</span> <span class='id identifier rubyid_loaded_dep'>loaded_dep</span>
<span class='ivar'>@loaded_dep</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="include-instance_method">
#<strong>include</strong>(lib_name) &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the header source code.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>lib_name</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The file name of the header.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/headers/base.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_lib_name'>lib_name</span><span class='rparen'>)</span>
<span class='id identifier rubyid_lib'>lib</span> <span class='op'>=</span> <span class='id identifier rubyid_lib_dep_map'>lib_dep_map</span><span class='lbracket'>[</span><span class='id identifier rubyid_lib_name'>lib_name</span><span class='rbracket'>]</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_lib'>lib</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>RuntimeError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_lib_name'>lib_name</span><span class='embexpr_end'>}</span><span class='tstring_content'> not found</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='comment'># Load the dependencies first, and only once
</span> <span class='id identifier rubyid_dep'>dep</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_lib'>lib</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_loaded_dep'>loaded_dep</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_f'>f</span><span class='rparen'>)</span>
<span class='id identifier rubyid_dep_path'>dep_path</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='id identifier rubyid_headers_path'>headers_path</span><span class='comma'>,</span> <span class='id identifier rubyid_f'>f</span><span class='rparen'>)</span>
<span class='id identifier rubyid_dep'>dep</span> <span class='op'>&lt;&lt;</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_dep_path'>dep_path</span><span class='rparen'>)</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_loaded_dep'>loaded_dep</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_f'>f</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='comment'># Load the headers
</span> <span class='id identifier rubyid_lib_path'>lib_path</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='id identifier rubyid_headers_path'>headers_path</span><span class='comma'>,</span> <span class='id identifier rubyid_lib_name'>lib_name</span><span class='rparen'>)</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_dep'>dep</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_lib_path'>lib_path</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:39:12 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

395
api/Metasploit/Framework/Compiler/Headers/Windows.html Normal file
View File

@ -0,0 +1,395 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::Compiler::Headers::Windows
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::Compiler::Headers::Windows";
relpath = '../../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../../_index.html">Index (W)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Compiler.html" title="Metasploit::Framework::Compiler (module)">Compiler</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Headers.html" title="Metasploit::Framework::Compiler::Headers (module)">Headers</a></span></span>
&raquo;
<span class="title">Windows</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::Compiler::Headers::Windows
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Base.html" title="Metasploit::Framework::Compiler::Headers::Base (class)">Base</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Base.html" title="Metasploit::Framework::Compiler::Headers::Base (class)">Base</a></span></li>
<li class="next">Metasploit::Framework::Compiler::Headers::Windows</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/compiler/headers/windows.rb</dd>
</dl>
</div>
<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="#headers_path-instance_method" title="#headers_path (instance method)">#<strong>headers_path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute headers_path.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#lib_dep_map-instance_method" title="#lib_dep_map (instance method)">#<strong>lib_dep_map</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute lib_dep_map.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Base.html" title="Metasploit::Framework::Compiler::Headers::Base (class)">Base</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Base.html#loaded_dep-instance_method" title="Metasploit::Framework::Compiler::Headers::Base#loaded_dep (method)">#loaded_dep</a></span></p>
<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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> &#x21d2; Windows </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Initializes the Windows headers.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="Metasploit::Framework::Compiler::Headers::Base (class)">Base</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Base.html#include-instance_method" title="Metasploit::Framework::Compiler::Headers::Base#include (method)">#include</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">
#<strong>initialize</strong> &#x21d2; <tt><span class='object_link'><a href="" title="Metasploit::Framework::Compiler::Headers::Windows (class)">Windows</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initializes the Windows headers.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/headers/windows.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
<span class='kw'>super</span>
<span class='ivar'>@headers_path</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../../../Msf.html" title="Msf (module)">Msf</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../../Msf/Config.html" title="Msf::Config (class)">Config</a></span></span><span class='period'>.</span><span class='id identifier rubyid_install_root'><span class='object_link'><a href="../../../../Msf/Config.html#install_root-class_method" title="Msf::Config.install_root (method)">install_root</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>data</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>headers</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>windows</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='ivar'>@lib_dep_map</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stddef.h</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Windows.h</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stddef.h</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stdlib.h</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stddef.h</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stdio.h</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stddef.h</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>String.h</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stddef.h</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Winsock2.h</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stddef.h</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Windows.h</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>rc4.h</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>String.h</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stdlib.h</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>base64.h</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stddef.h</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>xor.h</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stddef.h</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
<span class='rbrace'>}</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="headers_path=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="headers_path-instance_method">
#<strong>headers_path</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute headers_path</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/headers/windows.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_headers_path'>headers_path</span>
<span class='ivar'>@headers_path</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="lib_dep_map=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="lib_dep_map-instance_method">
#<strong>lib_dep_map</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute lib_dep_map</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
10
11
12</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/headers/windows.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_lib_dep_map'>lib_dep_map</span>
<span class='ivar'>@lib_dep_map</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:39:17 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

254
api/Metasploit/Framework/Compiler/Utils.html Normal file
View File

@ -0,0 +1,254 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::Compiler::Utils
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::Compiler::Utils";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (U)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Compiler.html" title="Metasploit::Framework::Compiler (module)">Compiler</a></span></span>
&raquo;
<span class="title">Utils</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::Compiler::Utils
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/compiler/utils.rb</dd>
</dl>
</div>
<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="#normalize_code-class_method" title="normalize_code (class method)">.<strong>normalize_code</strong>(code, headers) &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the normalized C code (with headers).</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="normalize_code-class_method">
.<strong>normalize_code</strong>(code, headers) &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the normalized C code (with headers).</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>code</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The C source code.</p>
</div>
</li>
<li>
<span class='name'>headers</span>
<span class='type'>(<tt>Metasploit::Framework::Compiler::Headers::Win32</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The normalized code.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13
14
15
16
17
18
19
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/utils.rb', line 11</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_normalize_code'>normalize_code</span><span class='lparen'>(</span><span class='id identifier rubyid_code'>code</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
<span class='id identifier rubyid_code'>code</span> <span class='op'>=</span> <span class='id identifier rubyid_code'>code</span><span class='period'>.</span><span class='id identifier rubyid_lines'>lines</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_line'>line</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='id identifier rubyid_line'>line</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\s*#include &lt;([[:print:]]+)&gt;$</span><span class='regexp_end'>/</span></span>
<span class='id identifier rubyid_h'>h</span> <span class='op'>=</span> <span class='id identifier rubyid_headers'>headers</span><span class='period'>.</span><span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='backref'>$1</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='tstring'><span class='tstring_beg'>%Q|</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_h'>h</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='tstring_end'>|</span></span>
<span class='kw'>else</span>
<span class='id identifier rubyid_line'>line</span>
<span class='kw'>end</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'><span class='object_link'><a href="../../../top-level-namespace.html#join-instance_method" title="#join (method)">join</a></span></span>
<span class='id identifier rubyid_code'>code</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:45 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

745
api/Metasploit/Framework/Compiler/Windows.html Normal file
View File

@ -0,0 +1,745 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::Compiler::Windows
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::Compiler::Windows";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (W)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Compiler.html" title="Metasploit::Framework::Compiler (module)">Compiler</a></span></span>
&raquo;
<span class="title">Windows</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::Compiler::Windows
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Metasploit::Framework::Compiler::Windows</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/compiler/windows.rb</dd>
</dl>
</div>
<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="#compile_c-class_method" title="compile_c (class method)">.<strong>compile_c</strong>(c_template, type = :exe, cpu = Metasm::Ia32.new) &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the binary of a compiled source.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#compile_c_to_file-class_method" title="compile_c_to_file (class method)">.<strong>compile_c_to_file</strong>(out_file, c_template, type = :exe, cpu = Metasm::Ia32.new) &#x21d2; Integer </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Saves the compiled code as a file.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#compile_random_c-class_method" title="compile_random_c (class method)">.<strong>compile_random_c</strong>(c_template, opts = {}) &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the binary of a randomized and compiled source code.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#compile_random_c_to_file-class_method" title="compile_random_c_to_file (class method)">.<strong>compile_random_c_to_file</strong>(out_file, c_template, opts = {}) &#x21d2; Integer </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Saves the randomized compiled code as a file.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="compile_c-class_method">
.<strong>compile_c</strong>(c_template, type = :exe, cpu = Metasm::Ia32.new) &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the binary of a compiled source.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>c_template</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The C source code to compile.</p>
</div>
</li>
<li>
<span class='name'>type</span>
<span class='type'>(<tt>Symbol</tt>)</span>
<em class="default">(defaults to: <tt>:exe</tt>)</em>
&mdash;
<div class='inline'>
<p>PE type, either :exe or :dll</p>
</div>
</li>
<li>
<span class='name'>cpu</span>
<span class='type'>(<tt>Metasm::CPU</tt>)</span>
<em class="default">(defaults to: <tt>Metasm::Ia32.new</tt>)</em>
&mdash;
<div class='inline'>
<p>A Metasm cpu object, for example: Metasm::Ia32.new</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The compiled code.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>NotImplementedError</tt>)</span>
&mdash;
<div class='inline'>
<p>If the type is not supported.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
20
21
22
23
24
25
26
27
28
29
30
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/windows.rb', line 20</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_compile_c'>compile_c</span><span class='lparen'>(</span><span class='id identifier rubyid_c_template'>c_template</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='op'>=</span><span class='symbol'>:exe</span><span class='comma'>,</span> <span class='id identifier rubyid_cpu'>cpu</span><span class='op'>=</span><span class='const'>Metasm</span><span class='op'>::</span><span class='const'>Ia32</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='rparen'>)</span>
<span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Compiler.html" title="Metasploit::Framework::Compiler (module)">Compiler</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Headers.html" title="Metasploit::Framework::Compiler::Headers (module)">Headers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Headers/Windows.html" title="Metasploit::Framework::Compiler::Headers::Windows (class)">Windows</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Headers/Windows.html#initialize-instance_method" title="Metasploit::Framework::Compiler::Headers::Windows#initialize (method)">new</a></span></span>
<span class='id identifier rubyid_source_code'>source_code</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Compiler.html" title="Metasploit::Framework::Compiler (module)">Compiler</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Utils.html" title="Metasploit::Framework::Compiler::Utils (module)">Utils</a></span></span><span class='period'>.</span><span class='id identifier rubyid_normalize_code'><span class='object_link'><a href="Utils.html#normalize_code-class_method" title="Metasploit::Framework::Compiler::Utils.normalize_code (method)">normalize_code</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_c_template'>c_template</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
<span class='id identifier rubyid_pe'>pe</span> <span class='op'>=</span> <span class='const'>Metasm</span><span class='op'>::</span><span class='const'>PE</span><span class='period'>.</span><span class='id identifier rubyid_compile_c'>compile_c</span><span class='lparen'>(</span><span class='id identifier rubyid_cpu'>cpu</span><span class='comma'>,</span> <span class='id identifier rubyid_source_code'>source_code</span><span class='rparen'>)</span>
<span class='kw'>case</span> <span class='id identifier rubyid_type'>type</span>
<span class='kw'>when</span> <span class='symbol'>:exe</span>
<span class='id identifier rubyid_pe'>pe</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span>
<span class='kw'>when</span> <span class='symbol'>:dll</span>
<span class='id identifier rubyid_pe'>pe</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>dll</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="compile_c_to_file-class_method">
.<strong>compile_c_to_file</strong>(out_file, c_template, type = :exe, cpu = Metasm::Ia32.new) &#x21d2; <tt>Integer</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Saves the compiled code as a file. This is basically a wrapper of
#self.compile.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>out_file</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The file path to save the binary as.</p>
</div>
</li>
<li>
<span class='name'>c_template</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The C source code to compile.</p>
</div>
</li>
<li>
<span class='name'>type</span>
<span class='type'>(<tt>Symbol</tt>)</span>
<em class="default">(defaults to: <tt>:exe</tt>)</em>
&mdash;
<div class='inline'>
<p>PE type, either :exe or :dll</p>
</div>
</li>
<li>
<span class='name'>cpu</span>
<span class='type'>(<tt>Metasm::CPU</tt>)</span>
<em class="default">(defaults to: <tt>Metasm::Ia32.new</tt>)</em>
&mdash;
<div class='inline'>
<p>A Metasm cpu object, for example: Metasm::Ia32.new</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>The number of bytes written.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
42
43
44
45</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/windows.rb', line 42</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_compile_c_to_file'>compile_c_to_file</span><span class='lparen'>(</span><span class='id identifier rubyid_out_file'>out_file</span><span class='comma'>,</span> <span class='id identifier rubyid_c_template'>c_template</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='op'>=</span><span class='symbol'>:exe</span><span class='comma'>,</span> <span class='id identifier rubyid_cpu'>cpu</span><span class='op'>=</span><span class='const'>Metasm</span><span class='op'>::</span><span class='const'>Ia32</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='rparen'>)</span>
<span class='id identifier rubyid_pe'>pe</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_compile_c'>compile_c</span><span class='lparen'>(</span><span class='id identifier rubyid_c_template'>c_template</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_out_file'>out_file</span><span class='comma'>,</span> <span class='id identifier rubyid_pe'>pe</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="compile_random_c-class_method">
.<strong>compile_random_c</strong>(c_template, opts = {}) &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the binary of a randomized and compiled source code.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>c_template</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The compiled code.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>NotImplementedError</tt>)</span>
&mdash;
<div class='inline'>
<p>If the type is not supported.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
53
54
55
56
57
58
59
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/windows.rb', line 53</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_compile_random_c'>compile_random_c</span><span class='lparen'>(</span><span class='id identifier rubyid_c_template'>c_template</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_type'>type</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='symbol'>:exe</span>
<span class='id identifier rubyid_cpu'>cpu</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:cpu</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='const'>Metasm</span><span class='op'>::</span><span class='const'>Ia32</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='id identifier rubyid_weight'>weight</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:weight</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>80</span>
<span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Compiler.html" title="Metasploit::Framework::Compiler (module)">Compiler</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Headers.html" title="Metasploit::Framework::Compiler::Headers (module)">Headers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Headers/Windows.html" title="Metasploit::Framework::Compiler::Headers::Windows (class)">Windows</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Headers/Windows.html#initialize-instance_method" title="Metasploit::Framework::Compiler::Headers::Windows#initialize (method)">new</a></span></span>
<span class='id identifier rubyid_source_code'>source_code</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Compiler.html" title="Metasploit::Framework::Compiler (module)">Compiler</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Utils.html" title="Metasploit::Framework::Compiler::Utils (module)">Utils</a></span></span><span class='period'>.</span><span class='id identifier rubyid_normalize_code'><span class='object_link'><a href="Utils.html#normalize_code-class_method" title="Metasploit::Framework::Compiler::Utils.normalize_code (method)">normalize_code</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_c_template'>c_template</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
<span class='id identifier rubyid_randomizer'>randomizer</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Obfuscation.html" title="Metasploit::Framework::Obfuscation (module)">Obfuscation</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Obfuscation/CRandomizer.html" title="Metasploit::Framework::Obfuscation::CRandomizer (module)">CRandomizer</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Obfuscation/CRandomizer/Parser.html" title="Metasploit::Framework::Obfuscation::CRandomizer::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Obfuscation/CRandomizer/Parser.html#initialize-instance_method" title="Metasploit::Framework::Obfuscation::CRandomizer::Parser#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_weight'>weight</span><span class='rparen'>)</span>
<span class='id identifier rubyid_randomized_code'>randomized_code</span> <span class='op'>=</span> <span class='id identifier rubyid_randomizer'>randomizer</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_source_code'>source_code</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_compile_c'>compile_c</span><span class='lparen'>(</span><span class='id identifier rubyid_randomized_code'>randomized_code</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_cpu'>cpu</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="compile_random_c_to_file-class_method">
.<strong>compile_random_c_to_file</strong>(out_file, c_template, opts = {}) &#x21d2; <tt>Integer</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Saves the randomized compiled code as a file. This is basically a wrapper
for #self.compile_random_c</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>out_file</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The file path to save the binary as.</p>
</div>
</li>
<li>
<span class='name'>c_template</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The C source code to randomize and compile.</p>
</div>
</li>
<li>
<span class='name'>opts</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
&mdash;
<div class='inline'>
<p>Options to pass to #compile_random_c</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>The number of bytes written.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
70
71
72
73</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/windows.rb', line 70</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_compile_random_c_to_file'>compile_random_c_to_file</span><span class='lparen'>(</span><span class='id identifier rubyid_out_file'>out_file</span><span class='comma'>,</span> <span class='id identifier rubyid_c_template'>c_template</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_pe'>pe</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_compile_random_c'>compile_random_c</span><span class='lparen'>(</span><span class='id identifier rubyid_c_template'>c_template</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_out_file'>out_file</span><span class='comma'>,</span> <span class='id identifier rubyid_pe'>pe</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:38:59 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

157
api/Metasploit/Framework/Core.html Normal file
View File

@ -0,0 +1,157 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::Core
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::Core";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (C)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span>
&raquo;
<span class="title">Core</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::Core
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/core/version.rb<span class="defines">,<br />
lib/metasploit/framework/core.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'>
<p>This is a lie. The core libraries are not semantically versioned. This is
currently just linked to the Metasploit::Framework::Version, which is also
not semantically versioned.</p>
</div>
</div>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Core/Version.html" title="Metasploit::Framework::Core::Version (module)">Version</a></span>
</p>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="VERSION-constant" class="">VERSION =
</dt>
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Framework.html#VERSION-constant" title="Metasploit::Framework::VERSION (constant)">VERSION</a></span></span></pre></dd>
<dt id="GEM_VERSION-constant" class="">GEM_VERSION =
</dt>
<dd><pre class="code"><span class='const'>Gem</span><span class='op'>::</span><span class='const'>Version</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Framework.html#GEM_VERSION-constant" title="Metasploit::Framework::GEM_VERSION (constant)">GEM_VERSION</a></span></span><span class='rparen'>)</span></pre></dd>
</dl>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:40 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

136
api/Metasploit/Framework/Core/Version.html Normal file
View File

@ -0,0 +1,136 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::Core::Version
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::Core::Version";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (V)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Core.html" title="Metasploit::Framework::Core (module)">Core</a></span></span>
&raquo;
<span class="title">Version</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::Core::Version
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/core/version.rb</dd>
</dl>
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="MAJOR-constant" class="">MAJOR =
</dt>
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Version.html" title="Metasploit::Framework::Version (module)">Version</a></span></span><span class='op'>::</span><span class='const'>MAJOR</span></pre></dd>
<dt id="MINOR-constant" class="">MINOR =
</dt>
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Version.html" title="Metasploit::Framework::Version (module)">Version</a></span></span><span class='op'>::</span><span class='const'>MINOR</span></pre></dd>
<dt id="PATCH-constant" class="">PATCH =
</dt>
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Version.html" title="Metasploit::Framework::Version (module)">Version</a></span></span><span class='op'>::</span><span class='const'>PATCH</span></pre></dd>
<dt id="PRERELEASE-constant" class="">PRERELEASE =
</dt>
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Version.html" title="Metasploit::Framework::Version (module)">Version</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Version.html#PRERELEASE-constant" title="Metasploit::Framework::Version::PRERELEASE (constant)">PRERELEASE</a></span></span></pre></dd>
</dl>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:43 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

1211
api/Metasploit/Framework/Credential.html Normal file
View File

File diff suppressed because it is too large Load Diff

2049
api/Metasploit/Framework/CredentialCollection.html Normal file
View File

File diff suppressed because it is too large Load Diff

506
api/Metasploit/Framework/DataService.html Normal file
View File

@ -0,0 +1,506 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::DataService
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::DataService";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (D)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span>
&raquo;
<span class="title">DataService</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::DataService
</h1>
<div class="box_info">
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="../../EventDataService.html" title="EventDataService (module)">EventDataService</a></span>, <span class='object_link'><a href="../../ExploitDataService.html" title="ExploitDataService (module)">ExploitDataService</a></span>, <span class='object_link'><a href="../../HostDataService.html" title="HostDataService (module)">HostDataService</a></span>, <span class='object_link'><a href="../../LootDataService.html" title="LootDataService (module)">LootDataService</a></span>, <span class='object_link'><a href="../../MsfDataService.html" title="MsfDataService (module)">MsfDataService</a></span>, <span class='object_link'><a href="../../NoteDataService.html" title="NoteDataService (module)">NoteDataService</a></span>, <span class='object_link'><a href="../../ServiceDataService.html" title="ServiceDataService (module)">ServiceDataService</a></span>, <span class='object_link'><a href="../../SessionDataService.html" title="SessionDataService (module)">SessionDataService</a></span>, <span class='object_link'><a href="../../SessionEventDataService.html" title="SessionEventDataService (module)">SessionEventDataService</a></span>, <span class='object_link'><a href="../../VulnDataService.html" title="VulnDataService (module)">VulnDataService</a></span>, <span class='object_link'><a href="../../WebDataService.html" title="WebDataService (module)">WebDataService</a></span>, <span class='object_link'><a href="../../WorkspaceDataService.html" title="WorkspaceDataService (module)">WorkspaceDataService</a></span></dd>
</dl>
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="DataService/RemoteHTTPDataService.html" title="Metasploit::Framework::DataService::RemoteHTTPDataService (class)">RemoteHTTPDataService</a></span>, <span class='object_link'><a href="../../Msf/DBManager.html" title="Msf::DBManager (class)">Msf::DBManager</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service.rb<span class="defines">,<br />
lib/metasploit/framework/data_service/proxy/core.rb,<br /> lib/metasploit/framework/data_service/remote/http/core.rb,<br /> lib/metasploit/framework/data_service/remote/managed_remote_data_service.rb</span>
</dd>
</dl>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="DataService/DataProxy.html" title="Metasploit::Framework::DataService::DataProxy (class)">DataProxy</a></span>, <span class='object_link'><a href="DataService/ManagedRemoteDataService.html" title="Metasploit::Framework::DataService::ManagedRemoteDataService (class)">ManagedRemoteDataService</a></span>, <span class='object_link'><a href="DataService/Metadata.html" title="Metasploit::Framework::DataService::Metadata (class)">Metadata</a></span>, <span class='object_link'><a href="DataService/RemoteHTTPDataService.html" title="Metasploit::Framework::DataService::RemoteHTTPDataService (class)">RemoteHTTPDataService</a></span>
</p>
<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="#active-instance_method" title="#active (instance method)">#<strong>active</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#active=-instance_method" title="#active= (instance method)">#<strong>active=</strong>(value) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#is_local%3F-instance_method" title="#is_local? (instance method)">#<strong>is_local?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../MsfDataService.html" title="MsfDataService (module)">MsfDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../../MsfDataService.html#get_msf_version-instance_method" title="MsfDataService#get_msf_version (method)">#get_msf_version</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../LootDataService.html" title="LootDataService (module)">LootDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../../LootDataService.html#find_or_create_loot-instance_method" title="LootDataService#find_or_create_loot (method)">#find_or_create_loot</a></span>, <span class='object_link'><a href="../../LootDataService.html#loot-instance_method" title="LootDataService#loot (method)">#loot</a></span>, <span class='object_link'><a href="../../LootDataService.html#report_loot-instance_method" title="LootDataService#report_loot (method)">#report_loot</a></span>, <span class='object_link'><a href="../../LootDataService.html#update_loot-instance_method" title="LootDataService#update_loot (method)">#update_loot</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../ExploitDataService.html" title="ExploitDataService (module)">ExploitDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../../ExploitDataService.html#report_exploit_attempt-instance_method" title="ExploitDataService#report_exploit_attempt (method)">#report_exploit_attempt</a></span>, <span class='object_link'><a href="../../ExploitDataService.html#report_exploit_failure-instance_method" title="ExploitDataService#report_exploit_failure (method)">#report_exploit_failure</a></span>, <span class='object_link'><a href="../../ExploitDataService.html#report_exploit_success-instance_method" title="ExploitDataService#report_exploit_success (method)">#report_exploit_success</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../SessionEventDataService.html" title="SessionEventDataService (module)">SessionEventDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../../SessionEventDataService.html#report_session_event-instance_method" title="SessionEventDataService#report_session_event (method)">#report_session_event</a></span>, <span class='object_link'><a href="../../SessionEventDataService.html#session_events-instance_method" title="SessionEventDataService#session_events (method)">#session_events</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../SessionDataService.html" title="SessionDataService (module)">SessionDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../../SessionDataService.html#report_session-instance_method" title="SessionDataService#report_session (method)">#report_session</a></span>, <span class='object_link'><a href="../../SessionDataService.html#sessions-instance_method" title="SessionDataService#sessions (method)">#sessions</a></span>, <span class='object_link'><a href="../../SessionDataService.html#update_session-instance_method" title="SessionDataService#update_session (method)">#update_session</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../ServiceDataService.html" title="ServiceDataService (module)">ServiceDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../../ServiceDataService.html#delete_service-instance_method" title="ServiceDataService#delete_service (method)">#delete_service</a></span>, <span class='object_link'><a href="../../ServiceDataService.html#find_or_create_service-instance_method" title="ServiceDataService#find_or_create_service (method)">#find_or_create_service</a></span>, <span class='object_link'><a href="../../ServiceDataService.html#report_service-instance_method" title="ServiceDataService#report_service (method)">#report_service</a></span>, <span class='object_link'><a href="../../ServiceDataService.html#services-instance_method" title="ServiceDataService#services (method)">#services</a></span>, <span class='object_link'><a href="../../ServiceDataService.html#update_service-instance_method" title="ServiceDataService#update_service (method)">#update_service</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../NoteDataService.html" title="NoteDataService (module)">NoteDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../../NoteDataService.html#delete_note-instance_method" title="NoteDataService#delete_note (method)">#delete_note</a></span>, <span class='object_link'><a href="../../NoteDataService.html#find_or_create_note-instance_method" title="NoteDataService#find_or_create_note (method)">#find_or_create_note</a></span>, <span class='object_link'><a href="../../NoteDataService.html#notes-instance_method" title="NoteDataService#notes (method)">#notes</a></span>, <span class='object_link'><a href="../../NoteDataService.html#report_note-instance_method" title="NoteDataService#report_note (method)">#report_note</a></span>, <span class='object_link'><a href="../../NoteDataService.html#update_note-instance_method" title="NoteDataService#update_note (method)">#update_note</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../WebDataService.html" title="WebDataService (module)">WebDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../../WebDataService.html#report_web_site-instance_method" title="WebDataService#report_web_site (method)">#report_web_site</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../WorkspaceDataService.html" title="WorkspaceDataService (module)">WorkspaceDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../../WorkspaceDataService.html#add_workspace-instance_method" title="WorkspaceDataService#add_workspace (method)">#add_workspace</a></span>, <span class='object_link'><a href="../../WorkspaceDataService.html#default_workspace-instance_method" title="WorkspaceDataService#default_workspace (method)">#default_workspace</a></span>, <span class='object_link'><a href="../../WorkspaceDataService.html#delete_workspaces-instance_method" title="WorkspaceDataService#delete_workspaces (method)">#delete_workspaces</a></span>, <span class='object_link'><a href="../../WorkspaceDataService.html#find_workspace-instance_method" title="WorkspaceDataService#find_workspace (method)">#find_workspace</a></span>, <span class='object_link'><a href="../../WorkspaceDataService.html#update_workspace-instance_method" title="WorkspaceDataService#update_workspace (method)">#update_workspace</a></span>, <span class='object_link'><a href="../../WorkspaceDataService.html#workspace-instance_method" title="WorkspaceDataService#workspace (method)">#workspace</a></span>, <span class='object_link'><a href="../../WorkspaceDataService.html#workspace=-instance_method" title="WorkspaceDataService#workspace= (method)">#workspace=</a></span>, <span class='object_link'><a href="../../WorkspaceDataService.html#workspaces-instance_method" title="WorkspaceDataService#workspaces (method)">#workspaces</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../VulnDataService.html" title="VulnDataService (module)">VulnDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../../VulnDataService.html#delete_vuln-instance_method" title="VulnDataService#delete_vuln (method)">#delete_vuln</a></span>, <span class='object_link'><a href="../../VulnDataService.html#find_or_create_vuln-instance_method" title="VulnDataService#find_or_create_vuln (method)">#find_or_create_vuln</a></span>, <span class='object_link'><a href="../../VulnDataService.html#report_vuln-instance_method" title="VulnDataService#report_vuln (method)">#report_vuln</a></span>, <span class='object_link'><a href="../../VulnDataService.html#update_vuln-instance_method" title="VulnDataService#update_vuln (method)">#update_vuln</a></span>, <span class='object_link'><a href="../../VulnDataService.html#vulns-instance_method" title="VulnDataService#vulns (method)">#vulns</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../EventDataService.html" title="EventDataService (module)">EventDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../../EventDataService.html#events-instance_method" title="EventDataService#events (method)">#events</a></span>, <span class='object_link'><a href="../../EventDataService.html#report_event-instance_method" title="EventDataService#report_event (method)">#report_event</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../HostDataService.html" title="HostDataService (module)">HostDataService</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../../HostDataService.html#delete_host-instance_method" title="HostDataService#delete_host (method)">#delete_host</a></span>, <span class='object_link'><a href="../../HostDataService.html#find_or_create_host-instance_method" title="HostDataService#find_or_create_host (method)">#find_or_create_host</a></span>, <span class='object_link'><a href="../../HostDataService.html#get_host-instance_method" title="HostDataService#get_host (method)">#get_host</a></span>, <span class='object_link'><a href="../../HostDataService.html#hosts-instance_method" title="HostDataService#hosts (method)">#hosts</a></span>, <span class='object_link'><a href="../../HostDataService.html#report_host-instance_method" title="HostDataService#report_host (method)">#report_host</a></span>, <span class='object_link'><a href="../../HostDataService.html#report_hosts-instance_method" title="HostDataService#report_hosts (method)">#report_hosts</a></span>, <span class='object_link'><a href="../../HostDataService.html#update_host-instance_method" title="HostDataService#update_host (method)">#update_host</a></span></p>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="active-instance_method">
#<strong>active</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service.rb', line 37</span>
<span class='kw'>def</span> <span class='id identifier rubyid_active'>active</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DataService#active is not implemented</span><span class='tstring_end'>&#39;</span></span><span class='semicolon'>;</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="active=-instance_method">
#<strong>active=</strong>(value) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service.rb', line 41</span>
<span class='kw'>def</span> <span class='id identifier rubyid_active='>active=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DataService#active= is not implemented</span><span class='tstring_end'>&#39;</span></span><span class='semicolon'>;</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="is_local?-instance_method">
#<strong>is_local?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<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">
45
46
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service.rb', line 45</span>
<span class='kw'>def</span> <span class='id identifier rubyid_is_local?'>is_local?</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DataService#is_local? is not implemented</span><span class='tstring_end'>&#39;</span></span><span class='semicolon'>;</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="name-instance_method">
#<strong>name</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
33
34
35</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service.rb', line 33</span>
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DataService#name is not implemented</span><span class='tstring_end'>&#39;</span></span><span class='semicolon'>;</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:43 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

1672
api/Metasploit/Framework/DataService/DataProxy.html Normal file
View File

File diff suppressed because it is too large Load Diff

507
api/Metasploit/Framework/DataService/ManagedRemoteDataService.html Normal file
View File

@ -0,0 +1,507 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::DataService::ManagedRemoteDataService
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::DataService::ManagedRemoteDataService";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (M)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../DataService.html" title="Metasploit::Framework::DataService (module)">DataService</a></span></span>
&raquo;
<span class="title">ManagedRemoteDataService</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::DataService::ManagedRemoteDataService
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Metasploit::Framework::DataService::ManagedRemoteDataService</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd>Singleton</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/remote/managed_remote_data_service.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Primarily for testing this instance is used to manage a data service
started within a separate process.</p>
</div>
</div>
<div class="tags">
</div>
<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="#remote_data_service-instance_method" title="#remote_data_service (instance method)">#<strong>remote_data_service</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the client used to interact with the remote data service.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#running%3F-instance_method" title="#running? (instance method)">#<strong>running?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns true if the the managed data service process is running.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#start-instance_method" title="#start (instance method)">#<strong>start</strong>(opts) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Starts a remote data service process.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#stop-instance_method" title="#stop (instance method)">#<strong>stop</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Stops the remote data service process.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="remote_data_service-instance_method">
#<strong>remote_data_service</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the client used to interact with the remote data service</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
24
25
26</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/remote/managed_remote_data_service.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_remote_data_service'>remote_data_service</span>
<span class='kw'>return</span> <span class='ivar'>@remote_host_data_service</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="running?-instance_method">
#<strong>running?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns true if the the managed data service process is running.</p>
</div>
</div>
<div class="tags">
<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">
17
18
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/remote/managed_remote_data_service.rb', line 17</span>
<span class='kw'>def</span> <span class='id identifier rubyid_running?'>running?</span>
<span class='kw'>return</span> <span class='ivar'>@running</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="start-instance_method">
#<strong>start</strong>(opts) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Starts a remote data service process</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/remote/managed_remote_data_service.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_start'>start</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='ivar'>@mutex</span><span class='period'>.</span><span class='id identifier rubyid_synchronize'>synchronize</span> <span class='kw'>do</span>
<span class='kw'>return</span> <span class='kw'>if</span> <span class='ivar'>@running</span>
<span class='comment'># started with no signal to prevent ctrl-c from taking out db
</span> <span class='id identifier rubyid_db_script'>db_script</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span> <span class='const'><span class='object_link'><a href="../../../Msf.html" title="Msf (module)">Msf</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Msf/Config.html" title="Msf::Config (class)">Config</a></span></span><span class='period'>.</span><span class='id identifier rubyid_install_root'><span class='object_link'><a href="../../../Msf/Config.html#install_root-class_method" title="Msf::Config.install_root (method)">install_root</a></span></span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:process_name</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='id identifier rubyid_wait_t'>wait_t</span> <span class='op'>=</span> <span class='const'>Open3</span><span class='period'>.</span><span class='id identifier rubyid_pipeline_start'>pipeline_start</span><span class='lparen'>(</span><span class='id identifier rubyid_db_script'>db_script</span><span class='rparen'>)</span>
<span class='ivar'>@pid</span> <span class='op'>=</span> <span class='id identifier rubyid_wait_t'>wait_t</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_pid'>pid</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Started process with pid </span><span class='embexpr_beg'>#{</span><span class='ivar'>@pid</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_endpoint'>endpoint</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>http://</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:host</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:port</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='ivar'>@remote_host_data_service</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../DataService.html" title="Metasploit::Framework::DataService (module)">DataService</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="RemoteHTTPDataService.html" title="Metasploit::Framework::DataService::RemoteHTTPDataService (class)">RemoteHTTPDataService</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="RemoteHTTPDataService.html#initialize-instance_method" title="Metasploit::Framework::DataService::RemoteHTTPDataService#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint'>endpoint</span><span class='rparen'>)</span>
<span class='id identifier rubyid_count'>count</span> <span class='op'>=</span> <span class='int'>0</span>
<span class='id identifier rubyid_loop'>loop</span> <span class='kw'>do</span>
<span class='id identifier rubyid_count'>count</span> <span class='op'>=</span> <span class='id identifier rubyid_count'>count</span> <span class='op'>+</span> <span class='int'>1</span>
<span class='kw'>if</span> <span class='id identifier rubyid_count'>count</span> <span class='op'>&gt;</span> <span class='int'>10</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Unable to start remote data service</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_sleep'>sleep</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='ivar'>@remote_host_data_service</span><span class='period'>.</span><span class='id identifier rubyid_is_online?'>is_online?</span>
<span class='kw'>break</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='ivar'>@running</span> <span class='op'>=</span> <span class='kw'>true</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="stop-instance_method">
#<strong>stop</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Stops the remote data service process</p>
<p>NOTE: This has potential issues on windows</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
69
70
71
72
73
74
75
76
77
78
79
80</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/remote/managed_remote_data_service.rb', line 69</span>
<span class='kw'>def</span> <span class='id identifier rubyid_stop'>stop</span>
<span class='ivar'>@mutex</span><span class='period'>.</span><span class='id identifier rubyid_synchronize'>synchronize</span> <span class='kw'>do</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='ivar'>@running</span>
<span class='kw'>begin</span>
<span class='const'>Process</span><span class='period'>.</span><span class='id identifier rubyid_kill'>kill</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>TERM</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='ivar'>@pid</span><span class='rparen'>)</span>
<span class='ivar'>@running</span> <span class='op'>=</span> <span class='kw'>false</span>
<span class='kw'>rescue</span> <span class='const'>Exception</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unable to kill db process: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:39:26 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

520
api/Metasploit/Framework/DataService/Metadata.html Normal file
View File

@ -0,0 +1,520 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::DataService::Metadata
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::DataService::Metadata";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (M)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../DataService.html" title="Metasploit::Framework::DataService (module)">DataService</a></span></span>
&raquo;
<span class="title">Metadata</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::DataService::Metadata
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Metasploit::Framework::DataService::Metadata</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Hold metadata about a data service</p>
</div>
</div>
<div class="tags">
</div>
<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="#active-instance_method" title="#active (instance method)">#<strong>active</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute active.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute id.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#is_local-instance_method" title="#is_local (instance method)">#<strong>is_local</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute is_local.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute name.</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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(id, name, active, is_local) &#x21d2; Metadata </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of Metadata.</p>
</div></span>
</li>
</ul>
<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">
#<strong>initialize</strong>(id, name, active, is_local) &#x21d2; <tt><span class='object_link'><a href="" title="Metasploit::Framework::DataService::Metadata (class)">Metadata</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Metadata</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
58
59
60
61
62
63
64</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service.rb', line 58</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_active'>active</span><span class='comma'>,</span> <span class='id identifier rubyid_is_local'>is_local</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='op'>=</span> <span class='id identifier rubyid_id'>id</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_active'>active</span> <span class='op'>=</span> <span class='id identifier rubyid_active'>active</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_is_local'>is_local</span> <span class='op'>=</span> <span class='id identifier rubyid_is_local'>is_local</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="active=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="active-instance_method">
#<strong>active</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute active</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
55
56
57</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service.rb', line 55</span>
<span class='kw'>def</span> <span class='id identifier rubyid_active'>active</span>
<span class='ivar'>@active</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="id=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="id-instance_method">
#<strong>id</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute id</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
53
54
55</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service.rb', line 53</span>
<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
<span class='ivar'>@id</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="is_local=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="is_local-instance_method">
#<strong>is_local</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute is_local</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
56
57
58</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service.rb', line 56</span>
<span class='kw'>def</span> <span class='id identifier rubyid_is_local'>is_local</span>
<span class='ivar'>@is_local</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="name=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="name-instance_method">
#<strong>name</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute name</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
54
55
56</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service.rb', line 54</span>
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
<span class='ivar'>@name</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:38:57 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

2698
api/Metasploit/Framework/DataService/RemoteHTTPDataService.html Normal file
View File

File diff suppressed because it is too large Load Diff

227
api/Metasploit/Framework/DataService/RemoteHTTPDataService/FailedResponse.html Normal file
View File

@ -0,0 +1,227 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::DataService::RemoteHTTPDataService::FailedResponse
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::DataService::RemoteHTTPDataService::FailedResponse";
relpath = '../../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../../_index.html">Index (F)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../DataService.html" title="Metasploit::Framework::DataService (module)">DataService</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../RemoteHTTPDataService.html" title="Metasploit::Framework::DataService::RemoteHTTPDataService (class)">RemoteHTTPDataService</a></span></span>
&raquo;
<span class="title">FailedResponse</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::DataService::RemoteHTTPDataService::FailedResponse
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="ResponseWrapper.html" title="Metasploit::Framework::DataService::RemoteHTTPDataService::ResponseWrapper (class)">ResponseWrapper</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="ResponseWrapper.html" title="Metasploit::Framework::DataService::RemoteHTTPDataService::ResponseWrapper (class)">ResponseWrapper</a></span></li>
<li class="next">Metasploit::Framework::DataService::RemoteHTTPDataService::FailedResponse</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/remote/http/core.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Failed response wrapper</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="ResponseWrapper.html" title="Metasploit::Framework::DataService::RemoteHTTPDataService::ResponseWrapper (class)">ResponseWrapper</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ResponseWrapper.html#expected-instance_method" title="Metasploit::Framework::DataService::RemoteHTTPDataService::ResponseWrapper#expected (method)">#expected</a></span>, <span class='object_link'><a href="ResponseWrapper.html#response-instance_method" title="Metasploit::Framework::DataService::RemoteHTTPDataService::ResponseWrapper#response (method)">#response</a></span></p>
<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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(response) &#x21d2; FailedResponse </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of FailedResponse.</p>
</div></span>
</li>
</ul>
<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">
#<strong>initialize</strong>(response) &#x21d2; <tt><span class='object_link'><a href="" title="Metasploit::Framework::DataService::RemoteHTTPDataService::FailedResponse (class)">FailedResponse</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of FailedResponse</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
251
252
253</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/remote/http/core.rb', line 251</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:39:21 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

374
api/Metasploit/Framework/DataService/RemoteHTTPDataService/ResponseWrapper.html Normal file
View File

@ -0,0 +1,374 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::DataService::RemoteHTTPDataService::ResponseWrapper
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::DataService::RemoteHTTPDataService::ResponseWrapper";
relpath = '../../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../../_index.html">Index (R)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../DataService.html" title="Metasploit::Framework::DataService (module)">DataService</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../RemoteHTTPDataService.html" title="Metasploit::Framework::DataService::RemoteHTTPDataService (class)">RemoteHTTPDataService</a></span></span>
&raquo;
<span class="title">ResponseWrapper</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::DataService::RemoteHTTPDataService::ResponseWrapper
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Metasploit::Framework::DataService::RemoteHTTPDataService::ResponseWrapper</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/remote/http/core.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Simple response wrapper</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="FailedResponse.html" title="Metasploit::Framework::DataService::RemoteHTTPDataService::FailedResponse (class)">FailedResponse</a></span>, <span class='object_link'><a href="SuccessResponse.html" title="Metasploit::Framework::DataService::RemoteHTTPDataService::SuccessResponse (class)">SuccessResponse</a></span></p>
</div>
<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="#expected-instance_method" title="#expected (instance method)">#<strong>expected</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute expected.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#response-instance_method" title="#response (instance method)">#<strong>response</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute response.</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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(response, expected) &#x21d2; ResponseWrapper </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of ResponseWrapper.</p>
</div></span>
</li>
</ul>
<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">
#<strong>initialize</strong>(response, expected) &#x21d2; <tt><span class='object_link'><a href="" title="Metasploit::Framework::DataService::RemoteHTTPDataService::ResponseWrapper (class)">ResponseWrapper</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of ResponseWrapper</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
241
242
243
244</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/remote/http/core.rb', line 241</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_expected'>expected</span><span class='rparen'>)</span>
<span class='ivar'>@response</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span>
<span class='ivar'>@expected</span> <span class='op'>=</span> <span class='id identifier rubyid_expected'>expected</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=""></span>
<div class="method_details first">
<h3 class="signature first" id="expected-instance_method">
#<strong>expected</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute expected</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
239
240
241</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/remote/http/core.rb', line 239</span>
<span class='kw'>def</span> <span class='id identifier rubyid_expected'>expected</span>
<span class='ivar'>@expected</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="response-instance_method">
#<strong>response</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute response</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
238
239
240</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/remote/http/core.rb', line 238</span>
<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
<span class='ivar'>@response</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:39:21 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

227
api/Metasploit/Framework/DataService/RemoteHTTPDataService/SuccessResponse.html Normal file
View File

@ -0,0 +1,227 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::DataService::RemoteHTTPDataService::SuccessResponse
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::DataService::RemoteHTTPDataService::SuccessResponse";
relpath = '../../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../../_index.html">Index (S)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../DataService.html" title="Metasploit::Framework::DataService (module)">DataService</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../RemoteHTTPDataService.html" title="Metasploit::Framework::DataService::RemoteHTTPDataService (class)">RemoteHTTPDataService</a></span></span>
&raquo;
<span class="title">SuccessResponse</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::DataService::RemoteHTTPDataService::SuccessResponse
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="ResponseWrapper.html" title="Metasploit::Framework::DataService::RemoteHTTPDataService::ResponseWrapper (class)">ResponseWrapper</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="ResponseWrapper.html" title="Metasploit::Framework::DataService::RemoteHTTPDataService::ResponseWrapper (class)">ResponseWrapper</a></span></li>
<li class="next">Metasploit::Framework::DataService::RemoteHTTPDataService::SuccessResponse</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/data_service/remote/http/core.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Success response wrapper</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="ResponseWrapper.html" title="Metasploit::Framework::DataService::RemoteHTTPDataService::ResponseWrapper (class)">ResponseWrapper</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ResponseWrapper.html#expected-instance_method" title="Metasploit::Framework::DataService::RemoteHTTPDataService::ResponseWrapper#expected (method)">#expected</a></span>, <span class='object_link'><a href="ResponseWrapper.html#response-instance_method" title="Metasploit::Framework::DataService::RemoteHTTPDataService::ResponseWrapper#response (method)">#response</a></span></p>
<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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(response) &#x21d2; SuccessResponse </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of SuccessResponse.</p>
</div></span>
</li>
</ul>
<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">
#<strong>initialize</strong>(response) &#x21d2; <tt><span class='object_link'><a href="" title="Metasploit::Framework::DataService::RemoteHTTPDataService::SuccessResponse (class)">SuccessResponse</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of SuccessResponse</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
260
261
262</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/data_service/remote/http/core.rb', line 260</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:39:21 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

721
api/Metasploit/Framework/Database.html Normal file
View File

@ -0,0 +1,721 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::Database
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::Database";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (D)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span>
&raquo;
<span class="title">Database</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::Database
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/database.rb</dd>
</dl>
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="CONFIGURATIONS_PATHNAME_PRECEDENCE-constant" class="">CONFIGURATIONS_PATHNAME_PRECEDENCE =
<div class="docstring">
<div class="discussion">
<p>CONSTANTS</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbracket'>[</span>
<span class='symbol'>:environment_configurations_pathname</span><span class='comma'>,</span>
<span class='symbol'>:user_configurations_pathname</span><span class='comma'>,</span>
<span class='symbol'>:project_configurations_pathname</span>
<span class='rbracket'>]</span></pre></dd>
</dl>
<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="#configurations_pathname-class_method" title="configurations_pathname (class method)">.<strong>configurations_pathname</strong>(options = {}) &#x21d2; Pathname<sup>?</sup> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns first configuration pathname from configuration_pathnames or the
overridding `:path`.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#configurations_pathnames-class_method" title="configurations_pathnames (class method)">.<strong>configurations_pathnames</strong> &#x21d2; Array&lt;Pathname&gt; </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return configuration pathnames that exist.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#environment_configurations_pathname-class_method" title="environment_configurations_pathname (class method)">.<strong>environment_configurations_pathname</strong> &#x21d2; Pathname<sup>?</sup> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Pathname to `database.yml` pointed to by `MSF_DATABASE_CONFIG` environment
variable.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#project_configurations_pathname-class_method" title="project_configurations_pathname (class method)">.<strong>project_configurations_pathname</strong> &#x21d2; Pathname </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Pathname to `database.yml` for the metasploit-framework project in
`config/database.yml`.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#user_configurations_pathname-class_method" title="user_configurations_pathname (class method)">.<strong>user_configurations_pathname</strong> &#x21d2; Pathname<sup>?</sup> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Pathname to `database.yml` in the user&#39;s config directory.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="configurations_pathname-class_method">
.<strong>configurations_pathname</strong>(options = {}) &#x21d2; <tt>Pathname</tt><sup>?</sup>
</h3><div class="docstring">
<div class="discussion">
<p>Returns first configuration pathname from configuration_pathnames or the
overridding `:path`.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt>Hash{Symbol=&gt;String}</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
<ul class="option">
<li>
<span class="name">:path</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
&mdash; <div class='inline'>
<p>Path to use instead of first element of configurations_pathnames</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Pathname</tt>)</span>
&mdash;
<div class='inline'>
<p>if configuration pathname exists.</p>
</div>
</li>
<li>
<span class='type'>(<tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>if configuration pathname does not exist.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/database.rb', line 27</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configurations_pathname'>configurations_pathname</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_assert_valid_keys'>assert_valid_keys</span><span class='lparen'>(</span><span class='symbol'>:path</span><span class='rparen'>)</span>
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span>
<span class='kw'>if</span> <span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
<span class='id identifier rubyid_pathname'>pathname</span> <span class='op'>=</span> <span class='const'>Pathname</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_pathname'>pathname</span> <span class='op'>=</span> <span class='id identifier rubyid_configurations_pathnames'>configurations_pathnames</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_pathname'>pathname</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_pathname'>pathname</span><span class='period'>.</span><span class='id identifier rubyid_exist?'>exist?</span>
<span class='id identifier rubyid_pathname'>pathname</span>
<span class='kw'>else</span>
<span class='kw'>nil</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="configurations_pathnames-class_method">
.<strong>configurations_pathnames</strong> &#x21d2; <tt>Array&lt;Pathname&gt;</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return configuration pathnames that exist.</p>
<p>Returns `Pathnames` in order of precedence</p>
<ol><li>
<p><span class='object_link'><a href="#environment_configurations_pathname-class_method" title="Metasploit::Framework::Database.environment_configurations_pathname (method)">environment_configurations_pathname</a></span></p>
</li><li>
<p><span class='object_link'><a href="#user_configurations_pathname-class_method" title="Metasploit::Framework::Database.user_configurations_pathname (method)">user_configurations_pathname</a></span></p>
</li><li>
<p><span class='object_link'><a href="#project_configurations_pathname-class_method" title="Metasploit::Framework::Database.project_configurations_pathname (method)">project_configurations_pathname</a></span></p>
</li></ol>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array&lt;Pathname&gt;</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
54
55
56
57
58
59
60
61
62
63
64
65
66</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/database.rb', line 54</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configurations_pathnames'>configurations_pathnames</span>
<span class='id identifier rubyid_configurations_pathnames'>configurations_pathnames</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='const'><span class='object_link'><a href="#CONFIGURATIONS_PATHNAME_PRECEDENCE-constant" title="Metasploit::Framework::Database::CONFIGURATIONS_PATHNAME_PRECEDENCE (constant)">CONFIGURATIONS_PATHNAME_PRECEDENCE</a></span></span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_configurations_pathname_message'>configurations_pathname_message</span><span class='op'>|</span>
<span class='id identifier rubyid_configurations_pathname'>configurations_pathname</span> <span class='op'>=</span> <span class='id identifier rubyid_public_send'>public_send</span><span class='lparen'>(</span><span class='id identifier rubyid_configurations_pathname_message'>configurations_pathname_message</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_configurations_pathname'>configurations_pathname</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_configurations_pathname'>configurations_pathname</span><span class='period'>.</span><span class='id identifier rubyid_exist?'>exist?</span>
<span class='id identifier rubyid_configurations_pathnames'>configurations_pathnames</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_configurations_pathname'>configurations_pathname</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_configurations_pathnames'>configurations_pathnames</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="environment_configurations_pathname-class_method">
.<strong>environment_configurations_pathname</strong> &#x21d2; <tt>Pathname</tt><sup>?</sup>
</h3><div class="docstring">
<div class="discussion">
<p>Pathname to `database.yml` pointed to by `MSF_DATABASE_CONFIG` environment
variable.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Pathname</tt>)</span>
&mdash;
<div class='inline'>
<p>if `MSF_DATABASE_CONFIG` is not blank.</p>
</div>
</li>
<li>
<span class='type'>(<tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>otherwise</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
72
73
74
75
76
77
78
79
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/database.rb', line 72</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_environment_configurations_pathname'>environment_configurations_pathname</span>
<span class='id identifier rubyid_msf_database_config'>msf_database_config</span> <span class='op'>=</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>MSF_DATABASE_CONFIG</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
<span class='kw'>if</span> <span class='id identifier rubyid_msf_database_config'>msf_database_config</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>
<span class='id identifier rubyid_msf_database_config'>msf_database_config</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_msf_database_config'>msf_database_config</span> <span class='op'>=</span> <span class='const'>Pathname</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_msf_database_config'>msf_database_config</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_msf_database_config'>msf_database_config</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="project_configurations_pathname-class_method">
.<strong>project_configurations_pathname</strong> &#x21d2; <tt>Pathname</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Pathname to `database.yml` for the metasploit-framework project in
`config/database.yml`.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Pathname</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
87
88
89
90</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/database.rb', line 87</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_project_configurations_pathname'>project_configurations_pathname</span>
<span class='id identifier rubyid_root'><span class='object_link'><a href="../../top-level-namespace.html" title="Top Level Namespace (root)">root</a></span></span> <span class='op'>=</span> <span class='const'>Pathname</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_realpath'>realpath</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span>
<span class='id identifier rubyid_root'><span class='object_link'><a href="../../top-level-namespace.html" title="Top Level Namespace (root)">root</a></span></span><span class='period'>.</span><span class='id identifier rubyid_join'><span class='object_link'><a href="../../top-level-namespace.html#join-instance_method" title="#join (method)">join</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>config</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>database.yml</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="user_configurations_pathname-class_method">
.<strong>user_configurations_pathname</strong> &#x21d2; <tt>Pathname</tt><sup>?</sup>
</h3><div class="docstring">
<div class="discussion">
<p>Pathname to `database.yml` in the user&#39;s config directory.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Pathname</tt>)</span>
&mdash;
<div class='inline'>
<p>if the user has a `database.yml` in their config directory (`~/.msf4` by
default).</p>
</div>
</li>
<li>
<span class='type'>(<tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>if the user does not have a `database.yml` in their config directory.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
96
97
98</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/database.rb', line 96</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_user_configurations_pathname'>user_configurations_pathname</span>
<span class='const'>Pathname</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Msf.html" title="Msf (module)">Msf</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Msf/Config.html" title="Msf::Config (class)">Config</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get_config_root'><span class='object_link'><a href="../../Msf/Config.html#get_config_root-class_method" title="Msf::Config.get_config_root (method)">get_config_root</a></span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'><span class='object_link'><a href="../../top-level-namespace.html#join-instance_method" title="#join (method)">join</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>database.yml</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:41 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

136
api/Metasploit/Framework/Engine.html Normal file
View File

@ -0,0 +1,136 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::Engine
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::Engine";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (E)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span>
&raquo;
<span class="title">Engine</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::Engine
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Rails::Engine</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Rails::Engine</li>
<li class="next">Metasploit::Framework::Engine</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="CommonEngine.html" title="Metasploit::Framework::CommonEngine (module)">CommonEngine</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/engine.rb</dd>
</dl>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:38:56 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

210
api/Metasploit/Framework/ExecutablePathValidator.html Normal file
View File

@ -0,0 +1,210 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::ExecutablePathValidator
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::ExecutablePathValidator";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (E)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span>
&raquo;
<span class="title">ExecutablePathValidator</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::ExecutablePathValidator
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">ActiveModel::EachValidator</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">ActiveModel::EachValidator</li>
<li class="next">Metasploit::Framework::ExecutablePathValidator</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>app/validators/metasploit/framework/executable_path_validator.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This is a ActiveModel custom validator that assumes the attribute is
supposed to be the path to a regular file. It checks whether the file
exists and whether or not it is an executable file.</p>
</div>
</div>
<div class="tags">
</div>
<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="#validate_each-instance_method" title="#validate_each (instance method)">#<strong>validate_each</strong>(record, attribute, value) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="validate_each-instance_method">
#<strong>validate_each</strong>(record, attribute, value) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10
11
12</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/validators/metasploit/framework/executable_path_validator.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_validate_each'>validate_each</span><span class='lparen'>(</span><span class='id identifier rubyid_record'>record</span><span class='comma'>,</span> <span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_executable?'>executable?</span> <span class='id identifier rubyid_value'>value</span>
<span class='id identifier rubyid_record'>record</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span><span class='lbracket'>[</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbracket'>]</span> <span class='op'>&lt;&lt;</span> <span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:message</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>is not a valid path to an executable file</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:37:15 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

210
api/Metasploit/Framework/FilePathValidator.html Normal file
View File

@ -0,0 +1,210 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::FilePathValidator
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::FilePathValidator";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (F)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span>
&raquo;
<span class="title">FilePathValidator</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::FilePathValidator
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">ActiveModel::EachValidator</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">ActiveModel::EachValidator</li>
<li class="next">Metasploit::Framework::FilePathValidator</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>app/validators/metasploit/framework/file_path_validator.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This is a ActiveModel custom validator that assumes the attribute is
supposed to be the path to a regular file. It checks whether the file
exists and whether or not it is a regular file.</p>
</div>
</div>
<div class="tags">
</div>
<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="#validate_each-instance_method" title="#validate_each (instance method)">#<strong>validate_each</strong>(record, attribute, value) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="validate_each-instance_method">
#<strong>validate_each</strong>(record, attribute, value) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10
11
12</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/validators/metasploit/framework/file_path_validator.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_validate_each'>validate_each</span><span class='lparen'>(</span><span class='id identifier rubyid_record'>record</span><span class='comma'>,</span> <span class='id identifier rubyid_attribute'>attribute</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_file?'>file?</span> <span class='id identifier rubyid_value'>value</span>
<span class='id identifier rubyid_record'>record</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span><span class='lbracket'>[</span><span class='id identifier rubyid_attribute'>attribute</span><span class='rbracket'>]</span> <span class='op'>&lt;&lt;</span> <span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:message</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>is not a valid path to a regular file</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:37:15 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

115
api/Metasploit/Framework/Ftp.html Normal file
View File

@ -0,0 +1,115 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::Ftp
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::Ftp";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (F)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span>
&raquo;
<span class="title">Ftp</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::Ftp
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/ftp/client.rb</dd>
</dl>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Ftp/Client.html" title="Metasploit::Framework::Ftp::Client (module)">Client</a></span>
</p>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:42 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

1497
api/Metasploit/Framework/Ftp/Client.html Normal file
View File

File diff suppressed because it is too large Load Diff

117
api/Metasploit/Framework/JtR.html Normal file
View File

@ -0,0 +1,117 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::JtR
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::JtR";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (J)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span>
&raquo;
<span class="title">JtR</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::JtR
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/jtr/cracker.rb<span class="defines">,<br />
lib/metasploit/framework/jtr/wordlist.rb,<br /> lib/metasploit/framework/jtr/invalid_wordlist.rb</span>
</dd>
</dl>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="JtR/Cracker.html" title="Metasploit::Framework::JtR::Cracker (class)">Cracker</a></span>, <span class='object_link'><a href="JtR/InvalidWordlist.html" title="Metasploit::Framework::JtR::InvalidWordlist (class)">InvalidWordlist</a></span>, <span class='object_link'><a href="JtR/JohnNotFoundError.html" title="Metasploit::Framework::JtR::JohnNotFoundError (class)">JohnNotFoundError</a></span>, <span class='object_link'><a href="JtR/Wordlist.html" title="Metasploit::Framework::JtR::Wordlist (class)">Wordlist</a></span>
</p>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:42 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

1987
api/Metasploit/Framework/JtR/Cracker.html Normal file
View File

File diff suppressed because it is too large Load Diff

307
api/Metasploit/Framework/JtR/InvalidWordlist.html Normal file
View File

@ -0,0 +1,307 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Exception: Metasploit::Framework::JtR::InvalidWordlist
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::JtR::InvalidWordlist";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (I)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../JtR.html" title="Metasploit::Framework::JtR (module)">JtR</a></span></span>
&raquo;
<span class="title">InvalidWordlist</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Exception: Metasploit::Framework::JtR::InvalidWordlist
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">StandardError</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">StandardError</li>
<li class="next">Metasploit::Framework::JtR::InvalidWordlist</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/jtr/invalid_wordlist.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This class is the generic Exception raised by a <span class='object_link'><a href="Wordlist.html" title="Metasploit::Framework::JtR::Wordlist (class)">Wordlist</a></span> when it fails
validation. It rolls up all validation errors into a single exception so
that all errors can be dealt with at once.</p>
</div>
</div>
<div class="tags">
</div>
<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="#model-instance_method" title="#model (instance method)">#<strong>model</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute model.</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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(model) &#x21d2; InvalidWordlist </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of InvalidWordlist.</p>
</div></span>
</li>
</ul>
<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">
#<strong>initialize</strong>(model) &#x21d2; <tt><span class='object_link'><a href="" title="Metasploit::Framework::JtR::InvalidWordlist (class)">InvalidWordlist</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of InvalidWordlist</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/jtr/invalid_wordlist.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_model'>model</span><span class='rparen'>)</span>
<span class='ivar'>@model</span> <span class='op'>=</span> <span class='id identifier rubyid_model'>model</span>
<span class='id identifier rubyid_errors'>errors</span> <span class='op'>=</span> <span class='ivar'>@model</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_full_messages'>full_messages</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>, </span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_errors'>errors</span><span class='rparen'>)</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=""></span>
<div class="method_details first">
<h3 class="signature first" id="model-instance_method">
#<strong>model</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute model</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/jtr/invalid_wordlist.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_model'>model</span>
<span class='ivar'>@model</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:39:09 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

124
api/Metasploit/Framework/JtR/JohnNotFoundError.html Normal file
View File

@ -0,0 +1,124 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Exception: Metasploit::Framework::JtR::JohnNotFoundError
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::JtR::JohnNotFoundError";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (J)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../JtR.html" title="Metasploit::Framework::JtR (module)">JtR</a></span></span>
&raquo;
<span class="title">JohnNotFoundError</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Exception: Metasploit::Framework::JtR::JohnNotFoundError
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">StandardError</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">StandardError</li>
<li class="next">Metasploit::Framework::JtR::JohnNotFoundError</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/jtr/cracker.rb</dd>
</dl>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:38:56 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

2969
api/Metasploit/Framework/JtR/Wordlist.html Normal file
View File

File diff suppressed because it is too large Load Diff

361
api/Metasploit/Framework/LoginScanner.html Normal file
View File

File diff suppressed because one or more lines are too long

408
api/Metasploit/Framework/LoginScanner/ACPP.html Normal file
View File

@ -0,0 +1,408 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::LoginScanner::ACPP
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::LoginScanner::ACPP";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (A)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../LoginScanner.html" title="Metasploit::Framework::LoginScanner (module)">LoginScanner</a></span></span>
&raquo;
<span class="title">ACPP</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::LoginScanner::ACPP
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Metasploit::Framework::LoginScanner::ACPP</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="Base.html" title="Metasploit::Framework::LoginScanner::Base (module)">Base</a></span>, <span class='object_link'><a href="RexSocket.html" title="Metasploit::Framework::LoginScanner::RexSocket (module)">RexSocket</a></span>, <span class='object_link'><a href="../Tcp/Client.html" title="Metasploit::Framework::Tcp::Client (module)">Tcp::Client</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/login_scanner/acpp.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This is the LoginScanner class for dealing with the Apple Airport ACPP
protocol. It is responsible for taking a single target, and a list of
credentials and attempting them. It then saves the results.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="DEFAULT_PORT-constant" class="">DEFAULT_PORT =
<div class="docstring">
<div class="discussion">
<p>CONSTANTS</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto.html" title="Rex::Proto (module)">Proto</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/ACPP.html" title="Rex::Proto::ACPP (module)">ACPP</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/ACPP.html#DEFAULT_PORT-constant" title="Rex::Proto::ACPP::DEFAULT_PORT (constant)">DEFAULT_PORT</a></span></span></pre></dd>
<dt id="LIKELY_PORTS-constant" class="">LIKELY_PORTS =
</dt>
<dd><pre class="code"><span class='lbracket'>[</span> <span class='const'><span class='object_link'><a href="#DEFAULT_PORT-constant" title="Metasploit::Framework::LoginScanner::ACPP::DEFAULT_PORT (constant)">DEFAULT_PORT</a></span></span> <span class='rbracket'>]</span></pre></dd>
<dt id="LIKELY_SERVICE_NAMES-constant" class="">LIKELY_SERVICE_NAMES =
</dt>
<dd><pre class="code"><span class='lbracket'>[</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>acpp</span><span class='tstring_end'>&#39;</span></span> <span class='rbracket'>]</span></pre></dd>
<dt id="PRIVATE_TYPES-constant" class="">PRIVATE_TYPES =
</dt>
<dd><pre class="code"><span class='lbracket'>[</span> <span class='symbol'>:password</span> <span class='rbracket'>]</span></pre></dd>
<dt id="REALM_KEY-constant" class="">REALM_KEY =
</dt>
<dd><pre class="code"><span class='kw'>nil</span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes included from <span class='object_link'><a href="../Tcp/Client.html" title="Metasploit::Framework::Tcp::Client (module)">Tcp::Client</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Tcp/Client.html#max_send_size-instance_method" title="Metasploit::Framework::Tcp::Client#max_send_size (method)">#max_send_size</a></span>, <span class='object_link'><a href="../Tcp/Client.html#send_delay-instance_method" title="Metasploit::Framework::Tcp::Client#send_delay (method)">#send_delay</a></span>, <span class='object_link'><a href="../Tcp/Client.html#sock-instance_method" title="Metasploit::Framework::Tcp::Client#sock (method)">#sock</a></span></p>
<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="#attempt_login-instance_method" title="#attempt_login (instance method)">#<strong>attempt_login</strong>(credential) &#x21d2; Metasploit::Framework::LoginScanner::Result </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method attempts a single login with a single credential against the
target.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Tcp/Client.html" title="Metasploit::Framework::Tcp::Client (module)">Tcp::Client</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Tcp/Client.html#chost-instance_method" title="Metasploit::Framework::Tcp::Client#chost (method)">#chost</a></span>, <span class='object_link'><a href="../Tcp/Client.html#connect-instance_method" title="Metasploit::Framework::Tcp::Client#connect (method)">#connect</a></span>, <span class='object_link'><a href="../Tcp/Client.html#cport-instance_method" title="Metasploit::Framework::Tcp::Client#cport (method)">#cport</a></span>, <span class='object_link'><a href="../Tcp/Client.html#disconnect-instance_method" title="Metasploit::Framework::Tcp::Client#disconnect (method)">#disconnect</a></span>, <span class='object_link'><a href="../Tcp/Client.html#proxies-instance_method" title="Metasploit::Framework::Tcp::Client#proxies (method)">#proxies</a></span>, <span class='object_link'><a href="../Tcp/Client.html#rhost-instance_method" title="Metasploit::Framework::Tcp::Client#rhost (method)">#rhost</a></span>, <span class='object_link'><a href="../Tcp/Client.html#rport-instance_method" title="Metasploit::Framework::Tcp::Client#rport (method)">#rport</a></span>, <span class='object_link'><a href="../Tcp/Client.html#set_tcp_evasions-instance_method" title="Metasploit::Framework::Tcp::Client#set_tcp_evasions (method)">#set_tcp_evasions</a></span>, <span class='object_link'><a href="../Tcp/Client.html#ssl-instance_method" title="Metasploit::Framework::Tcp::Client#ssl (method)">#ssl</a></span>, <span class='object_link'><a href="../Tcp/Client.html#ssl_version-instance_method" title="Metasploit::Framework::Tcp::Client#ssl_version (method)">#ssl_version</a></span></p>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="attempt_login-instance_method">
#<strong>attempt_login</strong>(credential) &#x21d2; <tt><span class='object_link'><a href="Result.html" title="Metasploit::Framework::LoginScanner::Result (class)">Metasploit::Framework::LoginScanner::Result</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method attempts a single login with a single credential against the
target</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>credential</span>
<span class='type'>(<tt><span class='object_link'><a href="../Credential.html" title="Metasploit::Framework::Credential (class)">Credential</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>The credential object to attmpt to login with</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Result.html" title="Metasploit::Framework::LoginScanner::Result (class)">Metasploit::Framework::LoginScanner::Result</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>The LoginScanner Result object</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/login_scanner/acpp.rb', line 30</span>
<span class='kw'>def</span> <span class='id identifier rubyid_attempt_login'>attempt_login</span><span class='lparen'>(</span><span class='id identifier rubyid_credential'>credential</span><span class='rparen'>)</span>
<span class='id identifier rubyid_result_options'>result_options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>credential:</span> <span class='id identifier rubyid_credential'>credential</span><span class='comma'>,</span>
<span class='label'>host:</span> <span class='id identifier rubyid_host'>host</span><span class='comma'>,</span>
<span class='label'>port:</span> <span class='id identifier rubyid_port'>port</span><span class='comma'>,</span>
<span class='label'>protocol:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tcp</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>service_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>acpp</span><span class='tstring_end'>&#39;</span></span>
<span class='rbrace'>}</span>
<span class='kw'>begin</span>
<span class='comment'># Make our initial socket to the target
</span> <span class='id identifier rubyid_disconnect'>disconnect</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_sock'>sock</span>
<span class='id identifier rubyid_connect'>connect</span>
<span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto.html" title="Rex::Proto (module)">Proto</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/ACPP.html" title="Rex::Proto::ACPP (module)">ACPP</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/ACPP/Client.html" title="Rex::Proto::ACPP::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../../../Rex/Proto/ACPP/Client.html#initialize-instance_method" title="Rex::Proto::ACPP::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_sock'>sock</span><span class='rparen'>)</span>
<span class='id identifier rubyid_auth_response'>auth_response</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_authenticate'>authenticate</span><span class='lparen'>(</span><span class='id identifier rubyid_credential'>credential</span><span class='period'>.</span><span class='id identifier rubyid_private'>private</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_auth_response'>auth_response</span><span class='period'>.</span><span class='id identifier rubyid_successful?'>successful?</span>
<span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Login</span><span class='op'>::</span><span class='const'>Status</span><span class='op'>::</span><span class='const'>SUCCESSFUL</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Login</span><span class='op'>::</span><span class='const'>Status</span><span class='op'>::</span><span class='const'>INCORRECT</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_result_options'>result_options</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span>
<span class='label'>proof:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Status code </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_auth_response'>auth_response</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='label'>status:</span> <span class='id identifier rubyid_status'>status</span>
<span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='op'>::</span><span class='const'>EOFError</span><span class='comma'>,</span> <span class='const'>Errno</span><span class='op'>::</span><span class='const'>ENOTCONN</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../../../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/ConnectionError.html" title="Rex::ConnectionError (class)">ConnectionError</a></span></span><span class='comma'>,</span> <span class='op'>::</span><span class='const'>Timeout</span><span class='op'>::</span><span class='const'>Error</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='id identifier rubyid_result_options'>result_options</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span>
<span class='label'>proof:</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span>
<span class='label'>status:</span> <span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Login</span><span class='op'>::</span><span class='const'>Status</span><span class='op'>::</span><span class='const'>UNABLE_TO_CONNECT</span>
<span class='rparen'>)</span>
<span class='kw'>ensure</span>
<span class='id identifier rubyid_disconnect'>disconnect</span>
<span class='kw'>end</span>
<span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../LoginScanner.html" title="Metasploit::Framework::LoginScanner (module)">LoginScanner</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Result.html" title="Metasploit::Framework::LoginScanner::Result (class)">Result</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Result.html#initialize-instance_method" title="Metasploit::Framework::LoginScanner::Result#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_result_options'>result_options</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:39:03 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

479
api/Metasploit/Framework/LoginScanner/AFP.html Normal file
View File

@ -0,0 +1,479 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::LoginScanner::AFP
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::LoginScanner::AFP";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (A)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../LoginScanner.html" title="Metasploit::Framework::LoginScanner (module)">LoginScanner</a></span></span>
&raquo;
<span class="title">AFP</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::LoginScanner::AFP
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Metasploit::Framework::LoginScanner::AFP</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="../AFP/Client.html" title="Metasploit::Framework::AFP::Client (module)">AFP::Client</a></span>, <span class='object_link'><a href="Base.html" title="Metasploit::Framework::LoginScanner::Base (module)">Base</a></span>, <span class='object_link'><a href="RexSocket.html" title="Metasploit::Framework::LoginScanner::RexSocket (module)">RexSocket</a></span>, <span class='object_link'><a href="../Tcp/Client.html" title="Metasploit::Framework::Tcp::Client (module)">Tcp::Client</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/login_scanner/afp.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This is the LoginScanner class for dealing with Apple Filing Protocol.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="DEFAULT_PORT-constant" class="">DEFAULT_PORT =
</dt>
<dd><pre class="code"><span class='int'>548</span></pre></dd>
<dt id="LIKELY_PORTS-constant" class="">LIKELY_PORTS =
</dt>
<dd><pre class="code"><span class='lbracket'>[</span> <span class='const'><span class='object_link'><a href="#DEFAULT_PORT-constant" title="Metasploit::Framework::LoginScanner::AFP::DEFAULT_PORT (constant)">DEFAULT_PORT</a></span></span> <span class='rbracket'>]</span></pre></dd>
<dt id="LIKELY_SERVICE_NAMES-constant" class="">LIKELY_SERVICE_NAMES =
</dt>
<dd><pre class="code"><span class='lbracket'>[</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>afp</span><span class='tstring_end'>&quot;</span></span> <span class='rbracket'>]</span></pre></dd>
<dt id="PRIVATE_TYPES-constant" class="">PRIVATE_TYPES =
</dt>
<dd><pre class="code"><span class='lbracket'>[</span> <span class='symbol'>:password</span> <span class='rbracket'>]</span></pre></dd>
<dt id="REALM_KEY-constant" class="">REALM_KEY =
</dt>
<dd><pre class="code"><span class='kw'>nil</span></pre></dd>
</dl>
<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="#login_timeout-instance_method" title="#login_timeout (instance method)">#<strong>login_timeout</strong> &#x21d2; Integer </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Number of seconds to wait before giving up.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes included from <span class='object_link'><a href="../Tcp/Client.html" title="Metasploit::Framework::Tcp::Client (module)">Tcp::Client</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Tcp/Client.html#max_send_size-instance_method" title="Metasploit::Framework::Tcp::Client#max_send_size (method)">#max_send_size</a></span>, <span class='object_link'><a href="../Tcp/Client.html#send_delay-instance_method" title="Metasploit::Framework::Tcp::Client#send_delay (method)">#send_delay</a></span>, <span class='object_link'><a href="../Tcp/Client.html#sock-instance_method" title="Metasploit::Framework::Tcp::Client#sock (method)">#sock</a></span></p>
<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="#attempt_login-instance_method" title="#attempt_login (instance method)">#<strong>attempt_login</strong>(credential) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#set_sane_defaults-instance_method" title="#set_sane_defaults (instance method)">#<strong>set_sane_defaults</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../AFP/Client.html" title="Metasploit::Framework::AFP::Client (module)">AFP::Client</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../AFP/Client.html#close_session-instance_method" title="Metasploit::Framework::AFP::Client#close_session (method)">#close_session</a></span>, <span class='object_link'><a href="../AFP/Client.html#get_body-instance_method" title="Metasploit::Framework::AFP::Client#get_body (method)">#get_body</a></span>, <span class='object_link'><a href="../AFP/Client.html#get_info-instance_method" title="Metasploit::Framework::AFP::Client#get_info (method)">#get_info</a></span>, <span class='object_link'><a href="../AFP/Client.html#login-instance_method" title="Metasploit::Framework::AFP::Client#login (method)">#login</a></span>, <span class='object_link'><a href="../AFP/Client.html#next_id-instance_method" title="Metasploit::Framework::AFP::Client#next_id (method)">#next_id</a></span>, <span class='object_link'><a href="../AFP/Client.html#no_user_authent_login-instance_method" title="Metasploit::Framework::AFP::Client#no_user_authent_login (method)">#no_user_authent_login</a></span>, <span class='object_link'><a href="../AFP/Client.html#open_session-instance_method" title="Metasploit::Framework::AFP::Client#open_session (method)">#open_session</a></span>, <span class='object_link'><a href="../AFP/Client.html#parse_flags-instance_method" title="Metasploit::Framework::AFP::Client#parse_flags (method)">#parse_flags</a></span>, <span class='object_link'><a href="../AFP/Client.html#parse_header-instance_method" title="Metasploit::Framework::AFP::Client#parse_header (method)">#parse_header</a></span>, <span class='object_link'><a href="../AFP/Client.html#parse_info_response-instance_method" title="Metasploit::Framework::AFP::Client#parse_info_response (method)">#parse_info_response</a></span>, <span class='object_link'><a href="../AFP/Client.html#parse_login_response_add_send_login_count-instance_method" title="Metasploit::Framework::AFP::Client#parse_login_response_add_send_login_count (method)">#parse_login_response_add_send_login_count</a></span>, <span class='object_link'><a href="../AFP/Client.html#parse_network_addresses-instance_method" title="Metasploit::Framework::AFP::Client#parse_network_addresses (method)">#parse_network_addresses</a></span>, <span class='object_link'><a href="../AFP/Client.html#parse_open_session_response-instance_method" title="Metasploit::Framework::AFP::Client#parse_open_session_response (method)">#parse_open_session_response</a></span>, <span class='object_link'><a href="../AFP/Client.html#read_array-instance_method" title="Metasploit::Framework::AFP::Client#read_array (method)">#read_array</a></span>, <span class='object_link'><a href="../AFP/Client.html#read_pascal_string-instance_method" title="Metasploit::Framework::AFP::Client#read_pascal_string (method)">#read_pascal_string</a></span>, <span class='object_link'><a href="../AFP/Client.html#read_utf8_pascal_string-instance_method" title="Metasploit::Framework::AFP::Client#read_utf8_pascal_string (method)">#read_utf8_pascal_string</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Tcp/Client.html" title="Metasploit::Framework::Tcp::Client (module)">Tcp::Client</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Tcp/Client.html#chost-instance_method" title="Metasploit::Framework::Tcp::Client#chost (method)">#chost</a></span>, <span class='object_link'><a href="../Tcp/Client.html#connect-instance_method" title="Metasploit::Framework::Tcp::Client#connect (method)">#connect</a></span>, <span class='object_link'><a href="../Tcp/Client.html#cport-instance_method" title="Metasploit::Framework::Tcp::Client#cport (method)">#cport</a></span>, <span class='object_link'><a href="../Tcp/Client.html#disconnect-instance_method" title="Metasploit::Framework::Tcp::Client#disconnect (method)">#disconnect</a></span>, <span class='object_link'><a href="../Tcp/Client.html#proxies-instance_method" title="Metasploit::Framework::Tcp::Client#proxies (method)">#proxies</a></span>, <span class='object_link'><a href="../Tcp/Client.html#rhost-instance_method" title="Metasploit::Framework::Tcp::Client#rhost (method)">#rhost</a></span>, <span class='object_link'><a href="../Tcp/Client.html#rport-instance_method" title="Metasploit::Framework::Tcp::Client#rport (method)">#rport</a></span>, <span class='object_link'><a href="../Tcp/Client.html#set_tcp_evasions-instance_method" title="Metasploit::Framework::Tcp::Client#set_tcp_evasions (method)">#set_tcp_evasions</a></span>, <span class='object_link'><a href="../Tcp/Client.html#ssl-instance_method" title="Metasploit::Framework::Tcp::Client#ssl (method)">#ssl</a></span>, <span class='object_link'><a href="../Tcp/Client.html#ssl_version-instance_method" title="Metasploit::Framework::Tcp::Client#ssl_version (method)">#ssl_version</a></span></p>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="login_timeout=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="login_timeout-instance_method">
#<strong>login_timeout</strong> &#x21d2; <tt>Integer</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Number of seconds to wait before giving up</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>Number of seconds to wait before giving up</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/login_scanner/afp.rb', line 26</span>
<span class='kw'>def</span> <span class='id identifier rubyid_login_timeout'>login_timeout</span>
<span class='ivar'>@login_timeout</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="attempt_login-instance_method">
#<strong>attempt_login</strong>(credential) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/login_scanner/afp.rb', line 28</span>
<span class='kw'>def</span> <span class='id identifier rubyid_attempt_login'>attempt_login</span><span class='lparen'>(</span><span class='id identifier rubyid_credential'>credential</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='id identifier rubyid_connect'>connect</span>
<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="../../../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/ConnectionError.html" title="Rex::ConnectionError (class)">ConnectionError</a></span></span><span class='comma'>,</span> <span class='const'>EOFError</span><span class='comma'>,</span> <span class='const'>Timeout</span><span class='op'>::</span><span class='const'>Error</span>
<span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Login</span><span class='op'>::</span><span class='const'>Status</span><span class='op'>::</span><span class='const'>UNABLE_TO_CONNECT</span>
<span class='kw'>else</span>
<span class='kw'>begin</span>
<span class='id identifier rubyid_success'>success</span> <span class='op'>=</span> <span class='id identifier rubyid_login'>login</span><span class='lparen'>(</span><span class='id identifier rubyid_credential'>credential</span><span class='period'>.</span><span class='id identifier rubyid_public'>public</span><span class='comma'>,</span> <span class='id identifier rubyid_credential'>credential</span><span class='period'>.</span><span class='id identifier rubyid_private'>private</span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='const'>RuntimeError</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='kw'>return</span> <span class='lbrace'>{</span><span class='symbol'>:status</span> <span class='op'>=&gt;</span> <span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Login</span><span class='op'>::</span><span class='const'>Status</span><span class='op'>::</span><span class='const'>UNABLE_TO_CONNECT</span><span class='comma'>,</span> <span class='symbol'>:proof</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_success'>success</span> <span class='op'>==</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Login</span><span class='op'>::</span><span class='const'>Status</span><span class='op'>::</span><span class='const'>SUCCESSFUL</span> <span class='op'>:</span> <span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Login</span><span class='op'>::</span><span class='const'>Status</span><span class='op'>::</span><span class='const'>INCORRECT</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Result.html" title="Metasploit::Framework::LoginScanner::Result (class)">Result</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Result.html#initialize-instance_method" title="Metasploit::Framework::LoginScanner::Result#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>credential:</span> <span class='id identifier rubyid_credential'>credential</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span>
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span> <span class='op'>=</span> <span class='id identifier rubyid_host'>host</span>
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_port'>port</span> <span class='op'>=</span> <span class='id identifier rubyid_port'>port</span>
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_protocol'>protocol</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tcp</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_service_name'>service_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>afp</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_result'>result</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="set_sane_defaults-instance_method">
#<strong>set_sane_defaults</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
51
52
53
54
55
56</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/login_scanner/afp.rb', line 51</span>
<span class='kw'>def</span> <span class='id identifier rubyid_set_sane_defaults'>set_sane_defaults</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_connection_timeout'>connection_timeout</span> <span class='op'>||=</span> <span class='int'>30</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_port'>port</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="#DEFAULT_PORT-constant" title="Metasploit::Framework::LoginScanner::AFP::DEFAULT_PORT (constant)">DEFAULT_PORT</a></span></span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_max_send_size'>max_send_size</span> <span class='op'>||=</span> <span class='int'>0</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_send_delay'>send_delay</span> <span class='op'>||=</span> <span class='int'>0</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:39:00 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

523
api/Metasploit/Framework/LoginScanner/AdvantechWebAccess.html Normal file
View File

File diff suppressed because one or more lines are too long

491
api/Metasploit/Framework/LoginScanner/Axis2.html Normal file
View File

File diff suppressed because one or more lines are too long

135
api/Metasploit/Framework/LoginScanner/Base.html Normal file
View File

@ -0,0 +1,135 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Metasploit::Framework::LoginScanner::Base
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::LoginScanner::Base";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (B)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../LoginScanner.html" title="Metasploit::Framework::LoginScanner (module)">LoginScanner</a></span></span>
&raquo;
<span class="title">Base</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Metasploit::Framework::LoginScanner::Base
</h1>
<div class="box_info">
<dl>
<dt>Extended by:</dt>
<dd>ActiveSupport::Concern</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd>ActiveModel::Validations</dd>
</dl>
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="ACPP.html" title="Metasploit::Framework::LoginScanner::ACPP (class)">ACPP</a></span>, <span class='object_link'><a href="AFP.html" title="Metasploit::Framework::LoginScanner::AFP (class)">AFP</a></span>, <span class='object_link'><a href="DB2.html" title="Metasploit::Framework::LoginScanner::DB2 (class)">DB2</a></span>, <span class='object_link'><a href="FTP.html" title="Metasploit::Framework::LoginScanner::FTP (class)">FTP</a></span>, <span class='object_link'><a href="HTTP.html" title="Metasploit::Framework::LoginScanner::HTTP (class)">HTTP</a></span>, <span class='object_link'><a href="MQTT.html" title="Metasploit::Framework::LoginScanner::MQTT (class)">MQTT</a></span>, <span class='object_link'><a href="MSSQL.html" title="Metasploit::Framework::LoginScanner::MSSQL (class)">MSSQL</a></span>, <span class='object_link'><a href="MySQL.html" title="Metasploit::Framework::LoginScanner::MySQL (class)">MySQL</a></span>, <span class='object_link'><a href="POP3.html" title="Metasploit::Framework::LoginScanner::POP3 (class)">POP3</a></span>, <span class='object_link'><a href="Postgres.html" title="Metasploit::Framework::LoginScanner::Postgres (class)">Postgres</a></span>, <span class='object_link'><a href="Redis.html" title="Metasploit::Framework::LoginScanner::Redis (class)">Redis</a></span>, <span class='object_link'><a href="SMB.html" title="Metasploit::Framework::LoginScanner::SMB (class)">SMB</a></span>, <span class='object_link'><a href="SNMP.html" title="Metasploit::Framework::LoginScanner::SNMP (class)">SNMP</a></span>, <span class='object_link'><a href="SSH.html" title="Metasploit::Framework::LoginScanner::SSH (class)">SSH</a></span>, <span class='object_link'><a href="Telnet.html" title="Metasploit::Framework::LoginScanner::Telnet (class)">Telnet</a></span>, <span class='object_link'><a href="VMAUTHD.html" title="Metasploit::Framework::LoginScanner::VMAUTHD (class)">VMAUTHD</a></span>, <span class='object_link'><a href="VNC.html" title="Metasploit::Framework::LoginScanner::VNC (class)">VNC</a></span>, <span class='object_link'><a href="VarnishCLI.html" title="Metasploit::Framework::LoginScanner::VarnishCLI (class)">VarnishCLI</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/login_scanner/base.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This module provides the base behaviour for all of the LoginScanner
classes. All of the LoginScanners should include this module to establish
base behaviour</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:36:46 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

689
api/Metasploit/Framework/LoginScanner/BavisionCameras.html Normal file
View File

File diff suppressed because one or more lines are too long

124
api/Metasploit/Framework/LoginScanner/BavisionCamerasException.html Normal file
View File

@ -0,0 +1,124 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Exception: Metasploit::Framework::LoginScanner::BavisionCamerasException
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::LoginScanner::BavisionCamerasException";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (B)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../LoginScanner.html" title="Metasploit::Framework::LoginScanner (module)">LoginScanner</a></span></span>
&raquo;
<span class="title">BavisionCamerasException</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Exception: Metasploit::Framework::LoginScanner::BavisionCamerasException
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">StandardError</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">StandardError</li>
<li class="next">Metasploit::Framework::LoginScanner::BavisionCamerasException</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/login_scanner/bavision_cameras.rb</dd>
</dl>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:39:21 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

407
api/Metasploit/Framework/LoginScanner/Buffalo.html Normal file
View File

File diff suppressed because one or more lines are too long

712
api/Metasploit/Framework/LoginScanner/Caidao.html Normal file
View File

File diff suppressed because one or more lines are too long

1003
api/Metasploit/Framework/LoginScanner/ChefWebUI.html Normal file
View File

File diff suppressed because one or more lines are too long

513
api/Metasploit/Framework/LoginScanner/CiscoFirepower.html Normal file
View File

File diff suppressed because one or more lines are too long

370
api/Metasploit/Framework/LoginScanner/DB2.html Normal file
View File

@ -0,0 +1,370 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::LoginScanner::DB2
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::LoginScanner::DB2";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (D)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../LoginScanner.html" title="Metasploit::Framework::LoginScanner (module)">LoginScanner</a></span></span>
&raquo;
<span class="title">DB2</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::LoginScanner::DB2
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Metasploit::Framework::LoginScanner::DB2</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="Base.html" title="Metasploit::Framework::LoginScanner::Base (module)">Base</a></span>, <span class='object_link'><a href="RexSocket.html" title="Metasploit::Framework::LoginScanner::RexSocket (module)">RexSocket</a></span>, <span class='object_link'><a href="../Tcp/Client.html" title="Metasploit::Framework::Tcp::Client (module)">Tcp::Client</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/login_scanner/db2.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This is the LoginScanner class for dealing with DB2 Database servers. It is
responsible for taking a single target, and a list of credentials and
attempting them. It then saves the results.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="DEFAULT_PORT-constant" class="">DEFAULT_PORT =
</dt>
<dd><pre class="code"><span class='int'>50000</span></pre></dd>
<dt id="DEFAULT_REALM-constant" class="">DEFAULT_REALM =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>toolsdb</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="LIKELY_PORTS-constant" class="">LIKELY_PORTS =
</dt>
<dd><pre class="code"><span class='lbracket'>[</span> <span class='const'><span class='object_link'><a href="#DEFAULT_PORT-constant" title="Metasploit::Framework::LoginScanner::DB2::DEFAULT_PORT (constant)">DEFAULT_PORT</a></span></span> <span class='rbracket'>]</span></pre></dd>
<dt id="LIKELY_SERVICE_NAMES-constant" class="">LIKELY_SERVICE_NAMES =
<div class="docstring">
<div class="discussion">
<div class="note todo">
<strong>TODO:</strong>
<div class='inline'>
<p>XXX</p>
</div>
</div>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbracket'>[</span> <span class='rbracket'>]</span></pre></dd>
<dt id="PRIVATE_TYPES-constant" class="">PRIVATE_TYPES =
</dt>
<dd><pre class="code"><span class='lbracket'>[</span> <span class='symbol'>:password</span> <span class='rbracket'>]</span></pre></dd>
<dt id="REALM_KEY-constant" class="">REALM_KEY =
</dt>
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Realm</span><span class='op'>::</span><span class='const'>Key</span><span class='op'>::</span><span class='const'>DB2_DATABASE</span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes included from <span class='object_link'><a href="../Tcp/Client.html" title="Metasploit::Framework::Tcp::Client (module)">Tcp::Client</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Tcp/Client.html#max_send_size-instance_method" title="Metasploit::Framework::Tcp::Client#max_send_size (method)">#max_send_size</a></span>, <span class='object_link'><a href="../Tcp/Client.html#send_delay-instance_method" title="Metasploit::Framework::Tcp::Client#send_delay (method)">#send_delay</a></span>, <span class='object_link'><a href="../Tcp/Client.html#sock-instance_method" title="Metasploit::Framework::Tcp::Client#sock (method)">#sock</a></span></p>
<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="#attempt_login-instance_method" title="#attempt_login (instance method)">#<strong>attempt_login</strong>(credential) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Tcp/Client.html" title="Metasploit::Framework::Tcp::Client (module)">Tcp::Client</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Tcp/Client.html#chost-instance_method" title="Metasploit::Framework::Tcp::Client#chost (method)">#chost</a></span>, <span class='object_link'><a href="../Tcp/Client.html#connect-instance_method" title="Metasploit::Framework::Tcp::Client#connect (method)">#connect</a></span>, <span class='object_link'><a href="../Tcp/Client.html#cport-instance_method" title="Metasploit::Framework::Tcp::Client#cport (method)">#cport</a></span>, <span class='object_link'><a href="../Tcp/Client.html#disconnect-instance_method" title="Metasploit::Framework::Tcp::Client#disconnect (method)">#disconnect</a></span>, <span class='object_link'><a href="../Tcp/Client.html#proxies-instance_method" title="Metasploit::Framework::Tcp::Client#proxies (method)">#proxies</a></span>, <span class='object_link'><a href="../Tcp/Client.html#rhost-instance_method" title="Metasploit::Framework::Tcp::Client#rhost (method)">#rhost</a></span>, <span class='object_link'><a href="../Tcp/Client.html#rport-instance_method" title="Metasploit::Framework::Tcp::Client#rport (method)">#rport</a></span>, <span class='object_link'><a href="../Tcp/Client.html#set_tcp_evasions-instance_method" title="Metasploit::Framework::Tcp::Client#set_tcp_evasions (method)">#set_tcp_evasions</a></span>, <span class='object_link'><a href="../Tcp/Client.html#ssl-instance_method" title="Metasploit::Framework::Tcp::Client#ssl (method)">#ssl</a></span>, <span class='object_link'><a href="../Tcp/Client.html#ssl_version-instance_method" title="Metasploit::Framework::Tcp::Client#ssl_version (method)">#ssl_version</a></span></p>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="attempt_login-instance_method">
#<strong>attempt_login</strong>(credential) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li>Base#attempt_login</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/login_scanner/db2.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_attempt_login'>attempt_login</span><span class='lparen'>(</span><span class='id identifier rubyid_credential'>credential</span><span class='rparen'>)</span>
<span class='id identifier rubyid_result_options'>result_options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>credential:</span> <span class='id identifier rubyid_credential'>credential</span>
<span class='rbrace'>}</span>
<span class='kw'>begin</span>
<span class='id identifier rubyid_probe_data'>probe_data</span> <span class='op'>=</span> <span class='id identifier rubyid_send_probe'>send_probe</span><span class='lparen'>(</span><span class='id identifier rubyid_credential'>credential</span><span class='period'>.</span><span class='id identifier rubyid_realm'>realm</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_probe_data'>probe_data</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='id identifier rubyid_result_options'>result_options</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Login</span><span class='op'>::</span><span class='const'>Status</span><span class='op'>::</span><span class='const'>UNABLE_TO_CONNECT</span>
<span class='kw'>else</span>
<span class='kw'>if</span> <span class='id identifier rubyid_authenticate?'>authenticate?</span><span class='lparen'>(</span><span class='id identifier rubyid_credential'>credential</span><span class='rparen'>)</span>
<span class='id identifier rubyid_result_options'>result_options</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Login</span><span class='op'>::</span><span class='const'>Status</span><span class='op'>::</span><span class='const'>SUCCESSFUL</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_result_options'>result_options</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Login</span><span class='op'>::</span><span class='const'>Status</span><span class='op'>::</span><span class='const'>INCORRECT</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/ConnectionError.html" title="Rex::ConnectionError (class)">ConnectionError</a></span></span><span class='comma'>,</span> <span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto.html" title="Rex::Proto (module)">Proto</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/DRDA.html" title="Rex::Proto::DRDA (module)">DRDA</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/DRDA/RespError.html" title="Rex::Proto::DRDA::RespError (class)">RespError</a></span></span><span class='comma'>,</span> <span class='op'>::</span><span class='const'>Timeout</span><span class='op'>::</span><span class='const'>Error</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='id identifier rubyid_result_options'>result_options</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='lbrace'>{</span>
<span class='label'>status:</span> <span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Login</span><span class='op'>::</span><span class='const'>Status</span><span class='op'>::</span><span class='const'>UNABLE_TO_CONNECT</span><span class='comma'>,</span>
<span class='label'>proof:</span> <span class='id identifier rubyid_e'>e</span><span class='comma'>,</span>
<span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../LoginScanner.html" title="Metasploit::Framework::LoginScanner (module)">LoginScanner</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Result.html" title="Metasploit::Framework::LoginScanner::Result (class)">Result</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Result.html#initialize-instance_method" title="Metasploit::Framework::LoginScanner::Result#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_result_options'>result_options</span><span class='rparen'>)</span>
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span> <span class='op'>=</span> <span class='id identifier rubyid_host'>host</span>
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_port'>port</span> <span class='op'>=</span> <span class='id identifier rubyid_port'>port</span>
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_protocol'>protocol</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tcp</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_service_name'>service_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>db2</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_result'>result</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:39:00 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

724
api/Metasploit/Framework/LoginScanner/DirectAdmin.html Normal file
View File

File diff suppressed because one or more lines are too long

437
api/Metasploit/Framework/LoginScanner/FTP.html Normal file
View File

@ -0,0 +1,437 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::LoginScanner::FTP
&mdash; Documentation by YARD 0.9.19
</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">
pathId = "Metasploit::Framework::LoginScanner::FTP";
relpath = '../../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (F)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../LoginScanner.html" title="Metasploit::Framework::LoginScanner (module)">LoginScanner</a></span></span>
&raquo;
<span class="title">FTP</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::LoginScanner::FTP
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Metasploit::Framework::LoginScanner::FTP</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="../Ftp/Client.html" title="Metasploit::Framework::Ftp::Client (module)">Ftp::Client</a></span>, <span class='object_link'><a href="Base.html" title="Metasploit::Framework::LoginScanner::Base (module)">Base</a></span>, <span class='object_link'><a href="RexSocket.html" title="Metasploit::Framework::LoginScanner::RexSocket (module)">RexSocket</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/login_scanner/ftp.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This is the LoginScanner class for dealing with FTP. It is responsible for
taking a single target, and a list of credentials and attempting them. It
then saves the results.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="DEFAULT_PORT-constant" class="">DEFAULT_PORT =
</dt>
<dd><pre class="code"><span class='int'>21</span></pre></dd>
<dt id="LIKELY_PORTS-constant" class="">LIKELY_PORTS =
</dt>
<dd><pre class="code"><span class='lbracket'>[</span> <span class='const'><span class='object_link'><a href="#DEFAULT_PORT-constant" title="Metasploit::Framework::LoginScanner::FTP::DEFAULT_PORT (constant)">DEFAULT_PORT</a></span></span><span class='comma'>,</span> <span class='int'>2121</span> <span class='rbracket'>]</span></pre></dd>
<dt id="LIKELY_SERVICE_NAMES-constant" class="">LIKELY_SERVICE_NAMES =
</dt>
<dd><pre class="code"><span class='lbracket'>[</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ftp</span><span class='tstring_end'>&#39;</span></span> <span class='rbracket'>]</span></pre></dd>
<dt id="PRIVATE_TYPES-constant" class="">PRIVATE_TYPES =
</dt>
<dd><pre class="code"><span class='lbracket'>[</span> <span class='symbol'>:password</span> <span class='rbracket'>]</span></pre></dd>
<dt id="REALM_KEY-constant" class="">REALM_KEY =
</dt>
<dd><pre class="code"><span class='kw'>nil</span></pre></dd>
</dl>
<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="#ftp_timeout-instance_method" title="#ftp_timeout (instance method)">#<strong>ftp_timeout</strong> &#x21d2; Integer </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The timeout in seconds to wait for a response to an FTP command.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes included from <span class='object_link'><a href="../Ftp/Client.html" title="Metasploit::Framework::Ftp::Client (module)">Ftp::Client</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Ftp/Client.html#banner-instance_method" title="Metasploit::Framework::Ftp::Client#banner (method)">#banner</a></span>, <span class='object_link'><a href="../Ftp/Client.html#datasocket-instance_method" title="Metasploit::Framework::Ftp::Client#datasocket (method)">#datasocket</a></span></p>
<h3 class="inherited">Attributes included from <span class='object_link'><a href="../Tcp/Client.html" title="Metasploit::Framework::Tcp::Client (module)">Tcp::Client</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Tcp/Client.html#max_send_size-instance_method" title="Metasploit::Framework::Tcp::Client#max_send_size (method)">#max_send_size</a></span>, <span class='object_link'><a href="../Tcp/Client.html#send_delay-instance_method" title="Metasploit::Framework::Tcp::Client#send_delay (method)">#send_delay</a></span>, <span class='object_link'><a href="../Tcp/Client.html#sock-instance_method" title="Metasploit::Framework::Tcp::Client#sock (method)">#sock</a></span></p>
<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="#attempt_login-instance_method" title="#attempt_login (instance method)">#<strong>attempt_login</strong>(credential) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Ftp/Client.html" title="Metasploit::Framework::Ftp::Client (module)">Ftp::Client</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Ftp/Client.html#connect-instance_method" title="Metasploit::Framework::Ftp::Client#connect (method)">#connect</a></span>, <span class='object_link'><a href="../Ftp/Client.html#connect_login-instance_method" title="Metasploit::Framework::Ftp::Client#connect_login (method)">#connect_login</a></span>, <span class='object_link'><a href="../Ftp/Client.html#data_connect-instance_method" title="Metasploit::Framework::Ftp::Client#data_connect (method)">#data_connect</a></span>, <span class='object_link'><a href="../Ftp/Client.html#data_disconnect-instance_method" title="Metasploit::Framework::Ftp::Client#data_disconnect (method)">#data_disconnect</a></span>, <span class='object_link'><a href="../Ftp/Client.html#raw_send-instance_method" title="Metasploit::Framework::Ftp::Client#raw_send (method)">#raw_send</a></span>, <span class='object_link'><a href="../Ftp/Client.html#raw_send_recv-instance_method" title="Metasploit::Framework::Ftp::Client#raw_send_recv (method)">#raw_send_recv</a></span>, <span class='object_link'><a href="../Ftp/Client.html#recv_ftp_resp-instance_method" title="Metasploit::Framework::Ftp::Client#recv_ftp_resp (method)">#recv_ftp_resp</a></span>, <span class='object_link'><a href="../Ftp/Client.html#send_cmd-instance_method" title="Metasploit::Framework::Ftp::Client#send_cmd (method)">#send_cmd</a></span>, <span class='object_link'><a href="../Ftp/Client.html#send_cmd_data-instance_method" title="Metasploit::Framework::Ftp::Client#send_cmd_data (method)">#send_cmd_data</a></span>, <span class='object_link'><a href="../Ftp/Client.html#send_pass-instance_method" title="Metasploit::Framework::Ftp::Client#send_pass (method)">#send_pass</a></span>, <span class='object_link'><a href="../Ftp/Client.html#send_quit-instance_method" title="Metasploit::Framework::Ftp::Client#send_quit (method)">#send_quit</a></span>, <span class='object_link'><a href="../Ftp/Client.html#send_user-instance_method" title="Metasploit::Framework::Ftp::Client#send_user (method)">#send_user</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Tcp/Client.html" title="Metasploit::Framework::Tcp::Client (module)">Tcp::Client</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Tcp/Client.html#chost-instance_method" title="Metasploit::Framework::Tcp::Client#chost (method)">#chost</a></span>, <span class='object_link'><a href="../Tcp/Client.html#connect-instance_method" title="Metasploit::Framework::Tcp::Client#connect (method)">#connect</a></span>, <span class='object_link'><a href="../Tcp/Client.html#cport-instance_method" title="Metasploit::Framework::Tcp::Client#cport (method)">#cport</a></span>, <span class='object_link'><a href="../Tcp/Client.html#disconnect-instance_method" title="Metasploit::Framework::Tcp::Client#disconnect (method)">#disconnect</a></span>, <span class='object_link'><a href="../Tcp/Client.html#proxies-instance_method" title="Metasploit::Framework::Tcp::Client#proxies (method)">#proxies</a></span>, <span class='object_link'><a href="../Tcp/Client.html#rhost-instance_method" title="Metasploit::Framework::Tcp::Client#rhost (method)">#rhost</a></span>, <span class='object_link'><a href="../Tcp/Client.html#rport-instance_method" title="Metasploit::Framework::Tcp::Client#rport (method)">#rport</a></span>, <span class='object_link'><a href="../Tcp/Client.html#set_tcp_evasions-instance_method" title="Metasploit::Framework::Tcp::Client#set_tcp_evasions (method)">#set_tcp_evasions</a></span>, <span class='object_link'><a href="../Tcp/Client.html#ssl-instance_method" title="Metasploit::Framework::Tcp::Client#ssl (method)">#ssl</a></span>, <span class='object_link'><a href="../Tcp/Client.html#ssl_version-instance_method" title="Metasploit::Framework::Tcp::Client#ssl_version (method)">#ssl_version</a></span></p>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="ftp_timeout=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="ftp_timeout-instance_method">
#<strong>ftp_timeout</strong> &#x21d2; <tt>Integer</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The timeout in seconds to wait for a response to an FTP command</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>The timeout in seconds to wait for a response to an FTP command</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/login_scanner/ftp.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ftp_timeout'>ftp_timeout</span>
<span class='ivar'>@ftp_timeout</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="attempt_login-instance_method">
#<strong>attempt_login</strong>(credential) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/login_scanner/ftp.rb', line 37</span>
<span class='kw'>def</span> <span class='id identifier rubyid_attempt_login'>attempt_login</span><span class='lparen'>(</span><span class='id identifier rubyid_credential'>credential</span><span class='rparen'>)</span>
<span class='id identifier rubyid_result_options'>result_options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>credential:</span> <span class='id identifier rubyid_credential'>credential</span>
<span class='rbrace'>}</span>
<span class='kw'>begin</span>
<span class='id identifier rubyid_success'>success</span> <span class='op'>=</span> <span class='id identifier rubyid_connect_login'>connect_login</span><span class='lparen'>(</span><span class='id identifier rubyid_credential'>credential</span><span class='period'>.</span><span class='id identifier rubyid_public'>public</span><span class='comma'>,</span> <span class='id identifier rubyid_credential'>credential</span><span class='period'>.</span><span class='id identifier rubyid_private'>private</span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='op'>::</span><span class='const'>EOFError</span><span class='comma'>,</span> <span class='const'>Errno</span><span class='op'>::</span><span class='const'>ECONNRESET</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../../../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/ConnectionError.html" title="Rex::ConnectionError (class)">ConnectionError</a></span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../../../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/ConnectionTimeout.html" title="Rex::ConnectionTimeout (class)">ConnectionTimeout</a></span></span><span class='comma'>,</span> <span class='op'>::</span><span class='const'>Timeout</span><span class='op'>::</span><span class='const'>Error</span>
<span class='id identifier rubyid_result_options'>result_options</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Login</span><span class='op'>::</span><span class='const'>Status</span><span class='op'>::</span><span class='const'>UNABLE_TO_CONNECT</span>
<span class='id identifier rubyid_success'>success</span> <span class='op'>=</span> <span class='kw'>false</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_success'>success</span>
<span class='id identifier rubyid_result_options'>result_options</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Login</span><span class='op'>::</span><span class='const'>Status</span><span class='op'>::</span><span class='const'>SUCCESSFUL</span>
<span class='kw'>elsif</span> <span class='op'>!</span><span class='lparen'>(</span><span class='id identifier rubyid_result_options'>result_options</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span> <span class='symbol'>:status</span><span class='rparen'>)</span>
<span class='id identifier rubyid_result_options'>result_options</span><span class='lbracket'>[</span><span class='symbol'>:status</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Login</span><span class='op'>::</span><span class='const'>Status</span><span class='op'>::</span><span class='const'>INCORRECT</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../LoginScanner.html" title="Metasploit::Framework::LoginScanner (module)">LoginScanner</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Result.html" title="Metasploit::Framework::LoginScanner::Result (class)">Result</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Result.html#initialize-instance_method" title="Metasploit::Framework::LoginScanner::Result#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_result_options'>result_options</span><span class='rparen'>)</span>
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span> <span class='op'>=</span> <span class='id identifier rubyid_host'>host</span>
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_port'>port</span> <span class='op'>=</span> <span class='id identifier rubyid_port'>port</span>
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_protocol'>protocol</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tcp</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_service_name'>service_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ftp</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_result'>result</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Apr 23 22:39:00 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.19 (ruby-2.3.3).
</div>
</div>
</body>
</html>

485
api/Metasploit/Framework/LoginScanner/GitLab.html Normal file
View File

File diff suppressed because one or more lines are too long

1646
api/Metasploit/Framework/LoginScanner/Glassfish.html Normal file
View File

File diff suppressed because one or more lines are too long

Some files were not shown because too many files have changed in this diff Show More