Files
beef/core/main/handlers/commands.rb
wheatley f33e2698a0 MAINTAINABILITY: 2257 update copyright 2022 (#2259)
* 2257 updated copyright date
2021-12-31 09:48:08 +10:00

111 lines
3.2 KiB
Ruby

#
# Copyright (c) 2006-2022 Wade Alcorn - wade@bindshell.net
# Browser Exploitation Framework (BeEF) - http://beefproject.com
# See the file 'doc/COPYING' for copying permission
#
module BeEF
module Core
module Handlers
class Commands
include BeEF::Core::Handlers::Modules::BeEFJS
include BeEF::Core::Handlers::Modules::Command
@data = {}
#
# Handles command data
#
# @param [Hash] data Data from command execution
# @param [Class] kclass Class of command
#
# @todo Confirm argument data variable type [radoen]: type is Hash confirmed.
#
def initialize(data, kclass)
@kclass = BeEF::Core::Command.const_get(kclass.capitalize)
@data = data
setup
end
#
# @note Initial setup function, creates the command module and saves details to datastore
#
def setup
@http_params = @data['request'].params
@http_header = {}
http_header = @data['request'].env.select { |k, v| k.to_s.start_with? 'HTTP_' }.each { |key, value|
@http_header[key.sub(/^HTTP_/, '')] = value.force_encoding('UTF-8')
}
# @note get and check command id from the request
command_id = get_param(@data, 'cid')
unless command_id.integer?
print_error "command_id is invalid"
return
end
# @note get and check session id from the request
beefhook = get_param(@data, 'beefhook')
unless BeEF::Filters.is_valid_hook_session_id?(beefhook)
print_error "BeEF hook is invalid"
return
end
result = get_param(@data, 'results')
# @note create the command module to handle the response
command = @kclass.new(BeEF::Module.get_key_by_class(@kclass))
command.build_callback_datastore(result, command_id, beefhook, @http_params, @http_header)
command.session_id = beefhook
command.post_execute if command.respond_to?(:post_execute)
# @todo this is the part that store result on db and the modify
# will be accessible from all the framework and so UI too
# @note get/set details for datastore and log entry
command_friendly_name = command.friendlyname
if command_friendly_name.empty?
print_error 'command friendly name is empty'
return
end
command_status = @data['status']
unless command_status.integer?
print_error 'command status is invalid'
return
end
command_results = @data['results']
if command_results.empty?
print_error 'command results are empty'
return
end
# @note save the command module results to the datastore and create a log entry
command_results = { 'data' => command_results }
BeEF::Core::Models::Command.save_result(
beefhook,
command_id,
command_friendly_name,
command_results,
command_status
)
end
#
# @note Returns parameter from hash
#
# @param [Hash] query Hash of data to return data from
# @param [String] key Key to search for and return inside `query`
#
# @return Value referenced in hash at the supplied key
#
def get_param(query, key)
return unless query.class == Hash
return unless query.key?(key)
query[key]
end
end
end
end
end