Files
metasploit-gs/api/Exploit/Remote/Relay/NTLM/HashCapture/HashCaptureNTLMProvider.html
T
jenkins-metasploit c3f5bd3de2 Reboot gh-pages
2026-05-08 17:08:43 +00:00

531 lines
14 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Exploit::Remote::Relay::NTLM::HashCapture::HashCaptureNTLMProvider
&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 = "Exploit::Remote::Relay::NTLM::HashCapture::HashCaptureNTLMProvider";
relpath = '../../../../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../../../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../../../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../../../_index.html">Index (H)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../../../Msf.html" title="Msf (module)">Msf</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../../../../Msf/Exploit.html" title="Msf::Exploit (class)">Exploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../../../../Msf/Exploit/Remote.html" title="Msf::Exploit::Remote (class)">Remote</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../../../../Msf/Exploit/Remote/Relay.html" title="Msf::Exploit::Remote::Relay (module)">Relay</a></span></span> &raquo; <span class='title'>NTLM</span> &raquo; <span class='title'><span class='object_link'><a href="../HashCapture.html" title="Exploit::Remote::Relay::NTLM::HashCapture (module)">HashCapture</a></span></span>
&raquo;
<span class="title">HashCaptureNTLMProvider</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: Exploit::Remote::Relay::NTLM::HashCapture::HashCaptureNTLMProvider
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">RubySMB::Gss::Provider::NTLM</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">RubySMB::Gss::Provider::NTLM</li>
<li class="next">Exploit::Remote::Relay::NTLM::HashCapture::HashCaptureNTLMProvider</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/exploit/remote/relay/ntlm/hash_capture.rb</dd>
</dl>
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#listener-instance_method" title="#listener (instance method)">#<strong>listener</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute listener.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ntlm_type3_status-instance_method" title="#ntlm_type3_status (instance method)">#<strong>ntlm_type3_status</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute ntlm_type3_status.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#service_name-instance_method" title="#service_name (instance method)">#<strong>service_name</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute service_name.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(allow_anonymous: false, allow_guests: false, default_domain: &#39;WORKGROUP&#39;, listener: nil, ntlm_type3_status: ::WindowsError::NTStatus::STATUS_ACCESS_DENIED, service_name:) &#x21d2; HashCaptureNTLMProvider </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of HashCaptureNTLMProvider.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#new_authenticator-instance_method" title="#new_authenticator (instance method)">#<strong>new_authenticator</strong>(server_client) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Needs overwritten to ensure our version of Authenticator is returned.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(allow_anonymous: false, allow_guests: false, default_domain: &#39;WORKGROUP&#39;, listener: nil, ntlm_type3_status: ::WindowsError::NTStatus::STATUS_ACCESS_DENIED, service_name:) &#x21d2; <tt><span class='object_link'><a href="" title="Exploit::Remote::Relay::NTLM::HashCapture::HashCaptureNTLMProvider (class)">HashCaptureNTLMProvider</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of HashCaptureNTLMProvider.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>ntlm_type3_status</span>
<span class='type'>(<tt>::WindowsError::NTStatus</tt>)</span>
<em class="default">(defaults to: <tt>::WindowsError::NTStatus::STATUS_ACCESS_DENIED</tt>)</em>
&mdash;
<div class='inline'>
<p>A specific NT Status to return as the response to the NTLM type 3 message. If this value is nil, the message will be processed as normal.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
180
181
182
183
184
185</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/exploit/remote/relay/ntlm/hash_capture.rb', line 180</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>allow_anonymous:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>allow_guests:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>default_domain:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>WORKGROUP</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>listener:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ntlm_type3_status:</span> <span class='op'>::</span><span class='const'>WindowsError</span><span class='op'>::</span><span class='const'>NTStatus</span><span class='op'>::</span><span class='const'>STATUS_ACCESS_DENIED</span><span class='comma'>,</span> <span class='label'>service_name:</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='label'>allow_anonymous:</span> <span class='id identifier rubyid_allow_anonymous'>allow_anonymous</span><span class='comma'>,</span> <span class='label'>allow_guests:</span> <span class='id identifier rubyid_allow_guests'>allow_guests</span><span class='comma'>,</span> <span class='label'>default_domain:</span> <span class='id identifier rubyid_default_domain'>default_domain</span><span class='rparen'>)</span>
<span class='ivar'>@listener</span> <span class='op'>=</span> <span class='id identifier rubyid_listener'>listener</span>
<span class='ivar'>@ntlm_type3_status</span> <span class='op'>=</span> <span class='id identifier rubyid_ntlm_type3_status'>ntlm_type3_status</span>
<span class='ivar'>@service_name</span> <span class='op'>=</span> <span class='id identifier rubyid_service_name'>service_name</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="listener-instance_method">
#<strong>listener</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute listener.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
194
195
196</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/exploit/remote/relay/ntlm/hash_capture.rb', line 194</span>
<span class='kw'>def</span> <span class='id identifier rubyid_listener'>listener</span>
<span class='ivar'>@listener</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="ntlm_type3_status=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="ntlm_type3_status-instance_method">
#<strong>ntlm_type3_status</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute ntlm_type3_status.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
195
196
197</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/exploit/remote/relay/ntlm/hash_capture.rb', line 195</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ntlm_type3_status'>ntlm_type3_status</span>
<span class='ivar'>@ntlm_type3_status</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="service_name=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="service_name-instance_method">
#<strong>service_name</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute service_name.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
195
196
197</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/exploit/remote/relay/ntlm/hash_capture.rb', line 195</span>
<span class='kw'>def</span> <span class='id identifier rubyid_service_name'>service_name</span>
<span class='ivar'>@service_name</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="new_authenticator-instance_method">
#<strong>new_authenticator</strong>(server_client) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Needs overwritten to ensure our version of Authenticator is returned</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
188
189
190
191
192</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/exploit/remote/relay/ntlm/hash_capture.rb', line 188</span>
<span class='kw'>def</span> <span class='id identifier rubyid_new_authenticator'>new_authenticator</span><span class='lparen'>(</span><span class='id identifier rubyid_server_client'>server_client</span><span class='rparen'>)</span>
<span class='comment'># build and return an instance that can process and track stateful information for a particular connection but
</span> <span class='comment'># that&#39;s backed by this particular provider
</span> <span class='const'><span class='object_link'><a href="HashCaptureAuthenticator.html" title="Exploit::Remote::Relay::NTLM::HashCapture::HashCaptureAuthenticator (class)">HashCaptureAuthenticator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../HashCapture.html#initialize-instance_method" title="Exploit::Remote::Relay::NTLM::HashCapture#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_server_client'>server_client</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:05:36 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>