Updated Copyright

Update Ruby Version - Complete

.bundle/config

@@ -1,2 +1,3 @@
 ---
 BUNDLE_WITHOUT: "development:test"
+BUNDLE_WITH: "geoip:ext_msf:ext_notifications:ext_dns:ext_qrcode"

.dockerignore

@@ -0,0 +1,8 @@
+# Don't copy over git files
+.git
+.github
+.gitignore
+doc
+docs
+test
+update-beef

.github/ISSUE_TEMPLATE.md

@@ -1,66 +1,31 @@
-# Submit Issue
-
-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/v0.5.2.0).
-
-Please do your best to provide as much information as possible. It will help substantially if you can enable and provide debugging logs with your issue. Instructions for enabling debugging logs are below:
-
-1. In the `config.yaml` file of your BeEF root folder set debug and client_debug (lines 11 & 13 respectively) to `true`
-   * If using a standard installation of `beef-xss` the root folder will typically be `/usr/share/beef-xss`
-2. Reproduce your error
-3. Retrieve your client-side logs from your browser's developer console (Ctrl + Shift + I)
-4. Retrieve your server-side logs from `~/.beef/beef.log`
-5. **If using `beef-xss`:** Retrieve your service logs using `journalctl -u beef-xss`
-
-Thank you, this will greatly aid us in identifying the root cause of your issue :)
-
-**If we request additional information and we don't hear back from you within a week, we will be closing the ticket off.**
-Feel free to open it back up if you continue to have issues. 
-
-## Summary
-
-**Q:** Please provide a brief summary of the issue that you experienced.
-**A:**
-
-## Environment
-
-*Please identify the environment in which your issue occurred.*
-
-1. **BeEF Version:**
-
-2. **Ruby Version:**
-
-3. **Browser Details (e.g. Chrome v81.0):**
-
-4. **Operating System (e.g. OSX Catalina):**
+## First Steps
 
+1. Confirm that your issue has not been posted previously by searching here: https://github.com/beefproject/beef/issues
+2. Confirm that the wiki does not contain the answers you seek: https://github.com/beefproject/beef/wiki
+3. Check the FAQ: https://github.com/beefproject/beef/wiki/FAQ
+4. BeEF Version:
+5. Ruby Version:
+6. Browser Details (e.g. Chrome v81.0):
+7. Operating System (e.g. OSX Catalina):
 
 ## Configuration
 
-**Q:** Have you made any changes to your BeEF configuration? 
-**A:**
-
-**Q:** Have you enabled or disabled any BeEF extensions?
-**A:**
-
-## Expected vs. Actual Behaviour
-
-**Expected Behaviour:** 
-<br />
-**Actual Behaviour:**
-<br />
+1. Have you made any changes to your BeEF configuration? Yes/No
+2. Have you enabled or disabled any BeEF extensions? Yes/No
 
 ## Steps to Reproduce
 
-*Please provide steps to reproduce this issue.*
+1. (eg. I ran install script, which ran fine)
+2. (eg. when launching console with './beef' I get an error as follows: <error here>)
+3. (eg. beef does not launch)
 
-1.
+## How to enable and capture detailed logging
 
+1. Edit `config.yaml` in the root directory
+   * If using Kali **beef-xss** the root dir will be  `/usr/share/beef-xss`
+2. Update `client_debug` to `true`
+3. Retrieve browser logs from your browser's developer console (Ctrl + Shift + I or F12 depending on browser)
+4. Retrieve your server-side logs from `~/.beef/beef.log`
+   * If using **beef-xss** logs found with `journalctl -u beef-xss`
 
-## 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 retrieved by following the instructions towards the top of the issue template.
+**If we request additional information and we don't hear back from you within a week, we will be closing the ticket off.**

.github/workflows/codeql.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '36 1 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript', 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    # - name: Autobuild
+    #  uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

.github/workflows/github_actions.yml

@@ -0,0 +1,63 @@
+name: 'BrowserStack Test'
+
+on:
+  pull_request_target:
+    branches: [ master ]
+      
+jobs:
+  approve:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Approve
+      run: echo For security reasons, all pull requests need to be approved first before running any automated CI.
+      
+  ubuntu-job:
+    name: 'BrowserStack Test on Ubuntu'
+    runs-on: ubuntu-latest  # Can be self-hosted runner also
+    environment:
+      name: Integrate Pull Request
+    env: 
+      GITACTIONS: true
+    steps:
+
+      - name: 'BrowserStack Env Setup'  # Invokes the setup-env action
+        uses: browserstack/github-actions/setup-env@master
+        with:
+          username:  ${{ secrets.BROWSERSTACK_USERNAME }}
+          access-key: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
+
+      - name: 'BrowserStack Local Tunnel Setup'  # Invokes the setup-local action
+        uses: browserstack/github-actions/setup-local@master
+        with:
+          local-testing: start
+          local-identifier: random
+
+      - name: 'Checkout the repository'
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+          fetch-depth: 2
+
+      - name: 'Setting up Ruby'
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.3 # Not needed with a .ruby-version file
+
+      - name: 'Update and Install Dwpendencies'
+        run: |
+          sudo apt update
+          sudo apt install libcurl4 libcurl4-openssl-dev
+      - name: 'Configure Bundle testing and install gems'
+        run: |
+          bundle config unset --local without
+          bundle config set --local with 'test' 'development'
+          bundle install
+      - name: 'Run BrowserStack simple verification'
+        run: |
+          bundle exec rake browserstack --trace
+
+      - name: 'BrowserStackLocal Stop'  # Terminating the BrowserStackLocal tunnel connection
+        uses: browserstack/github-actions/setup-local@master
+        with:
+          local-testing: stop

.github/workflows/stale.yml

@@ -0,0 +1,35 @@
+# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
+#
+# You can adjust the behavior by modifying this file.
+# For more information, see:
+# https://github.com/actions/stale
+name: Mark stale issues and pull requests
+
+on:
+  schedule:
+  - cron: '5 * * * *'
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+
+    steps:
+    - uses: actions/stale@v5
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        days-before-stale: 7
+        days-before-pr-stale: 14
+        days-before-close: 7
+        days-before-pr-close: 14
+        stale-issue-message: 'This issue as been marked as stale due to inactivity and will be closed in 7 days'
+        stale-pr-message: 'Stale pull request message'
+        stale-issue-label: 'Stale'
+        stale-pr-label: 'no-pr-activity'
+        exempt-issue-labels: 'Critical, High, Low, Medium, Review, Backlog'
+        exempt-milestones: true
+        exempt-draft-pr: true
+        start-date: '2022-06-15'

.gitignore

@@ -9,7 +9,6 @@ custom-config.yaml
 .rvmrc
 beef.log
 
-*.lock
 
 extensions/metasploit/msf-exploits.cache
 

.rubocop.yml

@@ -4,7 +4,8 @@ AllCops:
     - 'tmp/**/*'
     - 'tools/**/*'
     - 'doc/**/*'
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
+  NewCops: enable
 
 Layout/LineLength:
   Enabled: true
@@ -22,57 +23,20 @@ Metrics/ClassLength:
 Metrics/MethodLength:
   Enabled: false
 
+Metrics/ModuleLength:
+  Enabled: false
+
 Metrics/PerceivedComplexity:
   Enabled: false
 
 Metrics/CyclomaticComplexity:
   Enabled: false
 
+Naming/ClassAndModuleCamelCase:
+  Enabled: false
+
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-# TODO: review these
-Layout/SpaceBeforeBrackets:
-  Enabled: false
-Lint/AmbiguousAssignment:
-  Enabled: false
-Lint/DeprecatedConstants:
-  Enabled: false
-Lint/DuplicateBranch:
-  Enabled: false
-Lint/DuplicateRegexpCharacterClassElement:
-  Enabled: false
-Lint/EmptyBlock:
-  Enabled: false
-Lint/EmptyClass:
-  Enabled: false
-Lint/LambdaWithoutLiteralBlock:
-  Enabled: false
-Lint/NoReturnInBeginEndBlocks:
-  Enabled: false
-Lint/RedundantDirGlobSort:
-  Enabled: false
-Lint/ToEnumArguments:
-  Enabled: false
-Lint/UnexpectedBlockArity:
-  Enabled: false
-Lint/UnmodifiedReduceAccumulator:
-  Enabled: false
-Style/ArgumentsForwarding:
-  Enabled: false
-Style/CollectionCompact:
-  Enabled: false
-Style/DocumentDynamicEvalDefinition:
-  Enabled: false
-Style/EndlessMethod:
-  Enabled: false
-Style/HashExcept:
-  Enabled: false
-Style/NegatedIfElseCondition:
-  Enabled: false
-Style/NilLambda:
-  Enabled: false
-Style/RedundantArgument:
-  Enabled: false
-Style/SwapValues:
+Style/Documentation:
   Enabled: false

.ruby-version

@@ -1 +1 @@
-2.7.2
+3.0.3

.travis.yml

@@ -1,99 +0,0 @@
-language: ruby
-rvm:
-- 2.5.3
-- 2.6.0
-- 2.6.3
-- 2.6.5
-- 2.7.0
-notifications:
-  email:
-    recipients:
-      - wade@bindshell.net
-  on_success: always
-  on_failure: always
-branches:
-  only:
-  - master
-  - browserstack
-before_script:
-  - RUBY_VERSION=/bin/bash rvm current
-  - sed -i -E 's/system\((.*?)\)/""/g' /home/travis/.rvm/gems/$RUBY_VERSION/gems/browserstack-local-1.3.0/lib/browserstack/local.rb
-env:
-  - CONFIG_FILE=osx/catalina/catalina_chrome_41.config.yml
-  - CONFIG_FILE=osx/catalina/catalina_chrome_59.config.yml
-  - CONFIG_FILE=osx/catalina/catalina_chrome_81.config.yml
-  - CONFIG_FILE=osx/catalina/catalina_firefox_11.config.yml
-  - CONFIG_FILE=osx/catalina/catalina_firefox_68esr.config.yml
-  - CONFIG_FILE=osx/catalina/catalina_firefox_75.config.yml
-  - CONFIG_FILE=osx/catalina/catalina_safari_13.config.yml
-  - CONFIG_FILE=osx/elcapitan/elcapitan_chrome_14.config.yml
-  - CONFIG_FILE=osx/elcapitan/elcapitan_chrome_81.config.yml
-  - CONFIG_FILE=osx/elcapitan/elcapitan_firefox_7.config.yml
-  - CONFIG_FILE=osx/elcapitan/elcapitan_firefox_75.config.yml
-  - CONFIG_FILE=osx/elcapitan/elcapitan_safari_9-1.config.yml
-  - CONFIG_FILE=osx/snowleopard/snowleopard_chrome_14.config.yml
-  - CONFIG_FILE=osx/snowleopard/snowleopard_chrome_35.config.yml
-  - CONFIG_FILE=osx/snowleopard/snowleopard_chrome_49.config.yml
-  - CONFIG_FILE=osx/snowleopard/snowleopard_firefox_7.config.yml
-  - CONFIG_FILE=osx/snowleopard/snowleopard_firefox_38esr.config.yml
-  - CONFIG_FILE=osx/snowleopard/snowleopard_firefox_42.config.yml
-  - CONFIG_FILE=osx/snowleopard/snowleopard_safari_5-1.config.yml
-  - CONFIG_FILE=windows/win10/win10_chrome_37.config.yml
-  - CONFIG_FILE=windows/win10/win10_chrome_59.config.yml
-  - CONFIG_FILE=windows/win10/win10_firefox_32.config.yml
-  - CONFIG_FILE=windows/win10/win10_firefox_68esr.config.yml
-  - CONFIG_FILE=windows/win10/win10_firefox_75.config.yml
-  - CONFIG_FILE=windows/win10/win10_edge_81.config.yml
-  - CONFIG_FILE=windows/win10/win10_ie_11.config.yml
-  - CONFIG_FILE=windows/win8/win8_chrome_22.config.yml
-  - CONFIG_FILE=windows/win8/win8_chrome_81.config.yml
-  - CONFIG_FILE=windows/win8/win8_firefox_32.config.yml
-  - CONFIG_FILE=windows/win8/win8_firefox_75.config.yml
-  - CONFIG_FILE=windows/win8/win8_edge_81.config.yml
-  - CONFIG_FILE=windows/win8/win8_ie_10.config.yml
-  - CONFIG_FILE=windows/xp/xp_chrome_14.config.yml
-  - CONFIG_FILE=windows/xp/xp_chrome_28.config.yml
-  - CONFIG_FILE=windows/xp/xp_chrome_43.config.yml
-  - CONFIG_FILE=windows/xp/xp_firefox_16.config.yml
-  - CONFIG_FILE=windows/xp/xp_firefox_26.config.yml
-  - CONFIG_FILE=windows/xp/xp_firefox_45.config.yml
-  - CONFIG_FILE=windows/xp/xp_ie_7.config.yml
-jobs:
-  include:
-    - name: "Full Test Suite 2.5.3"
-      rvm: 2.5.3
-      env: CONFIG_FILE=windows/win10/win10_chrome_81.config.yml
-      script: bundle exec rspec
-    - name: "Full Test Suite 2.6.0"
-      rvm: 2.6.0
-      env: CONFIG_FILE=windows/win10/win10_chrome_81.config.yml
-      script: bundle exec rspec
-    - name: "Full Test Suite 2.6.3"
-      rvm: 2.6.3
-      env: CONFIG_FILE=windows/win10/win10_chrome_81.config.yml
-      script: bundle exec rspec
-    - name: "Full Test Suite 2.6.5"
-      rvm: 2.6.5
-      env: CONFIG_FILE=windows/win10/win10_chrome_81.config.yml
-      script: bundle exec rspec
-    - name: "Full Test Suite 2.7.0"
-      rvm: 2.7.0
-      env: CONFIG_FILE=windows/win10/win10_chrome_81.config.yml
-      script: bundle exec rspec
-script:
-  - bundle exec rspec --tag run_on_browserstack
-addons:
-  apt:
-    packages:
-    - libsqlite3-dev
-    - build-essential
-    - patch
-    - ruby-dev
-    - zlib1g-dev
-    - liblzma-dev
-    - libcurl4-openssl-dev
-  browserstack:
-    username:
-      secure: "Yj+a2jY56dFqJwXdU6JdSXeKhhS01CiToBoB922SXVnA2D2WclGOFiTi0YrkAS9PuOJX5AjC9eUw7VFUcp8DiLmeDGLWo8klYrWQoJOH55FmSWKjdkqDopJFYr0ZXk/ZuXzzpuMvKkCT5MGFnySXyheTW8aUj33GetJ6/sNq5BoA36jH04OE3iPgdBaFPRNDVXEIWLaLUDQsAyZsHNNYC+/cj3cxjXLHu+mbNuXsXEHgrHJ2A94EWdrdGODWL8mRtlSDNkIaYHZKCBnUlHWwCwBitLsjhzdy0YFrIGVbX96FV+C41sjPWLFjZhjAaNDuJ3FoTplbzFNvrw5oxQAAI8ZZqUwF4MRIrQbN8BLFVISX7JooQjfyrNVWvhpZWGPB4GZTN4CThrlQ7G7CJRYDVyqZ7nen6y0+osBr9DRKN+EemlVG73aNP3mXaZr6BmS1BpQJ6tlqDdLCvC5j/PdguKwvt4EmgHA8Pzn20UElV+8BPblcYGjsWplk/cxW1adW0pu2vIxskKxDKJ/ReY3l5yUpiQPZHbuMidq2ffSX0B3yALe7vx+3AvMb2Fk9yWh52EVJXPkVlLvhP7wDd22MHCemvrC2nLhkVR4MglLWs7dZKHswExlKJdWK4OSXprOStjZSA47sjF2nPdztWTpdI77SKaBcoLGR5WOV+JtcQgk="
-    access_key:
-      secure: "KHlR8NHPnoF9U1CJKgUhS1YhPSeTILI2lIu+JilQ5Xeo7rcbWg9lT2xwQQNnLYrISG1vC6OzsbkcnC/3ZnAv7jYff4iUTc3Syszs5wIhhvnhBx4qCxM+/UD78TJNQ0AuY7NOIK6OXcmwbpZrOBUojZkooEkc8bpG56nb2v7dOIafFLV+tv9xcc5DtMSfh7FavhqRFRO+PCybqOW8yWMc2NiMYy3p9jKBC3qYRqme4hx1NRrLo5BZQ+UIcO3Rf+vAjUP+3gGuhWeu2kDCvZYDnI2GN1/WacRVY2cqDPGiYlD6pHNMqU0raYKyWdK0QD4KwYpfjxBGRmwBfz8xU8KWUEZ3P11mJn+BvIt0qe3VpomR0/60/fok1BEso3nea8oENXur5G/5SOfpkPLjzd4P4f7JYnST1PeeWwpzV305wktDv9aLc+Ne9cFCaxSaaCnOk82rKDhtnktwnK7krFj1lM6oygtOD+arAytPKaURRgV2izaoophiXuLFb+9XKSkMGtJ3e+rQATonnDPaFTzouKaXSEPxZQQ2bnsp9tETAReDrYIwPHuYL778UbbBICgNk54CZSfTeRFLroRGNPb/0gPXbu6SryPnknfCMNd7ksSndVoyKsDo1plTHQJGVweP2hxR3R/9syk9Z6DU6H5H3dc/RbkkmoRPVooUtR/mZ/c="

