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

662 lines
22 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: Rex::Proto::Http::WebSocket::Frame
&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::Proto::Http::WebSocket::Frame";
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="../../../../Rex.html" title="Rex (module)">Rex</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../../Proto.html" title="Rex::Proto (module)">Proto</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Http.html" title="Rex::Proto::Http (module)">Http</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../WebSocket.html" title="Rex::Proto::Http::WebSocket (module)">WebSocket</a></span></span>
&raquo;
<span class="title">Frame</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: Rex::Proto::Http::WebSocket::Frame
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">BinData::Record</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">BinData::Record</li>
<li class="next">Rex::Proto::Http::WebSocket::Frame</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rex/proto/http/web_socket.rb</dd>
</dl>
</div>
<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="#apply_masking_key-class_method" title="apply_masking_key (class method)">.<strong>apply_masking_key</strong>(data, mask) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#from_binary-class_method" title="from_binary (class method)">.<strong>from_binary</strong>(value, last: true, mask: true) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#from_text-class_method" title="from_text (class method)">.<strong>from_text</strong>(value, last: true, mask: true) &#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="#mask!-instance_method" title="#mask! (instance method)">#<strong>mask!</strong>(key = nil) &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Update the frame instance in place to apply a masking key to the payload data as defined in RFC 6455 section 5.3.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_len-instance_method" title="#payload_len (instance method)">#<strong>payload_len</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#payload_len=-instance_method" title="#payload_len= (instance method)">#<strong>payload_len=</strong>(value) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#unmask!-instance_method" title="#unmask! (instance method)">#<strong>unmask!</strong> &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Update the frame instance in place to apply a masking key to the payload data as defined in RFC 6455 section 5.3.</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="apply_masking_key-class_method">
.<strong>apply_masking_key</strong>(data, mask) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
381
382
383
384
385
386
387
388
389</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/proto/http/web_socket.rb', line 381</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_apply_masking_key'>apply_masking_key</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_mask'>mask</span><span class='rparen'>)</span>
<span class='id identifier rubyid_mask'>mask</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_mask'>mask</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_pack'>pack</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>N</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each_byte'>each_byte</span><span class='period'>.</span><span class='id identifier rubyid_to_a'>to_a</span>
<span class='id identifier rubyid_xored'>xored</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_each_byte'>each_byte</span><span class='period'>.</span><span class='id identifier rubyid_each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_byte'>byte</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='op'>|</span>
<span class='id identifier rubyid_xored'>xored</span> <span class='op'>&lt;&lt;</span> <span class='lparen'>(</span><span class='id identifier rubyid_byte'>byte</span> <span class='op'>^</span> <span class='id identifier rubyid_mask'>mask</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span> <span class='op'>%</span> <span class='int'>4</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_chr'>chr</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_xored'>xored</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="from_binary-class_method">
.<strong>from_binary</strong>(value, last: true, mask: true) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
391
392
393</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/proto/http/web_socket.rb', line 391</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_binary'>from_binary</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='label'>last:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>mask:</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='id identifier rubyid_from_opcode'>from_opcode</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Opcode.html" title="Rex::Proto::Http::WebSocket::Opcode (class)">Opcode</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Opcode.html#BINARY-constant" title="Rex::Proto::Http::WebSocket::Opcode::BINARY (constant)">BINARY</a></span></span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='label'>last:</span> <span class='id identifier rubyid_last'>last</span><span class='comma'>,</span> <span class='label'>mask:</span> <span class='id identifier rubyid_mask'>mask</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="from_text-class_method">
.<strong>from_text</strong>(value, last: true, mask: true) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
395
396
397</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/proto/http/web_socket.rb', line 395</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_text'>from_text</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='label'>last:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>mask:</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='id identifier rubyid_from_opcode'>from_opcode</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Opcode.html" title="Rex::Proto::Http::WebSocket::Opcode (class)">Opcode</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Opcode.html#TEXT-constant" title="Rex::Proto::Http::WebSocket::Opcode::TEXT (constant)">TEXT</a></span></span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='label'>last:</span> <span class='id identifier rubyid_last'>last</span><span class='comma'>,</span> <span class='label'>mask:</span> <span class='id identifier rubyid_mask'>mask</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="mask!-instance_method">
#<strong>mask!</strong>(key = nil) &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Update the frame instance in place to apply a masking key to the payload data as defined in RFC 6455 section 5.3.</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>nil</tt>, <tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>either an explicit 32-bit masking key or nil to generate a random one</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 masked payload data is returned</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
404
405
406
407
408
409
410</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/proto/http/web_socket.rb', line 404</span>
<span class='kw'>def</span> <span class='id identifier rubyid_mask!'>mask!</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_masked'>masked</span><span class='period'>.</span><span class='id identifier rubyid_assign'>assign</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span>
<span class='id identifier rubyid_key'>key</span> <span class='op'>=</span> <span class='id identifier rubyid_rand'>rand</span><span class='lparen'>(</span><span class='int'>1</span><span class='op'>..</span><span class='int'>0xffffffff</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_masking_key'>masking_key</span><span class='period'>.</span><span class='id identifier rubyid_assign'>assign</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
<span class='id identifier rubyid_payload_data'>payload_data</span><span class='period'>.</span><span class='id identifier rubyid_assign'>assign</span><span class='lparen'>(</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_apply_masking_key'>apply_masking_key</span><span class='lparen'>(</span><span class='id identifier rubyid_payload_data'>payload_data</span><span class='comma'>,</span> <span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_masking_key'>masking_key</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_payload_data'>payload_data</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_len-instance_method">
#<strong>payload_len</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
422
423
424
425
426
427
428
429
430
431</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/proto/http/web_socket.rb', line 422</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_len'>payload_len</span>
<span class='kw'>case</span> <span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_payload_len_sm'>payload_len_sm</span>
<span class='kw'>when</span> <span class='int'>127</span>
<span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_payload_len_lg'>payload_len_lg</span>
<span class='kw'>when</span> <span class='int'>126</span>
<span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_payload_len_md'>payload_len_md</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_payload_len_sm'>payload_len_sm</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="payload_len=-instance_method">
#<strong>payload_len=</strong>(value) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
433
434
435
436
437
438
439
440
441
442
443
444
445</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/proto/http/web_socket.rb', line 433</span>
<span class='kw'>def</span> <span class='id identifier rubyid_payload_len='>payload_len=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>&lt;</span> <span class='int'>126</span>
<span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_payload_len_sm'>payload_len_sm</span><span class='period'>.</span><span class='id identifier rubyid_assign'>assign</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>&lt;</span> <span class='int'>0xffff</span>
<span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_payload_len_sm'>payload_len_sm</span><span class='period'>.</span><span class='id identifier rubyid_assign'>assign</span><span class='lparen'>(</span><span class='int'>126</span><span class='rparen'>)</span>
<span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_payload_len_md'>payload_len_md</span><span class='period'>.</span><span class='id identifier rubyid_assign'>assign</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>&lt;</span> <span class='int'>0x7fffffffffffffff</span>
<span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_payload_len_sm'>payload_len_sm</span><span class='period'>.</span><span class='id identifier rubyid_assign'>assign</span><span class='lparen'>(</span><span class='int'>127</span><span class='rparen'>)</span>
<span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_payload_len_lg'>payload_len_lg</span><span class='period'>.</span><span class='id identifier rubyid_assign'>assign</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>payload length is outside the acceptable range</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="unmask!-instance_method">
#<strong>unmask!</strong> &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Update the frame instance in place to apply a masking key to the payload data as defined in RFC 6455 section 5.3.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>the unmasked payload data is returned</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
416
417
418
419
420</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/proto/http/web_socket.rb', line 416</span>
<span class='kw'>def</span> <span class='id identifier rubyid_unmask!'>unmask!</span>
<span class='id identifier rubyid_payload_data'>payload_data</span><span class='period'>.</span><span class='id identifier rubyid_assign'>assign</span><span class='lparen'>(</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_apply_masking_key'>apply_masking_key</span><span class='lparen'>(</span><span class='id identifier rubyid_payload_data'>payload_data</span><span class='comma'>,</span> <span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_masking_key'>masking_key</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_masked'>masked</span><span class='period'>.</span><span class='id identifier rubyid_assign'>assign</span><span class='lparen'>(</span><span class='int'>0</span><span class='rparen'>)</span>
<span class='id identifier rubyid_payload_data'>payload_data</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:04:18 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