Hiddenden/beef
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'master' into dependabot/bundler/rubocop-1.62.1

Browse Source
This commit is contained in:
Stephen
2024-03-17 23:35:14 +00:00
parent f1d69d0301 ffdc303652
commit 62db76cdd9
9 changed files with 237 additions and 251 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
core/main/configuration.rb
View File

@@ -72,10 +72,12 @@ module BeEF
return unless validate_public_config_variable?(@config) return unless validate_public_config_variable?(@config)
# Note for developers:
# The configuration path 'beef.http.public_port' is deprecated.
# Use the new format for public_port variables as described in the BeEF project documentation.
# Refer to the BeEF configuration guide for the web server configuration details:
# https://github.com/beefproject/beef/wiki/Configuration#web-server-configuration
if @config['beef']['http']['public_port'] if @config['beef']['http']['public_port']
print_error 'Config path beef.http.public_port is deprecated.'
print_error 'Please use the new format for public variables found'
print_error 'https://github.com/beefproject/beef/wiki/Configuration#web-server-configuration'
return return
end end
@@ -277,13 +279,15 @@ module BeEF
private private
# Note for developers:
# The configuration path 'beef.http.public' is deprecated.
# Use the new format for public variables as described in the BeEF project documentation.
# Refer to the BeEF configuration guide for the web server configuration details:
# https://github.com/beefproject/beef/wiki/Configuration#web-server-configuration
def validate_public_config_variable?(config) def validate_public_config_variable?(config)
return true if config['beef']['http']['public'].is_a?(Hash) || return true if config['beef']['http']['public'].is_a?(Hash) ||
config['beef']['http']['public'].is_a?(NilClass) config['beef']['http']['public'].is_a?(NilClass)
print_error 'Config path beef.http.public is deprecated.'
print_error 'Please use the new format for public variables found'
print_error 'https://github.com/beefproject/beef/wiki/Configuration#web-server-configuration'
false false
end end
end end

10
core/module.rb
View File

@@ -301,9 +301,13 @@ module BeEF
targets = {} targets = {}
target_config.each do |k, v| target_config.each do |k, v|
next unless BeEF::Core::Constants::CommandModule.const_defined? "VERIFIED_#{k.upcase}" # Convert the key to a string if it's not already one
k_str = k.to_s.upcase
key = BeEF::Core::Constants::CommandModule.const_get "VERIFIED_#{k.upcase}"
# Use the adjusted string key for the rest of the process
next unless BeEF::Core::Constants::CommandModule.const_defined? "VERIFIED_#{k_str}"
key = BeEF::Core::Constants::CommandModule.const_get "VERIFIED_#{k_str}"
targets[key] = [] unless targets.key? key targets[key] = [] unless targets.key? key
browser = nil browser = nil

2
extensions/dns/model.rb
View File

@@ -12,7 +12,7 @@ module BeEF
# Hooks the model's "save" event. Validates pattern/response and generates a rule identifier. # Hooks the model's "save" event. Validates pattern/response and generates a rule identifier.
before_save :check_rule before_save :check_rule
self.table_name = 'dns_rules' self.table_name = 'dns_rules'
serialize :response, Array serialize :response, type: Array
private private

23
extensions/qrcode/qrcode.rb
View File

@@ -28,14 +28,25 @@ module BeEF
fullurls << target fullurls << target
# relative URLs # relative URLs
else else
# network interfaces
BeEF::Core::Console::Banners.interfaces.each do |int| # Retrieve the list of network interfaces from BeEF::Core::Console::Banners
next if int == '0.0.0.0' interfaces = BeEF::Core::Console::Banners.interfaces
fullurls << "#{beef_proto}://#{int}:#{beef_port}#{target}" # Check if the interfaces variable is nil, indicating that network interfaces are not available
if interfaces.nil?
print_error "[QR] Error: Network interfaces information is unavailable."
print_error "[QR] Error: This will be acceptable during testing."
else
# If interfaces are available, iterate over each network interface
interfaces.each do |int|
# Skip the loop iteration if the interface address is '0.0.0.0' (which generally represents all IPv4 addresses on the local machine)
next if int == '0.0.0.0'
# Construct full URLs using the network interface address, and add them to the fullurls array
# The URL is composed of the BeEF protocol, interface address, BeEF port, and the target path
fullurls << "#{beef_proto}://#{int}:#{beef_port}#{target}"
end
end end
# beef host
fullurls << "#{beef_proto}://#{beef_host}:#{beef_port}#{target}" unless beef_host == '0.0.0.0'
end end
end end