BeEF.postman_environment.json

@@ -1,49 +0,0 @@
-{
-	"id": "3b5f29e6-c8eb-4d23-bf52-c01255f22f08",
-	"name": "BeEF",
-	"values": [
-		{
-			"key": "hostname",
-			"value": "127.0.0.1",
-			"enabled": true
-		},
-		{
-			"key": "username",
-			"value": "beef",
-			"enabled": true
-		},
-		{
-			"key": "password",
-			"value": "beef",
-			"enabled": true
-		},
-		{
-			"key": "token",
-			"value": "",
-			"enabled": true
-		},
-		{
-			"key": "session",
-			"value": "",
-			"enabled": true
-		},
-		{
-			"key": "module_id",
-			"value": "",
-			"enabled": true
-		},
-		{
-			"key": "cmd_id",
-			"value": "",
-			"enabled": true
-		},
-		{
-			"key": "dnsrule_id",
-			"value": "",
-			"enabled": true
-		}
-	],
-	"_postman_variable_scope": "environment",
-	"_postman_exported_at": "2020-01-03T06:00:29.827Z",
-	"_postman_exported_using": "Postman/7.14.0"
-}

Dockerfile

@@ -4,61 +4,85 @@
 ##   Please read the Wiki Installation section on set-up using Docker prior to building this container.  ##
 ##   BeEF does NOT allow authentication with default credentials. So please, at the very least           ##
 ##   change the username:password in the config.yaml file to something secure that is not beef:beef      ##
-##   before building or you will to denied access and have to rebuild anyway.                            ##
+##   before building or you will be denied access and have to rebuild anyway.                            ##
 ##                                                                                                       ##
 ###########################################################################################################
 ###########################################################################################################
 
 # ---------------------------- Start of Builder 0 - Gemset Build ------------------------------------------
-FROM ruby:2.6.3-alpine AS builder
-LABEL maintainer="Beef Project: github.com/beefproject/beef"
-
-# Install gems in parallel with 4 workers to expedite build process.=
-ARG BUNDLER_ARGS="--jobs=4" 
-
-# Set gemrc config to install gems without Ruby Index (ri) and Ruby Documentation (rdoc) files
-RUN echo "gem: --no-ri --no-rdoc" > /etc/gemrc
+FROM ruby:3.2.1-slim-bullseye AS builder
 
 COPY . /beef
 
