api/Msf/Exploit/CheckCode.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
  Class: Msf::Exploit::CheckCode
  
    &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::Exploit::CheckCode";
  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 (C)</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="../Exploit.html" title="Msf::Exploit (class)">Exploit</a></span></span>
     &raquo; 
    <span class="title">CheckCode</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::Exploit::CheckCode
  
  
</h1>
<div class="box_info">
  
  <dl>
    <dt>Inherits:</dt>
    <dd>
      <span class="inheritName">Struct</span>
      
        <ul class="fullTree">
          <li>Object</li>
          
            <li class="next">Struct</li>
          
            <li class="next">Msf::Exploit::CheckCode</li>
          
        </ul>
        <a href="#" class="inheritanceTree">show all</a>
      
    </dd>
  </dl>
  

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

<h2>Overview</h2><div class="docstring">
  <div class="discussion">
    
<p>The various check codes that can be returned from the “check” routine. Please read the following wiki to learn how these codes are used: <a href="https://docs.metasploit.com/docs/development/developing-modules/guides/how-to-write-a-check-method.html">docs.metasploit.com/docs/development/developing-modules/guides/how-to-write-a-check-method.html</a></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="Unknown-constant" class="">Unknown =
          <div class="docstring">
  <div class="discussion">
    
<p>Can’t tell if the target is exploitable or not. This is recommended if the module fails to retrieve enough information from the target machine, such as due to a timeout.</p>


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

</div>
        </dt>
        <dd><pre class="code"><span class='kw'>self</span><span class='period'>.</span><span class='const'><span class='object_link'><a href="#Unknown-class_method" title="Msf::Exploit::CheckCode.Unknown (method)">Unknown</a></span></span><span class='lparen'>(</span><span class='rparen'>)</span></pre></dd>
      
        <dt id="Safe-constant" class="">Safe =
          <div class="docstring">
  <div class="discussion">
    
<p>The target is safe and is therefore not exploitable. This is recommended after the check fails to trigger the vulnerability, or even detect the service.</p>


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

</div>
        </dt>
        <dd><pre class="code"><span class='kw'>self</span><span class='period'>.</span><span class='const'><span class='object_link'><a href="#Safe-class_method" title="Msf::Exploit::CheckCode.Safe (method)">Safe</a></span></span><span class='lparen'>(</span><span class='rparen'>)</span></pre></dd>
      
        <dt id="Detected-constant" class="">Detected =
          <div class="docstring">
  <div class="discussion">
    
<p>The target is running the service in question, but the check fails to determine whether the target is vulnerable or not.</p>


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

</div>
        </dt>
        <dd><pre class="code"><span class='kw'>self</span><span class='period'>.</span><span class='const'><span class='object_link'><a href="#Detected-class_method" title="Msf::Exploit::CheckCode.Detected (method)">Detected</a></span></span><span class='lparen'>(</span><span class='rparen'>)</span></pre></dd>
      
        <dt id="Appears-constant" class="">Appears =
          <div class="docstring">
  <div class="discussion">
    
<p>The target appears to be vulnerable. This is recommended if the vulnerability is determined based on passive reconnaissance. For example: version, banner grabbing, or having the resource that’s known to be vulnerable.</p>


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

</div>
        </dt>
        <dd><pre class="code"><span class='kw'>self</span><span class='period'>.</span><span class='const'><span class='object_link'><a href="#Appears-class_method" title="Msf::Exploit::CheckCode.Appears (method)">Appears</a></span></span><span class='lparen'>(</span><span class='rparen'>)</span></pre></dd>
      
        <dt id="Vulnerable-constant" class="">Vulnerable =
          <div class="docstring">
  <div class="discussion">
    
<p>The target is vulnerable. Only used if the check is able to actually take advantage of the bug, and obtain hard evidence. For example: executing a command on the target machine, and retrieve the output.</p>


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

</div>
        </dt>
        <dd><pre class="code"><span class='kw'>self</span><span class='period'>.</span><span class='const'><span class='object_link'><a href="#Vulnerable-class_method" title="Msf::Exploit::CheckCode.Vulnerable (method)">Vulnerable</a></span></span><span class='lparen'>(</span><span class='rparen'>)</span></pre></dd>
      
        <dt id="Unsupported-constant" class="">Unsupported =
          <div class="docstring">
  <div class="discussion">
    