240
spec/beef/api/auth_rate_spec.rb
View File

@@ -1,137 +1,139 @@
# # #
# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net # # Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
# Browser Exploitation Framework (BeEF) - https://beefproject.com # # Browser Exploitation Framework (BeEF) - https://beefproject.com
# See the file 'doc/COPYING' for copying permission # # See the file 'doc/COPYING' for copying permission
# # #
RSpec.describe 'BeEF API Rate Limit' do # RSpec.describe 'BeEF API Rate Limit' do
before(:all) do # before(:all) do
@config = BeEF::Core::Configuration.instance # @config = BeEF::Core::Configuration.instance
@config.set('beef.credentials.user', "beef") # @config.set('beef.credentials.user', "beef")
@config.set('beef.credentials.passwd', "beef") # @config.set('beef.credentials.passwd', "beef")
@username = @config.get('beef.credentials.user') # @username = @config.get('beef.credentials.user')
@password = @config.get('beef.credentials.passwd') # @password = @config.get('beef.credentials.passwd')
# Load BeEF extensions and modules # # Load BeEF extensions and modules
# Always load Extensions, as previous changes to the config from other tests may affect # # Always load Extensions, as previous changes to the config from other tests may affect
# whether or not this test passes. # # whether or not this test passes.
print_info "Loading in BeEF::Extensions" # print_info "Loading in BeEF::Extensions"
BeEF::Extensions.load # BeEF::Extensions.load
sleep 2 # sleep 2
# Check if modules already loaded. No need to reload. # # Check if modules already loaded. No need to reload.
if @config.get('beef.module').nil? # if @config.get('beef.module').nil?
print_info "Loading in BeEF::Modules" # print_info "Loading in BeEF::Modules"
BeEF::Modules.load # BeEF::Modules.load
sleep 2 # sleep 2
else # else
print_info "Modules already loaded" # print_info "Modules already loaded"
end # end
# Grab DB file and regenerate if requested # # Grab DB file and regenerate if requested
print_info "Loading database" # print_info "Loading database"
db_file = @config.get('beef.database.file') # db_file = @config.get('beef.database.file')
if BeEF::Core::Console::CommandLine.parse[:resetdb] # if BeEF::Core::Console::CommandLine.parse[:resetdb]
print_info 'Resetting the database for BeEF.' # print_info 'Resetting the database for BeEF.'
File.delete(db_file) if File.exist?(db_file) # File.delete(db_file) if File.exist?(db_file)
end # end
# Load up DB and migrate if necessary # # Load up DB and migrate if necessary
ActiveRecord::Base.logger = nil # ActiveRecord::Base.logger = nil
OTR::ActiveRecord.migrations_paths = [File.join('core', 'main', 'ar-migrations')] # OTR::ActiveRecord.migrations_paths = [File.join('core', 'main', 'ar-migrations')]
OTR::ActiveRecord.configure_from_hash!(adapter:'sqlite3', database: db_file) # OTR::ActiveRecord.configure_from_hash!(adapter:'sqlite3', database: db_file)
# otr-activerecord require you to manually establish the connection with the following line # # otr-activerecord require you to manually establish the connection with the following line
#Also a check to confirm that the correct Gem version is installed to require it, likely easier for old systems. # #Also a check to confirm that the correct Gem version is installed to require it, likely easier for old systems.
if Gem.loaded_specs['otr-activerecord'].version > Gem::Version.create('1.4.2') # if Gem.loaded_specs['otr-activerecord'].version > Gem::Version.create('1.4.2')
OTR::ActiveRecord.establish_connection! # OTR::ActiveRecord.establish_connection!
end # end
context = ActiveRecord::Migration.new.migration_context
if context.needs_migration?
ActiveRecord::Migrator.new(:up, context.migrations, context.schema_migration).migrate
end
sleep 2 # # Migrate (if required)
# ActiveRecord::Migration.verbose = false # silence activerecord migration stdout messages
# context = ActiveRecord::Migration.new.migration_context
# if context.needs_migration?
# ActiveRecord::Migrator.new(:up, context.migrations, context.schema_migration, context.internal_metadata).migrate
# end
BeEF::Core::Migration.instance.update_db! # sleep 2
# Spawn HTTP Server # BeEF::Core::Migration.instance.update_db!
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 # # Spawn HTTP Server
BeEF::Core::Crypto::api_token # print_info "Starting HTTP Hook Server"
# http_hook_server = BeEF::Core::Server.instance
# http_hook_server.prepare
# Initiate server start-up # # Generate a token for the server to respond with
@pids = fork do # BeEF::Core::Crypto::api_token
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 # # Initiate server start-up
sleep 3 # @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
# Try to connect 3 times # # Give the server time to start-up
(0..2).each do |again| # sleep 3
# Authenticate to REST API & pull the token from the response
if @response.nil? # # Try to connect 3 times
print_info "Try to connect: " + again.to_s # (0..2).each do |again|
begin # # Authenticate to REST API & pull the token from the response
creds = { 'username': "#{@username}", 'password': "#{@password}" }.to_json # if @response.nil?
@response = RestClient.post "#{RESTAPI_ADMIN}/login", creds, :content_type => :json # print_info "Try to connect: " + again.to_s
rescue RestClient::ServerBrokeConnection, Errno::ECONNREFUSED # likely to be starting up still # begin
rescue => error # creds = { 'username': "#{@username}", 'password': "#{@password}" }.to_json
print_error error.message # @response = RestClient.post "#{RESTAPI_ADMIN}/login", creds, :content_type => :json
end # rescue RestClient::ServerBrokeConnection, Errno::ECONNREFUSED # likely to be starting up still
print_info "Rescue: sleep for 10 and try to connect again" # rescue => error
sleep 10 # print_error error.message
end # end
end # print_info "Rescue: sleep for 10 and try to connect again"
expect(@response) .to be_truthy # confirm the test has connected to the server # sleep 10
print_info "Connection with server was successful" # end
@token = JSON.parse(@response)['token'] # end
end # expect(@response) .to be_truthy # confirm the test has connected to the server
# print_info "Connection with server was successful"
# @token = JSON.parse(@response)['token']
# end
after(:all) do # after(:all) do
print_info "Shutting down server" # print_info "Shutting down server"
Process.kill("KILL",@pid) unless @pid.nil? # Process.kill("KILL",@pid) unless @pid.nil?
Process.kill("KILL",@pids) unless @pid.nil? # Process.kill("KILL",@pids) unless @pid.nil?
end # end
it 'adheres to auth rate limits' do # xit 'adheres to auth rate limits' do
passwds = (1..9).map { |i| "broken_pass"} # passwds = (1..9).map { |i| "broken_pass"}
passwds.push BEEF_PASSWD # passwds.push BEEF_PASSWD
apis = passwds.map { |pswd| BeefRestClient.new('http', ATTACK_DOMAIN, '3000', BEEF_USER, pswd) } # apis = passwds.map { |pswd| BeefRestClient.new('http', ATTACK_DOMAIN, '3000', BEEF_USER, pswd) }
l = apis.length # l = apis.length
(0..2).each do |again| # multiple sets of auth attempts # (0..2).each do |again| # multiple sets of auth attempts
# first pass -- apis in order, valid passwd on 9th attempt # # first pass -- apis in order, valid passwd on 9th attempt
# subsequent passes apis shuffled # # subsequent passes apis shuffled
puts "speed requesets" # all should return 401 # print_info "Starting authentication attempt sequence #{again + 1}. The valid password is placed randomly among failed attempts."
(0..50).each do |i| # (0..50).each do |i|
test_api = apis[i%l] # test_api = apis[i%l]
expect(test_api.auth()[:payload]).to eql("401 Unauthorized") # all (unless the valid is first 1 in 10 chance) # expect(test_api.auth()[:payload]).to eql("401 Unauthorized") # all (unless the valid is first 1 in 10 chance)
# t0 = t # end
end # # again with more time between calls -- there should be success (1st iteration)
# again with more time between calls -- there should be success (1st iteration) # print_info "Initiating delayed authentication requests to test successful authentication with correct credentials."
puts "delayed requests" # print_info "Delayed requests are made to simulate more realistic login attempts and verify rate limiting."
(0..(l*2)).each do |i| # (0..(l*2)).each do |i|
test_api = apis[i%l] # test_api = apis[i%l]
if (test_api.is_pass?(BEEF_PASSWD)) # if (test_api.is_pass?(BEEF_PASSWD))
expect(test_api.auth()[:payload]["success"]).to be(true) # valid pass should succeed # expect(test_api.auth()[:payload]["success"]).to be(true) # valid pass should succeed
else # else
expect(test_api.auth()[:payload]).to eql("401 Unauthorized") # expect(test_api.auth()[:payload]).to eql("401 Unauthorized")
end # end
sleep(0.5) # sleep(0.5)
# t0 = t # end
end # apis.shuffle! # new order for next iteration
apis.shuffle! # new order for next iteration # apis = apis.reverse if (apis[0].is_pass?(BEEF_PASSWD)) # prevent the first from having valid passwd
apis = apis.reverse if (apis[0].is_pass?(BEEF_PASSWD)) # prevent the first from having valid passwd # end # multiple sets of auth attempts
end # multiple sets of auth attempts # end
end
end # end

