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

461 lines
21 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Msf::Exploit::Remote::AuthOption
&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::Exploit::Remote::AuthOption";
relpath = '../../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (A)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Msf.html" title="Msf (module)">Msf</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Exploit.html" title="Msf::Exploit (class)">Exploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Remote.html" title="Msf::Exploit::Remote (class)">Remote</a></span></span>
&raquo;
<span class="title">AuthOption</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::Exploit::Remote::AuthOption
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/exploit/remote/auth_option.rb</dd>
</dl>
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="AUTO-constant" class="">AUTO =
<div class="docstring">
<div class="discussion">
<p>The module / specific protocol will automatically negotiate the best authentication method to use</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>auto</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="NTLM-constant" class="">NTLM =
<div class="docstring">
<div class="discussion">
<p>NTLM authentication is used</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ntlm</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="KERBEROS-constant" class="">KERBEROS =
<div class="docstring">
<div class="discussion">
<p>Kerberos authentication is used</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>kerberos</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="KERBEROS_DEFAULT_OFFERED_ENC_TYPES-constant" class="">KERBEROS_DEFAULT_OFFERED_ENC_TYPES =
</dt>
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto.html" title="Rex::Proto (module)">Proto</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/Kerberos.html" title="Rex::Proto::Kerberos (module)">Kerberos</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/Kerberos/Crypto.html" title="Rex::Proto::Kerberos::Crypto (module)">Crypto</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/Kerberos/Crypto/Encryption.html" title="Rex::Proto::Kerberos::Crypto::Encryption (module)">Encryption</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/Kerberos/Crypto/Encryption.html#DefaultOfferedEtypes-constant" title="Rex::Proto::Kerberos::Crypto::Encryption::DefaultOfferedEtypes (constant)">DefaultOfferedEtypes</a></span></span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_id'>id</span><span class='op'>|</span>
<span class='const'><span class='object_link'><a href="../../../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto.html" title="Rex::Proto (module)">Proto</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/Kerberos.html" title="Rex::Proto::Kerberos (module)">Kerberos</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/Kerberos/Crypto.html" title="Rex::Proto::Kerberos::Crypto (module)">Crypto</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/Kerberos/Crypto/Encryption.html" title="Rex::Proto::Kerberos::Crypto::Encryption (module)">Encryption</a></span></span><span class='period'>.</span><span class='id identifier rubyid_const_name'><span class='object_link'><a href="../../../Rex/Proto/Kerberos/Crypto/Encryption.html#const_name-class_method" title="Rex::Proto::Kerberos::Crypto::Encryption.const_name (method)">const_name</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>_</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>-</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre></dd>
<dt id="PLAINTEXT-constant" class="">PLAINTEXT =
<div class="docstring">
<div class="discussion">
<p>plaintext authentication is used</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>plaintext</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="SCHANNEL-constant" class="">SCHANNEL =
<div class="docstring">
<div class="discussion">
<p>SCHANNEL authentication is used.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>schannel</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="NONE-constant" class="">NONE =
<div class="docstring">
<div class="discussion">
<p>Do not authenticate with the service</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>none</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="SMB_OPTIONS-constant" class="">SMB_OPTIONS =
<div class="docstring">
<div class="discussion">
<p>The auth methods supported by the SMB protocol</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbracket'>[</span>
<span class='const'><span class='object_link'><a href="#AUTO-constant" title="Msf::Exploit::Remote::AuthOption::AUTO (constant)">AUTO</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#NTLM-constant" title="Msf::Exploit::Remote::AuthOption::NTLM (constant)">NTLM</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#KERBEROS-constant" title="Msf::Exploit::Remote::AuthOption::KERBEROS (constant)">KERBEROS</a></span></span>
<span class='rbracket'>]</span></pre></dd>
<dt id="HTTP_OPTIONS-constant" class="">HTTP_OPTIONS =
<div class="docstring">
<div class="discussion">
<p>The auth methods supported by the HTTP protocol</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbracket'>[</span>
<span class='const'><span class='object_link'><a href="#AUTO-constant" title="Msf::Exploit::Remote::AuthOption::AUTO (constant)">AUTO</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#NTLM-constant" title="Msf::Exploit::Remote::AuthOption::NTLM (constant)">NTLM</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#KERBEROS-constant" title="Msf::Exploit::Remote::AuthOption::KERBEROS (constant)">KERBEROS</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#PLAINTEXT-constant" title="Msf::Exploit::Remote::AuthOption::PLAINTEXT (constant)">PLAINTEXT</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#NONE-constant" title="Msf::Exploit::Remote::AuthOption::NONE (constant)">NONE</a></span></span>
<span class='rbracket'>]</span></pre></dd>
<dt id="LDAP_OPTIONS-constant" class="">LDAP_OPTIONS =
<div class="docstring">
<div class="discussion">
<p>The auth methods supported by the LDAP protocol</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbracket'>[</span>
<span class='const'><span class='object_link'><a href="#AUTO-constant" title="Msf::Exploit::Remote::AuthOption::AUTO (constant)">AUTO</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#NTLM-constant" title="Msf::Exploit::Remote::AuthOption::NTLM (constant)">NTLM</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#KERBEROS-constant" title="Msf::Exploit::Remote::AuthOption::KERBEROS (constant)">KERBEROS</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#SCHANNEL-constant" title="Msf::Exploit::Remote::AuthOption::SCHANNEL (constant)">SCHANNEL</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#PLAINTEXT-constant" title="Msf::Exploit::Remote::AuthOption::PLAINTEXT (constant)">PLAINTEXT</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#NONE-constant" title="Msf::Exploit::Remote::AuthOption::NONE (constant)">NONE</a></span></span>
<span class='rbracket'>]</span></pre></dd>
<dt id="MSSQL_OPTIONS-constant" class="">MSSQL_OPTIONS =
<div class="docstring">
<div class="discussion">
<p>The auth methods supported by the MSSQL/TDS protocol</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbracket'>[</span>
<span class='const'><span class='object_link'><a href="#AUTO-constant" title="Msf::Exploit::Remote::AuthOption::AUTO (constant)">AUTO</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#NTLM-constant" title="Msf::Exploit::Remote::AuthOption::NTLM (constant)">NTLM</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#KERBEROS-constant" title="Msf::Exploit::Remote::AuthOption::KERBEROS (constant)">KERBEROS</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#PLAINTEXT-constant" title="Msf::Exploit::Remote::AuthOption::PLAINTEXT (constant)">PLAINTEXT</a></span></span>
<span class='rbracket'>]</span></pre></dd>
<dt id="WINRM_OPTIONS-constant" class="">WINRM_OPTIONS =
<div class="docstring">
<div class="discussion">
<p>The auth methods supported by the WINRM protocol</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbracket'>[</span>
<span class='const'><span class='object_link'><a href="#AUTO-constant" title="Msf::Exploit::Remote::AuthOption::AUTO (constant)">AUTO</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#NTLM-constant" title="Msf::Exploit::Remote::AuthOption::NTLM (constant)">NTLM</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#KERBEROS-constant" title="Msf::Exploit::Remote::AuthOption::KERBEROS (constant)">KERBEROS</a></span></span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="#PLAINTEXT-constant" title="Msf::Exploit::Remote::AuthOption::PLAINTEXT (constant)">PLAINTEXT</a></span></span>
<span class='rbracket'>]</span></pre></dd>
</dl>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#as_default_offered_etypes-class_method" title="as_default_offered_etypes (class method)">.<strong>as_default_offered_etypes</strong>(value) &#x21d2; Array[Integer] The encryption types </a>
</span>
<span class="summary_desc"><div class='inline'>
<p><a href="Integer">Array</a> The encryption types.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="as_default_offered_etypes-class_method">
.<strong>as_default_offered_etypes</strong>(value) &#x21d2; <tt>Array[Integer] The encryption types</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns <a href="Integer">Array</a> The encryption types.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>value</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>String value with the user defined etypes, i.e. AES128,AES256,RC4_HMAC,etc</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array[Integer] The encryption types</tt>)</span>
&mdash;
<div class='inline'>
<p><a href="Integer">Array</a> The encryption types</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="../../../Rex/Proto/Kerberos/Crypto/Encryption.html#DefaultOfferedEtypes-constant" title="Rex::Proto::Kerberos::Crypto::Encryption::DefaultOfferedEtypes (constant)">Rex::Proto::Kerberos::Crypto::Encryption::DefaultOfferedEtypes</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
71
72
73
74
75
76
77</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/exploit/remote/auth_option.rb', line 71</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_as_default_offered_etypes'>as_default_offered_etypes</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='const'><span class='object_link'><a href="../../../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto.html" title="Rex::Proto (module)">Proto</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/Kerberos.html" title="Rex::Proto::Kerberos (module)">Kerberos</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/Kerberos/Crypto.html" title="Rex::Proto::Kerberos::Crypto (module)">Crypto</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/Kerberos/Crypto/Encryption.html" title="Rex::Proto::Kerberos::Crypto::Encryption (module)">Encryption</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/Kerberos/Crypto/Encryption.html#DefaultOfferedEtypes-constant" title="Rex::Proto::Kerberos::Crypto::Encryption::DefaultOfferedEtypes (constant)">DefaultOfferedEtypes</a></span></span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>
<span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>,</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:strip</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_reject'>reject</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:blank?</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_type'>type</span><span class='op'>|</span>
<span class='const'><span class='object_link'><a href="../../../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto.html" title="Rex::Proto (module)">Proto</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/Kerberos.html" title="Rex::Proto::Kerberos (module)">Kerberos</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/Kerberos/Crypto.html" title="Rex::Proto::Kerberos::Crypto (module)">Crypto</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../Rex/Proto/Kerberos/Crypto/Encryption.html" title="Rex::Proto::Kerberos::Crypto::Encryption (module)">Encryption</a></span></span><span class='period'>.</span><span class='id identifier rubyid_value_for'><span class='object_link'><a href="../../../Rex/Proto/Kerberos/Crypto/Encryption.html#value_for-class_method" title="Rex::Proto::Kerberos::Crypto::Encryption.value_for (method)">value_for</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='period'>.</span><span class='id identifier rubyid_upcase'>upcase</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>-</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>_</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_uniq'>uniq</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:01:58 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