-# Add bundler/gem dependencies and then install 
-RUN apk add --no-cache git curl libcurl curl-dev ruby-dev libffi-dev make g++ gcc musl-dev zlib-dev sqlite-dev && \
-  bundle install --system --clean --no-cache --gemfile=/beef/Gemfile $BUNDLER_ARGS && \
-  # Temp fix for https://github.com/bundler/bundler/issues/6680
-  rm -rf /usr/local/bundle/cache
-
-WORKDIR /beef
-
-# So we don't need to run as root
-RUN chmod -R a+r /usr/local/bundle
+# Set gemrc config to install gems without Ruby Index (ri) and Ruby Documentation (rdoc) files.
+# Then add bundler/gem dependencies and install.
+# Finally change permissions of bundle installs so we don't need to run as root.
+RUN echo "gem: --no-ri --no-rdoc" > /etc/gemrc \
+ && apt-get update \
+ && apt-get install -y --no-install-recommends \
+    git \
+    curl \
+    xz-utils \
+    make \
+    g++ \
+    libcurl4-openssl-dev \
+    ruby-dev \
+    libffi-dev \
+    zlib1g-dev \
+    libsqlite3-dev \
+    sqlite3 \
+ && bundle install --gemfile=/beef/Gemfile --jobs=`nproc` \
+ && rm -rf /usr/local/bundle/cache \
+ && chmod -R a+r /usr/local/bundle \
+ && rm -rf /var/lib/apt/lists/*
 # ------------------------------------- End of Builder 0 -------------------------------------------------
 
 
 # ---------------------------- Start of Builder 1 - Final Build ------------------------------------------
-FROM ruby:2.6.3-alpine
-LABEL maintainer="Beef Project: github.com/beefproject/beef"
+FROM ruby:3.2.1-slim-bullseye
+LABEL maintainer="Beef Project" \
+      source_url="github.com/beefproject/beef" \
+      homepage="https://beefproject.com/"
 
-# Create service account to run BeEF
-RUN adduser -h /beef -g beef -D beef
+# BeEF UI/Hook port
+ARG UI_PORT=3000
+ARG PROXY_PORT=6789
+ARG WEBSOCKET_PORT=61985
+ARG WEBSOCKET_SECURE_PORT=61986
 
-COPY . /beef
+
+# Create service account to run BeEF and install BeEF's runtime dependencies
+RUN adduser --home /beef --gecos beef --disabled-password beef \
+ && apt-get update \
+ && apt-get install -y --no-install-recommends \
+    curl \
+    openssl \
+    libssl-dev \
+    libreadline-dev \
+    libyaml-dev \
+    libxml2-dev \
+    libxslt-dev \
+    libncurses5-dev \
+    libsqlite3-dev \
+    sqlite3 \
+    zlib1g \
+    bison \
+    nodejs \
+ && apt-get -y clean \
+ && rm -rf /var/lib/apt/lists/*
 
 # Use gemset created by the builder above
+COPY --chown=beef:beef . /beef
 COPY --from=builder /usr/local/bundle /usr/local/bundle
 
-# Grant beef service account owner and groups rights over our BeEF working directory.
-RUN chown -R beef:beef /beef
-
-# Install BeEF's runtime dependencies
-RUN apk add --no-cache curl git build-base openssl readline-dev zlib zlib-dev libressl-dev yaml-dev sqlite-dev sqlite libxml2-dev libxslt-dev autoconf libc6-compat ncurses5 automake libtool bison nodejs
-
-WORKDIR /beef
-
 # Ensure we are using our service account by default
 USER beef
 
-# Expose UI, Proxy, WebSocket server, and WebSocketSecure server
-EXPOSE 3000 6789 61985 61986
+# Expose UI, Proxy, WebSocket server, and WebSocketSecure server ports
+EXPOSE $UI_PORT $PROXY_PORT $WEBSOCKET_PORT $WEBSOCKET_SECURE_PORT
 
+HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 CMD [ "curl", "-fS", "localhost:$UI_PORT" ]
+
+WORKDIR /beef
 ENTRYPOINT ["/beef/beef"]
 # ------------------------------------- End of Builder 1 -------------------------------------------------

Gemfile

@@ -1,93 +1,91 @@
-# BeEF's Gemfile
-
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 #gem 'simplecov', require: false, group: :test
-gem 'eventmachine'
-gem 'thin'
-gem 'sinatra', '>= 2.0.2'
-gem 'rack', '>= 2.2.3'
-gem 'rack-protection', '>= 2.0.0'
-gem 'em-websocket' # WebSocket support
-gem 'uglifier', '>= 2.7.2'
-gem 'mime-types'
-gem 'execjs'
-gem 'ansi'
-gem 'term-ansicolor', :require => 'term/ansicolor'
+
+gem 'net-smtp', require: false
 gem 'json'
-gem 'rubyzip', '>= 1.2.2'
-gem 'espeak-ruby', '>= 1.0.4' # Text-to-Voice
-gem 'nokogiri', '>= 1.11.1'
-gem 'rake', '>= 12.3.3'
-gem 'otr-activerecord', '>= 1.4.2'
-gem 'sqlite3'
-gem 'rubocop', '~> 1.20.0', require: false
+
+gem 'eventmachine', '~> 1.2', '>= 1.2.7'
+gem 'thin', '~> 1.8'
+gem 'sinatra', '~> 3.0'
+gem 'rack', '~> 2.2'
+gem 'rack-protection', '~> 3.0.5'
+gem 'em-websocket', '~> 0.5.3' # WebSocket support
+gem 'uglifier', '~> 4.2'
+gem 'mime-types', '~> 3.4', '>= 3.4.1'
+gem 'execjs', '~> 2.9'
+gem 'ansi', '~> 1.5'
+gem 'term-ansicolor', :require => 'term/ansicolor'
+gem 'rubyzip', '~> 2.3'
+gem 'espeak-ruby', '~> 1.1.0' # Text-to-Voice
+gem 'rake', '~> 13.1'
+# gem 'otr-activerecord', '~> 2.1', '>= 2.1.2'
+gem 'otr-activerecord', '= 2.1.2'
+gem 'sqlite3', '~> 1.6'
+gem 'rubocop', '~> 1.59.0', require: false
 
 # Geolocation support
 group :geoip do
-  gem 'maxmind-db'
+  gem 'maxmind-db', '~> 1.2'
 end
 
-gem 'parseconfig'
-gem 'erubis'
+gem 'parseconfig', '~> 1.1', '>= 1.1.2'
+gem 'erubis', '~> 2.7'
 
 # Metasploit Integration extension
 group :ext_msf do
-  gem 'msfrpc-client'
-  gem 'xmlrpc'
+  gem 'msfrpc-client', '~> 1.1', '>= 1.1.2'
+  gem 'xmlrpc', '~> 0.3.3'
 end
 
 # Notifications extension
 group :ext_notifications do
   # Pushover
-  gem 'rushover'
+  gem 'rushover', '~> 0.3.0'
   # Slack
-  gem 'slack-notifier'
-  # Twitter
-  gem 'twitter', '>= 5.0.0'
+  gem 'slack-notifier', '~> 2.4'
 end
 
 # DNS extension
 group :ext_dns do
-  gem 'async-dns'
+  gem 'async-dns', '~> 1.3'
+  gem 'async', '~> 1.31'
 end
 
 # QRcode extension
 group :ext_qrcode do
-  gem 'qr4r'
+  gem 'qr4r', '~> 0.6.1'
 end
 
 # For running unit tests
 group :test do
-    gem 'test-unit'
-    gem 'test-unit-full'
-    gem 'rspec'
-    gem 'rdoc'
+    gem 'test-unit-full', '~> 0.0.5'
+    gem 'rspec', '~> 3.12'
+    gem 'rdoc', '~> 6.6'
+    gem 'browserstack-local', '~> 1.4'
+
+    gem 'irb', '~> 1.11'
+    gem 'pry-byebug', '~> 3.10', '>= 3.10.1'
+
+    gem 'rest-client', '~> 2.1.0'
+    gem 'websocket-client-simple', '~> 0.6.1'
+
     # curb gem requires curl libraries
     # sudo apt-get install libcurl4-openssl-dev
-    gem 'curb'
+    gem 'curb', '~> 1.0', '>= 1.0.5'
+
     # 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
+    gem 'geckodriver-helper', '~> 0.24.0'
+    gem 'selenium-webdriver', '~> 4.16'
+
+    # nokogiri 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'
-    gem "websocket-client-simple", "~> 0.3.0"
-    gem "browserstack-local", "~> 1.3"
+    gem 'capybara', '~> 3.39'
 end
 
 source 'https://rubygems.org'
-
-
-
-
-

Gemfile.lock

@@ -0,0 +1,281 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activerecord (7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    ansi (1.5.0)
+    archive-zip (0.12.0)
+      io-like (~> 0.3.0)
+    ast (2.4.2)
+    async (1.31.0)
+      console (~> 1.10)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
+    async-dns (1.3.0)
+      async-io (~> 1.15)
+    async-io (1.34.3)
+      async
+    browserstack-local (1.4.3)
+    byebug (11.1.3)
+    capybara (3.39.2)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    console (1.16.2)
+      fiber-local
+    curb (1.0.5)
+    daemons (1.4.1)
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    erubis (2.7.0)
+    espeak-ruby (1.1.0)
+    event_emitter (0.2.6)
+    eventmachine (1.2.7)
+    execjs (2.9.1)
+    fiber-local (1.0.0)
+    geckodriver-helper (0.24.0)
+      archive-zip (~> 0.7)
+    hashie (5.0.0)
+    hashie-forbidden_attributes (0.1.1)
+      hashie (>= 3.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    http_parser.rb (0.8.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.1)
+    io-like (0.3.1)
+    irb (1.11.0)
+      rdoc
+      reline (>= 0.3.8)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    matrix (0.4.2)
+    maxmind-db (1.2.0)
+    method_source (1.0.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2023.0218.1)
+    mini_mime (1.1.2)
+    minitest (5.18.0)
+    mojo_magick (0.6.7)
+    msfrpc-client (1.1.2)
+      msgpack (~> 1)
+    msgpack (1.6.1)
+    mustermann (3.0.0)
+      ruby2_keywords (~> 0.0.1)
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.4.0)
+      net-protocol
+    netrc (0.11.0)
+    nio4r (2.5.8)
+    nokogiri (1.15.2-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.2-x86_64-linux)
+      racc (~> 1.4)
+    otr-activerecord (2.1.2)
+      activerecord (>= 4.0, < 7.1)
+      hashie-forbidden_attributes (~> 0.1)
+    parallel (1.24.0)
+    parseconfig (1.1.2)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    power_assert (2.0.3)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    psych (5.1.2)
+      stringio
+    public_suffix (5.0.1)
+    qr4r (0.6.1)
+      mojo_magick (~> 0.6.5)
+      rqrcode_core (~> 0.1)
+    racc (1.7.3)
+    rack (2.2.7)
+    rack-protection (3.0.6)
+      rack
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    regexp_parser (2.8.3)
+    reline (0.4.1)
+      io-console (~> 0.5)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.6)
+    rqrcode_core (0.2.0)
+    rr (3.1.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    rubyzip (2.3.2)
+    rushover (0.3.0)
+      json
+      rest-client
+    selenium-webdriver (4.16.0)
+      rexml (~> 3.2, >= 3.2.5)
+      rubyzip (>= 1.2.2, < 3.0)
+      websocket (~> 1.0)
+    sinatra (3.0.6)
+      mustermann (~> 3.0)
+      rack (~> 2.2, >= 2.2.4)
+      rack-protection (= 3.0.6)
+      tilt (~> 2.0)
+    slack-notifier (2.4.0)
+    sqlite3 (1.6.9-arm64-darwin)
+    sqlite3 (1.6.9-x86_64-linux)
+    stringio (3.1.0)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    test-unit (3.5.7)
+      power_assert
+    test-unit-context (0.5.1)
+      test-unit (>= 2.4.0)
+    test-unit-full (0.0.5)
+      test-unit
+      test-unit-context
+      test-unit-notify
+      test-unit-rr
+      test-unit-runner-tap
+    test-unit-notify (1.0.4)
+      test-unit (>= 2.4.9)
+    test-unit-rr (1.0.5)
+      rr (>= 1.1.1)
+      test-unit (>= 2.5.2)
+    test-unit-runner-tap (1.1.2)
+      test-unit
+    thin (1.8.2)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+    tilt (2.1.0)
+    timeout (0.4.0)
+    timers (4.3.5)
+    tins (1.32.1)
+      sync
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    uglifier (4.2.0)
+      execjs (>= 0.3.0, < 3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    websocket (1.2.10)
+    websocket-client-simple (0.6.1)
+      event_emitter
+      websocket
+    xmlrpc (0.3.3)
+      webrick
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  ansi (~> 1.5)
+  async (~> 1.31)
+  async-dns (~> 1.3)
+  browserstack-local (~> 1.4)
+  capybara (~> 3.39)
+  curb (~> 1.0, >= 1.0.5)
+  em-websocket (~> 0.5.3)
+  erubis (~> 2.7)
+  espeak-ruby (~> 1.1.0)
+  eventmachine (~> 1.2, >= 1.2.7)
+  execjs (~> 2.9)
+  geckodriver-helper (~> 0.24.0)
+  irb (~> 1.11)
+  json
+  maxmind-db (~> 1.2)
+  mime-types (~> 3.4, >= 3.4.1)
+  msfrpc-client (~> 1.1, >= 1.1.2)
+  net-smtp
+  otr-activerecord (= 2.1.2)
+  parseconfig (~> 1.1, >= 1.1.2)
+  pry-byebug (~> 3.10, >= 3.10.1)
+  qr4r (~> 0.6.1)
+  rack (~> 2.2)
+  rack-protection (~> 3.0.5)
+  rake (~> 13.0)
+  rdoc (~> 6.5)
+  rest-client (~> 2.1.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.59.0)
+  rubyzip (~> 2.3)
+  rushover (~> 0.3.0)
+  selenium-webdriver (~> 4.16)
+  sinatra (~> 3.0)
+  slack-notifier (~> 2.4)
+  sqlite3 (~> 1.6)
+  term-ansicolor
+  test-unit-full (~> 0.0.5)
+  thin (~> 1.8)
+  uglifier (~> 4.2)
+  websocket-client-simple (~> 0.6.1)
+  xmlrpc (~> 0.3.3)
+
+BUNDLED WITH
+   2.4.8

INSTALL.txt

@@ -1,6 +1,6 @@
 ===============================================================================
    
-    Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+    Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
     Browser Exploitation Framework (BeEF) - http://beefproject.com
     See the file 'doc/COPYING' for copying permission
 
@@ -21,9 +21,9 @@ Or cloning the Git repository from Github:
 Prerequisites
 --------------
 
-BeEF requires Ruby 2.5+.
+BeEF requires Ruby 3.0+.
 
-If your operating system package manager does not support Ruby version 2.5,
+If your operating system package manager does not support Ruby version 3.0,
 you can add the brightbox ppa repository for the latest version of Ruby:
 
   $ sudo apt-add-repository -y ppa:brightbox/ruby-ng

README.md

@@ -1,6 +1,6 @@
 ===============================================================================
 
-    Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+    Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
     Browser Exploitation Framework (BeEF) - http://beefproject.com
     See the file 'doc/COPYING' for copying permission
 
@@ -30,12 +30,13 @@ __Security Bugs:__ security@beefproject.com
 
 __Twitter:__ [@beefproject](https://twitter.com/beefproject)
 
+__Discord:__ https://discord.gg/ugmKmHarKc
 
 Requirements
 ------------
 
 * Operating System: Mac OSX 10.5.0 or higher / modern Linux. Note: Windows is not supported.
-* [Ruby](http://ruby-lang.org): 2.5 or newer
+* [Ruby](https://www.ruby-lang.org): 3.0 or newer
 * [SQLite](http://sqlite.org): 3.x
 * [Node.js](https://nodejs.org): 10 or newer
 * The gems listed in the Gemfile: https://github.com/beefproject/beef/blob/master/Gemfile

RESTful-API.postman_collection.json

@@ -1,567 +0,0 @@
-{
-	"info": {
-		"_postman_id": "3b47c3ff-c03f-446c-8edb-cacaab481425",
-		"name": "RESTful API",
-		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
-	},
-	"item": [
-		{
-			"name": "Authentication",
-			"event": [
-				{
-					"listen": "test",
-					"script": {
-						"id": "8e1a5f48-1d41-469d-a153-6cd5ee751912",
-						"exec": [
-							"var jsonData = JSON.parse(responseBody);",
-							"pm.environment.set(\"token\", jsonData.token);"
-						],
-						"type": "text/javascript"
-					}
-				}
-			],
-			"request": {
-				"method": "POST",
-				"header": [
-					{
-						"key": "Content-Type",
-						"name": "Content-Type",
-						"value": "application/json",
-						"type": "text"
-					}
-				],
-				"body": {
-					"mode": "raw",
-					"raw": "{\n\t\"username\": \"{{username}}\",\n\t\"password\": \"{{password}}\"\n\t\n}",
-					"options": {
-						"raw": {
-							"language": "json"
-						}
-					}
-				},
-				"url": {
-					"raw": "http://{{hostname}}:3000/api/admin/login",
-					"protocol": "http",
-					"host": [
-						"{{hostname}}"
-					],
-					"port": "3000",
-					"path": [
-						"api",
-						"admin",
-						"login"
-					]
-				},
-				"description": "In order to use the API, a token parameter must always be added to requests, otherwise a 401 error (Not Authorized) is returned.\n\nA new pseudo-random token is generated each time BeEF starts, using BeEF::Core::Crypto::api_token. The token is added to the BeEF::Configuration object.\n\nWhen BeEF starts the token is printed to the console. It should look something like:\n\n[16:02:47][*] RESTful API key: 320f3cf4da7bf0df7566a517c5db796e73a23f47\nGrabbing the Token from BeEF's API\n\nYou can issue a POST request to /api/admin/login using the BeEF credentials you have set in the main config.yaml file. This request will return the token in the response. You can parse the JSON and use it for your next requests requiring authentication."
-			},
-			"response": []
-		},
-		{
-			"name": "Get All Hooked Browsers",
-			"request": {
-				"method": "GET",
-				"header": [],
-				"url": {
-					"raw": "http://{{hostname}}:3000/api/hooks?token={{token}}",
-					"protocol": "http",
-					"host": [
-						"{{hostname}}"
-					],
-					"port": "3000",
-					"path": [
-						"api",
-						"hooks"
-					],
-					"query": [
-						{
-							"key": "token",
-							"value": "{{token}}"
-						}
-					]
-				},
-				"description": "Provides information (browser and OS version, cookies, enabled plugins, etc) about all hooked browsers (both online and offline)."
-			},
-			"response": []
-		},
-		{
-			"name": "Get Specific Hooked Browser",
-			"request": {
-				"method": "GET",
-				"header": [],
-				"url": {
-					"raw": "http://{{hostname}}:3000/api/hooks/{{session}}?token={{token}}",
-					"protocol": "http",
-					"host": [
-						"{{hostname}}"
-					],
-					"port": "3000",
-					"path": [
-						"api",
-						"hooks",
-						"{{session}}"
-					],
-					"query": [
-						{
-							"key": "token",
-							"value": "{{token}}"
-						}
-					]
-				},
-				"description": "\n    Provides information (browser and OS version, cookies, enabled plugins, etc) about a specific hooked browser.\n"
-			},
-			"response": []
-		},
-		{
-			"name": "Get All Hooked Browsers Logs",
-			"request": {
-				"method": "GET",
-				"header": [],
-				"url": {
-					"raw": "http://{{hostname}}:3000/api/logs?token={{token}}",
-					"protocol": "http",
-					"host": [
-						"{{hostname}}"
-					],
-					"port": "3000",
-					"path": [
-						"api",
-						"logs"
-					],
-					"query": [
-						{
-							"key": "token",
-							"value": "{{token}}"
-						}
-					]
-				},
-				"description": "The logs handler gives information about all hooked browser's logs, both global and relative."
-			},
-			"response": []
-		},
-		{
-			"name": "Get Specific Hooked Browsers Logs",
-			"request": {
-				"method": "GET",
-				"header": [],
-				"url": {
-					"raw": "http://{{hostname}}:3000/api/logs/{{session}}?token={{token}}",
-					"protocol": "http",
-					"host": [
-						"{{hostname}}"
-					],
-					"port": "3000",
-					"path": [
-						"api",
-						"logs",
-						"{{session}}"
-					],
-					"query": [
-						{
-							"key": "token",
-							"value": "{{token}}"
-						}
-					]
-				},
-				"description": " The logs handler gives information about a specified hooked browser's logs.\n"
-			},
-			"response": []
-		},
-		{
-			"name": "List All Command Modules",
-			"request": {
-				"method": "GET",
-				"header": [],
-				"url": {
-					"raw": "http://{{hostname}}:3000/api/modules?token={{token}}",
-					"protocol": "http",
-					"host": [
-						"{{hostname}}"
-					],
-					"port": "3000",
-					"path": [
-						"api",
-						"modules"
-					],
-					"query": [
-						{
-							"key": "token",
-							"value": "{{token}}"
-						}
-					]
-				},
-				"description": "List all available BeEF command modules."
-			},
-			"response": []
-		},
-		{
-			"name": "Get Information on Specific Module",
-			"request": {
-				"method": "GET",
-				"header": [],
-				"url": {
-					"raw": "http://{{hostname}}:3000/api/modules/{{module_id}}?token={{token}}",
-					"protocol": "http",
-					"host": [
-						"{{hostname}}"
-					],
-					"port": "3000",
-					"path": [
-						"api",
-						"modules",
-						"{{module_id}}"
-					],
-					"query": [
-						{
-							"key": "token",
-							"value": "{{token}}"
-						}
-					]
-				},
-				"description": "Get detailed information about a specific BeEF command module.\n"
-			},
-			"response": []
-		},
-		{
-			"name": "Launch Command Module on a Specific Browser",
-			"request": {
-				"method": "POST",
-				"header": [
-					{
-						"key": "Content-Type",
-						"name": "Content-Type",
-						"value": "application/json",
-						"type": "text"
-					}
-				],
-				"body": {
-					"mode": "raw",
-					"raw": "",
-					"options": {
-						"raw": {
-							"language": "json"
-						}
-					}
-				},
-				"url": {
-					"raw": "http://{{hostname}}:3000/api/modules/{{session}}/{{module_id}}?token={{token}}",
-					"protocol": "http",
-					"host": [
-						"{{hostname}}"
-					],
-					"port": "3000",
-					"path": [
-						"api",
-						"modules",
-						"{{session}}",
-						"{{module_id}}"
-					],
-					"query": [
-						{
-							"key": "token",
-							"value": "{{token}}"
-						}
-					]
-				},
-				"description": "Launch a specific BeEF command module on a given hooked browser.\n"
-			},
-			"response": []
-		},
-		{
-			"name": "Return Information About Previously Executed Module",
-			"protocolProfileBehavior": {
-				"disableBodyPruning": true
-			},
-			"request": {
-				"method": "GET",
-				"header": [
-					{
-						"key": "Content-Type",
-						"name": "Content-Type",
-						"value": "application/json",
-						"type": "text"
-					}
-				],
-				"body": {
-					"mode": "raw",
-					"raw": "",
-					"options": {
-						"raw": {
-							"language": "json"
-						}
-					}
-				},
-				"url": {
-					"raw": "http://{{hostname}}:3000/api/modules/{{session}}/{{module_id}}/{{cmd_id}}?token={{token}}",
-					"protocol": "http",
-					"host": [
-						"{{hostname}}"
-					],
-					"port": "3000",
-					"path": [
-						"api",
-						"modules",
-						"{{session}}",
-						"{{module_id}}",
-						"{{cmd_id}}"
-					],
-					"query": [
-						{
-							"key": "token",
-							"value": "{{token}}"
-						}
-					]
-				},
-				"description": "Returns information about a specific previously launched BeEF command module.\n"
-			},
-			"response": []
-		},
-		{
-			"name": "Send a Metasploit Module",
-			"request": {
-				"method": "POST",
-				"header": [],
-				"url": {
-					"raw": "http://{{hostname}}:3000/api/modules/{{session}}/{{module_id}}?token={{token}}",
-					"protocol": "http",
-					"host": [
-						"{{hostname}}"
-					],
-					"port": "3000",
-					"path": [
-						"api",
-						"modules",
-						"{{session}}",
-						"{{module_id}}"
-					],
-					"query": [
-						{
-							"key": "token",
-							"value": "{{token}}"
-						}
-					]
-				},
-				"description": "Launch a specific Metasploit module on a given hooked browser\n"
-			},
-			"response": []
-		},
-		{
-			"name": " Send a Module to Multiple Hooked Browsers",
-			"request": {
-				"method": "POST",
-				"header": [
-					{
-						"key": "Content-Type",
-						"name": "Content-Type",
-						"value": "application/json",
-						"type": "text"
-					}
-				],
-				"body": {
-					"mode": "raw",
-					"raw": "",
-					"options": {
-						"raw": {
-							"language": "json"
-						}
-					}
-				},
-				"url": {
-					"raw": "http://{{hostname}}:3000/api/modules/multi_browser?token={{token}}",
-					"protocol": "http",
-					"host": [
-						"{{hostname}}"
-					],
-					"port": "3000",
-					"path": [
-						"api",
-						"modules",
-						"multi_browser"
-					],
-					"query": [
-						{
-							"key": "token",
-							"value": "{{token}}"
-						}
-					]
-				},
-				"description": "Fire a new command module to multiple hooked browsers. Returns the command IDs of the launched module, or 0 if firing got issues."
-			},
-			"response": []
-		},
-		{
-			"name": " Send Multiple Modules to a Single Hooked Browser",
-			"request": {
-				"method": "POST",
-				"header": [
-					{
-						"key": "Content-Type",
-						"name": "Content-Type",
-						"value": "application/json",
-						"type": "text"
-					}
-				],
-				"body": {
-					"mode": "raw",
-					"raw": "",
-					"options": {
-						"raw": {
-							"language": "json"
-						}
-					}
-				},
-				"url": {
-					"raw": "http://{{hostname}}:3000/api/modules/multi_module?token={{token}}",
-					"protocol": "http",
-					"host": [
-						"{{hostname}}"
-					],
-					"port": "3000",
-					"path": [
-						"api",
-						"modules",
-						"multi_module"
-					],
-					"query": [
-						{
-							"key": "token",
-							"value": "{{token}}"
-						}
-					]
-				},
-				"description": "Fire multiple command modules to a single hooked browser. Returns the command IDs of the launched modules, or 0 if firing got issues."
-			},
-			"response": []
-		},
-		{
-			"name": "List the DNS ruleset",
-			"request": {
-				"method": "GET",
-				"header": [],
-				"url": {
-					"raw": "http://{{hostname}}:3000/api/dns/ruleset?token={{token}}",
-					"protocol": "http",
-					"host": [
-						"{{hostname}}"
-					],
-					"port": "3000",
-					"path": [
-						"api",
-						"dns",
-						"ruleset"
-					],
-					"query": [
-						{
-							"key": "token",
-							"value": "{{token}}"
-						}
-					]
-				},
-				"description": "Returns the current set of DNS rules.\n"
-			},
-			"response": []
-		},
-		{
-			"name": "List a Specific DNS Rule",
-			"request": {
-				"method": "GET",
-				"header": [],
-				"url": {
-					"raw": "http://{{hostname}}:3000/api/dns/rule/{{dnsrule_id}}?token={{token}}",
-					"protocol": "http",
-					"host": [
-						"{{hostname}}"
-					],
-					"port": "3000",
-					"path": [
-						"api",
-						"dns",
-						"rule",
-						"{{dnsrule_id}}"
-					],
-					"query": [
-						{
-							"key": "token",
-							"value": "{{token}}"
-						}
-					]
-				},
-				"description": "Returns an individual DNS rule given its unique id.\n"
-			},
-			"response": []
-		},
-		{
-			"name": "Add a New DNS Rule",
-			"request": {
-				"method": "POST",
-				"header": [
-					{
-						"key": "Content-Type",
-						"name": "Content-Type",
-						"value": "application/json",
-						"type": "text"
-					}
-				],
-				"body": {
-					"mode": "raw",
-					"raw": "",
-					"options": {
-						"raw": {
-							"language": "json"
-						}
-					}
-				},
-				"url": {
-					"raw": "http://{{hostname}}:3000/api/dns/rule?token={{token}}",
-					"protocol": "http",
-					"host": [
-						"{{hostname}}"
-					],
-					"port": "3000",
-					"path": [
-						"api",
-						"dns",
-						"rule"
-					],
-					"query": [
-						{
-							"key": "token",
-							"value": "{{token}}"
-						}
-					]
-				},
-				"description": "Adds a new DNS rule or \"resource record\". Does nothing if rule is already present.\n"
-			},
-			"response": []
-		},
-		{
-			"name": "Remove an Existing DNS Rule",
-			"request": {
-				"method": "DELETE",
-				"header": [],
-				"url": {
-					"raw": "http://{{hostname}}:3000/api/dns/rule/{{dnsrule_id}}?token={{token}}",
-					"protocol": "http",
-					"host": [
-						"{{hostname}}"
-					],
-					"port": "3000",
-					"path": [
-						"api",
-						"dns",
-						"rule",
-						"{{dnsrule_id}}"
-					],
-					"query": [
-						{
-							"key": "token",
-							"value": "{{token}}"
-						}
-					]
-				},
-				"description": "Removes an individual DNS rule with a specified unique ID.\n"
-			},
-			"response": []
-		}
-	],
-	"protocolProfileBehavior": {}
-}

Rakefile

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
@@ -23,6 +23,22 @@ RSpec::Core::RakeTask.new(:spec) do |task|
   task.rspec_opts = ['--tag ~run_on_browserstack']
 end
 
+RSpec::Core::RakeTask.new(:browserstack) do |task|
+  task.rspec_opts = ['--tag run_on_browserstack']
+end
+
+RSpec::Core::RakeTask.new(:bs) do |task|
+  configs = Dir["spec/support/browserstack/**/*.yml"]
+  configs.each do |config|
+    config = config.split('spec/support/browserstack')[1]
+    ENV['CONFIG_FILE'] = config
+    puts "\e[45m#{config.upcase}\e[0m"
+    task.rspec_opts = ['--tag run_on_browserstack']
+    Rake::Task['browserstack'].invoke
+    Rake::Task['browserstack'].reenable
+  end
+end
+
 ################################
 # SSL/TLS certificate
 
