Files
metasploit-gs/api/Msf/Modules/Metadata/Obj.html
T
jenkins-metasploit c3f5bd3de2 Reboot gh-pages
2026-05-08 17:08:43 +00:00

3610 lines
90 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::Modules::Metadata::Obj
&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::Modules::Metadata::Obj";
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'><span class='object_link'><a href="../../Modules.html" title="Msf::Modules (module)">Modules</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="Msf::Modules::Metadata (module)">Metadata</a></span></span>
&raquo;
<span class="title">Obj</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::Modules::Metadata::Obj
</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::Modules::Metadata::Obj</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/modules/metadata/obj.rb</dd>
</dl>
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="EMPTY_ARRAY-constant" class="">EMPTY_ARRAY =
<div class="docstring">
<div class="discussion">
<p>Frozen shared objects to avoid allocating duplicate empty containers</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="EMPTY_HASH-constant" class="">EMPTY_HASH =
</dt>
<dd><pre class="code"><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
</dl>
<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="#actions-instance_method" title="#actions (instance method)">#<strong>actions</strong> &#x21d2; Hash </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#adapted_refname-instance_method" title="#adapted_refname (instance method)">#<strong>adapted_refname</strong> &#x21d2; String<sup>?</sup> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Name of the adapted payload if applicable.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#adapter_refname-instance_method" title="#adapter_refname (instance method)">#<strong>adapter_refname</strong> &#x21d2; String<sup>?</sup> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Name of the adapter if applicable.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#aliases-instance_method" title="#aliases (instance method)">#<strong>aliases</strong> &#x21d2; Array&lt;String&gt; </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#arch-instance_method" title="#arch (instance method)">#<strong>arch</strong> &#x21d2; String </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#author-instance_method" title="#author (instance method)">#<strong>author</strong> &#x21d2; Array&lt;String&gt; </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#autofilter_ports-instance_method" title="#autofilter_ports (instance method)">#<strong>autofilter_ports</strong> &#x21d2; Array&lt;Integer&gt; </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#autofilter_services-instance_method" title="#autofilter_services (instance method)">#<strong>autofilter_services</strong> &#x21d2; Array&lt;String&gt; </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#check-instance_method" title="#check (instance method)">#<strong>check</strong> &#x21d2; Boolean </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#default_credential-instance_method" title="#default_credential (instance method)">#<strong>default_credential</strong> &#x21d2; Boolean </a>
(also: #default_cred?)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#description-instance_method" title="#description (instance method)">#<strong>description</strong> &#x21d2; String </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#disclosure_date-instance_method" title="#disclosure_date (instance method)">#<strong>disclosure_date</strong> &#x21d2; Date </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fullname-instance_method" title="#fullname (instance method)">#<strong>fullname</strong> &#x21d2; String </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#is_install_path-instance_method" title="#is_install_path (instance method)">#<strong>is_install_path</strong> &#x21d2; Boolean </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#mod_time-instance_method" title="#mod_time (instance method)">#<strong>mod_time</strong> &#x21d2; Time </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; String </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#notes-instance_method" title="#notes (instance method)">#<strong>notes</strong> &#x21d2; Hash </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_type-instance_method" title="#payload_type (instance method)">#<strong>payload_type</strong> &#x21d2; Integer </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The type of payload, e.g.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#platform-instance_method" title="#platform (instance method)">#<strong>platform</strong> &#x21d2; String </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#platform_list-instance_method" title="#platform_list (instance method)">#<strong>platform_list</strong> &#x21d2; Msf::Module::PlatformList </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#post_auth-instance_method" title="#post_auth (instance method)">#<strong>post_auth</strong> &#x21d2; Boolean </a>
(also: #post_auth?)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#rank-instance_method" title="#rank (instance method)">#<strong>rank</strong> &#x21d2; Integer </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ref_name-instance_method" title="#ref_name (instance method)">#<strong>ref_name</strong> &#x21d2; String </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#references-instance_method" title="#references (instance method)">#<strong>references</strong> &#x21d2; Array&lt;String&gt; </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#rport-instance_method" title="#rport (instance method)">#<strong>rport</strong> &#x21d2; Integer </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#session_types-instance_method" title="#session_types (instance method)">#<strong>session_types</strong> &#x21d2; Array&lt;String&gt; </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#stage_refname-instance_method" title="#stage_refname (instance method)">#<strong>stage_refname</strong> &#x21d2; String<sup>?</sup> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Name of the stage if applicable.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#staged-instance_method" title="#staged (instance method)">#<strong>staged</strong> &#x21d2; Boolean </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Whether or not the payload is staged.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#stager_refname-instance_method" title="#stager_refname (instance method)">#<strong>stager_refname</strong> &#x21d2; String<sup>?</sup> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Name of the stager if applicable.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#targets-instance_method" title="#targets (instance method)">#<strong>targets</strong> &#x21d2; Array&lt;String&gt;<sup>?</sup> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#type-instance_method" title="#type (instance method)">#<strong>type</strong> &#x21d2; String </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></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="#cached_platform_list-class_method" title="cached_platform_list (class method)">.<strong>cached_platform_list</strong>(platform_string) &#x21d2; Msf::Module::PlatformList<sup>?</sup> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Retrieve or build a cached PlatformList for the given platform string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#dedup_notes-class_method" title="dedup_notes (class method)">.<strong>dedup_notes</strong>(notes) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Deduplicate notes hash keys and string values via the frozen string table.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#dedup_string-class_method" title="dedup_string (class method)">.<strong>dedup_string</strong>(str) &#x21d2; String<sup>?</sup> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Deduplicate a string via Rubys built-in frozen string table (fstring).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#from_hash-class_method" title="from_hash (class method)">.<strong>from_hash</strong>(obj_hash) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Initialize this object from a hash.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(module_instance, obj_hash = nil) &#x21d2; Obj </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of Obj.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#path-instance_method" title="#path (instance method)">#<strong>path</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_json-instance_method" title="#to_json (instance method)">#<strong>to_json</strong>(*args) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the JSON representation of the module metadata.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update_mod_time-instance_method" title="#update_mod_time (instance method)">#<strong>update_mod_time</strong>(mod_time) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></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>(module_instance, obj_hash = nil) &#x21d2; <tt><span class='object_link'><a href="" title="Msf::Modules::Metadata::Obj (class)">Obj</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Obj.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 133</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_module_instance'>module_instance</span><span class='comma'>,</span> <span class='id identifier rubyid_obj_hash'>obj_hash</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_obj_hash'>obj_hash</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_init_from_hash'>init_from_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_obj_hash'>obj_hash</span><span class='rparen'>)</span>
<span class='kw'>return</span>
<span class='kw'>end</span>
<span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
<span class='ivar'>@fullname</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_realname'>realname</span>
<span class='ivar'>@aliases</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_aliases'>aliases</span>
<span class='ivar'>@disclosure_date</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_disclosure_date'>disclosure_date</span>
<span class='ivar'>@rank</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_rank'>rank</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='ivar'>@type</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span>
<span class='ivar'>@description</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_description'>description</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span>
<span class='ivar'>@author</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_author'>author</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_x'>x</span><span class='op'>|</span> <span class='id identifier rubyid_x'>x</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbrace'>}</span>
<span class='ivar'>@references</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_references'>references</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_x'>x</span><span class='op'>|</span> <span class='lbracket'>[</span><span class='id identifier rubyid_x'>x</span><span class='period'>.</span><span class='id identifier rubyid_ctx_id'>ctx_id</span><span class='comma'>,</span> <span class='id identifier rubyid_x'>x</span><span class='period'>.</span><span class='id identifier rubyid_ctx_val'>ctx_val</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_join'><span class='object_link'><a href="../../../top-level-namespace.html#join-instance_method" title="#join (method)">join</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='ivar'>@post_auth</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_post_auth?'>post_auth?</span>
<span class='ivar'>@default_credential</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_default_cred?'>default_cred?</span>
<span class='ivar'>@platform</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_platform_to_s'>platform_to_s</span>
<span class='ivar'>@platform_list</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_platform'>platform</span>
<span class='comment'># Done to ensure that differences do not show up for the same array grouping
</span> <span class='id identifier rubyid_sort_platform_string'>sort_platform_string</span>
<span class='ivar'>@arch</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_arch_to_s'>arch_to_s</span>
<span class='ivar'>@rport</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</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'>RPORT</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
<span class='ivar'>@path</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_file_path'>file_path</span>
<span class='ivar'>@mod_time</span> <span class='op'>=</span> <span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_mtime'>mtime</span><span class='lparen'>(</span><span class='ivar'>@path</span><span class='rparen'>)</span> <span class='kw'>rescue</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span>
<span class='ivar'>@ref_name</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_refname'>refname</span>
<span class='ivar'>@needs_cleanup</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:needs_cleanup</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_needs_cleanup'>needs_cleanup</span>
<span class='kw'>if</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:actions</span><span class='rparen'>)</span>
<span class='ivar'>@actions</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_actions'>actions</span><span class='period'>.</span><span class='id identifier rubyid_sort_by'>sort_by</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:name</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_action'>action</span><span class='op'>|</span>
<span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>name</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>description</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_description'>description</span>
<span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:autofilter_ports</span><span class='rparen'>)</span>
<span class='ivar'>@autofilter_ports</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_autofilter_ports'>autofilter_ports</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:autofilter_services</span><span class='rparen'>)</span>
<span class='ivar'>@autofilter_services</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_autofilter_services'>autofilter_services</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_install_path'>install_path</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="../../Config.html" title="Msf::Config (class)">Config</a></span></span><span class='period'>.</span><span class='id identifier rubyid_install_root'><span class='object_link'><a href="../../Config.html#install_root-class_method" title="Msf::Config.install_root (method)">install_root</a></span></span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>if</span> <span class='lparen'>(</span><span class='ivar'>@path</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='lparen'>(</span><span class='id identifier rubyid_install_path'>install_path</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='ivar'>@path</span> <span class='op'>=</span> <span class='ivar'>@path</span><span class='period'>.</span><span class='id identifier rubyid_sub'>sub</span><span class='lparen'>(</span><span class='id identifier rubyid_install_path'>install_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='ivar'>@is_install_path</span> <span class='op'>=</span> <span class='kw'>true</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:targets</span><span class='rparen'>)</span> <span class='kw'>and</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_targets'>targets</span>
<span class='ivar'>@targets</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_targets'>targets</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_x'>x</span><span class='op'>|</span> <span class='id identifier rubyid_x'>x</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='comment'># Store whether a module has a check method
</span> <span class='ivar'>@check</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_has_check?'>has_check?</span>
<span class='ivar'>@notes</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_notes'>notes</span>
<span class='ivar'>@session_types</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:session_types</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_session_types'>session_types</span>
<span class='kw'>if</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:payload_type</span><span class='rparen'>)</span>
<span class='ivar'>@payload_type</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_payload_type'>payload_type</span>
<span class='ivar'>@staged</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_staged?'>staged?</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='ivar'>@staged</span>
<span class='ivar'>@stage_refname</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_stage_refname'>stage_refname</span>
<span class='ivar'>@stager_refname</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_stager_refname'>stager_refname</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='ivar'>@payload_type</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="../../Payload.html" title="Msf::Payload (class)">Payload</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Payload/Type.html" title="Msf::Payload::Type (module)">Type</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Payload/Type.html#Adapter-constant" title="Msf::Payload::Type::Adapter (constant)">Adapter</a></span></span>
<span class='ivar'>@adapter_refname</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_adapter_refname'>adapter_refname</span>
<span class='ivar'>@adapted_refname</span> <span class='op'>=</span> <span class='id identifier rubyid_module_instance'>module_instance</span><span class='period'>.</span><span class='id identifier rubyid_adapted_refname'>adapted_refname</span>
<span class='kw'>end</span>
<span class='comment'># Due to potentially non-standard ASCII we force UTF-8 to ensure no problem with JSON serialization
</span> <span class='id identifier rubyid_force_encoding'>force_encoding</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>Encoding</span><span class='op'>::</span><span class='const'>UTF_8</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="actions-instance_method">
#<strong>actions</strong> &#x21d2; <tt>Hash</tt> <span class="extras">(readonly)</span>
</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>Hash</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
69
70
71</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 69</span>
<span class='kw'>def</span> <span class='id identifier rubyid_actions'>actions</span>
<span class='ivar'>@actions</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="adapted_refname-instance_method">
#<strong>adapted_refname</strong> &#x21d2; <tt>String</tt><sup>?</sup> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Name of the adapted payload if applicable.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>Name of the adapted payload if applicable</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
125
126
127</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 125</span>
<span class='kw'>def</span> <span class='id identifier rubyid_adapted_refname'>adapted_refname</span>
<span class='ivar'>@adapted_refname</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="adapter_refname-instance_method">
#<strong>adapter_refname</strong> &#x21d2; <tt>String</tt><sup>?</sup> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Name of the adapter if applicable.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>Name of the adapter if applicable</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
123
124
125</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 123</span>
<span class='kw'>def</span> <span class='id identifier rubyid_adapter_refname'>adapter_refname</span>
<span class='ivar'>@adapter_refname</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="aliases-instance_method">
#<strong>aliases</strong> &#x21d2; <tt>Array&lt;String&gt;</tt> <span class="extras">(readonly)</span>
</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>Array&lt;String&gt;</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
75
76
77</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 75</span>
<span class='kw'>def</span> <span class='id identifier rubyid_aliases'>aliases</span>
<span class='ivar'>@aliases</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="arch-instance_method">
#<strong>arch</strong> &#x21d2; <tt>String</tt> <span class="extras">(readonly)</span>
</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>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
93
94
95</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 93</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=""></span>
<div class="method_details ">
<h3 class="signature " id="author-instance_method">
#<strong>author</strong> &#x21d2; <tt>Array&lt;String&gt;</tt> <span class="extras">(readonly)</span>
</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>Array&lt;String&gt;</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
83
84
85</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 83</span>
<span class='kw'>def</span> <span class='id identifier rubyid_author'>author</span>
<span class='ivar'>@author</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="autofilter_ports-instance_method">
#<strong>autofilter_ports</strong> &#x21d2; <tt>Array&lt;Integer&gt;</tt> <span class="extras">(readonly)</span>
</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>Array&lt;Integer&gt;</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
97
98
99</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 97</span>
<span class='kw'>def</span> <span class='id identifier rubyid_autofilter_ports'>autofilter_ports</span>
<span class='ivar'>@autofilter_ports</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="autofilter_services-instance_method">
#<strong>autofilter_services</strong> &#x21d2; <tt>Array&lt;String&gt;</tt> <span class="extras">(readonly)</span>
</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>Array&lt;String&gt;</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
99
100
101</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 99</span>
<span class='kw'>def</span> <span class='id identifier rubyid_autofilter_services'>autofilter_services</span>
<span class='ivar'>@autofilter_services</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="check-instance_method">
#<strong>check</strong> &#x21d2; <tt>Boolean</tt> <span class="extras">(readonly)</span>
</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">
109
110
111</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 109</span>
<span class='kw'>def</span> <span class='id identifier rubyid_check'>check</span>
<span class='ivar'>@check</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="default_credential-instance_method">
#<strong>default_credential</strong> &#x21d2; <tt>Boolean</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='default_cred?-instance_method'>default_cred?</span></span>
</span>
</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">
114
115
116</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 114</span>
<span class='kw'>def</span> <span class='id identifier rubyid_default_credential'>default_credential</span>
<span class='ivar'>@default_credential</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="description-instance_method">
#<strong>description</strong> &#x21d2; <tt>String</tt> <span class="extras">(readonly)</span>
</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>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
85
86
87</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 85</span>
<span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
<span class='ivar'>@description</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="disclosure_date-instance_method">
#<strong>disclosure_date</strong> &#x21d2; <tt>Date</tt> <span class="extras">(readonly)</span>
</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>Date</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
79
80
81</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 79</span>
<span class='kw'>def</span> <span class='id identifier rubyid_disclosure_date'>disclosure_date</span>
<span class='ivar'>@disclosure_date</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="fullname-instance_method">
#<strong>fullname</strong> &#x21d2; <tt>String</tt> <span class="extras">(readonly)</span>
</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>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
73
74
75</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 73</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fullname'>fullname</span>
<span class='ivar'>@fullname</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="is_install_path-instance_method">
#<strong>is_install_path</strong> &#x21d2; <tt>Boolean</tt> <span class="extras">(readonly)</span>
</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">
105
106
107</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 105</span>
<span class='kw'>def</span> <span class='id identifier rubyid_is_install_path'>is_install_path</span>
<span class='ivar'>@is_install_path</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="mod_time-instance_method">
#<strong>mod_time</strong> &#x21d2; <tt>Time</tt> <span class="extras">(readonly)</span>
</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>Time</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
103
104
105</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 103</span>
<span class='kw'>def</span> <span class='id identifier rubyid_mod_time'>mod_time</span>
<span class='ivar'>@mod_time</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="name-instance_method">
#<strong>name</strong> &#x21d2; <tt>String</tt> <span class="extras">(readonly)</span>
</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>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
71
72
73</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 71</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=""></span>
<div class="method_details ">
<h3 class="signature " id="notes-instance_method">
#<strong>notes</strong> &#x21d2; <tt>Hash</tt> <span class="extras">(readonly)</span>
</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>Hash</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
117
118
119</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 117</span>
<span class='kw'>def</span> <span class='id identifier rubyid_notes'>notes</span>
<span class='ivar'>@notes</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="payload_type-instance_method">
#<strong>payload_type</strong> &#x21d2; <tt>Integer</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The type of payload, e.g. Single, Stager, Adapter.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>The type of payload, e.g. Single, Stager, Adapter</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
121
122
123</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 121</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_type'>payload_type</span>
<span class='ivar'>@payload_type</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="platform-instance_method">
#<strong>platform</strong> &#x21d2; <tt>String</tt> <span class="extras">(readonly)</span>
</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>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
89
90
91</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 89</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=""></span>
<div class="method_details ">
<h3 class="signature " id="platform_list-instance_method">
#<strong>platform_list</strong> &#x21d2; <tt><span class='object_link'><a href="../../Module/PlatformList.html" title="Msf::Module::PlatformList (class)">Msf::Module::PlatformList</a></span></tt> <span class="extras">(readonly)</span>
</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><span class='object_link'><a href="../../Module/PlatformList.html" title="Msf::Module::PlatformList (class)">Msf::Module::PlatformList</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
91
92
93</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 91</span>
<span class='kw'>def</span> <span class='id identifier rubyid_platform_list'>platform_list</span>
<span class='ivar'>@platform_list</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="post_auth-instance_method">
#<strong>post_auth</strong> &#x21d2; <tt>Boolean</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='post_auth?-instance_method'>post_auth?</span></span>
</span>
</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">
111
112
113</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 111</span>
<span class='kw'>def</span> <span class='id identifier rubyid_post_auth'>post_auth</span>
<span class='ivar'>@post_auth</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="rank-instance_method">
#<strong>rank</strong> &#x21d2; <tt>Integer</tt> <span class="extras">(readonly)</span>
</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>Integer</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
77
78
79</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 77</span>
<span class='kw'>def</span> <span class='id identifier rubyid_rank'>rank</span>
<span class='ivar'>@rank</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="ref_name-instance_method">
#<strong>ref_name</strong> &#x21d2; <tt>String</tt> <span class="extras">(readonly)</span>
</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>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
107
108
109</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 107</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ref_name'>ref_name</span>
<span class='ivar'>@ref_name</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="references-instance_method">
#<strong>references</strong> &#x21d2; <tt>Array&lt;String&gt;</tt> <span class="extras">(readonly)</span>
</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>Array&lt;String&gt;</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
87
88
89</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 87</span>
<span class='kw'>def</span> <span class='id identifier rubyid_references'>references</span>
<span class='ivar'>@references</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="rport-instance_method">
#<strong>rport</strong> &#x21d2; <tt>Integer</tt> <span class="extras">(readonly)</span>
</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>Integer</tt>)</span>
</li>
</ul>
</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/modules/metadata/obj.rb', line 95</span>
<span class='kw'>def</span> <span class='id identifier rubyid_rport'>rport</span>
<span class='ivar'>@rport</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="session_types-instance_method">
#<strong>session_types</strong> &#x21d2; <tt>Array&lt;String&gt;</tt> <span class="extras">(readonly)</span>
</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>Array&lt;String&gt;</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
119
120
121</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 119</span>
<span class='kw'>def</span> <span class='id identifier rubyid_session_types'>session_types</span>
<span class='ivar'>@session_types</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="stage_refname-instance_method">
#<strong>stage_refname</strong> &#x21d2; <tt>String</tt><sup>?</sup> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Name of the stage if applicable.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>Name of the stage if applicable</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
129
130
131</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 129</span>
<span class='kw'>def</span> <span class='id identifier rubyid_stage_refname'>stage_refname</span>
<span class='ivar'>@stage_refname</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="staged-instance_method">
#<strong>staged</strong> &#x21d2; <tt>Boolean</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether or not the payload is staged.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'>
<p>Whether or not the payload is staged</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
127
128
129</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 127</span>
<span class='kw'>def</span> <span class='id identifier rubyid_staged'>staged</span>
<span class='ivar'>@staged</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="stager_refname-instance_method">
#<strong>stager_refname</strong> &#x21d2; <tt>String</tt><sup>?</sup> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Name of the stager if applicable.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>Name of the stager if applicable</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
131
132
133</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 131</span>
<span class='kw'>def</span> <span class='id identifier rubyid_stager_refname'>stager_refname</span>
<span class='ivar'>@stager_refname</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="targets-instance_method">
#<strong>targets</strong> &#x21d2; <tt>Array&lt;String&gt;</tt><sup>?</sup> <span class="extras">(readonly)</span>
</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>Array&lt;String&gt;</tt>, <tt>nil</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
101
102
103</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 101</span>
<span class='kw'>def</span> <span class='id identifier rubyid_targets'>targets</span>
<span class='ivar'>@targets</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="type-instance_method">
#<strong>type</strong> &#x21d2; <tt>String</tt> <span class="extras">(readonly)</span>
</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>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
81
82
83</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 81</span>
<span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
<span class='ivar'>@type</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="cached_platform_list-class_method">
.<strong>cached_platform_list</strong>(platform_string) &#x21d2; <tt><span class='object_link'><a href="../../Module/PlatformList.html" title="Msf::Module::PlatformList (class)">Msf::Module::PlatformList</a></span></tt><sup>?</sup>
</h3><div class="docstring">
<div class="discussion">
<p>Retrieve or build a cached PlatformList for the given platform string.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>platform_string</span>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../../Module/PlatformList.html" title="Msf::Module::PlatformList (class)">Msf::Module::PlatformList</a></span></tt>, <tt>nil</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
33
34
35
36
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 33</span>
<span class='kw'>def</span> <span class='id identifier rubyid_cached_platform_list'>cached_platform_list</span><span class='lparen'>(</span><span class='id identifier rubyid_platform_string'>platform_string</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_platform_string'>platform_string</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='ivar'>@platform_list_cache</span><span class='lbracket'>[</span><span class='id identifier rubyid_platform_string'>platform_string</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='id identifier rubyid_build_platform_list'>build_platform_list</span><span class='lparen'>(</span><span class='id identifier rubyid_platform_string'>platform_string</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="dedup_notes-class_method">
.<strong>dedup_notes</strong>(notes) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Deduplicate notes hash keys and string values via the frozen string table. Keys like “Stability”, “SideEffects”, “Reliability” repeat across thousands of modules; values like “crash-safe”, “ioc-in-logs” repeat hundreds of times.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
42
43
44
45
46
47
48
49
50
51
52
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 42</span>
<span class='kw'>def</span> <span class='id identifier rubyid_dedup_notes'>dedup_notes</span><span class='lparen'>(</span><span class='id identifier rubyid_notes'>notes</span><span class='rparen'>)</span>
<span class='id identifier rubyid_notes'>notes</span><span class='period'>.</span><span class='id identifier rubyid_each_with_object'>each_with_object</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='lparen'>(</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_h'>h</span><span class='op'>|</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span><span class='op'>-</span><span class='id identifier rubyid_k'>k</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>case</span> <span class='id identifier rubyid_v'>v</span>
<span class='kw'>when</span> <span class='const'>Array</span>
<span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_e'>e</span><span class='op'>|</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='op'>-</span><span class='id identifier rubyid_e'>e</span> <span class='op'>:</span> <span class='id identifier rubyid_e'>e</span> <span class='rbrace'>}</span>
<span class='kw'>when</span> <span class='const'>String</span>
<span class='op'>-</span><span class='id identifier rubyid_v'>v</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_v'>v</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="dedup_string-class_method">
.<strong>dedup_string</strong>(str) &#x21d2; <tt>String</tt><sup>?</sup>
</h3><div class="docstring">
<div class="discussion">
<p>Deduplicate a string via Rubys built-in frozen string table (fstring). Identical string contents will share a single frozen object in memory, reducing heap usage for highly repeated values like type, platform, arch, and author.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>str</span>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>the string to intern</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>a frozen, deduplicated copy of the string, or nil</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
24
25
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_dedup_string'>dedup_string</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_str'>str</span> <span class='kw'>unless</span> <span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span>
<span class='op'>-</span><span class='id identifier rubyid_str'>str</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="from_hash-class_method">
.<strong>from_hash</strong>(obj_hash) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initialize this object from a hash</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
266
267
268</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 266</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_hash'>from_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_obj_hash'>obj_hash</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='const'><span class='object_link'><a href="" title="Msf::Modules::Metadata::Obj (class)">Obj</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Msf::Modules::Metadata::Obj#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_obj_hash'>obj_hash</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="path-instance_method">
#<strong>path</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
274
275
276
277
278
279
280</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 274</span>
<span class='kw'>def</span> <span class='id identifier rubyid_path'>path</span>
<span class='kw'>if</span> <span class='ivar'>@is_install_path</span>
<span class='kw'>return</span> <span class='ivar'>@full_path</span> <span class='op'>||=</span> <span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</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="../../Config.html" title="Msf::Config (class)">Config</a></span></span><span class='period'>.</span><span class='id identifier rubyid_install_root'><span class='object_link'><a href="../../Config.html#install_root-class_method" title="Msf::Config.install_root (method)">install_root</a></span></span><span class='comma'>,</span> <span class='ivar'>@path</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='ivar'>@path</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_json-instance_method">
#<strong>to_json</strong>(*args) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the JSON representation of the module metadata</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 216</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_json'>to_json</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>name</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@name</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>fullname</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@fullname</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>aliases</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@aliases</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>rank</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@rank</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>disclosure_date</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@disclosure_date</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='kw'>nil</span> <span class='op'>:</span> <span class='ivar'>@disclosure_date</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>type</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@type</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>author</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@author</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>description</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@description</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>references</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@references</span><span class='comma'>,</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='op'>=&gt;</span> <span class='ivar'>@platform</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='op'>=&gt;</span> <span class='ivar'>@arch</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>rport</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@rport</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>autofilter_ports</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@autofilter_ports</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>autofilter_services</span><span class='tstring_end'>&#39;</span></span><span class='op'>=&gt;</span> <span class='ivar'>@autofilter_services</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>targets</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@targets</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mod_time</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@mod_time</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>path</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@path</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>is_install_path</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@is_install_path</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ref_name</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@ref_name</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>check</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@check</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>post_auth</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@post_auth</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>default_credential</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@default_credential</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>notes</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@notes</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>session_types</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@session_types</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>needs_cleanup</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@needs_cleanup</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>actions</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@actions</span> <span class='kw'>if</span> <span class='ivar'>@actions</span>
<span class='kw'>if</span> <span class='ivar'>@payload_type</span>
<span class='id identifier rubyid_payload_data'>payload_data</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>payload_type</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@payload_type</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>adapter_refname</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@adapter_refname</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>adapted_refname</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@adapted_refname</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>adapted</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@adapted</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>staged</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@staged</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stage_refname</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@stage_refname</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stager_refname</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@stager_refname</span><span class='comma'>,</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_payload_data'>payload_data</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="update_mod_time-instance_method">
#<strong>update_mod_time</strong>(mod_time) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
270
271
272</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/modules/metadata/obj.rb', line 270</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update_mod_time'>update_mod_time</span><span class='lparen'>(</span><span class='id identifier rubyid_mod_time'>mod_time</span><span class='rparen'>)</span>
<span class='ivar'>@mod_time</span> <span class='op'>=</span> <span class='id identifier rubyid_mod_time'>mod_time</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:03:31 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>