Files
metasploit-gs/api/Rex/UserAgent.html
T
jenkins-metasploit c3f5bd3de2 Reboot gh-pages
2026-05-08 17:08:43 +00:00

444 lines
12 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Rex::UserAgent
&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::UserAgent";
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 (U)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Rex.html" title="Rex (module)">Rex</a></span></span>
&raquo;
<span class="title">UserAgent</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::UserAgent
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/rex/user_agent.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A helper module for using and referencing coming user agent strings.</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="COMMON_AGENTS-constant" class="">COMMON_AGENTS =
<div class="docstring">
<div class="discussion">
<p>Taken from <a href="https://www.whatismybrowser.com/guides/the-latest-user-agent">www.whatismybrowser.com/guides/the-latest-user-agent</a>/</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbracket'>[</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='comment'># Chrome Windows
</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='comment'># Chrome MacOS
</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36 Edg/131.0.2903.86</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='comment'># Edge Windows
</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Mozilla/5.0 (iPad; CPU OS 17_7_2 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.4.1 Mobile/15E148 Safari/604.1</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='comment'># Safari iPad
</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Mozilla/5.0 (Macintosh; Intel Mac OS X 14_7_2) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.4.1 Safari/605.1.15</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='comment'># Safari MacOS
</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:133.0) Gecko/20100101 Firefox/133.0</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='comment'># Firefox Windows
</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Mozilla/5.0 (Macintosh; Intel Mac OS X 14.7; rv:133.0) Gecko/20100101 Firefox/133.0</span><span class='tstring_end'>&#39;</span></span> <span class='comment'># Firefox MacOS
</span><span class='rbracket'>]</span></pre></dd>
<dt id="session_agent-classvariable" class="">@@session_agent =
</dt>
<dd><pre class="code"><span class='kw'>nil</span></pre></dd>
</dl>
<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="#most_common-class_method" title="most_common (class method)">.<strong>most_common</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Choose the most frequent user agent.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#random-class_method" title="random (class method)">.<strong>random</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Pick a random agent from the common agent list.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#session_agent-class_method" title="session_agent (class method)">.<strong>session_agent</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>A randomly-selected agent that will be consistent for the duration of metasploit running.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#shortest-class_method" title="shortest (class method)">.<strong>shortest</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Choose the agent with the shortest string (for use in payloads).</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="most_common-class_method">
.<strong>most_common</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Choose the most frequent user agent</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
54
55
56</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/user_agent.rb', line 54</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_most_common'>most_common</span>
<span class='const'><span class='object_link'><a href="#COMMON_AGENTS-constant" title="Rex::UserAgent::COMMON_AGENTS (constant)">COMMON_AGENTS</a></span></span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="random-class_method">
.<strong>random</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Pick a random agent from the common agent list.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
40
41
42</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/user_agent.rb', line 40</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_random'>random</span>
<span class='const'><span class='object_link'><a href="#COMMON_AGENTS-constant" title="Rex::UserAgent::COMMON_AGENTS (constant)">COMMON_AGENTS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_sample'>sample</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="session_agent-class_method">
.<strong>session_agent</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>A randomly-selected agent that will be consistent for the duration of metasploit running</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29
30
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/user_agent.rb', line 27</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_session_agent'>session_agent</span>
<span class='kw'>if</span> <span class='cvar'>@@session_agent</span>
<span class='cvar'>@@session_agent</span>
<span class='kw'>else</span>
<span class='cvar'>@@session_agent</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_random'>random</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="shortest-class_method">
.<strong>shortest</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Choose the agent with the shortest string (for use in payloads)</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/user_agent.rb', line 47</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_shortest'>shortest</span>
<span class='cvar'>@@shortest_agent</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="#COMMON_AGENTS-constant" title="Rex::UserAgent::COMMON_AGENTS (constant)">COMMON_AGENTS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_min'>min</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='comma'>,</span> <span class='id identifier rubyid_b'>b</span><span class='op'>|</span> <span class='id identifier rubyid_a'>a</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>&lt;=&gt;</span> <span class='id identifier rubyid_b'>b</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='rbrace'>}</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>