<p>The module does not support the check method.</p>


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

</div>
        </dt>
        <dd><pre class="code"><span class='kw'>self</span><span class='period'>.</span><span class='const'><span class='object_link'><a href="#Unsupported-class_method" title="Msf::Exploit::CheckCode.Unsupported (method)">Unsupported</a></span></span><span class='lparen'>(</span><span class='rparen'>)</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="#code-instance_method" title="#code (instance method)">#<strong>code</strong>  &#x21d2; Object </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute code.</p>
</div></span>
  
</li>

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

  </span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute details.</p>
</div></span>
  
</li>

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

  </span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute message.</p>
</div></span>
  
</li>

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

  </span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute reason.</p>
</div></span>
  
</li>

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

  </span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute vuln.</p>
</div></span>
  
</li>

    
  </ul>


    <h2>
      Class Method Summary
      <small><a href="#" class="summary_toggle">collapse</a></small>
    </h2>

    <ul class="summary">
      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#Appears-class_method" title="Appears (class method)">.<strong>Appears</strong>(reason = nil, details: {})  &#x21d2; Object </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#Detected-class_method" title="Detected (class method)">.<strong>Detected</strong>(reason = nil, details: {})  &#x21d2; Object </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#Safe-class_method" title="Safe (class method)">.<strong>Safe</strong>(reason = nil, details: {})  &#x21d2; Object </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#Unknown-class_method" title="Unknown (class method)">.<strong>Unknown</strong>(reason = nil, details: {})  &#x21d2; Object </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#Unsupported-class_method" title="Unsupported (class method)">.<strong>Unsupported</strong>(reason = nil, details: {})  &#x21d2; Object </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#Vulnerable-class_method" title="Vulnerable (class method)">.<strong>Vulnerable</strong>(reason = nil, details: {}, vuln: {})  &#x21d2; Object </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
    </ul>
  
    <h2>
      Instance Method Summary
      <small><a href="#" class="summary_toggle">collapse</a></small>
    </h2>

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

  </span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>Deprecated, should use #===.</p>
</div></span>
  
</li>

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

  </span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>Checks to see whether the other object is also a <span class='object_link'><a href="" title="Msf::Exploit::CheckCode (class)">CheckCode</a></span> and if so, whether it shares the same code as this one.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(code, reason, details: {}, vuln: {})  &#x21d2; CheckCode </a>
    

  </span>
  
  
    <span class="note title constructor">constructor</span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>A new instance of CheckCode.</p>
</div></span>
  
</li>

      
    </ul>
  

  <div id="constructor_details" class="method_details_list">
  <h2>Constructor Details</h2>
  
    <div class="method_details first">
  <h3 class="signature first" id="initialize-instance_method">
  
    #<strong>initialize</strong>(code, reason, details: {}, vuln: {})  &#x21d2; <tt><span class='object_link'><a href="" title="Msf::Exploit::CheckCode (class)">CheckCode</a></span></tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns a new instance of CheckCode.</p>


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

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


103
104
105
106
107
108
109
110
111
112
113
114
115</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/msf/core/exploit.rb', line 103</span>