@@ -72,15 +88,6 @@ namespace :rdoc do
   end
 end
 
-
-################################
-# Install
-
-#task :install do
-#  sh "export BEEF_TEST=true"
-#end
-
-
 ################################
 # X11 set up
 
@@ -118,7 +125,7 @@ task :beef_start => 'beef' do
   config = YAML.safe_load(File.read('./config.yaml'))
   config['beef']['credentials']['user'] = test_user
   config['beef']['credentials']['passwd'] = test_pass
-  Dir.mkdir('tmp') unless Dir.exists?('tmp')
+  Dir.mkdir('tmp') unless Dir.exist?('tmp')
   File.open(@beef_config_file, 'w') { |f| YAML.dump(config, f) }
 
   # set the environment creds -- in case we're using bad_fred
@@ -201,43 +208,6 @@ task :dmg do
 end
 
 
-################################
-# Create CDE Package
-# This will download and make the CDE Executable and
-# gnereate a CDE Package in cde-package
-
-task :cde do
-  puts "\nCloning and Making CDE...";
-  sh "git clone git://github.com/pgbovine/CDE.git";
-  Dir.chdir "CDE";
-  sh "make";
-  Dir.chdir "..";
-  puts "\nCreating CDE Package...\n";
-  sh "bundle install"
-  Rake::Task['cde_beef_start'].invoke
-  Rake::Task['beef_stop'].invoke
-  puts "\nCleaning Up...\n";
-  sleep (2);
-  sh "rm -rf CDE";
-  puts "\nCDE Package Created...\n";
-end
-
-################################
-# CDE/BeEF environment set up
-
-@beef_process_id = nil;
-
-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.each do |i| # delay for 10 seconds
-    printf '.'
-    sleep (i)
-  end
-  puts '.'
-end
-
 ################################
 # ActiveRecord
 namespace :db do

VERSION

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

arerules/alert.json