9
spec/beef/core/main/command_spec.rb
View File

@@ -1,8 +1,15 @@
RSpec.describe 'BeEF Command class testing' do RSpec.describe 'BeEF Command class testing' do
xit 'should return a beef configuration variable' do before(:each) do
# Reset or re-initialise the configuration to a default state
config = File.expand_path('../../../support/assets/config_old.yaml', __dir__)
@config_instance = BeEF::Core::Configuration.new(config)
end
it 'should return a beef configuration variable' do
BeEF::Modules.load BeEF::Modules.load
command_mock = BeEF::Core::Command.new('test_get_variable') command_mock = BeEF::Core::Command.new('test_get_variable')
expect(command_mock.config.beef_host).to eq('0.0.0.0') expect(command_mock.config.beef_host).to eq('0.0.0.0')
require 'modules/browser/hooked_domain/get_page_links/module' require 'modules/browser/hooked_domain/get_page_links/module'
gpl = Get_page_links.new('test_get_variable') gpl = Get_page_links.new('test_get_variable')
expect(gpl.config.beef_host).to eq('0.0.0.0') expect(gpl.config.beef_host).to eq('0.0.0.0')

155
spec/beef/extensions/requester_spec.rb
View File

@@ -1,7 +1,6 @@
require 'extensions/requester/extension' require 'extensions/requester/extension'
RSpec.describe 'BeEF Extension Requester' do RSpec.describe 'BeEF Extension Requester' do
before(:all) do before(:all) do
@config = BeEF::Core::Configuration.instance @config = BeEF::Core::Configuration.instance
@config.load_extensions_config @config.load_extensions_config
@@ -18,109 +17,61 @@ RSpec.describe 'BeEF Extension Requester' do
expect(requester).to respond_to(:requester_parse_db_request) expect(requester).to respond_to(:requester_parse_db_request)
end end
# default skipped because browser hooking not working properly in travis-CI
xit 'requester works' do xit 'requester works' do
# start beef server begin
# Start beef server
@config = BeEF::Core::Configuration.instance @config = BeEF::Core::Configuration.instance
@config.set('beef.credentials.user', "beef") @config.set('beef.credentials.user', 'beef')
@config.set('beef.credentials.passwd', "beef") @config.set('beef.credentials.passwd', 'beef')
#generate api token
BeEF::Core::Crypto::api_token
# load up DB
# Connect to DB
ActiveRecord::Base.logger = nil
OTR::ActiveRecord.migrations_paths = [File.join('core', 'main', 'ar-migrations')]
OTR::ActiveRecord.configure_from_hash!(adapter:'sqlite3', database:'beef.db')
# otr-activerecord require you to manually establish the connection with the following line
#Also a check to confirm that the correct Gem version is installed to require it, likely easier for old systems.
if Gem.loaded_specs['otr-activerecord'].version > Gem::Version.create('1.4.2')
OTR::ActiveRecord.establish_connection!
end
# Migrate (if required)
context = ActiveRecord::Migration.new.migration_context
if context.needs_migration?
puts "migrating db"
ActiveRecord::Migrator.new(:up, context.migrations, context.schema_migration).migrate
end
http_hook_server = BeEF::Core::Server.instance
http_hook_server.prepare
@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
# wait for server to start
sleep 1
https = BeEF::Core::Models::Http
### hook a new victim, use rest API to send request ###########
api = BeefRestClient.new('http', ATTACK_DOMAIN, '3000', BEEF_USER, BEEF_PASSWD)
response = api.auth()
@token = response[:token]
puts "authenticated. api token: #{@token}"
response = RestClient.get "#{RESTAPI_HOOKS}", {:params => {:token => @token}}
puts "hooks response: #{response}"
hb_details = JSON.parse(response.body)
puts "hb_details is empty: #{hb_details.empty?}"
while hb_details["hooked-browsers"]["online"].empty?
# get victim session
response = RestClient.get "#{RESTAPI_HOOKS}", {:params => {:token => @token}}
puts "hooks response: #{response}"
hb_details = JSON.parse(response.body)
puts "json: #{hb_details}"
puts "online hooked browsers empty: #{hb_details["hooked-browsers"]["online"].empty?}"
# Generate API token
BeEF::Core::Crypto::api_token
# Connect to DB
ActiveRecord::Base.logger = nil
OTR::ActiveRecord.migrations_paths = [File.join('core', 'main', 'ar-migrations')]
OTR::ActiveRecord.configure_from_hash!(adapter: 'sqlite3', database: 'beef.db')
OTR::ActiveRecord.establish_connection! if Gem.loaded_specs['otr-activerecord'].version > Gem::Version.create('1.4.2')
# Migrate if required
context = ActiveRecord::Migration.new.migration_context
ActiveRecord::Migrator.new(:up, context.migrations, context.schema_migration).migrate if context.needs_migration?
# Start HTTP hook server
http_hook_server = BeEF::Core::Server.instance
http_hook_server.prepare
@pids = fork { BeEF::API::Registrar.instance.fire(BeEF::API::Server, 'pre_http_start', http_hook_server) }
@pid = fork { http_hook_server.start }
# Wait for server to start
sleep 2
# Hook a new victim and use REST API to send request
api = BeefRestClient.new('http', ATTACK_DOMAIN, '3000', BEEF_USER, BEEF_PASSWD)
response = api.auth()
@token = response[:token]
while (response = RestClient.get("#{RESTAPI_HOOKS}", {params: {token: @token}})) &&
(hb_details = JSON.parse(response.body)) &&
hb_details['hooked-browsers']['online'].empty?
sleep 2
end
hb_session = hb_details['hooked-browsers']['online']['0']['session']
randreq = (0...8).map { (65 + rand(26)).chr }.join
RestClient.post("#{RESTAPI_REQUESTER}/send/#{hb_session}?token=#{@token}", "proto=http&raw_request=GET%20%2Ftest#{randreq}%20HTTP%2F1.1%0AHost%3A%20localhost%3A3000%0A")
sleep 2
sent_request = RestClient.get("#{RESTAPI_REQUESTER}/requests/#{hb_session}?token=#{@token}")
reqid = JSON.parse(sent_request)['requests'][0]['id']
response = RestClient.get("#{RESTAPI_REQUESTER}/response/#{reqid}?token=#{@token}")
expect(response)
ensure
# Clean up
BeEF::Core::Models::Http.where(hooked_browser_id: hb_session).delete_all if defined? hb_session
Process.kill('KILL', @pid) if defined? @pid
Process.kill('KILL', @pids) if defined? @pids
end end
hb_session = hb_details["hooked-browsers"]["online"]["0"]["session"]
puts "hooked browser: #{hb_session}"
# clear all previous victim requests
cleared = https.where(:hooked_browser_id => hb_session).delete_all
puts "cleared #{cleared} previous request entries"
# send a random request to localhost port 3000
randreq = (0...8).map { (65 + rand(26)).chr }.join
response = RestClient.post "#{RESTAPI_REQUESTER}/send/#{hb_session}?token=#{@token}", "proto=http&raw_request=GET%20%2Ftest#{randreq}%20HTTP%2F1.1%0AHost%3A%20localhost%3A3000%0A"
sleep 0.5
sent_request = RestClient.get "#{RESTAPI_REQUESTER}/requests/#{hb_session}?token=#{@token}"
puts "request sent: #{sent_request.to_json}"
sent_request = JSON.parse(sent_request)
reqid = sent_request["requests"][0]["id"]
puts "getting response for id #{reqid}"
response = RestClient.get "#{RESTAPI_REQUESTER}/response/#{reqid}?token=#{@token}"
expect(response)
###############################################################
# cleanup: delete test browser entries
https.where(:hooked_browser_id => hb_session).delete_all
# kill the server
Process.kill('KILL', @pid)
Process.kill('KILL', @pids)
puts "waiting for server to die.."
sleep 1
end end
end end

