Files
metasploit-gs/api/Msf/Post/Windows/NetAPI.html
T

825 lines
44 KiB
HTML
Raw Normal View History

2026-05-08 17:08:43 +00:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Msf::Post::Windows::NetAPI
&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 = "Msf::Post::Windows::NetAPI";
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 (N)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Msf.html" title="Msf (module)">Msf</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Post.html" title="Msf::Post (class)">Post</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Windows.html" title="Msf::Post::Windows (module)">Windows</a></span></span>
&raquo;
<span class="title">NetAPI</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: Msf::Post::Windows::NetAPI
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/post/windows/net_api.rb</dd>
</dl>
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="MAX_PREFERRED_LENGTH-constant" class="">MAX_PREFERRED_LENGTH =
</dt>
<dd><pre class="code"><span class='op'>-</span><span class='int'>1</span></pre></dd>
<dt id="SV_TYPE_ALL-constant" class="">SV_TYPE_ALL =
</dt>
<dd><pre class="code"><span class='int'>0xFFFFFFFF</span></pre></dd>
<dt id="SV_TYPE_DOMAIN_ENUM-constant" class="">SV_TYPE_DOMAIN_ENUM =
</dt>
<dd><pre class="code"><span class='int'>0x80000000</span></pre></dd>
<dt id="SV_TYPE_DOMAIN_BAKCTRL-constant" class="">SV_TYPE_DOMAIN_BAKCTRL =
</dt>
<dd><pre class="code"><span class='int'>0x00000010</span></pre></dd>
<dt id="SV_TYPE_DOMAIN_CTRL-constant" class="">SV_TYPE_DOMAIN_CTRL =
</dt>
<dd><pre class="code"><span class='int'>0x00000008</span></pre></dd>
<dt id="ERROR_ACCESS_DENIED-constant" class="">ERROR_ACCESS_DENIED =
</dt>
<dd><pre class="code"><span class='int'>5</span></pre></dd>
<dt id="ERROR_NOT_ENOUGH_MEMORY-constant" class="">ERROR_NOT_ENOUGH_MEMORY =
</dt>
<dd><pre class="code"><span class='int'>8</span></pre></dd>
<dt id="ERROR_INVALID_PARAMETER-constant" class="">ERROR_INVALID_PARAMETER =
</dt>
<dd><pre class="code"><span class='int'>87</span></pre></dd>
<dt id="ERROR_INVALID_LEVEL-constant" class="">ERROR_INVALID_LEVEL =
</dt>
<dd><pre class="code"><span class='int'>124</span></pre></dd>
<dt id="ERROR_MORE_DATA-constant" class="">ERROR_MORE_DATA =
</dt>
<dd><pre class="code"><span class='int'>234</span></pre></dd>
<dt id="ERROR_NO_BROWSER_SERVERS_FOUND-constant" class="">ERROR_NO_BROWSER_SERVERS_FOUND =
</dt>
<dd><pre class="code"><span class='int'>6118</span></pre></dd>
<dt id="NERR_ClientNameNotFound-constant" class="">NERR_ClientNameNotFound =
</dt>
<dd><pre class="code"><span class='int'>2312</span></pre></dd>
<dt id="NERR_InvalidComputer-constant" class="">NERR_InvalidComputer =
</dt>
<dd><pre class="code"><span class='int'>2351</span></pre></dd>
<dt id="NERR_UserNotFound-constant" class="">NERR_UserNotFound =
</dt>
<dd><pre class="code"><span class='int'>2221</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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(info = {}) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#net_server_enum-instance_method" title="#net_server_enum (instance method)">#<strong>net_server_enum</strong>(server_type = SV_TYPE_ALL, domain = nil) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#net_session_enum-instance_method" title="#net_session_enum (instance method)">#<strong>net_session_enum</strong>(hostname, username) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#netapi_buffer_free-instance_method" title="#netapi_buffer_free (instance method)">#<strong>netapi_buffer_free</strong>(ptr) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#read_server_structs-instance_method" title="#read_server_structs (instance method)">#<strong>read_server_structs</strong>(start_ptr, count, domain, server_type) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#read_session_structs-instance_method" title="#read_session_structs (instance method)">#<strong>read_session_structs</strong>(start_ptr, count, hostname) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#UnicodeByteStringToAscii-instance_method" title="#UnicodeByteStringToAscii (instance method)">#<strong>UnicodeByteStringToAscii</strong>(str) &#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="initialize-instance_method">
#<strong>initialize</strong>(info = {}) &#x21d2; <tt>Object</tt>
</h3><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</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/post/windows/net_api.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_info'>info</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span>
<span class='id identifier rubyid_update_info'>update_info</span><span class='lparen'>(</span>
<span class='id identifier rubyid_info'>info</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Compat</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Meterpreter</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Commands</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='qwords_beg'>%w[</span><span class='words_sep'>
</span><span class='tstring_content'>stdapi_railgun_api</span><span class='words_sep'>
</span><span class='tstring_content'>stdapi_railgun_memread</span><span class='words_sep'>
</span><span class='tstring_content'>stdapi_railgun_memwrite</span><span class='words_sep'>
</span><span class='tstring_end'>]</span></span>
<span class='rbrace'>}</span>
<span class='rbrace'>}</span>
<span class='rparen'>)</span>
<span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="net_server_enum-instance_method">
#<strong>net_server_enum</strong>(server_type = SV_TYPE_ALL, domain = nil) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/post/windows/net_api.rb', line 53</span>
<span class='kw'>def</span> <span class='id identifier rubyid_net_server_enum'>net_server_enum</span><span class='lparen'>(</span><span class='id identifier rubyid_server_type'>server_type</span><span class='op'>=</span><span class='const'>SV_TYPE_ALL</span><span class='comma'>,</span> <span class='id identifier rubyid_domain'>domain</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_hosts'>hosts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_railgun'>railgun</span><span class='period'>.</span><span class='id identifier rubyid_netapi32'>netapi32</span><span class='period'>.</span><span class='const'>NetServerEnum</span><span class='lparen'>(</span>
<span class='kw'>nil</span><span class='comma'>,</span> <span class='comment'># servername
</span> <span class='int'>100</span><span class='comma'>,</span> <span class='comment'># level (100/101)
</span> <span class='int'>4</span><span class='comma'>,</span> <span class='comment'># bufptr
</span> <span class='const'><span class='object_link'><a href="#MAX_PREFERRED_LENGTH-constant" title="Msf::Post::Windows::NetAPI::MAX_PREFERRED_LENGTH (constant)">MAX_PREFERRED_LENGTH</a></span></span><span class='comma'>,</span> <span class='comment'># prefmaxlen
</span> <span class='int'>4</span><span class='comma'>,</span> <span class='comment'># entries read
</span> <span class='int'>4</span><span class='comma'>,</span> <span class='comment'># total entries
</span> <span class='id identifier rubyid_server_type'>server_type</span><span class='comma'>,</span> <span class='comment'># server_type
</span> <span class='id identifier rubyid_domain'>domain</span><span class='comma'>,</span> <span class='comment'># domain
</span> <span class='kw'>nil</span> <span class='comment'># resume handle
</span> <span class='rparen'>)</span>
<span class='kw'>case</span> <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>return</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
<span class='kw'>when</span> <span class='int'>0</span>
<span class='comment'># Railgun assumes PDWORDS are pointers and returns 8 bytes for x64 architectures.
</span> <span class='comment'># Therefore we need to truncate the result value to an actual
</span> <span class='comment'># DWORD for entriesread or totalentries.
</span> <span class='id identifier rubyid_hosts'>hosts</span> <span class='op'>=</span> <span class='id identifier rubyid_read_server_structs'>read_server_structs</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>bufptr</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>entriesread</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>%</span> <span class='int'>4294967296</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_domain'>domain</span><span class='comma'>,</span> <span class='id identifier rubyid_server_type'>server_type</span><span class='rparen'>)</span>
<span class='kw'>when</span> <span class='const'><span class='object_link'><a href="#ERROR_NO_BROWSER_SERVERS_FOUND-constant" title="Msf::Post::Windows::NetAPI::ERROR_NO_BROWSER_SERVERS_FOUND (constant)">ERROR_NO_BROWSER_SERVERS_FOUND</a></span></span>
<span class='id identifier rubyid_print_error'>print_error</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ERROR_NO_BROWSER_SERVERS_FOUND</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>nil</span>
<span class='kw'>when</span> <span class='const'><span class='object_link'><a href="#ERROR_MORE_DATA-constant" title="Msf::Post::Windows::NetAPI::ERROR_MORE_DATA (constant)">ERROR_MORE_DATA</a></span></span>
<span class='id identifier rubyid_vprint_error'>vprint_error</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ERROR_MORE_DATA</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>nil</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_netapi_buffer_free'>netapi_buffer_free</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>bufptr</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_hosts'>hosts</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="net_session_enum-instance_method">
#<strong>net_session_enum</strong>(hostname, username) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/post/windows/net_api.rb', line 112</span>
<span class='kw'>def</span> <span class='id identifier rubyid_net_session_enum'>net_session_enum</span><span class='lparen'>(</span><span class='id identifier rubyid_hostname'>hostname</span><span class='comma'>,</span> <span class='id identifier rubyid_username'>username</span><span class='rparen'>)</span>
<span class='id identifier rubyid_sessions'>sessions</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_railgun'>railgun</span><span class='period'>.</span><span class='id identifier rubyid_netapi32'>netapi32</span><span class='period'>.</span><span class='const'>NetSessionEnum</span><span class='lparen'>(</span>
<span class='id identifier rubyid_hostname'>hostname</span><span class='comma'>,</span> <span class='comment'># servername
</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='comment'># UncClientName
</span> <span class='id identifier rubyid_username'>username</span><span class='comma'>,</span> <span class='comment'># username
</span> <span class='int'>10</span><span class='comma'>,</span> <span class='comment'># level
</span> <span class='int'>4</span><span class='comma'>,</span> <span class='comment'># bufptr
</span> <span class='const'><span class='object_link'><a href="#MAX_PREFERRED_LENGTH-constant" title="Msf::Post::Windows::NetAPI::MAX_PREFERRED_LENGTH (constant)">MAX_PREFERRED_LENGTH</a></span></span><span class='comma'>,</span> <span class='comment'># prefmaxlen
</span> <span class='int'>4</span><span class='comma'>,</span> <span class='comment'># entriesread
</span> <span class='int'>4</span><span class='comma'>,</span> <span class='comment'># totalentries
</span> <span class='kw'>nil</span> <span class='comment'># resume_handle
</span> <span class='rparen'>)</span>
<span class='kw'>case</span> <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>return</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
<span class='kw'>when</span> <span class='int'>0</span>
<span class='id identifier rubyid_vprint_error'>vprint_error</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_hostname'>hostname</span><span class='embexpr_end'>}</span><span class='tstring_content'> Session identified</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_sessions'>sessions</span> <span class='op'>=</span> <span class='id identifier rubyid_read_session_structs'>read_session_structs</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>bufptr</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>entriesread</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>%</span> <span class='int'>4294967296</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_hostname'>hostname</span><span class='rparen'>)</span>
<span class='kw'>when</span> <span class='const'><span class='object_link'><a href="#ERROR_ACCESS_DENIED-constant" title="Msf::Post::Windows::NetAPI::ERROR_ACCESS_DENIED (constant)">ERROR_ACCESS_DENIED</a></span></span>
<span class='id identifier rubyid_vprint_error'>vprint_error</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_hostname'>hostname</span><span class='embexpr_end'>}</span><span class='tstring_content'> Access denied...</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>nil</span>
<span class='kw'>when</span> <span class='int'>53</span>
<span class='id identifier rubyid_vprint_error'>vprint_error</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Host not found or did not respond: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_hostname'>hostname</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>nil</span>
<span class='kw'>when</span> <span class='int'>123</span>
<span class='id identifier rubyid_vprint_error'>vprint_error</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Invalid host: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_hostname'>hostname</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>nil</span>
<span class='kw'>when</span> <span class='const'><span class='object_link'><a href="#NERR_UserNotFound-constant" title="Msf::Post::Windows::NetAPI::NERR_UserNotFound (constant)">NERR_UserNotFound</a></span></span>
<span class='kw'>return</span> <span class='kw'>nil</span>
<span class='kw'>when</span> <span class='const'><span class='object_link'><a href="#ERROR_MORE_DATA-constant" title="Msf::Post::Windows::NetAPI::ERROR_MORE_DATA (constant)">ERROR_MORE_DATA</a></span></span>
<span class='id identifier rubyid_vprint_error'>vprint_error</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_hostname'>hostname</span><span class='embexpr_end'>}</span><span class='tstring_content'> ERROR_MORE_DATA</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_vprint_error'>vprint_error</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unaccounted for error code: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>return</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>nil</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_netapi_buffer_free'>netapi_buffer_free</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>bufptr</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_sessions'>sessions</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="netapi_buffer_free-instance_method">
#<strong>netapi_buffer_free</strong>(ptr) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
47
48
49
50
51</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/post/windows/net_api.rb', line 47</span>
<span class='kw'>def</span> <span class='id identifier rubyid_netapi_buffer_free'>netapi_buffer_free</span><span class='lparen'>(</span><span class='id identifier rubyid_ptr'>ptr</span><span class='rparen'>)</span>
<span class='comment'># Free the buffer
</span> <span class='id identifier rubyid_ret'>ret</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_railgun'>railgun</span><span class='period'>.</span><span class='id identifier rubyid_netapi32'>netapi32</span><span class='period'>.</span><span class='const'>NetApiBufferFree</span><span class='lparen'>(</span><span class='id identifier rubyid_ptr'>ptr</span><span class='rparen'>)</span>
<span class='id identifier rubyid_vprint_error'>vprint_error</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unable to free buffer, Error Code: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ret'>ret</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>return</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_ret'>ret</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>return</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='int'>0</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="read_server_structs-instance_method">
#<strong>read_server_structs</strong>(start_ptr, count, domain, server_type) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/post/windows/net_api.rb', line 87</span>
<span class='kw'>def</span> <span class='id identifier rubyid_read_server_structs'>read_server_structs</span><span class='lparen'>(</span><span class='id identifier rubyid_start_ptr'>start_ptr</span><span class='comma'>,</span> <span class='id identifier rubyid_count'>count</span><span class='comma'>,</span> <span class='id identifier rubyid_domain'>domain</span><span class='comma'>,</span> <span class='id identifier rubyid_server_type'>server_type</span><span class='rparen'>)</span>
<span class='id identifier rubyid_hosts'>hosts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='kw'>return</span> <span class='id identifier rubyid_hosts'>hosts</span> <span class='kw'>if</span> <span class='id identifier rubyid_count'>count</span> <span class='op'>&lt;=</span> <span class='int'>0</span>
<span class='id identifier rubyid_ptr_size'>ptr_size</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_railgun'>railgun</span><span class='period'>.</span><span class='id identifier rubyid_util'>util</span><span class='period'>.</span><span class='id identifier rubyid_pointer_size'>pointer_size</span>
<span class='id identifier rubyid_ptr'>ptr</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_ptr_size'>ptr_size</span> <span class='op'>==</span> <span class='int'>8</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Q&lt;</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>V</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_base'>base</span> <span class='op'>=</span> <span class='int'>0</span>
<span class='comment'># Struct -&gt; Ptr, Ptr
</span> <span class='id identifier rubyid_struct_size'>struct_size</span> <span class='op'>=</span> <span class='id identifier rubyid_ptr_size'>ptr_size</span> <span class='op'>*</span> <span class='int'>2</span>
<span class='id identifier rubyid_mem'>mem</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_railgun'>railgun</span><span class='period'>.</span><span class='id identifier rubyid_memread'>memread</span><span class='lparen'>(</span><span class='id identifier rubyid_start_ptr'>start_ptr</span><span class='comma'>,</span> <span class='id identifier rubyid_struct_size'>struct_size</span><span class='op'>*</span><span class='id identifier rubyid_count'>count</span><span class='rparen'>)</span>
<span class='id identifier rubyid_count'>count</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='kw'>do</span>
<span class='id identifier rubyid_x'>x</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_x'>x</span><span class='lbracket'>[</span><span class='symbol'>:version</span><span class='rbracket'>]</span><span class='op'>=</span> <span class='id identifier rubyid_mem'>mem</span><span class='lbracket'>[</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span> <span class='op'>+</span> <span class='int'>0</span><span class='rparen'>)</span><span class='comma'>,</span><span class='id identifier rubyid_ptr_size'>ptr_size</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_unpack'>unpack</span><span class='lparen'>(</span><span class='id identifier rubyid_ptr'>ptr</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='id identifier rubyid_nameptr'>nameptr</span> <span class='op'>=</span> <span class='id identifier rubyid_mem'>mem</span><span class='lbracket'>[</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span> <span class='op'>+</span> <span class='id identifier rubyid_ptr_size'>ptr_size</span><span class='rparen'>)</span><span class='comma'>,</span><span class='id identifier rubyid_ptr_size'>ptr_size</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_unpack'>unpack</span><span class='lparen'>(</span><span class='id identifier rubyid_ptr'>ptr</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='id identifier rubyid_x'>x</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#UnicodeByteStringToAscii-instance_method" title="Msf::Post::Windows::NetAPI#UnicodeByteStringToAscii (method)">UnicodeByteStringToAscii</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_railgun'>railgun</span><span class='period'>.</span><span class='id identifier rubyid_memread'>memread</span><span class='lparen'>(</span><span class='id identifier rubyid_nameptr'>nameptr</span><span class='comma'>,</span> <span class='int'>255</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_hosts'>hosts</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_x'>x</span>
<span class='id identifier rubyid_base'>base</span> <span class='op'>+=</span> <span class='id identifier rubyid_struct_size'>struct_size</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_hosts'>hosts</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="read_session_structs-instance_method">
#<strong>read_session_structs</strong>(start_ptr, count, hostname) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/post/windows/net_api.rb', line 154</span>
<span class='kw'>def</span> <span class='id identifier rubyid_read_session_structs'>read_session_structs</span><span class='lparen'>(</span><span class='id identifier rubyid_start_ptr'>start_ptr</span><span class='comma'>,</span> <span class='id identifier rubyid_count'>count</span><span class='comma'>,</span> <span class='id identifier rubyid_hostname'>hostname</span><span class='rparen'>)</span>
<span class='id identifier rubyid_sessions'>sessions</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='kw'>return</span> <span class='id identifier rubyid_sessions'>sessions</span> <span class='kw'>if</span> <span class='id identifier rubyid_count'>count</span> <span class='op'>&lt;=</span> <span class='int'>0</span>
<span class='id identifier rubyid_ptr_size'>ptr_size</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_railgun'>railgun</span><span class='period'>.</span><span class='id identifier rubyid_util'>util</span><span class='period'>.</span><span class='id identifier rubyid_pointer_size'>pointer_size</span>
<span class='id identifier rubyid_ptr'>ptr</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_ptr_size'>ptr_size</span> <span class='op'>==</span> <span class='int'>8</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Q&lt;</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>V</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_base'>base</span> <span class='op'>=</span> <span class='int'>0</span>
<span class='comment'># Struct -&gt; Ptr, Ptr, Dword Dword
</span> <span class='id identifier rubyid_struct_size'>struct_size</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_ptr_size'>ptr_size</span> <span class='op'>*</span> <span class='int'>2</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='int'>8</span>
<span class='id identifier rubyid_mem'>mem</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_railgun'>railgun</span><span class='period'>.</span><span class='id identifier rubyid_memread'>memread</span><span class='lparen'>(</span><span class='id identifier rubyid_start_ptr'>start_ptr</span><span class='comma'>,</span> <span class='id identifier rubyid_struct_size'>struct_size</span><span class='op'>*</span><span class='id identifier rubyid_count'>count</span><span class='rparen'>)</span>
<span class='id identifier rubyid_count'>count</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='kw'>do</span>
<span class='id identifier rubyid_sess'>sess</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_cnameptr'>cnameptr</span> <span class='op'>=</span> <span class='id identifier rubyid_mem'>mem</span><span class='lbracket'>[</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span> <span class='op'>+</span> <span class='int'>0</span><span class='rparen'>)</span><span class='comma'>,</span><span class='id identifier rubyid_ptr_size'>ptr_size</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_unpack'>unpack</span><span class='lparen'>(</span><span class='id identifier rubyid_ptr'>ptr</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='id identifier rubyid_usernameptr'>usernameptr</span> <span class='op'>=</span> <span class='id identifier rubyid_mem'>mem</span><span class='lbracket'>[</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span> <span class='op'>+</span> <span class='id identifier rubyid_ptr_size'>ptr_size</span><span class='rparen'>)</span><span class='comma'>,</span><span class='id identifier rubyid_ptr_size'>ptr_size</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_unpack'>unpack</span><span class='lparen'>(</span><span class='id identifier rubyid_ptr'>ptr</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='id identifier rubyid_sess'>sess</span><span class='lbracket'>[</span><span class='symbol'>:usetime</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mem'>mem</span><span class='lbracket'>[</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span> <span class='op'>+</span> <span class='lparen'>(</span><span class='id identifier rubyid_ptr_size'>ptr_size</span> <span class='op'>*</span> <span class='int'>2</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='comma'>,</span><span class='int'>4</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_unpack'>unpack</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>V</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='id identifier rubyid_sess'>sess</span><span class='lbracket'>[</span><span class='symbol'>:idletime</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mem'>mem</span><span class='lbracket'>[</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span> <span class='op'>+</span> <span class='lparen'>(</span><span class='id identifier rubyid_ptr_size'>ptr_size</span> <span class='op'>*</span> <span class='int'>2</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='int'>4</span><span class='rparen'>)</span><span class='comma'>,</span><span class='int'>4</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_unpack'>unpack</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>V</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='id identifier rubyid_sess'>sess</span><span class='lbracket'>[</span><span class='symbol'>:cname</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#UnicodeByteStringToAscii-instance_method" title="Msf::Post::Windows::NetAPI#UnicodeByteStringToAscii (method)">UnicodeByteStringToAscii</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_railgun'>railgun</span><span class='period'>.</span><span class='id identifier rubyid_memread'>memread</span><span class='lparen'>(</span><span class='id identifier rubyid_cnameptr'>cnameptr</span><span class='comma'>,</span><span class='int'>255</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_sess'>sess</span><span class='lbracket'>[</span><span class='symbol'>:username</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#UnicodeByteStringToAscii-instance_method" title="Msf::Post::Windows::NetAPI#UnicodeByteStringToAscii (method)">UnicodeByteStringToAscii</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_railgun'>railgun</span><span class='period'>.</span><span class='id identifier rubyid_memread'>memread</span><span class='lparen'>(</span><span class='id identifier rubyid_usernameptr'>usernameptr</span><span class='comma'>,</span><span class='int'>255</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_sess'>sess</span><span class='lbracket'>[</span><span class='symbol'>:hostname</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_hostname'>hostname</span>
<span class='id identifier rubyid_sessions'>sessions</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_sess'>sess</span>
<span class='id identifier rubyid_base'>base</span> <span class='op'>=</span> <span class='id identifier rubyid_base'>base</span> <span class='op'>+</span> <span class='id identifier rubyid_struct_size'>struct_size</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_sessions'>sessions</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="UnicodeByteStringToAscii-instance_method">
#<strong>UnicodeByteStringToAscii</strong>(str) &#x21d2; <tt>Object</tt>
</h3><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/msf/core/post/windows/net_api.rb', line 42</span>
<span class='kw'>def</span> <span class='const'>UnicodeByteStringToAscii</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
<span class='id identifier rubyid_length'>length</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\0\0\0</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='op'>+</span> <span class='int'>1</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'>Text</span><span class='period'>.</span><span class='id identifier rubyid_to_ascii'>to_ascii</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>..</span><span class='id identifier rubyid_length'>length</span><span class='rbracket'>]</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:01:37 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>