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

2134 lines
58 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::Module::Target
&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::Module::Target";
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 (T)</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="../Module.html" title="Msf::Module (class)">Module</a></span></span>
&raquo;
<span class="title">Target</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::Module::Target
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Msf::Module::Target</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/module/target.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A target for an exploit.</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Target/Bruteforce.html" title="Msf::Module::Target::Bruteforce (class)">Bruteforce</a></span>
</p>
<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="#arch-instance_method" title="#arch (instance method)">#<strong>arch</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The architectures, if any, that the target is specific to.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#bruteforce-instance_method" title="#bruteforce (instance method)">#<strong>bruteforce</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The bruteforce target information that will be non-nil if a Bruteforce option is passed to the constructor of the class.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#default_options-instance_method" title="#default_options (instance method)">#<strong>default_options</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>DefaultOptions hash to be imported into the datastore.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The name of the target (E.g. Windows XP SP0/SP1).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#opts-instance_method" title="#opts (instance method)">#<strong>opts</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The target-specific options, like payload settings and other stuff like that.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#platform-instance_method" title="#platform (instance method)">#<strong>platform</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The platforms that this target is for.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ret-instance_method" title="#ret (instance method)">#<strong>ret</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>An alias for the target ‘Ret’ option.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#save_registers-instance_method" title="#save_registers (instance method)">#<strong>save_registers</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The list of registers that need to be saved.</p>
</div></span>
</li>
</ul>
<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="#from_a-class_method" title="from_a (class method)">.<strong>from_a</strong>(ary) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Serialize from an array to a Target instance.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#transform-class_method" title="transform (class method)">.<strong>transform</strong>(src) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Transforms the supplied source into an array of Targets.</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="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(key) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Index the options directly.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#bruteforce%3F-instance_method" title="#bruteforce? (instance method)">#<strong>bruteforce?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns whether or not this is a bruteforce target, forces boolean result.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(name, opts) &#x21d2; Target </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Initializes an instance of a bruteforce target from the supplied information.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_append-instance_method" title="#payload_append (instance method)">#<strong>payload_append</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Payload append information for this target.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_append_encoder-instance_method" title="#payload_append_encoder (instance method)">#<strong>payload_append_encoder</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Payload append encoder information for this target.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_badchars-instance_method" title="#payload_badchars (instance method)">#<strong>payload_badchars</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The bad characters specific to this target for the payload.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_disable_nops-instance_method" title="#payload_disable_nops (instance method)">#<strong>payload_disable_nops</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Whether NOP generation should be enabled or disabled.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_encoder-instance_method" title="#payload_encoder (instance method)">#<strong>payload_encoder</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The payload encoder or encoders that can be used when generating the encoded payload (such as x86/shikata_ga_nai and so on).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_encoder_options-instance_method" title="#payload_encoder_options (instance method)">#<strong>payload_encoder_options</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>A hash of options that be initialized in the select encoder’s datastore that may be required as parameters for the encoding operation.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_encoder_type-instance_method" title="#payload_encoder_type (instance method)">#<strong>payload_encoder_type</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The payload encoder type or types that can be used when generating the encoded payload (such as alphanum, unicode, xor, and so on).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_extended_options-instance_method" title="#payload_extended_options (instance method)">#<strong>payload_extended_options</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns a hash of extended options that are applicable to payloads used against this particular target.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_max_nops-instance_method" title="#payload_max_nops (instance method)">#<strong>payload_max_nops</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Payload max nops information for this target.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_min_nops-instance_method" title="#payload_min_nops (instance method)">#<strong>payload_min_nops</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Payload min nops information for this target.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_nop-instance_method" title="#payload_nop (instance method)">#<strong>payload_nop</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The payload NOP generator or generators that can be used when generating the encoded payload (such as x86/opty2 and so on).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_prepend-instance_method" title="#payload_prepend (instance method)">#<strong>payload_prepend</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Payload prepend information for this target.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_prepend_encoder-instance_method" title="#payload_prepend_encoder (instance method)">#<strong>payload_prepend_encoder</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Payload prepend encoder information for this target.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_space-instance_method" title="#payload_space (instance method)">#<strong>payload_space</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Payload space information for this target.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_stack_adjustment-instance_method" title="#payload_stack_adjustment (instance method)">#<strong>payload_stack_adjustment</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Payload stack adjustment information for this target.</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>(name, opts) &#x21d2; <tt><span class='object_link'><a href="" title="Msf::Module::Target (class)">Target</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initializes an instance of a bruteforce target from the supplied information. The hash of options that this constructor takes is as follows:</p>
<p>Platform</p>
<p> The platform(s) that this target is to operate against.</p>
<p>SaveRegisters</p>
<p> The registers that must be saved by NOP generators.</p>
<p>Arch</p>
<p> The architectures, if any, that this target is specific to (E.g. ARCH_X86).</p>
<p>Bruteforce</p>
<p> Settings specific to a target that supports brute forcing. See the BruteForce class.</p>
<p>Ret</p>
<p> The target-specific return address or addresses that will be used.</p>
<p>Payload</p>
<p> Payload-specific options, such as append, prepend, and other values that can be set on a per-exploit or per-target basis.</p>
<p>DefaultOptions</p>
<pre class="code ruby"><code class="ruby">DefaultOptions hash to be imported into the datastore.
</code></pre>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 135</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='kw'>unless</span> <span class='id identifier rubyid_opts'>opts</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_save_registers'>save_registers</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>SaveRegisters</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_ret'>ret</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Ret</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_default_options'>default_options</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DefaultOptions</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
<span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Platform</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_platform'>platform</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../Msf.html" title="Msf (module)">Msf</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Module.html" title="Msf::Module (class)">Module</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="PlatformList.html" title="Msf::Module::PlatformList (class)">PlatformList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_transform'><span class='object_link'><a href="PlatformList.html#transform-class_method" title="Msf::Module::PlatformList.transform (method)">transform</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Platform</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Arch</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_arch'>arch</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/Transformer.html" title="Rex::Transformer (class)">Transformer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_transform'><span class='object_link'><a href="../../Rex/Transformer.html#transform-class_method" title="Rex::Transformer.transform (method)">transform</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Arch</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='const'>Array</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'>String</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Arch</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='comment'># Does this target have brute force information?
</span> <span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Bruteforce</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_bruteforce'>bruteforce</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Target/Bruteforce.html" title="Msf::Module::Target::Bruteforce (class)">Bruteforce</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Target/Bruteforce.html#initialize-instance_method" title="Msf::Module::Target::Bruteforce#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Bruteforce</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</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="arch=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="arch-instance_method">
#<strong>arch</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The architectures, if any, that the target is specific to.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
302
303
304</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 302</span>
<span class='kw'>def</span> <span class='id identifier rubyid_arch'>arch</span>
<span class='ivar'>@arch</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="bruteforce=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="bruteforce-instance_method">
#<strong>bruteforce</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The bruteforce target information that will be non-nil if a Bruteforce option is passed to the constructor of the class.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
320
321
322</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 320</span>
<span class='kw'>def</span> <span class='id identifier rubyid_bruteforce'>bruteforce</span>
<span class='ivar'>@bruteforce</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="default_options=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="default_options-instance_method">
#<strong>default_options</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>DefaultOptions hash to be imported into the datastore.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
324
325
326</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 324</span>
<span class='kw'>def</span> <span class='id identifier rubyid_default_options'>default_options</span>
<span class='ivar'>@default_options</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="name=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="name-instance_method">
#<strong>name</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The name of the target (E.g. Windows XP SP0/SP1)</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
294
295
296</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 294</span>
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
<span class='ivar'>@name</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="opts=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="opts-instance_method">
#<strong>opts</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The target-specific options, like payload settings and other stuff like that.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
307
308
309</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 307</span>
<span class='kw'>def</span> <span class='id identifier rubyid_opts'>opts</span>
<span class='ivar'>@opts</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="platform=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="platform-instance_method">
#<strong>platform</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The platforms that this target is for.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
298
299
300</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 298</span>
<span class='kw'>def</span> <span class='id identifier rubyid_platform'>platform</span>
<span class='ivar'>@platform</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="ret=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="ret-instance_method">
#<strong>ret</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>An alias for the target ‘Ret’ option.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
311
312
313</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 311</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ret'>ret</span>
<span class='ivar'>@ret</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="save_registers=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="save_registers-instance_method">
#<strong>save_registers</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The list of registers that need to be saved.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
315
316
317</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 315</span>
<span class='kw'>def</span> <span class='id identifier rubyid_save_registers'>save_registers</span>
<span class='ivar'>@save_registers</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="from_a-class_method">
.<strong>from_a</strong>(ary) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Serialize from an array to a Target instance.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
86
87
88
89
90</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 86</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_a'>from_a</span><span class='lparen'>(</span><span class='id identifier rubyid_ary'>ary</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_ary'>ary</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>&lt;</span> <span class='int'>2</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_ary'>ary</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span><span class='comma'>,</span> <span class='id identifier rubyid_ary'>ary</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="transform-class_method">
.<strong>transform</strong>(src) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Transforms the supplied source into an array of Targets.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
95
96
97</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 95</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_transform'>transform</span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='rparen'>)</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/Transformer.html" title="Rex::Transformer (class)">Transformer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_transform'><span class='object_link'><a href="../../Rex/Transformer.html#transform-class_method" title="Rex::Transformer.transform (method)">transform</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='comma'>,</span> <span class='const'>Array</span><span class='comma'>,</span> <span class='lbracket'>[</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='const'>String</span> <span class='rbracket'>]</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Target</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</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="[]-instance_method">
#<strong>[]</strong>(key) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Index the options directly.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
161
162
163</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 161</span>
<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="bruteforce?-instance_method">
#<strong>bruteforce?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns whether or not this is a bruteforce target, forces boolean result.</p>
</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">
169
170
171</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 169</span>
<span class='kw'>def</span> <span class='id identifier rubyid_bruteforce?'>bruteforce?</span>
<span class='kw'>return</span> <span class='lparen'>(</span><span class='id identifier rubyid_bruteforce'>bruteforce</span> <span class='op'>!=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_append-instance_method">
#<strong>payload_append</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Payload append information for this target.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
196
197
198</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 196</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_append'>payload_append</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Append</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_append_encoder-instance_method">
#<strong>payload_append_encoder</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Payload append encoder information for this target.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
210
211
212</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 210</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_append_encoder'>payload_append_encoder</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AppendEncoder</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_badchars-instance_method">
#<strong>payload_badchars</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The bad characters specific to this target for the payload.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
182
183
184</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 182</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_badchars'>payload_badchars</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>BadChars</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_disable_nops-instance_method">
#<strong>payload_disable_nops</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Whether NOP generation should be enabled or disabled</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
224
225
226</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 224</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_disable_nops'>payload_disable_nops</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DisableNops</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_encoder-instance_method">
#<strong>payload_encoder</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The payload encoder or encoders that can be used when generating the encoded payload (such as x86/shikata_ga_nai and so on).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
253
254
255</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 253</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_encoder'>payload_encoder</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Encoder</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_encoder_options-instance_method">
#<strong>payload_encoder_options</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>A hash of options that be initialized in the select encoder’s datastore that may be required as parameters for the encoding operation. This is particularly useful when a specific encoder type is being used (as specified by the EncoderType hash element).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
279
280
281</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 279</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_encoder_options'>payload_encoder_options</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>EncoderOptions</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_encoder_type-instance_method">
#<strong>payload_encoder_type</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The payload encoder type or types that can be used when generating the encoded payload (such as alphanum, unicode, xor, and so on).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
269
270
271</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 269</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_encoder_type'>payload_encoder_type</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>EncoderType</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_extended_options-instance_method">
#<strong>payload_extended_options</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a hash of extended options that are applicable to payloads used against this particular target.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
287
288
289</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 287</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_extended_options'>payload_extended_options</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ExtendedOptions</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_max_nops-instance_method">
#<strong>payload_max_nops</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Payload max nops information for this target.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
231
232
233</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 231</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_max_nops'>payload_max_nops</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>MaxNops</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_min_nops-instance_method">
#<strong>payload_min_nops</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Payload min nops information for this target.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
238
239
240</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 238</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_min_nops'>payload_min_nops</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>MinNops</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_nop-instance_method">
#<strong>payload_nop</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The payload NOP generator or generators that can be used when generating the encoded payload (such as x86/opty2 and so on).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
261
262
263</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 261</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_nop'>payload_nop</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Nop</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_prepend-instance_method">
#<strong>payload_prepend</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Payload prepend information for this target.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
189
190
191</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 189</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_prepend'>payload_prepend</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Prepend</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_prepend_encoder-instance_method">
#<strong>payload_prepend_encoder</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Payload prepend encoder information for this target.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
203
204
205</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 203</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_prepend_encoder'>payload_prepend_encoder</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>PrependEncoder</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_space-instance_method">
#<strong>payload_space</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Payload space information for this target.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
245
246
247</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 245</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_space'>payload_space</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Space</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_stack_adjustment-instance_method">
#<strong>payload_stack_adjustment</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Payload stack adjustment information for this target.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
217
218
219</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/module/target.rb', line 217</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_stack_adjustment'>payload_stack_adjustment</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payload</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>StackAdjustment</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:03:22 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