jenkins-metasploit
1304 lines
45 KiB
HTML
1304 lines
45 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>
|
|
Class: Msf::RPC::RPC_Console
|
|
|
|
— Documentation by YARD 0.9.37
|
|
|
|
</title>
|
|
|
|
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
|
|
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
|
|
<script type="text/javascript">
|
|
pathId = "Msf::RPC::RPC_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 (R)</a> »
|
|
<span class='title'><span class='object_link'><a href="../../Msf.html" title="Msf (module)">Msf</a></span></span> » <span class='title'><span class='object_link'><a href="../RPC.html" title="Msf::RPC (module)">RPC</a></span></span>
|
|
»
|
|
<span class="title">RPC_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: Msf::RPC::RPC_Console
|
|
|
|
|
|
|
|
</h1>
|
|
<div class="box_info">
|
|
|
|
<dl>
|
|
<dt>Inherits:</dt>
|
|
<dd>
|
|
<span class="inheritName"><span class='object_link'><a href="RPC_Base.html" title="Msf::RPC::RPC_Base (class)">RPC_Base</a></span></span>
|
|
|
|
<ul class="fullTree">
|
|
<li>Object</li>
|
|
|
|
<li class="next"><span class='object_link'><a href="RPC_Base.html" title="Msf::RPC::RPC_Base (class)">RPC_Base</a></span></li>
|
|
|
|
<li class="next">Msf::RPC::RPC_Console</li>
|
|
|
|
</ul>
|
|
<a href="#" class="inheritanceTree">show all</a>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
<dt>Defined in:</dt>
|
|
<dd>lib/msf/core/rpc/v10/rpc_console.rb</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Instance Attribute Summary</h2>
|
|
|
|
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="RPC_Base.html" title="Msf::RPC::RPC_Base (class)">RPC_Base</a></span></h3>
|
|
<p class="inherited"><span class='object_link'><a href="RPC_Base.html#framework-instance_method" title="Msf::RPC::RPC_Base#framework (method)">#framework</a></span>, <span class='object_link'><a href="RPC_Base.html#job_status_tracker-instance_method" title="Msf::RPC::RPC_Base#job_status_tracker (method)">#job_status_tracker</a></span>, <span class='object_link'><a href="RPC_Base.html#service-instance_method" title="Msf::RPC::RPC_Base#service (method)">#service</a></span>, <span class='object_link'><a href="RPC_Base.html#tokens-instance_method" title="Msf::RPC::RPC_Base#tokens (method)">#tokens</a></span>, <span class='object_link'><a href="RPC_Base.html#users-instance_method" title="Msf::RPC::RPC_Base#users (method)">#users</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>(*args) ⇒ Msf::Ui::Web::Driver </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
<span class="note title constructor">constructor</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Initializes the RPC console.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#rpc_create-instance_method" title="#rpc_create (instance method)">#<strong>rpc_create</strong>(opts = {}) ⇒ Hash </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Creates a new framework console instance.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#rpc_destroy-instance_method" title="#rpc_destroy (instance method)">#<strong>rpc_destroy</strong>(cid) ⇒ Hash </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Deletes a framework console instance.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#rpc_list-instance_method" title="#rpc_list (instance method)">#<strong>rpc_list</strong> ⇒ Hash </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Returns a list of framework consoles.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#rpc_read-instance_method" title="#rpc_read (instance method)">#<strong>rpc_read</strong>(cid) ⇒ Hash </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Returns the framework console output in raw form.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#rpc_session_detach-instance_method" title="#rpc_session_detach (instance method)">#<strong>rpc_session_detach</strong>(cid) ⇒ Hash </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Detaches a framework session.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#rpc_session_kill-instance_method" title="#rpc_session_kill (instance method)">#<strong>rpc_session_kill</strong>(cid) ⇒ Hash </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Kills a framework session.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#rpc_tabs-instance_method" title="#rpc_tabs (instance method)">#<strong>rpc_tabs</strong>(cid, line) ⇒ Hash </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Returns the tab-completed version of your input (such as a module path).</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#rpc_write-instance_method" title="#rpc_write (instance method)">#<strong>rpc_write</strong>(cid, data) ⇒ Hash </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Sends an input (such as a command) to the framework console.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="RPC_Base.html" title="Msf::RPC::RPC_Base (class)">RPC_Base</a></span></h3>
|
|
<p class="inherited"><span class='object_link'><a href="RPC_Base.html#error-instance_method" title="Msf::RPC::RPC_Base#error (method)">#error</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>(*args) ⇒ <tt><span class='object_link'><a href="../Ui/Web/Driver.html" title="Msf::Ui::Web::Driver (class)">Msf::Ui::Web::Driver</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Initializes the RPC console</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
12
|
|
13
|
|
14
|
|
15</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/msf/core/rpc/v10/rpc_console.rb', line 12</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</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='ivar'>@console_driver</span> <span class='op'>=</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="../Ui.html" title="Msf::Ui (module)">Ui</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Ui/Web.html" title="Msf::Ui::Web (module)">Web</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Ui/Web/Driver.html" title="Msf::Ui::Web::Driver (class)">Driver</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Ui/Web/Driver.html#initialize-instance_method" title="Msf::Ui::Web::Driver#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='symbol'>:framework</span> <span class='op'>=></span> <span class='id identifier rubyid_framework'>framework</span><span class='rparen'>)</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div id="instance_method_details" class="method_details_list">
|
|
<h2>Instance Method Details</h2>
|
|
|
|
|
|
<div class="method_details first">
|
|
<h3 class="signature first" id="rpc_create-instance_method">
|
|
|
|
#<strong>rpc_create</strong>(opts = {}) ⇒ <tt>Hash</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Creates a new framework console instance.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<div class="examples">
|
|
<h4 class="tag_title">Examples:</h4>
|
|
|
|
|
|
<h5 class="example_title"><div class='inline'>
|
|
<p>Here's how you would use this from the client:</p>
|
|
</div></h5>
|
|
|
|
<pre class="example code"><code><span class='id identifier rubyid_rpc'>rpc</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>console.create</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span></code></pre>
|
|
|
|
</div>
|
|
<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>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>See Msf::Ui::Web::Driver#create_console</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Information about the new console. It contains the following keys:</p>
|
|
<ul><li>
|
|
<p>'id' [Integer] The console's ID.</p>
|
|
</li><li>
|
|
<p>'prompt' [String] The framework prompt (example: 'msf > ')</p>
|
|
</li><li>
|
|
<p>'busy' [TrueClass] The console's busy state, or</p>
|
|
</li><li>
|
|
<p>'busy' [FalseClass] The console's busy state.</p>
|
|
</li></ul>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
27
|
|
28
|
|
29
|
|
30
|
|
31
|
|
32
|
|
33
|
|
34</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/msf/core/rpc/v10/rpc_console.rb', line 27</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_rpc_create'>rpc_create</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_cid'>cid</span> <span class='op'>=</span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_create_console'>create_console</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
|
|
<span class='lbrace'>{</span>
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_cid'>cid</span><span class='comma'>,</span>
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>prompt</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_consoles'>consoles</span><span class='lbracket'>[</span><span class='id identifier rubyid_cid'>cid</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_prompt'>prompt</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>busy</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_consoles'>consoles</span><span class='lbracket'>[</span><span class='id identifier rubyid_cid'>cid</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_busy'>busy</span> <span class='op'>||</span> <span class='kw'>false</span>
|
|
<span class='rbrace'>}</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="rpc_destroy-instance_method">
|
|
|
|
#<strong>rpc_destroy</strong>(cid) ⇒ <tt>Hash</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Deletes a framework console instance.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<div class="examples">
|
|
<h4 class="tag_title">Examples:</h4>
|
|
|
|
|
|
<h5 class="example_title"><div class='inline'>
|
|
<p>Here's how you would use this from the client:</p>
|
|
</div></h5>
|
|
|
|
<pre class="example code"><code><span class='id identifier rubyid_rpc'>rpc</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>console.destroy</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>1</span><span class='rparen'>)</span></code></pre>
|
|
|
|
</div>
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>cid</span>
|
|
|
|
|
|
<span class='type'>(<tt>Integer</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Framework console ID.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>A result indicating whether the action was successful or not. It contains the following key:</p>
|
|
<ul><li>
|
|
<p>'result' [String] Either 'success' or 'failure'.</p>
|
|
</li></ul>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
68
|
|
69
|
|
70
|
|
71
|
|
72
|
|
73</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/msf/core/rpc/v10/rpc_console.rb', line 68</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_rpc_destroy'>rpc_destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_cid'>cid</span><span class='rparen'>)</span>
|
|
<span class='id identifier rubyid_cid'>cid</span> <span class='op'>=</span> <span class='id identifier rubyid_cid'>cid</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
<span class='kw'>return</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>result</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>failure</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span> <span class='kw'>if</span> <span class='kw'>not</span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_consoles'>consoles</span><span class='lbracket'>[</span><span class='id identifier rubyid_cid'>cid</span><span class='rbracket'>]</span>
|
|
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_destroy_console'>destroy_console</span><span class='lparen'>(</span><span class='id identifier rubyid_cid'>cid</span><span class='rparen'>)</span>
|
|
<span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>result</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_res'>res</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>success</span><span class='tstring_end'>'</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>failure</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="rpc_list-instance_method">
|
|
|
|
#<strong>rpc_list</strong> ⇒ <tt>Hash</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Returns a list of framework consoles.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<div class="examples">
|
|
<h4 class="tag_title">Examples:</h4>
|
|
|
|
|
|
<h5 class="example_title"><div class='inline'>
|
|
<p>Here's how you would use this from the client:</p>
|
|
</div></h5>
|
|
|
|
<pre class="example code"><code><span class='id identifier rubyid_rpc'>rpc</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>console.list</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span></code></pre>
|
|
|
|
</div>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Console information.</p>
|
|
<ul><li>
|
|
<p>'consoles' [Array<Hash>] consoles, each element is a hash that includes:</p>
|
|
<ul><li>
|
|
<p>'id' [Integer] The console's ID</p>
|
|
</li><li>
|
|
<p>'prompt' [String] The framework prompt (example: 'msf > ')</p>
|
|
</li><li>
|
|
<p>'busy' [TrueClass] The console's busy state, or</p>
|
|
</li><li>
|
|
<p>'busy' [FalseClass] The console's busy state.</p>
|
|
</li></ul>
|
|
</li></ul>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
47
|
|
48
|
|
49
|
|
50
|
|
51
|
|
52
|
|
53
|
|
54
|
|
55
|
|
56
|
|
57</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/msf/core/rpc/v10/rpc_console.rb', line 47</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_rpc_list'>rpc_list</span>
|
|
<span class='id identifier rubyid_ret'>ret</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
<span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_consoles'>consoles</span><span class='period'>.</span><span class='id identifier rubyid_each_key'>each_key</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_cid'>cid</span><span class='op'>|</span>
|
|
<span class='id identifier rubyid_ret'>ret</span> <span class='op'><<</span> <span class='lbrace'>{</span>
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_cid'>cid</span><span class='comma'>,</span>
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>prompt</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_consoles'>consoles</span><span class='lbracket'>[</span><span class='id identifier rubyid_cid'>cid</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_prompt'>prompt</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>busy</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_consoles'>consoles</span><span class='lbracket'>[</span><span class='id identifier rubyid_cid'>cid</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_busy'>busy</span> <span class='op'>||</span> <span class='kw'>false</span>
|
|
<span class='rbrace'>}</span>
|
|
<span class='kw'>end</span>
|
|
<span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>consoles</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_ret'>ret</span><span class='rbrace'>}</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="rpc_read-instance_method">
|
|
|
|
#<strong>rpc_read</strong>(cid) ⇒ <tt>Hash</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Returns the framework console output in raw form.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<div class="examples">
|
|
<h4 class="tag_title">Examples:</h4>
|
|
|
|
|
|
<h5 class="example_title"><div class='inline'>
|
|
<p>Here's how you would use this from the client:</p>
|
|
</div></h5>
|
|
|
|
<pre class="example code"><code><span class='id identifier rubyid_rpc'>rpc</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>console.read</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>1</span><span class='rparen'>)</span></code></pre>
|
|
|
|
</div>
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>cid</span>
|
|
|
|
|
|
<span class='type'>(<tt>Integer</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Framework console ID.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>There are two different hashes you might get:</p>
|
|
|
|
<p>If the console ID is invalid, you will get a hash like the following:</p>
|
|
<ul><li>
|
|
<p>'result' [String] A value that says 'failure'.</p>
|
|
</li></ul>
|
|
|
|
<p>If the console ID is valid, you will get a hash like the following:</p>
|
|
<ul><li>
|
|
<p>'data' [String] The output the framework console produces (example: the banner)</p>
|
|
</li><li>
|
|
<p>'prompt' [String] The framework prompt (example: 'msf > ')</p>
|
|
</li><li>
|
|
<p>'busy' [TrueClass] The console's busy state, or</p>
|
|
</li><li>
|
|
<p>'busy' [FalseClass] The console's busy state.</p>
|
|
</li></ul>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
90
|
|
91
|
|
92
|
|
93
|
|
94
|
|
95
|
|
96
|
|
97
|
|
98</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/msf/core/rpc/v10/rpc_console.rb', line 90</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_rpc_read'>rpc_read</span><span class='lparen'>(</span><span class='id identifier rubyid_cid'>cid</span><span class='rparen'>)</span>
|
|
<span class='id identifier rubyid_cid'>cid</span> <span class='op'>=</span> <span class='id identifier rubyid_cid'>cid</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
<span class='kw'>return</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>result</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>failure</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span> <span class='kw'>if</span> <span class='kw'>not</span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_consoles'>consoles</span><span class='lbracket'>[</span><span class='id identifier rubyid_cid'>cid</span><span class='rbracket'>]</span>
|
|
<span class='lbrace'>{</span>
|
|
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>data</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_read_console'>read_console</span><span class='lparen'>(</span><span class='id identifier rubyid_cid'>cid</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>prompt</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_consoles'>consoles</span><span class='lbracket'>[</span><span class='id identifier rubyid_cid'>cid</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_prompt'>prompt</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>busy</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_consoles'>consoles</span><span class='lbracket'>[</span><span class='id identifier rubyid_cid'>cid</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_busy'>busy</span> <span class='op'>||</span> <span class='kw'>false</span>
|
|
<span class='rbrace'>}</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="rpc_session_detach-instance_method">
|
|
|
|
#<strong>rpc_session_detach</strong>(cid) ⇒ <tt>Hash</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Detaches a framework session. This serves the same purpose as [<a href="Z">CTRL]+</a> to background an interactive session.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<div class="examples">
|
|
<h4 class="tag_title">Examples:</h4>
|
|
|
|
|
|
<h5 class="example_title"><div class='inline'>
|
|
<p>Here's how you would use this from the client:</p>
|
|
</div></h5>
|
|
|
|
<pre class="example code"><code><span class='id identifier rubyid_rpc'>rpc</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>console.session_detach</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>4</span><span class='rparen'>)</span></code></pre>
|
|
|
|
</div>
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>cid</span>
|
|
|
|
|
|
<span class='type'>(<tt>Integer</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Framework console ID.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>A hash indicating whether the action was successful or not. It contains:</p>
|
|
<ul><li>
|
|
<p>'result' [String] A message that says 'success' if the console ID is valid (and successfully detached, otherwise 'failed')</p>
|
|
</li></ul>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
169
|
|
170
|
|
171
|
|
172
|
|
173
|
|
174</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/msf/core/rpc/v10/rpc_console.rb', line 169</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_rpc_session_detach'>rpc_session_detach</span><span class='lparen'>(</span><span class='id identifier rubyid_cid'>cid</span><span class='rparen'>)</span>
|
|
<span class='id identifier rubyid_cid'>cid</span> <span class='op'>=</span> <span class='id identifier rubyid_cid'>cid</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
<span class='kw'>return</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>result</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>failure</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span> <span class='kw'>if</span> <span class='kw'>not</span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_consoles'>consoles</span><span class='lbracket'>[</span><span class='id identifier rubyid_cid'>cid</span><span class='rbracket'>]</span>
|
|
<span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_consoles'>consoles</span><span class='lbracket'>[</span><span class='id identifier rubyid_cid'>cid</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_session_detach'>session_detach</span>
|
|
<span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>result</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>success</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="rpc_session_kill-instance_method">
|
|
|
|
#<strong>rpc_session_kill</strong>(cid) ⇒ <tt>Hash</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Kills a framework session. This serves the same purpose as [<a href="C">CTRL]+</a> to abort an interactive session. You might also want to considering using the session API calls instead of this.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<div class="examples">
|
|
<h4 class="tag_title">Examples:</h4>
|
|
|
|
|
|
<h5 class="example_title"><div class='inline'>
|
|
<p>Here's how you would use this from the client:</p>
|
|
</div></h5>
|
|
|
|
<pre class="example code"><code><span class='id identifier rubyid_rpc'>rpc</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>console.session_kill</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>4</span><span class='rparen'>)</span></code></pre>
|
|
|
|
</div>
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>cid</span>
|
|
|
|
|
|
<span class='type'>(<tt>Integer</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Framework console ID.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>A hash indicating whether the action was successful or not. It contains:</p>
|
|
<ul><li>
|
|
<p>'result' [String] A message that says 'success' if the console ID is valid (and successfully killed, otherwise 'failed')</p>
|
|
</li></ul>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
153
|
|
154
|
|
155
|
|
156
|
|
157
|
|
158</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/msf/core/rpc/v10/rpc_console.rb', line 153</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_rpc_session_kill'>rpc_session_kill</span><span class='lparen'>(</span><span class='id identifier rubyid_cid'>cid</span><span class='rparen'>)</span>
|
|
<span class='id identifier rubyid_cid'>cid</span> <span class='op'>=</span> <span class='id identifier rubyid_cid'>cid</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
<span class='kw'>return</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>result</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>failure</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span> <span class='kw'>if</span> <span class='kw'>not</span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_consoles'>consoles</span><span class='lbracket'>[</span><span class='id identifier rubyid_cid'>cid</span><span class='rbracket'>]</span>
|
|
<span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_consoles'>consoles</span><span class='lbracket'>[</span><span class='id identifier rubyid_cid'>cid</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_session_kill'>session_kill</span>
|
|
<span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>result</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>success</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="rpc_tabs-instance_method">
|
|
|
|
#<strong>rpc_tabs</strong>(cid, line) ⇒ <tt>Hash</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Returns the tab-completed version of your input (such as a module path).</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<div class="examples">
|
|
<h4 class="tag_title">Examples:</h4>
|
|
|
|
|
|
<h5 class="example_title"><div class='inline'>
|
|
<p>Here's how you would use this from the client:</p>
|
|
</div></h5>
|
|
|
|
<pre class="example code"><code><span class='comment'># This will return:
|
|
</span><span class='comment'># {"tabs"=>["use exploit/windows/smb/ms08_067_netapi"]}
|
|
</span><span class='id identifier rubyid_rpc'>rpc</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>console.tabs</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>4</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>use exploit/windows/smb/ms08_067_</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></code></pre>
|
|
|
|
</div>
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>cid</span>
|
|
|
|
|
|
<span class='type'>(<tt>Integer</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Framework console ID.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>line</span>
|
|
|
|
|
|
<span class='type'>(<tt>String</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Command.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>There are two different hashes you might get:</p>
|
|
|
|
<p>If the console ID is invalid, you will get a hash like the following:</p>
|
|
<ul><li>
|
|
<p>'result' [String] A value that says 'failure'.</p>
|
|
</li></ul>
|
|
|
|
<p>If the console ID is valid, you will get a hash like the following:</p>
|
|
<ul><li>
|
|
<p>'tabs' [String] The tab-completed version of the command.</p>
|
|
</li></ul>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
138
|
|
139
|
|
140
|
|
141
|
|
142</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/msf/core/rpc/v10/rpc_console.rb', line 138</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_rpc_tabs'>rpc_tabs</span><span class='lparen'>(</span><span class='id identifier rubyid_cid'>cid</span><span class='comma'>,</span> <span class='id identifier rubyid_line'>line</span><span class='rparen'>)</span>
|
|
<span class='id identifier rubyid_cid'>cid</span> <span class='op'>=</span> <span class='id identifier rubyid_cid'>cid</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
<span class='kw'>return</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>result</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>failure</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span> <span class='kw'>if</span> <span class='kw'>not</span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_consoles'>consoles</span><span class='lbracket'>[</span><span class='id identifier rubyid_cid'>cid</span><span class='rbracket'>]</span>
|
|
<span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>tabs</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_consoles'>consoles</span><span class='lbracket'>[</span><span class='id identifier rubyid_cid'>cid</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_tab_complete'>tab_complete</span><span class='lparen'>(</span><span class='id identifier rubyid_line'>line</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="rpc_write-instance_method">
|
|
|
|
#<strong>rpc_write</strong>(cid, data) ⇒ <tt>Hash</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<div class="note notetag">
|
|
<strong>Note:</strong>
|
|
<div class='inline'>
|
|
<p>Remember to add a newline (\r\n) at the end of input, otherwise the console will not do anything. And you will need to use the #rpc_read method to retrieve the output again.</p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p>Sends an input (such as a command) to the framework console.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<div class="examples">
|
|
<h4 class="tag_title">Examples:</h4>
|
|
|
|
|
|
<h5 class="example_title"><div class='inline'>
|
|
<p>Here's how you would use this from the client:</p>
|
|
</div></h5>
|
|
|
|
<pre class="example code"><code><span class='comment'># This will show the current module's options.
|
|
</span><span class='id identifier rubyid_rpc'>rpc</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>console.write</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>4</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>show options\r\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></code></pre>
|
|
|
|
</div>
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>cid</span>
|
|
|
|
|
|
<span class='type'>(<tt>Integer</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Framework console ID.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>data</span>
|
|
|
|
|
|
<span class='type'>(<tt>String</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>User input.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>There are two different hashes you might get:</p>
|
|
|
|
<p>If the console ID is invalid, you will get a hash like the following:</p>
|
|
<ul><li>
|
|
<p>'result' [String] A value that says 'failure'.</p>
|
|
</li></ul>
|
|
|
|
<p>If the console ID is invalid, you will get a hash like the following:</p>
|
|
<ul><li>
|
|
<p>'wrote' [Integer] Number of bytes sent.</p>
|
|
</li></ul>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
117
|
|
118
|
|
119
|
|
120
|
|
121</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/msf/core/rpc/v10/rpc_console.rb', line 117</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_rpc_write'>rpc_write</span><span class='lparen'>(</span><span class='id identifier rubyid_cid'>cid</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
<span class='id identifier rubyid_cid'>cid</span> <span class='op'>=</span> <span class='id identifier rubyid_cid'>cid</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
<span class='kw'>return</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>result</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>failure</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span> <span class='kw'>if</span> <span class='kw'>not</span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_consoles'>consoles</span><span class='lbracket'>[</span><span class='id identifier rubyid_cid'>cid</span><span class='rbracket'>]</span>
|
|
<span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>wrote</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='ivar'>@console_driver</span><span class='period'>.</span><span class='id identifier rubyid_write_console'>write_console</span><span class='lparen'>(</span><span class='id identifier rubyid_cid'>cid</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="footer">
|
|
Generated on Fri May 8 17:03:30 2026 by
|
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
0.9.37 (ruby-3.1.5).
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html> |