Updated the API documentation for ronin-exploits to 1.0.4.

ronin-rb · Dec 24, 2023 · 40d0228 · 40d0228
1 parent a26807a
commit 40d0228
Show file tree

Hide file tree

Showing 94 changed files with 523 additions and 1,245 deletions.
diff --git a/docs/ronin-exploits/Ronin.html b/docs/ronin-exploits/Ronin.html
@@ -133,7 +133,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:22 2023 by
+  Generated on Sat Dec 23 17:16:18 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits.html b/docs/ronin-exploits/Ronin/Exploits.html
@@ -153,7 +153,7 @@ <h2>
 
 </div>
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.0.3</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.0.4</span><span class='tstring_end'>&#39;</span></span></pre></dd>
 
     </dl>
 
@@ -171,7 +171,7 @@ <h2>
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:22 2023 by
+  Generated on Sat Dec 23 17:16:18 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/Advisory.html b/docs/ronin-exploits/Ronin/Exploits/Advisory.html
@@ -711,7 +711,7 @@ <h3 class="signature first" id="to_s-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:27 2023 by
+  Generated on Sat Dec 23 17:16:22 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/CLI.html b/docs/ronin-exploits/Ronin/Exploits/CLI.html
@@ -146,7 +146,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:25 2023 by
+  Generated on Sat Dec 23 17:16:20 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/CLI/Command.html b/docs/ronin-exploits/Ronin/Exploits/CLI/Command.html
@@ -132,7 +132,7 @@ <h2>Direct Known Subclasses</h2>
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:28 2023 by
+  Generated on Sat Dec 23 17:16:23 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/CLI/Commands.html b/docs/ronin-exploits/Ronin/Exploits/CLI/Commands.html
@@ -120,7 +120,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:24 2023 by
+  Generated on Sat Dec 23 17:16:19 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/CLI/Commands/Irb.html b/docs/ronin-exploits/Ronin/Exploits/CLI/Commands/Irb.html
@@ -232,7 +232,7 @@ <h3 class="signature first" id="run-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:29 2023 by
+  Generated on Sat Dec 23 17:16:23 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/CLI/Commands/List.html b/docs/ronin-exploits/Ronin/Exploits/CLI/Commands/List.html
@@ -280,7 +280,7 @@ <h3 class="signature first" id="run-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:33 2023 by
+  Generated on Sat Dec 23 17:16:26 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/CLI/Commands/New.html b/docs/ronin-exploits/Ronin/Exploits/CLI/Commands/New.html
@@ -174,6 +174,7 @@ <h2>
   <strong>This constant is part of a private API.</strong>
   You should avoid using this constant if possible, as it may be removed or be changed in the future.
 </p>
+<p>Mapping of exploit types and their file/class names.</p>
 
 
   </div>
@@ -247,6 +248,7 @@ <h2>
   <strong>This constant is part of a private API.</strong>
   You should avoid using this constant if possible, as it may be removed or be changed in the future.
 </p>
+<p>Mapping of network mixins and their file/module names.</p>
 
 
   </div>
@@ -516,15 +518,15 @@ <h3 class="signature first" id="initialize-instance_method">
       <pre class="lines">
 
 
-271
 272
 273
 274
 275
-276</pre>
+276
+277</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ronin/exploits/cli/commands/new.rb', line 271</span>
+      <pre class="code"><span class="info file"># File 'lib/ronin/exploits/cli/commands/new.rb', line 272</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span>
   <span class='kw'>super</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span>
@@ -601,18 +603,18 @@ <h3 class="signature first" id="format_kwargs-instance_method">
       <pre class="lines">
 
 
-299
 300
 301
 302
 303
 304
 305
 306
-307</pre>
+307
+308</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ronin/exploits/cli/commands/new.rb', line 299</span>
+      <pre class="code"><span class="info file"># File 'lib/ronin/exploits/cli/commands/new.rb', line 300</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_format_kwargs'>format_kwargs</span><span class='lparen'>(</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_args'>args</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
@@ -676,16 +678,16 @@ <h3 class="signature " id="run-instance_method">
       <pre class="lines">
 
 
-284
 285
 286
 287
 288
 289
