beef-npm
Version:
Node.js package to install and interact with BeEF (Browser Exploitation Framework)
731 lines (146 loc) • 8.78 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Namespace: updater</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Namespace: updater</h1>
<section>
<header>
<h2>updater</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Object in charge of getting new commands from the BeEF framework and execute them.
The XHR-polling channel is managed here. If WebSockets are enabled,
websocket.js is used instead.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="updater.js.html">updater.js</a>, <a href="updater.js.html#line7">line 7</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id=".beefhook"><span class="type-signature">(static) </span>beefhook<span class="type-signature"></span></h4>
<div class="description">
<p>Hook session name.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="updater.js.html">updater.js</a>, <a href="updater.js.html#line19">line 19</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".lock"><span class="type-signature">(static) </span>lock<span class="type-signature"></span></h4>
<div class="description">
<p>A lock.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="updater.js.html">updater.js</a>, <a href="updater.js.html#line22">line 22</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".objects"><span class="type-signature">(static) </span>objects<span class="type-signature"></span></h4>
<div class="description">
<p>An object containing all values to be registered and sent by the updater.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="updater.js.html">updater.js</a>, <a href="updater.js.html#line25">line 25</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".xhr_poll_timeout"><span class="type-signature">(static) </span>xhr_poll_timeout<span class="type-signature"></span></h4>
<div class="description">
<p>XHR-polling timeout.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="updater.js.html">updater.js</a>, <a href="updater.js.html#line16">line 16</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".execute_commands"><span class="type-signature">(static) </span>execute_commands<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Executes the received commands, if any.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="updater.js.html">updater.js</a>, <a href="updater.js.html#line75">line 75</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".get_commands"><span class="type-signature">(static) </span>get_commands<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Gets new commands from the framework.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="updater.js.html">updater.js</a>, <a href="updater.js.html#line58">line 58</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".regObject"><span class="type-signature">(static) </span>regObject<span class="signature">(key, value)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Registers an object to always send when requesting new commands to the framework.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>the name of the object.</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>the value of that object.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="updater.js.html">updater.js</a>, <a href="updater.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>beef.updater.regObject('java_enabled', 'true');</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="BeefJS.html">BeefJS</a></li><li><a href="beef.are.html">are</a></li><li><a href="beef.browser.html">browser</a></li><li><a href="beef.browser.cookie.html">cookie</a></li><li><a href="beef.browser.popup.html">popup</a></li><li><a href="beef.dom.html">dom</a></li><li><a href="beef.encode.base64.html">base64</a></li><li><a href="beef.encode.json.html">json</a></li><li><a href="beef.geolocation.html">geolocation</a></li><li><a href="beef.hardware.html">hardware</a></li><li><a href="beef.init.html">init</a></li><li><a href="beef.logger.html">logger</a></li><li><a href="beef.mitb.html">mitb</a></li><li><a href="beef.net.html">net</a></li><li><a href="beef.net.connection.html">connection</a></li><li><a href="beef.net.cors.html">cors</a></li><li><a href="beef.net.dns.html">dns</a></li><li><a href="beef.net.local.html">local</a></li><li><a href="beef.net.portscanner.html">portscanner</a></li><li><a href="beef.net.requester.html">requester</a></li><li><a href="beef.net.xssrays.html">xssrays</a></li><li><a href="beef.os.html">os</a></li><li><a href="beef.session.html">session</a></li><li><a href="beef.timeout.html">timeout</a></li><li><a href="beef.updater.html">updater</a></li><li><a href="beef.webrtc.html">webrtc</a></li><li><a href="beef.websocket.html">websocket</a></li></ul><h3>Global</h3><ul><li><a href="global.html#platform">platform</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Wed Oct 23 2024 16:03:46 GMT+1000 (Australian Eastern Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>