<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_code'>code</span><span class='comma'>,</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span> <span class='label'>details:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>vuln:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_msg'>msg</span> <span class='op'>=</span> <span class='kw'>case</span> <span class='id identifier rubyid_code'>code</span>
    <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>unknown</span><span class='tstring_end'>&#39;</span></span><span class='semicolon'>;</span>     <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Cannot reliably check exploitability.</span><span class='tstring_end'>&#39;</span></span>
    <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>safe</span><span class='tstring_end'>&#39;</span></span><span class='semicolon'>;</span>        <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>The target is not exploitable.</span><span class='tstring_end'>&#39;</span></span>
    <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>detected</span><span class='tstring_end'>&#39;</span></span><span class='semicolon'>;</span>    <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>The service is running, but could not be validated.</span><span class='tstring_end'>&#39;</span></span>
    <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>appears</span><span class='tstring_end'>&#39;</span></span><span class='semicolon'>;</span>     <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>The target appears to be vulnerable.</span><span class='tstring_end'>&#39;</span></span>
    <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>vulnerable</span><span class='tstring_end'>&#39;</span></span><span class='semicolon'>;</span>  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>The target is vulnerable.</span><span class='tstring_end'>&#39;</span></span>
    <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>unsupported</span><span class='tstring_end'>&#39;</span></span><span class='semicolon'>;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>This module does not support check.</span><span class='tstring_end'>&#39;</span></span>
    <span class='kw'>else</span>
      <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
  <span class='kw'>end</span>
  <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_code'>code</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_msg'>msg</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_reason'>reason</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span><span class='comma'>,</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span> <span class='id identifier rubyid_details'>details</span><span class='comma'>,</span> <span class='id identifier rubyid_vuln'>vuln</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="code=-instance_method"></span>
      <div class="method_details first">
  <h3 class="signature first" id="code-instance_method">
  
    #<strong>code</strong>  &#x21d2; <tt>Object</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns the value of attribute code</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>Object</tt>)</span>
      
      
        &mdash;
        <div class='inline'>
<p>the current value of code</p>
</div>
      
    </li>
  
</ul>

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


52
53
54</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/msf/core/exploit.rb', line 52</span>

<span class='kw'>def</span> <span class='id identifier rubyid_code'>code</span>
  <span class='ivar'>@code</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id="details=-instance_method"></span>
      <div class="method_details ">
  <h3 class="signature " id="details-instance_method">
  
    #<strong>details</strong>  &#x21d2; <tt>Object</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns the value of attribute details</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>Object</tt>)</span>
      
      
        &mdash;
        <div class='inline'>
<p>the current value of details</p>
</div>
      
    </li>
  
</ul>

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


52
53
54</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/msf/core/exploit.rb', line 52</span>

<span class='kw'>def</span> <span class='id identifier rubyid_details'>details</span>
  <span class='ivar'>@details</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id="message=-instance_method"></span>
      <div class="method_details ">
  <h3 class="signature " id="message-instance_method">
  
    #<strong>message</strong>  &#x21d2; <tt>Object</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns the value of attribute message</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>Object</tt>)</span>
      
      
        &mdash;
        <div class='inline'>
<p>the current value of message</p>
</div>
      
    </li>
  
</ul>

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


52
53
54</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/msf/core/exploit.rb', line 52</span>

<span class='kw'>def</span> <span class='id identifier rubyid_message'>message</span>
  <span class='ivar'>@message</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id="reason=-instance_method"></span>
      <div class="method_details ">
  <h3 class="signature " id="reason-instance_method">
  
    #<strong>reason</strong>  &#x21d2; <tt>Object</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns the value of attribute reason</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>Object</tt>)</span>
      
      
        &mdash;
        <div class='inline'>
<p>the current value of reason</p>
</div>
      
    </li>
  
</ul>

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


52
53
54</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/msf/core/exploit.rb', line 52</span>

<span class='kw'>def</span> <span class='id identifier rubyid_reason'>reason</span>
  <span class='ivar'>@reason</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id="vuln=-instance_method"></span>
      <div class="method_details ">
  <h3 class="signature " id="vuln-instance_method">
  
    #<strong>vuln</strong>  &#x21d2; <tt>Object</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns the value of attribute vuln</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>Object</tt>)</span>
      
      
        &mdash;
        <div class='inline'>
<p>the current value of vuln</p>
</div>
      
    </li>
  
</ul>

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


52
53
54</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/msf/core/exploit.rb', line 52</span>

<span class='kw'>def</span> <span class='id identifier rubyid_vuln'>vuln</span>
  <span class='ivar'>@vuln</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="Appears-class_method">
  
    .<strong>Appears</strong>(reason = nil, details: {})  &#x21d2; <tt>Object</tt> 
  

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


76
77
78</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/msf/core/exploit.rb', line 76</span>