-290</pre>
+290
+291</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ronin/exploits/cli/commands/new.rb', line 284</span>
+      <pre class="code"><span class="info file"># File 'lib/ronin/exploits/cli/commands/new.rb', line 285</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='rparen'>)</span>
   <span class='ivar'>@file_name</span>  <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_basename'>basename</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='comma'>,</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_extname'>extname</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='rparen'>)</span><span class='rparen'>)</span>
@@ -741,12 +743,12 @@ <h3 class="signature " id="seh_overflow_exploit?-instance_method">
       <pre class="lines">
 
 
-326
 327
-328</pre>
+328
+329</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ronin/exploits/cli/commands/new.rb', line 326</span>
+      <pre class="code"><span class="info file"># File 'lib/ronin/exploits/cli/commands/new.rb', line 327</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_seh_overflow_exploit?'>seh_overflow_exploit?</span>
   <span class='ivar'>@exploit_type</span><span class='lbracket'>[</span><span class='symbol'>:class</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>SEHOverflow</span><span class='tstring_end'>&#39;</span></span>
@@ -798,12 +800,12 @@ <h3 class="signature " id="stack_overflow_exploit?-instance_method">
       <pre class="lines">
 
 
-317
 318
-319</pre>
+319
+320</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ronin/exploits/cli/commands/new.rb', line 317</span>
+      <pre class="code"><span class="info file"># File 'lib/ronin/exploits/cli/commands/new.rb', line 318</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_stack_overflow_exploit?'>stack_overflow_exploit?</span>
   <span class='ivar'>@exploit_type</span><span class='lbracket'>[</span><span class='symbol'>:class</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>StackOverflow</span><span class='tstring_end'>&#39;</span></span>
@@ -855,12 +857,12 @@ <h3 class="signature " id="web_vuln_exploit?-instance_method">
       <pre class="lines">
 
 
-335
 336
-337</pre>
+337
+338</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ronin/exploits/cli/commands/new.rb', line 335</span>
+      <pre class="code"><span class="info file"># File 'lib/ronin/exploits/cli/commands/new.rb', line 336</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_web_vuln_exploit?'>web_vuln_exploit?</span>
   <span class='const'><span class='object_link'><a href="#WEB_VULN_EXPLOITS-constant" title="Ronin::Exploits::CLI::Commands::New::WEB_VULN_EXPLOITS (constant)">WEB_VULN_EXPLOITS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='ivar'>@exploit_type</span><span class='lbracket'>[</span><span class='symbol'>:class</span><span class='rbracket'>]</span><span class='rparen'>)</span>
@@ -875,7 +877,7 @@ <h3 class="signature " id="web_vuln_exploit?-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:31 2023 by
+  Generated on Sat Dec 23 17:16:24 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/CLI/Commands/Run.html b/docs/ronin-exploits/Ronin/Exploits/CLI/Commands/Run.html
@@ -1784,7 +1784,7 @@ <h3 class="signature " id="validate_payload-instance_method">
       <pre class="code"><span class="info file"># File 'lib/ronin/exploits/cli/commands/run.rb', line 342</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_validate_payload'>validate_payload</span>
-  <span class='kw'>super</span><span class='lparen'>(</span><span class='ivar'>@payload</span><span class='rparen'>)</span>
+  <span class='kw'>super</span><span class='lparen'>(</span><span class='ivar'>@payload</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@payload</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -1796,7 +1796,7 @@ <h3 class="signature " id="validate_payload-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:33 2023 by
+  Generated on Sat Dec 23 17:16:26 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/CLI/Commands/Show.html b/docs/ronin-exploits/Ronin/Exploits/CLI/Commands/Show.html
@@ -1195,7 +1195,7 @@ <h3 class="signature " id="run-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:35 2023 by
+  Generated on Sat Dec 23 17:16:28 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/CLI/ExploitCommand.html b/docs/ronin-exploits/Ronin/Exploits/CLI/ExploitCommand.html
@@ -805,7 +805,7 @@ <h3 class="signature " id="validate_exploit-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:36 2023 by
+  Generated on Sat Dec 23 17:16:28 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/CLI/ExploitMethods.html b/docs/ronin-exploits/Ronin/Exploits/CLI/ExploitMethods.html
@@ -627,7 +627,7 @@ <h3 class="signature " id="validate_exploit-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:24 2023 by
+  Generated on Sat Dec 23 17:16:20 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/CLI/RubyShell.html b/docs/ronin-exploits/Ronin/Exploits/CLI/RubyShell.html
@@ -266,7 +266,7 @@ <h3 class="signature first" id="initialize-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:29 2023 by
+  Generated on Sat Dec 23 17:16:23 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/ClientSideWebVuln.html b/docs/ronin-exploits/Ronin/Exploits/ClientSideWebVuln.html
@@ -441,7 +441,7 @@ <h3 class="signature " id="launch-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:36 2023 by
+  Generated on Sat Dec 23 17:16:28 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/Exploit.html b/docs/ronin-exploits/Ronin/Exploits/Exploit.html
@@ -3155,7 +3155,7 @@ <h3 class="signature " id="Vulnerable-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:27 2023 by
+  Generated on Sat Dec 23 17:16:22 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/ExploitError.html b/docs/ronin-exploits/Ronin/Exploits/ExploitError.html
@@ -118,7 +118,7 @@ <h2>Direct Known Subclasses</h2>
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:28 2023 by
+  Generated on Sat Dec 23 17:16:23 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/ExploitFailed.html b/docs/ronin-exploits/Ronin/Exploits/ExploitFailed.html
@@ -122,7 +122,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:28 2023 by
+  Generated on Sat Dec 23 17:16:23 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/HeapOverflow.html b/docs/ronin-exploits/Ronin/Exploits/HeapOverflow.html
@@ -311,7 +311,7 @@ <h3 class="signature first" id="exploit_type-class_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:29 2023 by
+  Generated on Sat Dec 23 17:16:23 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/IncompatiblePayload.html b/docs/ronin-exploits/Ronin/Exploits/IncompatiblePayload.html
@@ -122,7 +122,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:28 2023 by
+  Generated on Sat Dec 23 17:16:23 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/LFI.html b/docs/ronin-exploits/Ronin/Exploits/LFI.html
@@ -703,7 +703,7 @@ <h3 class="signature " id="vuln-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:25 2023 by
+  Generated on Sat Dec 23 17:16:20 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/Loot.html b/docs/ronin-exploits/Ronin/Exploits/Loot.html
@@ -868,7 +868,7 @@ <h3 class="signature " id="save-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:25 2023 by
+  Generated on Sat Dec 23 17:16:20 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/Loot/File.html b/docs/ronin-exploits/Ronin/Exploits/Loot/File.html
@@ -865,7 +865,7 @@ <h3 class="signature " id="to_s-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:28 2023 by
+  Generated on Sat Dec 23 17:16:23 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/MemoryCorruption.html b/docs/ronin-exploits/Ronin/Exploits/MemoryCorruption.html
@@ -312,7 +312,7 @@ <h3 class="signature first" id="exploit_type-class_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:36 2023 by
+  Generated on Sat Dec 23 17:16:28 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/Metadata.html b/docs/ronin-exploits/Ronin/Exploits/Metadata.html
@@ -107,7 +107,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:22 2023 by
+  Generated on Sat Dec 23 17:16:18 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/Metadata/Arch.html b/docs/ronin-exploits/Ronin/Exploits/Metadata/Arch.html
@@ -326,7 +326,7 @@ <h3 class="signature first" id="arch-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:23 2023 by
+  Generated on Sat Dec 23 17:16:19 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/Metadata/Arch/ClassMethods.html b/docs/ronin-exploits/Ronin/Exploits/Metadata/Arch/ClassMethods.html
@@ -243,7 +243,7 @@ <h3 class="signature first" id="arch-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:23 2023 by
+  Generated on Sat Dec 23 17:16:19 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>

diff --git a/docs/ronin-exploits/Ronin/Exploits/Metadata/CookieParam.html b/docs/ronin-exploits/Ronin/Exploits/Metadata/CookieParam.html
@@ -321,7 +321,7 @@ <h3 class="signature first" id="cookie_param-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 19 15:40:24 2023 by
+  Generated on Sat Dec 23 17:16:20 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.4).
 </div>