beef-npm
Version:
Node.js package to install and interact with BeEF (Browser Exploitation Framework)
2,168 lines (318 loc) • 19.4 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Namespace: logger</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: logger</h1>
<section>
<header>
<h2>logger</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Provides logging capabilities.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line7">line 7</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id=".events"><span class="type-signature">(static) </span>events<span class="type-signature"></span></h4>
<div class="description">
<p>Holds events created by user, to be sent back to BeEF</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line21">line 21</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".id"><span class="type-signature">(static) </span>id<span class="type-signature"></span></h4>
<div class="description">
<p>Internal logger id</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line17">line 17</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".in_submit"><span class="type-signature">(static) </span>in_submit<span class="type-signature"></span></h4>
<div class="description">
<p>Prevents from recursive event handling on form submission</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line50">line 50</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".stream"><span class="type-signature">(static) </span>stream<span class="type-signature"></span></h4>
<div class="description">
<p>Holds current stream of key presses</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line25">line 25</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".target"><span class="type-signature">(static) </span>target<span class="type-signature"></span></h4>
<div class="description">
<p>Contains current target of key presses</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line29">line 29</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".time"><span class="type-signature">(static) </span>time<span class="type-signature"></span></h4>
<div class="description">
<p>Holds the time the logger was started</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line33">line 33</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".click"><span class="type-signature">(static) </span>click<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Click function fires when the user clicks the mouse.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line155">line 155</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".console"><span class="type-signature">(static) </span>console<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Console function fires when data is sent to the browser console.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line222">line 222</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".copy"><span class="type-signature">(static) </span>copy<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Copy function fires when the user copies data to the clipboard.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line198">line 198</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".cut"><span class="type-signature">(static) </span>cut<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Cut function fires when the user cuts data to the clipboard.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line210">line 210</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".e"><span class="type-signature">(static) </span>e<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Holds the event details to be sent to BeEF</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line37">line 37</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".get_dom_identifier"><span class="type-signature">(static) </span>get_dom_identifier<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Translate DOM Object to a readable string</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line296">line 296</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".get_id"><span class="type-signature">(static) </span>get_id<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Get id</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line147">line 147</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".get_timestamp"><span class="type-signature">(static) </span>get_timestamp<span class="signature">()</span><span class="type-signature"> → {String}</span></h4>
<div class="description">
<p>Formats the timestamp</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line312">line 312</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>timestamp string</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id=".keypress"><span class="type-signature">(static) </span>keypress<span class="signature">(e:)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Keypress function fires everytime a key is pressed.</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>e:</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>event 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="logger.js.html">logger.js</a>, <a href="logger.js.html#line186">line 186</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".parse_stream"><span class="type-signature">(static) </span>parse_stream<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Parses stream array and creates history string</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line320">line 320</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".paste"><span class="type-signature">(static) </span>paste<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Paste function fires when the user pastes data from the clipboard.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line234">line 234</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".push_stream"><span class="type-signature">(static) </span>push_stream<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Pushes the current stream to the events queue</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line285">line 285</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".queue"><span class="type-signature">(static) </span>queue<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Queue results to be sent back to framework</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line350">line 350</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".start"><span class="type-signature">(static) </span>start<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Starts the logger</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line55">line 55</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".stop"><span class="type-signature">(static) </span>stop<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Stops the logger</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line130">line 130</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".submit"><span class="type-signature">(static) </span>submit<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Submit function fires whenever a form is submitted
TODO: Cleanup this function</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line247">line 247</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".win_blur"><span class="type-signature">(static) </span>win_blur<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Fires when the window element has lost focus</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line176">line 176</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".win_focus"><span class="type-signature">(static) </span>win_focus<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Fires when the window element has regained focus</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line167">line 167</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>