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

297 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Msf::OptAddressLocal
&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::OptAddressLocal";
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 (O)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Msf.html" title="Msf (module)">Msf</a></span></span>
&raquo;
<span class="title">OptAddressLocal</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: Msf::OptAddressLocal
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="OptAddressRoutable.html" title="Msf::OptAddressRoutable (class)">OptAddressRoutable</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="OptBase.html" title="Msf::OptBase (class)">OptBase</a></span></li>
<li class="next"><span class='object_link'><a href="OptAddress.html" title="Msf::OptAddress (class)">OptAddress</a></span></li>
<li class="next"><span class='object_link'><a href="OptAddressRoutable.html" title="Msf::OptAddressRoutable (class)">OptAddressRoutable</a></span></li>
<li class="next">Msf::OptAddressLocal</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/opt_address_local.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Network address option that allows referencing an address based on the name of the interface it’s associated with.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="OptBase.html" title="Msf::OptBase (class)">OptBase</a></span></h3>
<p class="inherited"><span class='object_link'><a href="OptBase.html#advanced-instance_method" title="Msf::OptBase#advanced (method)">#advanced</a></span>, <span class='object_link'><a href="OptBase.html#aliases-instance_method" title="Msf::OptBase#aliases (method)">#aliases</a></span>, <span class='object_link'><a href="OptBase.html#conditions-instance_method" title="Msf::OptBase#conditions (method)">#conditions</a></span>, <span class='object_link'><a href="OptBase.html#default-instance_method" title="Msf::OptBase#default (method)">#default</a></span>, <span class='object_link'><a href="OptBase.html#desc-instance_method" title="Msf::OptBase#desc (method)">#desc</a></span>, <span class='object_link'><a href="OptBase.html#enums-instance_method" title="Msf::OptBase#enums (method)">#enums</a></span>, <span class='object_link'><a href="OptBase.html#evasion-instance_method" title="Msf::OptBase#evasion (method)">#evasion</a></span>, <span class='object_link'><a href="OptBase.html#fallbacks-instance_method" title="Msf::OptBase#fallbacks (method)">#fallbacks</a></span>, <span class='object_link'><a href="OptBase.html#max_length-instance_method" title="Msf::OptBase#max_length (method)">#max_length</a></span>, <span class='object_link'><a href="OptBase.html#name-instance_method" title="Msf::OptBase#name (method)">#name</a></span>, <span class='object_link'><a href="OptBase.html#owner-instance_method" title="Msf::OptBase#owner (method)">#owner</a></span>, <span class='object_link'><a href="OptBase.html#regex-instance_method" title="Msf::OptBase#regex (method)">#regex</a></span>, <span class='object_link'><a href="OptBase.html#required-instance_method" title="Msf::OptBase#required (method)">#required</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="#valid%3F-instance_method" title="#valid? (instance method)">#<strong>valid?</strong>(value, check_empty: true, datastore: nil) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="OptAddressRoutable.html" title="Msf::OptAddressRoutable (class)">OptAddressRoutable</a></span></h3>
<p class="inherited"><span class='object_link'><a href="OptAddressRoutable.html#interfaces-instance_method" title="Msf::OptAddressRoutable#interfaces (method)">#interfaces</a></span>, <span class='object_link'><a href="OptAddressRoutable.html#normalize-instance_method" title="Msf::OptAddressRoutable#normalize (method)">#normalize</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="OptAddress.html" title="Msf::OptAddress (class)">OptAddress</a></span></h3>
<p class="inherited"><span class='object_link'><a href="OptAddress.html#type-instance_method" title="Msf::OptAddress#type (method)">#type</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="OptBase.html" title="Msf::OptBase (class)">OptBase</a></span></h3>
<p class="inherited"><span class='object_link'><a href="OptBase.html#advanced%3F-instance_method" title="Msf::OptBase#advanced? (method)">#advanced?</a></span>, <span class='object_link'><a href="OptBase.html#display_value-instance_method" title="Msf::OptBase#display_value (method)">#display_value</a></span>, <span class='object_link'><a href="OptBase.html#empty_required_value%3F-instance_method" title="Msf::OptBase#empty_required_value? (method)">#empty_required_value?</a></span>, <span class='object_link'><a href="OptBase.html#evasion%3F-instance_method" title="Msf::OptBase#evasion? (method)">#evasion?</a></span>, <span class='object_link'><a href="OptBase.html#initialize-instance_method" title="Msf::OptBase#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="OptBase.html#invalid_value_length%3F-instance_method" title="Msf::OptBase#invalid_value_length? (method)">#invalid_value_length?</a></span>, <span class='object_link'><a href="OptBase.html#normalize-instance_method" title="Msf::OptBase#normalize (method)">#normalize</a></span>, <span class='object_link'><a href="OptBase.html#required%3F-instance_method" title="Msf::OptBase#required? (method)">#required?</a></span>, <span class='object_link'><a href="OptBase.html#type%3F-instance_method" title="Msf::OptBase#type? (method)">#type?</a></span>, <span class='object_link'><a href="OptBase.html#validate_on_assignment%3F-instance_method" title="Msf::OptBase#validate_on_assignment? (method)">#validate_on_assignment?</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="OptBase.html#initialize-instance_method" title="Msf::OptBase#initialize (method)">Msf::OptBase</a></span></p>
</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="valid?-instance_method">
#<strong>valid?</strong>(value, check_empty: true, datastore: nil) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/opt_address_local.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_valid?'>valid?</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='label'>check_empty:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>datastore:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_check_empty'>check_empty</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_empty_required_value?'>empty_required_value?</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span><span class='lparen'>(</span><span class='const'>NilClass</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_interfaces'>interfaces</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='comment'># the 0.0.0.0 / :: addresses are valid local addresses for the purpose of binding
</span> <span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>if</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='period'>.</span><span class='id identifier rubyid_is_ip_addr?'>is_ip_addr?</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</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='period'>.</span><span class='id identifier rubyid_addr_atoi'>addr_atoi</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='op'>==</span> <span class='int'>0</span>
<span class='comment'># todo: this should probably have additional validation to ensure that the address is able to be bound to, this
</span> <span class='comment'># would mean that the address is either locally available, or available via a Rex::Socket channel, e.g. a Meterpreter
</span> <span class='comment'># session
</span>
<span class='kw'>super</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:03:27 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