31
spec/beef/extensions/social_engineering_spec.rb
View File

@@ -5,19 +5,26 @@ require 'extensions/social_engineering/models/interceptor'
require 'fileutils' require 'fileutils'
RSpec.describe 'BeEF Extension Social Engineering' do RSpec.describe 'BeEF Extension Social Engineering' do
it 'checks if wget exists' do
it 'persistence web cloner' do expect(`which wget`).to include('/wget')
expect {
BeEF::Core::Models::WebCloner.create(uri: "example.com", mount: "/")
}.to_not raise_error
end end
xit 'clone web page' do context 'when wget exists' do
expect { before(:each) do
BeEF::Core::Server.instance.prepare allow_any_instance_of(BeEF::Extension::SocialEngineering::WebCloner).to receive(:system).and_return(false) # Stub to simulate failure
BeEF::Extension::SocialEngineering::WebCloner.instance.clone_page("https://www.google.com", "/", nil, nil) end
}.to_not raise_error
FileUtils.rm(Dir['./extensions/social_engineering/web_cloner/cloned_pages/www.google.com']) xit 'clone web page', if: !`which wget`.empty? do
FileUtils.rm(Dir['./extensions/social_engineering/web_cloner/cloned_pages/www.google.com_mod']) expect {
BeEF::Core::Server.instance.prepare
BeEF::Extension::SocialEngineering::WebCloner.instance.clone_page("https://www.google.com", "/", nil, nil)
}.to_not raise_error
end
it 'persistence web cloner', if: !`which wget`.empty? do
expect {
BeEF::Core::Models::WebCloner.create(uri: "example.com", mount: "/")
}.to_not raise_error
end
end end
end end

2
spec/spec_helper.rb
View File

@@ -22,7 +22,7 @@ Dir['spec/support/*.rb'].each do |f|
end end
ENV['RACK_ENV'] ||= 'test' ENV['RACK_ENV'] ||= 'test'
ARGV = [] ARGV.clear
## BrowserStack config ## BrowserStack config