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

699 lines
17 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>
Module: Rex::Crypto
&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 = "Rex::Crypto";
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="../Rex.html" title="Rex (module)">Rex</a></span></span>
&raquo;
<span class="title">Crypto</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: Rex::Crypto
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/rex/crypto.rb<span class="defines">,<br />
lib/rex/crypto/rc4.rb,<br /> lib/rex/crypto/aes256.rb,<br /> lib/rex/crypto/chacha20.rb,<br /> lib/rex/crypto/key_wrap/nist_sp_800_38f.rb</span>
</dd>
</dl>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Crypto/Aes256.html" title="Rex::Crypto::Aes256 (module)">Aes256</a></span>, <span class='object_link'><a href="Crypto/KeyDerivation.html" title="Rex::Crypto::KeyDerivation (module)">KeyDerivation</a></span>, <span class='object_link'><a href="Crypto/KeyWrap.html" title="Rex::Crypto::KeyWrap (module)">KeyWrap</a></span>, <span class='object_link'><a href="Crypto/Rc4.html" title="Rex::Crypto::Rc4 (module)">Rc4</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Crypto/Chacha20.html" title="Rex::Crypto::Chacha20 (class)">Chacha20</a></span>
</p>
<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="#bytes_to_int-class_method" title="bytes_to_int (class method)">.<strong>bytes_to_int</strong>(bytes) &#x21d2; Integer </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns an integer represented as a byte array.</p>
</div></span>
</li>
<li class="public deprecated">
<span class="summary_signature">
<a href="#decrypt_aes256-class_method" title="decrypt_aes256 (class method)">.<strong>decrypt_aes256</strong>(iv, key, value) &#x21d2; String </a>
</span>
<span class="deprecated note title">deprecated</span>
<span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'>
<p>Access via Rex::Crypto::Aes256</p>
</div></span>
</li>
<li class="public deprecated">
<span class="summary_signature">
<a href="#encrypt_aes256-class_method" title="encrypt_aes256 (class method)">.<strong>encrypt_aes256</strong>(iv, key, value) &#x21d2; String </a>
</span>
<span class="deprecated note title">deprecated</span>
<span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'>
<p>Access via Rex::Crypto::Aes256</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#int_to_bytes-class_method" title="int_to_bytes (class method)">.<strong>int_to_bytes</strong>(num) &#x21d2; Integer </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns a byte array represented as a big-endian integer.</p>
</div></span>
</li>
<li class="public deprecated">
<span class="summary_signature">
<a href="#rc4-class_method" title="rc4 (class method)">.<strong>rc4</strong>(key, value) &#x21d2; Object </a>
</span>
<span class="deprecated note title">deprecated</span>
<span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'>
<p>Access via Rex::Crypto::Rc4</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="bytes_to_int-class_method">
.<strong>bytes_to_int</strong>(bytes) &#x21d2; <tt>Integer</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns an integer represented as a byte array. Useful for certain key-related operations.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>bytes</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The bytes to convert</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>The converted value.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
35
36
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/crypto.rb', line 35</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_bytes_to_int'>bytes_to_int</span><span class='lparen'>(</span><span class='id identifier rubyid_bytes'>bytes</span><span class='rparen'>)</span>
<span class='id identifier rubyid_bytes'>bytes</span><span class='period'>.</span><span class='id identifier rubyid_each_byte'>each_byte</span><span class='period'>.</span><span class='id identifier rubyid_reduce'>reduce</span><span class='lparen'>(</span><span class='int'>0</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_acc'>acc</span><span class='comma'>,</span> <span class='id identifier rubyid_byte'>byte</span><span class='op'>|</span> <span class='lparen'>(</span><span class='id identifier rubyid_acc'>acc</span> <span class='op'>&lt;&lt;</span> <span class='int'>8</span><span class='rparen'>)</span> <span class='op'>|</span> <span class='id identifier rubyid_byte'>byte</span> <span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="decrypt_aes256-class_method">
.<strong>decrypt_aes256</strong>(iv, key, value) &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'>
<p>Access via Rex::Crypto::Aes256</p>
</div></div>
<p>Returns a decrypted string using AES256-CBC.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>iv</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>Initialization vector.</p>
</div>
</li>
<li>
<span class='name'>key</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>Secret key.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The decrypted string.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
18
19
20</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/crypto.rb', line 18</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_decrypt_aes256'>decrypt_aes256</span><span class='lparen'>(</span><span class='id identifier rubyid_iv'>iv</span><span class='comma'>,</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="Crypto/Aes256.html" title="Rex::Crypto::Aes256 (module)">Aes256</a></span></span><span class='period'>.</span><span class='id identifier rubyid_decrypt_aes256'><span class='object_link'><a href="Crypto/Aes256.html#decrypt_aes256-class_method" title="Rex::Crypto::Aes256.decrypt_aes256 (method)">decrypt_aes256</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_iv'>iv</span><span class='comma'>,</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="encrypt_aes256-class_method">
.<strong>encrypt_aes256</strong>(iv, key, value) &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'>
<p>Access via Rex::Crypto::Aes256</p>
</div></div>
<p>Returns an encrypted string using AES256-CBC.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>iv</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>Initialization vector.</p>
</div>
</li>
<li>
<span class='name'>key</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>Secret key.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The encrypted string.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/crypto.rb', line 8</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_encrypt_aes256'>encrypt_aes256</span><span class='lparen'>(</span><span class='id identifier rubyid_iv'>iv</span><span class='comma'>,</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="Crypto/Aes256.html" title="Rex::Crypto::Aes256 (module)">Aes256</a></span></span><span class='period'>.</span><span class='id identifier rubyid_encrypt_aes256'><span class='object_link'><a href="Crypto/Aes256.html#encrypt_aes256-class_method" title="Rex::Crypto::Aes256.encrypt_aes256 (method)">encrypt_aes256</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_iv'>iv</span><span class='comma'>,</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="int_to_bytes-class_method">
.<strong>int_to_bytes</strong>(num) &#x21d2; <tt>Integer</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a byte array represented as a big-endian integer. Useful for certain key-related operations.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>bytes</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The bytes to convert</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>The converted value.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
43
44
45
46
47
48
49
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/crypto.rb', line 43</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_int_to_bytes'>int_to_bytes</span><span class='lparen'>(</span><span class='id identifier rubyid_num'>num</span><span class='rparen'>)</span>
<span class='id identifier rubyid_bytes'>bytes</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='kw'>while</span> <span class='id identifier rubyid_num'>num</span> <span class='op'>&gt;</span> <span class='int'>0</span>
<span class='id identifier rubyid_bytes'>bytes</span><span class='period'>.</span><span class='id identifier rubyid_unshift'>unshift</span><span class='lparen'>(</span><span class='id identifier rubyid_num'>num</span> <span class='op'>&amp;</span> <span class='int'>0xff</span><span class='rparen'>)</span>
<span class='id identifier rubyid_num'>num</span> <span class='op'>&gt;&gt;=</span> <span class='int'>8</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_bytes'>bytes</span><span class='period'>.</span><span class='id identifier rubyid_pack'>pack</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>C*</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="rc4-class_method">
.<strong>rc4</strong>(key, value) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'>
<p>Access via Rex::Crypto::Rc4</p>
</div></div>
<p>Returns a decrypted or encrypted RC4 string.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>key</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>Secret key.</p>
</div>
</li>
<li>
<span class='name'></span>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/crypto.rb', line 27</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_rc4'>rc4</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="Crypto/Rc4.html" title="Rex::Crypto::Rc4 (module)">Rc4</a></span></span><span class='period'>.</span><span class='id identifier rubyid_rc4'><span class='object_link'><a href="Crypto/Rc4.html#rc4-class_method" title="Rex::Crypto::Rc4.rc4 (method)">rc4</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:03:08 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