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

292 lines
8.9 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Msf::Exploit::Remote::SSH
&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::SSH";
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'><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">SSH</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::SSH
</h1>
<div class="box_info">
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="SSH/Options.html" title="Msf::Exploit::Remote::SSH::Options (module)">Options</a></span></dd>
</dl>
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../../../Metasploit/Framework/LoginScanner/SSH.html" title="Metasploit::Framework::LoginScanner::SSH (class)">Metasploit::Framework::LoginScanner::SSH</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/exploit/remote/ssh/options.rb<span class="defines">,<br />
lib/msf/core/exploit/remote/ssh.rb,<br /> lib/msf/core/exploit/remote/ssh/auth_methods/malformed_packet.rb,<br /> lib/msf/core/exploit/remote/ssh/auth_methods/fortinet_backdoor.rb,<br /> lib/msf/core/exploit/remote/ssh/auth_methods/libssh_auth_bypass.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Include this mixin if you want just the SSH datastore options (e.g., when using Metasploit::Framework::LoginScanner::SSH)</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="SSH/AuthMethods.html" title="Msf::Exploit::Remote::SSH::AuthMethods (module)">AuthMethods</a></span>, <span class='object_link'><a href="SSH/Options.html" title="Msf::Exploit::Remote::SSH::Options (module)">Options</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="#ssh_client_defaults-instance_method" title="#ssh_client_defaults (instance method)">#<strong>ssh_client_defaults</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ssh_socket_factory-instance_method" title="#ssh_socket_factory (instance method)">#<strong>ssh_socket_factory</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="SSH/Options.html" title="Msf::Exploit::Remote::SSH::Options (module)">Options</a></span></h3>
<p class="inherited"><span class='object_link'><a href="SSH/Options.html#initialize-instance_method" title="Msf::Exploit::Remote::SSH::Options#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="SSH/Options.html#peer-instance_method" title="Msf::Exploit::Remote::SSH::Options#peer (method)">#peer</a></span>, <span class='object_link'><a href="SSH/Options.html#rhost-instance_method" title="Msf::Exploit::Remote::SSH::Options#rhost (method)">#rhost</a></span>, <span class='object_link'><a href="SSH/Options.html#rport-instance_method" title="Msf::Exploit::Remote::SSH::Options#rport (method)">#rport</a></span></p>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="ssh_client_defaults-instance_method">
#<strong>ssh_client_defaults</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
29
30
31
32
33
34
35
36
37
38</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/exploit/remote/ssh.rb', line 29</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ssh_client_defaults'>ssh_client_defaults</span>
<span class='lbrace'>{</span>
<span class='label'>non_interactive:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>config:</span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='label'>use_agent:</span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='label'>verify_host_key:</span> <span class='symbol'>:never</span><span class='comma'>,</span>
<span class='label'>proxy:</span> <span class='id identifier rubyid_ssh_socket_factory'>ssh_socket_factory</span><span class='comma'>,</span>
<span class='label'>append_all_supported_algorithms:</span> <span class='kw'>true</span>
<span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="ssh_socket_factory-instance_method">
#<strong>ssh_socket_factory</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
21
22
23
24
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/exploit/remote/ssh.rb', line 21</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ssh_socket_factory'>ssh_socket_factory</span>
<span class='kw'>unless</span> <span class='kw'>defined?</span> <span class='id identifier rubyid_datastore'>datastore</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'>Socket</span><span class='op'>::</span><span class='const'>SSHFactory</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_framework'>framework</span><span class='comma'>,</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_proxies'>proxies</span><span class='rparen'>)</span>
<span class='kw'>end</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'>Socket</span><span class='op'>::</span><span class='const'>SSHFactory</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_framework'>framework</span><span class='comma'>,</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_datastore'>datastore</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Proxies</span><span class='tstring_end'>&#39;</span></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:24 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>