<span class='kw'>def</span> <span class='const'><span class='object_link'><a href="#Appears-constant" title="Msf::Exploit::CheckCode::Appears (constant)">Appears</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_reason'>reason</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>details:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>appears</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span> <span class='label'>details:</span> <span class='id identifier rubyid_details'>details</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="Detected-class_method">
  
    .<strong>Detected</strong>(reason = nil, details: {})  &#x21d2; <tt>Object</tt> 
  

</h3><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/exploit.rb', line 72</span>

<span class='kw'>def</span> <span class='const'><span class='object_link'><a href="#Detected-constant" title="Msf::Exploit::CheckCode::Detected (constant)">Detected</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_reason'>reason</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>details:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>detected</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span> <span class='label'>details:</span> <span class='id identifier rubyid_details'>details</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="Safe-class_method">
  
    .<strong>Safe</strong>(reason = nil, details: {})  &#x21d2; <tt>Object</tt> 
  

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


68
69
70</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/msf/core/exploit.rb', line 68</span>

<span class='kw'>def</span> <span class='const'><span class='object_link'><a href="#Safe-constant" title="Msf::Exploit::CheckCode::Safe (constant)">Safe</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_reason'>reason</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>details:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>safe</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span> <span class='label'>details:</span> <span class='id identifier rubyid_details'>details</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="Unknown-class_method">
  
    .<strong>Unknown</strong>(reason = nil, details: {})  &#x21d2; <tt>Object</tt> 
  

</h3><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/exploit.rb', line 64</span>

<span class='kw'>def</span> <span class='const'><span class='object_link'><a href="#Unknown-constant" title="Msf::Exploit::CheckCode::Unknown (constant)">Unknown</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_reason'>reason</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>details:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>unknown</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span> <span class='label'>details:</span> <span class='id identifier rubyid_details'>details</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="Unsupported-class_method">
  
    .<strong>Unsupported</strong>(reason = nil, details: {})  &#x21d2; <tt>Object</tt> 
  

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


84
85
86</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/msf/core/exploit.rb', line 84</span>

<span class='kw'>def</span> <span class='const'><span class='object_link'><a href="#Unsupported-constant" title="Msf::Exploit::CheckCode::Unsupported (constant)">Unsupported</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_reason'>reason</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>details:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>unsupported</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span> <span class='label'>details:</span> <span class='id identifier rubyid_details'>details</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="Vulnerable-class_method">
  
    .<strong>Vulnerable</strong>(reason = nil, details: {}, vuln: {})  &#x21d2; <tt>Object</tt> 
  

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


80
81
82</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/msf/core/exploit.rb', line 80</span>

<span class='kw'>def</span> <span class='const'><span class='object_link'><a href="#Vulnerable-constant" title="Msf::Exploit::CheckCode::Vulnerable (constant)">Vulnerable</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_reason'>reason</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>details:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>vuln:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>vulnerable</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span> <span class='label'>details:</span> <span class='id identifier rubyid_details'>details</span><span class='comma'>,</span> <span class='label'>vuln:</span> <span class='id identifier rubyid_vuln'>vuln</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
  </div>

  <div id="instance_method_details" class="method_details_list">
    <h2>Instance Method Details</h2>

    
      <div class="method_details first">
  <h3 class="signature first" id="==-instance_method">
  
    #<strong>==</strong>(other)  &#x21d2; <tt>Object</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Deprecated, should use #===</p>

<p>If you need to determine whether a CheckCode has the same code and message as another one, Struct#eql? is the way to go.</p>


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

</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/exploit.rb', line 93</span>

<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
  <span class='kw'>self</span> <span class='op'>===</span> <span class='id identifier rubyid_other'>other</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="===-instance_method">
  
    #<strong>===</strong>(other)  &#x21d2; <tt>Object</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Checks to see whether the other object is also a <span class='object_link'><a href="" title="Msf::Exploit::CheckCode (class)">Msf::Exploit::CheckCode</a></span> and if so, whether it shares the same code as this one.</p>


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

</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/exploit.rb', line 99</span>

<span class='kw'>def</span> <span class='op'>===</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
  </div>

</div>

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