@@ -1,9 +1,5 @@
 {"name": "Display an alert",
   "author": "mgeeky",
-  "browser": "ALL",
-  "browser_version": "ALL",
-  "os": "ALL",
-  "os_version": "ALL",
   "modules": [
     {"name": "alert_dialog",
       "condition": null,

arerules/coinhive_miner.json

@@ -1,20 +0,0 @@
-{"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

@@ -1,9 +1,5 @@
 {"name": "Confirm Close Tab",
   "author": "mgeeky",
-  "browser": "ALL",
-  "browser_version": "ALL",
-  "os": "ALL",
-  "os_version": "ALL",
   "modules": [
     {"name": "confirm_close_tab",
       "condition": null,

arerules/ff_osx_extension-dropper.json

@@ -2,7 +2,6 @@
   "name": "Firefox Extension Dropper",
   "author": "antisnatchor",
   "browser": "FF",
-  "browser_version": "ALL",
   "os": "OSX",
   "os_version": ">= 10.8",
   "modules": [{

arerules/get_cookie.json

@@ -1,10 +1,6 @@
 {
   "name": "Get Cookie",
   "author": "@benichmt1",
-  "browser": "ALL",
-  "browser_version": "ALL",
-  "os": "ALL",
-  "os_version": "ALL",
   "modules": [
     {"name": "get_cookie",
       "condition": null,

arerules/ie_win_htapowershell.json

@@ -2,7 +2,6 @@
   "name": "HTA PowerShell",
   "author": "antisnatchor",
   "browser": "IE",
-  "browser_version": "ALL",
   "os": "Windows",
   "os_version": ">= 7",
   "modules": [

arerules/lan_cors_scan.json

@@ -1,9 +1,6 @@
 {"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,

arerules/lan_cors_scan_common.json

@@ -1,9 +1,5 @@
 {"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,

arerules/lan_fingerprint.json

@@ -1,9 +1,6 @@
 {"name": "LAN Fingerprint",
   "author": "bcoles",
   "browser": ["FF", "C"],
-  "browser_version": "ALL",
-  "os": "ALL",
-  "os_version": "ALL",
   "modules": [
     {"name": "get_internal_ip_webrtc",
       "condition": null,

arerules/lan_fingerprint_common.json

@@ -1,9 +1,5 @@
 {"name": "LAN Fingerprint (Common IPs)",
   "author": "antisnatchor",
-  "browser": "ALL",
-  "browser_version": "ALL",
-  "os": "ALL",
-  "os_version": "ALL",
   "modules": [
     {"name": "internal_network_fingerprinting",
       "condition": null,

arerules/lan_flash_scan.json

@@ -1,9 +1,6 @@
 {"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,

arerules/lan_flash_scan_common.json

@@ -1,9 +1,6 @@
 {"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,

arerules/lan_http_scan.json

@@ -1,9 +1,6 @@
 {"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,

arerules/lan_http_scan_common.json

@@ -1,9 +1,5 @@
 {"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,

arerules/lan_ping_sweep.json

@@ -1,9 +1,6 @@
 {"name": "LAN Ping Sweep",
   "author": "bcoles",
   "browser": "FF",
-  "browser_version": "ALL",
-  "os": "ALL",
-  "os_version": "ALL",
   "modules": [
     {"name": "get_internal_ip_webrtc",
       "condition": null,

arerules/lan_ping_sweep_common.json

@@ -1,9 +1,6 @@
 {"name": "LAN Ping Sweep (Common IPs)",
   "author": "bcoles",
   "browser": "FF",
-  "browser_version": "ALL",
-  "os": "ALL",
-  "os_version": "ALL",
   "modules": [
     {"name": "ping_sweep",
       "condition": null,

arerules/lan_port_scan.json

@@ -1,9 +1,5 @@
 {"name": "LAN Port Scan",
   "author": "aburro & aussieklutz",
-  "browser": "ALL",
-  "browser_version": "ALL",
-  "os": "ALL",
-  "os_version": "ALL",
   "modules": [
     {"name": "get_internal_ip_webrtc",
       "condition": null,

arerules/lan_sw_port_scan.json

@@ -1,9 +1,5 @@
 {"name": "LAN SW Port Scan",
   "author": "aburro & aussieklutz",
-  "browser": "ALL",
-  "browser_version": "ALL",
-  "os": "ALL",
-  "os_version": "ALL",
   "modules": [
     {"name": "get_internal_ip_webrtc",
       "condition": null,

arerules/man_in_the_browser.json

@@ -1,9 +1,5 @@
 {"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,

arerules/raw_javascript.json

@@ -1,10 +1,6 @@
 {
   "name": "Raw JavaScript",
   "author": "wade@bindshell.net",
-  "browser": "ALL",
-  "browser_version": "ALL",
-  "os": "ALL",
-  "os_version": "ALL",
   "modules": [
     {"name": "raw_javascript",
       "condition": null,

arerules/record_snapshots.json

@@ -1,9 +1,5 @@
 {"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,

arerules/win_fake_malware.json

@@ -2,10 +2,7 @@
 {
   "name": "Windows Fake Malware",
   "author": "bcoles",
-  "browser": "ALL",
-  "browser_version": "ALL",
   "os": "Windows",
-  "os_version": "ALL",
   "modules": [
     {
       "name": "blockui",

beef

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
@@ -12,11 +12,12 @@
 $VERBOSE = nil
 
 #
-# @note Version check to ensure BeEF is running Ruby 2.5+
+# @note Version check to ensure BeEF is running Ruby 3.0+
 #
-if RUBY_VERSION < '2.5'
+min_ruby_version = '3.0'
+if RUBY_VERSION < min_ruby_version
   puts
-  puts "Ruby version #{RUBY_VERSION} is no longer supported. Please upgrade to Ruby version 2.5 or later."
+  puts "Ruby version #{RUBY_VERSION} is no longer supported. Please upgrade to Ruby version #{min_ruby_version} or later."
   puts
   exit 1
 end
@@ -47,17 +48,17 @@ require 'timeout'
 #
 # @note Ask user if they would like to update beef
 #
-
-if BeEF::Core::Console::CommandLine.parse[:update_disabled] == false
+if File.exist?("#{$root_dir}git") && BeEF::Core::Console::CommandLine.parse[:update_disabled] == false
   if BeEF::Core::Console::CommandLine.parse[:update_auto] == true
-  print "Pulling latest BeEF repository and updating"
+    print 'Checking latest BeEF repository and updating'
     `git pull && bundle`
-  else
+  elsif `git rev-parse master` != `git rev-parse origin/master`
     begin
-      answer = Timeout::timeout(5) do
-        print "Would you like to check and download the latest BeEF update? y/n: " 
+      Timeout.timeout(5) do
+        puts '-- BeEF Update Available --'
+        print 'Would you like to update to lastest version? y/n: '
         response = gets
-        `git pull && bundle` if response.strip == 'y' 
+        `git pull && bundle` if response&.strip == 'y'
       end
     rescue Timeout::Error
       puts "\nUpdate Skipped with input timeout"
@@ -183,8 +184,14 @@ 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.'
-  File.delete(db_file) if File.exists?(db_file)
+  begin
+    File.delete(db_file) if File.exist?(db_file)
+  rescue => e
+    print_error("Could not remove '#{db_file}' database file: #{e.message}")
+    exit(1)
+  end
 end
+
 # Connect to DB
 ActiveRecord::Base.logger = nil
 OTR::ActiveRecord.migrations_paths = [File.join('core', 'main', 'ar-migrations')]
@@ -194,6 +201,7 @@ OTR::ActiveRecord.configure_from_hash!(adapter:'sqlite3', database:db_file)
 if Gem.loaded_specs['otr-activerecord'].version > Gem::Version.create('1.4.2')
   OTR::ActiveRecord.establish_connection!
 end
+
 # Migrate (if required)
 context = ActiveRecord::Migration.new.migration_context
 if context.needs_migration?
@@ -207,7 +215,12 @@ print_info 'BeEF is loading. Wait a few seconds...'
 #
 # @note Execute migration procedure, checks for new modules
 #
-BeEF::Core::Migration.instance.update_db!
+begin
+  BeEF::Core::Migration.instance.update_db!
+rescue => e
+  print_error("Could not update '#{db_file}' database file: #{e.message}")
+  exit(1)
+end
 
 #
 # @note Create HTTP Server and prepare it to run
@@ -215,6 +228,13 @@ BeEF::Core::Migration.instance.update_db!
 http_hook_server = BeEF::Core::Server.instance
 http_hook_server.prepare
 
+begin
+  BeEF::Core::Logger.instance.register('System', 'BeEF server started')
+rescue => e
+  print_error("Database connection failed: #{e.message}")
+  exit(1)
+end
+
 #
 # @note Prints information back to the user before running the server
 #

config.yaml

@@ -1,12 +1,12 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 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.5.2.0'
+    version: '0.5.4.0'
     # More verbose messages (server-side)
     debug: false
     # More verbose messages (client-side)
@@ -45,22 +45,23 @@ beef:
         # 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),
-        # These settings will be used to create a public facing URL
-        # This public facing URL will be used for all hook related calls
-        # set the public setting below:
-        # public:
-        #     host: "" # public hostname/IP address
-        #     port: "" # public port will default to 80 if no https 443 if https 
-                      # and local if not set but there is a public host
+        # Public Domain Name / Reverse Proxy / Port Forwarding
+        #
+        # In order for the client-side BeEF JavaScript hook to be able to connect to BeEF,
+        # the hook JavaScript needs to be generated with the correct connect-back details.
+        #
+        # If you're using a public domain name, reverse proxy, or port forwarding you must
+        # configure the public-facing connection details here.
+
+        #public:
+        #    host: "beef.local" # public hostname/IP address
+        #    port: "443" # public port (443 if the public server is using HTTPS)
         #    https: false # true/false
 
-        # 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:
-        # NOTE: Allowing the reverse proxy will enable a vulnerability where the ui/panel can be spoofed
-        #   by altering the X-FORWARDED-FOR ip address in the request header.
+        # If using any reverse proxy you should also set allow_reverse_proxy to true below.
+        # Note that this causes the BeEF server to trust the X-Forwarded-For HTTP header.
+        # If the BeEF server is directly accessible, clients can spoof their connecting
+        # IP address using this header to bypass the IP address permissions/exclusions.
         allow_reverse_proxy: false
 
         # Hook
@@ -93,8 +94,6 @@ beef:
         # Experimental HTTPS support for the hook / admin / all other Thin managed web services
         https:
             enable: false
-            # Enabled this config setting if you're external facing uri is using https
-            public_enabled: false
             # In production environments, be sure to use a valid certificate signed for the value
             # used in beef.http.public (the domain name of the server where you run BeEF)
             key: "beef_key.pem"
@@ -120,17 +119,10 @@ beef:
     dns_hostname_lookup: false
 
     # IP Geolocation
-    # NOTE: requires MaxMind database. Run ./updated-geoipdb to install.
     geoip:
         enable: true
-        database: '/opt/GeoIP/GeoLite2-City.mmdb'
-
-    # 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
+        # GeoLite2 City database created by MaxMind, available from https://www.maxmind.com
+        database: '/usr/share/GeoIP/GeoLite2-City.mmdb'
 
     # You may override default extension configuration parameters here
     # Note: additional experimental extensions are available in the 'extensions' directory

core/api.rb

@@ -1,12 +1,11 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 
 module BeEF
   module API
-
     #
     # Registrar class to handle all registered timed API calls
     #
@@ -24,18 +23,18 @@ module BeEF
       # 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 [Class] clss 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 = [])
-        unless verify_api_path(c, method)
-          print_error "API Registrar: Attempted to register non-existant API method #{c} :#{method}"
+      def register(owner, clss, method, params = [])
+        unless verify_api_path(clss, method)
+          print_error "API Registrar: Attempted to register non-existant API method #{clss} :#{method}"
           return
         end
 
-        if registered?(owner, c, method, params)
-          print_debug "API Registrar: Attempting to re-register API call #{c} :#{method}"
+        if registered?(owner, clss, method, params)
+          print_debug "API Registrar: Attempting to re-register API call #{clss} :#{method}"
           return
         end
 
@@ -43,7 +42,7 @@ module BeEF
         @registry << {
           'id' => id,
           'owner' => owner,
-          'class'  => c,
+          'class' => clss,
           'method' => method,
           'params' => params
         }
@@ -56,18 +55,19 @@ module BeEF
       # 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 [Class] clss 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 = [])
+      def registered?(owner, clss, method, params = [])
         @registry.each do |r|
           next unless r['owner'] == owner
-          next unless r['class'] == c
+          next unless r['class'] == clss
           next unless r['method'] == method
           next unless is_matched_params? r, params
+
           return true
         end
         false
@@ -76,17 +76,18 @@ module BeEF
       #
       # Match a timed API call to determine if an API.fire() is required
       #
-      # @param [Class] c the target API class
+      # @param [Class] clss 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 = [])
+      def matched?(clss, method, params = [])
         @registry.each do |r|
-          next unless r['class'] == c
+          next unless r['class'] == clss
           next unless r['method'] == method
           next unless is_matched_params? r, params
+
           return true
         end
         false
@@ -98,24 +99,25 @@ module BeEF
       # @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 [Class] clss 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 = [])
+      def get_owners(clss, method, params = [])
         owners = []
         @registry.each do |r|
-          next unless r['class'] == c
+          next unless r['class'] == clss
           next unless r['method'] == method
           next unless is_matched_params? r, params
-          owners << { :owner => r['owner'], :id => r['id'] }
+
+          owners << { owner: r['owner'], id: r['id'] }
         end
         owners
       end
@@ -126,23 +128,23 @@ module BeEF
       #
       # @note This is a security precaution
       #
-      # @param [Class] c the target API class to verify
-      # @param [String] m the target method to verify
+      # @param [Class] clss the target API class to verify
+      # @param [String] mthd the target method to verify
       #
-      def verify_api_path(c, m)
-        (c.const_defined?('API_PATHS') && c.const_get('API_PATHS').key?(m))
+      def verify_api_path(clss, mthd)
+        (clss.const_defined?('API_PATHS') && clss.const_get('API_PATHS').key?(mthd))
       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
+      # @param [Class] clss the target API class to verify
+      # @param [String] mthd the target method to verify
       #
       # @return [Symbol] the API path
       #
-      def get_api_path(c, m)
-        verify_api_path(c, m) ? c.const_get('API_PATHS')[m] : nil
+      def get_api_path(clss, mthd)
+        verify_api_path(clss, mthd) ? clss.const_get('API_PATHS')[mthd] : nil
       end
 
       #
@@ -171,37 +173,33 @@ module BeEF
       #
       # Fires all owners registered to this API hook
       #
-      # @param [Class] c the target API class
-      # @param [String] m the target API method
+      # @param [Class] clss the target API class
+      # @param [String] mthd 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
       #
-      def fire(c, m, *args)
-        mods = get_owners(c, m, args)
+      def fire(clss, mthd, *args)
+        mods = get_owners(clss, mthd, 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}"
+        unless verify_api_path(clss, mthd) && clss.ancestors.first.to_s.start_with?('BeEF::API')
+          print_error "API Path not defined for Class: #{clss} method: #{mthd}"
           return []
         end
 
         data = []
-        method = get_api_path(c, m)
+        method = get_api_path(clss, mthd)
         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
+          data << { api_id: mod[:id], data: result } unless result.nil?
+        rescue StandardError => e
           print_error "API Fire Error: #{e.message} in #{mod}.#{method}()"
         end
-        end
 
         data
       end
@@ -214,8 +212,7 @@ require 'core/api/modules'
 require 'core/api/extension'
 require 'core/api/extensions'
 require 'core/api/main/migration'
-require 'core/api/main/network_stack/assethandler.rb'
+require 'core/api/main/network_stack/assethandler'
 require 'core/api/main/server'
 require 'core/api/main/server/hook'
 require 'core/api/main/configuration'
-

core/api/extension.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
@@ -7,14 +7,11 @@
 module BeEF
   module API
     module Extension
-
       attr_reader :full_name, :short_name, :description
 
       @full_name = ''
       @short_name = ''
       @description = ''
-
     end
-
   end
 end

core/api/extensions.rb

@@ -1,21 +1,18 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
   module API
     module Extensions
-
       # @note Defined API Paths
       API_PATHS = {
         'post_load' => :post_load
-      }
+      }.freeze
 
       # API hook fired after all extensions have been loaded
-      def post_load;
-      end
-
+      def post_load; end
     end
   end
 end

core/api/main/configuration.rb

@@ -1,22 +1,19 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-module API
+  module API
     module Configuration
-    
       # @note Defined API Paths
       API_PATHS = {
         'module_configuration_load' => :module_configuration_load
-    }
+      }.freeze
 
       # Fires just after module configuration is loaded and merged
       # @param [String] mod module key
       def module_configuration_load(mod); end
-
     end
-  
-end
+  end
 end

core/api/main/migration.rb

@@ -1,21 +1,18 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-module API
+  module API
     module Migration
-    
       # @note Defined API Paths
       API_PATHS = {
         'migrate_commands' => :migrate_commands
-    }
+      }.freeze
 
       # Fired just after the migration process
       def migrate_commands; end
-    
     end
-  
-end
+  end
 end

core/api/main/network_stack/assethandler.rb

@@ -1,14 +1,13 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-module API
-module NetworkStack
-module Handlers
-module AssetHandler
-
+  module API
+    module NetworkStack
+      module Handlers
+        module AssetHandler
           # Binds a file to be accessible by the hooked browser
           # @param [String] file file to be served
           # @param [String] path URL path to be bound, if no path is specified a randomly generated one will be used
@@ -17,8 +16,8 @@ module AssetHandler
           # @return [String] URL bound to the specified file
           # @todo Add hooked browser parameter to only allow specified hooked browsers access to the bound URL. Waiting on Issue #336
           # @note This is a direct API call and does not have to be registered to be used
-    def self.bind(file, path=nil, extension=nil, count=-1)
-        return BeEF::Core::NetworkStack::Handlers::AssetHandler.instance.bind(file, path, extension, count)
+          def self.bind(file, path = nil, extension = nil, count = -1)
+            BeEF::Core::NetworkStack::Handlers::AssetHandler.instance.bind(file, path, extension, count)
           end
 
           # Unbinds a file made accessible to hooked browsers
@@ -28,9 +27,8 @@ module AssetHandler
           def self.unbind(url)
             BeEF::Core::NetworkStack::Handlers::AssetHandler.instance.unbind(url)
           end
-
-end
-end
-end
-end
+        end
+      end
+    end
+  end
 end

core/api/main/server.rb

@@ -1,17 +1,16 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-module API
-module Server
-
+  module API
+    module Server
       # @note Defined API Paths
       API_PATHS = {
         'mount_handler' => :mount_handler,
         'pre_http_start' => :pre_http_start
-    }
+      }.freeze
 
       # Fires just before the HTTP Server is started
       # @param [Object] http_hook_server HTTP Server object
@@ -36,8 +35,6 @@ module Server
       def self.unmount(url)
         BeEF::Core::Server.instance.unmount(url)
       end
-
-  
-end
-end
+    end
+  end
 end

core/api/main/server/hook.rb

@@ -1,24 +1,21 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-module API
-module Server
+  module API
+    module Server
       module Hook
-
         # @note Defined API Paths
         API_PATHS = {
           'pre_hook_send' => :pre_hook_send
-    }
+        }.freeze
 
         # Fires just before the hook is sent to the hooked browser
         # @param [Class] handler the associated handler Class
         def pre_hook_send(handler); end
-    
       end
-  
-end
-end
+    end
+  end
 end

core/api/module.rb

@@ -1,16 +1,14 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
   module API
-
     module Command
     end
 
     module Module
-
       # @note Defined API Paths
       API_PATHS = {
         'pre_soft_load' => :pre_soft_load,
@@ -20,7 +18,7 @@ module BeEF
         'get_options' => :get_options,
         'get_payload_options' => :get_payload_options,
         'override_execute' => :override_execute
-      }
+      }.freeze
 
       # Fired before a module soft load
       # @param [String] mod module key of module about to be soft loaded
@@ -54,8 +52,6 @@ module BeEF
       # @return [Hash] a hash of options
       # @note the option hash is merged with all other API hook's returned hash. Hooking this API method prevents the default options being returned.
       def get_payload_options; end
-
     end
-
   end
 end

core/api/modules.rb

@@ -1,22 +1,18 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
   module API
-
     module Modules
-
       # @note Defined API Paths
       API_PATHS = {
         'post_soft_load' => :post_soft_load
-      }
+      }.freeze
 
       # Fires just after all modules are soft loaded
       def post_soft_load; end
-
     end
-
   end
 end

core/bootstrap.rb

@@ -1,24 +1,22 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
   module Core
-
   end
 end
 
 ## @note Include the BeEF router
 require 'core/main/router/router'
 require 'core/main/router/api'
-require 'core/main/router/error_responses'
-
 
 ## @note Include http server functions for beef
 require 'core/main/server'
 require 'core/main/handlers/modules/beefjs'
 require 'core/main/handlers/modules/legacybeefjs'
+require 'core/main/handlers/modules/multistagebeefjs'
 require 'core/main/handlers/modules/command'
 require 'core/main/handlers/commands'
 require 'core/main/handlers/hookedbrowsers'

core/core.rb

@@ -1,12 +1,11 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-module Core
-  
-end
+  module Core
+  end
 end
 
 # @note Includes database models - the order must be consistent otherwise DataMapper goes crazy
@@ -20,6 +19,7 @@ require 'core/main/models/optioncache'
 require 'core/main/models/browserdetails'
 require 'core/main/models/rule'
 require 'core/main/models/execution'
+require 'core/main/models/legacybrowseruseragents'
 
 # @note Include the constants
 require 'core/main/constants/browsers'
@@ -38,4 +38,3 @@ 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,11 +1,10 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
   module Extension
-
     # Checks to see if extension is set inside the configuration
     # @param [String] ext the extension key
     # @return [Boolean] whether or not the extension exists in BeEF's configuration
@@ -18,6 +17,7 @@ module BeEF
     # @return [Boolean] whether or not the extension is enabled
     def self.is_enabled(ext)
       return false unless is_present(ext)
+
       BeEF::Core::Configuration.instance.get("beef.extension.#{ext}.enable") == true
     end
 
@@ -26,6 +26,7 @@ module BeEF
     # @return [Boolean] whether or not the extension is loaded
     def self.is_loaded(ext)
       return false unless is_enabled(ext)
+
       BeEF::Core::Configuration.instance.get("beef.extension.#{ext}.loaded") == true
     end
 
@@ -41,7 +42,7 @@ module BeEF
       end
       print_error "Unable to load extension '#{ext}'"
       false
-    rescue => e
+    rescue StandardError => e
       print_error "Unable to load extension '#{ext}':"
       print_more e.message
     end

core/extensions.rb

@@ -1,16 +1,15 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
   module Extensions
-
     # Returns configuration of all enabled extensions
     # @return [Array] an array of extension configuration hashes that are enabled
     def self.get_enabled
-      BeEF::Core::Configuration.instance.get('beef.extension').select { |k,v| v['enable'] == true }
-    rescue => e
+      BeEF::Core::Configuration.instance.get('beef.extension').select { |_k, v| v['enable'] == true }
+    rescue StandardError => e
       print_error "Failed to get enabled extensions: #{e.message}"
       print_error e.backtrace
     end
@@ -18,8 +17,8 @@ module BeEF
     # Returns configuration of all loaded extensions
     # @return [Array] an array of extension configuration hashes that are loaded
     def self.get_loaded
-      BeEF::Core::Configuration.instance.get('beef.extension').select {|k,v| v['loaded'] == true }
-    rescue => e
+      BeEF::Core::Configuration.instance.get('beef.extension').select { |_k, v| v['loaded'] == true }
+    rescue StandardError => e
       print_error "Failed to get loaded extensions: #{e.message}"
       print_error e.backtrace
     end
@@ -28,12 +27,12 @@ module BeEF
     # @note API fire for post_load
     def self.load
       BeEF::Core::Configuration.instance.load_extensions_config
-      self.get_enabled.each { |k,v|
+      get_enabled.each do |k, _v|
         BeEF::Extension.load k
-      }
+      end
       # API post extension load
       BeEF::API::Registrar.instance.fire BeEF::API::Extensions, 'post_load'
-    rescue => e
+    rescue StandardError => e
       print_error "Failed to load extensions: #{e.message}"
       print_error e.backtrace
     end

core/filters.rb

@@ -1,11 +1,10 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
   module Filters
-
   end
 end
 

core/filters/base.rb

@@ -1,11 +1,10 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-module Filters
-
+  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
@@ -13,6 +12,7 @@ module Filters
       return false if str.nil?
       return false unless str.is_a? String
       return false if str.empty?
+
       true
     end
 
@@ -31,14 +31,15 @@ module Filters
     #   @return [Boolean] Whether one of the characters exists in the string
     def self.exists?(chars, str)
       regex = Regexp.new(chars)
-    not regex.match(str.encode('UTF-8', invalid: :replace, undef: :replace, replace: '')).nil?
+      !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
-  def self.has_null? (str)
+    def self.has_null?(str)
       return false unless is_non_empty_string?(str)
+
       exists?('\x00', str)
     end
 
@@ -47,7 +48,8 @@ module Filters
     #   @return [Boolean] Whether or not the string has non-printable characters
     def self.has_non_printable_char?(str)
       return false unless is_non_empty_string?(str)
-    not only?('[:print:]', str)
+
+      !only?('[:print:]', str)
     end
 
     # Check if num characters only
@@ -55,6 +57,7 @@ module Filters
     #   @return [Boolean] If the string only contains numbers
     def self.nums_only?(str)
       return false unless is_non_empty_string?(str)
+
       only?('0-9', str)
     end
 
@@ -64,7 +67,8 @@ module Filters
     def self.is_valid_float?(str)
       return false unless is_non_empty_string?(str)
       return false unless only?('0-9\.', str)
-    not (str =~ /^[\d]+\.[\d]+$/).nil?
+
+      !(str =~ /^\d+\.\d+$/).nil?
     end
 
     # Check if hex characters only
@@ -72,6 +76,7 @@ module Filters
     #   @return [Boolean] If the string only contains hex characters
     def self.hexs_only?(str)
       return false unless is_non_empty_string?(str)
+
       only?('0123456789ABCDEFabcdef', str)
     end
 
@@ -80,7 +85,8 @@ module Filters
     #   @return [Boolean] If the first character of the string is a number
     def self.first_char_is_num?(str)
       return false unless is_non_empty_string?(str)
-    not (str =~ /^\d.*/).nil?
+
+      !(str =~ /^\d.*/).nil?
     end
 
     # Check for space characters: \t\n\r\f
@@ -88,6 +94,7 @@ module Filters
     #   @return [Boolean] If the string has a whitespace character
     def self.has_whitespace_char?(str)
       return false unless is_non_empty_string?(str)
+
       exists?('\s', str)
     end
 
@@ -96,7 +103,8 @@ module Filters
     #   @return [Boolean] If the string only has alphanums
     def self.alphanums_only?(str)
       return false unless is_non_empty_string?(str)
-    only?("a-zA-Z0-9", str)
+
+      only?('a-zA-Z0-9', str)
     end
 
     # @overload self.is_valid_ip?(ip, version)
@@ -111,7 +119,8 @@ module Filters
     #   @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
+
+      if 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
@@ -134,9 +143,11 @@ module Filters
              (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
+        true
+      else
+        false
+      end
     end
 
     # Checks if the given string is a valid private IP address
@@ -145,7 +156,8 @@ module Filters
     # @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
+
+      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
@@ -164,6 +176,7 @@ module Filters
     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
 
@@ -173,7 +186,8 @@ module Filters
     # @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 unless is_non_empty_string?(str)
-    not (str =~ /[^\w\d\s()-.,;:_\/!\302\256]/).nil?  
+
+      !(str =~ %r{[^\w\d\s()-.,;:_/!\302\256]}).nil?
     end
 
     # Check for valid base details characters
@@ -183,6 +197,7 @@ module Filters
     # @note This function passes the \302\256 character which translates to the registered symbol (r)
     def self.has_valid_base_chars?(str)
       return false unless is_non_empty_string?(str)
+
       (str =~ /[^\302\256[:print:]]/).nil?
     end
 
@@ -192,8 +207,8 @@ module Filters
     def self.is_valid_yes_no?(str)
       return false if has_non_printable_char?(str)
       return false if str !~ /\A(Yes|No)\z/i
+
       true
     end
-
-end
+  end
 end

core/filters/browser.rb

@@ -1,11 +1,10 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-module Filters
-
+  module Filters
     # Check the browser type value - for example, 'FF'
     # @param [String] str String for testing
     # @return [Boolean] If the string has valid browser name characters
@@ -13,6 +12,7 @@ module Filters
       return false unless is_non_empty_string?(str)
       return false if str.length > 2
       return false if has_non_printable_char?(str)
+
       true
     end
 
@@ -23,6 +23,7 @@ module Filters
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length < 2
+
       true
     end
 
@@ -33,6 +34,7 @@ module Filters
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length < 2
+
       true
     end
 
@@ -42,10 +44,11 @@ module Filters
     def self.is_valid_browserversion?(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 true if str.eql? 'UNKNOWN'
+      return true if str.eql? 'ALL'
+      return false if !nums_only?(str) and !is_valid_float?(str)
       return false if str.length > 20
+
       true
     end
 
@@ -55,10 +58,11 @@ module Filters
     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 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
 
@@ -69,6 +73,7 @@ module Filters
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length > 300
+
       true
     end
 
@@ -79,6 +84,7 @@ module Filters
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length > 2000
+
       true
     end
 
@@ -89,6 +95,7 @@ module Filters
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length > 200
+
       true
     end
 
@@ -99,6 +106,7 @@ module Filters
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length > 200
+
       true
     end
 
@@ -109,6 +117,7 @@ module Filters
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length > 200
+
       true
     end
 
@@ -119,6 +128,7 @@ module Filters
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length > 200
+
       true
     end
 
@@ -129,6 +139,7 @@ module Filters
       return false unless is_non_empty_string?(str)
       return false if has_non_printable_char?(str)
       return false if str.length > 200
+
       true
     end
 
@@ -140,12 +151,12 @@ module Filters
     def self.is_valid_browser_plugins?(str)
       return false unless is_non_empty_string?(str)
       return false if str.length > 1000
-    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?
-    end
-  end
 
-end  
+      if str.encoding === Encoding.find('UTF-8')
+        (str =~ /[^\w\d\s()-.,';_!\302\256]/u).nil?
+      else
+        (str =~ /[^\w\d\s()-.,';_!\302\256]/n).nil?
+      end
+    end
+  end
 end

core/filters/command.rb

@@ -1,11 +1,10 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-module Filters
-    
+  module Filters
     # Check if the string is a valid path from a HTTP request
     # @param [String] str String for testing
     # @return [Boolean] If the string has valid path characters
@@ -13,6 +12,7 @@ module Filters
       return false if str.nil?
       return false unless str.is_a? String
       return false if has_non_printable_char?(str)
+
       true
     end
 
@@ -22,6 +22,7 @@ module Filters
     def self.is_valid_hook_session_id?(str)
       return false unless is_non_empty_string?(str)
       return false unless has_valid_key_chars?(str)
+
       true
     end
 
@@ -31,6 +32,7 @@ module Filters
     def self.is_valid_command_module_datastore_key?(str)
       return false unless is_non_empty_string?(str)
       return false unless has_valid_key_chars?(str)
+
       true
     end
 
@@ -40,6 +42,7 @@ module Filters
     def self.is_valid_command_module_datastore_param?(str)
       return false if has_null?(str)
       return false unless has_valid_base_chars?(str)
+
       true
     end
 
@@ -49,6 +52,7 @@ module Filters
     def self.has_valid_key_chars?(str)
       return false unless is_non_empty_string?(str)
       return false unless has_valid_base_chars?(str)
+
       true
     end
 
@@ -59,9 +63,9 @@ module Filters
       return false if str.nil?
       return false unless str.is_a? String
       return false if str.empty?
-    return false unless (str =~ /[^\w_\:]/).nil?
+      return false unless (str =~ /[^\w_:]/).nil?
+
       true
     end
-
-end
+  end
 end

core/filters/http.rb

@@ -1,11 +1,10 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-module Filters
-  
+  module Filters
     # Verify the hostname string is valid
     # @param [String] str String for testing
     # @return [Boolean] If the string is a valid hostname
@@ -13,49 +12,51 @@ module Filters
       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 (str =~ /^[a-zA-Z0-9][a-zA-Z0-9\-.]*[a-zA-Z0-9]$/).nil?
+
       true
     end
 
     def self.is_valid_verb?(verb)
-    ["HEAD", "GET", "POST", "OPTIONS", "PUT", "DELETE"].each {|v| return true if verb.eql? v }
+      %w[HEAD GET POST OPTIONS PUT DELETE].each { |v| return true if verb.eql? v }
       false
     end
 
     def self.is_valid_url?(uri)
-    return true if !uri.nil?
+      return true unless uri.nil?
+
       # OPTIONS * is not yet supported
-    #return true if uri.eql? "*"
+      # return true if uri.eql? "*"
       # TODO : CHECK THE normalize_path method and include it somewhere (maybe here)
-    #return true if uri.eql? self.normalize_path(uri)
+      # return true if uri.eql? self.normalize_path(uri)
       false
     end
 
     def self.is_valid_http_version?(version)
       # from browsers the http version contains a space at the end ("HTTP/1.0\r")
-    version.gsub!(/[\r]+/,"")
-    ["HTTP/1.0", "HTTP/1.1"].each {|v| return true if version.eql? v }
+      version.gsub!(/\r+/, '')
+      ['HTTP/1.0', 'HTTP/1.1'].each { |v| return true if version.eql? v }
       false
     end
 
     def self.is_valid_host_str?(host_str)
       # from browsers the host header contains a space at the end
-    host_str.gsub!(/[\r]+/,"")
-    return true if "Host:".eql?(host_str)
+      host_str.gsub!(/\r+/, '')
+      return true if 'Host:'.eql?(host_str)
+
       false
     end
 
     def normalize_path(path)
-    print_error "abnormal path `#{path}'" if path[0] != ?/
+      print_error "abnormal path `#{path}'" if path[0] != '/'
       ret = path.dup
 
       ret.gsub!(%r{/+}o, '/')                    # //      => /
-    while ret.sub!(%r'/\.(?:/|\Z)', '/'); end  # /.      => /
-    while ret.sub!(%r'/(?!\.\./)[^/]+/\.\.(?:/|\Z)', '/'); end # /foo/.. => /foo
+      while ret.sub!(%r{/\.(?:/|\Z)}, '/'); end  # /.      => /
+      while ret.sub!(%r{/(?!\.\./)[^/]+/\.\.(?:/|\Z)}, '/'); end # /foo/.. => /foo
 
       print_error "abnormal path `#{path}'" if %r{/\.\.(/|\Z)} =~ ret
       ret
     end
-
-end
+  end
 end

core/filters/page.rb

@@ -1,11 +1,10 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-module Filters
-  
+  module Filters
     # Verify the page title string is valid
     # @param [String] str String for testing
     # @return [Boolean] If the string is a valid page title
@@ -13,6 +12,7 @@ module Filters
       return false unless str.is_a? String
       return false if has_non_printable_char?(str)
       return false if str.length > 500 # CxF Increased this because some page titles are MUCH longer
+
       true
     end
 
@@ -23,8 +23,8 @@ module Filters
       return false unless str.is_a? String
       return false if has_non_printable_char?(str)
       return false if str.length > 350
+
       true
     end
-  
-end
+  end
 end

core/hbmanager.rb

@@ -1,16 +1,15 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 # Browser Exploitation Framework (BeEF) - http://beefproject.com
 # See the file 'doc/COPYING' for copying permission
 #
 module BeEF
   module HBManager
-
     # Get hooked browser by session id
     # @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.where(:session => sid).first
+      BeEF::Core::Models::HookedBrowser.where(session: sid).first
     end
 
     # Get hooked browser by id
@@ -19,6 +18,5 @@ module BeEF
     def self.get_by_id(id)
       BeEF::Core::Models::HookedBrowser.find(id)
     end
-
   end
 end

core/loader.rb

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

core/logger.rb

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

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

@@ -1,12 +1,8 @@
 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

@@ -1,7 +1,5 @@
 class CreateHookedBrowsers < ActiveRecord::Migration[6.0]
-
   def change
-
     create_table :hooked_browsers do |t|
       t.text :session
       t.text :ip
@@ -13,7 +11,5 @@ class CreateHookedBrowsers < ActiveRecord::Migration[6.0]
       t.integer :count
       t.boolean :is_proxy
     end
-
   end
-
 end

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

@@ -1,14 +1,10 @@
 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

@@ -1,7 +1,5 @@
 class CreateCommands < ActiveRecord::Migration[6.0]
-
   def change
-
     create_table :commands do |t|
       t.references :command_module
       t.references :hooked_browser
@@ -10,7 +8,5 @@ class CreateCommands < ActiveRecord::Migration[6.0]
       t.text :label
       t.boolean :instructions_sent, default: false
     end
-
   end
-
 end

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

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

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

@@ -1,12 +1,8 @@
 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

@@ -1,13 +1,9 @@
 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

@@ -1,7 +1,5 @@
 class CreateExecutions < ActiveRecord::Migration[6.0]
-
   def change
-
     create_table :executions do |t|
       t.text :session_id
       t.integer :mod_count
@@ -12,7 +10,5 @@ class CreateExecutions < ActiveRecord::Migration[6.0]
       t.boolean :is_sent
       t.integer :rule_id
     end
-
   end
-
 end

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

@@ -1,7 +1,5 @@
 class CreateRules < ActiveRecord::Migration[6.0]
-
   def change
-
     create_table :rules do |t|
       t.text :name
       t.text :author
@@ -14,7 +12,5 @@ class CreateRules < ActiveRecord::Migration[6.0]
       t.text :execution_delay
       t.text :chain_mode
     end
-
   end
-
 end

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

@@ -1,12 +1,8 @@
 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

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

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

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

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

@@ -1,7 +1,5 @@
 class CreateNetworkHost < ActiveRecord::Migration[6.0]
-
   def change
-
     create_table :network_hosts do |t|
       t.references :hooked_browser
       t.text :ip
@@ -11,7 +9,5 @@ class CreateNetworkHost < ActiveRecord::Migration[6.0]
       t.text :mac
       t.text :lastseen
     end
-
   end
-
 end

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

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

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

@@ -1,13 +1,11 @@
 class CreateHttp < ActiveRecord::Migration[6.0]
-
   def change
-
     create_table :https do |t|
       t.text :hooked_browser_id
       # 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
+      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, ...
@@ -21,7 +19,7 @@ class CreateHttp < ActiveRecord::Migration[6.0]
       # The http response method. GET or POST.
       t.text :method
       # The content length for the request.
-            t.text :content_length, :default => 0
+      t.text :content_length, default: 0
       # The request protocol/scheme (http/https)
       t.text :proto
       # The domain on which perform the request.
@@ -29,7 +27,7 @@ class CreateHttp < ActiveRecord::Migration[6.0]
       # 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"
+      t.text :has_ran, default: 'waiting'
       # The path of the request.
       # Example: /secret.html
       t.text :path
@@ -38,7 +36,5 @@ class CreateHttp < ActiveRecord::Migration[6.0]
       # 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

@@ -1,13 +1,9 @@
 class CreateRtcStatus < ActiveRecord::Migration[6.0]
-
   def change
-
     create_table :rtc_statuss 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

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

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

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

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

@@ -1,14 +1,10 @@
 class CreateRtcModuleStatus < ActiveRecord::Migration[6.0]
-
   def change
-
     create_table :rtc_module_statuss 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

@@ -1,14 +1,10 @@
 class CreateXssraysDetail < ActiveRecord::Migration[6.0]
-
   def change
-
     create_table :xssraysdetails 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

@@ -1,14 +1,10 @@
 class CreateDnsRule < ActiveRecord::Migration[6.0]
-
   def change
-
     create_table :dns_rules 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

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

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

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

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

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

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

@@ -1,7 +1,5 @@
 class CreateXssraysScan < ActiveRecord::Migration[6.0]
-
   def change
-
     create_table :xssraysscans do |t|
       t.references :hooked_browser
       t.datetime :scan_start
@@ -12,7 +10,5 @@ class CreateXssraysScan < ActiveRecord::Migration[6.0]
       t.boolean :is_started
       t.boolean :is_finished
     end
-
   end
-
 end

core/main/autorun_engine/engine.rb

@@ -1,14 +1,12 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 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
@@ -20,26 +18,232 @@ module BeEF
 
           @debug_on = @config.get('beef.debug')
 
-          @VERSION = ['<','<=','==','>=','>','ALL']
-          @VERSION_STR = ['XP','Vista']
+          @VERSION = ['<', '<=', '==', '>=', '>', 'ALL']
+          @VERSION_STR = %w[XP Vista 7]
+        end
+
+        # Checks if there are any ARE rules to be triggered for the specified hooked browser.
+        #
+        # 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 find_matching_rules_for_zombie(browser, browser_version, os, os_version)
+          rules = BeEF::Core::Models::Rule.all
+
+          return if rules.nil?
+          return if rules.empty?
+
+          # TODO: handle cases where there are multiple ARE rules for the same hooked browser.
+          # maybe rules need to have priority or something?
+
+          print_info '[ARE] Checking if any defined rules should be triggered on target.'
+
+          match_rules = []
+          rules.each do |rule|
+            next unless zombie_matches_rule?(browser, browser_version, os, os_version, rule)
+
+            match_rules.push(rule.id)
+            print_more("Hooked browser and OS match rule: #{rule.name}.")
+          end
+
+          print_more("Found [#{match_rules.length}/#{rules.length}] ARE rules matching the hooked browser.")
+
+          match_rules
+        end
+
+        # @return [Boolean]
+        # 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
+        def zombie_matches_rule?(browser, browser_version, os, os_version, rule)
+          return false if rule.nil?
+
+          unless zombie_browser_matches_rule?(browser, browser_version, rule)
+            print_debug("Browser version check -> (hook) #{browser_version} #{rule.browser_version} (rule) : does not match")
+            return false
+          end
+
+          print_debug("Browser version check -> (hook) #{browser_version} #{rule.browser_version} (rule) : matched")
+
+          unless zombie_os_matches_rule?(os, os_version, rule)
+            print_debug("OS version check -> (hook) #{os_version} #{rule.os_version} (rule): does not match")
+            return false
+          end
+
+          print_debug("OS version check -> (hook) #{os_version} #{rule.os_version} (rule): matched")
+
+          true
+        rescue StandardError => e
+          print_error e.message
+          print_debug e.backtrace.join("\n")
+        end
+
+        # @return [Boolean]
+        # TODO: This should be updated to support matching multiple OS (like the browser check below)
+        def zombie_os_matches_rule?(os, os_version, rule)
+          return false if rule.nil?
+
+          return false unless rule.os == 'ALL' || os == rule.os
+
+          # check if the OS versions match
+          os_ver_rule_cond = rule.os_version.split(' ').first
+
+          return true if os_ver_rule_cond == 'ALL'
+
+          return false unless @VERSION.include?(os_ver_rule_cond) || @VERSION_STR.include?(os_ver_rule_cond)
+
+          os_ver_rule_maj = rule.os_version.split(' ').last.split('.').first
+          os_ver_rule_min = rule.os_version.split(' ').last.split('.').last
+
+          if os_ver_rule_maj == 'XP'
+            os_ver_rule_maj = 5
+            os_ver_rule_min = 0
+          elsif os_ver_rule_maj == 'Vista'
+            os_ver_rule_maj = 6
+            os_ver_rule_min = 0
+          elsif os_ver_rule_maj == '7'
+            os_ver_rule_maj = 6
+            os_ver_rule_min = 0
+          end
+
+          # 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
+            # XP is Windows 5.0 and Vista is Windows 6.0. Easier for comparison later on.
+            # TODO: BUG: This will fail horribly if the target OS is Windows 7 or newer,
+            # as no version normalization is performed.
+            # TODO: Update this for every OS since Vista/7 ...
+            if os_version == 'XP'
+              os_ver_hook_maj = 5
+              os_ver_hook_min = 0
+            elsif os_version == 'Vista'
+              os_ver_hook_maj = 6
+              os_ver_hook_min = 0
+            elsif os_version == '7'
+              os_ver_hook_maj = 6
+              os_ver_hook_min = 0
+            end
+          end
+
+          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)
+            return false unless (os_major_version_match && os_minor_version_match)
+          end
+
+          true
+        rescue StandardError => e
+          print_error e.message
+          print_debug e.backtrace.join("\n")
+        end
+
+        # @return [Boolean]
+        def zombie_browser_matches_rule?(browser, browser_version, rule)
+          return false if rule.nil?
+
+          b_ver_cond = rule.browser_version.split(' ').first
+
+          return false unless @VERSION.include?(b_ver_cond)
+
+          b_ver = rule.browser_version.split(' ').last
+
+          return false unless BeEF::Filters.is_valid_browserversion?(b_ver)
+
+          # check if rule specifies multiple browsers
+          if rule.browser =~ /\A[A-Z]+\Z/
+              return false 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)
+              return false unless browser_version_match
+            else
+              browser_match = false
+              rule.browser.gsub(/[^A-Z,]/i, '').split(',').each do |b|
+                if b == browser || b == 'ALL'
+                  browser_match = true
+                  break
+                end
+              end
+              return false unless browser_match
+          end
+
+          true
+        rescue StandardError => e
+          print_error e.message
+          print_debug e.backtrace.join("\n")
         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
+        # stored in the BeEF::Core::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)
+        def find_and_run_all_matching_rules_for_zombie(hb_id)
+          return if hb_id.nil?
+
+          hb_details = BeEF::Core::Models::BrowserDetails
+          browser_name = hb_details.get(hb_id, 'browser.name')
+          browser_version = hb_details.get(hb_id, 'browser.version')
+          os_name = hb_details.get(hb_id, 'host.os.name')
+          os_version = hb_details.get(hb_id, 'host.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
+          rules = are.find_matching_rules_for_zombie(browser_name, browser_version, os_name, os_version)
+
+          return if rules.nil?
+          return if rules.empty?
+
+          are.run_rules_on_zombie(rules, hb_id)
         end
 
+        # Run the specified rule IDs on the specified zombie ID
+        # only if the rules match.
+        def run_matching_rules_on_zombie(rule_ids, hb_id)
+          return if rule_ids.nil?
+          return if hb_id.nil?
+
+          rule_ids = [rule_ids.to_i] if rule_ids.is_a?(String)
+
+          hb_details = BeEF::Core::Models::BrowserDetails
+          browser_name = hb_details.get(hb_id, 'browser.name')
+          browser_version = hb_details.get(hb_id, 'browser.version')
+          os_name = hb_details.get(hb_id, 'host.os.name')
+          os_version = hb_details.get(hb_id, 'host.os.version')
+
+          are = BeEF::Core::AutorunEngine::Engine.instance
+          rules = are.find_matching_rules_for_zombie(browser_name, browser_version, os_name, os_version)
+
+          return if rules.nil?
+          return if rules.empty?
+
+          new_rules = []
+          rules.each do |rule|
+            new_rules << rule if rule_ids.include?(rule)
+          end
+
+          return if new_rules.empty?
+
+          are.run_rules_on_zombie(new_rules, hb_id)
+        end
+
+        # Run the specified rule IDs on the specified zombie ID
+        # regardless of whether the rules match.
         # 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)
+        def run_rules_on_zombie(rule_ids, hb_id)
+          return if rule_ids.nil?
+          return if hb_id.nil?
 
           hb = BeEF::HBManager.get_by_id(hb_id)
           hb_session = hb.session
 
+          rule_ids = [rule_ids] if rule_ids.is_a?(Integer)
+
           rule_ids.each do |rule_id|
             rule = BeEF::Core::Models::Rule.find(rule_id)
             modules = JSON.parse(rule.modules)
@@ -48,26 +252,30 @@ module BeEF
             execution_delay = JSON.parse(rule.execution_delay)
             chain_mode = rule.chain_mode
 
-            mods_bodies = Array.new
-            mods_codes = Array.new
-            mods_conditions = Array.new
+            unless %w[sequential nested-forward].include?(chain_mode)
+              print_error("[ARE] Invalid chain mode '#{chain_mode}' for rule")
+              return
+            end
+
+            mods_bodies = []
+            mods_codes = []
+            mods_conditions = []
 
             # 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
+              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})
+              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'])
@@ -80,26 +288,27 @@ module BeEF
             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 ;-)
+              # we should never get here. chain mode is validated earlier.
+              print_error("[ARE] Invalid chain mode '#{chain_mode}'")
+              next
             end
 
+            print_more "Triggering rules #{rule_ids} on HB #{hb_id}"
+
             are_exec = BeEF::Core::Models::Execution.new(
-                :session_id => hb_session,
-                :mod_count => modules.length,
-                :mod_successful => 0,
-                :rule_token => rule_token,
-                :mod_body => wrapper,
-                :is_sent => false,
-                :id => rule_id
+              session_id: 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
 
+        private
 
         # Wraps module bodies in their own function, using setTimeout to trigger them with an eventual delay.
         # Launch order is also taken care of.
@@ -114,7 +323,7 @@ module BeEF
           delayed_exec = ''
           c = 0
           while c < mods.length
-            delayed_exec += %Q| setTimeout(function(){#{mods[order[c]][:mod_name]}_#{rule_token}();}, #{delay[c]}); |
+            delayed_exec += %| 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
@@ -141,15 +350,16 @@ module BeEF
         #     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
+          wrapper = ''
+          delayed_exec = ''
+          delayed_exec_footers = []
           c = 0
 
           while c < mods.length
-            if mods.length == 1
-              i = c
+            i = if mods.length == 1
+                  c
                 else
-              i = c + 1
+                  c + 1
                 end
 
             code_snippet = ''
@@ -159,11 +369,11 @@ module BeEF
               mod_input = 'mod_input'
             end
 
-            conditions[i] = true if conditions[i] == nil || conditions[i] == ''
+            conditions[i] = true if conditions[i].nil? || conditions[i] == ''
 
             if c == 0
               # this is the first wrapper to prepare
-              delayed_exec += %Q|
+              delayed_exec += %|
                 function #{mods[order[c]][:mod_name]}_#{rule_token}_f(){
                   #{mods[order[c]][:mod_name]}_#{rule_token}();
 
@@ -185,7 +395,7 @@ module BeEF
                          #{mods[order[c]][:mod_name]}_#{rule_token}_mod_output = mod_result[1];
               |
 
-              delayed_exec_footer = %Q|
+              delayed_exec_footer = %|
                      }
                     }
                   }
@@ -198,10 +408,10 @@ module BeEF
               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}")
+              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|
+              delayed_exec += %|
                 function #{mods[order[c]][:mod_name]}_#{rule_token}_f(){
                   if(#{mods[order[c]][:mod_name]}_#{rule_token}_can_exec){
                      #{code_snippet}
@@ -223,7 +433,7 @@ module BeEF
                              #{mods[order[c]][:mod_name]}_#{rule_token}_mod_output = mod_result[1];
               |
 
-              delayed_exec_footer = %Q|
+              delayed_exec_footer = %|
                          }
                        }
                      }
@@ -236,9 +446,9 @@ module BeEF
 
               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}")
+              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|
+              delayed_exec += %|
                 function #{mods[order[c]][:mod_name]}_#{rule_token}_f(){
                   if(#{mods[order[c]][:mod_name]}_#{rule_token}_can_exec){
                      #{code_snippet}
@@ -258,7 +468,6 @@ module BeEF
           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.
@@ -266,16 +475,16 @@ module BeEF
           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
+              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/))
+            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
@@ -293,7 +502,7 @@ module BeEF
 
             build_missing_beefjs_components(command_module.beefjs_components) unless command_module.beefjs_components.empty?
 
-            if config.get("beef.extension.evasion.enable")
+            if config.get('beef.extension.evasion.enable')
               evasion = BeEF::Extension::Evasion::Evasion.instance
               command_body = evasion.obfuscate(command_module.output) + "\n\n"
             else
@@ -303,8 +512,8 @@ module BeEF
             # @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|
+            mod_input = replace_input ? 'mod_input' : ''
+            result = %|
                 var #{mod.name}_#{rule_token} = function(#{mod_input}){
                     #{clean_command_body(command_body, replace_input)}
                 };
@@ -312,8 +521,8 @@ module BeEF
                 var #{mod.name}_#{rule_token}_mod_output = null;
             |
 
-            return {:mod_name => mod.name, :mod_body => result}
-          rescue =>  e
+            { mod_name: mod.name, mod_body: result }
+          rescue StandardError => e
             print_error e.message
             print_debug e.backtrace.join("\n")
           end
@@ -324,9 +533,8 @@ module BeEF
         #
         # 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
+          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\(\)/
@@ -334,9 +542,7 @@ module BeEF
               break
             end
           end
-            if wrapper_start_index.nil?
-              print_error "[ARE] Could not find module start index"
-            end
+          print_error '[ARE] Could not find module start index' if wrapper_start_index.nil?
 
           cmd_body.reverse.each_with_index do |line, index|
             if line.include?('});')
@@ -344,143 +550,26 @@ module BeEF
               break
             end
           end
-            if wrapper_end_index.nil?
-              print_error "[ARE] Could not find module end index"
-            end
+          print_error '[ARE] Could not find module end index' if wrapper_end_index.nil?
 
-            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
+          cleaned_cmd_body = cmd_body.slice(wrapper_start_index..-(wrapper_end_index + 1)).join("\n")
+
+          print_error '[ARE] No command to send' if cleaned_cmd_body.eql?('')
 
           # check if <<mod_input>> should be replaced with a variable name (depending if the variable is a string or number)
-            if replace_input
+          return cleaned_cmd_body unless replace_input
+
           if cleaned_cmd_body.include?('"<<mod_input>>"')
-                final_cmd_body = cleaned_cmd_body.gsub('"<<mod_input>>"','mod_input')
+            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')
+            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')
+            cleaned_cmd_body.gsub('\'<<mod_input>>\'', 'mod_input')
           else
-                return cleaned_cmd_body
+            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
+        rescue StandardError => e
+          print_error "[ARE] There is likely a problem with the module's command.js parsing. Check Engine.clean_command_body. #{e.message}"
         end
 
         # compare versions
@@ -491,7 +580,8 @@ module BeEF
           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
+
+          false
         end
       end
     end

core/main/autorun_engine/parser.rb

@@ -1,89 +1,80 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 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']
+        BROWSER = %w[FF C IE S O ALL]
+        OS = %w[Linux Windows OSX Android iOS BlackBerry ALL]
+        VERSION = ['<', '<=', '==', '>=', '>', 'ALL', 'Vista', 'XP']
+        CHAIN_MODE = %w[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)
+        def parse(name, author, browser, browser_version, os, os_version, modules, execution_order, execution_delay, chain_mode)
+          raise ArgumentError, "Invalid rule name: #{name}" unless BeEF::Filters.is_non_empty_string?(name)
+          raise ArgumentError, "Invalid author name: #{author}" unless BeEF::Filters.is_non_empty_string?(author)
+          raise ArgumentError, "Invalid chain_mode definition: #{chain_mode}" unless CHAIN_MODE.include?(chain_mode)
+          raise ArgumentError, "Invalid os definition: #{os}" unless OS.include?(os)
+
+          unless modules.size == execution_delay.size
+            raise ArgumentError, "Number of execution_delay values (#{execution_delay.size}) must be consistent with number of modules (#{modules.size})"
+          end
+          execution_delay.each { |delay| raise TypeError, "Invalid execution_delay value: #{delay}. Values must be Integers." unless delay.is_a?(Integer) }
+
+          unless modules.size == execution_order.size
+            raise ArgumentError, "Number of execution_order values (#{execution_order.size}) must be consistent with number of modules (#{modules.size})"
+          end
+          execution_order.each { |order| raise TypeError, "Invalid execution_order value: #{order}. Values must be Integers." unless order.is_a?(Integer) }
+
           # if multiple browsers were specified, check each browser
-            if browser.kind_of?(Array)
+          if browser.is_a?(Array)
             browser.each do |b|
-                return [false, 'Illegal browser definition'] unless BROWSER.include?(b)
+              raise ArgumentError, "Invalid browser definition: #{browser}" 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
+            raise ArgumentError, "Invalid browser definition: #{browser}" unless BROWSER.include?(browser)
+
+            if browser_version != 'ALL' && !(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)
+              raise ArgumentError, "Invalid browser_version definition: #{browser_version}"
             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
+          if os_version != 'ALL' && !(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)
+            return ArgumentError, "Invalid os_version definition: #{os_version}"
           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
+            mod = BeEF::Core::Models::CommandModule.where(name: cmd_mod['name']).first
+
+            raise "The specified module name (#{cmd_mod['name']}) does not exist" 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]
+              if opt['name'] != cmd_mod['options'].keys[opt_count]
+                raise ArgumentError, "The specified option (#{cmd_mod['options'].keys[opt_count]}) for module (#{cmd_mod['name']}) was not specified"
+              end
+
               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
+          true
         end
       end
     end

core/main/autorun_engine/rule_loader.rb

@@ -1,14 +1,12 @@
 #
-# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+# Copyright (c) 2006-2024 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
@@ -16,80 +14,111 @@ module BeEF
           @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'
+        # Load an ARE rule set
+        # @param [Hash] ARE ruleset as JSON
+        # @return [Hash] {"success": Boolean, "rule_id": Integer, "error": String}
+        def load_rule_json(data)
+          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']
+          execution_order = data['execution_order']
+          execution_delay = data['execution_delay']
+          chain_mode = data['chain_mode'] || 'sequential'
 
-            parser_result = BeEF::Core::AutorunEngine::Parser.instance.parse(
-                name,author,browser,browser_version,os,os_version,modules,exec_order,exec_delay,chain_mode)
+          begin
+            BeEF::Core::AutorunEngine::Parser.instance.parse(
+              name,
+              author,
+              browser,
+              browser_version,
+              os,
+              os_version,
+              modules,
+              execution_order,
+              execution_delay,
+              chain_mode
+            )
+          rescue => e
+            print_error("[ARE] Error loading ruleset (#{name}): #{e.message}")
+            return { 'success' => false, 'error' => e.message }
+          end
+
+          existing_rule = BeEF::Core::Models::Rule.where(
+            name: name,
+            author: author,
+            browser: browser,
+            browser_version: browser_version,
+            os: os,
+            os_version: os_version,
+            modules: modules.to_json,
+            execution_order: execution_order.to_s,
+            execution_delay: execution_delay.to_s,
+            chain_mode: chain_mode
+          ).first
+
+          unless existing_rule.nil?
+            msg = "Duplicate rule already exists in the database (ID: #{existing_rule.id})"
+            print_info("[ARE] Skipping ruleset (#{name}): #{msg}")
+            return { 'success' => false, 'error' => msg }
+          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: execution_order.to_s,
+            execution_delay: execution_delay.to_s,
+            chain_mode: chain_mode
+          )
+          are_rule.save
+
+          print_info("[ARE] Ruleset (#{name}) parsed and stored successfully.")
 
-            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:"
+            print_more 'Modules to run:'
             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 '(*) Options:'
+              mod['options'].each do |key, value|
                 print_more "\t#{key}: (#{value})"
               end
             end
-                print_more "Exec order: #{exec_order}"
+            print_more "Exec order: #{execution_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 }
+
+          { 'success' => true, 'rule_id' => are_rule.id }
+        rescue TypeError, ArgumentError => e
+          print_error("[ARE] Failed to load ruleset (#{name}): #{e.message}")
+          { 'success' => false, 'error' => e.message }
         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
+        # Load an ARE ruleset from file
+        # @param [String] JSON ARE ruleset file path
+        def load_rule_file(json_rule_path)
           rule_file = File.open(json_rule_path, 'r:UTF-8', &:read)
-            self.load JSON.parse(rule_file)
+          self.load_rule_json(JSON.parse(rule_file))
         rescue => e
-            print_error "[ARE] Failed to load ruleset from #{json_rule_path}"
-          end
+          print_error("[ARE] Failed to load ruleset from #{json_rule_path}: #{e.message}")
         end
 
+        # Load all JSON ARE rule files from arerules/enabled/ directory
         def load_directory
-          Dir.glob("#{$root_dir}/arerules/enabled/**/*.json") do |rule|
-            print_debug "[ARE] Processing rule: #{rule}"
-            self.load_file rule
+          Dir.glob("#{$root_dir}/arerules/enabled/**/*.json") do |rule_file|
+            print_debug("[ARE] Processing ruleset file: #{rule_file}")
+            load_rule_file(rule_file)
           end
         end
       end

core/main/client/are.js

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

core/main/client/beef.js

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+// Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 // Browser Exploitation Framework (BeEF) - http://beefproject.com
 // See the file 'doc/COPYING' for copying permission
 //
@@ -39,7 +39,7 @@ if(typeof beef === 'undefined' && typeof window.beef === 'undefined') {
          */
         debug: function(msg) {
             isDebug = '<%= @client_debug %>'
-            if (typeof console == "object" && typeof console.log == "function" && isDebug.localeCompare("true")) {
+            if (typeof console == "object" && typeof console.log == "function" && isDebug === 'true') {
                 var currentdate = new Date();
                 var pad = function(n){return ("0" + n).slice(-2);}
                 var datetime = currentdate.getFullYear() + "-"

core/main/client/browser.js

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
+// Copyright (c) 2006-2024 Wade Alcorn - wade@bindshell.net
 // Browser Exploitation Framework (BeEF) - http://beefproject.com
 // See the file 'doc/COPYING' for copying permission
 //
@@ -4331,24 +4331,6 @@ beef.browser = {
         if (has_wmp) details['browser.capabilities.wmp'] = has_wmp;
         if (has_vlc) details['browser.capabilities.vlc'] = has_vlc;
 
-        var pf_integration = "<%= @phishing_frenzy_enable %>";
-        if (pf_integration) {
-            var pf_param = "uid";
-            var pf_victim_uid = "";
-            var location_search = window.location.search.substring(1);
-            var params = location_search.split('&');
-            for (var i = 0; i < params.length; i++) {
-                var param_entry = params[i].split('=');
-                if (param_entry[0] == pf_param) {
-                    pf_victim_uid = param_entry[1];
-                    details['PhishingFrenzyUID'] = pf_victim_uid;
-                    break;
-                }
-            }
-        } else {
-            details['PhishingFrenzyUID'] = "N/A";
-        }
-
         return details;
     },
 

core/main/client/browser/cookie.js

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

core/main/client/browser/popup.js

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

core/main/client/dom.js

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