adam/metasploit-gs
1
0
Fork 0
Code Issues Pull Requests Actions 9 Packages Projects Releases Wiki Activity
Files
gh-pages
metasploit-gs/api/SimpleClientPipe.html
T
jenkins-metasploit c3f5bd3de2 Reboot gh-pages
2026-05-08 17:08:43 +00:00

395 lines
16 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: SimpleClientPipe
&mdash; 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 = "SimpleClientPipe";
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">SimpleClientPipe</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: SimpleClientPipe
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html" title="Rex::Proto::SMB::SimpleClient (class)">Rex::Proto::SMB::SimpleClient</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html" title="Rex::Proto::SMB::SimpleClient (class)">Rex::Proto::SMB::SimpleClient</a></span></li>
<li class="next">SimpleClientPipe</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/handler/bind_named_pipe.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>SimpleClient for named pipe comms. Uses OpenPipe wrapper to provide a socket interface required by the packet dispatcher.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<h3 class="inherited">Constants inherited
from <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html" title="Rex::Proto::SMB::SimpleClient (class)">Rex::Proto::SMB::SimpleClient</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#CONST-constant" title="Rex::Proto::SMB::SimpleClient::CONST (constant)">Rex::Proto::SMB::SimpleClient::CONST</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#CRYPT-constant" title="Rex::Proto::SMB::SimpleClient::CRYPT (constant)">Rex::Proto::SMB::SimpleClient::CRYPT</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#DEFAULT_VERSIONS-constant" title="Rex::Proto::SMB::SimpleClient::DEFAULT_VERSIONS (constant)">Rex::Proto::SMB::SimpleClient::DEFAULT_VERSIONS</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#EVADE-constant" title="Rex::Proto::SMB::SimpleClient::EVADE (constant)">Rex::Proto::SMB::SimpleClient::EVADE</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#UTILS-constant" title="Rex::Proto::SMB::SimpleClient::UTILS (constant)">Rex::Proto::SMB::SimpleClient::UTILS</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#XCEPT-constant" title="Rex::Proto::SMB::SimpleClient::XCEPT (constant)">Rex::Proto::SMB::SimpleClient::XCEPT</a></span></p>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#pipe-instance_method" title="#pipe (instance method)">#<strong>pipe</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute pipe.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html" title="Rex::Proto::SMB::SimpleClient (class)">Rex::Proto::SMB::SimpleClient</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#address-instance_method" title="Rex::Proto::SMB::SimpleClient#address (method)">#address</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#client-instance_method" title="Rex::Proto::SMB::SimpleClient#client (method)">#client</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#direct-instance_method" title="Rex::Proto::SMB::SimpleClient#direct (method)">#direct</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#last_error-instance_method" title="Rex::Proto::SMB::SimpleClient#last_error (method)">#last_error</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#last_share-instance_method" title="Rex::Proto::SMB::SimpleClient#last_share (method)">#last_share</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#msf_session-instance_method" title="Rex::Proto::SMB::SimpleClient#msf_session (method)">#msf_session</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#port-instance_method" title="Rex::Proto::SMB::SimpleClient#port (method)">#port</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#server_max_buffer_size-instance_method" title="Rex::Proto::SMB::SimpleClient#server_max_buffer_size (method)">#server_max_buffer_size</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#shares-instance_method" title="Rex::Proto::SMB::SimpleClient#shares (method)">#shares</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#socket-instance_method" title="Rex::Proto::SMB::SimpleClient#socket (method)">#socket</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#versions-instance_method" title="Rex::Proto::SMB::SimpleClient#versions (method)">#versions</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="#create_pipe-instance_method" title="#create_pipe (instance method)">#<strong>create_pipe</strong>(path) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Copy of SimpleClient.create_pipe except OpenPipeSock is used instead of OpenPipe.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(socket, direct, versions = [1, 2, 3]) &#x21d2; SimpleClientPipe </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of SimpleClientPipe.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html" title="Rex::Proto::SMB::SimpleClient (class)">Rex::Proto::SMB::SimpleClient</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#connect-instance_method" title="Rex::Proto::SMB::SimpleClient#connect (method)">#connect</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#delete-instance_method" title="Rex::Proto::SMB::SimpleClient#delete (method)">#delete</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#disconnect-instance_method" title="Rex::Proto::SMB::SimpleClient#disconnect (method)">#disconnect</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#login-instance_method" title="Rex::Proto::SMB::SimpleClient#login (method)">#login</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#login_split_next_ntlm1-instance_method" title="Rex::Proto::SMB::SimpleClient#login_split_next_ntlm1 (method)">#login_split_next_ntlm1</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#login_split_start_ntlm1-instance_method" title="Rex::Proto::SMB::SimpleClient#login_split_start_ntlm1 (method)">#login_split_start_ntlm1</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#negotiated_smb_version-instance_method" title="Rex::Proto::SMB::SimpleClient#negotiated_smb_version (method)">#negotiated_smb_version</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#open-instance_method" title="Rex::Proto::SMB::SimpleClient#open (method)">#open</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#peerinfo-instance_method" title="Rex::Proto::SMB::SimpleClient#peerinfo (method)">#peerinfo</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#peerport-instance_method" title="Rex::Proto::SMB::SimpleClient#peerport (method)">#peerport</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#signing_required-instance_method" title="Rex::Proto::SMB::SimpleClient#signing_required (method)">#signing_required</a></span>, <span class='object_link'><a href="Rex/Proto/SMB/SimpleClient.html#trans_pipe-instance_method" title="Rex::Proto::SMB::SimpleClient#trans_pipe (method)">#trans_pipe</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>(socket, direct, versions = [1, 2, 3]) &#x21d2; <tt><span class='object_link'><a href="" title="SimpleClientPipe (class)">SimpleClientPipe</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of SimpleClientPipe.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
162
163
164
165</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/handler/bind_named_pipe.rb', line 162</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_socket'>socket</span><span class='comma'>,</span> <span class='id identifier rubyid_direct'>direct</span><span class='comma'>,</span> <span class='id identifier rubyid_versions'>versions</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>3</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_socket'>socket</span><span class='comma'>,</span> <span class='id identifier rubyid_direct'>direct</span><span class='comma'>,</span> <span class='id identifier rubyid_versions'>versions</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_pipe'>pipe</span> <span class='op'>=</span> <span class='kw'>nil</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="pipe=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="pipe-instance_method">
#<strong>pipe</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute pipe.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
160
161
162</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/handler/bind_named_pipe.rb', line 160</span>
<span class='kw'>def</span> <span class='id identifier rubyid_pipe'>pipe</span>
<span class='ivar'>@pipe</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="create_pipe-instance_method">
#<strong>create_pipe</strong>(path) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Copy of SimpleClient.create_pipe except OpenPipeSock is used instead of OpenPipe. This is because we need to implement our own read/write.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
169
170
171
172
173</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/handler/bind_named_pipe.rb', line 169</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_pipe'>create_pipe</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_create_pipe'>create_pipe</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_pipe'>pipe</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="OpenPipeSock.html" title="OpenPipeSock (class)">OpenPipeSock</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="OpenPipeSock.html#initialize-instance_method" title="OpenPipeSock#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_last_tree_id'>last_tree_id</span><span class='comma'>,</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_last_file_id'>last_file_id</span><span class='comma'>,</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_versions'>versions</span><span class='comma'>,</span>
<span class='label'>simple:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>server_max_buffer_size:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_server_max_buffer_size'>server_max_buffer_size</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:03:32 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>
Reference in New Issue View Git Blame Copy Permalink