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

1033 lines
47 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Msf::FeatureManager
&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::FeatureManager";
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 (F)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Msf.html" title="Msf (module)">Msf</a></span></span>
&raquo;
<span class="title">FeatureManager</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::FeatureManager
</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::FeatureManager</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd>Singleton</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/feature_manager.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>The feature manager is responsible for managing feature flags that can change characteristics of framework. Each feature will have a default value. The user can choose to override this default value if they wish.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="CONFIG_KEY-constant" class="">CONFIG_KEY =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>framework/features</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="WRAPPED_TABLES-constant" class="">WRAPPED_TABLES =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wrapped_tables</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="FULLY_INTERACTIVE_SHELLS-constant" class="">FULLY_INTERACTIVE_SHELLS =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>fully_interactive_shells</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="MANAGER_COMMANDS-constant" class="">MANAGER_COMMANDS =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>manager_commands</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="METASPLOIT_PAYLOAD_WARNINGS-constant" class="">METASPLOIT_PAYLOAD_WARNINGS =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>metasploit_payload_warnings</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="DEFER_MODULE_LOADS-constant" class="">DEFER_MODULE_LOADS =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>defer_module_loads</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="DNS-constant" class="">DNS =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>dns</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="HIERARCHICAL_SEARCH_TABLE-constant" class="">HIERARCHICAL_SEARCH_TABLE =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hierarchical_search_table</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="SMB_SESSION_TYPE-constant" class="">SMB_SESSION_TYPE =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>smb_session_type</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="POSTGRESQL_SESSION_TYPE-constant" class="">POSTGRESQL_SESSION_TYPE =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>postgresql_session_type</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="MYSQL_SESSION_TYPE-constant" class="">MYSQL_SESSION_TYPE =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mysql_session_type</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="MSSQL_SESSION_TYPE-constant" class="">MSSQL_SESSION_TYPE =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mssql_session_type</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="LDAP_SESSION_TYPE-constant" class="">LDAP_SESSION_TYPE =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ldap_session_type</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="SHOW_SUCCESSFUL_LOGINS-constant" class="">SHOW_SUCCESSFUL_LOGINS =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>show_successful_logins</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="DISPLAY_MODULE_ACTION-constant" class="">DISPLAY_MODULE_ACTION =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>display_module_action</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="DEFAULTS-constant" class="">DEFAULTS =
</dt>
<dd><pre class="code"><span class='lbracket'>[</span>
<span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='const'><span class='object_link'><a href="#WRAPPED_TABLES-constant" title="Msf::FeatureManager::WRAPPED_TABLES (constant)">WRAPPED_TABLES</a></span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>When enabled Metasploit will wordwrap all tables to fit into the available terminal width</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>default_value:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>developer_notes:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>This functionality is enabled by default now, and the feature flag can be removed now</span><span class='tstring_end'>&#39;</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='comma'>,</span>
<span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='const'><span class='object_link'><a href="#FULLY_INTERACTIVE_SHELLS-constant" title="Msf::FeatureManager::FULLY_INTERACTIVE_SHELLS (constant)">FULLY_INTERACTIVE_SHELLS</a></span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>When enabled you will have the option to drop into a fully interactive shell from within meterpreter</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>default_value:</span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='label'>developer_notes:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Development paused as the interaction time feels clunky, especially for slow transport layers like HTTP on Mettle. Would require changes to the transport sleep/priority logic</span><span class='tstring_end'>&#39;</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='comma'>,</span>
<span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='const'><span class='object_link'><a href="#MANAGER_COMMANDS-constant" title="Msf::FeatureManager::MANAGER_COMMANDS (constant)">MANAGER_COMMANDS</a></span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>When enabled you will have access to manager commands such as _servicemanager and _historymanager</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>default_value:</span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='label'>developer_notes:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Useful for developers, likely not to ever be useful for an average user</span><span class='tstring_end'>&#39;</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='comma'>,</span>
<span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='const'><span class='object_link'><a href="#METASPLOIT_PAYLOAD_WARNINGS-constant" title="Msf::FeatureManager::METASPLOIT_PAYLOAD_WARNINGS (constant)">METASPLOIT_PAYLOAD_WARNINGS</a></span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>When enabled Metasploit will output warnings about missing Metasploit payloads, for instance if they were removed by antivirus etc</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>requires_restart:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>default_value:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>developer_notes:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Enabled in Metasploit 6.4.x</span><span class='tstring_end'>&#39;</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='comma'>,</span>
<span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='const'><span class='object_link'><a href="#DEFER_MODULE_LOADS-constant" title="Msf::FeatureManager::DEFER_MODULE_LOADS (constant)">DEFER_MODULE_LOADS</a></span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>When enabled will not eagerly load all modules</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>requires_restart:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>default_value:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>developer_notes:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Enabled in Metasploit 6.4.x</span><span class='tstring_end'>&#39;</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='comma'>,</span>
<span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='const'><span class='object_link'><a href="#SMB_SESSION_TYPE-constant" title="Msf::FeatureManager::SMB_SESSION_TYPE (constant)">SMB_SESSION_TYPE</a></span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>When enabled will allow for the creation/use of smb sessions</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>requires_restart:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>default_value:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>developer_notes:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Enabled in Metasploit 6.4.x</span><span class='tstring_end'>&#39;</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='comma'>,</span>
<span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='const'><span class='object_link'><a href="#POSTGRESQL_SESSION_TYPE-constant" title="Msf::FeatureManager::POSTGRESQL_SESSION_TYPE (constant)">POSTGRESQL_SESSION_TYPE</a></span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>When enabled will allow for the creation/use of PostgreSQL sessions</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>requires_restart:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>default_value:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>developer_notes:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Enabled in Metasploit 6.4.x</span><span class='tstring_end'>&#39;</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='comma'>,</span>
<span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='const'><span class='object_link'><a href="#MYSQL_SESSION_TYPE-constant" title="Msf::FeatureManager::MYSQL_SESSION_TYPE (constant)">MYSQL_SESSION_TYPE</a></span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>When enabled will allow for the creation/use of MySQL sessions</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>requires_restart:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>default_value:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>developer_notes:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Enabled in Metasploit 6.4.x</span><span class='tstring_end'>&#39;</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='comma'>,</span>
<span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='const'><span class='object_link'><a href="#MSSQL_SESSION_TYPE-constant" title="Msf::FeatureManager::MSSQL_SESSION_TYPE (constant)">MSSQL_SESSION_TYPE</a></span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>When enabled will allow for the creation/use of mssql sessions</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>requires_restart:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>default_value:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>developer_notes:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Enabled in Metasploit 6.4.x</span><span class='tstring_end'>&#39;</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='comma'>,</span>
<span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='const'><span class='object_link'><a href="#LDAP_SESSION_TYPE-constant" title="Msf::FeatureManager::LDAP_SESSION_TYPE (constant)">LDAP_SESSION_TYPE</a></span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>When enabled will allow for the creation/use of LDAP sessions</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>requires_restart:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>default_value:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>developer_notes:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Enabled in Metasploit 6.4.52</span><span class='tstring_end'>&#39;</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='comma'>,</span>
<span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='const'><span class='object_link'><a href="#SHOW_SUCCESSFUL_LOGINS-constant" title="Msf::FeatureManager::SHOW_SUCCESSFUL_LOGINS (constant)">SHOW_SUCCESSFUL_LOGINS</a></span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>When enabled scanners/login modules will return a table off successful logins once the module completes</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>requires_restart:</span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='label'>default_value:</span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='label'>developer_notes:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>To be enabled after appropriate testing</span><span class='tstring_end'>&#39;</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='comma'>,</span>
<span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='const'><span class='object_link'><a href="#DNS-constant" title="Msf::FeatureManager::DNS (constant)">DNS</a></span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>When enabled allows configuration of DNS resolution behaviour in Metasploit</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>requires_restart:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>default_value:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>developer_notes:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Enabled in Metasploit 6.4.x</span><span class='tstring_end'>&#39;</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='comma'>,</span>
<span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='const'><span class='object_link'><a href="#HIERARCHICAL_SEARCH_TABLE-constant" title="Msf::FeatureManager::HIERARCHICAL_SEARCH_TABLE (constant)">HIERARCHICAL_SEARCH_TABLE</a></span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>When enabled the search table is enhanced to show details on module actions and targets</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>requires_restart:</span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='label'>default_value:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>developer_notes:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Enabled in Metasploit 6.4.x</span><span class='tstring_end'>&#39;</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='comma'>,</span>
<span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='const'><span class='object_link'><a href="#DISPLAY_MODULE_ACTION-constant" title="Msf::FeatureManager::DISPLAY_MODULE_ACTION (constant)">DISPLAY_MODULE_ACTION</a></span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>When enabled after using a module the current action and number of actions will be displayed</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>requires_restart:</span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='label'>default_value:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>developer_notes:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Added as a feature so users can turn it off if they wish to reduce clutter in their terminal</span><span class='tstring_end'>&#39;</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
<span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
</dl>
<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="#all-instance_method" title="#all (instance method)">#<strong>all</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#enabled%3F-instance_method" title="#enabled? (instance method)">#<strong>enabled?</strong>(name) &#x21d2; TrueClass, FalseClass </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>True if the flag is be enabled, false otherwise.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#exists%3F-instance_method" title="#exists? (instance method)">#<strong>exists?</strong>(name) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> &#x21d2; FeatureManager </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Initializes the feature manager.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#load_config-instance_method" title="#load_config (instance method)">#<strong>load_config</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#names-instance_method" title="#names (instance method)">#<strong>names</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#requires_restart%3F-instance_method" title="#requires_restart? (instance method)">#<strong>requires_restart?</strong>(name) &#x21d2; TrueClass, FalseClass </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>True if the flag requires a console restart to work effectively.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#save_config-instance_method" title="#save_config (instance method)">#<strong>save_config</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#set-instance_method" title="#set (instance method)">#<strong>set</strong>(name, value) &#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> &#x21d2; <tt><span class='object_link'><a href="" title="Msf::FeatureManager (class)">FeatureManager</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initializes the feature manager.</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</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/feature_manager.rb', line 133</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
<span class='ivar'>@flag_lookup</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#DEFAULTS-constant" title="Msf::FeatureManager::DEFAULTS (constant)">DEFAULTS</a></span></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='id identifier rubyid_feature'>feature</span><span class='comma'>,</span> <span class='id identifier rubyid_acc'>acc</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='id identifier rubyid_feature'>feature</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="#WRAPPED_TABLES-constant" title="Msf::FeatureManager::WRAPPED_TABLES (constant)">WRAPPED_TABLES</a></span></span>
<span class='kw'>if</span> <span class='id identifier rubyid_feature'>feature</span><span class='lbracket'>[</span><span class='symbol'>:default_value</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='kw'>true</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'>Text</span><span class='op'>::</span><span class='const'>Table</span><span class='period'>.</span><span class='id identifier rubyid_wrap_tables!'>wrap_tables!</span>
<span class='kw'>else</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'>Text</span><span class='op'>::</span><span class='const'>Table</span><span class='period'>.</span><span class='id identifier rubyid_unwrap_tables!'>unwrap_tables!</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_key'>key</span> <span class='op'>=</span> <span class='id identifier rubyid_feature'>feature</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_acc'>acc</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_feature'>feature</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
<span class='kw'>end</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="all-instance_method">
#<strong>all</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
148
149
150
151
152</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/feature_manager.rb', line 148</span>
<span class='kw'>def</span> <span class='id identifier rubyid_all'>all</span>
<span class='ivar'>@flag_lookup</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</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_feature'>feature</span><span class='op'>|</span>
<span class='id identifier rubyid_feature'>feature</span><span class='period'>.</span><span class='id identifier rubyid_slice'>slice</span><span class='lparen'>(</span><span class='symbol'>:name</span><span class='comma'>,</span> <span class='symbol'>:description</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>enabled:</span> <span class='id identifier rubyid_enabled?'>enabled?</span><span class='lparen'>(</span><span class='id identifier rubyid_feature'>feature</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="enabled?-instance_method">
#<strong>enabled?</strong>(name) &#x21d2; <tt>TrueClass</tt>, <tt>FalseClass</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns True if the flag is be enabled, false otherwise.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The feature name</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>TrueClass</tt>, <tt>FalseClass</tt>)</span>
&mdash;
<div class='inline'>
<p>True if the flag is be enabled, false otherwise</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
156
157
158
159
160
161</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/feature_manager.rb', line 156</span>
<span class='kw'>def</span> <span class='id identifier rubyid_enabled?'>enabled?</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='ivar'>@flag_lookup</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_feature'>feature</span> <span class='op'>=</span> <span class='ivar'>@flag_lookup</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_feature'>feature</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:user_preference</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_feature'>feature</span><span class='lbracket'>[</span><span class='symbol'>:user_preference</span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='id identifier rubyid_feature'>feature</span><span class='lbracket'>[</span><span class='symbol'>:default_value</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="exists?-instance_method">
#<strong>exists?</strong>(name) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
171
172
173</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/feature_manager.rb', line 171</span>
<span class='kw'>def</span> <span class='id identifier rubyid_exists?'>exists?</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
<span class='ivar'>@flag_lookup</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="load_config-instance_method">
#<strong>load_config</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
193
194
195
196
197
198</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/feature_manager.rb', line 193</span>
<span class='kw'>def</span> <span class='id identifier rubyid_load_config'>load_config</span>
<span class='id identifier rubyid_conf'>conf</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_load'><span class='object_link'><a href="Config.html#load-class_method" title="Msf::Config.load (method)">load</a></span></span>
<span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#CONFIG_KEY-constant" title="Msf::FeatureManager::CONFIG_KEY (constant)">CONFIG_KEY</a></span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
<span class='id identifier rubyid_set'>set</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>true</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="names-instance_method">
#<strong>names</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
175
176
177</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/feature_manager.rb', line 175</span>
<span class='kw'>def</span> <span class='id identifier rubyid_names'>names</span>
<span class='id identifier rubyid_all'>all</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_feature'>feature</span><span class='op'>|</span> <span class='id identifier rubyid_feature'>feature</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="requires_restart?-instance_method">
#<strong>requires_restart?</strong>(name) &#x21d2; <tt>TrueClass</tt>, <tt>FalseClass</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns True if the flag requires a console restart to work effectively.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The feature name</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>TrueClass</tt>, <tt>FalseClass</tt>)</span>
&mdash;
<div class='inline'>
<p>True if the flag requires a console restart to work effectively</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
165
166
167
168
169</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/feature_manager.rb', line 165</span>
<span class='kw'>def</span> <span class='id identifier rubyid_requires_restart?'>requires_restart?</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='ivar'>@flag_lookup</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span>
<span class='ivar'>@flag_lookup</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:requires_restart</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='kw'>true</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="save_config-instance_method">
#<strong>save_config</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
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/feature_manager.rb', line 200</span>
<span class='kw'>def</span> <span class='id identifier rubyid_save_config'>save_config</span>
<span class='comment'># Note, we intentionally omit features that have not explicitly been set by the user.
</span> <span class='id identifier rubyid_config'>config</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_load'><span class='object_link'><a href="Config.html#load-class_method" title="Msf::Config.load (method)">load</a></span></span>
<span class='id identifier rubyid_old_config'>old_config</span> <span class='op'>=</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#CONFIG_KEY-constant" title="Msf::FeatureManager::CONFIG_KEY (constant)">CONFIG_KEY</a></span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_new_config'>new_config</span> <span class='op'>=</span> <span class='ivar'>@flag_lookup</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_each_with_object'>each_with_object</span><span class='lparen'>(</span><span class='id identifier rubyid_old_config'>old_config</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_feature'>feature</span><span class='comma'>,</span> <span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
<span class='kw'>next</span> <span class='kw'>unless</span> <span class='id identifier rubyid_feature'>feature</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:user_preference</span><span class='rparen'>)</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_feature'>feature</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_feature'>feature</span><span class='lbracket'>[</span><span class='symbol'>:user_preference</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
<span class='kw'>end</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_save'><span class='object_link'><a href="Config.html#save-class_method" title="Msf::Config.save (method)">save</a></span></span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#CONFIG_KEY-constant" title="Msf::FeatureManager::CONFIG_KEY (constant)">CONFIG_KEY</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_new_config'>new_config</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="set-instance_method">
#<strong>set</strong>(name, value) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
179
180
181
182
183
184
185
186
187
188
189
190
191</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/feature_manager.rb', line 179</span>
<span class='kw'>def</span> <span class='id identifier rubyid_set'>set</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='ivar'>@flag_lookup</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span>
<span class='ivar'>@flag_lookup</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:user_preference</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="#WRAPPED_TABLES-constant" title="Msf::FeatureManager::WRAPPED_TABLES (constant)">WRAPPED_TABLES</a></span></span>
<span class='kw'>if</span> <span class='id identifier rubyid_value'>value</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'>Text</span><span class='op'>::</span><span class='const'>Table</span><span class='period'>.</span><span class='id identifier rubyid_wrap_tables!'>wrap_tables!</span>
<span class='kw'>else</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'>Text</span><span class='op'>::</span><span class='const'>Table</span><span class='period'>.</span><span class='id identifier rubyid_unwrap_tables!'>unwrap_tables!</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:03:25 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