api/Msf/Module/FullName.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
  Module: Msf::Module::FullName
  
    &mdash; Documentation by YARD 0.9.37
  
</title>

  <link rel="stylesheet" href="../../css/style.css" type="text/css" />

  <link rel="stylesheet" href="../../css/common.css" type="text/css" />

<script type="text/javascript">
  pathId = "Msf::Module::FullName";
  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'><span class='object_link'><a href="../Module.html" title="Msf::Module (class)">Module</a></span></span>
     &raquo; 
    <span class="title">FullName</span>
  
</div>

        <div id="search">
  
    <a class="full_list_link" id="class_list_link"
        href="../../class_list.html">

        <svg width="24" height="24">
          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
        </svg>
    </a>
  
</div>
        <div class="clear"></div>
      </div>

      <div id="content"><h1>Module: Msf::Module::FullName
  
  
</h1>
<div class="box_info">
  

  <dl>
      <dt>Extended by:</dt>
      <dd>ActiveSupport::Concern</dd>
  </dl>
  
  
  <dl>
    <dt>Included in:</dt>
    <dd><span class='object_link'><a href="../Module.html" title="Msf::Module (class)">Msf::Module</a></span></dd>
  </dl>
  

  <dl>
    <dt>Defined in:</dt>
    <dd>lib/msf/core/module/full_name.rb</dd>
  </dl>
  
</div>

<h2>Overview</h2><div class="docstring">
  <div class="discussion">
    
  <div class="note notetag">
    <strong>Note:</strong>
    <div class='inline'>
<p><span class='object_link'><a href="ModuleInfo.html#name-instance_method" title="Msf::Module::ModuleInfo#name (method)">ModuleInfo#name</a></span> is unrelated to <span class='object_link'><a href="#fullname-instance_method" title="Msf::Module::FullName#fullname (method)">#fullname</a></span> and should instead be thought of as the title or summary of the module.</p>
</div>
  </div>


<p>Names related to <span class='object_link'><a href="#fullname-instance_method" title="Msf::Module::FullName#fullname (method)">#fullname</a></span>, such as <span class='object_link'><a href="#fullname-instance_method" title="Msf::Module::FullName#fullname (method)">#fullname</a></span>, <span class='object_link'><a href="#refname-instance_method" title="Msf::Module::FullName#refname (method)">#refname</a></span>, and <span class='object_link'><a href="#shortname-instance_method" title="Msf::Module::FullName#shortname (method)">#shortname</a></span>.</p>


  </div>
</div>
<div class="tags">
  

</div><h2>Defined Under Namespace</h2>
<p class="children">
  
    
      <strong class="modules">Modules:</strong> <span class='object_link'><a href="FullName/ClassMethods.html" title="Msf::Module::FullName::ClassMethods (module)">ClassMethods</a></span>
    
  
</p>


  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
  <ul class="summary">
    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#aliased_as-instance_method" title="#aliased_as (instance method)">#<strong>aliased_as</strong>  &#x21d2; Object </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>Instance Methods.</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="#aliases-instance_method" title="#aliases (instance method)">#<strong>aliases</strong>  &#x21d2; Object </a>
    

  </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; Object </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>Returns the module’s framework full reference name.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#promptname-instance_method" title="#promptname (instance method)">#<strong>promptname</strong>  &#x21d2; Object </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>Returns the module’s framework prompt-friendly name.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#realname-instance_method" title="#realname (instance method)">#<strong>realname</strong>  &#x21d2; Object </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>Always return the module’s framework full reference name, even when the module is aliased.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#refname-instance_method" title="#refname (instance method)">#<strong>refname</strong>  &#x21d2; Object </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>Returns the module’s framework reference name.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#shortname-instance_method" title="#shortname (instance method)">#<strong>shortname</strong>  &#x21d2; Object </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>Returns the module’s framework short name.</p>
</div></span>
  
</li>

      
    </ul>
  

  <div id="instance_attr_details" class="attr_details">
    <h2>Instance Attribute Details</h2>
    
      
      <span id="aliased_as=-instance_method"></span>
      <div class="method_details first">
  <h3 class="signature first" id="aliased_as-instance_method">
  
    #<strong>aliased_as</strong>  &#x21d2; <tt>Object</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Instance Methods</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


55
56
57</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/msf/core/module/full_name.rb', line 55</span>

<span class='kw'>def</span> <span class='id identifier rubyid_aliased_as'>aliased_as</span>
  <span class='ivar'>@aliased_as</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="aliases-instance_method">
  
    #<strong>aliases</strong>  &#x21d2; <tt>Object</tt> 
  

</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


104
105
106</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/msf/core/module/full_name.rb', line 104</span>

<span class='kw'>def</span> <span class='id identifier rubyid_aliases'>aliases</span>
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_aliases'>aliases</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="fullname-instance_method">
  
    #<strong>fullname</strong>  &#x21d2; <tt>Object</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns the module’s framework full reference name.  This is the short name that end-users work with (refname) plus the type of module prepended.  Ex:</p>

<p>payloads/windows/shell/reverse_tcp</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


64
65
66</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/msf/core/module/full_name.rb', line 64</span>

<span class='kw'>def</span> <span class='id identifier rubyid_fullname'>fullname</span>
  <span class='id identifier rubyid_aliased_as'>aliased_as</span> <span class='op'>||</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_fullname'>fullname</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="promptname-instance_method">
  
    #<strong>promptname</strong>  &#x21d2; <tt>Object</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns the module’s framework prompt-friendly name.</p>

<p>windows/shell/reverse_tcp</p>


  </div>
</div>
<div class="tags">
  

</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/module/full_name.rb', line 91</span>

<span class='kw'>def</span> <span class='id identifier rubyid_promptname'>promptname</span>
  <span class='id identifier rubyid_refname'>refname</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="realname-instance_method">
  
    #<strong>realname</strong>  &#x21d2; <tt>Object</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Always return the module’s framework full reference name, even when the module is aliased.</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


72
73
74</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/msf/core/module/full_name.rb', line 72</span>

<span class='kw'>def</span> <span class='id identifier rubyid_realname'>realname</span>
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_fullname'>fullname</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="refname-instance_method">
  
    #<strong>refname</strong>  &#x21d2; <tt>Object</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns the module’s framework reference name.  This is the short name that end-users work with.  Ex:</p>

<p>windows/shell/reverse_tcp</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


82
83
84</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/msf/core/module/full_name.rb', line 82</span>

<span class='kw'>def</span> <span class='id identifier rubyid_refname'>refname</span>
  <span class='id identifier rubyid_fullname'>fullname</span><span class='period'>.</span><span class='id identifier rubyid_delete_prefix'>delete_prefix</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_type'>type</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="shortname-instance_method">
  
    #<strong>shortname</strong>  &#x21d2; <tt>Object</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns the module’s framework short name.</p>

<p>reverse_tcp</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


100
101
102</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/msf/core/module/full_name.rb', line 100</span>

<span class='kw'>def</span> <span class='id identifier rubyid_shortname'>shortname</span>
  <span class='id identifier rubyid_refname'>refname</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
  </div>

</div>

      <div id="footer">
  Generated on Fri May  8 17:01:14 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>