beef-npm
Version:
Node.js package to install and interact with BeEF (Browser Exploitation Framework)
567 lines (129 loc) • 7.74 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Namespace: BeefJS</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: BeefJS</h1>
<section>
<header>
<h2>BeefJS</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Register the BeEF JS on the window object.</p></div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>version</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>BeEf Version</p></td>
</tr>
<tr>
<td class="name"><code>pageIsLoaded</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>This gets set to true during window.onload(). It's a useful hack when messing with document.write().</p></td>
</tr>
<tr>
<td class="name"><code>onpopstate</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last"><p>An array containing functions to be executed by the window.onpopstate() method.</p></td>
</tr>
<tr>
<td class="name"><code>onclose</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last"><p>An array containing functions to be executed by the window.onclose() method.</p></td>
</tr>
<tr>
<td class="name"><code>commands</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last"><p>An array containing functions to be executed by Beef.</p></td>
</tr>
<tr>
<td class="name"><code>components</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last"><p>An array containing all the BeEF JS components.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="beef.js.html">beef.js</a>, <a href="beef.js.html#line16">line 16</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".debug"><span class="type-signature">(static) </span>debug<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Adds a function to display debug messages (wraps console.log())</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="beef.js.html">beef.js</a>, <a href="beef.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".execute"><span class="type-signature">(static) </span>execute<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Adds a function to execute.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="beef.js.html">beef.js</a>, <a href="beef.js.html#line62">line 62</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".regCmp"><span class="type-signature">(static) </span>regCmp<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Registers a component in BeEF JS.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="beef.js.html">beef.js</a>, <a href="beef.js.html#line77">line 77</a>
</li></ul></dd>
</dl>
</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>